teksymmetry-reek 1.1.3.1

data/spec/reek/smells/feature_envy_spec.rb

@@ -0,0 +1,221 @@
+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 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 report many calls to parameter' do
+    'def envy(arga)
+      arga.b(arga) + arga.c(@fred)
+    end'.should reek_only_of(:FeatureEnvy, /arga/)
+  end
+
+  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
+
+  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
+
+  it 'should count local calls' do
+    '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|
+        self[key] += 3
+        self[key] = o4
+      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_not reek
+  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

data/spec/reek/smells/large_class_spec.rb

@@ -0,0 +1,87 @@
+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
+
+  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
+
+describe LargeClass do
+
+  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
+    ShortClass.should_not reek
+  end
+end
+
+describe LargeClass, 'when exceptions are listed' do
+
+  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
+
+  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
+
+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
+
+  it 'ignores class with only a couple of ivars' do
+    LargeClass.should_not reek_of(:LargeClass)
+  end
+
+  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

@@ -0,0 +1,195 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/code_parser'
+require 'reek/report'
+require 'reek/smells/long_method'
+
+include Reek
+include Reek::Smells
+
+def process_method(src)
+  source = Source.from_s(src)
+  CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+end
+
+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
+
+  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
+
+describe LongMethod do
+  it 'counts 1 assignment' do
+    method = process_method('def one() val = 4; end')
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 assignments' do
+    method = process_method('def one() val = 4; val = 4; val = 4; end')
+    method.num_statements.should == 3
+  end
+
+  it 'counts 1 attr assignment' do
+    method = process_method('def one() val[0] = 4; end')
+    method.num_statements.should == 1
+  end
+
+  it 'counts 1 increment assignment' do
+    method = process_method('def one() val += 4; end')
+    method.num_statements.should == 1
+  end
+
+  it 'counts 1 increment attr assignment' do
+    method = process_method('def one() val[0] += 4; end')
+    method.num_statements.should == 1
+  end
+
+  it 'counts 1 nested assignment' do
+    method = process_method('def one() val = fred = 4; end')
+    method.num_statements.should == 1
+  end
+
+  it 'counts returns' do
+    method = process_method('def one() val = 4; true; end')
+    method.num_statements.should == 2
+  end
+end
+
+describe LongMethod, 'does not count control statements' do
+  it 'counts 1 statement in a conditional expression' do
+    method = process_method('def one() if val == 4; callee(); end; end')
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 statements in a conditional expression' do
+    method = process_method('def one() if val == 4; callee(); callee(); callee(); end; end')
+    method.num_statements.should == 3
+  end
+
+  it 'does not count empty conditional expression' do
+    method = process_method('def one() if val == 4; ; end; end')
+    method.num_statements.should == 0
+  end
+
+  it 'counts 1 statement in a while loop' do
+    method = process_method('def one() while val < 4; callee(); end; end')
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 statements in a while loop' do
+    method = process_method('def one() while val < 4; callee(); callee(); callee(); end; end')
+    method.num_statements.should == 3
+  end
+
+  it 'counts 1 statement in a until loop' do
+    method = process_method('def one() until val < 4; callee(); end; end')
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 statements in a until loop' do
+    method = process_method('def one() until val < 4; callee(); callee(); callee(); end; end')
+    method.num_statements.should == 3
+  end
+
+  it 'counts 1 statement in a for loop' do
+    method = process_method('def one() for i in 0..4; callee(); end; end')
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 statements in a for loop' do
+    method = process_method('def one() for i in 0..4; callee(); callee(); callee(); end; end')
+    method.num_statements.should == 3
+  end
+
+  it 'counts 1 statement in a rescue' do
+    method = process_method('def one() begin; callee(); rescue; callee(); end; end')
+    method.num_statements.should == 2
+  end
+
+  it 'counts 3 statements in a rescue' do
+    method = process_method('def one() begin; callee(); callee(); callee(); rescue; callee(); callee(); callee(); end; end')
+    method.num_statements.should == 6
+  end
+
+  it 'counts 1 statement in a when' do
+    method = process_method('def one() case fred; when "hi"; callee(); end; end')
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 statements in a when' do
+    method = process_method('def one() case fred; when "hi"; callee(); callee(); when "lo"; callee(); end; end')
+    method.num_statements.should == 3
+  end
+
+  it 'does not count empty case' do
+    method = process_method('def one() case fred; when "hi"; ; when "lo"; ; end; end')
+    method.num_statements.should == 0
+  end
+
+  it 'counts else statement' do
+    src = <<EOS
+def parse(arg, argv, &error)
+  if !(val = arg) and (argv.empty? or /\A-/ =~ (val = argv[0]))
+    return nil, block, nil
+  end
+  opt = (val = parse_arg(val, &error))[1]
+  val = conv_arg(*val)
+  if opt and !arg
+    argv.shift
+  else
+    val[0] = nil
+  end
+  val
+end
+EOS
+    method = process_method(src)
+    method.num_statements.should == 6
+  end
+end

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -0,0 +1,85 @@
+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 LongParameterList 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
+      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
+        InnerTest.should reek_only_of(:LongParameterList, /abc/)
+      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 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
+    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