reek 1.2.6 → 1.2.7

data/spec/reek/smells/long_method_spec.rb

@@ -1,16 +1,16 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-require 'reek/code_parser'
-require 'reek/sniffer'
-require 'reek/smells/long_method'
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'smells', 'long_method')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'code_parser')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'sniffer')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
 
 include Reek
 include Reek::Smells
 
 def process_method(src)
   source = src.to_reek_source
-  sniffer = Sniffer.new(source)
-  CodeParser.new(sniffer).process_defn(source.syntax_tree)
+  sniffer = Core::Sniffer.new(source)
+  Core::CodeParser.new(sniffer).process_defn(source.syntax_tree)
 end
 
 describe LongMethod do
@@ -194,3 +194,28 @@ EOS
     method.num_statements.should == 6
   end
 end
+
+describe LongMethod do
+  before(:each) do
+    @detector = LongMethod.new('silver')
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  context 'when the method has 30 statements' do
+    before :each do
+      @num_statements = 30
+      @ctx = mock('method_context', :null_object => true)
+      @ctx.should_receive(:num_statements).and_return(@num_statements)
+      @detector.examine_context(@ctx)
+      @yaml = @detector.smells_found.to_a[0].to_yaml   # SMELL: too cumbersome!
+    end
+    it 'reports the number of statements' do
+      @yaml.should match(/statement_count:[\s]*#{@num_statements}/)
+      # SMELL: many tests duplicate the names of the YAML fields
+    end
+    it 'reports the correct subclass' do
+      @yaml.should match(/subclass:[\s]*#{LongMethod::SUBCLASS_TOO_MANY_STATEMENTS}/)
+    end
+  end
+end

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-require 'reek/smells/long_parameter_list'
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'smells', 'long_parameter_list')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
 
 include Reek
 include Reek::Smells
@@ -54,19 +54,48 @@ describe LongParameterList do
       end
     end
   end
-  
-  describe 'yield' do
-    it 'should not report yield with no parameters' do
-      'def simple(arga, argb, &blk) f(3);yield; end'.should_not reek
+end
+
+describe LongParameterList do
+  before(:each) do
+    @source_name = 'smokin'
+    @detector = LongParameterList.new(@source_name, {})
+    # SMELL: can't use the default config, because that contains an override,
+    # which causes the mocked matches?() method to be called twice!!
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  context 'looking at the YAML' do
+    before :each do
+      src = <<EOS
+def badguy(arga, argb, argc, argd)
+  f(3)
+  true
+end
+EOS
+      source = src.to_reek_source
+      sniffer = Sniffer.new(source)
+      @mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+      @detector.examine_context(@mctx)
+      warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
+      @yaml = warning.to_yaml
+    end
+    it 'reports the source' do
+      @yaml.should match(/source:\s*#{@source_name}/)
+    end
+    it 'reports the class' do
+      @yaml.should match(/\sclass:\s*LongParameterList/)
     end
-    it 'should not report yield with few parameters' do
-      'def simple(arga, argb, &blk) f(3);yield a,b; end'.should_not reek
+    it 'reports the subclass' do
+      @yaml.should match(/subclass:\s*LongParameterList/)
     end
-    it 'should report yield with many parameters' do
-      'def simple(arga, argb, &blk) f(3);yield arga,argb,arga,argb; end'.should reek_only_of(:LongYieldList, /simple/, /yields/, /4/)
+    it 'reports the number of parameters' do
+      @yaml.should match(/parameter_count:[\s]*#{@num_parameters}/)
+      # SMELL: many tests duplicate the names of the YAML fields
     end
-    it 'should not report yield of a long expression' do
-      'def simple(arga, argb, &blk) f(3);yield(if @dec then argb else 5+3 end); end'.should_not reek
+    it 'reports the line number of the method' do
+      @yaml.should match(/lines:\s*- 1/)
     end
   end
 end

data/spec/reek/smells/long_yield_list_spec.rb

@@ -0,0 +1,65 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'smells', 'long_yield_list')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
+
+include Reek
+include Reek::Smells
+
+describe LongYieldList do
+  before(:each) do
+    @source_name = 'oo la la'
+    @detector = LongYieldList.new(@source_name)
+    # SMELL: can't use the default config, because that contains an override,
+    # which causes the mocked matches?() method to be called twice!!
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  context 'yield' do
+    it 'should not report yield with no parameters' do
+      'def simple(arga, argb, &blk) f(3);yield; end'.should_not reek
+    end
+    it 'should not report yield with few parameters' do
+      'def simple(arga, argb, &blk) f(3);yield a,b; end'.should_not reek
+    end
+    it 'should report yield with many parameters' do
+      'def simple(arga, argb, &blk) f(3);yield arga,argb,arga,argb; end'.should reek_only_of(:LongYieldList, /simple/, /yields/, /4/)
+    end
+    it 'should not report yield of a long expression' do
+      'def simple(arga, argb, &blk) f(3);yield(if @dec then argb else 5+3 end); end'.should_not reek
+    end
+  end
+
+  context 'looking at the YAML' do
+    before :each do
+      src = <<EOS
+def simple(arga, argb, &blk)
+  f(3)
+  yield(arga,argb,arga,argb)
+  end
+EOS
+      source = src.to_reek_source
+      sniffer = Sniffer.new(source)
+      @mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+      @detector.examine_context(@mctx)
+      warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
+      @yaml = warning.to_yaml
+    end
+    it 'reports the source' do
+      @yaml.should match(/source:\s*#{@source_name}/)
+    end
+    it 'reports the class' do
+      @yaml.should match(/class:\s*LongParameterList/)
+    end
+    it 'reports the subclass' do
+      @yaml.should match(/subclass:\s*LongYieldList/)
+    end
+    it 'reports the number of parameters' do
+      @yaml.should match(/parameter_count:[\s]*#{@num_parameters}/)
+      # SMELL: many tests duplicate the names of the YAML fields
+    end
+    it 'reports the line number of the method' do
+      @yaml.should match(/lines:\s*- 3/)
+    end
+  end
+end

data/spec/reek/smells/nested_iterators_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-require 'reek/smells/nested_iterators'
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'smells', 'nested_iterators')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
 
 include Reek::Smells
 
@@ -40,3 +40,94 @@ EOS
   end
 end
 
+describe NestedIterators do
+  before(:each) do
+    @detector = NestedIterators.new('cuckoo')
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  context 'find_deepest_iterators' do
+    context 'with no iterators' do
+      it 'returns an empty list' do
+        src = 'def fred() nothing = true; end'
+        source = src.to_reek_source
+        sniffer = Sniffer.new(source)
+        @mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+        @detector.find_deepest_iterators(@mctx).should == []
+      end
+    end
+
+    context 'with one iterator' do
+      before :each do
+        src = 'def fred() nothing.each {|item| item}; end'
+        source = src.to_reek_source
+        sniffer = Sniffer.new(source)
+        mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+        @result = @detector.find_deepest_iterators(mctx)
+      end
+      it 'returns a depth of 1' do
+        @result.should == []
+      end
+    end
+
+    context 'with two non-nested iterators' do
+      before :each do
+        src = <<EOS
+def fred()
+  nothing.each do |item|
+    item
+  end
+  again.each {|thing| }
+end
+EOS
+        source = src.to_reek_source
+        sniffer = Sniffer.new(source)
+        mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+        @result = @detector.find_deepest_iterators(mctx)
+      end
+      it 'returns both iterators' do
+        @result.length.should == 0
+      end
+    end
+
+    context 'with one nested iterator' do
+      before :each do
+        src = <<EOS
+def fred()
+  nothing.each do |item|
+    again.each {|thing| item }
+  end
+end
+EOS
+        source = src.to_reek_source
+        sniffer = Sniffer.new(source)
+        @mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+        @result = @detector.find_deepest_iterators(@mctx)
+      end
+      it 'returns only the deepest iterator' do
+        @result.length.should == 1
+      end
+      it 'has depth of 2' do
+        @result[0][1].should == 2
+      end
+      it 'refers to the innermost exp' do
+        @result[0][0].line.should == 3
+      end
+
+      context 'when reporting yaml' do
+        before :each do
+          @detector.examine_context(@mctx)
+          warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
+          @yaml = warning.to_yaml
+        end
+        it 'reports the depth' do
+          @yaml.should match(/depth:\s*2/)
+        end
+        it 'reports the deepest line number' do
+          @yaml.should match(/lines:[\s-]*3/)
+        end
+      end
+    end
+  end
+end

data/spec/reek/smells/simulated_polymorphism_spec.rb

@@ -1,15 +1,19 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'smells', 'simulated_polymorphism')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'code_context')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
 
-require 'reek/smells/simulated_polymorphism'
-require 'reek/code_context'
-
-include Reek
+include Reek::Core
 include Reek::Smells
 
 describe SimulatedPolymorphism do
   before :each do
-    @detector = SimulatedPolymorphism.new
+    @source_name = 'howdy-doody'
+    @detector = SimulatedPolymorphism.new(@source_name)
   end
+
+  it_should_behave_like 'SmellDetector'
+
   context 'with no conditionals' do
     it 'gathers an empty hash' do
       ast = 'module Stable; end'.to_reek_source.syntax_tree
@@ -28,36 +32,60 @@ describe SimulatedPolymorphism do
 
   context 'with three identical conditionals' do
     before :each do
-      cond = '@field == :sym'
-      @cond_expr = cond.to_reek_source.syntax_tree
+      @cond = '@field == :sym'
+      @cond_expr = @cond.to_reek_source.syntax_tree
       src = <<EOS
 class Scrunch
   def first
-    return #{cond} ? 0 : 3;
+    puts "hello" if @debug
+    return #{@cond} ? 0 : 3;
   end
   def second
-    if #{cond}
+    if #{@cond}
       @other += " quarts"
     end
   end
   def third
-    raise 'flu!' unless #{cond}
+    raise 'flu!' unless #{@cond}
   end
 end
 EOS
 
       ast = src.to_reek_source.syntax_tree
-      ctx = CodeContext.new(nil, ast)
-      @conds = @detector.conditional_counts(ctx)
+      @ctx = CodeContext.new(nil, ast)
+      @conds = @detector.conditional_counts(@ctx)
     end
-    it 'finds one matching conditional' do
-      @conds.length.should == 1
-    end
-    it 'returns the condition expr' do
-      @conds.keys[0].should == @cond_expr
+    it 'finds both conditionals' do
+      @conds.length.should == 2
     end
     it 'knows there are three copies' do
-      @conds[@cond_expr].should == 3
+      @conds[@cond_expr].length.should == 3
+    end
+
+    context 'looking at the YAML' do
+      before :each do
+        @detector.examine(@ctx)
+        warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
+        @yaml = warning.to_yaml
+      end
+      it 'reports the source' do
+        @yaml.should match(/source:\s*#{@source_name}/)
+      end
+      it 'reports the class' do
+        @yaml.should match(/class:\s*SimulatedPolymorphism/)
+      end
+      it 'reports the subclass' do
+        @yaml.should match(/subclass:\s*RepeatedConditional/)
+      end
+      it 'reports the expression' do
+        @yaml.should match(/expression:\s*\(#{@cond}\)/)
+      end
+      it 'reports the number of occurrences' do
+        @yaml.should match(/occurrences:\s*3/)
+      end
+      it 'reports the referring lines' do
+        @yaml.should match(/lines:\s*- 4\s*- 7\s*- 12/)
+      end
     end
   end
 
@@ -90,7 +118,7 @@ EOS
       @conds.keys[0].should == @cond_expr
     end
     it 'knows there are three copies' do
-      @conds[@cond_expr].should == 2
+      @conds[@cond_expr].length.should == 2
     end
   end
 

data/spec/reek/smells/smell_detector_shared.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'smell_configuration')
+
+include Reek::Core
+
+shared_examples_for 'SmellDetector' do
+  context 'exception matching follows the context' do
+    before :each do
+      @ctx = mock('context')
+    end
+    it 'when false' do
+      @ctx.should_receive(:matches?).and_return(false)
+      @detector.exception?(@ctx).should == false
+    end
+
+    it 'when true' do
+      @ctx.should_receive(:matches?).and_return(true)
+      @detector.exception?(@ctx).should == true
+    end
+  end
+
+  context 'configuration' do
+    it 'becomes disabled when disabled' do
+      @detector.configure({@detector.smell_type => {SmellConfiguration::ENABLED_KEY => false}})
+      @detector.should_not be_enabled
+    end
+  end
+end

data/spec/reek/smells/uncommunicative_method_name_spec.rb

@@ -0,0 +1,57 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'smells', 'uncommunicative_method_name')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'code_parser')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'sniffer')
+
+include Reek
+include Reek::Smells
+
+describe UncommunicativeMethodName do
+  before :each do
+    @source_name = 'wallamalloo'
+    @detector = UncommunicativeMethodName.new(@source_name)
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  it 'should not report one-word method name' do
+    'def help(fred) basics(17) end'.should_not reek
+  end
+  it 'should report one-letter method name' do
+    'def x(fred) basics(17) end'.should reek_only_of(:UncommunicativeMethodName, /x/)
+  end
+  it 'should report name of the form "x2"' do
+    'def x2(fred) basics(17) end'.should reek_only_of(:UncommunicativeMethodName, /x2/)
+  end
+  it 'should report long name ending in a number' do
+    'def method2(fred) basics(17) end'.should reek_only_of(:UncommunicativeMethodName, /method2/)
+  end
+
+  context 'looking at the YAML' do
+    before :each do
+      src = 'def bad3() end'
+      source = src.to_reek_source
+      sniffer = Core::Sniffer.new(source)
+      @mctx = Core::CodeParser.new(sniffer).process_defn(source.syntax_tree)
+      @detector.examine(@mctx)
+      warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
+      @yaml = warning.to_yaml
+    end
+    it 'reports the source' do
+      @yaml.should match(/source:\s*#{@source_name}/)
+    end
+    it 'reports the class' do
+      @yaml.should match(/\sclass:\s*UncommunicativeName/)
+    end
+    it 'reports the subclass' do
+      @yaml.should match(/subclass:\s*UncommunicativeMethodName/)
+    end
+    it 'reports the variable name' do
+      @yaml.should match(/method_name:\s*bad3/)
+    end
+    it 'reports the line number of the method def' do
+      @yaml.should match(/lines:\s*- 1/)
+    end
+  end
+end