reek 1.2.6 → 1.2.7

data/.yardopts

@@ -0,0 +1,10 @@
+--no-private
+--readme README.md
+lib/reek.rb
+lib/reek/*.rb
+lib/reek/smells/*.rb
+lib/reek/source/*.rb
+lib/reek/spec/*.rb
+lib/reek/rake/*.rb
+-
+*.txt

data/History.txt

@@ -1,3 +1,23 @@
+== 1.2.7 (in development)
+
+=== Major Changes
+* New option --yaml reports smells in YAML format
+* Now require 'reek/rake/task' to use the rake task
+* Now require 'reek/spec' to use the Rspec matchers
+* Developer API completely revised and documented
+
+=== Minor Changes
+* New smell: Irresponsible Module (has no meaningful comment)
+* ControlCouple no longer checks arguments yielded to blocks
+* FeatureEnvy and UtilityFunction are now subclasses of a new smell: LowCohesion
+* NestedIterators now reports the nesting depth
+* Fixed problem checking for UtilityFunctions in Object
+* Improved detection of invalid config files
+* Invalid config files are now ignored
+* Non-existent files are now ignored
+
+See http://wiki.github.com/kevinrutherford/reek for further details.
+
 == 1.2.6 (2009-11-28)
 
 === Minor Changes

data/README.md

@@ -0,0 +1,90 @@
+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[http://wiki.github.com/kevinrutherford/reek/command-line-options]
+or run
+
+    $ reek --help
+
+Example
+-------
+
+Imagine a source file <tt>csv_writer.rb</tt> 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](http://wiki.github.com/kevinrutherford/reek/control-couple)
+* [Data Clump](http://wiki.github.com/kevinrutherford/reek/data-clump)
+* [Feature Envy](http://wiki.github.com/kevinrutherford/reek/feature-envy)
+* [Large Class](http://wiki.github.com/kevinrutherford/reek/large-class)
+* [Long Method](http://wiki.github.com/kevinrutherford/reek/long-method)
+* [Long Parameter List](http://wiki.github.com/kevinrutherford/reek/long-parameter-list)
+* [Simulated Polymorphism](http://wiki.github.com/kevinrutherford/reek/simulated-polymorphism)
+* [Uncommunicative Name](http://wiki.github.com/kevinrutherford/reek/uncommunicative-name)
+
+...and more. See the [Reek wiki](http://wiki.github.com/kevinrutherford/reek/code-smells)
+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::Rake::Task` 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 [http://wiki.github.com/kevinrutherford/reek](http://wiki.github.com/kevinrutherford/reek)
+* Browse the code or install the latest cutting-edge beta version from [http://github.com/kevinrutherford/reek/tree](http://github.com/kevinrutherford/reek/tree)
+* Read the code API at [http://rdoc.info/projects/kevinrutherford/reek](http://rdoc.info/projects/kevinrutherford/reek)

data/bin/reek

@@ -6,6 +6,6 @@
 # Author: Kevin Rutherford
 #
 
-require 'reek/adapters/application'
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'lib', 'reek', 'cli', 'application')
 
-exit Reek::Application.new(ARGV).execute
+exit Reek::Cli::Application.new(ARGV).execute

data/config/defaults.reek

@@ -1,10 +1,28 @@
 --- 
+UncommunicativeParameterName: 
+  accept: 
+  - Inline::C
+  exclude: []
+
+  enabled: true
+  reject: 
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
 LargeClass: 
   max_methods: 25
   exclude: []
 
   enabled: true
   max_instance_variables: 9
+UncommunicativeMethodName: 
+  accept: []
+
+  exclude: []
+
+  enabled: true
+  reject: 
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
 LongParameterList: 
   max_params: 3
   exclude: []
@@ -20,7 +38,13 @@ FeatureEnvy:
 ClassVariable: 
   exclude: *id001
   enabled: true
-UncommunicativeName: 
+BooleanParameter: 
+  exclude: *id001
+  enabled: true
+IrresponsibleModule: 
+  exclude: *id001
+  enabled: true
+UncommunicativeModuleName: 
   accept: 
   - Inline::C
   exclude: []
@@ -51,6 +75,15 @@ Attribute:
   exclude: []
 
   enabled: false
+UncommunicativeVariableName: 
+  accept: 
+  - Inline::C
+  exclude: []
+
+  enabled: true
+  reject: 
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
 SimulatedPolymorphism: 
   exclude: []
 
@@ -70,6 +103,3 @@ LongYieldList:
   exclude: []
 
   enabled: true
-  overrides: 
-    initialize: 
-      max_params: 5

data/features/masking_smells.feature

@@ -13,21 +13,41 @@ Feature: Masking smells using config files
         Dirty has the variable name '@s' (Uncommunicative Name)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
         Dirty#a has the name 'a' (Uncommunicative Name)
-        Dirty#a/block has the variable name 'x' (Uncommunicative Name)
-        Dirty#a/block/block is nested (Nested Iterators)
+        Dirty#a has the variable name 'x' (Uncommunicative Name)
 
       """
 
   Scenario: corrupt config file prevents normal output
-    When I run reek spec/samples/corrupt_config_file/dirty.rb
-    Then the exit status indicates an error
-    And it reports the error 'Error: Invalid configuration file "corrupt.reek" -- not a Hash'
+    When I run reek spec/samples/corrupt_config_file
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/corrupt_config_file/dirty.rb -- 7 warnings:
+        Dirty has no descriptive comment (Irresponsible Module)
+        Dirty has the variable name '@s' (Uncommunicative Name)
+        Dirty#a calls @s.title twice (Duplication)
+        Dirty#a calls puts(@s.title) twice (Duplication)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
+        Dirty#a has the name 'a' (Uncommunicative Name)
+        Dirty#a has the variable name 'x' (Uncommunicative Name)
+
+      """
+    And it reports the error 'Error: Invalid configuration file "corrupt.reek" -- "This is not a config file" is not a code smell'
 
   Scenario: missing source file is an error
-    When I run reek no_such_file.rb
-    Then the exit status indicates an error
-    And it reports the error "Error: No such file or directory - no_such_file.rb"
+    When I run reek no_such_file.rb spec/samples/masked/dirty.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+        Dirty#a calls @s.title twice (Duplication)
+        Dirty#a calls puts(@s.title) twice (Duplication)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
+
+      """
+    And it reports the error "Error: No such file - no_such_file.rb"
 
   Scenario: switch off one smell
     When I run reek spec/samples/masked/dirty.rb
@@ -37,7 +57,7 @@ Feature: Masking smells using config files
       spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
-        Dirty#a/block/block is nested (Nested Iterators)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
 
       """
 
@@ -50,9 +70,9 @@ Feature: Masking smells using config files
         (masked) Dirty has the variable name '@s' (Uncommunicative Name)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
         (masked) Dirty#a has the name 'a' (Uncommunicative Name)
-        (masked) Dirty#a/block has the variable name 'x' (Uncommunicative Name)
-        Dirty#a/block/block is nested (Nested Iterators)
+        (masked) Dirty#a has the variable name 'x' (Uncommunicative Name)
 
       """
 
@@ -64,7 +84,7 @@ Feature: Masking smells using config files
       spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
-        Dirty#a/block/block is nested (Nested Iterators)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
 
       """
 
@@ -77,8 +97,8 @@ Feature: Masking smells using config files
         Dirty has the variable name '@s' (Uncommunicative Name)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
         Dirty#a has the name 'a' (Uncommunicative Name)
-        Dirty#a/block/block is nested (Nested Iterators)
 
       """
 
@@ -104,8 +124,8 @@ Feature: Masking smells using config files
         (masked) Dirty has the variable name '@s' (Uncommunicative Name)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
+        (masked) Dirty#a contains iterators nested 2 deep (Nested Iterators)
         (masked) Dirty#a has the name 'a' (Uncommunicative Name)
-        (masked) Dirty#a/block has the variable name 'x' (Uncommunicative Name)
-        (masked) Dirty#a/block/block is nested (Nested Iterators)
+        (masked) Dirty#a has the variable name 'x' (Uncommunicative Name)
 
       """

data/features/options.feature

@@ -8,6 +8,7 @@ Feature: Reek can be controlled using command-line options
     When I run reek --no-such-option
     Then the exit status indicates an error
     And it reports the error "Error: invalid option: --no-such-option"
+    And stdout equals ""
 
   Scenario: display the current version number
     When I run reek --version
@@ -37,5 +38,6 @@ Feature: Reek can be controlled using command-line options
       Report formatting:
           -a, --[no-]show-all              Show all smells, including those masked by config settings
           -q, --[no-]quiet                 Suppress headings for smell-free source files
+          -y, --yaml                       Report smells in YAML format
 
       """

data/features/rake_task.feature

@@ -1,12 +1,12 @@
 @rake
-Feature: Reek can be driven through its RakeTask
+Feature: Reek can be driven through its Task
   Reek provides an easy way to integrate its use into Rakefiles,
-  via the RakeTask class. These scenarios test its various options.
+  via the Task class. These scenarios test its various options.
 
   Scenario: source_files points at the desired files
     When I run rake reek with:
       """
-      Reek::RakeTask.new do |t|
+      Reek::Rake::Task.new do |t|
         t.source_files = 'spec/samples/masked/dirty.rb'
       end
       """
@@ -16,13 +16,13 @@ Feature: Reek can be driven through its RakeTask
       spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
-        Dirty#a/block/block is nested (Nested Iterators)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
       """
 
   Scenario: name changes the task name
     When I run rake silky with:
       """
-      Reek::RakeTask.new('silky') do |t|
+      Reek::Rake::Task.new('silky') do |t|
         t.source_files = 'spec/samples/masked/dirty.rb'
       end
       """
@@ -32,31 +32,24 @@ Feature: Reek can be driven through its RakeTask
       spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
-        Dirty#a/block/block is nested (Nested Iterators)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
       """
 
   Scenario: verbose prints the reek command
     When I run rake reek with:
       """
-      Reek::RakeTask.new do |t|
+      Reek::Rake::Task.new do |t|
         t.source_files = 'spec/samples/masked/dirty.rb'
         t.verbose = true
       end
       """
     Then the exit status indicates an error
-    And it reports:
-      """
-      /usr/bin/ruby1.8 -I"/home/kevin/Working/git/reek/lib" "/home/kevin/Working/git/reek/bin/reek"  "spec/samples/masked/dirty.rb"
-      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
-        Dirty#a calls @s.title twice (Duplication)
-        Dirty#a calls puts(@s.title) twice (Duplication)
-        Dirty#a/block/block is nested (Nested Iterators)
-      """
+    And stdout includes /spec\/samples\/masked\/dirty\.rb/
 
   Scenario: fail_on_error can hide the error status
     When I run rake reek with:
       """
-      Reek::RakeTask.new do |t|
+      Reek::Rake::Task.new do |t|
         t.fail_on_error = false
         t.source_files = 'spec/samples/empty_config_file/dirty.rb'
       end
@@ -68,7 +61,7 @@ Feature: Reek can be driven through its RakeTask
         Dirty has the variable name '@s' (Uncommunicative Name)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
         Dirty#a has the name 'a' (Uncommunicative Name)
-        Dirty#a/block has the variable name 'x' (Uncommunicative Name)
-        Dirty#a/block/block is nested (Nested Iterators)
+        Dirty#a has the variable name 'x' (Uncommunicative Name)
       """

data/features/reports.feature

@@ -13,16 +13,16 @@ Feature: Correctly formatted reports
         Dirty has the variable name '@s' (Uncommunicative Name)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
         Dirty#a has the name 'a' (Uncommunicative Name)
-        Dirty#a/block has the variable name 'x' (Uncommunicative Name)
-        Dirty#a/block/block is nested (Nested Iterators)
+        Dirty#a has the variable name 'x' (Uncommunicative Name)
       spec/samples/two_smelly_files/dirty_two.rb -- 6 warnings:
         Dirty has the variable name '@s' (Uncommunicative Name)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
+        Dirty#a contains iterators nested 2 deep (Nested Iterators)
         Dirty#a has the name 'a' (Uncommunicative Name)
-        Dirty#a/block has the variable name 'x' (Uncommunicative Name)
-        Dirty#a/block/block is nested (Nested Iterators)
+        Dirty#a has the variable name 'x' (Uncommunicative Name)
 
       """
 
@@ -50,11 +50,7 @@ Feature: Correctly formatted reports
   Scenario Outline: --quiet turns off headers for fragrant files
     When I run reek <option> spec/samples/three_clean_files/*.rb
     Then it succeeds
-    And it reports:
-      """
-
-
-      """
+    And stdout equals ""
 
     Examples:
       | option  |
@@ -67,20 +63,22 @@ Feature: Correctly formatted reports
     Then it succeeds
     And it reports:
       """
-      spec/samples/clean_due_to_masking/dirty_one.rb -- 0 warnings (+6 masked):
+      spec/samples/clean_due_to_masking/dirty_one.rb -- 0 warnings (+7 masked):
+        (masked) Dirty has no descriptive comment (Irresponsible Module)
         (masked) Dirty has the variable name '@s' (Uncommunicative Name)
         (masked) Dirty#a calls @s.title twice (Duplication)
         (masked) Dirty#a calls puts(@s.title) twice (Duplication)
+        (masked) Dirty#a contains iterators nested 2 deep (Nested Iterators)
         (masked) Dirty#a has the name 'a' (Uncommunicative Name)
-        (masked) Dirty#a/block has the variable name 'x' (Uncommunicative Name)
-        (masked) Dirty#a/block/block is nested (Nested Iterators)
-      spec/samples/clean_due_to_masking/dirty_two.rb -- 0 warnings (+6 masked):
+        (masked) Dirty#a has the variable name 'x' (Uncommunicative Name)
+      spec/samples/clean_due_to_masking/dirty_two.rb -- 0 warnings (+7 masked):
+        (masked) Dirty has no descriptive comment (Irresponsible Module)
         (masked) Dirty has the variable name '@s' (Uncommunicative Name)
         (masked) Dirty#a calls @s.title twice (Duplication)
         (masked) Dirty#a calls puts(@s.title) twice (Duplication)
+        (masked) Dirty#a contains iterators nested 2 deep (Nested Iterators)
         (masked) Dirty#a has the name 'a' (Uncommunicative Name)
-        (masked) Dirty#a/block has the variable name 'x' (Uncommunicative Name)
-        (masked) Dirty#a/block/block is nested (Nested Iterators)
+        (masked) Dirty#a has the variable name 'x' (Uncommunicative Name)
 
       """