reek 1.1.3 → 1.2.0

data/History.txt

@@ -1,10 +1,50 @@
+== 1.2 2009-09-20
+
+=== Major Changes
+* Reek passes all its tests under ruby 1.8.6, 1.8.7 and 1.9.1 (fixed #16)
+* New smell -- Data Clump:
+** Looks within a class for 3 or more methods taking the same 2 or more parameters
+* New smell -- Simulated Polymorphism:
+** Currently only performs basic check for multiple tests of same value
+* Reek's output reports are now formatted differently:
+** Reek is no longer silent about smell-free source code
+** Output now reports on all files examined, even if they have no smells
+** Smell warnings are indented in the report; file summary headers are not
+** Reports for multiple sources are run together; no more blank lines
+** Reports in spec matcher failures are quiet (fixed #38)
+* The smells masked by *.reek config files can now be seen:
+** The header for each source file now counts masked smells
+** The --show-all (-a) option shows masked warnings in the report
+* The spec matchers are now accessed by requiring 'reek/adapters/spec'
+
+=== Minor Changes
+* Reek's RDoc is now hosted at http://rdoc.info/projects/kevinrutherford/reek
+* If a dir is passed on the command-line all **/*.rb files below it are examined (fixed #41)
+* Duplication warnings now report the number of identical calls
+* FeatureEnvy no longer ignores :self when passed as a method parameter
+* LargeClass is disabled when checking in-memory classes (fixed #28)
+* LongParameterList accepts upto 5 parameters for #initialize methods
+* Several changes to the LongMethod counting algorithm:
+** LongMethod now counts statements deeper into each method (fixed #25)
+** LongMethod no longer counts control structures, only their contained stmts
+** See http://wiki.github.com/kevinrutherford/reek/long-method for details
+* UncommunicativeName warns about any name ending in a number (fixed #18)
+* UtilityFunction has been relaxed somewhat:
+** no longer reports methods that call 'super' (fixed #39)
+** no longer reports simple helper methods
+** can be configured based on number of calls out
+* Now reports an error for corrupt config files
+* Empty config files are ignored
+* Smells can be configured with scope-specific overrides for any config item
+
+
 == 1.1.3 2009-05-19
 
 === Minor Changes
 * No longer depends directly on the sexp_processor gem
 
 === Fixes
-* LargeClass now relies only on the given source code (#26)
+* LargeClass now relies only on the given source code (fixed #26)
 
 == 1.1.2 2009-05-18
 
@@ -15,7 +55,7 @@
 == 1.1.1 2009-05-08
 
 === Minor enhancements
-* LargeClass now also warns about any class with > 9 instance variables (#6)
+* LargeClass now also warns about any class with > 9 instance variables (fixed #6)
 * Now depends on ruby2ruby, to display code better
 * Duplication notices more repeated method calls
 * Smells within blocks are now reported better
@@ -23,7 +63,7 @@
 == 1.1.0 2009-04-10
 
 === Minor enhancements
-* Now possible to write 'MyClass.should_not reek' (#33)
+* Now possible to write 'MyClass.should_not reek' (fixed #33)
 
 === Fixes
 * Now counts attr assignments ([]= etc) in feature envy calculations
@@ -32,7 +72,7 @@
 == 1.0.1 2009-04-06
 
 === Fixes
-* Dir[...].to_source now creates a Report that can be browsed (#36)
+* Dir[...].to_source now creates a Report that can be browsed (fixed #36)
 
 == 1.0.0 2009-04-05
 

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008,2009 Kevin Rutherford
+
+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.

data/README.rdoc

@@ -0,0 +1,83 @@
+= 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 <tt>Reek::RakeTask</tt> to easily add Reek to your Rakefile
+* Use <tt>Reek::Spec</tt> to add the <tt>should_not reek</tt> 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
+
+== Learn More
+
+Find out more about Reek from any of the following sources:
+
+* Browse the Reek documentation at http://wiki.github.com/kevinrutherford/reek
+* Browse the code or install the latest cutting-edge beta version from http://github.com/kevinrutherford/reek/tree
+* Read the code API at http://rdoc.info/projects/kevinrutherford/reek

data/Rakefile

@@ -7,7 +7,6 @@ PROJECT_NAME = 'reek'
 
 BUILD_DIR = 'build'; directory BUILD_DIR
 PKG_DIR = "#{BUILD_DIR}/pkg"; directory PKG_DIR
-RDOC_DIR = "#{BUILD_DIR}/rdoc"; directory RDOC_DIR
 
 GEM_MANIFEST = "Manifest.txt"
 VERSION_FILE = 'lib/reek.rb'

data/bin/reek

@@ -1,19 +1,11 @@
 #!/usr/bin/env ruby
 #
 # Reek examines Ruby source code for smells.
-# Visit http://reek.rubyforge.org/ for docs etc.
+# Visit http://wiki.github.com/kevinrutherford/reek for docs etc.
 #
 # Author: Kevin Rutherford
 #
 
-require 'reek'
-require 'reek/source'
-require 'reek/options'
+require 'reek/adapters/application'
 
-exitstatus = 0
-source = Reek::Options.parse(ARGV)
-if source.smelly?
-  puts source.report
-  exitstatus = 2
-end
-exit(exitstatus)
+exit Reek::Application.new(ARGV).execute

data/config/defaults.reek

@@ -10,6 +10,9 @@ LongParameterList:
   exclude: []
 
   enabled: true
+  overrides: 
+    initialize: 
+      max_params: 5
 FeatureEnvy: 
   exclude: 
   - initialize
@@ -21,7 +24,8 @@ UncommunicativeName:
 
   enabled: true
   reject: 
-  - !ruby/regexp /^.[0-9]*$/
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
 NestedIterators: 
   exclude: []
 
@@ -37,9 +41,21 @@ Duplication:
   enabled: true
   max_calls: 1
 UtilityFunction: 
+  max_helper_calls: 1
   exclude: []
 
   enabled: true
+SimulatedPolymorphism: 
+  exclude: []
+
+  enabled: true
+  max_ifs: 2
+DataClump: 
+  exclude: []
+
+  enabled: true
+  max_copies: 2
+  min_clump_size: 2
 ControlCouple: 
   exclude: 
   - initialize
@@ -49,3 +65,6 @@ LongYieldList:
   exclude: []
 
   enabled: true
+  overrides: 
+    initialize: 
+      max_params: 5

data/features/masking_smells.feature

@@ -0,0 +1,111 @@
+@masking
+Feature: Masking smells using config files
+  In order to keep my reports meaningful
+  As a developer
+  I want to mask some smells using config files
+
+  Scenario: empty config file is ignored
+    When I run reek spec/samples/empty_config_file/dirty.rb
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/empty_config_file/dirty.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 has the name 'a' (Uncommunicative Name)
+        Dirty#a/block has the variable name 'x' (Uncommunicative Name)
+        Dirty#a/block/block is nested (Nested Iterators)
+
+      """
+
+  Scenario: corrupt config file prevents normal output
+    When I run reek spec/samples/corrupt_config_file/dirty.rb
+    Then it fails with exit status 1
+    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 it fails with exit status 1
+    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
+    Then it fails with exit status 2
+    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/block/block is nested (Nested Iterators)
+
+      """
+
+  Scenario: switch off one smell but show all in the report
+    When I run reek --show-all spec/samples/masked/dirty.rb
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+        (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 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)
+
+      """
+
+  Scenario: switch off one smell and hide them in the report
+    When I run reek --no-show-all spec/samples/masked/dirty.rb
+    Then it fails with exit status 2
+    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/block/block is nested (Nested Iterators)
+
+      """
+
+  Scenario: non-masked smells are only counted once
+    When I run reek spec/samples/not_quite_masked/dirty.rb
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/not_quite_masked/dirty.rb -- 5 warnings (+1 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 has the name 'a' (Uncommunicative Name)
+        Dirty#a/block/block is nested (Nested Iterators)
+
+      """
+
+  @overrides
+  Scenario: lower overrides upper
+    When I run reek spec/samples/overrides
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/overrides/masked/dirty.rb -- 2 warnings (+4 masked):
+        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
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/overrides/masked/dirty.rb -- 2 warnings (+4 masked):
+        (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 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)
+
+      """

data/features/options.feature

@@ -0,0 +1,49 @@
+@options
+Feature: Reek can be controlled using command-line options
+  In order to change reek's default behaviour
+  As a developer
+  I want to supply options on the command line
+
+  Scenario: return non-zero status on bad option
+    When I run reek --no-such-option
+    Then it fails with exit status 1
+    And it reports the error "Error: invalid option: --no-such-option"
+
+  Scenario: return non-zero status on missing argument
+    When I run reek -f
+    Then it fails with exit status 1
+    And it reports the error "Error: missing argument: -f"
+
+  Scenario: display the current version number
+    When I run reek --version
+    Then it succeeds
+    And it reports the current version
+
+  Scenario: display the help information
+    When I run reek --help
+    Then it succeeds
+    And it reports:
+      """
+      Usage: reek [options] [files]
+
+      Examples:
+
+      reek lib/*.rb
+      reek -q -a lib
+      cat my_class.rb | reek
+
+      See http://wiki.github.com/kevinrutherford/reek for detailed help.
+
+      Common options:
+          -h, --help                       Show this message
+          -v, --version                    Show version
+
+
+      Report formatting:
+          -a, --[no-]show-all              Show all smells, including those masked by config settings
+          -q, --quiet                      Suppress headings for smell-free source files
+          -f, --format FORMAT              Specify the format of smell warnings
+          -c, --context-first              Sort by context; sets the format string to "%m%c %w (%s)"
+          -s, --smell-first                Sort by smell; sets the format string to "%m[%s] %c %w"
+
+      """

data/features/reports.feature

@@ -0,0 +1,90 @@
+@reports
+Feature: Correctly formatted reports
+  In order to get the most out of reek
+  As a developer
+  I want to be able to parse reek's output simply and consistently
+
+  Scenario Outline: two reports run together with indented smells
+    When I run reek <args>
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/two_smelly_files/dirty_one.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 has the name 'a' (Uncommunicative Name)
+        Dirty#a/block has the variable name 'x' (Uncommunicative Name)
+        Dirty#a/block/block is nested (Nested Iterators)
+      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 has the name 'a' (Uncommunicative Name)
+        Dirty#a/block has the variable name 'x' (Uncommunicative Name)
+        Dirty#a/block/block is nested (Nested Iterators)
+
+      """
+
+    Examples:
+      | args                               |
+      | spec/samples/two_smelly_files/*.rb |
+      | spec/samples/two_smelly_files      |
+
+  Scenario Outline: good files show headers consecutively
+    When I run reek <args>
+    Then it succeeds
+    And it reports:
+      """
+      spec/samples/three_clean_files/clean_one.rb -- 0 warnings
+      spec/samples/three_clean_files/clean_three.rb -- 0 warnings
+      spec/samples/three_clean_files/clean_two.rb -- 0 warnings
+
+      """
+
+    Examples:
+      | args |
+      | spec/samples/three_clean_files/*.rb |
+      | spec/samples/three_clean_files      |
+
+  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:
+      """
+
+
+      """
+
+    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    |