reek 1.2.6 → 1.2.8

data/spec/reek/cli/report_spec.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'examiner')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'cli', 'report')
+
+include Reek
+include Reek::Cli
+
+describe QuietReport, " when empty" do
+  context 'empty source' do
+    it 'has an empty quiet_report' do
+      examiner = Examiner.new('')
+      QuietReport.new(examiner).report.should == ''
+    end
+  end
+
+  context 'with a couple of smells' do
+    before :each do
+      examiner = Examiner.new('def simple(a) a[3] end')
+      rpt = QuietReport.new(examiner)
+      @lines = rpt.report.split("\n")
+    end
+    it 'has a header and a list of smells' do
+      @lines.should have_at_least(3).lines
+    end
+    it 'should mention every smell name' do
+      @lines[0].should match('[Utility Function]')
+      @lines[1].should match('[Feature Envy]')
+    end
+  end
+end

data/spec/reek/{version_command_spec.rb → cli/version_command_spec.rb}

@@ -1,8 +1,8 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-
-require 'reek/version_command'
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'cli', 'version_command')
 
 include Reek
+include Reek::Cli
 
 describe VersionCommand do
   before :each do

data/spec/reek/cli/yaml_command_spec.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'cli', 'yaml_command')
+
+include Reek
+include Reek::Cli
+
+describe YamlCommand do
+  before :each do
+    @view = mock('view', :null_object => true)
+    @examiner = mock('examiner')
+  end
+
+  context 'with no smells' do
+    before :each do
+      @examiner.should_receive(:smells).and_return([])
+      @cmd = YamlCommand.new([@examiner])
+    end
+
+    it 'displays nothing on the view' do
+      @view.should_not_receive(:output)
+      @cmd.execute(@view)
+    end
+
+    it 'tells the view it succeeded' do
+      @view.should_receive(:report_success)
+      @cmd.execute(@view)
+    end
+  end
+
+  context 'with smells' do
+    before :each do
+      @smell = SmellWarning.new('UncommunicativeName', "self", 27, "self")
+      @examiner.should_receive(:smells).and_return([@smell])
+      @cmd = YamlCommand.new([@examiner])
+    end
+
+    it 'displays the correct text on the view' do
+      @view.should_receive(:output).with(/UncommunicativeName/)
+      @cmd.execute(@view)
+    end
+
+    it 'tells the view it found smells' do
+      @view.should_receive(:report_smells)
+      @cmd.execute(@view)
+    end
+  end
+end

data/spec/reek/core/code_context_spec.rb

