= hoe-reek

code  :: https://github.com/saigkill/hoe-reek
docs :: https://saigkill.tuxfamily.org/documentation/hoe-reek
apidoc :: http://www.rubydoc.info/gems/hoe-reek
bugs  :: https://github.com/saigkill/hoe-reek/issues
questions :: https://groups.google.com/forum/#!forum/saigkills-hoe-plugins
openhub statistics :: https://www.openhub.net/p/hoe-reek
authors blog :: https://saigkill.tuxfamily.org
min. rubyver :: 2.3.0

last public version  :: {<img src="https://badge.fury.io/rb/hoe-reek.png" alt="Last Version" />}[http://rubygems.org/gems/hoe-reek]
downloads latest :: {<img src="https://img.shields.io/gem/dtv/hoe-reek.svg" alt="Downloads latest version" />}[http://rubygems.org/gems/hoe-reek]
downloads all :: {<img src="https://img.shields.io/gem/dt/hoe-reek.svg" alt="Downloads all versions" />}[http://rubygems.org/gems/hoe-reek]
code quality :: {<img src="https://scrutinizer-ci.com/g/saigkill/hoe-reek/badges/quality-score.png?b=master" />}[https://scrutinizer-ci.com/g/saigkill/hoe-reek/]
code quality :: {<img src="https://api.codeclimate.com/v1/badges/47c41b9c432372b426a2/maintainability" alt="Code Quality" />}[https://codeclimate.com/github/saigkill/hoe-reek/maintainability]
security :: {<img src="https://hakiri.io/github/saigkill/hoe-reek/master.svg" alt="security" />}[https://hakiri.io/github/saigkill/hoe-reek/master]
dependency check :: {<img src="https://gemnasium.com/saigkill/hoe-reek.svg" alt="Dependency Status" />}[https://gemnasium.com/saigkill/hoe-reek]
documentation quality :: {<img src="http://inch-ci.org/github/saigkill/hoe-reek.svg?branch=master" alt="Documentation Quality" />}[http://inch-ci.org/github/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 History.rdoc contains a detailed description on what has changed. For most
users the NEWS file might be a better place to look since it contains
change summaries between the different versions.

hoe-reek is released under the GPL3 License, see the file 'License.rdoc'
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.

Read the documentation at: https://saigkill.tuxfamily.org/documentation/hoe-reek

== REQUIREMENTS:

* reek

== INSTALL:

The installation is very easy.

    gem install hoe-reek

Read the documentation at: https://saigkill.tuxfamily.org/documentation/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.