reek 0.2.2 → 0.2.3

data/lib/reek/version.rb

@@ -2,7 +2,7 @@ module Reek #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 2
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/integration_spec.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/spec_helper.rb'
 require 'reek/version'
 
 describe 'Reek version number' do
-  it 'should reprot the correct value' do
+  it 'should report the correct value' do
     actual = `ruby -Ilib bin/reek --version`.split
     actual[0].should == 'reek'
     actual[1].should == Reek::VERSION::STRING
@@ -20,6 +20,7 @@ describe 'Integration test:' do
 
       it 'should report the correct smells' do
         actual = `ruby -Ilib bin/reek #{source} 2>/dev/null`.split(/\n/)
+        actual.length.should == @expected.length
         @expected.zip(actual).each do |p|
           actual = p[1] ? p[1].chomp : p[1]
           actual.should == p[0]
@@ -28,6 +29,7 @@ describe 'Integration test:' do
 
       it 'should report the correct smells in smell order' do
         actual = `ruby -Ilib bin/reek --sort smell #{source} 2>/dev/null`.split(/\n/)
+        actual.length.should == @expected.length
         @expected.sort.zip(actual).each do |p|
           actual = p[1] ? p[1].chomp : p[1]
           actual.should == p[0]
@@ -36,13 +38,3 @@ describe 'Integration test:' do
     end
   end
 end
-
-describe 'Reek source code:' do
-  Dir['lib/**/*.rb'].each do |source|
-    describe source do
-      it 'should report no smells' do
-        `ruby -Ilib bin/reek #{source}`.should == "\n"
-      end
-    end
-  end
-end

data/spec/reek/feature_envy_spec.rb

@@ -1,49 +1,87 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 require 'reek/method_checker'
+require 'reek/smells'
 require 'reek/report'
 
 include Reek
 
-describe MethodChecker, "(Feature Envy)" do
-
+describe FeatureEnvy, 'with only messages to self' do
   before(:each) do
     @rpt = Report.new
     @cchk = MethodChecker.new(@rpt, 'Thing')
   end
 
-  it 'should not report local method call' do
-    @cchk.check_source('def simple(arga) f(17) end')
+  it 'should not report use of self' do
+    @cchk.check_source('def simple() self.to_s + self.to_i end')
+    @rpt.should be_empty
+  end
+
+  it 'should not report vcall with no argument' do
+    @cchk.check_source('def simple() func + grunc end')
+    @rpt.should be_empty
+  end
+
+  it 'should not report vcall with argument' do
+    @cchk.check_source('def simple(arga) func(17) + grunc(arga) end')
     @rpt.should be_empty
   end
+end
 
-  it 'should report message chain' do
-    @cchk.check_source('def parse(arga) arga.b.c end')
-    @rpt.length.should == 2
+describe FeatureEnvy, 'when the receiver is a parameter' do
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
   end
 
-  it 'should report simple parameter call' do
-    @cchk.check_source('def simple(arga) arga[3] end')
-    @rpt.length.should == 2
-    @rpt[0].should == UtilityFunction.new(@cchk)
-    @rpt[1].should == FeatureEnvy.new(@cchk, :arga)
+  it 'should not report single use' do
+    @cchk.check_source('def no_envy(arga) arga.barg(@item) end')
+    @rpt.length.should == 0
+  end
+
+  it 'should not report return value' do
+    @cchk.check_source('def no_envy(arga) arga.barg(@item); arga end')
+    @rpt.length.should == 0
+  end
+
+  it 'should report many calls to parameter' do
+    @cchk.check_source('def envy(arga) arga.b(arga) + arga.c(@fred) end')
+    @rpt.length.should == 1
+    FeatureEnvy.should === @rpt[0]
+    @rpt[0].to_s.should match(/arga/)
+  end
+end
+
+describe FeatureEnvy, 'when there are many possible receivers' do
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
   end
 
   it 'should report highest affinity' do
-    @cchk.check_source('def simple(arga) slim = ""; s1 = ""; s1.to_s; @m = 34; end')
+    @cchk.check_source('def total_envy() @total += @item.price; @total += @item.tax; @total *= 1.15 end')
     @rpt.length.should == 1
