kevinrutherford-reek 0.3.1.4

data/spec/reek/smells/uncommunicative_name_spec.rb

@@ -0,0 +1,118 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+require 'ostruct'
+require 'reek/method_context'
+require 'reek/smells/uncommunicative_name'
+
+include Reek
+include Reek::Smells
+
+describe UncommunicativeName, "method name" do
+  it 'should not report one-word method name' do
+    'def help(fred) basics(17) end'.should_not reek
+  end
+  it 'should report one-letter method name' do
+    'def x(fred) basics(17) end'.should reek_only_of(:UncommunicativeName, /x/)
+  end
+  it 'should report name of the form "x2"' do
+    'def x2(fred) basics(17) end'.should reek_only_of(:UncommunicativeName, /x2/)
+  end
+end
+
+describe UncommunicativeName, "field name" do
+  it 'should not report one-word field name' do
+    'class Thing; def help(fred) @simple end end'.should_not reek
+  end
+  it 'should report one-letter fieldname' do
+    'class Thing; def simple(fred) @x end end'.should reek_only_of(:UncommunicativeName, /@x/, /Thing/, /variable name/)
+  end
+  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 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
+end
+
+describe UncommunicativeName, "local variable name" do
+  it 'should not report one-word variable name' do
+    'def help(fred) simple = jim(45) end'.should_not reek
+  end
+  it 'should report one-letter variable name' do
+    'def simple(fred) x = jim(45) end'.should reek_only_of(:UncommunicativeName, /x/, /variable name/)
+  end
+  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 variable name only once' do
+    'def simple(fred) x = jim(45); x = y end'.should reek_only_of(:UncommunicativeName, /x/)
+  end
+end
+
+describe UncommunicativeName, "parameter name" do
+  it 'should not recognise *' do
+    'def help(xray, *) basics(17) end'.should_not reek
+  end
+  it "should report parameter's name" do
+    'def help(x) basics(17) end'.should reek_only_of(:UncommunicativeName, /x/, /variable name/)
+  end
+  it 'should report name of the form "x2"' do
+    'def help(x2) basics(17) end'.should reek_only_of(:UncommunicativeName, /x2/, /variable name/)
+  end
+end
+
+describe UncommunicativeName, "block parameter name" do
+  it "should report parameter's name" do
+    'def help() @stuff.each {|x|} end'.should reek_only_of(:UncommunicativeName, /x/, /block/, /variable name/)
+  end
+  
+  it "should report method name via if context" do
+    src = <<EOS
+def bad
+  unless @mod then
+    @sig.each { |x| x.to_s }
+  end
+end
+EOS
+    src.should reek_only_of(:UncommunicativeName, /'x'/)
+  end
+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.should reek_of(:UncommunicativeName, /'x'/)
+    ruby.should reek_of(:UncommunicativeName, /'y'/)
+    ruby.should reek_of(:UncommunicativeName, /'@z'/)
+  end
+
+  it 'should report all bad block parameters' do
+    source =<<EOS
+class Thing
+  def bad(fred)
+    @fred.each {|x| 4 - x }
+    @jim.each {|y| y - 4 }
+  end
+end
+EOS
+    source.should reek_of(:UncommunicativeName, /'x'/)
+    source.should reek_of(:UncommunicativeName, /'y'/)
+  end
+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
+  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
+  end
+end

data/spec/reek/smells/utility_function_spec.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/smells/utility_function'
+
+include Reek
+include Reek::Smells
+
+describe UtilityFunction do
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = CodeParser.new(@rpt, SmellConfig.new.smell_listeners)
+  end
+
+  it 'should not report attrset' do
+    class Fred
+      attr_writer :xyz
+    end
+    @cchk.check_object(Fred)
+    @rpt.should be_empty
+  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
+    end
+    class Son < Father
+      def thing(ff); ff; end
+    end
+    @cchk.check_object(Son)
+    @rpt.should be_empty
+  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?
+    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
+  end
+end
+EOS
+    src.should_not reek
+  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
+  end
+end