reek 1.2.1 → 1.2.3

data/History.txt

@@ -1,3 +1,13 @@
+== 1.2.2 (under development in github)
+
+=== Minor Changes
+* New smell: Attribute (disabled by default)
+* Expanded DataClump to check modules (#9)
+* Fixed LargeClass to ignore inner classes and modules
+* Fixed LargeClass to ignore singleton methods
+* Removed support for MyClass.should_not reek due to ParseTree EOL
+* Removed internal requiring of 'rubygems'
+
 == 1.2.1 (2009-10-02)
 
 === Minor Changes

data/Rakefile

@@ -1,4 +1,3 @@
-require 'rake'
 require 'rake/clean'
 
 $:.unshift File.dirname(__FILE__) + '/lib'

data/config/defaults.reek

@@ -14,12 +14,11 @@ LongParameterList:
     initialize: 
       max_params: 5
 FeatureEnvy: 
-  exclude: 
-  - initialize
-  enabled: true
-ClassVariable: 
   exclude: &id001 []
 
+  enabled: true
+ClassVariable: 
+  exclude: *id001
   enabled: true
 UncommunicativeName: 
   accept: 
@@ -48,6 +47,10 @@ UtilityFunction:
   exclude: []
 
   enabled: true
+Attribute: 
+  exclude: []
+
+  enabled: false
 SimulatedPolymorphism: 
   exclude: []
 
@@ -60,8 +63,7 @@ DataClump:
   max_copies: 2
   min_clump_size: 2
 ControlCouple: 
-  exclude: 
-  - initialize
+  exclude: *id001
   enabled: true
 LongYieldList: 
   max_params: 3

data/features/masking_smells.feature

@@ -6,7 +6,7 @@ Feature: Masking 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
+    Then the exit status indicates smells
     And it reports:
       """
       spec/samples/empty_config_file/dirty.rb -- 6 warnings:
@@ -21,17 +21,17 @@ Feature: Masking smells using config files
 
   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
+    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 it fails with exit status 1
+    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
-    Then it fails with exit status 2
+    Then the exit status indicates smells
     And it reports:
       """
       spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
@@ -43,7 +43,7 @@ Feature: Masking smells using config files
 
   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
+    Then the exit status indicates smells
     And it reports:
       """
       spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
@@ -58,7 +58,7 @@ Feature: Masking smells using config files
 
   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
+    Then the exit status indicates smells
     And it reports:
       """
       spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
@@ -70,7 +70,7 @@ Feature: Masking smells using config files
 
   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
+    Then the exit status indicates smells
     And it reports:
       """
       spec/samples/not_quite_masked/dirty.rb -- 5 warnings (+1 masked):
@@ -85,7 +85,7 @@ Feature: Masking smells using config files
   @overrides
   Scenario: lower overrides upper
     When I run reek spec/samples/overrides
-    Then it fails with exit status 2
+    Then the exit status indicates smells
     And it reports:
       """
       spec/samples/overrides/masked/dirty.rb -- 2 warnings (+4 masked):
@@ -97,7 +97,7 @@ Feature: Masking smells using config files
   @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
+    Then the exit status indicates smells
     And it reports:
       """
       spec/samples/overrides/masked/dirty.rb -- 2 warnings (+4 masked):

data/features/options.feature

@@ -6,12 +6,12 @@ Feature: Reek can be controlled using command-line options
 
   Scenario: return non-zero status on bad option
     When I run reek --no-such-option
-    Then it fails with exit status 1
+    Then the exit status indicates an error
     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
+    Then the exit status indicates an error
     And it reports the error "Error: missing argument: -f"
 
   Scenario: display the current version number

data/features/profile.feature

@@ -0,0 +1,34 @@
+@profile
+Feature: Reek's configuration can be based on any number of canned profiles
+  The starting point for configuring the smell detectors can be
+  selected from a list of supplied config files.
+
+#  Scenario: XP profile reveals Attribute smells
+#    When I run reek --profile xp spec/samples/not_quite_masked/dirty.rb
+#    Then the exit status indicates smells
+#    And it reports:
+#      """
+#      spec/samples/not_quite_masked/dirty.rb -- 5 warnings (+2 masked):
+#        Dirty declares the attribute property (Attribute)
+#        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)
+#
+#      """
+#
+#  Scenario: XP profile works with unmasked smells
+#    When I run reek --show-all --profile xp spec/samples/not_quite_masked/dirty.rb
+#    Then the exit status indicates smells
+#    And it reports:
+#      """
+#      spec/samples/not_quite_masked/dirty.rb -- 5 warnings (+2 masked):
+#        Dirty declares the attribute property (Attribute)
+#        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)
+#        (masked) Dirty#a/block has the variable name 'x' (Uncommunicative Name)
+#        (masked) Dirty#a/block/block is nested (Nested Iterators)
+#
+#      """

data/features/rake_task.feature

@@ -0,0 +1,74 @@
+@rake
+Feature: Reek can be driven through its RakeTask
+  Reek provides an easy way to integrate its use into Rakefiles,
+  via the RakeTask 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|
+        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):
+        Dirty#a calls @s.title twice (Duplication)
+        Dirty#a calls puts(@s.title) twice (Duplication)
+        Dirty#a/block/block is nested (Nested Iterators)
+      """
+
+  Scenario: name changes the task name
+    When I run rake silky with:
+      """
+      Reek::RakeTask.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):
+        Dirty#a calls @s.title twice (Duplication)
+        Dirty#a calls puts(@s.title) twice (Duplication)
+        Dirty#a/block/block is nested (Nested Iterators)
+      """
+
+  Scenario: verbose prints the reek command
+    When I run rake reek with:
+      """
+      Reek::RakeTask.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)
+      """
+
+  Scenario: fail_on_error can hide the error status
+    When I run rake reek with:
+      """
+      Reek::RakeTask.new do |t|
+        t.fail_on_error = false
+        t.source_files = 'spec/samples/empty_config_file/dirty.rb'
+      end
+      """
+    Then it succeeds
+    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)
+      """

