reek 1.2.1 → 1.2.3

data/spec/reek/singleton_method_context_spec.rb

@@ -10,7 +10,7 @@ describe SingletonMethodContext, 'outer_name' do
 
   it "should report full context" do
     element = StopContext.new
-    element = ModuleContext.new(element, Name.new(:mod))
+    element = ModuleContext.new(element, Name.new(:mod), s(:module, :mod, nil))
     element = SingletonMethodContext.new(element, s(:defs, s(:call, nil, :a, s(:arglist)), :b, s(:args)))
     element.outer_name.should match(/mod::a\.b/)
   end

data/spec/reek/smells/attribute_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/smells/attribute'
+require 'reek/class_context'
+
+require 'spec/reek/smells/behaves_like_variable_detector'
+
+include Reek
+include Reek::Smells
+
+describe Attribute do
+  before :each do
+    @detector = Attribute.new
+    @record_variable = :record_attribute
+  end
+
+  [ClassContext, ModuleContext].each do |klass|
+    context "in a #{klass}" do
+      before :each do
+        @ctx = klass.create(StopContext.new, s(:null, :Fred))
+      end
+
+      it_should_behave_like 'a variable detector'
+    end
+  end
+end

data/spec/reek/smells/behaves_like_variable_detector.rb

@@ -0,0 +1,39 @@
+shared_examples_for 'a variable detector' do
+  context 'with no variables' do
+    it "doesn't record a smell" do
+      @detector.examine_context(@ctx)
+      @detector.num_smells.should == 0
+    end
+  end
+
+  context 'with one variable encountered twice' do
+    before :each do
+      @ctx.send(@record_variable, :something)
+      @ctx.send(@record_variable, :something)
+      @detector.examine_context(@ctx)
+    end
+
+    it 'records only one smell' do
+      @detector.num_smells.should == 1
+    end
+    it 'mentions the variable name in the report' do
+      @detector.should have_smell([/something/])
+    end
+  end
+
+  context 'with two variables' do
+    before :each do
+      @ctx.send(@record_variable, :something)
+      @ctx.send(@record_variable, :something_else)
+      @detector.examine_context(@ctx)
+    end
+
+    it 'records both smells' do
+      @detector.num_smells.should == 2
+    end
+    it 'mentions both variable names in the report' do
+      @detector.should have_smell([/something/])
+      @detector.should have_smell([/something_else/])
+    end
+  end
+end

data/spec/reek/smells/class_variable_spec.rb

@@ -7,75 +7,109 @@ include Reek
 include Reek::Smells
 
 describe ClassVariable do
-  shared_examples_for 'a class variable container' do
-    context 'no class variables' do
-      it "doesn't record a smell" do
-        @detector.examine_context(@ctx)
-        @detector.num_smells.should == 0
+  before :each do
+    @detector = ClassVariable.new
+  end
+
+  context 'with no class variables' do
+    it 'records nothing in the class' do
+      ctx = ClassContext.from_s('class Fred; end')
+      @detector.class_variables_in(ctx).should be_empty
+    end
+    it 'records nothing in the module' do
+      ctx = ModuleContext.from_s('module Fred; end')
+      @detector.class_variables_in(ctx).should be_empty
+    end
+  end
+
+  context 'with one class variable' do
+    shared_examples_for 'one variable found' do
+      it 'records the class variable' do
+        @detector.class_variables_in(@ctx).should include(:@@tools)
+      end
+      it 'records only that class variable' do
+        @detector.class_variables_in(@ctx).length.should == 1
       end
     end
 
-    context 'one class variable' do
+    context 'declared in a class' do
       before :each do
-        @ctx.record_class_variable(:@@cvar)
-        @detector.examine_context(@ctx)
+        @ctx = ClassContext.from_s('class Fred; @@tools = {}; end')
       end
 
-      it 'records a smell' do
-        @detector.num_smells.should == 1
-      end
-      it 'mentions the variable name in the report' do
-        @detector.should have_smell([/@@cvar/])
-      end
+      it_should_behave_like 'one variable found'
     end
 
-    context 'one class variable encountered twice' do
+    context 'used in a class' do
       before :each do
-        @ctx.record_class_variable(:@@cvar)
-        @ctx.record_class_variable(:@@cvar)
-        @detector.examine_context(@ctx)
+        @ctx = ClassContext.from_s('class Fred; def jim() @@tools = {}; end; end')
       end
 
-      it 'records only one smell' do
-        @detector.num_smells.should == 1
+      it_should_behave_like 'one variable found'
+    end
+
+    context 'indexed in a class' do
+      before :each do
+        @ctx = ClassContext.from_s('class Fred; def jim() @@tools[mash] = {}; end; end')
       end
