reek 1.2.6 → 1.2.8

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,65 @@
+== 1.2.8 (2010-04-26)
+
+=== Major Changes
+* Smell detectors can be configured or disabled in code comments
+** Comment with :reek:smell_name disables the named smell for a class, module or method
+** Comment with :reek:smell_name:{...} for more detailed configuration
+* Additional config file(s) can be specified:
+** on the command-line using -c
+** via Reek::Rake::Task in the rakefile
+
+=== Minor Changes
+* Duplication can be configured to ignore specific calls
+* IrresponsibleModule now reports scoped module names correctly (#66)
+* NestedIterators is now more configurable:
+** Option to specify permitted nesting depth (#14)
+** Option to ignore certain iterator methods
+
+== 1.2.7.3 (2010-03-29)
+
+=== Minor Changes
+* UtilityFunction no longer reported when local method called in param initializer (#60)
+* Spaces removed from smell class names in report output
+* Masked smells are no longer reported
+** the -a command-line option has been removed
+** some methods on Examiner are now deprecated
+* DataClump no longer needs infinite memory for large classes (#57 again)
+
+== 1.2.7.2 (2010-03-05)
+
+=== Minor Changes
+* Number of masked smells is no longer shown in report headers
+* Masked smells are no longer listed in --yaml reports
+* DataClump no longer needs infinite memory for large classes (#57)
+* DataClump reports the names of the offending methods in the YAML report
+* UncommunicativeMethodName now accepts operator names (+, -, ...)
+* Uncommunicative Name now warns about uppercase letters in method & var names
+
+== 1.2.7.1 (2010-02-03)
+
+=== Minor Changes
+* Fixed crash on a case statement with no condition (#58)
+
+== 1.2.7 (2010-02-01)
+
+=== 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,74 @@
+# 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>demo.rb</tt> containing:
+
+    class Dirty
+      # This method smells of :reek:NestedIterators but ignores them
+      def awful(x, y, offset = 0, log = false)
+        puts @screen.title
+        @screen = widgets.map {|w| w.each {|key| key += 3}}
+        puts @screen.contents
+      end
+    end
+
+Reek will report the following code smells in this file:
+
+    $ reek demo.rb
+    spec/samples/demo/demo.rb -- 6 warnings:
+      Dirty has no descriptive comment (IrresponsibleModule)
+      Dirty#awful has 4 parameters (LongParameterList)
+      Dirty#awful has boolean parameter 'log' (ControlCouple)
+      Dirty#awful has the parameter name 'x' (UncommunicativeName)
+      Dirty#awful has the parameter name 'y' (UncommunicativeName)
+      Dirty#awful has the variable name 'w' (UncommunicativeName)
+
+## Features
+
+Reek currently includes checks for some aspects of Control Couple,
+Data Clump, Feature Envy, Large Class, Long Method, Long Parameter List,
+Simulated Polymorphism, 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:
+
+* `require 'reek/rake/task'` to easily add Reek to your Rakefile
+* `require '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 development 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)
+* Follow [@rubyreek](http://twitter.com/rubyreek) on twitter!

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,30 @@
 --- 
+UncommunicativeParameterName: 
+  accept: []
+
+  exclude: []
+
+  enabled: true
+  reject: 
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
 LargeClass: 
   max_methods: 25
   exclude: []
 
   enabled: true
   max_instance_variables: 9
+UncommunicativeMethodName: 
+  accept: []
+
+  exclude: []
+
+  enabled: true
+  reject: 
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
 LongParameterList: 
   max_params: 3
   exclude: []
@@ -20,7 +40,13 @@ FeatureEnvy:
 ClassVariable: 
   exclude: *id001
   enabled: true
-UncommunicativeName: 
+BooleanParameter: 
+  exclude: *id001
+  enabled: true
+IrresponsibleModule: 
+  exclude: *id001
+  enabled: true
+UncommunicativeModuleName: 
   accept: 
   - Inline::C
   exclude: []
@@ -30,14 +56,20 @@ UncommunicativeName:
   - !ruby/regexp /^.$/
   - !ruby/regexp /[0-9]$/
 NestedIterators: 
-  exclude: *id001
+  ignore_iterators: []
+
+  exclude: []
+
   enabled: true
+  max_allowed_nesting: 1
 LongMethod: 
   max_statements: 5
   exclude: 
   - initialize
   enabled: true
 Duplication: 
+  allow_calls: []
+
   exclude: []
 
   enabled: true
@@ -51,6 +83,16 @@ Attribute:
   exclude: []
 
   enabled: false
+UncommunicativeVariableName: 
+  accept: []
+
+  exclude: []
+
+  enabled: true
+  reject: 
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
 SimulatedPolymorphism: 
   exclude: []
 
@@ -70,6 +112,3 @@ LongYieldList:
   exclude: []
 
   enabled: true
-  overrides: 
-    initialize: 
-      max_params: 5

data/features/api.feature

@@ -0,0 +1,20 @@
+@masking
+Feature: The Reek API maintains backwards compatibility
+  In order to use Reek witthout fuss
+  As a developer
+  I want to mave a stable API
+
+  Scenario: the demo example reports as expected
+    When I run reek spec/samples/demo
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/demo/demo.rb -- 6 warnings:
+        Dirty has no descriptive comment (IrresponsibleModule)
+        Dirty#awful has 4 parameters (LongParameterList)
+        Dirty#awful has boolean parameter 'log' (ControlCouple)
+        Dirty#awful has the parameter name 'x' (UncommunicativeName)
+        Dirty#awful has the parameter name 'y' (UncommunicativeName)
+        Dirty#awful has the variable name 'w' (UncommunicativeName)
+
+      """

data/features/masking_smells.feature

@@ -10,61 +10,54 @@ Feature: Masking smells using config files
     And it reports:
       """
       spec/samples/empty_config_file/dirty.rb -- 6 warnings:
-        Dirty has the variable name '@s' (Uncommunicative Name)
+        Dirty has the variable name '@s' (UncommunicativeName)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
-        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 contains iterators nested 2 deep (NestedIterators)
+        Dirty#a has the name 'a' (UncommunicativeName)
+        Dirty#a has the variable name 'x' (UncommunicativeName)
 
       """
 
   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'
-
-  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"
-
-  Scenario: switch off one smell
-    When I run reek spec/samples/masked/dirty.rb
+    When I run reek spec/samples/corrupt_config_file
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+      spec/samples/corrupt_config_file/dirty.rb -- 7 warnings:
+        Dirty has no descriptive comment (IrresponsibleModule)
+        Dirty has the variable name '@s' (UncommunicativeName)
         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 (NestedIterators)
+        Dirty#a has the name 'a' (UncommunicativeName)
+        Dirty#a has the variable name 'x' (UncommunicativeName)
 
       """
+    And it reports the error 'Error: Invalid configuration file "corrupt.reek" -- "This is not a config file" is not a code smell'
 
-  Scenario: switch off one smell but show all in the report
-    When I run reek --show-all spec/samples/masked/dirty.rb
+  Scenario: missing source file is an error
+    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):
-        (masked) Dirty has the variable name '@s' (Uncommunicative Name)
+      spec/samples/masked/dirty.rb -- 3 warnings:
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
-        (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)
+        Dirty#a contains iterators nested 2 deep (NestedIterators)
 
       """
+    And it reports the error "Error: No such file - no_such_file.rb"
 
-  Scenario: switch off one smell and hide them in the report
-    When I run reek --no-show-all spec/samples/masked/dirty.rb
+  Scenario: switch off one smell
+    When I run reek spec/samples/masked/dirty.rb
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+      spec/samples/masked/dirty.rb -- 3 warnings:
         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 (NestedIterators)
 
       """
 
@@ -73,12 +66,12 @@ Feature: Masking smells using config files
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/not_quite_masked/dirty.rb -- 5 warnings (+1 masked):
-        Dirty has the variable name '@s' (Uncommunicative Name)
+      spec/samples/not_quite_masked/dirty.rb -- 5 warnings:
+        Dirty has the variable name '@s' (UncommunicativeName)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
-        Dirty#a has the name 'a' (Uncommunicative Name)
-        Dirty#a/block/block is nested (Nested Iterators)
+        Dirty#a contains iterators nested 2 deep (NestedIterators)
+        Dirty#a has the name 'a' (UncommunicativeName)
 
       """
 
@@ -88,24 +81,49 @@ Feature: Masking smells using config files
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/overrides/masked/dirty.rb -- 2 warnings (+4 masked):
+      spec/samples/overrides/masked/dirty.rb -- 2 warnings:
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
 
       """
 
-  @overrides
-  Scenario: all show up masked even when overridden
-    When I run reek --show-all spec/samples/overrides
+  Scenario: allow masking some calls for duplication smell
+    When I run reek spec/samples/mask_some/dirty.rb
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/overrides/masked/dirty.rb -- 2 warnings (+4 masked):
-        (masked) Dirty has the variable name '@s' (Uncommunicative Name)
+      spec/samples/mask_some/dirty.rb -- 2 warnings:
         Dirty#a calls @s.title twice (Duplication)
-        Dirty#a calls puts(@s.title) twice (Duplication)
-        (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)
+        Dirty#a contains iterators nested 2 deep (NestedIterators)
+
+      """
+
+  @comments
+  Scenario: provide extra masking inline in comments
+    When I run reek spec/samples/inline_config
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/inline_config/dirty.rb -- 1 warning:
+        Dirty#a calls @s.title twice (Duplication)
+
+      """
+
+  Scenario: supports a config file
+    When I run reek -c spec/samples/config/allow_duplication.reek spec/samples/masked/dirty.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/masked/dirty.rb -- 1 warning:
+        Dirty#a contains iterators nested 2 deep (NestedIterators)
+
+      """
+
+  Scenario: supports multiple config files
+    When I run reek -c spec/samples/config/allow_duplication.reek -c spec/samples/config/deeper_nested_iterators.reek spec/samples/masked/dirty.rb
+    Then it succeeds
+    And it reports:
+      """
+      spec/samples/masked/dirty.rb -- 0 warnings
 
       """

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
@@ -24,7 +25,7 @@ Feature: Reek can be controlled using command-line options
       Examples:
 
       reek lib/*.rb
-      reek -q -a lib
+      reek -q lib
       cat my_class.rb | reek
 
       See http://wiki.github.com/kevinrutherford/reek for detailed help.
@@ -34,8 +35,12 @@ Feature: Reek can be controlled using command-line options
           -v, --version                    Show version
 
 
+      Configuration:
+          -c, --config FILE                Read configuration options from FILE
+
+
       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,62 +1,55 @@
 @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
       """
     Then the exit status indicates an error
     And it reports:
       """
-      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+      spec/samples/masked/dirty.rb -- 3 warnings:
         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 (NestedIterators)
       """
 
   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
       """
     Then the exit status indicates an error
     And it reports:
       """
-      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+      spec/samples/masked/dirty.rb -- 3 warnings:
         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 (NestedIterators)
       """
 
   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
@@ -65,10 +58,24 @@ Feature: Reek can be driven through its RakeTask
     And it reports:
       """
       spec/samples/empty_config_file/dirty.rb -- 6 warnings:
-        Dirty has the variable name '@s' (Uncommunicative Name)
+        Dirty has the variable name '@s' (UncommunicativeName)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
-        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 contains iterators nested 2 deep (NestedIterators)
+        Dirty#a has the name 'a' (UncommunicativeName)
+        Dirty#a has the variable name 'x' (UncommunicativeName)
+      """
+
+  Scenario: can be configured with config_files
+    When I run rake reek with:
+      """
+      Reek::Rake::Task.new do |t|
+        t.config_files = 'spec/samples/config/**/*.reek'
+        t.source_files = 'spec/samples/masked/dirty.rb'
+      end
+      """
+    Then it succeeds
+    And it reports:
+      """
+      spec/samples/masked/dirty.rb -- 0 warnings
       """

data/features/reports.feature

@@ -10,19 +10,19 @@ Feature: Correctly formatted reports
     And it reports:
       """
       spec/samples/two_smelly_files/dirty_one.rb -- 6 warnings:
-        Dirty has the variable name '@s' (Uncommunicative Name)
+        Dirty has the variable name '@s' (UncommunicativeName)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
-        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 contains iterators nested 2 deep (NestedIterators)
+        Dirty#a has the name 'a' (UncommunicativeName)
+        Dirty#a has the variable name 'x' (UncommunicativeName)
       spec/samples/two_smelly_files/dirty_two.rb -- 6 warnings:
-        Dirty has the variable name '@s' (Uncommunicative Name)
+        Dirty has the variable name '@s' (UncommunicativeName)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
-        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 contains iterators nested 2 deep (NestedIterators)
+        Dirty#a has the name 'a' (UncommunicativeName)
+        Dirty#a has the variable name 'x' (UncommunicativeName)
 
       """
 
@@ -50,41 +50,9 @@ 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  |
       | -q      |
       | --quiet |
-
-
-  Scenario Outline: -a turns on details in presence of -q
-    When I run reek <options> spec/samples/clean_due_to_masking/*.rb
-    Then it succeeds
-    And it reports:
-      """
-      spec/samples/clean_due_to_masking/dirty_one.rb -- 0 warnings (+6 masked):
-        (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 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 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 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)
-
-      """
-
-    Examples:
-      | options  |
-      | -q -a    |
-      | -a -q    |