Contents

h1. reek

Reek is a tool that examines Ruby classes, modules and methods and reports any code smells it finds.

h2. Installing

    @$ gem install reek@

h2. The basics

    @$ reek [options] [source_files]@

(See @reek --help@ for details.)

h2. Code Smells

reek currently includes very naive checks for the following code smells:

* Long Method
* Large Class
* Feature Envy
* Uncommunicative Name
* Long Parameter List
* Utility Function
* Nested Iterators

h2. How to access the source code

The source is hosted on both "github":http://github.com/kevinrutherford/reek/tree/master and "rubyforge":http://rubyforge.org/projects/reek/

h2. License

This code is free to use under the terms of the MIT license. 

h2. Contact

Comments are welcome. Send an email to "Kevin Rutherford":mailto:[e-mail]

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
reek-0.3.0	website/index.txt
reek-0.2.3	website/index.txt