reek 1.2.6 → 1.2.8

data/spec/reek/smell_warning_spec.rb

@@ -1,33 +1,10 @@
-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
 
 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)
-      end
-
-      it 'should hash equal when the smell is the same' do
-        @first.hash.should == @second.hash
-      end
-      it 'should compare equal when the smell is the same' do
-        @first.should == @second
-      end
-      it 'should compare equal when using <=>' do
-        (@first <=> @second).should == 0
-      end
-      it 'matches using eql?' do
-        @first.should eql(@second)
-        @second.should eql(@first)
-      end
-    end
-
     shared_examples_for 'first sorts ahead of second' do
       it 'hash differently' do
         @first.hash.should_not == @second.hash
@@ -46,8 +23,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 +32,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 +41,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 +50,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,70 +59,85 @@ 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'
     end
   end
 
-  context 'masked reporting' do
-    class CountingReport
-      attr_reader :masked, :non_masked
-      def initialize
-        @masked = @non_masked = 0
+  context 'YAML representation' do
+    before :each do
+      @message = 'test message'
+      @lines = [24, 513]
+      @class = 'FeatureEnvy'
+      @context_name = 'Module::Class#method/block'
+      # Use a random string and a random bool
+    end
+
+    shared_examples_for 'common fields' do
+      it 'includes the smell class' do
+        @yaml.should match(/class:\s*FeatureEnvy/)
       end
