@@ -1,82 +1,6 @@ -= reek += Reek -* http://rubyforge.org/projects/reek/ -* mailto:kevin@rutherford-software.com +Code smell detection for Ruby. -== DESCRIPTION: - -Reek is a tool that examines Ruby classes, modules and methods and -reports any code smells it finds. - -=== SUPPORTED CODE SMELLS: - -Reek currently includes very naive checks for the following smells: - -* Long Method -* Large Class -* Feature Envy -* Uncommunicative Name -* Long Parameter List -* Utility Function -* Nested Iterators -* Control Couple -* Duplication - -== FEATURES/PROBLEMS: - -* Most of the current checks are quite naive. -* Not many smells checked right now; more coming soon. -* The current Feature Envy check is probably over zealous. -* There's no convenient programmer's API just yet. - -== SYNOPSIS: - - $ reek [options] sources - -(See `reek --help` for details.) - -== DEPENDENCIES: - -Reek makes use of the following other gems: - -* ParseTree -* sexp_processor - -== INSTALL: - -Get the latest version of the gem: - - $ gem install reek - -Or get the latest source code from: - - $ git clone git://github.com/kevinrutherford/reek.git - -or - - $ git clone git://rubyforge.org/reek.git - -== LICENSE: - -(The MIT License) - -Copyright (c) 2008 Kevin Rutherford, Rutherford Software Ltd - -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. +The documentation is at http://wiki.github.com/kevinrutherford/reek +The code lives at http://github.com/kevinrutherford/reek/tree README.txt fa96fbdb1192cdb50e1ad2fc9f4b9103fd873ce0 Kevin Rutherford kevin@rutherford-software.com http://github.com/kevinrutherford/reek/commit/c214b6c1ccb734f45b08ca244185ee5c3066da83 c214b6c1ccb734f45b08ca244185ee5c3066da83

2009-02-03T02:08:01-08:00

Updated the README to point to the wiki 2ba8d03cec5d372bbcefae327594ac5538fac469 Kevin Rutherford kevin@rutherford-software.com