This repository is private.
All pages are served over SSL and all pushing and pulling is done over SSH.
No one may fork, clone, or view it unless they are added as a member.
Every repository with this icon (
) is private.
Every repository with this icon (
This repository is public.
Anyone may fork, clone, or view it.
Every repository with this icon (
) is public.
Every repository with this icon (
reek /
| name | age | message | |
|---|---|---|---|
| |
.gitignore | Sun Sep 20 12:51:40 -0700 2009 | |
| |
History.txt | Thu Nov 19 13:54:34 -0800 2009 | |
| |
License.txt | Thu Jul 09 12:53:06 -0700 2009 | |
| |
Manifest.txt | Thu Nov 19 13:54:34 -0800 2009 | |
| |
README.rdoc | Mon Sep 21 13:25:29 -0700 2009 | |
| |
Rakefile | Mon Oct 12 06:47:36 -0700 2009 | |
| |
bin/ | Fri Jul 24 12:34:30 -0700 2009 | |
| |
config/ | Sun Nov 01 12:23:15 -0800 2009 | |
| |
features/ | Mon Nov 16 09:09:11 -0800 2009 | |
| |
lib/ | Thu Nov 19 13:54:34 -0800 2009 | |
| |
quality/ | Tue Nov 10 07:37:51 -0800 2009 | |
| |
reek.gemspec | Thu Nov 19 13:54:34 -0800 2009 | |
| |
spec/ | Thu Nov 19 13:50:04 -0800 2009 | |
| |
tasks/ | Mon Oct 12 08:49:18 -0700 2009 | |
| |
website/ | Mon Feb 09 12:17:26 -0800 2009 |
README.rdoc
Reek — code smell detection for Ruby
Reek is a tool that examines Ruby classes, modules and methods and reports any code smells it finds. Install it like this:
$ gem install reek
and run it like this:
$ reek [options] [dir_or_source_file]*
For a full list of command-line options see the Reek wiki or run
$ reek --help
Example
Imagine a source file csv_writer.rb containing:
class CsvWriter
def write_line(fields)
if (fields.length == 0)
puts
else
write_field(fields[0])
1.upto(fields.length-1) do |i|
print ","
write_field(fields[i])
end
puts
end
end
#...
end
Reek will report the following code smells in this file:
$ reek csv_writer.rb CsvWriter#write_line calls fields.length multiple times (Duplication) CsvWriter#write_line has approx 6 statements (Long Method) CsvWriter#write_line/block has the variable name 'i' (Uncommunicative Name)
Features
Reek currently includes checks for some aspects of the following smells:
- Control Couple
- Data Clump
- Feature Envy
- Large Class
- Long Method
- Long Parameter List
- Simulated Polymorphism
- Uncommunicative Name
…and more. See the Reek wiki for up to date details of exactly what Reek will check in your code.
Tool Integration
Reek integrates with many of your favourite tools:
- Use Reek::RakeTask to easily add Reek to your Rakefile
- Use Reek::Spec to add the should_not reek custom matcher to your Rspec examples
- Reek is fully compliant with Ruby 1.8.6, 1.8.7 and 1.9.1
Dependencies
Reek makes use of the following other gems:
- ruby_parser
- sexp_processor
- ruby2ruby
Learn More
Find out more about Reek from any of the following sources:
- Browse the Reek documentation at wiki.github.com/kevinrutherford/reek
- Browse the code or install the latest cutting-edge beta version from github.com/kevinrutherford/reek/tree
- Read the code API at rdoc.info/projects/kevinrutherford/reek