-      def found_smell(sw)
-        @non_masked += 1
+      it 'includes the context' do
+        @yaml.should match(/context:\s*#{@context_name}/)
       end
-
-      def found_masked_smell(sw)
-        @masked += 1
+      it 'includes the message' do
+        @yaml.should match(/message:\s*#{@message}/)
+      end
+      it 'indicates the masking' do
+        @yaml.should match(/is_active:\s*true/)
+      end
+      it 'includes the line numbers' do
+        @lines.each do |line|
+          @yaml.should match(/lines:[\s\d-]*- #{line}/)
+        end
       end
     end
 
-    before :each do
-      @masked = SmellWarning.new(Smells::FeatureEnvy.new, 'Fred', 27, "self", true)
-      @visible = SmellWarning.new(Smells::FeatureEnvy.new, 'Fred', 27, "self", false)
-    end
+    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,
+          @source, @subclass, @parameters)
+        @yaml = @warning.to_yaml
+      end
 
-    it 'reports as masked when masked' do
-      rpt = CountingReport.new
-      @masked.report_on(rpt)
-      rpt.masked.should == 1
-      rpt.non_masked.should == 0
-    end
+      it_should_behave_like 'common fields'
 
-    it 'reports as non-masked when non-masked' do
-      rpt = CountingReport.new
-      @visible.report_on(rpt)
-      rpt.masked.should == 0
-      rpt.non_masked.should == 1
+      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
-  end
 
-  context 'YAML representation' do
-    before :each do
-      @message = 'message'
-      # 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}/)
-    end
-    it 'indicates the masking' do
-      @yaml.should match(/is_masked:\s*true/)
-    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)
+        @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,39 +1,58 @@
-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', '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')
-      @detector.attributes_in(ctx).should be_empty
-    end
     it 'records nothing in the module' do
-      ctx = ModuleContext.from_s('module Fred; end')
-      @detector.attributes_in(ctx).should be_empty
+      src = 'module Fred; end'
+      ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
+      @detector.examine_context(ctx).should be_empty
     end
   end
 
   context 'with one attribute' do
+    before :each do
+      @attr_name = 'super_thing'
+    end
+
     shared_examples_for 'one attribute found' do
-      it 'records the attribute' do
-        @detector.attributes_in(@ctx).should include(:property)
+      before :each do
+        ctx = CodeContext.new(nil, @src.to_reek_source.syntax_tree)
+        @smells = @detector.examine_context(ctx)
       end
+
       it 'records only that attribute' do
-        @detector.attributes_in(@ctx).length.should == 1
+        @smells.length.should == 1
+      end
+      it 'reports the attribute name' do
+        @smells[0].smell[Attribute::ATTRIBUTE_KEY].should == @attr_name
+      end
+      it 'reports the declaration line number' do
+        @smells[0].lines.should == [1]
+      end
+      it 'reports the correct smell class' do
+        @smells[0].smell_class.should == Attribute::SMELL_CLASS
+      end
+      it 'reports the context fq name' do
+        @smells[0].context.should == 'Fred'
       end
     end
 
     context 'declared in a class' do
       before :each do
-        @ctx = ClassContext.from_s('class Fred; attr :property; end')
+        @src = "class Fred; attr :#{@attr_name}; end"
       end
 
       it_should_behave_like 'one attribute found'
@@ -41,7 +60,7 @@ describe Attribute do
 
     context 'reader in a class' do
       before :each do
-        @ctx = ClassContext.from_s('class Fred; attr_reader :property; end')
+        @src = "class Fred; attr_reader :#{@attr_name}; end"
       end
 
       it_should_behave_like 'one attribute found'
@@ -49,7 +68,7 @@ describe Attribute do
 
     context 'writer in a class' do
       before :each do
-        @ctx = ClassContext.from_s('class Fred; attr_writer :property; end')
+        @src = "class Fred; attr_writer :#{@attr_name}; end"
       end
 
       it_should_behave_like 'one attribute found'
@@ -57,7 +76,7 @@ describe Attribute do
 
     context 'accessor in a class' do
       before :each do
-        @ctx = ClassContext.from_s('class Fred; attr_accessor :property; end')
+        @src = "class Fred; attr_accessor :#{@attr_name}; end"
       end
 
       it_should_behave_like 'one attribute found'
@@ -65,7 +84,7 @@ describe Attribute do
 
     context 'declared in a module' do
       before :each do
-        @ctx = ModuleContext.from_s('module Fred; attr :property; end')
+        @src = "module Fred; attr :#{@attr_name}; end"
       end
 
       it_should_behave_like 'one attribute found'
@@ -73,7 +92,7 @@ describe Attribute do
 
     context 'reader in a module' do
       before :each do
-        @ctx = ModuleContext.from_s('module Fred; attr_reader :property; end')
+        @src = "module Fred; attr_reader :#{@attr_name}; end"
       end
 
       it_should_behave_like 'one attribute found'
@@ -81,7 +100,7 @@ describe Attribute do
 
     context 'writer in a module' do
       before :each do
-        @ctx = ModuleContext.from_s('module Fred; attr_writer :property; end')
+        @src = "module Fred; attr_writer :#{@attr_name}; end"
       end
 
       it_should_behave_like 'one attribute found'
@@ -89,7 +108,7 @@ describe Attribute do
 
     context 'accessor in a module' do
       before :each do
-        @ctx = ModuleContext.from_s('module Fred; attr_accessor :property; end')
+        @src = "module Fred; attr_accessor :#{@attr_name}; end"
       end
 
       it_should_behave_like 'one attribute found'

data/spec/reek/smells/behaves_like_variable_detector.rb

@@ -2,7 +2,7 @@ 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
+      @detector.smells_found.length.should == 0
     end
   end
 
@@ -14,7 +14,7 @@ shared_examples_for 'a variable detector' do
     end
 
     it 'records only one smell' do
-      @detector.num_smells.should == 1
+      @detector.smells_found.length.should == 1
     end
     it 'mentions the variable name in the report' do
       @detector.should have_smell([/something/])

data/spec/reek/smells/boolean_parameter_spec.rb

@@ -0,0 +1,66 @@
+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
+        src = 'def cc(arga = true) end'
+        src.should smell_of(BooleanParameter, BooleanParameter::PARAMETER_KEY => 'arga')
+      end
+      it 'reports a parameter defaulted to false' do
+        src = 'def cc(arga = false) end'
+        src.should smell_of(BooleanParameter, BooleanParameter::PARAMETER_KEY => 'arga')
+      end
+      it 'reports two parameters defaulted to booleans' do
+        src = 'def cc(nowt, arga = true, argb = false, &blk) end'
+        src.should smell_of(BooleanParameter,
+          {BooleanParameter::PARAMETER_KEY => 'arga'},
+          {BooleanParameter::PARAMETER_KEY => 'argb'})
+      end
+    end
+
+    context 'in a singleton method' do
+      it 'reports a parameter defaulted to true' do
+        src = 'def self.cc(arga = true) end'
+        src.should smell_of(BooleanParameter, BooleanParameter::PARAMETER_KEY => 'arga')
+      end
+      it 'reports a parameter defaulted to false' do
+        src = 'def fred.cc(arga = false) end'
+        src.should smell_of(BooleanParameter, BooleanParameter::PARAMETER_KEY => 'arga')
+      end
+      it 'reports two parameters defaulted to booleans' do
+        src = 'def Module.cc(nowt, arga = true, argb = false, &blk) end'
+        src.should smell_of(BooleanParameter,
+          {BooleanParameter::PARAMETER_KEY => 'arga'},
+          {BooleanParameter::PARAMETER_KEY => 'argb'})
+      end
+    end
+  end
+
+  context 'when a smell is reported' do
+    before(:each) do
+      @source_name = 'smokin'
+      @detector = BooleanParameter.new(@source_name)
+    end
+
+    it_should_behave_like 'SmellDetector'
+
+    it 'reports the fields correctly' do
+      src = 'def cc(arga = true) end'
+      ctx = MethodContext.new(nil, src.to_reek_source.syntax_tree)
+      @detector.examine(ctx)
+      smells = @detector.smells_found.to_a
+      smells.length.should == 1
+      smells[0].smell_class.should == BooleanParameter::SMELL_CLASS
+      smells[0].smell[BooleanParameter::PARAMETER_KEY].should == 'arga'
+      smells[0].source.should == @source_name
+      smells[0].smell_class.should == BooleanParameter::SMELL_CLASS
+      smells[0].subclass.should == BooleanParameter::SMELL_SUBCLASS
+      smells[0].lines.should == [1]
+    end
+  end
+end

data/spec/reek/smells/class_variable_spec.rb

@@ -1,115 +1,100 @@
-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', '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
+    @source_name = 'raffles'
+    @detector = ClassVariable.new(@source_name)
+    @class_variable = '@@things'
   end
 
+  it_should_behave_like 'SmellDetector'
+
   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
+      exp = ast(:class, :Fred)
+      @detector.examine_context(CodeContext.new(nil, exp)).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
+      exp = ast(:module, :Fred)
+      @detector.examine_context(CodeContext.new(nil, exp)).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)
+      before :each do
+        ast = @src.to_reek_source.syntax_tree
+        @smells = @detector.examine_context(CodeContext.new(nil, ast))
       end
       it 'records only that class variable' do
