kevinrutherford-reek 0.3.1.4

data/spec/integration/reek_source_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe 'Reek source code:' do
+  Dir['lib/**/*.rb'].each do |path|
+    it "reports no smells in #{path}" do
+      File.new(path).should_not reek
+    end
+  end
+
+  it 'reports no smells via the Dir matcher' do
+    Dir['lib/**/*.rb'].should_not reek
+  end
+end
+
+describe 'RakeTask' do
+  it 'should report no duplication' do
+    report = `rake reek`.split("\n")
+    report.length.should == 1
+  end
+end

data/spec/integration/script_spec.rb

@@ -0,0 +1,55 @@
+require 'reek'
+
+describe 'version number' do
+  it 'should report the correct value' do
+    actual = `ruby -Ilib bin/reek --version`.split
+    $?.exitstatus.should == 0
+    actual[0].should == 'reek'
+    actual[1].should == Reek::VERSION
+  end
+end
+
+describe 'exit status', 'when reek is used incorrectly' do
+  it 'should return non-zero status on bad option' do
+    `ruby -Ilib bin/reek --no-such-option`
+    $?.exitstatus.should == 1
+  end
+
+  it 'should complain about missing file' do
+    `ruby -Ilib bin/reek nosuchfile.rb`
+    $?.exitstatus.should == 1
+  end
+
+  it 'should return non-zero status on missing argument' do
+    `ruby -Ilib bin/reek -f 2>/dev/null`
+    $?.exitstatus.should == 1
+  end
+end
+
+describe 'exit status', 'when reek is used correctly' do
+  it 'should return non-zero status when smells are reported' do
+    `echo "def x() 3; end" | ruby -Ilib bin/reek`
+    $?.exitstatus.should == 2
+  end
+
+  it 'should return zero status with no smells' do
+    `echo "def simple() @fred = 3 end" | ruby -Ilib bin/reek`
+    $?.exitstatus.should == 0
+  end
+end
+
+describe 'report format', 'with one source' do
+  it 'should output nothing with empty source' do
+    `echo "" | ruby -Ilib bin/reek`.should be_empty
+  end
+
+  it 'should output nothing when no smells' do
+    `echo "def simple() @fred = 3; end" | ruby -Ilib bin/reek`.should be_empty
+  end
+
+  it 'should not adorn the list of warnings' do
+    report = `echo  "class Turn; def y() @x = 3; end end" | ruby -Ilib bin/reek`
+    report.split(/\n/).length.should == 2
+    report.should_not match(/\n\n/)
+  end
+end

data/spec/reek/class_context_spec.rb