@@ -0,0 +1,145 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'method_context')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'module_context')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'stop_context')
+
+include Reek::Core
+
+describe CodeContext do
+  context 'name recognition' do
+    before :each do
+      @exp_name = 'random_name'    # SMELL: could use a String.random here
+      @full_name = "::::::::::::::::::::#{@exp_name}"
+      @exp = mock('exp')
+      @exp.should_receive(:name).any_number_of_times.and_return(@exp_name)
+      @exp.should_receive(:full_name).any_number_of_times.and_return(@full_name)
+      @exp.should_receive(:comments).any_number_of_times.and_return('')
+      @ctx = CodeContext.new(nil, @exp)
+    end
+    it 'gets its short name from the exp' do
+      @ctx.name.should == @exp_name
+    end
+    it 'does not match an empty list' do
+      @ctx.matches?([]).should == false
+    end
+    it 'does not match when its own short name is not given' do
+      @ctx.matches?(['banana']).should == false
+    end
+    it 'recognises its own short name' do
+      @ctx.matches?(['banana', @exp_name]).should == true
+    end
+    it 'recognises its short name as a regex' do
+      @ctx.matches?([/banana/, /#{@exp_name}/]).should == true
+    end
+
+    context 'when there is an outer' do
+      before :each do
+        @outer_name = 'another_random sting'
+        outer = mock('outer')
+        outer.should_receive(:full_name).at_least(:once).and_return(@outer_name)
+        outer.should_receive(:config).and_return({})
+        @ctx = CodeContext.new(outer, @exp)
+      end
+      it 'creates the correct full name' do
+        @ctx.full_name.should == "#{@full_name}"
+      end
+      it 'recognises its own full name' do
+        @ctx.matches?(['banana', @full_name]).should == true
+      end
+      it 'recognises its full name as a regex' do
+        @ctx.matches?([/banana/, /#{@full_name}/]).should == true
+      end
+    end
+  end
+
+  context '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, 'mod', ast(:module, :mod, nil))
+      element = MethodContext.new(element, ast(:defn, :bad))
+      element.bananas(17, -5).should == 55
+    end
+  end
+
+  context 'enumerating syntax elements' do
+    context 'in an empty module' do
+      before :each do
+        @module_name = 'Emptiness'
+        src = "module #{@module_name}; end"
+        ast = src.to_reek_source.syntax_tree
+        @ctx = CodeContext.new(nil, ast)
+      end
+      it 'yields no calls' do
+        @ctx.each_node(:call, []) {|exp| raise "#{exp} yielded by empty module!"}
+      end
+      it 'yields one module' do
+        mods = 0
+        @ctx.each_node(:module, []) {|exp| mods += 1}
+        mods.should == 1
+      end
+      it "yields the module's full AST" do
+        @ctx.each_node(:module, []) {|exp| exp[1].should == @module_name.to_sym}
+      end
+
+      context 'with no block' do
+        it 'returns an empty array of ifs' do
+          @ctx.each_node(:if, []).should be_empty
+        end
+      end
+    end
+
+    context 'with a nested element' do
+      before :each do
+        @module_name = 'Loneliness'
+        @method_name = 'calloo'
+        src = "module #{@module_name}; def #{@method_name}; puts('hello') end; end"
+        ast = src.to_reek_source.syntax_tree
+        @ctx = CodeContext.new(nil, ast)
+      end
+      it 'yields no ifs' do
+        @ctx.each_node(:if, []) {|exp| raise "#{exp} yielded by empty module!"}
+      end
+      it 'yields one module' do
+        @ctx.each_node(:module, []).length.should == 1
+      end
+      it "yields the module's full AST" do
+        @ctx.each_node(:module, []) {|exp| exp[1].should == @module_name.to_sym}
+      end
+      it 'yields one method' do
+        @ctx.each_node(:defn, []).length.should == 1
+      end
+      it "yields the method's full AST" do
+        @ctx.each_node(:defn, []) {|exp| exp[1].should == @method_name.to_sym}
+      end
+
+      context 'pruning the traversal' do
+        it 'ignores the call inside the method' do
+          @ctx.each_node(:call, [:defn]).should be_empty
+        end
+      end
+    end
+
+    it 'finds 3 ifs in a class' do
+      src = <<EOS
+class Scrunch
+  def first
+    return @field == :sym ? 0 : 3;
+  end
+  def second
+    if @field == :sym
+      @other += " quarts"
+    end
+  end
+  def third
+    raise 'flu!' unless @field == :sym
+  end
+end
+EOS
+
+      ast = src.to_reek_source.syntax_tree
+      ctx = CodeContext.new(nil, ast)
+      ctx.each_node(:if, []).length.should == 3
+    end
+  end
+end

data/spec/reek/{code_parser_spec.rb → core/code_parser_spec.rb}

@@ -1,21 +1,22 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'code_parser')
 
-require 'reek/code_parser'
-
-include Reek
+include Reek::Core
 
 describe CodeParser, "with no method definitions" do
   it 'reports no problems for empty source code' do
     ''.should_not reek
   end
   it 'reports no problems for empty class' do
-    'class Fred; end'.should_not reek
+    '# clean class for testing purposes
+class Fred; end'.should_not reek
   end
 end
 
 describe CodeParser, 'with a global method definition' do
   it 'reports no problems for simple method' do
-    'def Outermost::fred() true; end'.should_not reek
+    src = 'def Outermost::fred() true; end'
+    src.should_not reek
   end
 end
 

data/spec/reek/{config_spec.rb → core/config_spec.rb}

@@ -1,9 +1,5 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-
-require 'reek/sniffer'
-require 'yaml'
-
-include Reek
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'sniffer')
 
 describe Hash do
   before :each do

data/spec/reek/{method_context_spec.rb → core/method_context_spec.rb}

@@ -1,13 +1,14 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'method_context')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'stop_context')
 
-require 'reek/method_context'
-require 'reek/stop_context'
-
-include Reek
+include Reek::Core
 
 describe MethodContext, 'matching' do
   before :each do
-    @element = MethodContext.new(StopContext.new, s(0, :mod))
+    exp = mock('exp', :null_object => true)
+    exp.should_receive(:full_name).at_least(:once).and_return('mod')
+    @element = MethodContext.new(StopContext.new, exp)
   end
 
   it 'should recognise itself in a collection of names' do
@@ -21,46 +22,25 @@ describe MethodContext, 'matching' do
   end
 end
 