-      it 'mentions the variable name in the report' do
-        @detector.should have_smell([/@@cvar/])
+
+      it_should_behave_like 'one variable found'
+    end
+
+    context 'declared and used in a class' do
+      before :each do
+        @ctx = ClassContext.from_s('class Fred; @@tools = {}; def jim() @@tools = {}; end; end')
       end
+
+      it_should_behave_like 'one variable found'
     end
 
-    context 'two class variables' do
+    context 'used twice in a class' do
       before :each do
-        @ctx.record_class_variable(:@@cvar)
-        @ctx.record_class_variable(:@@another)
-        @detector.examine_context(@ctx)
+        @ctx = ClassContext.from_s('class Fred; def jeff() @@tools = {}; end; def jim() @@tools = {}; end; end')
       end
 
-      it 'records a smell' do
-        @detector.num_smells.should == 2
+      it_should_behave_like 'one variable found'
+    end
+
+    context 'declared in a module' do
+      before :each do
+        @ctx = ClassContext.from_s('module Fred; @@tools = {}; end')
       end
-      it 'mentions both variable names in the report' do
-        @detector.should have_smell([/@@cvar/])
-        @detector.should have_smell([/@@another/])
+
+      it_should_behave_like 'one variable found'
+    end
+
+    context 'used in a module' do
+      before :each do
+        @ctx = ClassContext.from_s('module Fred; def jim() @@tools = {}; end; end')
       end
+
+      it_should_behave_like 'one variable found'
     end
-  end
 
-  context 'in a class' do
-    before :each do
-      @ctx = ClassContext.create(StopContext.new, "Fred")
-      @detector = ClassVariable.new
+    context 'indexed in a module' do
+      before :each do
+        @ctx = ClassContext.from_s('module Fred; def jim() @@tools[mash] = {}; end; end')
+      end
+
+      it_should_behave_like 'one variable found'
     end
 
-    it_should_behave_like 'a class variable container'
-  end
+    context 'declared and used in a module' do
+      before :each do
+        @ctx = ClassContext.from_s('module Fred; @@tools = {}; def jim() @@tools = {}; end; end')
+      end
 
-  context 'in a module' do
-    before :each do
-      @ctx = ModuleContext.create(StopContext.new, "Fred")
-      @detector = ClassVariable.new
+      it_should_behave_like 'one variable found'
     end
 
-    it_should_behave_like 'a class variable container'
+    context 'used twice in a module' do
+      before :each do
+        @ctx = ClassContext.from_s('module Fred; def jeff() @@tools = {}; end; def jim() @@tools = {}; end; end')
+      end
+
+      it_should_behave_like 'one variable found'
+    end
   end
 end

data/spec/reek/smells/control_couple_spec.rb

@@ -6,7 +6,7 @@ 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/)
+    'def simple(arga) arga ? @ivar : 3 end'.should reek_only_of(:ControlCouple, /arga/)
   end
 
   it 'should not report a ternary check on an ivar' do

data/spec/reek/smells/data_clump_spec.rb

@@ -4,10 +4,10 @@ require 'reek/smells/data_clump'
 
 include Reek::Smells
 
-describe DataClump do
-  it 'should not report small parameter sets' do
+shared_examples_for 'a data clump detector' do
+  it 'does not report small parameter sets' do
     src = <<EOS
-class Scrunch
+#{@context} Scrunch
   def first(pa) @field == :sym ? 0 : 3; end
   def second(pa) @field == :sym; end
   def third(pa) pa - pb + @fred; end
@@ -17,9 +17,9 @@ EOS
     src.should_not reek
   end
 
-  it 'should report 3 identical pairs in a class' do
+  it 'reports 3 identical pairs in a class' do
     src = <<EOS
-class Scrunch
+#{@context} 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
@@ -29,9 +29,9 @@ EOS
     src.should reek_of(:DataClump, /\[pa, pb\]/, /3 methods/)
   end
 
-  it 'should report 3 swapped pairs in a class' do
+  it 'reports 3 swapped pairs in a class' do
     src = <<EOS
-class Scrunch
+#{@context} 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
@@ -41,9 +41,9 @@ EOS
     src.should reek_of(:DataClump, /\[pa, pb\]/, /3 methods/)
   end
 
-  it 'should report 3 identical parameter sets in a class' do
+  it 'reports 3 identical parameter sets in a class' do
     src = <<EOS
