reek 1.2.6 → 1.2.7

data/spec/reek/{help_command_spec.rb → cli/help_command_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', 'cli', 'help_command')
 
-require 'reek/help_command'
-
-include Reek
+include Reek::Cli
 
 describe HelpCommand do
   before :each do

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

@@ -1,8 +1,9 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-
-require 'reek/reek_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', 'reek_command')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'examiner')
 
 include Reek
+include Reek::Cli
 
 describe ReekCommand do
   before :each do
@@ -11,8 +12,8 @@ describe ReekCommand do
 
   context 'with smells' do
     before :each do
-      src = 'def x(); end'
-      @cmd = ReekCommand.new(src, QuietReport, false)
+      examiner = Examiner.new('def x(); end')
+      @cmd = ReekCommand.new([examiner], QuietReport, false)
     end
 
     it 'displays the correct text on the view' do
@@ -28,8 +29,8 @@ describe ReekCommand do
 
   context 'with no smells' do
     before :each do
-      src = 'def clean(); end'
-      @cmd = ReekCommand.new(src, QuietReport, false)
+      examiner = Examiner.new('def clean(); end')
+      @cmd = ReekCommand.new([examiner], QuietReport, false)
     end
 
     it 'displays nothing on the view' do

data/spec/reek/cli/report_spec.rb

@@ -0,0 +1,26 @@
+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 ReportSection, " when empty" do
+  context 'empty source' do
+    it 'has an empty quiet_report' do
+      examiner = Examiner.new('')
+      ReportSection.new(examiner, false).quiet_report.should == ''
+    end
+  end
+
+  context 'with a couple of smells' do
+    it 'should mention every smell name' do
+      examiner = Examiner.new('def simple(a) a[3] end')
+      rpt = ReportSection.new(examiner, false)
+      @lines = rpt.smell_list.split("\n")
+      @lines.should have_at_least(2).lines
+      @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(:all_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", true)
+      @examiner.should_receive(:all_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/block_context_spec.rb

@@ -0,0 +1,26 @@
+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', 'block_context')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core',  'method_context')
+
+include Reek::Core
+
+describe BlockContext do
+  context 'full_name' do
+    it "reports full context" do
+      bctx = BlockContext.new(StopContext.new, s(nil, nil))
+      bctx.full_name.should == 'block'
+    end
+    it 'uses / to connect to the class name' do
+      element = StopContext.new
+      element = ClassContext.new(element, :Fred, s(:class, :Fred))
+      element = BlockContext.new(element, s(:iter, nil, s(:lasgn, :x), nil))
+      element.full_name.should == 'Fred/block'
+    end
+    it 'uses / to connect to the module name' do
+      element = StopContext.new
+      element = ModuleContext.new(element, :Fred, s(:module, :Fred))
+      element = BlockContext.new(element, s(:iter, nil, s(:lasgn, :x), nil))
+      element.full_name.should == 'Fred/block'
+    end
+  end
+end

data/spec/reek/core/class_context_spec.rb

@@ -0,0 +1,53 @@
+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', 'class_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 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
+# module for test
+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
+# module for test
+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 ClassContext do
+  it 'does not report empty class in another module' do
+    '# module for test
+class Treetop::Runtime::SyntaxNode; end'.should_not reek
+  end
+
+  it 'deals with :: scoped names' do
+    element = ClassContext.create(StopContext.new, [:colon2, [:colon2, [:const, :Treetop], :Runtime], :SyntaxNode])
+    element.num_methods.should == 0
+  end
+end

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

@@ -1,19 +1,17 @@
-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', 'block_context')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'class_context')
+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')
 
-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
+include Reek::Core
 
 describe CodeContext do
   context 'full_name' do
     it "reports the full context" do
       element = StopContext.new
-      element = ModuleContext.new(element, Name.new(:mod), s(:module, :mod, nil))
+      element = ModuleContext.new(element, 'mod', s(:module, :mod, nil))
       element = ClassContext.new(element, [0, :klass], s())
       element = MethodContext.new(element, [0, :bad])
       element = BlockContext.new(element, s(nil, nil))
@@ -22,13 +20,6 @@ describe CodeContext do
       element.full_name.should match(/mod/)
     end
 
-    it 'reports the method name via if context' do
-      element1 = StopContext.new
-      element2 = MethodContext.new(element1, [0, :bad])
-      element3 = IfContext.new(element2, [0,1])
-      BlockContext.new(element3, s(nil, nil)).full_name.should match(/bad/)
-    end
-
     it 'reports the method name via nested blocks' do
       element1 = StopContext.new
       element2 = MethodContext.new(element1, [0, :bad])
@@ -39,21 +30,8 @@ describe CodeContext do
       outer_name = 'randomstring'
       outer = mock('outer')
       outer.should_receive(:full_name).and_return(outer_name)
-      ifc = IfContext.new(outer, s(:if, s()))
-      ifc.full_name.should == outer_name
-    end
-  end
-
-  context 'instance variables' do
-    it 'should pass instance variables down to the first class' do
-      element = StopContext.new
-      element = ModuleContext.new(element, Name.new(:mod), s(:module, :mod, nil))
-      class_element = ClassContext.new(element, [0, :klass], s())
-      element = MethodContext.new(class_element, [0, :bad])
-      element = BlockContext.new(element, s(nil, nil))
-      element.record_instance_variable(:fred)
-      class_element.variable_names.size.should == 1
-      class_element.variable_names.should include(Name.new(:fred))
+      ifc = BlockContext.new(outer, s(:if, s()))
+      ifc.full_name.should == "#{outer_name}/block"
     end
   end
 
@@ -61,7 +39,7 @@ describe CodeContext 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, Name.new(:mod), s(:module, :mod, nil))
+      element = ModuleContext.new(stop, 'mod', s(:module, :mod, nil))
       class_element = ClassContext.new(element, [0, :klass], s())
       element = MethodContext.new(class_element, [0, :bad])
       element = BlockContext.new(element, s(nil, nil))
