reek 1.1.3 → 1.2.0

data/spec/reek/smells/data_clump_spec.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/smells/data_clump'
+
+include Reek::Smells
+
+describe DataClump do
+  it 'should not report small parameter sets' do
+    src = <<EOS
+class Scrunch
+  def first(pa) @field == :sym ? 0 : 3; end
+  def second(pa) @field == :sym; end
+  def third(pa) pa - pb + @fred; end
+end
+EOS
+
+    src.should_not reek
+  end
+
+  it 'should report 3 identical pairs in a class' do
+    src = <<EOS
+class Scrunch
+  def first(pa, pb) @field == :sym ? 0 : 3; end
+  def second(pa, pb) @field == :sym; end
+  def third(pa, pb) pa - pb + @fred; end
+end
+EOS
+
+    src.should reek_of(:DataClump, /\[pa, pb\]/, /3 methods/)
+  end
+
+  it 'should report 3 swapped pairs in a class' do
+    src = <<EOS
+class Scrunch
+  def one(pa, pb) @field == :sym ? 0 : 3; end
+  def two(pb, pa) @field == :sym; end
+  def tri(pa, pb) pa - pb + @fred; end
+end
+EOS
+
+    src.should reek_of(:DataClump, /\[pa, pb\]/, /3 methods/)
+  end
+
+  it 'should report 3 identical parameter sets in a class' do
+    src = <<EOS
+class Scrunch
+  def first(pa, pb, pc) @field == :sym ? 0 : 3; end
+  def second(pa, pb, pc) @field == :sym; end
+  def third(pa, pb, pc) pa - pb + @fred; end
+end
+EOS
+
+    src.should reek_of(:DataClump, /\[pa, pb, pc\]/, /3 methods/)
+    src.should_not reek_of(:DataClump, /\[pa, pb\]/, /3 methods/)
+    src.should_not reek_of(:DataClump, /\[pa, pc\]/, /3 methods/)
+    src.should_not reek_of(:DataClump, /\[pb, pc\]/, /3 methods/)
+  end
+
+  it 'should recognise re-ordered identical parameter sets' do
+    src = <<EOS
+class Scrunch
+  def first(pb, pa, pc) @field == :sym ? 0 : 3; end
+  def second(pc, pb, pa) @field == :sym; end
+  def third(pa, pb, pc) pa - pb + @fred; end
+end
+EOS
+
+    src.should reek_of(:DataClump, /\[pa, pb, pc\]/, /3 methods/)
+    src.should_not reek_of(:DataClump, /\[pa, pb\]/, /3 methods/)
+    src.should_not reek_of(:DataClump, /\[pa, pc\]/, /3 methods/)
+    src.should_not reek_of(:DataClump, /\[pb, pc\]/, /3 methods/)
+  end
+
+  it 'should count only identical parameter sets' do
+    src = <<EOS
+class RedCloth
+  def fa(p1, p2, p3, conten) end
+  def fb(p1, p2, p3, conten) end
+  def fc(name, windowW, windowH) end
+end
+EOS
+
+    src.should_not reek_of(:DataClump)
+  end
+
+  # TODO: include singleton methods in the calcs
+end

data/spec/reek/smells/duplication_spec.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + '/../../spec_helper.rb'
-require 'reek/report'
+
+require 'reek/configuration'
 require 'reek/method_context'
 require 'reek/stop_context'
 require 'reek/smells/duplication'
@@ -21,7 +22,7 @@ describe Duplication, "repeated method calls" do
   end
 
   it 'should report nested calls' do
-    ruby = 'def double_thing() @other.thing.foo + @other.thing.foo end'.to_source
+    ruby = 'def double_thing() @other.thing.foo + @other.thing.foo end'.sniff
     ruby.should reek_of(:Duplication, /@other.thing[^\.]/)
     ruby.should reek_of(:Duplication, /@other.thing.foo/)
   end
@@ -41,41 +42,36 @@ describe Duplication, "non-repeated method calls" do
   end
 end
 
-require 'ostruct'
-
 describe Duplication, '#examine' do
   before :each do
-    @mc = OpenStruct.new
+    @mc = MethodContext.new(StopContext.new, s(:defn, :fred))
     @dup = Duplication.new
   end
 
   it 'should return true when reporting a smell' do
