kevinrutherford-reek 1.0.1 → 1.1.1

data/spec/reek/report_spec.rb

@@ -28,7 +28,7 @@ describe Report, "to_s" do
   end
 
   it 'should place each detailed report on a separate line' do
-    @report.length.should == 2
+    @report.should have_at_least(2).lines
   end
 
   it 'should mention every smell name' do

data/spec/reek/sexp_formatter_spec.rb

@@ -7,7 +7,7 @@ include Reek
 
 def should_print(example)
   it "should format #{example} correctly" do
-    sexp = CodeParser.parse_tree_for(example)[0]
+    sexp = CodeParser.parse_tree_for(example)
     SexpFormatter.format(sexp).should == example
   end
 end
@@ -23,9 +23,10 @@ describe SexpFormatter do
   should_print 'obj.method(arg1, arg2)'
   should_print 'obj.method'
   should_print '$1'
-  should_print 'o=q.downcase'
+  should_print 'o = q.downcase'
   should_print 'true'
   should_print '"-#{q}xxx#{z.size}"'
-  should_print '0..5'
-  should_print '0..temp'
+  should_print '(0..5)'
+  should_print '(0..temp)'
+  should_print 'result[opt] = false'
 end

data/spec/reek/singleton_method_context_spec.rb

@@ -11,7 +11,7 @@ describe SingletonMethodContext, 'outer_name' do
   it "should report full context" do
     element = StopContext.new
     element = ModuleContext.new(element, [0, :mod])
-    element = SingletonMethodContext.new(element,  [:defs, [:vcall, :a], :b, nil])
+    element = SingletonMethodContext.new(element,  [:defs, [:call, nil, :a, [:arglist]], :b, nil])
     element.outer_name.should match(/mod::a\.b/)
   end
 end

data/spec/reek/smells/duplication_spec.rb

@@ -13,7 +13,7 @@ describe Duplication, "repeated method calls" do
   end
 
   it 'should report repeated call to lvar' do
-    'def double_thing() other[@thing] + other[@thing] end'.should reek_only_of(:Duplication, /other\[@thing\]/)
+    'def double_thing(other) other[@thing] + other[@thing] end'.should reek_only_of(:Duplication, /other\[@thing\]/)
   end
 
   it 'should report call parameters' do
@@ -50,7 +50,7 @@ describe Duplication, '#examine' do
   end
 
   it 'should return true when reporting a smell' do
-    @mc.calls = {'x' => 47}
+    @mc.calls = {s(:call, nil, :other, s(:arglist)) => 47}
     @dup.examine(@mc, []).should == true
   end
   

data/spec/reek/smells/feature_envy_spec.rb

@@ -6,7 +6,7 @@ require 'reek/stop_context'
 include Reek
 include Reek::Smells
 
-describe FeatureEnvy, 'with only messages to self' do
+describe FeatureEnvy do
   it 'should not report use of self' do
     'def simple() self.to_s + self.to_i end'.should_not reek
   end
@@ -18,23 +18,26 @@ describe FeatureEnvy, 'with only messages to self' do
   it 'should not report vcall with argument' do
     'def simple(arga) func(17); end'.should_not reek
   end
-end
 
-describe FeatureEnvy, 'when the receiver is a parameter' do
   it 'should not report single use' do
-    'def no_envy(arga) arga.barg(@item) end'.should_not reek
+    '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
+    '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/)
+    'def envy(arga)
+      arga.b(arga) + arga.c(@fred)
+    end'.should reek_only_of(:FeatureEnvy, /arga/)
   end
-end
 
-describe FeatureEnvy, 'when there are many possible receivers' do
   it 'should report highest affinity' do
     ruby = 'def total_envy
       fred = @item
@@ -56,9 +59,7 @@ describe FeatureEnvy, 'when there are many possible receivers' do
     ruby.should reek_of(:FeatureEnvy, /total/)
     ruby.should reek_of(:FeatureEnvy, /fred/)
   end
-end
 
-describe FeatureEnvy, 'when the receiver is external' do
   it 'should ignore global variables' do
     'def no_envy() $s2.to_a; $s2[@item] end'.should_not reek
   end
@@ -66,9 +67,7 @@ describe FeatureEnvy, 'when the receiver is external' do
   it 'should not report class methods' do
     'def simple() self.class.new.flatten_merge(self) end'.should_not reek
   end
-end
 
-describe FeatureEnvy, 'when the receiver is an ivar' do
   it 'should not report single use of an ivar' do
     'def no_envy() @item.to_a end'.should_not reek
   end
@@ -78,17 +77,132 @@ describe FeatureEnvy, 'when the receiver is an ivar' do
   end
 
   it 'should not report ivar usage in a parameter' do
