reek 1.2.6 → 1.2.8

data/spec/reek/source/reference_collector_spec.rb

@@ -0,0 +1,53 @@
+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', 'reference_collector')
+
+include Reek::Source
+
+describe ReferenceCollector do
+
+  context 'counting refs to self' do
+    def refs_to_self(src)
+      ReferenceCollector.new(src.to_reek_source.syntax_tree).num_refs_to_self
+    end
+    it 'with no refs to self' do
+      refs_to_self('def no_envy(arga) arga.barg end').should == 0
+    end
+    it 'counts a call to super' do
+      refs_to_self('def simple() super; end').should == 1
+    end
+    it 'counts a local call' do
+      refs_to_self('def simple() to_s; end').should == 1
+    end
+    it 'counts a use of self' do
+      refs_to_self('def simple() lv = self; end').should == 1
+    end
+    it 'counts a call with self as receiver' do
+      refs_to_self('def simple() self.to_s; end').should == 1
+    end
+    it 'counts uses of an ivar' do
+      refs_to_self('def no_envy() @item.to_a; @item = 4; @item end').should == 3
+    end
+    it 'counts an ivar passed to a method' do
+      refs_to_self('def no_envy(arga) arga.barg(@item); arga end').should == 1
+    end
+    it 'ignores global variables' do
+      refs_to_self('def no_envy(arga) $s2.to_a; $s2[arga] end').should == 0
+    end
+    it 'ignores global variables' do
+      src = <<EOS
+    def accept(t, pat = /.*/nm, &block)
+      if pat
+        pat.respond_to?(:match) or raise TypeError, "has no `match'"
+      else
+        pat = t if t.respond_to?(:match)
+      end
+      unless block
+        block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
+      end
+      @atype[t] = [pat, block]
+    end
+EOS
+      refs_to_self(src).should == 2
+    end
+  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,270 @@
+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 SexpNode do
+  context 'format' do
+    it 'formats self' do
+      @node = s(:self)
+      @node.extend(SexpNode)
+      @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
+
+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
+    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
+    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
+    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
+    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
+    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
+    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
+    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
+
+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
+    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
+    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
+    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
+    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
+    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
+    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
+    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
+
+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
+
+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/reek/spec/should_reek_of_spec.rb

@@ -0,0 +1,76 @@
+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', 'spec')
+
+include Reek
+include Reek::Spec
+
+describe ShouldReekOf do
+  context 'rdoc demo example' do
+    before :each do
+      @ruby = 'def double_thing() @other.thing.foo + @other.thing.foo end'
+    end
+
+    it 'reports duplicate calls to @other.thing' do
+      @ruby.should reek_of(:Duplication, /@other.thing[^\.]/)
+    end
+    it 'reports duplicate calls to @other.thing.foo' do
+      @ruby.should reek_of(:Duplication, /@other.thing.foo/)
+    end
+    it 'does not report any feature envy' do
+      @ruby.should_not reek_of(:FeatureEnvy)
+    end
+  end
+
+  context 'checking code in a string' do
+    before :each do
+      @clean_code = 'def good() true; end'
+      @smelly_code = 'def x() y = 4; end'
+      @matcher = ShouldReekOf.new(:UncommunicativeVariableName, [/x/, /y/])
+    end
+
+    it 'matches a smelly String' do
+      @matcher.matches?(@smelly_code).should be_true
+    end
+
+    it 'doesnt match a fragrant String' do
+      @matcher.matches?(@clean_code).should be_false
+    end
+
+    it 'reports the smells when should_not fails' do
+      @matcher.matches?(@smelly_code).should be_true
+      @matcher.failure_message_for_should_not.should match('UncommunicativeVariableName')
+    end
+  end
+
+  context 'checking code in a Dir' do
+    before :each do
+      @clean_dir = Dir['spec/samples/three_clean_files/*.rb']
+      @smelly_dir = Dir['spec/samples/two_smelly_files/*.rb']
+      @matcher = ShouldReekOf.new(:UncommunicativeVariableName, [/Dirty/, /@s/])
+    end
+
+    it 'matches a smelly String' do
+      @matcher.matches?(@smelly_dir).should be_true
+    end
+
+    it 'doesnt match a fragrant String' do
+      @matcher.matches?(@clean_dir).should be_false
+    end
+  end
+
+  context 'checking code in a File' do
+    before :each do
+      @clean_file = File.new(Dir['spec/samples/three_clean_files/*.rb'][0])
+      @smelly_file = File.new(Dir['spec/samples/two_smelly_files/*.rb'][0])
+      @matcher = ShouldReekOf.new(:UncommunicativeVariableName, [/Dirty/, /@s/])
+    end
+
+    it 'matches a smelly String' do
+      @matcher.matches?(@smelly_file).should be_true
+    end
+
+    it 'doesnt match a fragrant String' do
+      @matcher.matches?(@clean_file).should be_false
+    end
+  end
+end

data/spec/reek/spec/should_reek_only_of_spec.rb