-    @mc.calls = {s(:call, nil, :other, s(:arglist)) => 47}
-    @dup.examine(@mc, []).should == true
+    3.times { @mc.record_call_to(s(:call, nil, :other, s(:arglist)))}
+    @dup.examine(@mc).should == true
   end
-  
+
   it 'should return false when not reporting a smell' do
-    @mc.calls = []
-    @dup.examine(@mc, []).should == false
+    @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
+    4.times { @mc.record_call_to(s(:call, s(:Set), :new, s(:arglist)))}
+    @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
+    @dup = Duplication.new({SmellConfiguration::ENABLED_KEY => false})
   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
+    @dup.examine(@ctx).should == false
   end
 end

data/spec/reek/smells/feature_envy_spec.rb

@@ -27,9 +27,9 @@ describe FeatureEnvy do
 
   it 'should not report return value' do
     'def no_envy(arga)
-        arga.barg(@item)
-        arga
-      end'.should_not reek
+       arga.barg(@item)
+       arga
+     end'.should_not reek
   end
 
   it 'should report many calls to parameter' do
@@ -133,22 +133,6 @@ describe FeatureEnvy do
      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
@@ -177,12 +161,8 @@ describe FeatureEnvy do
   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
+        self[key] += 3
+        self[key] = o4
       end
       self
     end'.should_not reek
@@ -202,7 +182,22 @@ def report
   @report
 end
 EOS
-    ruby.should reek_only_of(:LongMethod)
+
+    ruby.should_not reek
+  end
+
+  it 'interprets << correctly' do
+    ruby = <<EOS
+def report_on(report)
+  if @is_masked
+    report.record_masked_smell(self)
+  else
+    report << self
+  end
+end
+EOS
+
+    ruby.should_not reek
   end
 end
 
@@ -216,10 +211,10 @@ describe FeatureEnvy, '#examine' do
   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
+    @fe.examine(@context).should == true
   end
 
   it 'should return false when not reporting a smell' do
-    @fe.examine(@context, []).should == false
+    @fe.examine(@context).should == false
   end
 end

data/spec/reek/smells/large_class_spec.rb

@@ -1,44 +1,67 @@
 require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/class_context'
+require 'reek/stop_context'
 require 'reek/code_parser'
-require 'reek/report'
 require 'reek/smells/large_class'
 
 include Reek
 include Reek::Smells
 
-describe LargeClass do
+describe LargeClass, 'checking Class objects' do
 
-  it 'should report large class' do
+  it 'should not report class with 26 methods' do
+    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
     class BigOne
       26.times do |i|
-        define_method "method#{i}".to_sym do
+        define_method "method#{i}x".to_sym do
           @melting
         end
       end
     end
-    BigOne.should reek_only_of(:LargeClass, /BigOne/)
+    BigOne.should_not reek
   end
-end
-
-describe LargeClass do
 
   it 'should not report short class' do
+    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
     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
+      def method_a() @var_a; end
+      def method_b() @var_b; end
+      def method_c() @var_c; end
+      def method_d() @var_d; end
+      def method_e() @var_e; end
+      def method_f() @var_f; end
     end
     ShortClass.should_not reek
   end
+
+  describe LargeClass, 'counting instance variables' do
+    it 'should not report class with 10 ivars' do
+      pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
+      class ManyIvars
+        def meth
+          @vara = @varb = @varc = @vard = @vare
+          @varf = @varg = @varh = @vari = @varj
+        end
+      end
+      ManyIvars.should_not reek
+    end
+
+    it 'ignores class with only a couple of ivars' do
+      pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
+      LargeClass.should_not reek_of(:LargeClass)
+    end
+
+    it 'ignores fq class with only a couple of ivars' do
+    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
+      Reek::Smells::LargeClass.should_not reek_of(:LargeClass)
+    end
+  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
@@ -47,41 +70,93 @@ describe LargeClass, 'when exceptions are listed' do
   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
+    lc.examine(@ctx).should == false
   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
+    lc.examine(@ctx).should == false
   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
+    lc.examine(@ctx).should == true
   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