data/features/reports.feature

@@ -6,7 +6,7 @@ Feature: Correctly formatted reports
 
   Scenario Outline: two reports run together with indented smells
     When I run reek <args>
-    Then it fails with exit status 2
+    Then the exit status indicates smells
     And it reports:
       """
       spec/samples/two_smelly_files/dirty_one.rb -- 6 warnings:

data/features/samples.feature

@@ -6,7 +6,7 @@ Feature: Basic smell detection
 
   Scenario: Correct smells from inline.rb
     When I run reek spec/samples/inline.rb
-    Then it fails with exit status 2
+    Then the exit status indicates smells
     And it reports:
     """
     spec/samples/inline.rb -- 39 warnings (+1 masked):
@@ -54,11 +54,11 @@ Feature: Basic smell detection
 
   Scenario: Correct smells from optparse.rb
     When I run reek spec/samples/optparse.rb
-    Then it fails with exit status 2
+    Then the exit status indicates smells
     And it reports:
     """
     spec/samples/optparse.rb -- 121 warnings:
-      OptionParser has at least 59 methods (Large Class)
+      OptionParser has at least 42 methods (Large Class)
       OptionParser tests ((argv.size == 1) and Array.===(argv[0])) at least 3 times (Simulated Polymorphism)
       OptionParser tests a at least 7 times (Simulated Polymorphism)
       OptionParser tests default_pattern at least 7 times (Simulated Polymorphism)
@@ -184,7 +184,7 @@ Feature: Basic smell detection
 
   Scenario: Correct smells from redcloth.rb
     When I run reek spec/samples/redcloth.rb
-    Then it fails with exit status 2
+    Then the exit status indicates smells
     And it reports:
     """
     spec/samples/redcloth.rb -- 95 warnings:

data/features/stdin.feature

@@ -33,7 +33,7 @@ Feature: Reek reads from $stdin when no files are given
 
   Scenario: return non-zero status when there are smells
     When I pass "class Turn; def y() @x = 3; end end" to reek
