reek 1.1.3 → 1.2.0

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -1,8 +1,6 @@
 require File.dirname(__FILE__) + '/../../spec_helper.rb'
 
-require 'reek/code_parser'
 require 'reek/smells/long_parameter_list'
-require 'reek/report'
 
 include Reek
 include Reek::Smells
@@ -63,6 +61,7 @@ describe LongParameterList do
       end
 
       it 'should only report long param list' do
+        pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
         InnerTest.should reek_only_of(:LongParameterList, /abc/)
       end
     end

data/spec/reek/smells/simulated_polymorphism_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/smells/simulated_polymorphism'
+
+include Reek::Smells
+
+describe SimulatedPolymorphism do
+  it 'should report 3 similar conditions 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
+
+    src.should reek_only_of(:SimulatedPolymorphism, /@field == :sym/)
+  end
+
+  it 'should include case statements in the count' do
+    src = <<EOS
+class Scrunch
+  def first
+    return @field ? 0 : 3;
+  end
+  def second
+    case @field
+    when :sym
+      @other += " quarts"
+    end
+  end
+  def third
+    raise 'flu!' unless @field
+  end
+end
+EOS
+
+    src.should reek_only_of(:SimulatedPolymorphism, /@field/)
+  end
+
+  # And count code in superclasses, if we have it
+end

data/spec/reek/smells/smell_detector_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/configuration'
+require 'reek/smells/duplication'
+require 'reek/smells/large_class'
+require 'reek/smells/long_method'
+
+include Reek
+include Reek::Smells
+
+describe SmellDetector, 'configuration' do
+  before:each do
+    @detector = LongMethod.new
+  end
+
+  it 'adopts new max_statements value' do
+    @detector.configure_with(LongMethod::MAX_ALLOWED_STATEMENTS_KEY => 25)
+    @detector.value(LongMethod::MAX_ALLOWED_STATEMENTS_KEY, nil, 0).should == 25
+  end
+end
+
+describe SmellDetector, 'when copied' do
+  before :each do
+    @detector = LongMethod.new
+    @copy = @detector.copy
+  end
+
+  it 'should have the same state' do
+    @copy.max_statements.should == @detector.max_statements
+  end
+
+  it 'should change independently of its parent' do
+    default_max = @detector.max_statements
+    @copy.configure_with(LongMethod::MAX_ALLOWED_STATEMENTS_KEY => 25)
+    @detector.max_statements.should == default_max
+  end
+end
+
+describe SmellDetector, 'configuration' do
+#  it 'stays enabled when not disabled' do
+#    @detector = LargeClass.new
+#    @detector.should be_enabled
+#    @detector.configure({'LargeClass' => {'max_methods' => 50}})
+#    @detector.should be_enabled
+#  end
+
+  it 'becomes disabled when disabled' do
+    @detector = LargeClass.new
+    @detector.should be_enabled
+    @detector.configure({'LargeClass' => {SmellConfiguration::ENABLED_KEY => false}})
+    @detector.should_not be_enabled
+  end
+end

data/spec/reek/smells/uncommunicative_name_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../../spec_helper.rb'
-require 'ostruct'
+
 require 'reek/method_context'
 require 'reek/smells/uncommunicative_name'
 
@@ -16,6 +16,9 @@ describe UncommunicativeName, "method name" do
   it 'should report name of the form "x2"' do
     'def x2(fred) basics(17) end'.should reek_only_of(:UncommunicativeName, /x2/)
   end
+  it 'should report long name ending in a number' do
+    'def method2(fred) basics(17) end'.should reek_only_of(:UncommunicativeName, /method2/)
+  end
 end
 
 describe UncommunicativeName, "field name" do
@@ -28,6 +31,9 @@ describe UncommunicativeName, "field name" do
   it 'should report name of the form "x2"' do
     'class Thing; def simple(fred) @x2 end end'.should reek_only_of(:UncommunicativeName, /@x2/, /Thing/, /variable name/)
   end
+  it 'should report long name ending in a number' do
+    'class Thing; def simple(fred) @field12 end end'.should reek_only_of(:UncommunicativeName, /@field12/, /Thing/, /variable name/)
+  end
   it 'should report one-letter fieldname in assignment' do
     'class Thing; def simple(fred) @x = fred end end'.should reek_only_of(:UncommunicativeName, /@x/, /Thing/, /variable name/)
   end
@@ -43,6 +49,9 @@ describe UncommunicativeName, "local variable name" do
   it 'should report name of the form "x2"' do
     'def simple(fred) x2 = jim(45) end'.should reek_only_of(:UncommunicativeName, /x2/, /variable name/)
   end