-    'def no_envy; @item.price + tax(@item) - savings(@item) end'.should_not reek
+    'def no_envy
+        @item.price + tax(@item) - savings(@item)
+      end'.should_not reek
   end
 
   it 'should not be fooled by duplication' do
-    ruby = Source.from_s('def feed(thing); @cow.feed_to(thing.pig); @duck.feed_to(thing.pig); end')
-    ruby.should reek_only_of(:Duplication, /thing.pig/)
+    'def feed(thing)
+        @cow.feed_to(thing.pig)
+        @duck.feed_to(thing.pig)
+      end'.should reek_only_of(:Duplication, /thing.pig/)
   end
 
   it 'should count local calls' do
-    ruby = Source.from_s('def feed(thing); cow.feed_to(thing.pig); duck.feed_to(thing.pig); end')
-    ruby.should reek_only_of(:Duplication, /thing.pig/)
+    '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/)
+    #
+    # def moved_version
+    #   price + tax
+    # end
+    #
+    # def envy
+    #   @item.moved_version
+    # 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 'reports the most-used ivar' do
+    pending('bug')
+    'def func
+       @other.a
+       @other.b
+       @nother.c
+     end'.should reek_of(:FeatureEnvy, /@other/)
+    #
+    # def other.func(me)
+    #   a
+    #   b
+    #   me.nother_c
+    # end
+    #
+  end
+
+  it 'ignores multiple ivars' do
+    'def func
+       @other.a
+       @other.b
+       @nother.c
+       @nother.d
+     end'.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
+
+  it 'counts self references correctly' do
+    'def adopt!(other)
+      other.keys.each do |key|
+        ov = other[key]
+        if Array === ov and has_key?(key)
+          self[key] += ov
+        else
+          self[key] = ov
+        end
+      end
+      self
+    end'.should_not reek
+  end
+end
+
+describe FeatureEnvy do
+  it 'counts references to self correctly' do
+    ruby = <<EOS
+def report
+  unless @report
+    @report = Report.new
+    cf = SmellConfig.new
+    cf = cf.load_local(@dir) if @dir
+    CodeParser.new(@report, cf.smell_listeners).check_source(@source)
+  end
+  @report
+end
+EOS
+    ruby.should reek_only_of(:LongMethod)
   end
 end
 
@@ -104,26 +218,8 @@ describe FeatureEnvy, '#examine' do
     @context.refs.record_ref([:lvar, :thing])
     @fe.examine(@context, []).should == true
   end
-  
+
   it 'should return false when not reporting a smell' do
     @fe.examine(@context, []).should == false
   end
 end
-
-describe FeatureEnvy, 'when the receiver is an lvar' do
-  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/)
-  end
-
-  it 'should not report lvar usage in a parameter' do
-    'def no_envy; lv = @item; lv.price + tax(lv) - savings(lv) end'.should_not reek
-  end
-end

data/spec/reek/smells/large_class_spec.rb

@@ -8,18 +8,19 @@ include Reek::Smells
 
 describe LargeClass do
 
-  class BigOne
-    26.times do |i|
-      define_method "method#{i}".to_sym do
-        @melting
+  it 'should report large class' do
+    class BigOne
+      26.times do |i|
+        define_method "method#{i}".to_sym do
+          @melting
+        end
       end
     end
+    BigOne.should reek_only_of(:LargeClass, /BigOne/)
   end
+end
 
-  before(:each) do
-    @rpt = Report.new
-    @cchk = CodeParser.new(@rpt, SmellConfig.new.smell_listeners)
-  end
+describe LargeClass do
 
   it 'should not report short class' do
     class ShortClass
@@ -30,57 +31,57 @@ describe LargeClass do
       def method5() @var5; end
       def method6() @var6; end
     end
-    @cchk.check_object(ShortClass)
-    @rpt.should be_empty
+    ShortClass.should_not reek
   end
+end
 
-  it 'should report large class' do
-    @cchk.check_object(BigOne)
-    @rpt.length.should == 1
-  end
+describe LargeClass, 'when exceptions are listed' do
 
-  it 'should report class name' do
-    @cchk.check_object(BigOne)
-    @rpt[0].report.should match(/BigOne/)
+  before(:each) do
+    @rpt = Report.new
+    @ctx = ClassContext.create(StopContext.new, [0, :Humungous])
+    30.times { |num| @ctx.record_method("method#{num}") }
+    @config = LargeClass.default_config
   end
 