@@ -72,19 +50,19 @@ describe CodeContext do
   context 'name matching' do
     it 'should recognise itself in a collection of names' do
       element = StopContext.new
-      element = ModuleContext.new(element, Name.new(:mod), s(:module, :mod, nil))
+      element = ModuleContext.new(element, 'mod', s(:module, :mod, nil))
       element.matches?(['banana', 'mod']).should == true
     end
 
     it 'should recognise itself in a collection of REs' do
       element = StopContext.new
-      element = ModuleContext.new(element, Name.new(:mod), s(:module, :mod, nil))
+      element = ModuleContext.new(element, 'mod', s(:module, :mod, nil))
       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, Name.new(:mod), s(:module, :mod, nil))
+      element = ModuleContext.new(element, 'mod', s(:module, :mod, nil))
       element = ClassContext.create(element, s(:class, :klass))
       element.matches?(['banana', 'mod']).should == true
       element.matches?(['banana', 'mod::klass']).should == true
@@ -92,7 +70,7 @@ describe CodeContext do
 
     it 'should recognise its fq name in a collection of names' do
       element = StopContext.new
-      element = ModuleContext.new(element, Name.new(:mod), s(:module, :mod, nil))
+      element = ModuleContext.new(element, 'mod', s(:module, :mod, nil))
       element = ClassContext.create(element, s(:class, :klass))
       element.matches?([/banana/, /mod/]).should == true
       element.matches?([/banana/, /mod::klass/]).should == true

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

@@ -1,15 +1,15 @@
-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
 

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/{masking_collection_spec.rb → core/masking_collection_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', 'masking_collection')
 
-require 'reek/masking_collection'
-
-include Reek
+include Reek::Core
 
 describe MaskingCollection do
   before(:each) do

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

@@ -1,9 +1,8 @@
-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
@@ -24,8 +23,8 @@ 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 = ModuleContext.new(element, 'mod', s(:module, :mod, nil))
+    element = ClassContext.new(element, 'klass', s())
     @element = MethodContext.new(element, s(0, :meth))
   end
 

data/spec/reek/core/module_context_spec.rb

@@ -0,0 +1,42 @@
+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/, /Fred/)
+  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
+
+  context 'full_name' do
+    it "reports full context" do
+      element = StopContext.new
+      element = ModuleContext.new(element, 'mod', s(:module, :mod, nil))
+      element.full_name.should == 'mod'
+    end
+  end
+
+  it 'finds fq loaded class' do
+    exp = [:class, :"Reek::Smells::LargeClass", nil]
+    ctx = StopContext.new
+    res = ModuleContext.resolve(exp[1], ctx)
+    res[1].should == "LargeClass"
+  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