kevinrutherford-reek 0.3.1.4

data/spec/reek/sexp_formatter_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/code_parser'
+require 'reek/sexp_formatter'
+
+include Reek
+
+def should_print(example)
+  it "should format #{example} correctly" do
+    sexp = CodeParser.parse_tree_for(example)[0]
+    SexpFormatter.format(sexp).should == example
+  end
+end
+
+describe SexpFormatter do
+  should_print 'self'
+  should_print 'Alpha'
+  should_print 'Alpha::Beta'
+  should_print '@@fred'
+  should_print '`ls`'
+  should_print 'array[0]'
+  should_print 'array[0, 1, 2]'
+  should_print 'obj.method(arg1, arg2)'
+  should_print 'obj.method'
+  should_print '$1'
+  should_print 'o=q.downcase'
+  should_print 'true'
+  should_print '"-#{q}xxx#{z.size}"'
+  should_print '0..5'
+  should_print '0..temp'
+end

data/spec/reek/singleton_method_context_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/module_context'
+require 'reek/singleton_method_context'
+require 'reek/stop_context'
+
+include Reek
+
+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.outer_name.should match(/mod::a\.b/)
+  end
+end

data/spec/reek/smells/control_couple_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/smells/control_couple'
+
+include Reek::Smells
+
+describe ControlCouple do
+  it 'should report a ternary check on a parameter' do
+    'def simple(arga) arga ? @ivar : 3 end'.should reek_of(:ControlCouple, /arga/)
+  end
+
+  it 'should not report a ternary check on an ivar' do
+    'def simple(arga) @ivar ? arga : 3 end'.should_not reek
+  end
+
+  it 'should not report a ternary check on a lvar' do
+    'def simple(arga) lvar = 27; lvar ? arga : @ivar end'.should_not reek
+  end
+
+  it 'should spot a couple inside a block' do
+    'def blocks(arg) @text.map { |blk| arg ? blk : "#{blk}" } end'.should reek_of(:ControlCouple, /arg/)
+  end
+end

data/spec/reek/smells/duplication_spec.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+require 'reek/report'
+require 'reek/method_context'
+require 'reek/stop_context'
+require 'reek/smells/duplication'
+
+include Reek
+include Reek::Smells
+
+describe Duplication, "repeated method calls" do
+  it 'should report 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
+    'def double_thing() other[@thing] + other[@thing] end'.should reek_only_of(:Duplication, /other\[@thing\]/)
+  end
+
+  it 'should report 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'.to_source
+    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
+
+describe Duplication, "non-repeated method calls" do
+  it 'should not report similar calls' do
+    'def equals(other) other.thing == self.thing end'.should_not reek
+  end
+
+  it 'should respect call parameters' do
+    'def double_thing() @other.thing(3) + @other.thing(2) end'.should_not reek
+  end
+end
+
+require 'ostruct'
+
+describe Duplication, '#examine' do
+  before :each do
+    @mc = OpenStruct.new
+    @dup = Duplication.new
+  end
+
+  it 'should return true when reporting a smell' do
+    @mc.calls = {'x' => 47}
+    @dup.examine(@mc, []).should == true
+  end
+  
+  it 'should return false when not reporting a smell' do
+    @mc.calls = []
+    @dup.examine(@mc, []).should == false
+  end
+  
+  it 'should return false when not reporting calls to new' do
+    @mc.calls = {[:call, :Set, :new] => 4}
+    @dup.examine(@mc, []).should == false
+  end
+end
+
+describe Duplication, 'when disabled' do
+  before :each do
+    @ctx = MethodContext.new(StopContext.new, [0, :double_thing])
+    @dup = Duplication.new({SmellDetector::ENABLED_KEY => false})
+    @rpt = Report.new
+  end
+
+  it 'should not report repeated call' do
+    @ctx.record_call_to([:fred])
+    @ctx.record_call_to([:fred])
+    @dup.examine(@ctx, @rpt).should == false
+    @rpt.length.should == 0
+  end
+end