-        @detector.class_variables_in(@ctx).length.should == 1
+        @smells.length.should == 1
       end
-    end
-
-    context 'declared in a class' do
-      before :each do
-        @ctx = ClassContext.from_s('class Fred; @@tools = {}; end')
+      it 'records the variable name' do
+        @smells[0].smell[ClassVariable::VARIABLE_KEY].should == @class_variable
       end
-
-      it_should_behave_like 'one variable found'
     end
 
-    context 'used in a class' do
-      before :each do
-        @ctx = ClassContext.from_s('class Fred; def jim() @@tools = {}; end; end')
-      end
+    ['class', 'module'].each do |scope|
+      context "declared in a #{scope}" do
+        before :each do
+          @src = "#{scope} Fred; #{@class_variable} = {}; end"
+        end
 
-      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')
+        it_should_behave_like 'one variable found'
       end
 
-      it_should_behave_like 'one variable found'
-    end
+      context "used in a #{scope}" do
+        before :each do
+          @src = "#{scope} Fred; def jim() #{@class_variable} = {}; end; end"
+        end
 
-    context 'declared and used in a class' do
-      before :each do
-        @ctx = ClassContext.from_s('class Fred; @@tools = {}; def jim() @@tools = {}; end; end')
+        it_should_behave_like 'one variable found'
       end
 
-      it_should_behave_like 'one variable found'
-    end
+      context "indexed in a #{scope}" do
+        before :each do
+          @src = "#{scope} Fred; def jim() #{@class_variable}[mash] = {}; end; end"
+        end
 
-    context 'used twice in a class' do
-      before :each do
-        @ctx = ClassContext.from_s('class Fred; def jeff() @@tools = {}; end; def jim() @@tools = {}; end; end')
+        it_should_behave_like 'one variable found'
       end
 
-      it_should_behave_like 'one variable found'
-    end
+      context "declared and used in a #{scope}" do
+        before :each do
+          @src = "#{scope} Fred; #{@class_variable} = {}; def jim() #{@class_variable} = {}; end; end"
+        end
 
-    context 'declared in a module' do
-      before :each do
-        @ctx = ClassContext.from_s('module Fred; @@tools = {}; end')
+        it_should_behave_like 'one variable found'
       end
 
-      it_should_behave_like 'one variable found'
-    end
+      context "used twice in a #{scope}" do
+        before :each do
+          @src = "#{scope} Fred; def jeff() #{@class_variable} = {}; end; def jim() #{@class_variable} = {}; end; end"
+        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
-
-    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
-
-    context 'declared and used in a module' do
-      before :each do
-        @ctx = ClassContext.from_s('module Fred; @@tools = {}; def jim() @@tools = {}; end; end')
+        it_should_behave_like 'one variable found'
       end
-
-      it_should_behave_like 'one variable found'
     end
+  end
 
-    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
+  it 'reports the correct fields' do
+    src = <<EOS
+module Fred
+  #{@class_variable} = {}
+end
+EOS
+    ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
+    @warning = @detector.examine_context(ctx)[0]
+    @warning.source.should == @source_name
+    @warning.smell_class.should == ClassVariable::SMELL_CLASS
+    @warning.subclass.should == ClassVariable::SMELL_SUBCLASS
+    @warning.smell[ClassVariable::VARIABLE_KEY].should == @class_variable
+    @warning.lines.should == [2]
   end
 end