-describe MethodContext, 'matching fq names' do
-  before :each do
-    element = StopContext.new
-    element = ModuleContext.new(element, Name.new(:mod), s(:module, :mod, nil))
-    element = ClassContext.new(element, Name.new(:klass), s())
-    @element = MethodContext.new(element, s(0, :meth))
-  end
-
-  it 'should recognise itself in a collection of names' do
-    @element.matches?(['banana', 'meth']).should == true
-    @element.matches?(['banana', 'klass#meth']).should == true
-    @element.matches?(['banana']).should == false
-  end
-
-  it 'should recognise itself in a collection of names' do
-    @element.matches?([/banana/, /meth/]).should == true
-    @element.matches?([/banana/, /klass#meth/]).should == true
-    @element.matches?([/banana/]).should == false
-  end
-end
-
 describe MethodContext do
   it 'should record ivars as refs to self' do
-    mctx = MethodContext.new(StopContext.new, [:defn, :feed])
+    mctx = MethodContext.new(StopContext.new, ast(:defn, :feed))
     mctx.envious_receivers.should == []
-    mctx.record_call_to([:call, [:ivar, :@cow], :feed_to])
+    mctx.record_call_to(ast(:call, s(:ivar, :@cow), :feed_to))
     mctx.envious_receivers.should == []
   end
 
   it 'should count calls to self' do
-    mctx = MethodContext.new(StopContext.new, [:defn, :equals])
+    mctx = MethodContext.new(StopContext.new, ast(:defn, :equals))
     mctx.refs.record_ref([:lvar, :other])
-    mctx.record_call_to([:call, [:self], :thing])
+    mctx.record_call_to(ast(:call, s(:self), :thing))
     mctx.envious_receivers.should be_empty
   end
 
   it 'should recognise a call on self' do
     mc = MethodContext.new(StopContext.new, s(:defn, :deep))
-    mc.record_call_to(s(:call, s(:lvar, :text), :each, s(:arglist)))
-    mc.record_call_to(s(:call, nil, :shelve, s(:arglist)))
+    mc.record_call_to(ast(:call, s(:lvar, :text), :each, s(:arglist)))
+    mc.record_call_to(ast(:call, nil, :shelve, s(:arglist)))
     mc.envious_receivers.should be_empty
   end
 end
@@ -85,7 +65,7 @@ describe MethodParameters, 'default assignments' do
       @defaults = assignments_from(src)
     end
     it 'returns the param-value pair' do
-      @defaults[:argb].should == s(:lit, 456)
+      @defaults[0].should == s(:argb, s(:lit, 456))
     end
     it 'returns the nothing else' do
       @defaults.length.should == 1
@@ -98,8 +78,8 @@ describe MethodParameters, 'default assignments' do
       @defaults = assignments_from(src)
     end
     it 'returns both param-value pairs' do
-      @defaults[:arga].should == s(:lit, 123)
-      @defaults[:argb].should == s(:lit, 456)
+      @defaults[0].should == s(:arga, s(:lit, 123))
+      @defaults[1].should == s(:argb, s(:lit, 456))
     end
     it 'returns nothing else' do
       @defaults.length.should == 2

data/spec/reek/core/module_context_spec.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'module_context')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'stop_context')
+
+include Reek::Core
+
+describe ModuleContext do
+  it 'should report module name for smell in method' do
+    'module Fred; def simple(x) true; end; end'.should reek_of(:UncommunicativeParameterName, /x/, /simple/)
+  end
+
+  it 'should not report module with empty class' do
+    '# module for test
+module Fred
+# module for test
+ class Jim; end; end'.should_not reek
+  end
+end
+
+describe ModuleContext do
+  it 'should recognise global constant' do
+    '# module for test
+module ::Global
+# module for test
+ class Inside; end; end'.should_not reek
+  end
+end

data/spec/reek/{object_refs_spec.rb → core/object_refs_spec.rb}

@@ -1,8 +1,7 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'object_refs')
 
-require 'reek/object_refs'
-
-include Reek
+include Reek::Core
 
 describe ObjectRefs, 'when empty' do
   before(:each) do
@@ -27,7 +26,7 @@ describe ObjectRefs, 'with no refs to self' do
   end
 
   it 'should report :a as the max' do
-    @refs.max_keys.should == ['a']
+    @refs.max_keys.should == {'a' => 2}
   end
 
   it 'should not report self as the max' do
@@ -75,7 +74,7 @@ describe ObjectRefs, 'with many refs to self' do
   end
 
   it 'should report self among the max' do
-    @refs.max_keys.should == [Sexp.from_array([:lit, :self])]
+    @refs.max_keys.should == {Sexp.from_array([:lit, :self]) => 4}
   end
 
   it 'should report self as the max' do