-  describe 'when exceptions are listed' do
-    before :each do
-      @ctx = ClassContext.create(StopContext.new, [0, :Humungous])
-      30.times { |num| @ctx.record_method("method#{num}") }
-      @config = LargeClass.default_config
-    end
+  it 'should ignore first excepted name' do
+    @config[LargeClass::EXCLUDE_KEY] = ['Humungous']
+    lc = LargeClass.new(@config)
+    lc.examine(@ctx, @rpt).should == false
+    @rpt.length.should == 0
+  end
 
-    it 'should ignore first excepted name' do
-      @config[LargeClass::EXCLUDE_KEY] = ['Humungous']
-      lc = LargeClass.new(@config)
-      lc.examine(@ctx, @rpt).should == false
-      @rpt.length.should == 0
-    end
+  it 'should ignore second excepted name' do
+    @config[LargeClass::EXCLUDE_KEY] = ['Oversized', 'Humungous']
+    lc = LargeClass.new(@config)
+    lc.examine(@ctx, @rpt).should == false
+    @rpt.length.should == 0
+  end
 
-    it 'should ignore second excepted name' do
-      @config[LargeClass::EXCLUDE_KEY] = ['Oversized', 'Humungous']
-      lc = LargeClass.new(@config)
-      lc.examine(@ctx, @rpt).should == false
-      @rpt.length.should == 0
-    end
+  it 'should report non-excepted name' do
+    @config[LargeClass::EXCLUDE_KEY] = ['SmellMe']
+    lc = LargeClass.new(@config)
+    lc.examine(@ctx, @rpt).should == true
+    @rpt.length.should == 1
+  end
+end
 
-    it 'should report non-excepted name' do
-      @config[LargeClass::EXCLUDE_KEY] = ['SmellMe']
-      lc = LargeClass.new(@config)
-      lc.examine(@ctx, @rpt).should == true
-      @rpt.length.should == 1
+describe LargeClass, 'counting instance variables' do
+  it 'warns about class with 10 ivars' do
+    class ManyIvars
+      def method
+        @vara = @varb = @varc = @vard = @vare
+        @varf = @varg = @varh = @vari = @varj
+      end
     end
+    ManyIvars.should reek_of(:LargeClass, /10/)
   end
-end
 
-describe LargeClass do
-  it 'should not report empty class in another module' do
-    'class Treetop::Runtime::SyntaxNode; end'.should_not reek
+  it 'ignores class with only a couple of ivars' do
+    LargeClass.should_not reek_of(:LargeClass)
   end
 
-  it 'should deal with :: scoped names' do
-    element = ClassContext.create(StopContext.new, [:colon2, [:colon2, [:const, :Treetop], :Runtime], :SyntaxNode])
-    element.num_methods.should == 0
+  it 'ignores fq class with only a couple of ivars' do
+    Reek::Smells::LargeClass.should_not reek_of(:LargeClass)
   end
 end

data/spec/reek/smells/long_method_spec.rb

@@ -5,7 +5,7 @@ require 'reek/report'
 
 include Reek
 
-describe CodeParser, "(Long Method)" do
+describe LongMethod do
   it 'should not report short methods' do
     'def short(arga) alf = f(1);@bet = 2;@cut = 3;@dit = 4; @emp = 5;end'.should_not reek
   end

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -7,7 +7,7 @@ require 'reek/report'
 include Reek
 include Reek::Smells
 
-describe CodeParser, "(Long Parameter List)" do
+describe LongParameterList do
   
   describe 'for methods with few parameters' do
     it 'should report nothing for no parameters' do
@@ -25,7 +25,7 @@ describe CodeParser, "(Long Parameter List)" do
     it 'should not report inner block with too many parameters' do
       'def simple(yep,zero); m[3]; rand(34); f.each { |arga, argb, argc, argd| true}; end'.should_not reek
     end
-    
+
     describe 'and default values' do
       it 'should report nothing for 1 parameter' do
         'def simple(zero=nil) f(3);false end'.should_not reek
@@ -57,20 +57,13 @@ describe CodeParser, "(Long Parameter List)" do
     end
     
     describe 'in a class' do
-      before(:each) do
-        @rpt = Report.new
-        @cchk = CodeParser.new(@rpt, SmellConfig.new.smell_listeners)
-      end
-
       class InnerTest
         def xyzero(arga,argb) f(3);true end
         def abc(argx,yep,zero,argm) f(3);false end
       end
 
       it 'should only report long param list' do
-        @cchk.check_object(InnerTest)
-        @rpt.length.should == 1
-        @rpt[0].report.should match(/Long Parameter List/)
+        InnerTest.should reek_only_of(:LongParameterList, /abc/)
       end
     end
   end
@@ -83,7 +76,7 @@ describe CodeParser, "(Long Parameter List)" 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 a,b,a,b; end'.should reek_only_of(:LongYieldList, /simple/, /yields/, /4/)
+      '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