reek 1.3.1 → 1.3.2

data/spec/reek/smells/feature_envy_spec.rb

@@ -1,6 +1,6 @@
-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', 'feature_envy')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
+require 'spec_helper'
+require 'reek/smells/feature_envy'
+require 'reek/smells/smell_detector_shared'
 
 include Reek
 include Reek::Smells

data/spec/reek/smells/irresponsible_module_spec.rb

@@ -1,6 +1,6 @@
-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', 'irresponsible_module')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
+require 'spec_helper'
+require 'reek/smells/irresponsible_module'
+require 'reek/smells/smell_detector_shared'
 include Reek::Smells
 
 describe IrresponsibleModule do

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -1,6 +1,6 @@
-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')
+require 'spec_helper'
+require 'reek/smells/long_parameter_list'
+require 'reek/smells/smell_detector_shared'
 
 include Reek
 include Reek::Smells

data/spec/reek/smells/long_yield_list_spec.rb

@@ -1,6 +1,6 @@
-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')
+require 'spec_helper'
+require 'reek/smells/long_yield_list'
+require 'reek/smells/smell_detector_shared'
 
 include Reek
 include Reek::Smells

data/spec/reek/smells/nested_iterators_spec.rb

@@ -1,6 +1,6 @@
-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')
+require 'spec_helper'
+require 'reek/smells/nested_iterators'
+require 'reek/smells/smell_detector_shared'
 
 include Reek::Smells
 
@@ -51,7 +51,45 @@ def bad(fred)
   @jim.each {|ting| ting.each {|piece| @hal.send} }
 end
 EOS
-    src.should smell_of(NestedIterators, {}, {})
+    src.should smell_of(NestedIterators, {})
+  end
+
+  it 'reports nested iterators only once per method even if levels are different' do
+    src = <<-EOS
+      def bad(fred)
+        @fred.each {|item| item.each {|part| part.foo} }
+        @jim.each {|ting| ting.each {|piece| piece.each {|atom| atom.foo } } }
+      end
+    EOS
+    src.should smell_of(NestedIterators, {})
+  end
+
+  it 'reports nesting inside iterator arguments' do
+    src = <<-EOS
+      def bad(fred, ted)
+        fred.foo(
+          ted.each {|item|
+            item.each {|part|
+              part.baz
+            }
+          }
+        ) { |qux| qux.quuz }
+      end
+    EOS
+    src.should smell_of(NestedIterators, NestedIterators::NESTING_DEPTH_KEY => 2)
+  end
+
+  it 'reports the deepest level of nesting only' do
+    src = <<-EOS
+      def bad(fred)
+        fred.each {|item|
+          item.each {|part|
+            part.each {|sub| sub.foobar}
+          }
+        }
+      end
+    EOS
+    src.should smell_of(NestedIterators, NestedIterators::NESTING_DEPTH_KEY => 3)
   end
 
   context 'when the allowed nesting depth is 3' do

data/spec/reek/smells/nil_check_spec.rb

@@ -1,6 +1,6 @@
-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', 'nil_check')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
+require 'spec_helper'
+require 'reek/smells/nil_check'
+require 'reek/smells/smell_detector_shared'
 
 include Reek
 include Reek::Smells
@@ -9,19 +9,31 @@ describe NilCheck do
 
   context 'for methods' do
 
+    it 'reports the correct line number' do
+      src = <<-EOS
+      def nilcheck foo
+        foo.nil?
+      end
+      EOS
+      ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
+      detector = NilCheck.new('source_name')
+      smells = detector.examine_context(ctx)
+      smells[0].lines.should eq [2]
+    end
+
     it 'should report nothing when scope includes no nil checks' do
       'def no_nils; end'.should_not smell_of(NilCheck)
     end
 
     it 'should report when scope uses multiple nil? methods' do
       src = <<-eos
-      def chk_multi_nil(para) 
-        para.nil? 
+      def chk_multi_nil(para)
+        para.nil?
         puts "Hello"
-        \"\".nil? 
+        \"\".nil?
       end
       eos