@@ -0,0 +1,198 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/class_context'
+require 'reek/stop_context'
+require 'reek/smells/feature_envy'
+
+include Reek
+include Reek::Smells
+
+describe ClassContext do
+  it 'should report Long Parameter List' do
+    ruby = 'class Inner; def simple(arga, argb, argc, argd) f(3);true end end'
+    ruby.should reek_of(:LongParameterList, /Inner/, /simple/, /4 parameters/)
+  end
+
+  it 'should report two different methods' do
+    src = <<EOEX
+class Fred
+  def simple(arga, argb, argc, argd) f(3);true end
+  def simply(arga, argb, argc, argd) f(3);false end
+end
+EOEX
+    src.should reek_of(:LongParameterList, /Fred/, /simple/)
+    src.should reek_of(:LongParameterList, /Fred/, /simply/)
+  end
+
+  it 'should report many different methods' do
+    src = <<EOEX
+class Fred
+    def textile_bq(tag, atts, cite, content) f(3);end
+    def textile_p(tag, atts, cite, content) f(3);end
+    def textile_fn_(tag, num, atts, cite, content) f(3);end
+    def textile_popup_help(name, windowW, windowH) f(3);end
+end
+EOEX
+    src.should reek_of(:LongParameterList, /Fred/, /textile_bq/)
+    src.should reek_of(:LongParameterList, /Fred/, /textile_fn_/)
+    src.should reek_of(:LongParameterList, /Fred/, /textile_p/)
+  end
+end
+
+describe Class do
+  
+  module Insert
+    def meth_a() end
+  private
+    def meth_b() end
+  protected
+    def meth_c() end
+  end
+
+  class Parent
+    def meth1() end
+  private
+    def meth2() end
+  protected
+    def meth3() end
+  end
+  
+  class FullChild < Parent
+    include Insert
+    def meth7() end
+  private
+    def meth8() end
+  protected
+    def meth6() end
+  end
+
+  describe 'with no superclass or modules' do
+    it 'should report correct number of methods' do
+      Parent.non_inherited_methods.length.should == 3
+    end
+  end
+
+  describe 'with superclass and modules' do
+    it 'should report correct number of methods' do
+      FullChild.non_inherited_methods.length.should == 3
+    end
+  end
+end
+
+describe ClassContext, 'overridden methods' do
+  class Above
+    def above() end
+    def both() end
+  end
+  
+  class Below < Above
+    def both() end
+    def below() end
+  end
+  
+  describe 'of loaded class' do
+    before :each do
+      @ctx = ClassContext.create(StopContext.new, [0, :Below])
+    end
+
+    it 'should recognise non-overridden method' do
+      @ctx.is_overriding_method?('below').should == false
+      @ctx.is_overriding_method?('above').should == false
+    end
+
+    it 'should recognise overridden method' do
+      @ctx.is_overriding_method?('both').should == true
+    end
+    
+    it 'should recognise methods in current codebase' do
+      ctx = ClassContext.create(StopContext.new, [0, :FeatureEnvy])
+      ctx.is_overriding_method?('examine_context').should == true
+    end
+  end
+  
+  describe 'of non-loaded class' do
+    before :each do
+      @ctx = ClassContext.create(StopContext.new, [0, :Missing])
+    end
+
+    it 'should recognise non-overridden method' do
+      @ctx.is_overriding_method?('below').should == false
+      @ctx.is_overriding_method?('above').should == false
+    end
+
+    it 'should recognise overridden method' do
+      @ctx.is_overriding_method?('both').should == false
+    end
+  end
+end
+
+describe 'Integration defect:' do
+  it 'should not report UtilityFunction for FeatureEnvy#examine_context' do
+    kelement = ClassContext.create(StopContext.new, [0, :FeatureEnvy, s(:const, :SmellDetector)])
+    meth = Name.new(:examine_context)
+    kelement.is_overriding_method?(meth).should == true
+    melement = MethodContext.new(kelement, [0, :examine_context])
+    melement.is_overriding_method?(meth).should == true
+    melement.depends_on_instance?.should == true
+  end
+end
+
+describe CodeContext, 'find class' do
+  module Mod1
+    class Klass1
+      module Mod2
+        class Klass2
+        end
+      end
+    end
+  end
+
+  before :each do
+    @stop = StopContext.new
+    @mod1 = ModuleContext.create(@stop, [0, :Mod1])
+    @klass1 = ClassContext.create(@mod1, [0, :Klass1])
+    @mod2 = ModuleContext.create(@klass1, [0, :Mod2])
+    @klass2 = ClassContext.create(@mod2, [0, :Klass2])
+  end
+
+  describe StopContext do
+    it 'should not find unqualified class' do
+      @stop.find_module('Klass2').should == nil
+    end
+
+    it 'should find unqualified module' do
+      @stop.find_module('Mod1').name.should == 'Mod1'
+    end
+  end
+  
+  describe ModuleContext do
+    it 'should find local name' do
+      @mod1.find_module('Klass1').name.should == 'Mod1::Klass1'
+      @mod2.find_module('Klass2').name.should == 'Mod1::Klass1::Mod2::Klass2'
+    end
+    
+    it 'should not find deeper class' do
+      @mod1.find_module('Klass2').should == nil
+    end
+    
+    it 'should find own Module' do
+      @mod1.myself.name.should == 'Mod1'
+      @mod2.myself.name.should == 'Mod1::Klass1::Mod2'
+    end
+  end
+  
+  describe ClassContext do
+    it 'should find local module' do
+      @klass1.find_module('Mod2').name.should == 'Mod1::Klass1::Mod2'
+    end
+    
+    it 'should not find deeper module' do
+      @klass1.find_module('Klass2').should == nil
+    end
+    
+    it 'should find own Class' do
+      @klass1.myself.name.should == 'Mod1::Klass1'
+      @klass2.myself.name.should == 'Mod1::Klass1::Mod2::Klass2'
+    end
+  end
+end

