# hoe-reek

|What | Where |
|-----|--------|
|code  | https://github.com/saigkill/hoe-reek | 
|docs | https://github.com/saigkill/hoe-reek/wiki | 
|apidoc | http://www.rubydoc.info/gems/hoe-reek | 
|bugs  | https://github.com/saigkill/hoe-reek/issues | 
|openhub statistics | https://www.openhub.net/p/hoe-reek | 
|authors blog | https://saschamanns.de |
|min. rubyver | 2.3.0 | 

| What | Status |
|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|last public version  | [![Last Version](https://badge.fury.io/rb/hoe-reek.png)](http://rubygems.org/gems/hoe-reek)
|downloads latest | [![Downloads latest](https://img.shields.io/gem/dtv/hoe-reek.svg)](http://rubygems.org/gems/hoe-reek)
|downloads all | [![Downloads all](https://img.shields.io/gem/dt/hoe-reek.svg)](http://rubygems.org/gems/hoe-reek)
|code quality | [![Maintainability](https://api.codeclimate.com/v1/badges/47c41b9c432372b426a2/maintainability)](https://codeclimate.com/github/saigkill/hoe-reek/maintainability) |
|continuous integration | ![CI](https://github.com/saigkill/hoe-reek/workflows/CI/badge.svg?branch=master&event=push) | 
|security | [![Security](https://hakiri.io/github/saigkill/hoe-reek/master.svg)](https://hakiri.io/github/saigkill/hoe-reek/master/shield) |
|vulnerabilities|[![Known Vulnerabilities](https://snyk.io/test/github/saigkill/hoe-reek/badge.svg?targetFile=Gemfile.lock)](https://snyk.io/test/github/saigkill/hoe-reek?targetFile=Gemfile.lock) | 
|documentation quality | [![Documentation Quality](https://inch-ci.org/github/saigkill/hoe-reek.svg?branch=master)](https://inch-ci.org/github/saigkill/hoe-reek) |

## SCREENSHOT

[![Screenshot](https://saschamanns.de/img/screenshots/hoe-manns-screenshots.png)](https://github.com/saigkill/hoe-reek)

## DESCRIPTION:

Tasks to integrate the reek code smell engine into your hoe projects. This project continues erics project (https://github.com/erikh/hoe-reek).

The CHANGELOG.md contains a detailed description on what has changed.

hoe-reek is released under the GPL3 License, see the file 'LICENSE.md' for more information.

The official web site is:

    https://github.com/saigkill/hoe-reek

## FEATURES:

* Integration of Reek into a hoe Rake task.

This Gem was programmed and tested for Linux systems. If anyone would like to make the methods also fit for other OS, i'm happy about Pull requests.

## SYNOPSIS:

Use in your Rakefile:

    Hoe.plugin :reek

    Hoe.spec 'yourproject' do
    ...
    end

Also add hoe-reek to your requirements and recreate your Gemfile.

## REQUIREMENTS:

* reek

## INSTALL:

The installation is very easy.

    gem install hoe-reek

## DEVELOPERS:

After checking out the source, run:

  $ rake newb

This task will install any missing dependencies, run the tests/specs,
and generate the RDoc.