-class Scrunch
+#{@context} 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
@@ -56,9 +56,9 @@ EOS
     src.should_not reek_of(:DataClump, /\[pb, pc\]/, /3 methods/)
   end
 
-  it 'should recognise re-ordered identical parameter sets' do
+  it 'recognises re-ordered identical parameter sets' do
     src = <<EOS
-class Scrunch
+#{@context} 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
@@ -71,9 +71,9 @@ EOS
     src.should_not reek_of(:DataClump, /\[pb, pc\]/, /3 methods/)
   end
 
-  it 'should count only identical parameter sets' do
+  it 'counts only identical parameter sets' do
     src = <<EOS
-class RedCloth
+#{@context} RedCloth
   def fa(p1, p2, p3, conten) end
   def fb(p1, p2, p3, conten) end
   def fc(name, windowW, windowH) end
@@ -82,6 +82,24 @@ EOS
 
     src.should_not reek_of(:DataClump)
   end
+end
+
+describe DataClump do
+  context 'in a class' do
+    before :each do
+      @context = 'class'
+    end
+
+    it_should_behave_like 'a data clump detector'
+  end
+
+  context 'in a module' do
+    before :each do
+      @context = 'module'
+    end
+
+    it_should_behave_like 'a data clump detector'
+  end
 
   # TODO: include singleton methods in the calcs
 end

data/spec/reek/smells/feature_envy_spec.rb

@@ -204,7 +204,7 @@ end
 describe FeatureEnvy, '#examine' do
 
   before :each do
-    @context = MethodContext.new(StopContext.new, [:defn, :cool])
+    @context = MethodContext.new(StopContext.new, s(:defn, :cool))
     @fe = FeatureEnvy.new
   end
 

data/spec/reek/smells/large_class_spec.rb

@@ -8,73 +8,31 @@ require 'reek/smells/large_class'
 include Reek
 include Reek::Smells
 
-describe LargeClass, 'checking Class objects' 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}x".to_sym do
-          @melting
-        end
-      end
-    end
-    BigOne.should_not reek
-  end
-
-  it 'should not report short class' do
-    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-    class ShortClass
-      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
-    @ctx = ClassContext.create(StopContext.new, [0, :Humungous])
-    30.times { |num| @ctx.record_method("method#{num}") }
+    @class_name = 'Humungous'
+    src = <<EOS
+class #{@class_name}
+  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
+    @ctx = ClassContext.from_s(src)
     @config = LargeClass.default_config
   end
 
   it 'should ignore first excepted name' do
-    @config[LargeClass::EXCLUDE_KEY] = ['Humungous']
+    @config[LargeClass::EXCLUDE_KEY] = [@class_name]
     lc = LargeClass.new(@config)
     lc.examine(@ctx).should == false
   end
 
   it 'should ignore second excepted name' do
-    @config[LargeClass::EXCLUDE_KEY] = ['Oversized', 'Humungous']
+    @config[LargeClass::EXCLUDE_KEY] = ['Oversized', @class_name]
     lc = LargeClass.new(@config)
     lc.examine(@ctx).should == false
   end
@@ -88,7 +46,7 @@ end
 
 describe LargeClass, 'checking source code' do
 
-  describe 'counting instance variables' do
+  context 'counting instance variables' do
     it 'should not report empty class' do
       ClassContext.from_s('class Empty;end').should have(0).variable_names
     end
@@ -119,18 +77,7 @@ EOS
     end
   end
 
-  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
+  context 'counting methods' do
 
     it 'should not report 25 methods' do
       src = <<EOS
@@ -159,4 +106,20 @@ EOS
       src.should reek_of(:LargeClass)
     end
   end
+
+  context 'with a nested module' do
+    it 'stops at a nested module' 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
+  module Hidden; def me41x()3 end;def me42x()3 end;def me43x()3 end;def me44x()3 end;def me45x()3 end; end
+  def me51x()3 end
+end
+EOS
+      src.should_not reek_of(:LargeClass)
+    end
+  end
 end

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -53,18 +53,6 @@ describe LongParameterList 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
-        pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-        InnerTest.should reek_only_of(:LongParameterList, /abc/)
-      end
-    end
   end
   
   describe 'yield' do

data/spec/reek/smells/simulated_polymorphism_spec.rb

@@ -1,49 +1,97 @@
 require File.dirname(__FILE__) + '/../../spec_helper.rb'
 
 require 'reek/smells/simulated_polymorphism'
+require 'reek/code_context'
 
+include Reek
 include Reek::Smells
 
 describe SimulatedPolymorphism do
