reek 1.2.6 → 1.2.7

data/spec/reek/smells/uncommunicative_module_name_spec.rb

@@ -0,0 +1,67 @@
+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', 'uncommunicative_module_name')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'code_parser')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'sniffer')
+
+include Reek
+include Reek::Smells
+
+describe UncommunicativeModuleName do
+  before :each do
+    @source_name = 'classy'
+    @detector = UncommunicativeModuleName.new(@source_name)
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  ['class', 'module'].each do |type|
+    it 'does not report one-word name' do
+      "#{type} Helper; end".should_not reek_of(:UncommunicativeModuleName)
+    end
+    it 'reports one-letter name' do
+      "#{type} X; end".should reek_of(:UncommunicativeModuleName, /X/)
+    end
+    it 'reports name of the form "x2"' do
+      "#{type} X2; end".should reek_of(:UncommunicativeModuleName, /X2/)
+    end
+    it 'reports long name ending in a number' do
+      "#{type} Printer2; end".should reek_of(:UncommunicativeModuleName, /Printer2/)
+    end
+  end
+
+  context 'accepting names' do
+    it 'accepts Inline::C' do
+      ctx = mock('context')
+      ctx.should_receive(:full_name).and_return('Inline::C')
+      @detector.accept?(ctx).should == true
+    end
+  end
+
+  context 'looking at the YAML' do
+    before :each do
+      src = 'module Printer2; end'
+      source = src.to_reek_source
+      sniffer = Core::Sniffer.new(source)
+      @mctx = Core::CodeParser.new(sniffer).process_module(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(/class:\s*UncommunicativeName/)
+    end
+    it 'reports the subclass' do
+      @yaml.should match(/subclass:\s*UncommunicativeModuleName/)
+    end
+    it 'reports the variable name' do
+      @yaml.should match(/module_name:\s*Printer2/)
+    end
+    it 'reports the line number of the declaration' do
+      @yaml.should match(/lines:\s*- 1/)
+    end
+  end
+end

data/spec/reek/smells/uncommunicative_parameter_name_spec.rb

@@ -0,0 +1,61 @@
+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', 'uncommunicative_parameter_name')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'method_context')
+
+include Reek::Core
+include Reek::Smells
+
+describe UncommunicativeParameterName do
+  before :each do
+    @source_name = 'wallamalloo'
+    @detector = UncommunicativeParameterName.new(@source_name)
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  context "parameter name" do
+    ['obj.', ''].each do |host|
+      it 'does not recognise *' do
+        "def #{host}help(xray, *) basics(17) end".should_not reek
+      end
+      it "reports parameter's name" do
+        "def #{host}help(x) basics(17) end".should reek_only_of(:UncommunicativeParameterName, /x/, /parameter name/)
+      end
+      it 'reports name of the form "x2"' do
+        "def #{host}help(x2) basics(17) end".should reek_only_of(:UncommunicativeParameterName, /x2/, /parameter name/)
+        #SMELL: should match either the class or the subclass!
+      end
+      it 'reports long name ending in a number' do
+        "def #{host}help(param1) basics(17) end".should reek_only_of(:UncommunicativeParameterName, /param1/, /parameter name/)
+      end
+    end
+  end
+
+  context 'looking at the YAML' do
+    before :each do
+      src = 'def bad(good, bad2, good_again) end'
+      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(/class:\s*UncommunicativeName/)
+    end
+    it 'reports the subclass' do
+      @yaml.should match(/subclass:\s*UncommunicativeParameterName/)
+    end
+    it 'reports the variable name' do
+      @yaml.should match(/parameter_name:\s*bad2/)
+    end
+    it 'reports the line number of the declaration' do
+      @yaml.should match(/lines:\s*- 1/)
+    end
+  end
+end

data/spec/reek/smells/uncommunicative_variable_name_spec.rb

@@ -0,0 +1,124 @@
+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', 'uncommunicative_variable_name')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'code_parser')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'sniffer')
+
+include Reek
+include Reek::Smells
+
+describe UncommunicativeVariableName do
+  before :each do
+    @source_name = 'wallamalloo'
+    @detector = UncommunicativeVariableName.new(@source_name)
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  context "field name" do
+    it 'does not report use of one-letter fieldname' do
+      'class Thing; def simple(fred) @x end end'.should_not reek_of(:UncommunicativeVariableName, /@x/, /Thing/, /variable name/)
+    end
+    it 'reports one-letter fieldname in assignment' do
+      'class Thing; def simple(fred) @x = fred end end'.should reek_of(:UncommunicativeVariableName, /@x/, /Thing/, /variable name/)
+    end
+  end
+
+  context "local variable name" do
+    it 'does not report one-word variable name' do
+      'def help(fred) simple = jim(45) end'.should_not reek
+    end
+    it 'reports one-letter variable name' do
+      'def simple(fred) x = jim(45) end'.should reek_only_of(:UncommunicativeVariableName, /x/, /variable name/)
+    end
+    it 'reports name of the form "x2"' do
+      'def simple(fred) x2 = jim(45) end'.should reek_only_of(:UncommunicativeVariableName, /x2/, /variable name/)
+    end
+    it 'reports long name ending in a number' do
+      'def simple(fred) var123 = jim(45) end'.should reek_only_of(:UncommunicativeVariableName, /var123/, /variable name/)
+    end
+    it 'reports variable name only once' do
+      'def simple(fred) x = jim(45); x = y end'.should reek_only_of(:UncommunicativeVariableName, /x/)
+    end
+    it 'reports a bad name inside a block' do
+      src = 'def clean(text) text.each { q2 = 3 } end'
+      src.should reek_of(:UncommunicativeVariableName, /q2/)
+    end
+    it 'reports variable name outside any method' do
+      'class Simple; x = jim(45); end'.should reek_of(:UncommunicativeVariableName, /x/)
+    end
+  end
+
+  context "block parameter name" do
+    it "reports parameter's name" do
+      'def help() @stuff.each {|x|} end'.should reek_only_of(:UncommunicativeVariableName, /x/, /variable name/)
+    end
+    it "reports deep block parameter" do
+      src = <<EOS
+  def bad
+    unless @mod then
+      @sig.each { |x| x.to_s }
+    end
+  end
+EOS
+      src.should reek_only_of(:UncommunicativeVariableName, /'x'/)
+    end
+    it 'reports 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(:UncommunicativeVariableName, /'x'/)
+      source.should reek_of(:UncommunicativeVariableName, /'y'/)
+    end
+  end
+
+  context 'looking at the YAML' do
+    before :each do
+      src = <<EOS
+def bad
+  unless @mod then
+     x2 = xy.to_s
+     x2
+     x2 = 56
+  end
+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
+    end
+    it 'reports the source' do
+      @yaml.should match(/source:\s*#{@source_name}/)
+    end
+    it 'reports the class' do
+      @yaml.should match(/class:\s*UncommunicativeName/)
+    end
+    it 'reports the subclass' do
+      @yaml.should match(/subclass:\s*UncommunicativeVariableName/)
+    end
+    it 'reports the variable name' do
+      @yaml.should match(/variable_name:\s*x2/)
+    end
+    it 'reports all line numbers' do
+      @yaml.should match(/lines:\s*- 3\s*- 5/)
+    end
+  end
+
+  context "several names" do
+    it 'should report all bad names' do
+      ruby = 'class Oof; def y(x) @z = x end end'
+      ruby.should reek_of(:UncommunicativeParameterName, /'x'/)
+      ruby.should reek_of(:UncommunicativeMethodName, /'y'/)
+      ruby.should reek_of(:UncommunicativeVariableName, /'@z'/)
+    end
+  end
+end

data/spec/reek/smells/utility_function_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-require 'reek/smells/utility_function'
+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', 'utility_function')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
 
 include Reek
 include Reek::Smells
@@ -25,6 +25,10 @@ describe UtilityFunction do
     it 'recognises an ivar reference within a block' do
       'def clean(text) text.each { @fred = 3} end'.should_not reek
     end
+    it 'copes with nil superclass' do
+      '# clean class for testing purposes
+class Object; def is_maybe?() false end end'.should_not reek
+    end
   end
 
   context 'with only one call' do
@@ -59,6 +63,7 @@ describe UtilityFunction do
 
     it 'should recognise a deep call' do
       src = <<EOS
+# clean class for testing purposes
   class Red
     def deep(text)
       text.each { |mod| atts = shelve(mod) }
@@ -73,3 +78,40 @@ EOS
     end
   end
 end
+
+describe UtilityFunction do
+  before(:each) do
+    @source_name = 'loser'
+    @detector = UtilityFunction.new(@source_name)
+  end
+
+  it_should_behave_like 'SmellDetector'
+
+  context 'looking at the YAML' do
+    before :each do
+      src = <<EOS
+def simple(arga)
+  arga.b.c
+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/)
+    end
+    it 'reports the line number of the method' do
+      @yaml.should match(/lines:\s*- 1/)
+    end
+  end
+end

data/spec/reek/source/code_comment_spec.rb

@@ -0,0 +1,24 @@
+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', 'source', 'code_comment')
+
+include Reek::Source
+
+describe CodeComment do
+  context 'comment checks' do
+    it 'rejects no comment' do
+      CodeComment.new('').is_descriptive?.should be_false
+    end
+    it 'rejects an empty comment' do
+      CodeComment.new('#').is_descriptive?.should be_false
+    end
+    it 'rejects a 1-word comment' do
+      CodeComment.new("# fred\n#  ").is_descriptive?.should be_false
+    end
+    it 'accepts a 2-word comment' do
+      CodeComment.new('# fred here  ').is_descriptive?.should be_true
+    end
+    it 'accepts a multi-word comment' do
+      CodeComment.new("# fred here \n# with \n   # biscuits ").is_descriptive?.should be_true
+    end
+  end
+end

data/spec/reek/source/object_source_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+
+include Reek
+
+describe Dir do
+  it 'reports correct smells via the Dir matcher' do
+    files = Dir['spec/samples/two_smelly_files/*.rb']
+    files.should reek
+    files.should reek_of(:UncommunicativeVariableName)
+    files.should_not reek_of(:LargeClass)
+  end
+
+  it 'copes with daft file specs' do
+    Dir["spec/samples/two_smelly_files/*/.rb"].should_not reek
+  end
+
+  it 'copes with empty array' do
+    [].should_not reek
+  end
+end

data/spec/reek/{adapters/source_spec.rb → source/source_code_spec.rb}

@@ -1,20 +1,19 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-require 'reek/adapters/source'
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
 require 'stringio'
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'source', 'source_code')
 
