reek 1.2.6 → 1.2.7

data/spec/reek/smells/data_clump_spec.rb

@@ -1,12 +1,13 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-require 'reek/smells/data_clump'
+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', 'data_clump')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
 
 include Reek::Smells
 
 shared_examples_for 'a data clump detector' do
   it 'does not report small parameter sets' do
     src = <<EOS
+# test module
 #{@context} Scrunch
   def first(pa) @field == :sym ? 0 : 3; end
   def second(pa) @field == :sym; end
@@ -17,16 +18,28 @@ EOS
     src.should_not reek
   end
 
-  it 'reports 3 identical pairs in a class' do
-    src = <<EOS
+  context 'with 3 identical pairs' do
+    before :each do
+      @src = <<EOS
 #{@context} Scrunch
   def first(pa, pb) @field == :sym ? 0 : 3; end
   def second(pa, pb) @field == :sym; end
   def third(pa, pb) pa - pb + @fred; end
 end
 EOS
-
-    src.should reek_of(:DataClump, /\[pa, pb\]/, /3 methods/)
+      ctx = ModuleContext.from_s(@src)
+      detector = DataClump.new('newt')
+      detector.examine(ctx)
+      warning = detector.smells_found.to_a[0]   # SMELL: too cumbersome!
+      @yaml = warning.to_yaml
+    end
+    it 'reports all parameters' do
+      @yaml.should match(/parameters:[\s-]*pa/)
+      @yaml.should match(/parameters:[\spa-]*pb/)
+    end
+    it 'reports the number of occurrences' do
+      @yaml.should match(/occurrences:\s*3/)
+    end
   end
 
   it 'reports 3 swapped pairs in a class' do
@@ -103,3 +116,11 @@ describe DataClump do
 
   # TODO: include singleton methods in the calcs
 end
+
+describe DataClump do
+  before(:each) do
+    @detector = DataClump.new('newt')
+  end
+
+  it_should_behave_like 'SmellDetector'
+end

data/spec/reek/smells/duplication_spec.rb

@@ -1,35 +1,33 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-require 'reek/configuration'
-require 'reek/method_context'
-require 'reek/stop_context'
-require 'reek/smells/duplication'
+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', 'duplication')
+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
 
 describe Duplication, "repeated method calls" do
-  it 'should report repeated call' do
+  it 'reports repeated call' do
     'def double_thing() @other.thing + @other.thing end'.should reek_only_of(:Duplication, /@other.thing/)
   end
-
-  it 'should report repeated call to lvar' do
+  it 'reports repeated call to lvar' do
     'def double_thing(other) other[@thing] + other[@thing] end'.should reek_only_of(:Duplication, /other\[@thing\]/)
   end
-
-  it 'should report call parameters' do
+  it 'reports call parameters' do
     'def double_thing() @other.thing(2,3) + @other.thing(2,3) end'.should reek_only_of(:Duplication, /@other.thing\(2, 3\)/)
   end
-
   it 'should report nested calls' do
-    ruby = 'def double_thing() @other.thing.foo + @other.thing.foo end'.sniff
+    ruby = 'def double_thing() @other.thing.foo + @other.thing.foo end'
     ruby.should reek_of(:Duplication, /@other.thing[^\.]/)
     ruby.should reek_of(:Duplication, /@other.thing.foo/)
   end
-
   it 'should ignore calls to new' do
     'def double_thing() @other.new + @other.new end'.should_not reek
   end
+  it 'reports repeated assignment' do
+    'def double_thing(thing) @other[thing] = true; @other[thing] = true; end'.should reek_only_of(:Duplication, /@other\[thing\] = true/)
+  end
 end
 
 describe Duplication, "non-repeated method calls" do
@@ -42,36 +40,44 @@ describe Duplication, "non-repeated method calls" do
   end
 end
 