data/spec/reek/code_context_spec.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/block_context'
+require 'reek/if_context'
+require 'reek/class_context'
+require 'reek/module_context'
+require 'reek/method_context'
+require 'reek/stop_context'
+
+include Reek
+
+describe CodeContext, 'to_s' do
+
+  it "should report full context" do
+    element = StopContext.new
+    element = ModuleContext.new(element, [0, :mod])
+    element = ClassContext.new(element, [0, :klass])
+    element = MethodContext.new(element, [0, :bad])
+    element = BlockContext.new(element, nil)
+    element.to_s.should match(/bad/)
+    element.to_s.should match(/klass/)
+    element.to_s.should match(/mod/)
+  end
+
+  it "should report method name via if context" do
+    element1 = StopContext.new
+    element2 = MethodContext.new(element1, [0, :bad])
+    element3 = IfContext.new(element2, [0,1])
+    BlockContext.new(element3, nil).to_s.should match(/bad/)
+  end
+
+  it "should report method name via nested blocks" do
+    element1 = StopContext.new
+    element2 = MethodContext.new(element1, [0, :bad])
+    element3 = BlockContext.new(element2, nil)
+    BlockContext.new(element3, nil).to_s.should match(/bad/)
+  end
+end
+
+describe CodeContext, 'instance variables' do
+  it 'should pass instance variables down to the first class' do
+    element = StopContext.new
+    element = ModuleContext.new(element, [0, :mod])
+    class_element = ClassContext.new(element, [0, :klass])
+    element = MethodContext.new(class_element, [0, :bad])
+    element = BlockContext.new(element, nil)
+    element.record_instance_variable(:fred)
+    class_element.variable_names.should == [Name.new(:fred)]
+  end
+end
+
+describe CodeContext, 'generics' do
+  it 'should pass unknown method calls down the stack' do
+    stop = StopContext.new
+    def stop.bananas(arg1, arg2) arg1 + arg2 + 43 end
+    element = ModuleContext.new(stop, [0, :mod])
+    class_element = ClassContext.new(element, [0, :klass])
+    element = MethodContext.new(class_element, [0, :bad])
+    element = BlockContext.new(element, nil)
+    element.bananas(17, -5).should == 55
+  end
+end
+
+describe CodeContext do
+  it 'should recognise itself in a collection of names' do
+    element = StopContext.new
+    element = ModuleContext.new(element, [0, :mod])
+    element.matches?(['banana', 'mod']).should == true
+  end
+
+  it 'should recognise itself in a collection of REs' do
+    element = StopContext.new
+    element = ModuleContext.new(element, [0, :mod])
+    element.matches?([/banana/, /mod/]).should == true
+  end
+
+  it 'should recognise its fq name in a collection of names' do
+    element = StopContext.new
+    element = ModuleContext.new(element, [0, :mod])
+    element = ClassContext.create(element, [0, :klass])
+    element.matches?(['banana', 'mod']).should == true
+    element.matches?(['banana', 'mod::klass']).should == true
+  end
+
+  it 'should recognise its fq name in a collection of names' do
+    element = StopContext.new
+    element = ModuleContext.new(element, [0, :mod])
+    element = ClassContext.create(element, [0, :klass])
+    element.matches?([/banana/, /mod/]).should == true
+    element.matches?([/banana/, /mod::klass/]).should == true
+  end
+end

data/spec/reek/code_parser_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/code_parser'
+require 'reek/report'
+
+include Reek
+
+describe CodeParser, "with no method definitions" do
+  it 'should report no problems for empty source code' do
+    ''.should_not reek
+  end
+  it 'should report no problems for empty class' do
+    'class Fred; end'.should_not reek
+  end
+end
+
+describe CodeParser, 'with a global method definition' do
+  it 'should report no problems for simple method' do
+    'def Outermost::fred() true; end'.should_not reek
+  end
+end
+
+describe CodeParser, 'when given a C extension' do
+  before(:each) do
+    @cchk = CodeParser.new(Report.new, SmellConfig.new.smell_listeners)
+  end
+
+  it 'should ignore :cfunc' do
+    @cchk.check_object(Enumerable)
+  end
+end
+
+describe CodeParser, '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'
+    source.should_not reek
+  end
+end