data/spec/reek/smells/feature_envy_spec.rb

@@ -0,0 +1,129 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+require 'reek/smells/feature_envy'
+require 'reek/method_context'
+require 'reek/stop_context'
+
+include Reek
+include Reek::Smells
+
+describe FeatureEnvy, 'with only messages to self' 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
+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
+  end
+
+  it 'should not report return value' 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/)
+  end
+end
+
+describe FeatureEnvy, 'when there are many possible receivers' do
+  it 'should report highest affinity' do
+    ruby = 'def total_envy
+      fred = @item
+      total = 0
+      total += fred.price
+      total += fred.tax
+      total *= 1.15
+    end'
+    ruby.should reek_only_of(:FeatureEnvy, /total/)
+  end
+
+  it 'should report multiple affinities' do
+    ruby = 'def total_envy
+      fred = @item
+      total = 0
+      total += fred.price
+      total += fred.tax
+    end'
+    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
+
+  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
+
+  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
+    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/)
+  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/)
+  end
+end
+
+describe FeatureEnvy, '#examine' do
+
+  before :each do
+    @context = MethodContext.new(StopContext.new, [:defn, :cool])
+    @fe = FeatureEnvy.new
+  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 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

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+require 'reek/code_parser'
+require 'reek/report'
+require 'reek/smells/large_class'
+
+include Reek
+include Reek::Smells
+
+describe LargeClass do
+
+  class BigOne
+    26.times do |i|
+      define_method "method#{i}".to_sym do
+        @melting
+      end
+    end
+  end
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = CodeParser.new(@rpt, SmellConfig.new.smell_listeners)
+  end
+
+  it 'should not report short class' do
+    class ShortClass
+      def method1() @var1; end
+      def method2() @var2; end
+      def method3() @var3; end
+      def method4() @var4; end
+      def method5() @var5; end
+      def method6() @var6; end
+    end
+    @cchk.check_object(ShortClass)
+    @rpt.should be_empty
+  end
+
+  it 'should report large class' do
+    @cchk.check_object(BigOne)
+    @rpt.length.should == 1
+  end
+
+  it 'should report class name' do
+    @cchk.check_object(BigOne)
+    @rpt[0].report.should match(/BigOne/)
+  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 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
+end
+
+describe LargeClass do
+  it 'should not report empty class in another module' do
+    'class Treetop::Runtime::SyntaxNode; end'.should_not reek
+  end
+
+  it 'should deal with :: scoped names' do
+    element = ClassContext.create(StopContext.new, [:colon2, [:colon2, [:const, :Treetop], :Runtime], :SyntaxNode])
+    element.num_methods.should == 0
+  end
+end

