reek 1.2.7.3 → 1.2.8

data/spec/reek/smells/uncommunicative_variable_name_spec.rb

@@ -17,32 +17,48 @@ describe UncommunicativeVariableName do
 
   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/)
+      src = 'class Thing; def simple(fred) @x end end'
+      src.should_not smell_of(UncommunicativeVariableName)
     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/)
+      src = 'class Thing; def simple(fred) @x = fred end end'
+      src.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
+      'def help(fred) simple = jim(45) end'.should_not smell_of(UncommunicativeVariableName)
     end
     it 'reports one-letter variable name' do
-      'def simple(fred) x = jim(45) end'.should reek_only_of(:UncommunicativeVariableName, /x/, /variable name/)
+      src = 'def simple(fred) x = jim(45) end'
+      src.should smell_of(UncommunicativeVariableName,
+        {UncommunicativeVariableName::VARIABLE_NAME_KEY => 'x'})
     end
     it 'reports name of the form "x2"' do
-      'def simple(fred) x2 = jim(45) end'.should reek_only_of(:UncommunicativeVariableName, /x2/, /variable name/)
+      src = 'def simple(fred) x2 = jim(45) end'
+      src.should smell_of(UncommunicativeVariableName,
+        {UncommunicativeVariableName::VARIABLE_NAME_KEY => 'x2'})
     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/)
+      @bad_var = 'var123'
+      src = "def simple(fred) #{@bad_var} = jim(45) end"
+      src.should smell_of(UncommunicativeVariableName,
+        {UncommunicativeVariableName::VARIABLE_NAME_KEY => @bad_var})
     end
     it 'reports variable name only once' do
-      'def simple(fred) x = jim(45); x = y end'.should reek_only_of(:UncommunicativeVariableName, /x/)
+      src = 'def simple(fred) x = jim(45); x = y end'
+      ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
+      smells = @detector.examine_context(ctx)
+      smells.length.should == 1
+      smells[0].subclass.should == UncommunicativeVariableName::SMELL_SUBCLASS
+      smells[0].smell[UncommunicativeVariableName::VARIABLE_NAME_KEY].should == 'x'
+      smells[0].lines.should == [1,1]
     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/)
+      src.should smell_of(UncommunicativeVariableName,
+        {UncommunicativeVariableName::VARIABLE_NAME_KEY => 'q2'})
     end
     it 'reports variable name outside any method' do
       'class Simple; x = jim(45); end'.should reek_of(:UncommunicativeVariableName, /x/)
@@ -50,9 +66,6 @@ describe UncommunicativeVariableName do
   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
@@ -61,20 +74,8 @@ describe UncommunicativeVariableName do
     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'/)
+      src.should smell_of(UncommunicativeVariableName,
+        {UncommunicativeVariableName::VARIABLE_NAME_KEY => 'x'})
     end
   end
 
@@ -89,35 +90,31 @@ def bad
   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!
-    end
-    it 'reports the source' do
-      @warning.source.should == @source_name
-    end
-    it 'reports the class' do
-      @warning.smell_class.should == 'UncommunicativeName'
+      ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
+      @smells = @detector.examine_context(ctx)
+      @warning = @smells[0]
     end
-    it 'reports the subclass' do
-      @warning.subclass.should == 'UncommunicativeVariableName'
-    end
-    it 'reports the variable name' do
+
+    it_should_behave_like 'common fields set correctly'
+
+    it 'reports the correct values' do
       @warning.smell['variable_name'].should == 'x2'
