reek 1.2.7.1 → 1.2.7.2

data/spec/reek/smells/class_variable_spec.rb

@@ -13,37 +13,37 @@ describe ClassVariable do
     @class_variable = '@@things'
   end
 
+  it_should_behave_like 'SmellDetector'
+
   context 'with no class variables' do
     it 'records nothing in the class' do
-      ctx = ClassContext.from_s('class Fred; end')
-      @detector.class_variables_in(ctx).should be_empty
+      exp = ast(:class, :Fred)
+      @detector.class_variables_in(exp).should be_empty
     end
     it 'records nothing in the module' do
-      ctx = ModuleContext.from_s('module Fred; end')
-      @detector.class_variables_in(ctx).should be_empty
+      exp = ast(:module, :Fred)
+      @detector.class_variables_in(exp).should be_empty
     end
   end
 
   context 'with one class variable' do
     shared_examples_for 'one variable found' do
       before :each do
-        @detector.examine_context(@ctx)
-        @smells = @detector.smells_found
+        ast = @src.to_reek_source.syntax_tree
+        @cvars = @detector.class_variables_in(ast).to_a
       end
       it 'records only that class variable' do
-        @smells.length.should == 1
+        @cvars.length.should == 1
       end
       it 'records the variable name' do
-        @smells.each do |warning|
-          warning.smell['variable'].should == @class_variable
-        end
+        @cvars[0].to_s.should == @class_variable
       end
     end
 
     ['class', 'module'].each do |scope|
       context "declared in a #{scope}" do
         before :each do
-          @ctx = ClassContext.from_s("#{scope} Fred; #{@class_variable} = {}; end")
+          @src = "#{scope} Fred; #{@class_variable} = {}; end"
         end
 
         it_should_behave_like 'one variable found'
@@ -51,7 +51,7 @@ describe ClassVariable do
 
       context "used in a #{scope}" do
         before :each do
-          @ctx = ClassContext.from_s("#{scope} Fred; def jim() #{@class_variable} = {}; end; end")
+          @src = "#{scope} Fred; def jim() #{@class_variable} = {}; end; end"
         end
 
         it_should_behave_like 'one variable found'
@@ -59,7 +59,7 @@ describe ClassVariable do
 
       context "indexed in a #{scope}" do
         before :each do
-          @ctx = ClassContext.from_s("#{scope} Fred; def jim() #{@class_variable}[mash] = {}; end; end")
+          @src = "#{scope} Fred; def jim() #{@class_variable}[mash] = {}; end; end"
         end
 
         it_should_behave_like 'one variable found'
@@ -67,7 +67,7 @@ describe ClassVariable do
 
       context "declared and used in a #{scope}" do
         before :each do
-          @ctx = ClassContext.from_s("#{scope} Fred; #{@class_variable} = {}; def jim() #{@class_variable} = {}; end; end")
+          @src = "#{scope} Fred; #{@class_variable} = {}; def jim() #{@class_variable} = {}; end; end"
         end
 
         it_should_behave_like 'one variable found'
@@ -75,14 +75,11 @@ describe ClassVariable do
 
       context "used twice in a #{scope}" do
         before :each do
-          @ctx = ClassContext.from_s("#{scope} Fred; def jeff() #{@class_variable} = {}; end; def jim() #{@class_variable} = {}; end; end")
+          @src = "#{scope} Fred; def jeff() #{@class_variable} = {}; end; def jim() #{@class_variable} = {}; end; end"
         end
 
         it_should_behave_like 'one variable found'
       end
     end
-
   end
-
-  it_should_behave_like 'SmellDetector'
 end

data/spec/reek/smells/data_clump_spec.rb

@@ -20,8 +20,9 @@ EOS
 
   context 'with 3 identical pairs' do
     before :each do
+      @module_name = 'Scrunch'
       @src = <<EOS
-#{@context} Scrunch
+#{@context} #{@module_name}
   def first(pa, pb) @field == :sym ? 0 : 3; end
   def second(pa, pb) @field == :sym; end
   def third(pa, pb) pa - pb + @fred; end
@@ -30,15 +31,30 @@ EOS
       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
+      @smells = detector.smells_found.to_a
+      @warning = @smells[0]   # SMELL: too cumbersome!
+      @yaml = @warning.to_yaml
+    end
+    it 'records only the one smell' do
+      @smells.length.should == 1
     end
     it 'reports all parameters' do
-      @yaml.should match(/parameters:[\s-]*pa/)
-      @yaml.should match(/parameters:[\spa-]*pb/)
+      @smells[0].smell[DataClump::PARAMETERS_KEY].should == ['pa', 'pb']
     end
     it 'reports the number of occurrences' do