-    @rpt[0].should == FeatureEnvy.new(@cchk, :s1)
+    FeatureEnvy.should === @rpt[0]
+    @rpt[0].to_s.should match(/@total/)
   end
 
   it 'should report multiple affinities' do
-    @cchk.check_source('def simple(arga) s1 = ""; s1.to_s; s2 = ""; s2.to_s; @m = 34; end')
+    @cchk.check_source('def total_envy() @total += @item.price; @total += @item.tax end')
     @rpt.length.should == 1
-    @rpt[0].should == FeatureEnvy.new(@cchk, :s1, :s2)
+    @rpt[0].to_s.should match(/@total/)
+    @rpt[0].to_s.should match(/@item/)
   end
+end
 
-  it 'should not reference global variables' do
-    @cchk.check_source('def simple(arga) @s = ""; $s2.to_a; $s2.to_s; end')
-    @rpt.length.should == 0
+describe FeatureEnvy, 'when the receiver is external' do
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should ignore global variables' do
+    @cchk.check_source('def no_envy() $s2.to_a; $s2[@item] end')
+    @rpt.should be_empty
   end
 
   it 'should not report class methods' do
@@ -52,10 +90,111 @@ describe MethodChecker, "(Feature Envy)" do
   end
 end
 
-describe FeatureEnvy, '#report' do
-  it 'should report the envious host' do
-    mchk = MethodChecker.new([], 'Class')
-    smell = FeatureEnvy.new(mchk, [:lvar, :fred])
-    smell.report.should match(/fred/)
+describe FeatureEnvy, 'when the receiver is an ivar' do
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should not report single use of an ivar' do
+    @cchk.check_source('def no_envy() @item.to_a end')
+    @rpt.length.should == 0
+  end
+
+  it 'should not report returning an ivar' do
+    @cchk.check_source('def no_envy() @item.to_a; @item end')
+    @rpt.length.should == 0
+  end
+
+  it 'should report many calls to ivar' do
+    @cchk.check_source('def envy; @item.price + @item.tax end')
+    @rpt.length.should == 1
+    FeatureEnvy.should === @rpt[0]
+    @rpt[0].to_s.should match(/@item/)
+  end
+
+  it 'should not report ivar usage in a parameter' do
+    @cchk.check_source('def no_envy; @item.price + tax(@item) - savings(@item) end')
+    @rpt.should be_empty
+  end
+end
+
+describe FeatureEnvy, 'when the receiver is an lvar' do
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should not report single use of an lvar' do
+    @cchk.check_source('def no_envy() lv = @item; lv.to_a end')
+    @rpt.length.should == 0
+  end
+
+  it 'should not report returning an lvar' do
+    @cchk.check_source('def no_envy() lv = @item; lv.to_a; lv end')
+    @rpt.length.should == 0
+  end
+
+  it 'should report many calls to lvar' do
+    @cchk.check_source('def envy; lv = @item; lv.price + lv.tax end')
+    @rpt.length.should == 1
+    FeatureEnvy.should === @rpt[0]
+    @rpt[0].to_s.should match(/lv/)
+  end
+
+  it 'should not report lvar usage in a parameter' do
+    @cchk.check_source('def no_envy; lv = @item; lv.price + tax(lv) - savings(lv) end')
+    @rpt.should be_empty
+  end
+end
+
+describe FeatureEnvy, 'when the receiver is a returned value' do
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should not report single use of a return value' do
+    @cchk.check_source('def no_envy() f.g.price end')
+    @rpt.length.should == 0
+  end
+
+  it 'should not report return value' do
+    @cchk.check_source('def no_envy() f.g.wibble; f.g end')
+    @rpt.length.should == 1
+    FeatureEnvy.should === @rpt[0]
+    @rpt[0].to_s.should match(/f/)
+    @rpt[0].to_s.should_not match(/f.g/)
+  end
+
+  it 'should report many calls to a returned value' do
+    @cchk.check_source('def envy; f.g.price + f.g.tax end')
+    @rpt.length.should == 1
+    FeatureEnvy.should === @rpt[0]
+    @rpt[0].to_s.should match(/f.g/)
+  end
+
+  it 'should not report value usage in a parameter' do
+    @cchk.check_source('def no_envy; f.g.price + tax(f.g) - savings(f.g) end')
+    @rpt.should be_empty
+  end
+end
+
+describe FeatureEnvy, 'when the receiver is a dvar' do
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
   end