-      src.should smell_of(NilCheck, 
+      src.should smell_of(NilCheck,
                           {NilCheck => nil}, {NilCheck => nil})
     end
 
@@ -42,16 +54,16 @@ describe NilCheck do
 
     it 'should report when scope uses multiple case-clauses checking nil' do
       src = <<-eos
-      def caseNil 
-        case @inst_var 
-        when nil then puts "Nil" 
+      def case_nil
+        case @inst_var
+        when nil then puts "Nil"
         end
         puts "Hello"
         case @inst_var2
         when 1 then puts 1
         when nil then puts nil.inspect
         end
-      end 
+      end
       eos
       src.should smell_of(NilCheck,
                           {NilCheck => nil}, {NilCheck => nil})

data/spec/reek/smells/{simulated_polymorphism_spec.rb → repeated_conditional_spec.rb}

@@ -1,15 +1,15 @@
-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 'spec_helper'
+require 'reek/smells/repeated_conditional'
+require 'reek/core/code_context'
+require 'reek/smells/smell_detector_shared'
 
 include Reek::Core
 include Reek::Smells
 
-describe SimulatedPolymorphism do
+describe RepeatedConditional do
   before :each do
     @source_name = 'howdy-doody'
-    @detector = SimulatedPolymorphism.new(@source_name)
+    @detector = RepeatedConditional.new(@source_name)
   end
 
   it_should_behave_like 'SmellDetector'

data/spec/reek/smells/smell_detector_shared.rb

@@ -1,5 +1,5 @@
-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')
+require 'spec_helper'
+require 'reek/core/smell_configuration'
 
 include Reek::Core
 

data/spec/reek/smells/too_many_instance_variables_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'reek/smells/too_many_instance_variables'
+require 'reek/examiner'
+require 'reek/core/code_parser'
+require 'reek/smells/smell_detector_shared'
+
+include Reek
+include Reek::Smells
+
+describe TooManyInstanceVariables do
+  before(:each) do
+    @source_name = 'elephant'
+    @detector = TooManyInstanceVariables.new(@source_name)
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  context 'counting instance variables' do
+    it 'should not report 9 ivars' do
+      '# clean class for testing purposes
+class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=4; end;end'.should_not reek
+    end
+
+    it 'counts each ivar only once' do
+      '# clean class for testing purposes
+class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=4;@aa=3; end;end'.should_not reek
+    end
+
+    it 'should report 10 ivars' do
+      '# smelly class for testing purposes
+class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=@aj=4; end;end'.should reek_only_of(:TooManyInstanceVariables)
+    end
+
+    it 'should not report 10 ivars in 2 extensions' do
+      src = <<EOS
+# clean class for testing purposes
+class Full;def ivars_a() @aa=@ab=@ac=@ad=@ae; end;end
+# clean class for testing purposes
+class Full;def ivars_b() @af=@ag=@ah=@ai=@aj; end;end
+EOS
+      src.should_not reek
+    end
+  end
+
+  it 'reports correctly when the class has 10 instance variables' do
+    src = <<EOS
+# smelly class for testing purposes
+class Empty
+  def ivars
+    @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=@aj=4
+  end
+end
+EOS
+    ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
+    @warning = @detector.examine_context(ctx)[0]
+    @warning.source.should == @source_name
+    @warning.smell_class.should == 'LargeClass'
+    @warning.subclass.should == TooManyInstanceVariables::SMELL_SUBCLASS
+    @warning.smell[TooManyInstanceVariables::IVAR_COUNT_KEY].should == 10
+    @warning.lines.should == [2]
+  end
+end

data/spec/reek/smells/{large_class_spec.rb → too_many_methods_spec.rb}

@@ -1,47 +1,20 @@
-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', 'large_class')
-require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'examiner')
-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.expand_path(__FILE__)), 'smell_detector_shared')
+require 'spec_helper'
+require 'reek/smells/too_many_methods'
+require 'reek/examiner'
+require 'reek/core/code_parser'
+require 'reek/smells/smell_detector_shared'
 
 include Reek
 include Reek::Smells
 
-describe LargeClass do
+describe TooManyMethods do
   before(:each) do
     @source_name = 'elephant'
-    @detector = LargeClass.new(@source_name)
+    @detector = TooManyMethods.new(@source_name)
   end
 
   it_should_behave_like 'SmellDetector'
 
-  context 'counting instance variables' do
-    it 'should not report 9 ivars' do
-      '# clean class for testing purposes
-class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=4; end;end'.should_not reek
-    end
-
-    it 'counts each ivar only once' do
-      '# clean class for testing purposes
-class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=4;@aa=3; end;end'.should_not reek
-    end
-
-    it 'should report 10 ivars' do
-      '# smelly class for testing purposes
-class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=@aj=4; end;end'.should reek_only_of(:LargeClass)
-    end
-
-    it 'should not report 10 ivars in 2 extensions' do
-      src = <<EOS
-# clean class for testing purposes
-class Full;def ivars_a() @aa=@ab=@ac=@ad=@ae; end;end
-# clean class for testing purposes
-class Full;def ivars_b() @af=@ag=@ah=@ai=@aj; end;end
-EOS
-      src.should_not reek
-    end
-  end
-
   context 'counting methods' do
 
     it 'should not report 25 methods' do
@@ -73,8 +46,8 @@ EOS
       ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
       smells = @detector.examine_context(ctx)
       smells.length.should == 1
