reek 1.2.6 → 1.2.7

data/spec/reek/core/singleton_method_context_spec.rb

@@ -0,0 +1,15 @@
+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
+  it "reports full context" do
+    element = StopContext.new
+    element = ModuleContext.new(element, 'mod', s(:module, :mod, nil))
+    element = SingletonMethodContext.new(element, s(:defs, s(:call, nil, :a, s(:arglist)), :b, s(:args)))
+    element.full_name.should match(/mod#a\.b/)
+  end
+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/examiner_spec.rb

@@ -0,0 +1,42 @@
+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
+
+describe Examiner do
+  it 'detects smells in a file' do
+    dirty_file = Dir['spec/samples/two_smelly_files/*.rb'][0]
+    Examiner.new(File.new(dirty_file)).should be_smelly
+  end
+  it 'doesnt match a fragrant String' do
+    examiner = Examiner.new('def good() true; end')
+    examiner.all_active_smells.should == []
+  end
+  it 'matches a smelly String' do
+    Examiner.new('def fine() y = 4; end').all_active_smells.length.should == 1
+  end
+
+  context 'checking code in a Dir' do
+    it 'matches a smelly Dir' do
+      smelly_dir = Dir['spec/samples/all_but_one_masked/*.rb']
+      Examiner.new(smelly_dir).all_active_smells.length.should == 1
+    end
+    it 'doesnt match a fragrant Dir' do
+      clean_dir = Dir['spec/samples/three_clean_files/*.rb']
+      Examiner.new(clean_dir).all_active_smells.length.should == 0
+    end
+  end
+
+  context 'checking code in a File' do
+    it 'matches a smelly File' do
+      smelly_file = File.new(Dir['spec/samples/all_but_one_masked/d*.rb'][0])
+      Examiner.new(smelly_file).all_active_smells.length.should == 1
+    end
+
+    it 'doesnt match a fragrant File' do
+      clean_file = File.new(Dir['spec/samples/three_clean_files/*.rb'][0])
+      Examiner.new(clean_file).all_active_smells.length.should == 0
+    end
+  end
+
+end

data/spec/reek/smell_warning_spec.rb

@@ -1,7 +1,5 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-
-require 'reek/smell_warning'
-require 'reek/smells/feature_envy'
+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', 'smell_warning')
 
 include Reek
 
@@ -9,8 +7,8 @@ describe SmellWarning do
   context 'sort order' do
     context 'smells differing only by masking' do
       before :each do
-        @first = SmellWarning.new(Smells::FeatureEnvy.new, "self", 27, "self", true)
-        @second = SmellWarning.new(Smells::FeatureEnvy.new, "self", 27, "self", false)
+        @first = SmellWarning.new('FeatureEnvy', "self", 27, "self", true)
+        @second = SmellWarning.new('FeatureEnvy', "self", 27, "self", false)
       end
 
       it 'should hash equal when the smell is the same' do
@@ -46,8 +44,8 @@ describe SmellWarning do
 
     context 'smells differing only by detector' do
       before :each do
-        @first = SmellWarning.new(Smells::Duplication.new, "self", 27, "self", false)
-        @second = SmellWarning.new(Smells::FeatureEnvy.new, "self", 27, "self", true)
+        @first = SmellWarning.new('Duplication', "self", 27, "self", false)
+        @second = SmellWarning.new('FeatureEnvy', "self", 27, "self", true)
       end
 
       it_should_behave_like 'first sorts ahead of second'
@@ -55,8 +53,8 @@ describe SmellWarning do
 
     context 'smells differing only by context' do
       before :each do
-        @first = SmellWarning.new(Smells::FeatureEnvy.new, "first", 27, "self", true)
-        @second = SmellWarning.new(Smells::FeatureEnvy.new, "second", 27, "self", false)
+        @first = SmellWarning.new('FeatureEnvy', "first", 27, "self", true)
+        @second = SmellWarning.new('FeatureEnvy', "second", 27, "self", false)
       end
 
       it_should_behave_like 'first sorts ahead of second'
@@ -64,8 +62,8 @@ describe SmellWarning do
 
     context 'smells differing only by message' do
       before :each do
-        @first = SmellWarning.new(Smells::FeatureEnvy.new, "context", 27, "first", true)
-        @second = SmellWarning.new(Smells::FeatureEnvy.new, "context", 27, "second", false)
+        @first = SmellWarning.new('FeatureEnvy', "context", 27, "first", true)
+        @second = SmellWarning.new('FeatureEnvy', "context", 27, "second", false)
       end
 
       it_should_behave_like 'first sorts ahead of second'
@@ -73,8 +71,8 @@ describe SmellWarning do
 
     context 'message takes precedence over smell name' do
       before :each do
-        @first = SmellWarning.new(Smells::UtilityFunction.new, "context", 27, "first", true)
-        @second = SmellWarning.new(Smells::FeatureEnvy.new, "context", 27, "second", false)
+        @first = SmellWarning.new('UtilityFunction', "context", 27, "first", true)
+        @second = SmellWarning.new('FeatureEnvy', "context", 27, "second", false)
       end
 
       it_should_behave_like 'first sorts ahead of second'
@@ -82,8 +80,8 @@ describe SmellWarning do
 
     context 'smells differing everywhere' do
       before :each do
-        @first = SmellWarning.new(Smells::UncommunicativeName.new, "Dirty", 27, "has the variable name '@s'", true)
-        @second = SmellWarning.new(Smells::Duplication.new, 'Dirty#a', 27, "calls @s.title twice", false)
+        @first = SmellWarning.new('UncommunicativeName', "Dirty", 27, "has the variable name '@s'", true)
+        @second = SmellWarning.new('Duplication', 'Dirty#a', 27, "calls @s.title twice", false)
       end
 
       it_should_behave_like 'first sorts ahead of second'
@@ -106,8 +104,8 @@ describe SmellWarning do
     end
 
     before :each do
-      @masked = SmellWarning.new(Smells::FeatureEnvy.new, 'Fred', 27, "self", true)
-      @visible = SmellWarning.new(Smells::FeatureEnvy.new, 'Fred', 27, "self", false)
+      @masked = SmellWarning.new('FeatureEnvy', 'Fred', 27, "self", true)
+      @visible = SmellWarning.new('FeatureEnvy', 'Fred', 27, "self", false)
     end
 
     it 'reports as masked when masked' do
@@ -127,25 +125,76 @@ describe SmellWarning do
 
   context 'YAML representation' do
     before :each do
-      @message = 'message'
+      @message = 'test message'
+      @lines = [24, 513]
+      @class = 'FeatureEnvy'
+      @context_name = 'Module::Class#method/block'
+      @is_active = true
       # Use a random string and a random bool
-      warning = SmellWarning.new(Smells::FeatureEnvy.new, 'Fred', 27, @message, true)
-      @yaml = warning.to_yaml
-    end
-    it 'includes the smell class' do
-      @yaml.should match(/smell:\s*FeatureEnvy/)
     end
-    it 'includes the context' do
-      @yaml.should match(/context:\s*Fred/)
-    end
-    it 'includes the message' do
-      @yaml.should match(/message:\s*#{@message}/)
+
+    shared_examples_for 'common fields' do
+      it 'includes the smell class' do
+        @yaml.should match(/class:\s*FeatureEnvy/)
+      end
+      it 'includes the context' do
+        @yaml.should match(/context:\s*#{@context_name}/)
+      end
+      it 'includes the message' do
+        @yaml.should match(/message:\s*#{@message}/)
+      end
+      it 'indicates the masking' do
+        @yaml.should match(/is_active:\s*#{@is_active}/)
+      end
+      it 'includes the line numbers' do
+        @lines.each do |line|
+          @yaml.should match(/lines:[\s\d-]*- #{line}/)
+        end
+      end
     end
-    it 'indicates the masking' do
-      @yaml.should match(/is_masked:\s*true/)
+
+    context 'with all details specified' do
+      before :each do
+        @source = 'a/ruby/source/file.rb'
+        @subclass = 'TooManyParties'
+        @parameters = {'one' => 34, 'two' => 'second'}
+        warning = SmellWarning.new(@class, @context_name, @lines, @message, @is_masked,
+          @source, @subclass, @parameters)
+        @yaml = warning.to_yaml
+      end
+
+      it_should_behave_like 'common fields'
+
+      it 'includes the subclass' do
+        @yaml.should match(/subclass:\s*#{@subclass}/)
+      end
+      it 'includes the source' do
+        @yaml.should match(/source:\s*#{@source}/)
+      end
+      it 'includes the parameters' do
+        @parameters.each do |key,value|
+          @yaml.should match(/#{key}:\s*#{value}/)
+        end
+      end
     end
-    it 'includes the line number' do
-      @yaml.should match(/line:\s*27/)
+
+    context 'with all defaults used' do
+      before :each do
+        warning = SmellWarning.new(@class, @context_name, @lines, @message, @is_masked)
+        @yaml = warning.to_yaml
+      end
+
+      it_should_behave_like 'common fields'
+
+      it 'includes no subclass' do
+        @yaml.should match(/subclass:\s*""/)
+      end
+      it 'includes no source' do
+        @yaml.should match(/source:\s*""/)
+      end
+      it 'includes empty parameters' do
+        @yaml.should_not match(/parameter/)
+      end
     end
   end
 end

data/spec/reek/smells/attribute_spec.rb

@@ -1,15 +1,20 @@
-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', 'smells', 'attribute')
+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', 'module_context')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
 
-require 'reek/smells/attribute'
-require 'reek/class_context'
-
-include Reek
+include Reek::Core
 include Reek::Smells
 
 describe Attribute do
   before :each do
-    @detector = Attribute.new
+    @source_name = 'ticker'
+    @detector = Attribute.new(@source_name)
   end
+
+  it_should_behave_like 'SmellDetector'
+
   context 'with no attributes' do
     it 'records nothing in the class' do
       ctx = ClassContext.from_s('class Fred; end')
@@ -24,7 +29,7 @@ describe Attribute do
   context 'with one attribute' do
     shared_examples_for 'one attribute found' do
       it 'records the attribute' do
-        @detector.attributes_in(@ctx).should include(:property)
+        @detector.attributes_in(@ctx).should include([:property, 1])
       end
       it 'records only that attribute' do
         @detector.attributes_in(@ctx).length.should == 1
@@ -95,4 +100,25 @@ describe Attribute do
       it_should_behave_like 'one attribute found'
     end
   end
+
+  context 'looking at the YAML' do
+    before :each do
+      @attr = 'prop'
+      src = <<EOS
+module Fred
+  attr_writer :#{@attr}
+end
+EOS
+      @ctx = ModuleContext.from_s(src)
+      @detector.examine_context(@ctx)
+      warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
+      @yaml = warning.to_yaml
+    end
+    it 'reports the attribute' do
+      @yaml.should match(/attribute:\s*#{@attr}/)
+    end
+    it 'reports the declaration line number' do
+      @yaml.should match(/lines:[\s-]*3/)
+    end
+  end
 end

data/spec/reek/smells/boolean_parameter_spec.rb

@@ -0,0 +1,76 @@
+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', 'smells', 'boolean_parameter')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
+
+include Reek::Smells
+
+describe BooleanParameter do
+  context 'parameter defaulted with boolean' do
+    context 'in a method' do
+      it 'reports a parameter defaulted to true' do
+        'def cc(arga = true) end'.should reek_of(:BooleanParameter, /arga/)
+      end
+      it 'reports a parameter defaulted to false' do
+        'def cc(arga = false) end'.should reek_of(:BooleanParameter, /arga/)
+      end
+      it 'reports two parameters defaulted to booleans' do
+        src = 'def cc(nowt, arga = true, argb = false, &blk) end'
+        src.should reek_of(:BooleanParameter, /arga/)
+        src.should reek_of(:BooleanParameter, /argb/)
+      end
+    end
+
+    context 'in a singleton method' do
+      it 'reports a parameter defaulted to true' do
+        'def self.cc(arga = true) end'.should reek_of(:BooleanParameter, /arga/)
+      end
+      it 'reports a parameter defaulted to false' do
+        'def fred.cc(arga = false) end'.should reek_of(:BooleanParameter, /arga/)
+      end
+      it 'reports two parameters defaulted to booleans' do
+        src = 'def Module.cc(nowt, arga = true, argb = false, &blk) end'
+        src.should reek_of(:BooleanParameter, /arga/)
+        src.should reek_of(:BooleanParameter, /argb/)
+      end
+    end
+  end
+end
+
+describe BooleanParameter do
+  before(:each) do
+    @source_name = 'smokin'
+    @detector = BooleanParameter.new(@source_name)
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  context 'looking at the YAML' do
+    before :each do
+      src = <<EOS
+def cc(arga = true)
+end
+EOS
+      source = src.to_reek_source
+      sniffer = Sniffer.new(source)
+      @mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+      @detector.examine(@mctx)
+      warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
+      @yaml = warning.to_yaml
+    end
+    it 'reports the source' do
+      @yaml.should match(/source:\s*#{@source_name}/)
+    end
+    it 'reports the class' do
+      @yaml.should match(/\sclass:\s*ControlCouple/)
+    end
+    it 'reports the subclass' do
+      @yaml.should match(/subclass:\s*BooleanParameter/)
+    end
+    it 'reports the parameter name' do
+      @yaml.should match(/parameter:\s*arga/)
+    end
+    it 'reports the correct line' do
+      @yaml.should match(/lines:\s*- 1/)
+    end
+  end
+end

data/spec/reek/smells/class_variable_spec.rb

@@ -1,14 +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', 'smells', 'class_variable')
+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', 'module_context')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
 
-require 'reek/smells/class_variable'
-require 'reek/class_context'
-
-include Reek
+include Reek::Core
 include Reek::Smells
 
 describe ClassVariable do
   before :each do
-    @detector = ClassVariable.new
+    @detector = ClassVariable.new('raffles')
   end
 
   context 'with no class variables' do
@@ -30,6 +31,12 @@ describe ClassVariable do
       it 'records only that class variable' do
         @detector.class_variables_in(@ctx).length.should == 1
       end
+      it 'records the variable in the YAML report' do
+        @detector.examine_context(@ctx)
+        @detector.smells_found.each do |warning|
+          warning.to_yaml.should match(/variable:[\s]*"@@tools"/)
+        end
+      end
     end
 
     context 'declared in a class' do
@@ -112,4 +119,6 @@ describe ClassVariable do
       it_should_behave_like 'one variable found'
     end
   end
+
+  it_should_behave_like 'SmellDetector'
 end

data/spec/reek/smells/control_couple_spec.rb

@@ -1,10 +1,17 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-require 'reek/smells/control_couple'
+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', 'smells', 'control_couple')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
 
 include Reek::Smells
 
 describe ControlCouple do
+  before(:each) do
+    @source_name = 'lets get married'
+    @detector = ControlCouple.new(@source_name)
+  end
+
+  it_should_behave_like 'SmellDetector'
+
   context 'conditional on a parameter' do
     it 'should report a ternary check on a parameter' do
       'def simple(arga) arga ? @ivar : 3 end'.should reek_only_of(:ControlCouple, /arga/)
@@ -20,33 +27,37 @@ describe ControlCouple do
     end
   end
 
-  context 'parameter defaulted with boolean' do
-    context 'in a method' do
-      it 'reports a parameter defaulted to true' do
-        'def cc(arga = true) end'.should reek_of(:ControlCouple, /arga/)
-      end
-      it 'reports a parameter defaulted to false' do
-        'def cc(arga = false) end'.should reek_of(:ControlCouple, /arga/)
-      end
-      it 'reports two parameters defaulted to booleans' do
-        src = 'def cc(nowt, arga = true, argb = false, &blk) end'
-        src.should reek_of(:ControlCouple, /arga/)
-        src.should reek_of(:ControlCouple, /argb/)
-      end
+  context 'looking at the YAML' do
+    before :each do
+      src = <<EOS
+def things(arg)
+  @text.map do |blk|
+    arg ? blk : "blk"
+  end
+  puts "hello" if arg
+end
+EOS
+      source = src.to_reek_source
+      sniffer = Sniffer.new(source)
+      @mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+      @detector.examine_context(@mctx)
+      warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
+      @yaml = warning.to_yaml
     end
-
-    context 'in a singleton method' do
-      it 'reports a parameter defaulted to true' do
-        'def self.cc(arga = true) end'.should reek_of(:ControlCouple, /arga/)
-      end
-      it 'reports a parameter defaulted to false' do
-        'def fred.cc(arga = false) end'.should reek_of(:ControlCouple, /arga/)
-      end
-      it 'reports two parameters defaulted to booleans' do
-        src = 'def Module.cc(nowt, arga = true, argb = false, &blk) end'
-        src.should reek_of(:ControlCouple, /arga/)
-        src.should reek_of(:ControlCouple, /argb/)
-      end
+    it 'reports the source' do
+      @yaml.should match(/source:\s*#{@source_name}/)
+    end
+    it 'reports the class' do
+      @yaml.should match(/class:\s*ControlCouple/)
+    end
+    it 'reports the subclass' do
+      @yaml.should match(/subclass:\s*ControlParameter/)
+    end
+    it 'reports the control parameter' do
+      @yaml.should match(/parameter:\s*arg/)
+    end
+    it 'reports all conditional locations' do
+      @yaml.should match(/lines:\s*- 3\s*- 6/)
     end
   end
 end