+
+  it "should not report method with successive iterators" do
+    pending('this is a bug!')
+    source =<<EOS
+def bad(fred)
+  @fred.each {|item| item.each }
+  @jim.each {|item| item.each }
+end
+EOS
+    @chk.check_source(source)
+    @rpt.should be_empty
+  end  
 end

data/spec/reek/long_method_spec.rb

@@ -27,18 +27,18 @@ describe MethodChecker, "(Long Method)" do
     source =<<EOS
   def standard_entries(rbconfig)
     @abc = rbconfig
-    rubypath = File.join(@abc['bindir'], @abc['ruby_install_name'] + c['EXEEXT'])
-    major = c['MAJOR'].to_i
-    minor = c['MINOR'].to_i
-    teeny = c['TEENY'].to_i
+    rubypath = File.join(@abc['bindir'], @abcf['ruby_install_name'] + cff['EXEEXT'])
+    major = yyy['MAJOR'].to_i
+    minor = zzz['MINOR'].to_i
+    teeny = ccc['TEENY'].to_i
     version = ""
     if c['rubylibdir']
-      libruby         = "/lib/ruby"
-      librubyver      = "/lib/ruby/"
-      librubyverarch  = "/lib/ruby/"
-      siteruby        = "lib/ruby/version/site_ruby"
-      siterubyver     = siteruby
-      siterubyverarch = "$siterubyver/['arch']}"
+      @libruby         = "/lib/ruby"
+      @librubyver      = "/lib/ruby/"
+      @librubyverarch  = "/lib/ruby/"
+      @siteruby        = "lib/ruby/version/site_ruby"
+      @siterubyver     = siteruby
+      @siterubyverarch = "$siterubyver/['arch']}"
     end
   end
 EOS
@@ -59,7 +59,7 @@ describe MethodChecker, "(Long Block)" do
     src = <<EOS
 def long(arga)
   f(3)
-  37.each do |xyzero|
+  self.each do |xyzero|
     xyzero = 1
     xyzero = 2
     xyzero = 3

data/spec/reek/method_checker_spec.rb

@@ -31,3 +31,37 @@ describe MethodChecker, 'when given a C extension' do
     @cchk.check_object(Enumerable)
   end
 end
+
+describe MethodChecker, 'when a yield is the receiver' do
+  it 'should report no problems' do
+    source = 'def values(*args)
+  @to_sql += case
+    when block_given? then " #{yield.to_sql}"
+    else " values (#{args.to_sql})"
+  end
+  self
+end'
+    rpt = Report.new
+    chk = MethodChecker.new(rpt, 'Thing')
+    chk.check_source(source)
+    rpt.should be_empty
+  end
+end
+
+describe MethodChecker, '#is_override?' do
+  it 'should be false for non-override method' do
+    MethodChecker.is_override?('String', 'gsub').should == false
+  end
+
+  it 'should be true for overriding method' do
+    MethodChecker.is_override?('MethodChecker', 'to_s').should == true
+  end
+
+  it 'should be false for non-existent class' do
+    MethodChecker.is_override?('Flibble', 'to_s').should == false
+  end
+
+  it 'should be true for smells' do
+    MethodChecker.is_override?('UtilityFunction', 'recognise?').should == true
+  end
+end

data/spec/reek/nested_iterators_spec.rb

@@ -21,8 +21,8 @@ describe MethodChecker, " nested iterators" do
     source =<<EOS
 def bad(fred)
   @fred.each {|item| item.each }
-  @jim.each {|item| item.each }
-end    
+  @jim.each {|ting| ting.each }
+end
 EOS
     @chk.check_source(source)
     @rpt.should be_empty