data/spec/reek/core/singleton_method_context_spec.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'module_context')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'singleton_method_context')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'stop_context')
+
+include Reek::Core
+
+describe SingletonMethodContext do
+end

data/spec/reek/core/smell_configuration_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'smell_configuration')
+
+include Reek::Core
+
+describe SmellConfiguration do
+  it 'returns the default value when key not found' do
+    cf = SmellConfiguration.new({})
+    cf.value('fred', nil, 27).should == 27
+  end
+end

data/spec/reek/core/stop_context_spec.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'stop_context')
+
+include Reek
+include Reek::Core
+
+describe StopContext do
+  before :each do
+    @stop = StopContext.new
+  end
+
+  context 'full_name' do
+    it "reports full context" do
+      @stop.full_name.should == ''
+    end
+  end
+end

data/spec/reek/core/warning_collector_spec.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'warning_collector')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'smell_warning')
+
+include Reek::Core
+
+describe WarningCollector do
+  before(:each) do
+    @collector = WarningCollector.new
+  end
+
+  context 'when empty' do
+    it 'reports no warnings' do
+      @collector.warnings.should == []
+    end
+  end
+
+  context 'with one warning' do
+    before :each do
+      @warning = Reek::SmellWarning.new('ControlCouple', 'fred', [1,2,3], 'hello')
+      @collector.found_smell(@warning)
+    end
+    it 'reports that warning' do
+      @collector.warnings.should == [@warning]
+    end
+  end
+end

data/spec/reek/examiner_spec.rb

@@ -0,0 +1,103 @@
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'lib', 'reek', 'examiner')
+
+include Reek
+
+shared_examples_for 'supports the deprecated api' do
+  it 'returns all smells as active' do
+    @examiner.all_active_smells.should == @examiner.smells
+  end
+  it 'returns all smells as active' do
+    @examiner.all_smells.should == @examiner.smells
+  end
+  it 'counts all smells as active smells' do
+    @examiner.num_active_smells.should == @examiner.smells.length
+  end
+  it 'never reports masked smells' do
+    @examiner.num_masked_smells.should == 0
+  end
+end
+
+shared_examples_for 'no smells found' do
+  it 'is not smelly' do
+    @examiner.should_not be_smelly
+  end
+  it 'finds no smells' do
+    @examiner.smells.length.should == 0
+  end
+
+  it_should_behave_like 'supports the deprecated api'
+end
+
+shared_examples_for 'one smell found' do
+  it 'is smelly' do
+    @examiner.should be_smelly
+  end
+  it 'reports the smell' do
+    @examiner.smells.length.should == 1
+  end
+  it 'reports the correct smell' do
+    @examiner.smells[0].smell_class.should == @expected_first_smell
+  end
+
+  it_should_behave_like 'supports the deprecated api'
+end
+
+describe Examiner do
+  before :each do
+    @expected_first_smell = 'NestedIterators'
+  end
+
+  context 'with a fragrant String' do
+    before :each do
+      @examiner = Examiner.new('def good() true; end')
+    end
+
+    it_should_behave_like 'no smells found'
+  end
+
+  context 'with a smelly String' do
+    before :each do
+      @examiner = Examiner.new('def fine() y = 4; end')
+      @expected_first_smell = 'UncommunicativeName'
+    end
+
+    it_should_behave_like 'one smell found'
+  end
+
+  context 'with a smelly Dir' do
+    before :each do
+      smelly_dir = Dir['spec/samples/all_but_one_masked/*.rb']
+      @examiner = Examiner.new(smelly_dir)
+    end
+
+    it_should_behave_like 'one smell found'
+  end
+
+  context 'with a fragrant Dir' do
+    before :each do
+      clean_dir = Dir['spec/samples/three_clean_files/*.rb']
+      @examiner = Examiner.new(clean_dir)
+    end
+
+    it_should_behave_like 'no smells found'
+  end
+
+  context 'with a smelly File' do
+    before :each do
+      smelly_file = File.new(Dir['spec/samples/all_but_one_masked/d*.rb'][0])
+      @examiner = Examiner.new(smelly_file)
+    end
+
+    it_should_behave_like 'one smell found'
+  end
+
+  context 'with a fragrant File' do
+    before :each do
+      clean_file = File.new(Dir['spec/samples/three_clean_files/*.rb'][0])
+      @examiner = Examiner.new(clean_file)
+    end
+
+    it_should_behave_like 'no smells found'
+  end
+end