reek 1.2.7.2 → 1.2.7.3

data/spec/reek/smells/attribute_spec.rb

@@ -1,6 +1,5 @@
 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')
 
@@ -16,13 +15,11 @@ describe Attribute do
   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)
+      @detector.smells_found.should be_empty
     end
   end
 

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/class_variable_spec.rb

@@ -1,6 +1,5 @@
 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')
 

data/spec/reek/smells/control_couple_spec.rb

@@ -39,25 +39,18 @@ 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
-    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/)
+      mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+      @detector.examine_context(mctx)
+      @warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
     end
+
+    it_should_behave_like 'common fields set correctly'
+
     it 'reports the control parameter' do
-      @yaml.should match(/parameter:\s*arg/)
+      @warning.smell['parameter'].should == 'arg'
     end
     it 'reports all conditional locations' do
-      @yaml.should match(/lines:\s*- 3\s*- 6/)
+      @warning.lines.should == [3,6]
     end
   end
 end

data/spec/reek/smells/data_clump_spec.rb

@@ -28,7 +28,7 @@ EOS
   def third(pa, pb) pa - pb + @fred; end
 end
 EOS
-      ctx = ModuleContext.from_s(@src)
+      ctx = CodeContext.new(nil, @src.to_reek_source.syntax_tree)
       detector = DataClump.new('newt')
       detector.examine(ctx)
       @smells = detector.smells_found.to_a
@@ -139,4 +139,88 @@ describe DataClump do
   end
 
   it_should_behave_like 'SmellDetector'
+
+  it 'get a real example right' do
+    src = <<-EOS
+module Inline
+  def generate(src, options) end
+  def c (src, options) end
+  def c_singleton (src, options) end
+  def c_raw (src, options) end
+  def c_raw_singleton (src, options) end
 end
+EOS
+    ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
+    detector = DataClump.new('newt')
+    detector.examine(ctx)
+    smells = detector.smells_found.to_a
+    smells.length.should == 1
+    warning = smells[0]
+    warning.smell[DataClump::OCCURRENCES_KEY].should == 5
+  end
+end
+
+#---------------------------------------------------------------------------------
+#
+#def occurrences(potential_clump, all_methods)
+#  all_methods.select do |method|
+#    potential_clump - method == []
+#  end.length
+#end
+#
+#describe 'occurrences' do
+#  it 'counts correctly' do
+#    params = [[:a1, :a2], [:a1, :a2]]
+#    potential_clump = [:a1, :a2]
+#    occurrences(potential_clump, params).should == 2
+#  end
+#end
+#
+#def immediate_clumps(root, other_params, all_methods)
+#  result = []
+#  other_params.map do |param|
+#    potential_clump = (root + [param])
+#    if occurrences(potential_clump, all_methods) >= 2
+#      result << potential_clump
+#      result = result + immediate_clumps(potential_clump, other_params - [param], all_methods)
+#    end
+#  end.compact
+#  result
+#end
+#
+#def clumps_containing(root, other_params, all_methods)
+#  return [] unless other_params
+#  immediate_clumps(root, other_params, all_methods) + clumps_containing([other_params[0]], other_params[1..-1], all_methods)
+#end
+#
+#def clumps_in(all_methods)
+#  all_params = all_methods.flatten.sort {|a,b| a.to_s <=> b.to_s}.uniq
+#  clumps_containing([all_params[0]], all_params[1..-1], all_methods)
+#end
+#
+#describe 'set of parameters' do
+#  it 'finds the trivial clump' do
+#    params = [[:a1, :a2], [:a1, :a2]]
+#    clumps_in(params).should == [[:a1, :a2]]
+#  end
+#
+#  it 'finds the trivial size-3 clump' do
+#    params = [[:a1, :a2, :a3], [:a1, :a2, :a3]]
+#    clumps_in(params).should == [[:a1, :a2, :a3]]
+#  end
+#
+#  it 'doesnt find non clump' do
+#    params = [[:a1, :a2], [:a1, :a3]]
+#    clumps_in(params).should == []
+#  end
+#
+#  it 'finds the trivial sub-clump' do
+#    params = [[:a1, :a2], [:a3, :a1, :a2]]
+#    clumps_in(params).should == [[:a1, :a2]]
+#  end
+#
+#  it 'finds the non-a1 clump' do
+#    params = [[:a1, :a3, :a2], [:a3, :a2]]
+#    clumps_in(params).should == [[:a2, :a3]]
+#  end
+#end