@@ -31,8 +31,8 @@ EOS
   it "should report nested iterators only once per method" do
     source =<<EOS
 def bad(fred)
-  @fred.each {|item| item.each {|part| @jim.send} }
-  @jim.each {|item| item.each {|piece| @fred.send} }
+  @fred.each {|item| item.each {|part| @joe.send} }
+  @jim.each {|ting| ting.each {|piece| @hal.send} }
 end    
 EOS
     @chk.check_source(source)

data/spec/reek/object_refs_spec.rb

@@ -0,0 +1,129 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/object_refs'
+
+include Reek
+
+describe ObjectRefs, 'when empty' do
+  before(:each) do
+    @refs = ObjectRefs.new
+  end
+
+  it 'should report one ref to self' do
+    @refs.refs_to_self.should == 1
+  end
+end
+
+describe ObjectRefs, 'with no refs to self' do
+  before(:each) do
+    @refs = ObjectRefs.new
+    @refs.record_ref('a')
+    @refs.record_ref('b')
+    @refs.record_ref('a')
+  end
+
+  it 'should report no refs to self' do
+    @refs.refs_to_self.should == 1
+  end
+
+  it 'should report :a as the max' do
+    @refs.max_keys.should == ['a']
+  end
+
+  it 'should not report self as the max' do
+    @refs.self_is_max?.should == false
+  end
+end
+
+describe ObjectRefs, 'with one ref to self' do
+  before(:each) do
+    @refs = ObjectRefs.new
+    @refs.record_ref('a')
+    @refs.record_ref('b')
+    @refs.record_ref('a')
+    @refs.record_reference_to_self
+  end
+
+  it 'should report 1 ref to self' do
+    @refs.refs_to_self.should == 2
+  end
+
+  it 'should report self among the max' do
+    @refs.max_keys.should be_include('a')
+    @refs.max_keys.should be_include(Sexp.from_array([:lit, :self]))
+  end
+
+  it 'should report self as the max' do
+    @refs.self_is_max?.should == true
+  end
+end
+
+describe ObjectRefs, 'with many refs to self' do
+  before(:each) do
+    @refs = ObjectRefs.new
+    @refs.record_reference_to_self
+    @refs.record_ref('a')
+    @refs.record_reference_to_self
+    @refs.record_ref('b')
+    @refs.record_ref('a')
+    @refs.record_reference_to_self
+  end
+
+  it 'should report all refs to self' do
+    @refs.refs_to_self.should == 4
+  end
+
+  it 'should report self among the max' do
+    @refs.max_keys.should == [Sexp.from_array([:lit, :self])]
+  end
+
+  it 'should report self as the max' do
+    @refs.self_is_max?.should == true
+  end
+end
+
+describe ObjectRefs, 'when self is not the only max' do
+  before(:each) do
+    @refs = ObjectRefs.new
+    @refs.record_ref('a')
+    @refs.record_reference_to_self
+    @refs.record_ref('b')
+    @refs.record_ref('a')
+  end
+
+  it 'should report all refs to self' do
+    @refs.refs_to_self.should == 2
+  end
+
+  it 'should report self among the max' do
+    @refs.max_keys.should be_include('a')
+    @refs.max_keys.should be_include(Sexp.from_array([:lit, :self]))
+  end
+
+  it 'should report self as the max' do
+    @refs.self_is_max?.should == true
+  end
+end
+
+describe ObjectRefs, 'when self is not among the max' do
+  before(:each) do
+    @refs = ObjectRefs.new
+    @refs.record_ref('a')
+    @refs.record_ref('b')
+    @refs.record_ref('a')
+    @refs.record_ref('b')
+  end
+
+  it 'should report all refs to self' do
+    @refs.refs_to_self.should == 1
+  end
+
+  it 'should not report self among the max' do
+    @refs.max_keys.should be_include('a')
+    @refs.max_keys.should be_include('b')
+  end
+
+  it 'should not report self as the max' do
+    @refs.self_is_max?.should == false
+  end
+end