reek 1.2.7.3 → 1.2.8

data/History.txt

@@ -1,3 +1,20 @@
+== 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

data/README.md

@@ -1,5 +1,4 @@
-Reek -- code smell detection for Ruby
-=====================================
+# 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:
@@ -16,63 +15,47 @@ 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
+## 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 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)
+    $ 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
-----------------
+### 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
+* `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
-------------
+### Dependencies
 
 Reek makes use of the following other gems:
 
@@ -86,5 +69,6 @@ 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)
+* 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/config/defaults.reek

@@ -56,14 +56,20 @@ UncommunicativeModuleName:
   - !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

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

@@ -86,3 +86,44 @@ Feature: Masking smells using config files
         Dirty#a calls puts(@s.title) twice (Duplication)
 
       """
+
+  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/mask_some/dirty.rb -- 2 warnings:
+        Dirty#a calls @s.title twice (Duplication)
+        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

@@ -35,6 +35,10 @@ Feature: Reek can be controlled using command-line options
           -v, --version                    Show version
 
 
+      Configuration:
+          -c, --config FILE                Read configuration options from FILE
+
+
       Report formatting:
           -q, --[no-]quiet                 Suppress headings for smell-free source files
           -y, --yaml                       Report smells in YAML format

data/features/rake_task.feature

@@ -65,3 +65,17 @@ Feature: Reek can be driven through its Task
         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/yaml.feature

@@ -54,7 +54,7 @@ Feature: Report smells using simple YAML layout
         smell: 
           class: NestedIterators
           depth: 2
-          subclass: ""
+          subclass: NestedIterators
           message: contains iterators nested 2 deep
         status: 
           is_active: true
@@ -63,7 +63,7 @@ Feature: Report smells using simple YAML layout
 
   @stdin
   Scenario: return non-zero status when there are smells
-    When I pass "# test class\nclass Turn; def fred(arg = true) end end" to reek --yaml
+    When I pass "class Turn; end" to reek --yaml
     Then the exit status indicates smells
     And it reports:
       """
@@ -71,14 +71,14 @@ Feature: Report smells using simple YAML layout
       - !ruby/object:Reek::SmellWarning 
         location: 
           lines: 
-          - 2
-          context: Turn#fred
+          - 1
+          context: Turn
           source: $stdin
         smell: 
-          parameter: arg
-          class: ControlCouple
-          subclass: BooleanParameter
-          message: has boolean parameter 'arg'
+          class: IrresponsibleModule
+          subclass: IrresponsibleModule
+          module_name: Turn
+          message: has no descriptive comment
         status: 
           is_active: true
 

data/lib/reek.rb

@@ -2,7 +2,7 @@
 # Reek's core functionality
 #
 module Reek
-  VERSION = '1.2.7.3'
+  VERSION = '1.2.8'
 end
 
 require File.join(File.dirname(File.expand_path(__FILE__)), 'reek', 'examiner')

data/lib/reek/cli/command_line.rb

@@ -19,6 +19,7 @@ module Reek
         @parser = OptionParser.new
         @report_class = VerboseReport
         @command_class = ReekCommand
+        @config_files = []
         set_options
       end
 
@@ -35,6 +36,7 @@ module Reek
         # reek -v|--version        Output the tool's version number
         #
         # reek [options] files     List the smells in the given files
+        #      -c|--config file    Specify file(s) with config options
         #      -q|-[no-]quiet      Only list files that have smells
         #      files               Names of files or dirs to be checked
         #
@@ -62,6 +64,11 @@ EOB
           @command_class = VersionCommand
         end
 
+        @parser.separator "\nConfiguration:"
+        @parser.on("-c", "--config FILE", "Read configuration options from FILE") do |file|
+          @config_files << file
+        end
+
         @parser.separator "\nReport formatting:"
         @parser.on("-q", "--[no-]quiet", "Suppress headings for smell-free source files") do |opt|
           @report_class = opt ? QuietReport : VerboseReport
@@ -82,10 +89,10 @@ EOB
           VersionCommand.new(@parser.program_name)
         elsif @command_class == YamlCommand
           sources = get_sources
-          YamlCommand.create(sources)
+          YamlCommand.create(sources, @config_files)
         else
           sources = get_sources
-          ReekCommand.create(sources, @report_class)
+          ReekCommand.create(sources, @report_class, @config_files)
         end
       end
 

data/lib/reek/cli/reek_command.rb

@@ -8,19 +8,20 @@ module Reek
     # text report format.
     #
     class ReekCommand
-      def self.create(sources, report_class)
-        new(report_class, sources)
+      def self.create(sources, report_class, config_files = [])
+        new(report_class, sources, config_files)
       end
 
-      def initialize(report_class, sources)
+      def initialize(report_class, sources, config_files = [])
         @sources = sources
         @report_class = report_class
+        @config_files = config_files
       end
 
       def execute(view)
         had_smells = false
         @sources.each do |source|
-          examiner = Examiner.new(source)
+          examiner = Examiner.new(source, @config_files)
           rpt = @report_class.new(examiner)
           had_smells ||= examiner.smelly?
           view.output(rpt.report)

data/lib/reek/cli/yaml_command.rb

@@ -8,8 +8,8 @@ module Reek
     # YAML format.
     #
     class YamlCommand
-      def self.create(sources)
-        examiners = sources.map {|src| Examiner.new(src) }
+      def self.create(sources, config_files)
+        examiners = sources.map {|src| Examiner.new(src, config_files) }
         new(examiners)
       end
 

data/lib/reek/core/code_context.rb

@@ -10,11 +10,12 @@ module Reek
     #
     class CodeContext
 
-      attr_reader :exp
+      attr_reader :exp, :config
 
       def initialize(outer, exp)
         @outer = outer
         @exp = exp
+        @config = local_config
       end
 
       def name
@@ -50,6 +51,14 @@ module Reek
         outer = @outer ? @outer.full_name : ''
         exp.full_name(outer)
       end
+
+      def local_config
+        return Hash.new if @exp.nil?
+        config = Source::CodeComment.new(@exp.comments || '').config
+        return config unless @outer
+        @outer.config.deep_copy.adopt!(config)
+        # no tests for this -----^
+      end
     end
   end
 end

data/lib/reek/core/method_context.rb

@@ -10,10 +10,10 @@ module Reek
     module MethodParameters
       def default_assignments
         assignments = self[-1]
-        result = {}
+        result = []
         return result unless is_assignment_block?(assignments)
         assignments[1..-1].each do |exp|
-          result[exp[1]] = exp[2] if exp[0] == :lasgn
+          result << exp[1..2] if exp[0] == :lasgn
         end
         result
       end

data/lib/reek/core/sniffer.rb

@@ -1,5 +1,6 @@
 require File.join(File.dirname(File.expand_path(__FILE__)), 'code_parser')
 require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smells')
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'source', 'config_file')
 require 'yaml'
 
 #
@@ -64,12 +65,13 @@ module Reek
         ]
       end
 
-      def initialize(src)
+      def initialize(src, config_files = [])
         @typed_detectors = nil
         @detectors = Hash.new
         Sniffer.smell_classes.each do |klass|
           @detectors[klass] = klass.new(src.desc)
         end
+        config_files.each{ |cf| Reek::Source::ConfigFile.new(cf).configure(self) }
         @source = src
         src.configure(self)
       end

data/lib/reek/core/stop_context.rb

@@ -14,6 +14,10 @@ module Reek
         nil
       end
 
+      def config
+        {}
+      end
+
       def count_statements(num)
         0
       end