-describe Duplication, '#examine' do
-  before :each do
-    @mc = MethodContext.new(StopContext.new, s(:defn, :fred))
-    @dup = Duplication.new
+describe Duplication do
+  before(:each) do
+    @source_name = 'copy-cat'
+    @detector = Duplication.new(@source_name)
   end
 
-  it 'should return true when reporting a smell' do
-    3.times { @mc.record_call_to(s(:call, nil, :other, s(:arglist)))}
-    @dup.examine(@mc).should == true
-  end
+  it_should_behave_like 'SmellDetector'
 
-  it 'should return false when not reporting a smell' do
-    @dup.examine(@mc).should == false
-  end
-
-  it 'should return false when not reporting calls to new' do
-    4.times { @mc.record_call_to(s(:call, s(:Set), :new, s(:arglist)))}
-    @dup.examine(@mc).should == false
-  end
+  context 'looking at the YAML' do
+    before :each do
+      src = <<EOS
+def double_thing(other)
+  other[@thing]
+  not_the_sam(at = all)
+  other[@thing]
 end
-
-describe Duplication, 'when disabled' do
-  before :each do
-    @ctx = MethodContext.new(StopContext.new, [0, :double_thing])
-    @dup = Duplication.new({SmellConfiguration::ENABLED_KEY => false})
-  end
-
-  it 'should not report repeated call' do
-    @ctx.record_call_to([:fred])
-    @ctx.record_call_to([:fred])
-    @dup.examine(@ctx).should == false
+EOS
+      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(/class:\s*Duplication/)
+    end
+    it 'reports the subclass' do
+      @yaml.should match(/subclass:\s*DuplicateMethodCall/)
+    end
+    it 'reports the call' do
+      @yaml.should match(/call:\s*other\[\@thing\]/)
+    end
+    it 'reports the correct lines' do
+      @yaml.should match(/lines:\s*- 2\s*- 4/)
+    end
   end
 end

data/spec/reek/smells/feature_envy_spec.rb

@@ -1,7 +1,6 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-require 'reek/smells/feature_envy'
-require 'reek/method_context'
-require 'reek/stop_context'
+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')
 
 include Reek
 include Reek::Smells
@@ -27,8 +26,38 @@ describe FeatureEnvy do
     'def no_envy(arga) arga.barg(@item); arga end'.should_not reek
   end
 