data/spec/reek/smells/duplication_spec.rb

@@ -62,7 +62,7 @@ describe Duplication do
 
   it_should_behave_like 'SmellDetector'
 
-  context 'looking at the YAML' do
+  context 'when a smell is reported' do
     before :each do
       src = <<EOS
 def double_thing(other)
@@ -75,23 +75,22 @@ EOS
       sniffer = Core::Sniffer.new(source)
       @mctx = Core::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
+      @warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
     end
     it 'reports the source' do
-      @yaml.should match(/source:\s*#{@source_name}/)
+      @warning.source.should == @source_name
     end
     it 'reports the class' do
-      @yaml.should match(/class:\s*Duplication/)
+      @warning.smell_class.should == 'Duplication'
     end
     it 'reports the subclass' do
-      @yaml.should match(/subclass:\s*DuplicateMethodCall/)
+      @warning.subclass.should == 'DuplicateMethodCall'
     end
     it 'reports the call' do
-      @yaml.should match(/call:\s*other\[\@thing\]/)
+      @warning.smell['call'].should == 'other[@thing]'
     end
     it 'reports the correct lines' do
-      @yaml.should match(/lines:\s*- 2\s*- 4/)
+      @warning.lines.should == [2,4]
     end
   end
 end

data/spec/reek/smells/feature_envy_spec.rb

@@ -73,36 +73,6 @@ EOS
     end
   end
 
-  context 'when an envious receiver exists' do
-    before :each do
-      @source_name = 'green as a cucumber'
-      @receiver = 'blah'
-      @ctx = mock('method_context', :null_object => true)
-      @ctx.should_receive(:envious_receivers).and_return({ast(:lvar, @receiver) => 4})
-      @detector = FeatureEnvy.new(@source_name)
-      @detector.examine_context(@ctx)
-      @smells = @detector.smells_found.to_a
-    end
-    it 'reports only that smell' do
-      @smells.length.should == 1
-    end
-    it 'reports the source' do
-      @smells[0].source.should == @source_name
-    end
-    it 'reports the class' do
-      @smells[0].smell_class.should == FeatureEnvy::SMELL_CLASS
-    end
-    it 'reports the subclass' do
-      @smells[0].subclass.should == FeatureEnvy::SMELL_SUBCLASS
-    end
-    it 'reports the envious receiver' do
-      @smells[0].smell[FeatureEnvy::RECEIVER_KEY].should == @receiver
-    end
-    it 'reports the number of references' do
-      @smells[0].smell[FeatureEnvy::REFERENCES_KEY].should == 4
-    end
-  end
-
   it 'should report highest affinity' do
     src = <<EOS
 def total_envy
@@ -186,8 +156,8 @@ EOS
   it 'interprets << correctly' do
     ruby = <<EOS
 def report_on(report)
-  if @is_masked
-    report.record_masked_smell(self)
+  if @is_doubled
+    report.record_doubled_smell(self)
   else
     report << self
   end

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -66,7 +66,7 @@ describe LongParameterList do
 
   it_should_behave_like 'SmellDetector'
 
-  context 'looking at the YAML' do
+  context 'when a smell is reported' do
     before :each do
       src = <<EOS
 def badguy(arga, argb, argc, argd)
@@ -76,26 +76,19 @@ 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
-    it 'reports the source' do
-      @yaml.should match(/source:\s*#{@source_name}/)
-    end
-    it 'reports the class' do
-      @yaml.should match(/\sclass:\s*LongParameterList/)
-    end
-    it 'reports the subclass' do
-      @yaml.should match(/subclass:\s*LongParameterList/)
+      mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+      @detector.examine_context(mctx)
+      @warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
     end
+
+    it_should_behave_like 'common fields set correctly'
+
     it 'reports the number of parameters' do
-      @yaml.should match(/parameter_count:[\s]*#{@num_parameters}/)
+      @warning.smell['parameter_count'].should == 4
       # SMELL: many tests duplicate the names of the YAML fields
     end
     it 'reports the line number of the method' do
-      @yaml.should match(/lines:\s*- 1/)
+      @warning.lines.should == [1]
     end
   end
 end

data/spec/reek/smells/long_yield_list_spec.rb

@@ -40,26 +40,19 @@ def simple(arga, argb, &blk)
 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
-    it 'reports the source' do
-      @yaml.should match(/source:\s*#{@source_name}/)
-    end
-    it 'reports the class' do
-      @yaml.should match(/class:\s*LongParameterList/)
-    end
-    it 'reports the subclass' do
-      @yaml.should match(/subclass:\s*LongYieldList/)
+      mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+      @detector.examine_context(mctx)
+      @warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
     end
+
+    it_should_behave_like 'common fields set correctly'
+
     it 'reports the number of parameters' do
-      @yaml.should match(/parameter_count:[\s]*#{@num_parameters}/)
+      @warning.smell['parameter_count'].should == 4
       # SMELL: many tests duplicate the names of the YAML fields
     end
     it 'reports the line number of the method' do
-      @yaml.should match(/lines:\s*- 3/)
+      @warning.lines.should == [3]
     end
   end
 end

data/spec/reek/smells/smell_detector_shared.rb

@@ -26,3 +26,15 @@ shared_examples_for 'SmellDetector' do
     end
   end
 end
+
+shared_examples_for 'common fields set correctly' do
+  it 'reports the source' do
+    @warning.source.should == @source_name
+  end
+  it 'reports the class' do
+    @warning.smell_class.should == @detector.class::SMELL_CLASS
+  end
+  it 'reports the subclass' do
+    @warning.subclass.should == @detector.class::SMELL_SUBCLASS
+  end
+end

data/spec/reek/smells/uncommunicative_variable_name_spec.rb

@@ -78,7 +78,7 @@ EOS
     end
   end
 
-  context 'looking at the YAML' do
+  context 'when a smell is reported' do
     before :each do
       src = <<EOS
 def bad
@@ -91,25 +91,24 @@ end
 EOS
       source = src.to_reek_source
       sniffer = Core::Sniffer.new(source)
-      @mctx = Core::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
+      mctx = Core::CodeParser.new(sniffer).process_defn(source.syntax_tree)
+      @detector.examine(mctx)
+      @warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
     end
     it 'reports the source' do
-      @yaml.should match(/source:\s*#{@source_name}/)
+      @warning.source.should == @source_name
     end
     it 'reports the class' do
-      @yaml.should match(/class:\s*UncommunicativeName/)
+      @warning.smell_class.should == 'UncommunicativeName'
     end
     it 'reports the subclass' do
-      @yaml.should match(/subclass:\s*UncommunicativeVariableName/)
+      @warning.subclass.should == 'UncommunicativeVariableName'
     end
     it 'reports the variable name' do
-      @yaml.should match(/variable_name:\s*x2/)
+      @warning.smell['variable_name'].should == 'x2'
     end
     it 'reports all line numbers' do
-      @yaml.should match(/lines:\s*- 3\s*- 5/)
+      @warning.lines.should == [3,5]
     end
   end
 

data/spec/reek/smells/utility_function_spec.rb

@@ -51,6 +51,9 @@ class Object; def is_maybe?() false end end'.should_not reek
     it 'reports two calls' do
       'def simple(arga) arga.to_s + arga.to_i end'.should reek_of(:UtilityFunction, /simple/)
     end
+    it 'counts a local call in a param initializer' do
+      'def simple(arga=local) arga.to_s end'.should_not reek_of(:UtilityFunction)
+    end
     it 'should count usages of self'do
       'def <=>(other) Options[:sort_order].compare(self, other) end'.should_not reek
     end
@@ -94,7 +97,7 @@ describe UtilityFunction do
 
   it_should_behave_like 'SmellDetector'
 
-  context 'looking at the YAML' do
+  context 'when a smells is reported' do
     before :each do
       src = <<EOS
 def simple(arga)
@@ -103,22 +106,15 @@ 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
-    it 'reports the source' do
-      @yaml.should match(/source:\s*#{@source_name}/)
-    end
-    it 'reports the class' do
-      @yaml.should match(/\sclass:\s*LowCohesion/)
-    end
-    it 'reports the subclass' do
-      @yaml.should match(/subclass:\s*UtilityFunction/)
+      mctx = CodeParser.new(sniffer).process_defn(source.syntax_tree)
+      @detector.examine_context(mctx)
+      @warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
     end
+
+    it_should_behave_like 'common fields set correctly'
+
     it 'reports the line number of the method' do
-      @yaml.should match(/lines:\s*- 1/)
+      @warning.lines.should == [1]
     end
   end
 end