-    Then it fails with exit status 2
+    Then the exit status indicates smells
     And it reports:
       """
       $stdin -- 2 warnings:

data/features/step_definitions/reek_steps.rb

@@ -1,13 +1,13 @@
 When /^I run reek (.*)$/ do |args|
-  run args
+  reek(args)
 end
 
 When /^I pass "([^\"]*)" to reek *(.*)$/ do |stdin, args|
-  run_with_pipe(stdin, args)
+  reek_with_pipe(stdin, args)
 end
 
-When /^I run rake reek$/ do
-  rake
+When /^I run rake (\w*) with:$/ do |name, task_def|
+  rake(name, task_def)
 end
 
 Then /^stdout equals "([^\"]*)"$/ do |report|
@@ -15,11 +15,15 @@ Then /^stdout equals "([^\"]*)"$/ do |report|
 end
 
 Then /^it succeeds$/ do
-  @last_exit_status.should == 0
+  @last_exit_status.should == Reek::EXIT_STATUS[:success]
 end
 
-Then /^it fails with exit status (\d+)$/ do |status|
-  @last_exit_status.should == status.to_i
+Then /^the exit status indicates an error$/ do
+  @last_exit_status.should == Reek::EXIT_STATUS[:error]
+end
+
+Then /^the exit status indicates smells$/ do
+  @last_exit_status.should == Reek::EXIT_STATUS[:smells]
 end
 
 Then /^it reports:$/ do |report|

data/features/support/env.rb

@@ -5,34 +5,42 @@ require 'tempfile'
 require 'spec/expectations'
 require 'fileutils'
 require 'reek'
+require 'reek/adapters/application'
 
-class CucumberWorld
-
-  def run(args)
-    stderr_file = Tempfile.new('cucumber')
+class ReekWorld
+  def run(cmd)
+    stderr_file = Tempfile.new('reek-world')
     stderr_file.close
-    @last_stdout = `ruby -Ilib bin/reek #{args} 2> #{stderr_file.path}`
+    @last_stdout = `#{cmd} 2> #{stderr_file.path}`
     @last_exit_status = $?.exitstatus
     @last_stderr = IO.read(stderr_file.path)
   end
 
-  def run_with_pipe(stdin, args)
-    stderr_file = Tempfile.new('cucumber')
-    stderr_file.close
-    @last_stdout = `echo \"#{stdin}\" | ruby -Ilib bin/reek #{args} 2> #{stderr_file.path}`
-    @last_exit_status = $?.exitstatus
-    @last_stderr = IO.read(stderr_file.path)
+  def reek(args)
+    run("ruby -Ilib -rubygems bin/reek #{args}")
   end
 
-  def rake
-    stderr_file = Tempfile.new('cucumber')
-    stderr_file.close
-    @last_stdout = `rake reek 2> #{stderr_file.path}`
-    @last_exit_status = $?.exitstatus
-    @last_stderr = IO.read(stderr_file.path)
+  def reek_with_pipe(stdin, args)
+    run("echo \"#{stdin}\" | ruby -Ilib -rubygems bin/reek #{args}")
+  end
+
+  def rake(name, task_def)
+    header = <<EOS
+$:.unshift('lib')
+require 'reek/adapters/rake_task'
+
+EOS
+    rakefile = Tempfile.new('rake_task', '.')
+    rakefile.puts(header + task_def)
+    rakefile.close
+    run("RUBYOPT=rubygems rake -f #{rakefile.path} #{name}")
+    lines = @last_stdout.split("\n")
+    if lines.length > 0 and lines[0] =~ /^\(/
+      @last_stdout = lines[1..-1].join("\n")
+    end
   end
 end
 
 World do
-  CucumberWorld.new
+  ReekWorld.new
 end

data/lib/reek/adapters/application.rb

@@ -3,6 +3,13 @@ require 'reek/adapters/source'
 require 'reek/adapters/core_extras'
 
 module Reek
+
+  EXIT_STATUS = {
+    :success => 0,
+    :error   => 1,
+    :smells  => 2
+  }
+
   #
   # Represents an instance of a Reek application.
   # This is the entry point for all invocations of Reek from the
@@ -27,7 +34,7 @@ module Reek
     def reek
       examine_sources
       puts @options.create_report(@sniffer.sniffers).report
-      return @sniffer.smelly? ? 2 : 0
+      return EXIT_STATUS[@sniffer.smelly? ? :smells : :success]
     end
 
     def execute
@@ -37,7 +44,7 @@ module Reek
         return ex.status
       rescue Exception => error
         $stderr.puts "Error: #{error}"
-        return 1
+        return EXIT_STATUS[:error]
       end
     end
   end

data/lib/reek/adapters/command_line.rb

@@ -45,11 +45,11 @@ EOB
 
       @parser.on("-h", "--help", "Show this message") do
         puts @parser
-        exit(0)
+        exit(EXIT_STATUS[:success])
       end
       @parser.on("-v", "--version", "Show version") do
         puts "#{@parser.program_name} #{Reek::VERSION}"
-        exit(0)
+        exit(EXIT_STATUS[:success])
       end
 
       @parser.separator "\nReport formatting:"

data/lib/reek/adapters/core_extras.rb

@@ -10,14 +10,6 @@ class Object
   def sniff
     Reek::Sniffer.new(self.to_reek_source)
   end
-
-  #
-  # Constructs a Sniffer which examines this object for code smells.
-  # (This feature is only enabled if you have the ParseTree gem installed.)
-  #
-  def to_reek_source
-    ObjectSource.new(self, self.to_s)
-  end
 end
 
 class File

data/lib/reek/adapters/source.rb

@@ -1,4 +1,6 @@
+require 'ruby_parser'
 require 'reek/adapters/config_file'
+require 'reek/tree_dresser'
 
 module Reek
 
@@ -17,7 +19,8 @@ module Reek
     def configure(sniffer) end
 
     def syntax_tree
-      RubyParser.new.parse(@source, @desc) || s()
+      ast = RubyParser.new.parse(@source, @desc) || s()
+      TreeDresser.new.dress(ast)
     end
   end
 

data/lib/reek/adapters/spec.rb

@@ -1,6 +1,5 @@
 require 'reek/sniffer'
 require 'reek/adapters/core_extras'
-require 'reek/adapters/object_source'
 require 'reek/adapters/report'
 
 module Reek
@@ -89,11 +88,9 @@ module Reek
     end
 
     class ShouldReekOnlyOf < ShouldReekOf        # :nodoc:
-      include ReekMatcher
-
       def matches?(actual)
         @sniffer = actual.sniff
-        @sniffer.smells_only_of?(@klass, @patterns)
+        @sniffer.num_smells == 1 and @sniffer.has_smell?(@klass, @patterns)
       end
       def failure_message_for_should
         "Expected #{@sniffer.desc} to reek only of #{@klass}, but got:\n#{report}"

data/lib/reek/block_context.rb

@@ -21,15 +21,25 @@ module Reek
     end
   end
 
-  class BlockContext < CodeContext
+  class VariableContainer < CodeContext
+
+    def initialize(outer, exp)
+      super
+      @local_variables = Set.new
+    end
+
+    def record_local_variable(sym)
+      @local_variables << Name.new(sym)
+    end
+  end
+
+  class BlockContext < VariableContainer
 
     def initialize(outer, exp)
       super
       @name = Name.new('block')
-      @parameters = exp[0] if exp
-      @parameters ||= []
+      @parameters = exp[2] || []
       @parameters.extend(ParameterSet)
-      @local_variables = Set.new
     end
 
     def inside_a_block?
@@ -43,10 +53,6 @@ module Reek
     def nested_block?
       @outer.inside_a_block?
     end
-    
-    def record_local_variable(sym)
-      @local_variables << Name.new(sym)
-    end
 
     def outer_name
       "#{@outer.outer_name}#{@name}/"

data/lib/reek/class_context.rb

@@ -1,5 +1,5 @@
 require 'set'
-require 'reek/code_context'
+require 'reek/module_context'
 
 class Class
   def is_overriding_method?(name)
@@ -11,39 +11,14 @@ class Class
 end
 
 module Reek
-  class ClassContext < CodeContext
+  class ClassContext < ModuleContext
 
-    def ClassContext.create(outer, exp)
-      res = Name.resolve(exp[1], outer)
-      ClassContext.new(res[0], res[1], exp[2])
-    end
-
-    def ClassContext.from_s(src)
-      source = src.to_reek_source
-      sniffer = Sniffer.new(source)
-      CodeParser.new(sniffer).process_class(source.syntax_tree)
-    end
+    attr_reader :parsed_methods
 
-    attr_reader :conditionals, :parsed_methods, :class_variables
-
-    # SMELL: inconsistent with other contexts (not linked to the sexp)
-    def initialize(outer, name, superclass = nil)
-      super(outer, nil)
-      @name = name
-      @superclass = superclass
-      @parsed_methods = []
+    def initialize(outer, name, exp)
+      super
+      @superclass = exp[2]
       @instance_variables = Set.new
-      @conditionals = []
-      @class_variables = Set.new
-    end
-
-    def myself
-      @myself ||= @outer.find_module(@name)
-    end
-
-    def find_module(modname)
-      return nil unless myself
-      @myself.const_or_nil(modname.to_s)
     end
 
     def is_overriding_method?(name)
@@ -55,40 +30,16 @@ module Reek
       @superclass == [:const, :Struct]
     end
 
-    def num_methods
-      @parsed_methods.length
-    end
-
-    def record_class_variable(cvar)
-      @class_variables << Name.new(cvar)
-    end
-
     def record_instance_variable(sym)
       @instance_variables << Name.new(sym)
     end
 
-    def record_method(meth)
-      @parsed_methods << meth
-    end
-
     def outer_name
       "#{@outer.outer_name}#{@name}#"
     end
 
-    def to_s
-      "#{@outer.outer_name}#{@name}"
-    end
-
     def variable_names
       @instance_variables
     end
-
-    def record_conditional(exp)
-      @conditionals << exp
-    end
-
-    def parameterized_methods(min_clump_size)
-      parsed_methods.select {|meth| meth.parameters.length >= min_clump_size }
-    end
   end
 end

data/lib/reek/code_context.rb

@@ -23,6 +23,16 @@ module Reek
       @myself = nil
     end
 
+    def each(type, ignoring, &blk)
+      if block_given?
+        @exp.look_for(type, ignoring, &blk)
+      else
+        result = []
+        @exp.look_for(type, ignoring) {|exp| result << exp}
+        result
+      end
+    end
+
     # SMELL: Temporary Field -- @name isn't always initialized
     def matches?(strings)
       me = @name.to_s