+  it 'should report long name ending in a number' do
+    'def simple(fred) var123 = jim(45) end'.should reek_only_of(:UncommunicativeName, /var123/, /variable name/)
+  end
   it 'should report variable name only once' do
     'def simple(fred) x = jim(45); x = y end'.should reek_only_of(:UncommunicativeName, /x/)
   end
@@ -63,6 +72,9 @@ describe UncommunicativeName, "parameter name" do
   it 'should report name of the form "x2"' do
     'def help(x2) basics(17) end'.should reek_only_of(:UncommunicativeName, /x2/, /variable name/)
   end
+  it 'should report long name ending in a number' do
+    'def help(param1) basics(17) end'.should reek_only_of(:UncommunicativeName, /param1/, /variable name/)
+  end
 end
 
 describe UncommunicativeName, "block parameter name" do
@@ -78,6 +90,7 @@ def bad
   end
 end
 EOS
+
     src.should reek_only_of(:UncommunicativeName, /'x'/)
   end
 end
@@ -85,7 +98,7 @@ end
 describe UncommunicativeName, "several names" do
 
   it 'should report all bad names' do
-    ruby = Source.from_s('class Oof; def y(x) @z = x end end')
+    ruby = 'class Oof; def y(x) @z = x end end'.sniff
     ruby.should reek_of(:UncommunicativeName, /'x'/)
     ruby.should reek_of(:UncommunicativeName, /'y'/)
     ruby.should reek_of(:UncommunicativeName, /'@z'/)
@@ -100,6 +113,7 @@ class Thing
   end
 end
 EOS
+
     source.should reek_of(:UncommunicativeName, /'x'/)
     source.should reek_of(:UncommunicativeName, /'y'/)
   end
@@ -107,17 +121,16 @@ end
 
 describe UncommunicativeName, '#examine' do
   before :each do
-    @report = Report.new
     @uc = UncommunicativeName.new
   end
   
   it 'should return true when reporting a smell' do
-    mc = MethodContext.new(StopContext.new, [:defn, :x, nil])
-    @uc.examine(mc, @report).should == true
+    mc = MethodContext.new(StopContext.new, s(:defn, :x, s(:args)))
+    @uc.examine(mc).should == true
   end
   
   it 'should return false when not reporting a smell' do
-    mc = MethodContext.new(StopContext.new, [:defn, :not_bad, nil])
-    @uc.examine(mc, @report).should == false
+    mc = MethodContext.new(StopContext.new, s(:defn, :not_bad, s(:args)))
+    @uc.examine(mc).should == false
   end
 end

data/spec/reek/smells/utility_function_spec.rb

@@ -6,88 +6,97 @@ include Reek
 include Reek::Smells
 
 describe UtilityFunction do
-
-  it 'should not report attrset' do
-    class Fred
-      attr_writer :xyz
+  context 'with no calls' do
+    it 'does not report empty method' do
+      'def simple(arga) end'.should_not reek
+    end
+    it 'does not report literal' do
+      'def simple(arga) 3; end'.should_not reek
+    end
+    it 'does not report instance variable reference' do
+      'def simple(arga) @yellow end'.should_not reek
+    end
+    it 'does not report vcall' do
+      'def simple(arga) y end'.should_not reek
+    end
+    it 'does not report references to self' do
+      'def into; self; end'.should_not reek
+    end
+    it 'recognises an ivar reference within a block' do
+      'def clean(text) text.each { @fred = 3} end'.should_not reek
     end
-    Fred.should_not reek
   end
 
-  it 'should count usages of self'do
-    'def <=>(other) Options[:sort_order].compare(self, other) end'.should_not reek
-  end
-  it 'should count self reference within a dstr' do
-    'def as(alias_name); "#{self} as #{alias_name}".to_sym; end'.should_not reek
-  end
-  it 'should count calls to self within a dstr' do
-    'def to_sql; "\'#{self.gsub(/\'/, "\'\'")}\'"; end'.should_not reek
-  end
-  it 'should report simple parameter call' do
-    'def simple(arga) arga.to_s end'.should reek_of(:UtilityFunction, /simple/)
-  end
-  it 'should report message chain' do
-    'def simple(arga) arga.b.c end'.should reek_of(:UtilityFunction, /simple/)
-  end
-  
-  it 'should not report overriding methods' do
-    class Father
-      def thing(ff); @kids = 0; end
+  context 'with only one call' do
+    it 'does not report a call to a parameter' do
+      'def simple(arga)
+         arga.to_s
+       end'.should_not reek_of(:UtilityFunction, /simple/)
     end
-    class Son < Father
-      def thing(ff); ff; end
+    it 'does not report a call to a constant' do
+      'def simple(arga)
+         FIELDS[arga]
+       end'.should_not reek
     end
-    Son.should_not reek
   end
 