-  it 'should report 3 similar conditions in a class' do
-    src = <<EOS
+  before :each do
+    @detector = SimulatedPolymorphism.new
+  end
+  context 'with no conditionals' do
+    it 'gathers an empty hash' do
+      ast = 'module Stable; end'.to_reek_source.syntax_tree
+      ctx = CodeContext.new(nil, ast)
+      @detector.conditional_counts(ctx).length.should == 0
+    end
+  end
+
+  context 'with a test of block_given?' do
+    it 'does not record the condition' do
+      ast = 'def fred() yield(3) if block_given?; end'.to_reek_source.syntax_tree
+      ctx = CodeContext.new(nil, ast)
+      @detector.conditional_counts(ctx).length.should == 0
+    end
+  end
+
+  context 'with three identical conditionals' do
+    before :each do
+      cond = '@field == :sym'
+      @cond_expr = cond.to_reek_source.syntax_tree
+      src = <<EOS
 class Scrunch
   def first
-    return @field == :sym ? 0 : 3;
+    return #{cond} ? 0 : 3;
   end
   def second
-    if @field == :sym
+    if #{cond}
       @other += " quarts"
     end
   end
   def third
-    raise 'flu!' unless @field == :sym
+    raise 'flu!' unless #{cond}
   end
 end
 EOS
 
-    src.should reek_only_of(:SimulatedPolymorphism, /@field == :sym/)
+      ast = src.to_reek_source.syntax_tree
+      ctx = CodeContext.new(nil, ast)
+      @conds = @detector.conditional_counts(ctx)
+    end
+    it 'finds one matching conditional' do
+      @conds.length.should == 1
+    end
+    it 'returns the condition expr' do
+      @conds.keys[0].should == @cond_expr
+    end
+    it 'knows there are three copies' do
+      @conds[@cond_expr].should == 3
+    end
   end
 
-  it 'should include case statements in the count' do
-    src = <<EOS
+  context 'with a matching if and case' do
+    before :each do
+      cond = '@field == :sym'
+      @cond_expr = cond.to_reek_source.syntax_tree
+      src = <<EOS
 class Scrunch
-  def first
-    return @field ? 0 : 3;
+  def alpha
+    return #{cond} ? 0 : 2;
   end
-  def second
-    case @field
-    when :sym
-      @other += " quarts"
+  def beta
+    case #{cond}
+    when :symbol
+      @tother += " pints"
     end
   end
-  def third
-    raise 'flu!' unless @field
-  end
 end
 EOS
 
-    src.should reek_only_of(:SimulatedPolymorphism, /@field/)
+      ast = src.to_reek_source.syntax_tree
+      ctx = CodeContext.new(nil, ast)
+      @conds = @detector.conditional_counts(ctx)
+    end
+    it 'finds exactly one conditional' do
+      @conds.length.should == 1
+    end
+    it 'returns the condition expr' do
+      @conds.keys[0].should == @cond_expr
+    end
+    it 'knows there are three copies' do
+      @conds[@cond_expr].should == 2
+    end
   end
 
   # And count code in superclasses, if we have it

data/spec/reek/smells/utility_function_spec.rb

@@ -79,24 +79,3 @@ EOS
     end
   end
 end
-
-describe UtilityFunction do
-  it 'should not report attrset' do
-    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-    class Fred
-      attr_writer :xyz
-    end
-    Fred.should_not reek
-  end
-
-  it 'should not report overriding methods' do
-    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-    class Father
-      def thing(ff); @kids = 0; end
-    end
-    class Son < Father
-      def thing(ff); ff; end
-    end
-    Son.should_not reek
-  end
-end

data/spec/reek/sniffer_spec.rb

@@ -7,4 +7,5 @@ describe Sniffer do
     dirty_file = Dir['spec/samples/two_smelly_files/*.rb'][0]
     File.new(dirty_file).sniff.should be_smelly
   end
+
 end

data/spec/samples/not_quite_masked/dirty.rb

@@ -1,4 +1,6 @@
 class Dirty
+  attr_reader :property
+
   def a
     puts @s.title
     @s.map {|x| x.each {|key| key += 3}}

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 $:.unshift File.dirname(__FILE__) + '/../lib'
 
+require 'rubygems'
 begin
   require 'spec/expectations'
 rescue LoadError
-  require 'rubygems'
   gem 'rspec'
   require 'spec/expectations'
 end

data/tasks/reek.rake

@@ -4,7 +4,7 @@ begin
   Reek::RakeTask.new do |t|
     t.fail_on_error = true
     t.verbose = false
-    t.reek_opts = '--quiet --show-all'
+    t.reek_opts = '--quiet'
   end
 rescue Gem::LoadError
 end