-      @yaml.should match(/occurrences:\s*3/)
+      @smells[0].smell['occurrences'].should == 3
+    end
+    it 'reports all parameters' do
+      @smells[0].smell[DataClump::METHODS_KEY].should == ['first', 'second', 'third']
+    end
+    it 'reports the declaration line numbers' do
+      @smells[0].lines.should == [2,3,4]
+    end
+    it 'reports the correct smell class' do
+      @smells[0].smell_class.should == DataClump::SMELL_CLASS
+    end
+    it 'reports the context fq name' do
+      @smells[0].context.should == @module_name
     end
   end
 

data/spec/reek/smells/duplication_spec.rb

@@ -7,26 +7,40 @@ require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shar
 include Reek
 include Reek::Smells
 
-describe Duplication, "repeated method calls" do
-  it 'reports repeated call' do
-    'def double_thing() @other.thing + @other.thing end'.should reek_only_of(:Duplication, /@other.thing/)
-  end
-  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 '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'
-    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
+describe Duplication do
+  context "with repeated method calls" do
+    it 'reports repeated call' do
+      'def double_thing() @other.thing + @other.thing end'.should reek_only_of(:Duplication, /@other.thing/)
+    end
+    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 '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'
+      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
   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/)
+
+  context 'with repeated attribute assignment' do
+    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
+    it 'does not report multi-assignments' do
+      src = <<EOS
+def _parse ctxt
+  ctxt.index, result = @ind, @result
+  error, ctxt.index = @err, @err_ind
+end
+EOS
+      src.should_not reek
+    end
   end
 end
 

data/spec/reek/smells/feature_envy_spec.rb

@@ -6,24 +6,65 @@ include Reek
 include Reek::Smells
 
 describe FeatureEnvy do
-  it 'should not report use of self' do
-    'def simple() self.to_s + self.to_i end'.should_not reek
-  end
-
-  it 'should not report vcall with no argument' do
-    'def simple() func; end'.should_not reek
-  end
-
-  it 'should not report vcall with argument' do
-    'def simple(arga) func(17); end'.should_not reek
-  end
-
-  it 'should not report single use' do
-    'def no_envy(arga) arga.barg(@item) end'.should_not reek
+  context 'with no smell' do
+    it 'should not report use of self' do
+      'def simple() self.to_s + self.to_i end'.should_not reek
+    end
+    it 'should not report vcall with no argument' do
+      'def simple() func; end'.should_not reek
+    end
+    it 'should not report vcall with argument' do
+      'def simple(arga) func(17); end'.should_not reek
+    end
+    it 'should not report single use' do
+      'def no_envy(arga) arga.barg(@item) end'.should_not reek
+    end
+    it 'should not report return value' do
+      'def no_envy(arga) arga.barg(@item); arga end'.should_not reek
+    end
+    it 'should ignore global variables' do
+      'def no_envy() $s2.to_a; $s2[@item] end'.should_not reek
+    end
+    it 'should not report class methods' do
+      'def simple() self.class.new.flatten_merge(self) end'.should_not reek
+    end
+    it 'should not report single use of an ivar' do
+      'def no_envy() @item.to_a end'.should_not reek
+    end
+    it 'should not report returning an ivar' do
+      'def no_envy() @item.to_a; @item end'.should_not reek
+    end
+    it 'should not report ivar usage in a parameter' do
+      'def no_envy() @item.price + tax(@item) - savings(@item) end'.should_not reek
+    end
+    it 'should not report single use of an lvar' do
+      'def no_envy() lv = @item; lv.to_a end'.should_not reek
+    end
+    it 'should not report returning an lvar' do
+      'def no_envy() lv = @item; lv.to_a; lv end'.should_not reek
+    end
+    it 'ignores lvar usage in a parameter' do
+      'def no_envy() lv = @item; lv.price + tax(lv) - savings(lv); end'.should_not reek
+    end
+    it 'ignores multiple ivars' do
+      src = <<EOS
+  def func
+    @other.a
+    @other.b
+    @nother.c
+    @nother.d
   end
-
-  it 'should not report return value' do
-    'def no_envy(arga) arga.barg(@item); arga end'.should_not reek
+EOS
+      src.should_not reek
+      #
+      # def other.func(me)
+      #   a
+      #   b
+      #   me.nother_c
+      #   me.nother_d
+      # end
+      #
+    end
   end
 
   context 'with 2 calls to a parameter' do