@@ -0,0 +1,89 @@
+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', 'spec')
+
+include Reek
+include Reek::Spec
+
+describe ShouldReekOnlyOf do
+  before :each do
+    @expected_smell_class = :NestedIterators
+    @expected_context_name = 'SmellyClass#big_method'
+    @matcher = ShouldReekOnlyOf.new(@expected_smell_class, [/#{@expected_context_name}/])
+    @examiner = mock('examiner', :null_object => true)
+    @examiner.should_receive(:smells).and_return {smells}
+    @match = @matcher.matches_examiner?(@examiner)
+  end
+
+  shared_examples_for 'no match' do
+    it 'does not match' do
+      @match.should be_false
+    end
+    context 'when a match was expected' do
+      before :each do
+        @source = 'the_path/to_a/source_file.rb'
+        @examiner.should_receive(:description).and_return(@source)
+      end
+      it 'reports the source' do
+        @matcher.failure_message_for_should.should match(@source)
+      end
+      it 'reports the expected smell class' do
+        @matcher.failure_message_for_should.should match(@expected_smell_class.to_s)
+      end
+    end
+  end
+
+  context 'with no smells' do
+    def smells
+      []
+    end
+
+    it_should_behave_like 'no match'
+  end
+
+  context 'with 1 non-matching smell' do
+    def smells
+      [SmellWarning.new('ControlCouple', 'context', [1], 'any old message')]
+    end
+
+    it_should_behave_like 'no match'
+  end
+
+  context 'with 2 non-matching smells' do
+    def smells
+      [
+        SmellWarning.new('ControlCouple', 'context', [1], 'any old message'),
+        SmellWarning.new('FeatureEnvy', 'context', [1], 'any old message')
+        ]
+    end
+
+    it_should_behave_like 'no match'
+  end
+
+  context 'with 1 non-matching and 1 matching smell' do
+    def smells
+      [
+        SmellWarning.new('ControlCouple', 'context', [1], 'any old message'),
+        SmellWarning.new(@expected_smell_class.to_s, 'context', [1], "message mentioning #{@expected_context_name}")
+        ]
+    end
+
+    it_should_behave_like 'no match'
+  end
+
+  context 'with 1 matching smell' do
+    def smells
+      [SmellWarning.new(@expected_smell_class.to_s, nil, [1], "message mentioning #{@expected_context_name}")]
+    end
+    it 'matches' do
+      @match.should be_true
+    end
+    it 'reports the expected smell when no match was expected' do
+      @matcher.failure_message_for_should_not.should match(@expected_smell_class.to_s)
+    end
+    it 'reports the source when no match was expected' do
+      source = 'the_path/to_a/source_file.rb'
+      @examiner.should_receive(:description).and_return(source)
+      @matcher.failure_message_for_should_not.should match(source)
+    end
+  end
+end

data/spec/reek/{adapters → spec}/should_reek_spec.rb

@@ -1,7 +1,5 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-require 'reek/adapters/report'
-require 'reek/adapters/spec'
+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', 'spec')
 
 include Reek
 include Reek::Spec
@@ -22,8 +20,8 @@ describe ShouldReek, 'checking code in a string' do
   end
 
   it 'reports the smells when should_not fails' do
-    @matcher.matches?(@smelly_code).should be_true
-    @matcher.failure_message_for_should_not.should include(QuietReport.new(@smelly_code.sniff).report)
+    @matcher.matches?(@smelly_code)
+    @matcher.failure_message_for_should_not.should match('UncommunicativeName')
   end
 end
 
@@ -43,8 +41,8 @@ describe ShouldReek, 'checking code in a Dir' do
   end
 
   it 'reports the smells when should_not fails' do
-    @matcher.matches?(@smelly_dir).should be_true
-    @matcher.failure_message_for_should_not.should include(QuietReport.new(@smelly_dir.sniff.sniffers).report)
+    @matcher.matches?(@smelly_dir)
+    @matcher.failure_message_for_should_not.should match('UncommunicativeName')
   end
 end
 
@@ -64,29 +62,7 @@ describe ShouldReek, 'checking code in a File' do
   end
 
   it 'reports the smells when should_not fails' do
-    @matcher.matches?(@smelly_file).should be_true
-    @matcher.failure_message_for_should_not.should include(QuietReport.new(@smelly_file.sniff).report)
-  end
-end
-
-describe ShouldReek, 'report formatting' do
-  before :each do
-    sn_clean = 'def clean() @thing = 4; end'.sniff
-    sn_dirty = 'def dirty() thing.cool + thing.cool; end'.sniff
-    sniffers = SnifferSet.new([sn_clean, sn_dirty], '')
-    @matcher = ShouldReek.new
-    @matcher.matches?(sniffers)
-    @lines = @matcher.failure_message_for_should_not.split("\n").map {|str| str.chomp}
-    @error_message = @lines.shift
-    @smells = @lines.grep(/^  /)
-    @headers = (@lines - @smells)
-  end
-
-  it 'mentions every smell in the report' do
-    @smells.should have(2).warnings
-  end
-
-  it 'doesnt mention the clean files' do
-    @headers.should have(1).headers
+    @matcher.matches?(@smelly_file)
+    @matcher.failure_message_for_should_not.should match('UncommunicativeName')
   end
 end

data/spec/samples/all_but_one_masked/clean_one.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/all_but_one_masked/dirty.rb

@@ -1,3 +1,4 @@
+# smelly class for testing purposes
 class Dirty
   def a
     puts @s.title

data/spec/samples/all_but_one_masked/masked.reek

@@ -1,5 +1,9 @@
 ---
 Duplication:
   enabled: false
-UncommunicativeName:
+UncommunicativeVariableName:
+  enabled: false
+UncommunicativeMethodName:
+  enabled: false
+UncommunicativeParameterName:
   enabled: false

data/spec/samples/clean_due_to_masking/clean_one.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/clean_due_to_masking/clean_three.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/clean_due_to_masking/clean_two.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/clean_due_to_masking/dirty_one.rb

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

data/spec/samples/clean_due_to_masking/dirty_two.rb

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

data/spec/samples/clean_due_to_masking/masked.reek

@@ -1,7 +1,11 @@
 ---
 Duplication:
   enabled: false
+IrresponsibleModule:
+  enabled: false
 NestedIterators:
   enabled: false
-UncommunicativeName:
+UncommunicativeVariableName:
+  enabled: false
+UncommunicativeMethodName:
   enabled: false

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/corrupt_config_file/dirty.rb

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