-      smells[0].subclass.should == LargeClass::SUBCLASS_TOO_MANY_METHODS
-      smells[0].smell[LargeClass::METHOD_COUNT_KEY].should == 26
+      smells[0].subclass.should == TooManyMethods::SMELL_SUBCLASS
+      smells[0].smell[TooManyMethods::METHOD_COUNT_KEY].should == 26
     end
   end
 
@@ -110,26 +83,8 @@ EOS
     @warning = @detector.examine_context(ctx)[0]
     @warning.source.should == @source_name
     @warning.smell_class.should == 'LargeClass'
-    @warning.subclass.should == LargeClass::SUBCLASS_TOO_MANY_METHODS
-    @warning.smell[LargeClass::METHOD_COUNT_KEY].should == 26
+    @warning.subclass.should == TooManyMethods::SMELL_SUBCLASS
+    @warning.smell[TooManyMethods::METHOD_COUNT_KEY].should == 26
     @warning.lines.should == [1]
   end
-
-  it 'reports correctly when the class has 30 instance variables' do
-    src = <<EOS
-# smelly class for testing purposes
-class Empty
-  def ivars
-    @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=@aj=4
-  end
-end
-EOS
-    ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
-    @warning = @detector.examine_context(ctx)[0]
-    @warning.source.should == @source_name
-    @warning.smell_class.should == 'LargeClass'
-    @warning.subclass.should == LargeClass::SUBCLASS_TOO_MANY_IVARS
-    @warning.smell[LargeClass::IVAR_COUNT_KEY].should == 10
-    @warning.lines.should == [2]
-  end
 end

data/spec/reek/smells/{long_method_spec.rb → too_many_statements_spec.rb}

@@ -1,8 +1,8 @@
-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')
+require 'spec_helper'
+require 'reek/smells/too_many_statements'
+require 'reek/core/code_parser'
+require 'reek/core/sniffer'
+require 'reek/smells/smell_detector_shared'
 
 include Reek
 include Reek::Smells
@@ -19,20 +19,20 @@ def process_singleton_method(src)
   Core::CodeParser.new(sniffer).process_defs(source.syntax_tree)
 end
 
-describe LongMethod do
+describe TooManyStatements do
   it 'should not report short methods' do
     src = 'def short(arga) alf = f(1);@bet = 2;@cut = 3;@dit = 4; @emp = 5;end'
-    src.should_not smell_of(LongMethod)
+    src.should_not smell_of(TooManyStatements)
   end
 
   it 'should report long methods' do
     src = 'def long() alf = f(1);@bet = 2;@cut = 3;@dit = 4; @emp = 5;@fry = 6;end'
-    src.should reek_only_of(:LongMethod, /6 statements/)
+    src.should reek_only_of(:TooManyStatements, /6 statements/)
   end
 
   it 'should not report initialize' do
     src = 'def initialize(arga) alf = f(1);@bet = 2;@cut = 3;@dit = 4; @emp = 5;@fry = 6;end'
-    src.should_not smell_of(LongMethod)
+    src.should_not smell_of(TooManyStatements)
   end
 
   it 'should only report a long method once' do
@@ -54,7 +54,7 @@ def standard_entries(rbconfig)
   end
 end
 EOS
-    src.should reek_only_of(:LongMethod)
+    src.should reek_only_of(:TooManyStatements)
   end
 
   it 'should report long inner block' do
@@ -71,11 +71,11 @@ def long()
   end
 end
 EOS
-    src.should reek_only_of(:LongMethod)
+    src.should reek_only_of(:TooManyStatements)
   end
 end
 
-describe LongMethod do
+describe TooManyStatements do
   it 'counts 1 assignment' do
     method = process_method('def one() val = 4; end')
     method.num_statements.should == 1
@@ -112,7 +112,7 @@ describe LongMethod do
   end
 end
 
-describe LongMethod, 'does not count control statements' do
+describe TooManyStatements, 'does not count control statements' do
   it 'counts 1 statement in a conditional expression' do
     method = process_method('def one() if val == 4; callee(); end; end')
     method.num_statements.should == 1
@@ -220,9 +220,9 @@ EOS
   end
 end
 
-describe LongMethod do
+describe TooManyStatements do
   before(:each) do
-    @detector = LongMethod.new('silver')
+    @detector = TooManyStatements.new('silver')
   end
 
   it_should_behave_like 'SmellDetector'
@@ -239,10 +239,10 @@ describe LongMethod do
       @smells.length.should == 1
     end
     it 'reports the number of statements' do
-      @smells[0].smell[LongMethod::STATEMENT_COUNT_KEY].should == @num_statements
+      @smells[0].smell[TooManyStatements::STATEMENT_COUNT_KEY].should == @num_statements
     end
     it 'reports the correct subclass' do
-      @smells[0].subclass.should == LongMethod::SUBCLASS_TOO_MANY_STATEMENTS
+      @smells[0].subclass.should == TooManyStatements::SMELL_SUBCLASS
     end
   end
 end