-    end
-    it 'reports all line numbers' do
       @warning.lines.should == [3,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'/)
+  context 'when a smell is reported in a singleton method' do
+    before :each do
+      src = 'def self.bad() x2 = 4; end'
+      ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
+      @smells = @detector.examine_context(ctx)
+      @warning = @smells[0]
+    end
+
+    it_should_behave_like 'common fields set correctly'
+
+    it 'reports the fq context' do
+      @warning.context.should == 'self.bad'
     end
   end
 end

data/spec/reek/smells/utility_function_spec.rb

@@ -6,16 +6,27 @@ include Reek
 include Reek::Smells
 
 describe UtilityFunction do
+  before(:each) do
+    @source_name = 'loser'
+    @detector = UtilityFunction.new(@source_name)
+  end
+
+  it_should_behave_like 'SmellDetector'
+
   context 'with a singleton method' do
     ['self', 'local_call', '$global'].each do |receiver|
       it 'ignores the receiver' do
-        "def #{receiver}.simple(arga) arga.to_s + arga.to_i end".should_not reek
+        src = "def #{receiver}.simple(arga) arga.to_s + arga.to_i end"
+        ctx = MethodContext.new(nil, src.to_reek_source.syntax_tree)
+        @detector.examine_context(ctx).should be_empty
       end
     end
   end
   context 'with no calls' do
     it 'does not report empty method' do
-      'def simple(arga) end'.should_not reek
+      src = 'def simple(arga) end'
+      ctx = MethodContext.new(nil, src.to_reek_source.syntax_tree)
+      @detector.examine_context(ctx).should be_empty
     end
     it 'does not report literal' do
       'def simple(arga) 3; end'.should_not reek
@@ -87,15 +98,6 @@ EOS
       src.should_not reek
     end
   end
-end
-
-describe UtilityFunction do
-  before(:each) do
-    @source_name = 'loser'
-    @detector = UtilityFunction.new(@source_name)
-  end
-
-  it_should_behave_like 'SmellDetector'
 
   context 'when a smells is reported' do
     before :each do
@@ -107,8 +109,7 @@ 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!
+      @warning = @detector.examine_context(mctx)[0]   # SMELL: too cumbersome!
     end
 
     it_should_behave_like 'common fields set correctly'

data/spec/reek/source/code_comment_spec.rb

@@ -4,10 +4,19 @@ require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expan
 include Reek::Source
 
 describe CodeComment do
-  context 'comment checks' do
-    it 'rejects no comment' do
-      CodeComment.new('').is_descriptive?.should be_false
+  context 'with an empty comment' do
+    before :each do
+      @comment = CodeComment.new('')
+    end
+    it 'is not descriptive' do
+      @comment.is_descriptive?.should be_false
     end
+    it 'has an empty config' do
+      @comment.config.should be_empty
+    end
+  end
+
+  context 'comment checks' do
     it 'rejects an empty comment' do
       CodeComment.new('#').is_descriptive?.should be_false
     end
@@ -21,4 +30,53 @@ describe CodeComment do
       CodeComment.new("# fred here \n# with \n   # biscuits ").is_descriptive?.should be_true
     end
   end
+
+  context 'comment config' do
+    it 'parses hashed options' do
+      config = CodeComment.new("# :reek:Duplication: { enabled: false }").config
+      config.should include('Duplication')
+      config['Duplication'].should include('enabled')
+      config['Duplication']['enabled'].should be_false
+    end
+    it 'parses hashed options with ruby names' do
+      config = CodeComment.new("# :reek:nested_iterators: { enabled: true }").config
+      config.should include('NestedIterators')
+      config['NestedIterators'].should include('enabled')
+      config['NestedIterators']['enabled'].should be_true
+    end
+    it 'parses multiple hashed options' do
+      config = CodeComment.new("# :reek:Duplication: { enabled: false }\n:reek:nested_iterators: { enabled: true }").config
+      config.should include('Duplication','NestedIterators')
+      config['Duplication'].should include('enabled')
+      config['Duplication']['enabled'].should be_false
+      config['NestedIterators'].should include('enabled')
+      config['NestedIterators']['enabled'].should be_true
+    end
+    it 'parses multiple hashed options on the same line' do
+      config = CodeComment.new("# :reek:Duplication: { enabled: false } and :reek:nested_iterators: { enabled: true }").config
+      config.should include('Duplication','NestedIterators')
+      config['Duplication'].should include('enabled')
+      config['Duplication']['enabled'].should be_false
+      config['NestedIterators'].should include('enabled')
+      config['NestedIterators']['enabled'].should be_true
+    end
+    it 'parses multiple unhashed options on the same line' do
+      config = CodeComment.new("# :reek:Duplication and :reek:nested_iterators").config
+      config.should include('Duplication','NestedIterators')
+      config['Duplication'].should include('enabled')
+      config['Duplication']['enabled'].should be_false
+      config['NestedIterators'].should include('enabled')
+      config['NestedIterators']['enabled'].should be_false
+    end
+    it 'disables the smell if no options are specifed' do
+      config = CodeComment.new("# :reek:Duplication").config
+      config.should include('Duplication')
+      config['Duplication'].should include('enabled')
+      config['Duplication']['enabled'].should be_false
+    end
+    it 'ignores smells after a space' do
+      config = CodeComment.new("# :reek: Duplication").config
+      config.should_not include('Duplication')
+    end
+  end
 end

data/spec/reek/source/tree_dresser_spec.rb

@@ -20,7 +20,20 @@ describe SexpNode do
     it 'formats self' do
       @node = s(:self)
       @node.extend(SexpNode)
-      @node.format.should == 'self'
+      @node.format_ruby.should == 'self'
+    end
+  end
+
+  context 'hash' do
+    it 'hashes equal for equal sexps' do
+      node1 = ast(:defn, s(:const2, :Fred, :jim), s(:call, :+, s(:lit, 4), :fred))
+      node2 = ast(:defn, s(:const2, :Fred, :jim), s(:call, :+, s(:lit, 4), :fred))
+      node1.hash.should == node2.hash
+    end
+    it 'hashes diferent for diferent sexps' do
+      node1 = ast(:defn, s(:const2, :Fred, :jim), s(:call, :+, s(:lit, 4), :fred))
+      node2 = ast(:defn, s(:const2, :Fred, :jim), s(:call, :+, s(:lit, 3), :fred))
+      node1.hash.should_not == node2.hash
     end
   end
 end
@@ -37,6 +50,12 @@ describe SexpExtensions::DefnNode do
     it 'has no parameter names' do
       @node.parameter_names.should == s()
     end
+    it 'includes outer scope in its full name' do
+      @node.full_name('Fred').should == 'Fred#hello'
+    end
+    it 'includes no marker in its full name with empty outer scope' do
+      @node.full_name('').should == 'hello'
+    end
   end
 
   context 'with 1 parameter' do
@@ -50,6 +69,12 @@ describe SexpExtensions::DefnNode do
     it 'has 1 parameter name' do
       @node.parameter_names.should == s(:param)
     end
+    it 'includes outer scope in its full name' do
+      @node.full_name('Fred').should == 'Fred#hello'
+    end
+    it 'includes no marker in its full name with empty outer scope' do
+      @node.full_name('').should == 'hello'
+    end
   end
 
   context 'with a block' do
@@ -63,6 +88,12 @@ describe SexpExtensions::DefnNode do
     it 'has 1 parameter name' do
       @node.parameter_names.should == s(:param, :"&blk")
     end
+    it 'includes outer scope in its full name' do
+      @node.full_name('Fred').should == 'Fred#hello'
+    end
+    it 'includes no marker in its full name with empty outer scope' do
+      @node.full_name('').should == 'hello'
+    end
   end
 
   context 'with 1 defaulted parameter' do
@@ -76,6 +107,12 @@ describe SexpExtensions::DefnNode do
     it 'has 1 parameter name' do
       @node.parameter_names.should == s(:param)
     end
+    it 'includes outer scope in its full name' do
+      @node.full_name('Fred').should == 'Fred#hello'
+    end
+    it 'includes no marker in its full name with empty outer scope' do
+      @node.full_name('').should == 'hello'
+    end
   end
 end
 
@@ -91,6 +128,12 @@ describe SexpExtensions::DefsNode do
     it 'has no parameter names' do
       @node.parameter_names.should == s()
     end
+    it 'includes outer scope in its full name' do
+      @node.full_name('Fred').should == 'Fred#obj.hello'
+    end
+    it 'includes no marker in its full name with empty outer scope' do
+      @node.full_name('').should == 'obj.hello'
+    end
   end
 
   context 'with 1 parameter' do
@@ -104,6 +147,12 @@ describe SexpExtensions::DefsNode do
     it 'has 1 parameter name' do
       @node.parameter_names.should == s(:param)
     end
+    it 'includes outer scope in its full name' do
+      @node.full_name('Fred').should == 'Fred#obj.hello'
+    end
+    it 'includes no marker in its full name with empty outer scope' do
+      @node.full_name('').should == 'obj.hello'
+    end
   end
 
   context 'with a block' do
@@ -117,6 +166,12 @@ describe SexpExtensions::DefsNode do
     it 'has 1 parameter name' do
       @node.parameter_names.should == s(:param, :"&blk")
     end
+    it 'includes outer scope in its full name' do
+      @node.full_name('Fred').should == 'Fred#obj.hello'
+    end
+    it 'includes no marker in its full name with empty outer scope' do
+      @node.full_name('').should == 'obj.hello'
+    end
   end
 
   context 'with 1 defaulted parameter' do
@@ -130,6 +185,12 @@ describe SexpExtensions::DefsNode do
     it 'has 1 parameter name' do
       @node.parameter_names.should == s(:param)
     end
+    it 'includes outer scope in its full name' do
+      @node.full_name('Fred').should == 'Fred#obj.hello'
+    end
+    it 'includes no marker in its full name with empty outer scope' do
+      @node.full_name('').should == 'obj.hello'
+    end
   end
 end
 
@@ -173,3 +234,37 @@ describe SexpExtensions::IterNode do
     end
   end
 end
+
+describe SexpExtensions::ModuleNode do
+  context 'with a simple name' do
+    subject do
+      mod = ast(:module, :Fred, nil)
+      mod
+    end
+    its(:name) { should == :Fred }
+    its(:simple_name) { should == :Fred }
+    its(:text_name) { should == 'Fred' }
+    it 'has a simple full_name' do
+      subject.full_name('').should == 'Fred'
+    end
+    it 'has a fq full_name' do
+      subject.full_name('Blimey::O::Reilly').should == 'Blimey::O::Reilly::Fred'
+    end
+  end
+
+  context 'with a scoped name' do
+    subject do
+      mod = ast(:module, s(:colon2, s(:const, :Foo), :Bar), nil)
+      mod
+    end
+    its(:name) { should == s(:colon2, s(:const, :Foo), :Bar) }
+    its(:simple_name) { should == :Bar }
+    its(:text_name) { should == 'Foo::Bar' }
+    it 'has a simple full_name' do
+      subject.full_name('').should == 'Foo::Bar'
+    end
+    it 'has a fq full_name' do
+      subject.full_name('Blimey::O::Reilly').should == 'Blimey::O::Reilly::Foo::Bar'
+    end
+  end
+end

data/spec/samples/config/allow_duplication.reek

@@ -0,0 +1,3 @@
+---
+Duplication:
+  enabled: false

data/spec/samples/config/deeper_nested_iterators.reek

@@ -0,0 +1,3 @@
+---
+NestedIterators:
+  max_allowed_nesting: 3

data/spec/samples/demo/demo.rb

@@ -0,0 +1,8 @@
+class Dirty
+  # This method smells of :reek:NestedIterators but ignores them
+  def awful(x, y, offset = 0, log = false)
+    puts @screen.title
+    @screen = widgets.map {|w| w.each {|key| key += 3}}
+    puts @screen.contents
+  end
+end