-  it 'should not report class method' do
-    pending('bug')
-    source = <<EOS
-class Cache
-  class << self
-    def create_unless_known(attributes)
-      Cache.create(attributes) unless Cache.known?
+  context 'with two or more calls' do
+    it 'reports two calls' do
+      'def simple(arga)
+         arga.to_s + arga.to_i
+       end'.should reek_of(:UtilityFunction, /simple/)
+    end
+    it 'should count usages of self'do
+      'def <=>(other) Options[:sort_order].compare(self, other) end'.should_not reek
+    end
+    it 'should count self reference within a dstr' do
+      'def as(alias_name); "#{self} as #{alias_name}".to_sym; end'.should_not reek
+    end
+    it 'should count calls to self within a dstr' do
+      'def to_sql; "\'#{self.gsub(/\'/, "\'\'")}\'"; end'.should_not reek
+    end
+    it 'should report message chain' do
+      'def simple(arga) arga.b.c end'.should reek_of(:UtilityFunction, /simple/)
+    end
+
+    it 'does not report a method that calls super' do
+      'def child(arg) super; arg.to_s; end'.should_not reek
     end
-  end
-end
-EOS
-    source.should_not reek
-  end
-  
-  it 'should recognise a deep call' do
-    src = <<EOS
-class Red
-  def deep(text)
-    text.each { |mod| atts = shelve(mod) }
-  end
 
-  def shelve(val)
-    @shelf << val
+    it 'should recognise a deep call' do
+      src = <<EOS
+  class Red
+    def deep(text)
+      text.each { |mod| atts = shelve(mod) }
+    end
+
+    def shelve(val)
+      @shelf << val
+    end
   end
-end
 EOS
-    src.should_not reek
+      src.should_not reek
+    end
   end
 end
 
-describe UtilityFunction, 'should only report a method containing a call' do
-  it 'should not report empty method' do
-    'def simple(arga) end'.should_not reek
-  end
-  it 'should not report literal' do
-    'def simple(arga) 3; end'.should_not reek
-  end
-  it 'should not report instance variable reference' do
-    'def simple(arga) @yellow end'.should_not reek
-  end
-  it 'should not report vcall' do
-    'def simple(arga) y end'.should_not reek
-  end
-  it 'should not report references to self' do
-    'def into; self; end'.should_not reek
+describe UtilityFunction do
+  it 'should not report attrset' do
+    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
+    class Fred
+      attr_writer :xyz
+    end
+    Fred.should_not reek
   end
 
-  it 'should recognise an ivar reference within a block' do
-    'def clean(text) text.each { @fred = 3} end'.should_not reek
+  it 'should not report overriding methods' do
+    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
+    class Father
+      def thing(ff); @kids = 0; end
+    end
+    class Son < Father
+      def thing(ff); ff; end
+    end
+    Son.should_not reek
   end
 end

data/spec/reek/sniffer_spec.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+include Reek
+
+describe Sniffer do
+  it 'detects smells in a file' do
+    dirty_file = Dir['spec/samples/two_smelly_files/*.rb'][0]
+    File.new(dirty_file).sniff.should be_smelly
+  end
+end

data/spec/samples/all_but_one_masked/clean_one.rb

@@ -0,0 +1,6 @@
+class Clean
+  def assign
+    puts @sub.title
+    @sub.map {|para| para.name }
+  end
+end

data/spec/samples/all_but_one_masked/dirty.rb

@@ -0,0 +1,7 @@
+class Dirty
+  def a
+    puts @s.title
+    @s.map {|x| x.each {|key| key += 3}}
+    puts @s.title
+  end
+end

data/spec/samples/all_but_one_masked/masked.reek

@@ -0,0 +1,5 @@
+---
+Duplication:
+  enabled: false
+UncommunicativeName:
+  enabled: false

data/spec/samples/clean_due_to_masking/clean_one.rb

@@ -0,0 +1,6 @@
+class Clean
+  def assign
+    puts @sub.title
+    @sub.map {|para| para.name }
+  end
+end

data/spec/samples/clean_due_to_masking/clean_three.rb

@@ -0,0 +1,6 @@
+class Clean
+  def assign
+    puts @sub.title
+    @sub.map {|para| para.name }
+  end
+end

data/spec/samples/clean_due_to_masking/clean_two.rb

@@ -0,0 +1,6 @@
+class Clean
+  def assign
+    puts @sub.title
+    @sub.map {|para| para.name }
+  end
+end

data/spec/samples/clean_due_to_masking/dirty_one.rb

@@ -0,0 +1,7 @@
+class Dirty
+  def a
+    puts @s.title
+    @s.map {|x| x.each {|key| key += 3}}
+    puts @s.title
+  end
+end