data/spec/reek/smells/long_method_spec.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/code_parser'
+require 'reek/report'
+
+include Reek
+
+describe CodeParser, "(Long Method)" 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
+
+  it 'should report long methods' do
+    'def long(arga) alf = f(1);@bet = 2;@cut = 3;@dit = 4; @emp = 5;@fry = 6;end'.should reek_only_of(:LongMethod, /6 statements/)
+  end
+
+  it 'should not report initialize' do
+    'def initialize(arga) alf = f(1);@bet = 2;@cut = 3;@dit = 4; @emp = 5;@fry = 6;end'.should_not reek
+  end
+
+  it 'should only report a long method once' do
+    source =<<EOS
+def standard_entries(rbconfig)
+  @abc = rbconfig
+  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']}"
+  end
+end
+EOS
+    source.should reek_only_of(:LongMethod)
+  end
+
+  it 'should report long inner block' do
+    src = <<EOS
+def long(arga)
+  f(3)
+  self.each do |xyzero|
+    xyzero = 1
+    xyzero = 2
+    xyzero = 3
+    xyzero = 4
+    xyzero = 5
+    xyzero = 6
+  end
+end
+EOS
+    src.should reek_only_of(:LongMethod)
+  end
+end

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/code_parser'
+require 'reek/smells/long_parameter_list'
+require 'reek/report'
+
+include Reek
+include Reek::Smells
+
+describe CodeParser, "(Long Parameter List)" do
+  
+  describe 'for methods with few parameters' do
+    it 'should report nothing for no parameters' do
+      'def simple; f(3);true; end'.should_not reek
+    end
+    it 'should report nothing for 1 parameter' do
+      'def simple(yep) f(3);true end'.should_not reek
+    end
+    it 'should report nothing for 2 parameters' do
+      'def simple(yep,zero) f(3);true end'.should_not reek
+    end
+    it 'should not count an optional block' do
+      'def simple(alpha, yep, zero, &opt) f(3);true end'.should_not reek
+    end
+    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
+      end
+      it 'should report nothing for 2 parameters with 1 default' do
+        'def simple(yep, zero=nil) f(3);false end'.should_not reek
+      end
+      it 'should report nothing for 2 defaulted parameters' do
+        'def simple(yep=4, zero=nil) f(3);false end'.should_not reek
+      end
+    end
+  end
+
+  describe 'for methods with too many parameters' do
+    it 'should report 4 parameters' do
+      'def simple(arga, argb, argc, argd) f(3);true end'.should reek_only_of(:LongParameterList, /4 parameters/)
+    end
+    it 'should report 8 parameters' do
+      'def simple(arga, argb, argc, argd,arge, argf, argg, argh) f(3);true end'.should reek_only_of(:LongParameterList, /8 parameters/)
+    end
+
+    describe 'and default values' do
+      it 'should report 3 with 1 defaulted' do
+        'def simple(polly, queue, yep, zero=nil) f(3);false end'.should reek_only_of(:LongParameterList, /4 parameters/)
+      end
+      it 'should report with 3 defaulted' do
+        'def simple(aarg, polly=2, yep=true, zero=nil) f(3);false end'.should reek_only_of(:LongParameterList, /4 parameters/)
+      end
+    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/)
+      end
+    end
+  end
+  
+  describe 'yield' do
+    it 'should not report yield with no parameters' do
+      'def simple(arga, argb, &blk) f(3);yield; end'.should_not reek
+    end
+    it 'should not report yield with few parameters' 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/)
+    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
+    end
+  end
+end

data/spec/reek/smells/nested_iterators_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/smells/nested_iterators'
+
+include Reek::Smells
+
+describe NestedIterators do
+
+  it 'should report nested iterators in a method' do
+    'def bad(fred) @fred.each {|item| item.each {|ting| ting.ting} } end'.should reek_only_of(:NestedIterators)
+  end
+
+  it 'should not report method with successive iterators' do
+    'def bad(fred)
+      @fred.each {|item| item.each }
+      @jim.each {|ting| ting.each }
+    end'.should_not reek
+  end
+
+  it 'should not report method with chained iterators' do
+    'def chained
+      @sig.keys.sort_by { |xray| xray.to_s }.each { |min| md5 << min.to_s }
+    end'.should_not reek
+  end
+
+  it 'should report nested iterators only once per method' do
+    'def bad(fred)
+      @fred.each {|item| item.each {|part| @joe.send} }
+      @jim.each {|ting| ting.each {|piece| @hal.send} }
+    end'.should reek_only_of(:NestedIterators)
+  end
+end
+

data/spec/reek/smells/smell_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/smells/smells'
+
+include Reek
+
+describe SmellWarning, ' in comparisons' do
+  before :each do
+    @first = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self")
+    @second = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self")
+  end
+
+  it 'should hash equal when the smell is the same' do
+    @first.hash.should == @second.hash
+  end
+
+  it 'should compare equal when the smell is the same' do
+    @first.should == @second
+  end
+
+  it 'should compare equal when using <=>' do
+    (@first <=> @second).should == 0
+  end
+end