+describe LargeClass, 'checking source code' do
+
+  describe 'counting instance variables' do
+    it 'should not report empty class' do
+      ClassContext.from_s('class Empty;end').should have(0).variable_names
+    end
+
+    it 'should count ivars in one method' do
+      ClassContext.from_s('class Empty;def ivars() @aa=@ab=@ac=@ad; end;end').should have(4).variable_names
+    end
+
+    it 'should count ivars in 2 methods' do
+      ClassContext.from_s('class Empty;def iv1() @aa=@ab; end;def iv2() @aa=@ac; end;end').should have(3).variable_names
+    end
+
+    it 'should not report 9 ivars' do
+      'class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai; end;end'.should_not reek
+    end
+
+    it 'should report 10 ivars' do
+      'class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=@aj; end;end'.should reek_of(:LargeClass)
     end
-    ManyIvars.should reek_of(:LargeClass, /10/)
-  end
 
-  it 'ignores class with only a couple of ivars' do
-    LargeClass.should_not reek_of(:LargeClass)
+    it 'should not report 10 ivars in 2 extensions' do
+      src = <<EOS
+class Full;def ivars_a() @aa=@ab=@ac=@ad=@ae; end;end
+class Full;def ivars_b() @af=@ag=@ah=@ai=@aj; end;end
+EOS
+
+      src.should_not reek
+    end
   end
 
-  it 'ignores fq class with only a couple of ivars' do
-    Reek::Smells::LargeClass.should_not reek_of(:LargeClass)
+  describe 'counting methods' do
+    it 'should not report empty class' do
+      ClassContext.from_s('class Empty;end').num_methods.should == 0
+    end
+
+    it 'should count 1 method' do
+      ClassContext.from_s('class Empty;def ivars() @aa=@ab; end;end').num_methods.should == 1
+    end
+
+    it 'should count 2 methods' do
+      ClassContext.from_s('class Empty;def meth1() @aa=@ab;end;def meth2() @aa=@ab;end;end').num_methods.should == 2
+    end
+
+    it 'should not report 25 methods' do
+      src = <<EOS
+class Full
+  def me01x()3 end;def me02x()3 end;def me03x()3 end;def me04x()3 end;def me05x()3 end
+  def me11x()3 end;def me12x()3 end;def me13x()3 end;def me14x()3 end;def me15x()3 end
+  def me21x()3 end;def me22x()3 end;def me23x()3 end;def me24x()3 end;def me25x()3 end
+  def me31x()3 end;def me32x()3 end;def me33x()3 end;def me34x()3 end;def me35x()3 end
+  def me41x()3 end;def me42x()3 end;def me43x()3 end;def me44x()3 end;def me45x()3 end
+end
+EOS
+      src.should_not reek
+    end
+
+    it 'should report 26 methods' do
+      src = <<EOS
+class Full
+  def me01x()3 end;def me02x()3 end;def me03x()3 end;def me04x()3 end;def me05x()3 end
+  def me11x()3 end;def me12x()3 end;def me13x()3 end;def me14x()3 end;def me15x()3 end
+  def me21x()3 end;def me22x()3 end;def me23x()3 end;def me24x()3 end;def me25x()3 end
+  def me31x()3 end;def me32x()3 end;def me33x()3 end;def me34x()3 end;def me35x()3 end
+  def me41x()3 end;def me42x()3 end;def me43x()3 end;def me44x()3 end;def me45x()3 end
+  def me51x()3 end
+end
+EOS
+      src.should reek_of(:LargeClass)
+    end
   end
 end

data/spec/reek/smells/long_method_spec.rb

@@ -1,9 +1,17 @@
 require File.dirname(__FILE__) + '/../../spec_helper.rb'
 
 require 'reek/code_parser'
-require 'reek/report'
+require 'reek/sniffer'
+require 'reek/smells/long_method'
 
 include Reek
+include Reek::Smells
+
+def process_method(src)
+  source = src.to_reek_source
+  sniffer = Sniffer.new(source)
+  CodeParser.new(sniffer).process_defn(source.syntax_tree)
+end
 
 describe LongMethod do
   it 'should not report short methods' do
@@ -19,7 +27,7 @@ describe LongMethod do
   end
 
   it 'should only report a long method once' do
-    source =<<EOS
+    src = <<EOS
 def standard_entries(rbconfig)
   @abc = rbconfig
   rubypath = File.join(@abc['bindir'], @abcf['ruby_install_name'] + cff['EXEEXT'])
@@ -37,7 +45,7 @@ def standard_entries(rbconfig)
   end
 end
 EOS
-    source.should reek_only_of(:LongMethod)
+    src.should reek_only_of(:LongMethod)
   end
 
   it 'should report long inner block' do
@@ -57,3 +65,132 @@ 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