-include Reek
+include Reek::Source
 
-describe Source do
+describe SourceCode do
   context 'when the parser fails' do
     before :each do
       @catcher = StringIO.new
-      @old_err_io = (Source.err_io = @catcher)
+      @old_err_io = (SourceCode.err_io = @catcher)
       parser = mock('parser')
       @error_message = 'Error message'
       parser.should_receive(:parse).and_raise(SyntaxError.new(@error_message))
       @source_name = 'Test source'
-      @src = Source.new('', @source_name, parser)
+      @src = SourceCode.new('', @source_name, parser)
     end
     it 'raises a SyntaxError' do
       @src.syntax_tree
@@ -35,7 +34,7 @@ describe Source do
       @catcher.string.should match(@error_message)
     end
     after :each do
-      Source.err_io = @old_err_io
+      SourceCode.err_io = @old_err_io
     end
   end
 end

data/spec/reek/source/tree_dresser_spec.rb

@@ -0,0 +1,165 @@
+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', 'source', 'tree_dresser')
+
+include Reek::Source
+
+describe TreeDresser do
+  before(:each) do
+    @dresser = TreeDresser.new
+  end
+  it 'maps :if to IfNode' do
+    @dresser.extensions_for(:if).should == 'IfNode'
+  end
+  it 'maps :call to CallNode' do
+    @dresser.extensions_for(:call).should == 'CallNode'
+  end
+end
+
+describe SexpExtensions::DefnNode do
+  context 'with no parameters' do
+    before :each do
+      @node = s(:defn, :hello, s(:args))
+      @node.extend(SexpExtensions::DefnNode)
+    end
+    it 'has no parameters' do
+      @node.parameters.should == s(:args)
+    end
+    it 'has no parameter names' do
+      @node.parameter_names.should == s()
+    end
+  end
+
+  context 'with 1 parameter' do
+    before :each do
+      @node = s(:defn, :hello, s(:args, :param))
+      @node.extend(SexpExtensions::DefnNode)
+    end
+    it 'has 1 parameter' do
+      @node.parameters.should == s(:args, :param)
+    end
+    it 'has 1 parameter name' do
+      @node.parameter_names.should == s(:param)
+    end
+  end
+
+  context 'with a block' do
+    before :each do
+      @node = s(:defn, :hello, s(:args, :param, :"&blk"))
+      @node.extend(SexpExtensions::DefnNode)
+    end
+    it 'has 1 parameter' do
+      @node.parameters.should == s(:args, :param, :"&blk")
+    end
+    it 'has 1 parameter name' do
+      @node.parameter_names.should == s(:param, :"&blk")
+    end
+  end
+
+  context 'with 1 defaulted parameter' do
+    before :each do
+      @node = s(:defn, :hello, s(:args, :param, s(:block, s(:lasgn, :param, s(:array)))))
+      @node.extend(SexpExtensions::DefnNode)
+    end
+    it 'has 1 parameter' do
+      @node.parameters.should == s(:args, :param)
+    end
+    it 'has 1 parameter name' do
+      @node.parameter_names.should == s(:param)
+    end
+  end
+end
+
+describe SexpExtensions::DefsNode do
+  context 'with no parameters' do
+    before :each do
+      @node = s(:defs, :obj, :hello, s(:args))
+      @node.extend(SexpExtensions::DefsNode)
+    end
+    it 'has no parameters' do
+      @node.parameters.should == s(:args)
+    end
+    it 'has no parameter names' do
+      @node.parameter_names.should == s()
+    end
+  end
+
+  context 'with 1 parameter' do
+    before :each do
+      @node = s(:defs, :obj, :hello, s(:args, :param))
+      @node.extend(SexpExtensions::DefsNode)
+    end
+    it 'has 1 parameter' do
+      @node.parameters.should == s(:args, :param)
+    end
+    it 'has 1 parameter name' do
+      @node.parameter_names.should == s(:param)
+    end
+  end
+
+  context 'with a block' do
+    before :each do
+      @node = s(:defs, :obj, :hello, s(:args, :param, :"&blk"))
+      @node.extend(SexpExtensions::DefsNode)
+    end
+    it 'has 1 parameter' do
+      @node.parameters.should == s(:args, :param, :"&blk")
+    end
+    it 'has 1 parameter name' do
+      @node.parameter_names.should == s(:param, :"&blk")
+    end
+  end
+
+  context 'with 1 defaulted parameter' do
+    before :each do
+      @node = s(:defs, :obj, :hello, s(:args, :param, s(:block, s(:lasgn, :param, s(:array)))))
+      @node.extend(SexpExtensions::DefsNode)
+    end
+    it 'has 1 parameter' do
+      @node.parameters.should == s(:args, :param)
+    end
+    it 'has 1 parameter name' do
+      @node.parameter_names.should == s(:param)
+    end
+  end
+end
+
+describe SexpExtensions::IterNode do
+  context 'with no parameters' do
+    before :each do
+      @node = s(:iter, s(), nil, s())
+      @node.extend(SexpExtensions::IterNode)
+    end
+    it 'has no parameters' do
+      @node.parameters.should == []
+    end
+    it 'has no parameter names' do
+      @node.parameter_names.should == []
+    end
+  end
+
+  context 'with 1 parameter' do
+    before :each do
+      @node = s(:iter, s(), s(:lasgn, :param), s())
+      @node.extend(SexpExtensions::IterNode)
+    end
+    it 'has 1 parameter' do
+      @node.parameters.should == s(:lasgn, :param)
+    end
+    it 'has 1 parameter name' do
+      @node.parameter_names.should == s(:param)
+    end
+  end
+
+  context 'with 2 parameters' do
+    before :each do
+      @node = s(:iter, s(), s(:masgn, s(:array, s(:lasgn, :x), s(:lasgn, :y))), s())
+      @node.extend(SexpExtensions::IterNode)
+    end
+    it 'has 1 parameter' do
+      @node.parameters.should == s(:masgn, s(:array, s(:lasgn, :x), s(:lasgn, :y)))
+    end
+    it 'has 1 parameter name' do
+      @node.parameter_names.should == [:x, :y]
+    end
+  end
+end