data/spec/reek/config_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/smells/smells'
+require 'yaml'
+
+include Reek
+
+describe 'Config' do
+  before :each do
+    @first = {
+      'one' => {'two' => 3, 'three' => 4},
+      'two' => {'four' => true}
+    }
+  end
+
+  it 'should deep merge Hashes' do
+    other = Hash.new {|hash,key| hash[key] = {} }
+    other['one']['gunk'] = 45
+    other['two']['four'] = false
+    @first.value_merge!(other).to_yaml
+    @first['two']['four'].should == false
+    @first['one'].keys.length.should == 3
+  end
+  
+  it 'should deep copy Hashes' do
+    second = @first.deep_copy
+    second['two'].object_id.should_not be_eql(@first['two'].object_id)
+  end
+  
+  it 'should merge array values' do
+    @first['three'] = [1,2,3]
+  end
+end
+
+describe Config, 'merging arrays' do
+  it 'should merge array values' do
+    first = {'key' => {'one' => [1,2,3]}}
+    second = {'key' => {'one' => [4,5]}}
+    first.value_merge!(second)
+    first['key']['one'].should == [1,2,3,4,5]
+  end
+end

data/spec/reek/module_context_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'reek/module_context'
+require 'reek/stop_context'
+
+include Reek
+
+describe ModuleContext do
+  it 'should report module name for smell in method' do
+    'module Fred; def simple(x) true; end; end'.should reek_of(:UncommunicativeName, /x/, /simple/, /Fred/)
+  end
+
+  it 'should not report module with empty class' do
+    'module Fred; class Jim; end; end'.should_not reek
+  end
+
+  it 'should handle module with empty class' do
+    stop = StopContext.new
+    modctx = ModuleContext.create(stop, [:module, :Fred, []])
+    modctx.find_module(Name.new(:Jim)).should be_nil
+  end
+end
+
+describe ModuleContext do
+  it 'should recognise global constant' do
+    'module ::Global class Inside; end; end'.should_not reek
+  end
+
+  it 'should not find missing global constant' do
+    element = ModuleContext.create(StopContext.new, [:module, [:colon3, :Global], nil])
+    element.myself.should be_nil
+  end
+
+  it 'should find global constant' do
+    module ::GlobalTestModule; end
+    element = ModuleContext.create(StopContext.new, [:module, [:colon3, :GlobalTestModule], nil])
+    element.myself.name.should == 'GlobalTestModule'
+  end
+end

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

data/spec/reek/options_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+ 
+require 'reek/options'
+
+include Reek
+
+describe Options, ' when given no arguments' do
+  it "should retain the default sort order" do
+    default_order = Options[:format]
+    Options.parse ['nosuchfile.rb']
+    Options[:format].should == default_order
+  end
+end

data/spec/reek/report_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/smells/smell_detector'
+require 'reek/report'
+require 'reek/source'
+require 'reek/smells/feature_envy'
+
+include Reek
+
+describe Report, " when empty" do
+  before(:each) do
+    @rpt = Report.new
+  end
+
+  it 'should have zero length' do
+    @rpt.length.should == 0
+  end
+
+  it 'should claim to be empty' do
+    @rpt.should be_empty
+  end
+end
+
+describe Report, "to_s" do
+  before(:each) do
+    rpt = Source.from_s('def simple(a) a[3] end').report
+    @report = rpt.to_s.split("\n")
+  end
+
+  it 'should place each detailed report on a separate line' do
+    @report.length.should == 2
+  end
+
+  it 'should mention every smell name' do
+    @report[0].should match(/[Utility Function]/)
+    @report[1].should match(/[Feature Envy]/)
+  end
+end
+
+describe Report, " as a SortedSet" do
+  it 'should only add a smell once' do
+    rpt = Report.new
+    rpt << SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!')
+    rpt.length.should == 1
+    rpt << SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!')
+    rpt.length.should == 1
+  end
+end