-  it 'should report many calls to parameter' do
-    'def envy(arga) arga.b(arga) + arga.c(@fred) end'.should reek_only_of(:FeatureEnvy, /arga/)
+  context 'with 2 calls to a parameter' do
+    it 'reports the smell' do
+      'def envy(arga) arga.b(arga) + arga.c(@fred) end'.should reek_only_of(:FeatureEnvy, /arga/)
+    end
+  end
+
+  context 'when an envious receiver exists' do
+    before :each do
+      @source_name = 'green as a cucumber'
+      @receiver = 'blah'
+      @ctx = mock('method_context', :null_object => true)
+      @ctx.should_receive(:envious_receivers).and_return({s(:lvar, @receiver) => 4})
+      @detector = FeatureEnvy.new(@source_name)
+      @detector.examine_context(@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(/\sclass:\s*LowCohesion/)
+    end
+    it 'reports the subclass' do
+      @yaml.should match(/subclass:\s*FeatureEnvy/)
+    end
+    it 'reports the envious receiver' do
+      @yaml.should match(/receiver:[\s]*#{@receiver}/)
+    end
+    it 'reports the number of references' do
+      @yaml.should match(/references:\s*4/)
+    end
   end
 
   it 'should report highest affinity' do
@@ -178,20 +207,49 @@ EOS
   end
 end
 
-describe FeatureEnvy, '#examine' do
-
-  before :each do
-    @context = MethodContext.new(StopContext.new, s(:defn, :cool))
-    @fe = FeatureEnvy.new
+describe FeatureEnvy do
+  before(:each) do
+    @source_name = 'green as a cucumber'
+    @detector = FeatureEnvy.new(@source_name)
   end
 
-  it 'should return true when reporting a smell' do
-    @context.refs.record_ref([:lvar, :thing])
-    @context.refs.record_ref([:lvar, :thing])
-    @fe.examine(@context).should == true
-  end
+  it_should_behave_like 'SmellDetector'
 
-  it 'should return false when not reporting a smell' do
-    @fe.examine(@context).should == false
+  context 'when reporting yaml' do
+    before :each do
+      src = <<EOS
+def envious(other)
+  other.call
+  self.do_nothing
+  other.other
+  other.fred
+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*LowCohesion/)
+    end
+    it 'reports the subclass' do
+      @yaml.should match(/subclass:\s*FeatureEnvy/)
+    end
+    it 'reports the envious receiver' do
+      @yaml.should match(/receiver:\s*other/)
+    end
+    it 'reports the number of references' do
+      @yaml.should match(/references:\s*3/)
+    end
+    it 'reports the referring lines' do
+      pending
+      @yaml.should match(/lines:\s*- 2\s*- 4\s*- 5/)
+    end
   end
 end

data/spec/reek/smells/irresponsible_module_spec.rb

@@ -0,0 +1,37 @@
+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')
+
+include Reek::Smells
+
+describe IrresponsibleModule do
+  ['class'].each do |unit|
+    it "does not report a #{unit} having a comment" do
+      src = <<EOS
+# test #{unit}
+#{unit} Responsible; end
+EOS
+      src.should_not reek
+    end
+    it "reports a #{unit} without a comment" do
+      "#{unit} Responsible; end".should reek_only_of(:IrresponsibleModule, /Responsible/)
+    end
+    it "reports a #{unit} with an empty comment" do
+      src = <<EOS
+#
+#
+#  
+#{unit} Responsible; end
+EOS
+      src.should reek_only_of(:IrresponsibleModule, /Responsible/)
+    end
+  end
+end
+
+describe IrresponsibleModule do
+  before(:each) do
+    @detector = IrresponsibleModule.new('yoof')
+  end
+
+  it_should_behave_like 'SmellDetector'
+end

data/spec/reek/smells/large_class_spec.rb

@@ -1,78 +1,37 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-require 'reek/class_context'
-require 'reek/stop_context'
-require 'reek/code_parser'
-require 'reek/smells/large_class'
+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')
 
 include Reek
 include Reek::Smells
 
-describe LargeClass, 'when exceptions are listed' do
-  before(:each) do
-    @class_name = 'Humungous'
-    src = <<EOS
-class #{@class_name}
-  def me01x()3 end;def me02x()3 end;def me03x()3 end;def me04x()3 end;def me05x()3 end
-  def me11x()3 end;def me12x()3 end;def me13x()3 end;def me14x()3 end;def me15x()3 end
-  def me21x()3 end;def me22x()3 end;def me23x()3 end;def me24x()3 end;def me25x()3 end
-  def me31x()3 end;def me32x()3 end;def me33x()3 end;def me34x()3 end;def me35x()3 end
-  def me41x()3 end;def me42x()3 end;def me43x()3 end;def me44x()3 end;def me45x()3 end
-  def me51x()3 end
-end
-EOS
-    @ctx = ClassContext.from_s(src)
-    @config = LargeClass.default_config
-  end
-
-  it 'should ignore first excepted name' do
-    @config[LargeClass::EXCLUDE_KEY] = [@class_name]
-    lc = LargeClass.new(@config)
-    lc.examine(@ctx).should == false
-  end
-
-  it 'should ignore second excepted name' do
-    @config[LargeClass::EXCLUDE_KEY] = ['Oversized', @class_name]
-    lc = LargeClass.new(@config)
-    lc.examine(@ctx).should == false
-  end
-
-  it 'should report non-excepted name' do
-    @config[LargeClass::EXCLUDE_KEY] = ['SmellMe']
-    lc = LargeClass.new(@config)
-    lc.examine(@ctx).should == true
-  end
-end
-
 describe LargeClass, 'checking source code' do
 
   context 'counting instance variables' do
-    it 'should not report empty class' do
-      ClassContext.from_s('class Empty;end').should have(0).variable_names
-    end
-
-    it 'should count ivars in one method' do
-      ClassContext.from_s('class Empty;def ivars() @aa=@ab=@ac=@ad; end;end').should have(4).variable_names
+    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 'should count ivars in 2 methods' do
-      ClassContext.from_s('class Empty;def iv1() @aa=@ab; end;def iv2() @aa=@ac; end;end').should have(3).variable_names
-    end
-
-    it 'should not report 9 ivars' do
-      'class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai; end;end'.should_not reek
+    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
-      'class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=@aj; end;end'.should reek_of(:LargeClass)
+      '# 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
@@ -81,6 +40,7 @@ EOS
 
     it 'should not report 25 methods' do
       src = <<EOS
+# smelly class for testing purposes
 class Full
   def me01x()3 end;def me02x()3 end;def me03x()3 end;def me04x()3 end;def me05x()3 end
   def me11x()3 end;def me12x()3 end;def me13x()3 end;def me14x()3 end;def me15x()3 end
@@ -123,3 +83,78 @@ EOS
     end
   end
 end
+
+describe LargeClass, 'looking at the YAML' do
+  before(:each) do
+    @source_name = 'elephant'
+    @detector = LargeClass.new(@source_name)
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  context 'when the class has many methods' do
+    before :each do
+      src = <<EOS
+class Full
+  def me01x()3 end;def me02x()3 end;def me03x()3 end;def me04x()3 end;def me05x()3 end
+  def me11x()3 end;def me12x()3 end;def me13x()3 end;def me14x()3 end;def me15x()3 end
+  def me21x()3 end;def me22x()3 end;def me23x()3 end;def me24x()3 end;def me25x()3 end
+  def me31x()3 end;def me32x()3 end;def me33x()3 end;def me34x()3 end;def me35x()3 end
+  def me41x()3 end;def me42x()3 end;def me43x()3 end;def me44x()3 end;def me45x()3 end
+  def me51x()3 end
+end
+EOS
+      @yaml = Examiner.new(src).all_smells[0].to_yaml
+    end
+    it 'reports the source' do
+      @yaml.should match(/source:\s*string/)
+    end
+    it 'reports the correct class' do
+      @yaml.should match(/\sclass:\s*LargeClass/)
+    end
+    it 'reports the correct subclass' do
+      @yaml.should match(/\ssubclass:\s*#{LargeClass::SUBCLASS_TOO_MANY_METHODS}/)
+    end
+    it 'reports the number of methods' do
+      @yaml.should match(/method_count:[\s]*26/)
+      # SMELL: many tests duplicate the names of the YAML fields
+    end
+    it 'reports the line number of the declaration' do
+      @yaml.should match(/lines:\s*- 1/)
+    end
+  end
+
+  context 'when the class has 30 instance variables' do
+    before :each 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
+      source = src.to_reek_source
+      sniffer = Core::Sniffer.new(source)
+      ctx = Core::CodeParser.new(sniffer).process_class(source.syntax_tree)
+      @detector.examine_context(ctx)
+      @yaml = @detector.smells_found.to_a[0].to_yaml   # SMELL: too cumbersome!
+    end
+    it 'reports the source' do
+      @yaml.should match(/source:\s*#{@source_name}/)
+    end
+    it 'reports the correct class' do
+      @yaml.should match(/\sclass:\s*LargeClass/)
+    end
+    it 'reports the correct subclass' do
+      @yaml.should match(/\ssubclass:\s*#{LargeClass::SUBCLASS_TOO_MANY_IVARS}/)
+    end
+    it 'reports the number of methods' do
+      @yaml.should match(/ivar_count:\s*10/)
+      # SMELL: many tests duplicate the names of the YAML fields
+    end
+    it 'reports the line number of the declaration' do
+      @yaml.should match(/lines:\s*- 2/)
+    end
+  end
+end