@@ -37,26 +78,28 @@ describe FeatureEnvy 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})
+      @ctx.should_receive(:envious_receivers).and_return({ast(: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
+      @smells = @detector.smells_found.to_a
+    end
+    it 'reports only that smell' do
+      @smells.length.should == 1
     end
     it 'reports the source' do
-      @yaml.should match(/source:\s*#{@source_name}/)
+      @smells[0].source.should == @source_name
     end
     it 'reports the class' do
-      @yaml.should match(/\sclass:\s*LowCohesion/)
+      @smells[0].smell_class.should == FeatureEnvy::SMELL_CLASS
     end
     it 'reports the subclass' do
-      @yaml.should match(/subclass:\s*FeatureEnvy/)
+      @smells[0].subclass.should == FeatureEnvy::SMELL_SUBCLASS
     end
     it 'reports the envious receiver' do
-      @yaml.should match(/receiver:[\s]*#{@receiver}/)
+      @smells[0].smell[FeatureEnvy::RECEIVER_KEY].should == @receiver
     end
     it 'reports the number of references' do
-      @yaml.should match(/references:\s*4/)
+      @smells[0].smell[FeatureEnvy::REFERENCES_KEY].should == 4
     end
   end
 
@@ -86,26 +129,6 @@ EOS
     src.should reek_of(:FeatureEnvy, /fred/)
   end
 
-  it 'should ignore global variables' do
-    'def no_envy() $s2.to_a; $s2[@item] end'.should_not reek
-  end
-
-  it 'should not report class methods' do
-    'def simple() self.class.new.flatten_merge(self) end'.should_not reek
-  end
-
-  it 'should not report single use of an ivar' do
-    'def no_envy() @item.to_a end'.should_not reek
-  end
-
-  it 'should not report returning an ivar' do
-    'def no_envy() @item.to_a; @item end'.should_not reek
-  end
-
-  it 'should not report ivar usage in a parameter' do
-    'def no_envy() @item.price + tax(@item) - savings(@item) end'.should_not reek
-  end
-
   it 'should not be fooled by duplication' do
     'def feed(thing) @cow.feed_to(thing.pig); @duck.feed_to(thing.pig) end'.should reek_only_of(:Duplication, /thing.pig/)
   end
@@ -114,14 +137,6 @@ EOS
     'def feed(thing) cow.feed_to(thing.pig); duck.feed_to(thing.pig) end'.should reek_only_of(:Duplication, /thing.pig/)
   end
 
-  it 'should not report single use of an lvar' do
-    'def no_envy() lv = @item; lv.to_a end'.should_not reek
-  end
-
-  it 'should not report returning an lvar' do
-    'def no_envy() lv = @item; lv.to_a; lv end'.should_not reek
-  end
-
   it 'should report many calls to lvar' do
     'def envy() lv = @item; lv.price + lv.tax; end'.should reek_only_of(:FeatureEnvy, /lv/)
     #
@@ -134,30 +149,6 @@ EOS
     # end
   end
 
-  it 'ignores lvar usage in a parameter' do
-    'def no_envy() lv = @item; lv.price + tax(lv) - savings(lv); end'.should_not reek
-  end
-
-  it 'ignores multiple ivars' do
-    src = <<EOS
-def func
-  @other.a
-  @other.b
-  @nother.c
-  @nother.d
-end
-EOS
-    src.should_not reek
-    #
-    # def other.func(me)
-    #   a
-    #   b
-    #   me.nother_c
-    #   me.nother_d
-    # end
-    #
-  end
-
   it 'ignores frequent use of a call' do
     'def func() other.a; other.b; nother.c end'.should_not reek_of(:FeatureEnvy)
   end
@@ -217,39 +208,42 @@ describe FeatureEnvy do
 
   context 'when reporting yaml' do
     before :each do
+      @receiver = 'other'
       src = <<EOS
 def envious(other)
-  other.call
+  #{@receiver}.call
   self.do_nothing
-  other.other
-  other.fred
+  #{@receiver}.other
+  #{@receiver}.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
+      @smells = @detector.smells_found.to_a
+    end
+    it 'reports only that smell' do
+      @smells.length.should == 1
     end
     it 'reports the source' do
-      @yaml.should match(/source:\s*#{@source_name}/)
+      @smells[0].source.should == @source_name
     end
     it 'reports the class' do
-      @yaml.should match(/class:\s*LowCohesion/)
+      @smells[0].smell_class.should == FeatureEnvy::SMELL_CLASS
     end
     it 'reports the subclass' do
-      @yaml.should match(/subclass:\s*FeatureEnvy/)
+      @smells[0].subclass.should == FeatureEnvy::SMELL_SUBCLASS
     end
     it 'reports the envious receiver' do
-      @yaml.should match(/receiver:\s*other/)
+      @smells[0].smell[FeatureEnvy::RECEIVER_KEY].should == @receiver
     end
     it 'reports the number of references' do
-      @yaml.should match(/references:\s*3/)
+      @smells[0].smell[FeatureEnvy::REFERENCES_KEY].should == 3
     end
     it 'reports the referring lines' do
       pending
-      @yaml.should match(/lines:\s*- 2\s*- 4\s*- 5/)
+      @smells[0].lines.should == [2, 4, 5]
     end
   end
 end

data/spec/reek/smells/large_class_spec.rb

@@ -104,7 +104,7 @@ class Full
   def me51x()3 end
 end
 EOS
-      @yaml = Examiner.new(src).all_smells[0].to_yaml
+      @yaml = Examiner.new(src).smells[0].to_yaml
     end
     it 'reports the source' do
       @yaml.should match(/source:\s*string/)