= hoe-reek

home  :: http://saigkill.github.io
code  :: http://github.com/saigkill/hoe-reek
docu (en) :: https://saigkill.tuxfamily.org/docs/hoe-reek/en-US/html/
docu (de) :: https://saigkill.tuxfamily.org/docs/hoe-reek/de-DE/html/
apidoc :: http://www.rubydoc.info/gems/hoe-reek
bugs  :: https://github.com/saigkill/hoe-reek/issues
min. rubyver :: 2.2.0
license :: {<img src="http://img.shields.io/:license-mit-blue.svg" />}[https://github.com/saigkill/hoe-reek/blob/master/LICENSE.rdoc]
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]
continuous integration :: {<img src="https://scrutinizer-ci.com/g/saigkill/hoe-reek/badges/build.png?b=master" />}[https://scrutinizer-ci.com/g/saigkill/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://d3s6mut3hikguw.cloudfront.net/github/saigkill/hoe-reek/badges/gpa.svg" alt="Code Quality" />}[https://codeclimate.com/github/saigkill/hoe-reek]
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]
donations :: {<img src="https://pledgie.com/campaigns/30306.png?skin_name=chrome" alt="Donations" />}[https://pledgie.com/campaigns/30306]
donations :: {<img src="https://saigkill.tuxfamily.org/dotclear/public/Amazon.png" alt="Donations" />}[http://www.amazon.de/registry/wishlist/D75HOEQ00BDD]

== DESCRIPTION:

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

== FEATURES/PROBLEMS:

* 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.

For a detailed information please visit: https://saigkill.tuxfamily.org/docs/hoe-reek/en-US/html/ (en) or https://saigkill.tuxfamily.org/docs/hoe-reek/de-DE/html/ (de).
If you like this piece of software don't forget to give the gitlab repo a star.

== 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:

* rake
* reek
* hoe

== INSTALL:

    gem install hoe-reek

== RUN:

Type rake reek inside your project dir.

== DEVELOPERS:

After checking out the source, run:

  $ rake newb

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

Read https://github.com/saigkill/hoe-reek/blob/master/CONTRIBUTING.md

== LICENSE:

(The MIT License)

Copyright (c) 2015-2017 Sascha Manns <Sascha.Manns@mailbox.org>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.