reek 2.0.4 → 2.1.0

data/spec/reek/smells/uncommunicative_parameter_name_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
-require 'reek/smells/uncommunicative_parameter_name'
-require 'reek/smells/smell_detector_shared'
-require 'reek/core/method_context'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/smells/uncommunicative_parameter_name'
+require_relative 'smell_detector_shared'
+require_relative '../../../lib/reek/core/method_context'
 
 describe Reek::Smells::UncommunicativeParameterName do
   before :each do
@@ -69,7 +69,7 @@ describe Reek::Smells::UncommunicativeParameterName do
   context 'looking at the smell result fields' do
     before :each do
       src = 'def bad(good, bad2, good_again); basics(good, bad2, good_again); end'
-      ctx = Reek::Core::MethodContext.new(nil, src.to_reek_source.syntax_tree)
+      ctx = Reek::Core::MethodContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
       @smells = @detector.examine_context(ctx)
       @warning = @smells[0]
     end

data/spec/reek/smells/uncommunicative_variable_name_spec.rb

@@ -1,6 +1,6 @@
-require 'spec_helper'
-require 'reek/smells/uncommunicative_variable_name'
-require 'reek/smells/smell_detector_shared'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/smells/uncommunicative_variable_name'
+require_relative 'smell_detector_shared'
 
 describe Reek::Smells::UncommunicativeVariableName do
   before :each do
@@ -52,7 +52,8 @@ describe Reek::Smells::UncommunicativeVariableName do
 
     it 'reports variable name only once' do
       src = 'def simple(fred) x = jim(45); x = y end'
-      ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
+      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
+      ctx = Reek::Core::CodeContext.new(nil, syntax_tree)
       smells = @detector.examine_context(ctx)
       expect(smells.length).to eq(1)
       expect(smells[0].smell_type).to eq(described_class.smell_type)
@@ -163,7 +164,8 @@ describe Reek::Smells::UncommunicativeVariableName do
           end
         end
       EOS
-      ctx = CodeContext.new(nil, src.to_reek_source.syntax_tree)
+      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
+      ctx = Reek::Core::CodeContext.new(nil, syntax_tree)
       @smells = @detector.examine_context(ctx)
       @warning = @smells[0]
     end
@@ -179,7 +181,8 @@ describe Reek::Smells::UncommunicativeVariableName do
   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)
+      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
+      ctx = Reek::Core::CodeContext.new(nil, syntax_tree)
       @smells = @detector.examine_context(ctx)
       @warning = @smells[0]
     end

data/spec/reek/smells/unused_parameters_spec.rb

@@ -1,6 +1,6 @@
-require 'spec_helper'
-require 'reek/smells/unused_parameters'
-require 'reek/smells/smell_detector_shared'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/smells/unused_parameters'
+require_relative 'smell_detector_shared'
 
 describe Reek::Smells::UnusedParameters do
   context 'for methods' do

data/spec/reek/smells/utility_function_spec.rb

@@ -1,30 +1,50 @@
-require 'spec_helper'
-require 'reek/smells/utility_function'
-require 'reek/smells/smell_detector_shared'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/smells/utility_function'
+require_relative 'smell_detector_shared'
 
 describe Reek::Smells::UtilityFunction do
-  before(:each) do
-    @source_name = 'dummy_source'
-    @detector = build(:smell_detector, smell_type: :UtilityFunction, source: @source_name)
-  end
+  describe 'a detector' do
+    before(:each) do
+      @source_name = 'dummy_source'
+      @detector = build(:smell_detector,
+                        smell_type: :UtilityFunction,
+                        source: @source_name)
+    end
+
+    it_should_behave_like 'SmellDetector'
+
+    context 'when a smells is reported' do
+      before :each do
+        src = <<-EOS
+        def simple(arga)
+          arga.b.c
+        end
+        EOS
+        source = Reek::Source::SourceCode.from(src)
+        mctx = Reek::Core::TreeWalker.new.process_def(source.syntax_tree)
+        @warning = @detector.examine_context(mctx)[0]   # SMELL: too cumbersome!
+      end
+
+      it_should_behave_like 'common fields set correctly'
 
-  it_should_behave_like 'SmellDetector'
+      it 'reports the line number of the method' do
+        expect(@warning.lines).to eq([1])
+      end
+    end
+  end
 
   context 'with a singleton method' do
     ['self', 'local_call', '$global'].each do |receiver|
       it 'ignores the receiver' do
         src = "def #{receiver}.simple(arga) arga.to_s + arga.to_i end"
-        ctx = Reek::Core::MethodContext.new(nil, src.to_reek_source.syntax_tree)
-        expect(@detector.examine_context(ctx)).to be_empty
+        expect(src).not_to reek_of(:UtilityFunction)
       end
     end
   end
 
   context 'with no calls' do
     it 'does not report empty method' do
-      src = 'def simple(arga) end'
-      ctx = Reek::Core::MethodContext.new(nil, src.to_reek_source.syntax_tree)
-      expect(@detector.examine_context(ctx)).to be_empty
+      expect('def simple(arga) end').not_to reek_of(:UtilityFunction)
     end
 
     it 'does not report literal' do
@@ -53,12 +73,12 @@ describe Reek::Smells::UtilityFunction do
   end
 
   context 'with only one call' do
-    it 'does not report a call to a parameter' do
-      expect('def simple(arga) arga.to_s end').not_to reek_of(:UtilityFunction,  name: 'simple')
+    it 'reports a call to a parameter' do
+      expect('def simple(arga) arga.to_s end').to reek_of(:UtilityFunction,  name: 'simple')
     end
 
-    it 'does not report a call to a constant' do
-      expect('def simple(arga) FIELDS[arga] end').not_to reek_of(:UtilityFunction)
+    it 'reports a call to a constant' do
+      expect('def simple(arga) FIELDS[arga] end').to reek_of(:UtilityFunction)
     end
   end
 
@@ -66,6 +86,7 @@ describe Reek::Smells::UtilityFunction do
     it 'reports two calls' do
       src = 'def simple(arga) arga.to_s + arga.to_i end'
       expect(src).to reek_of(:UtilityFunction,  name: 'simple')
+      expect(src).not_to reek_of(:FeatureEnvy)
     end
 
     it 'counts a local call in a param initializer' do
@@ -88,7 +109,9 @@ describe Reek::Smells::UtilityFunction do
     end
 
     it 'should report message chain' do
-      expect('def simple(arga) arga.b.c end').to reek_of(:UtilityFunction,  name: 'simple')
+      src = 'def simple(arga) arga.b.c end'
+      expect(src).to reek_of(:UtilityFunction,  name: 'simple')
+      expect(src).not_to reek_of(:FeatureEnvy)
     end
 
     it 'does not report a method that calls super' do
@@ -110,23 +133,4 @@ describe Reek::Smells::UtilityFunction do
       expect(src).not_to reek_of(:UtilityFunction)
     end
   end
-
-  context 'when a smells is reported' do
-    before :each do
-      src = <<-EOS
-        def simple(arga)
-          arga.b.c
-        end
-      EOS
-      source = src.to_reek_source
-      mctx = Reek::Core::TreeWalker.new.process_def(source.syntax_tree)
-      @warning = @detector.examine_context(mctx)[0]   # SMELL: too cumbersome!
-    end
-
-    it_should_behave_like 'common fields set correctly'
-
-    it 'reports the line number of the method' do
-      expect(@warning.lines).to eq([1])
-    end
-  end
 end

data/spec/reek/source/code_comment_spec.rb

@@ -1,12 +1,10 @@
-require 'spec_helper'
-require 'reek/source/code_comment'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/source/code_comment'
 
-include Reek::Source
-
-describe CodeComment do
+describe Reek::Source::CodeComment do
   context 'with an empty comment' do
     before :each do
-      @comment = CodeComment.new('')
+      @comment = Reek::Source::CodeComment.new('')
     end
     it 'is not descriptive' do
       expect(@comment).not_to be_descriptive
@@ -18,34 +16,37 @@ describe CodeComment do
 
   context 'comment checks' do
     it 'rejects an empty comment' do
-      expect(CodeComment.new('#')).not_to be_descriptive
+      expect(Reek::Source::CodeComment.new('#')).not_to be_descriptive
     end
     it 'rejects a 1-word comment' do
-      expect(CodeComment.new("# fred\n#  ")).not_to be_descriptive
+      expect(Reek::Source::CodeComment.new("# fred\n#  ")).not_to be_descriptive
     end
     it 'accepts a 2-word comment' do
-      expect(CodeComment.new('# fred here  ')).to be_descriptive
+      expect(Reek::Source::CodeComment.new('# fred here  ')).to be_descriptive
     end
     it 'accepts a multi-word comment' do
-      expect(CodeComment.new("# fred here \n# with \n   # biscuits ")).to be_descriptive
+      comment = "# fred here \n# with \n   # biscuits "
+      expect(Reek::Source::CodeComment.new(comment)).to be_descriptive
     end
   end
 
   context 'comment config' do
     it 'parses hashed options' do
-      config = CodeComment.new('# :reek:Duplication: { enabled: false }').config
+      comment = '# :reek:Duplication: { enabled: false }'
+      config = Reek::Source::CodeComment.new(comment).config
       expect(config).to include('Duplication')
       expect(config['Duplication']).to include('enabled')
       expect(config['Duplication']['enabled']).to be_falsey
     end
     it 'parses hashed options with ruby names' do
-      config = CodeComment.new('# :reek:nested_iterators: { enabled: true }').config
+      comment = '# :reek:nested_iterators: { enabled: true }'
+      config = Reek::Source::CodeComment.new(comment).config
       expect(config).to include('NestedIterators')
       expect(config['NestedIterators']).to include('enabled')
       expect(config['NestedIterators']['enabled']).to be_truthy
     end
     it 'parses multiple hashed options' do
-      config = CodeComment.new('
+      config = Reek::Source::CodeComment.new('
         # :reek:Duplication: { enabled: false }
         :reek:nested_iterators: { enabled: true }
       ').config
@@ -56,7 +57,7 @@ describe CodeComment do
       expect(config['NestedIterators']['enabled']).to be_truthy
     end
     it 'parses multiple hashed options on the same line' do
-      config = CodeComment.new('
+      config = Reek::Source::CodeComment.new('
         #:reek:Duplication: { enabled: false } and :reek:nested_iterators: { enabled: true }
       ').config
       expect(config).to include('Duplication', 'NestedIterators')
@@ -66,7 +67,8 @@ describe CodeComment do
       expect(config['NestedIterators']['enabled']).to be_truthy
     end
     it 'parses multiple unhashed options on the same line' do
-      config = CodeComment.new('# :reek:Duplication and :reek:nested_iterators').config
+      comment = '# :reek:Duplication and :reek:nested_iterators'
+      config = Reek::Source::CodeComment.new(comment).config
       expect(config).to include('Duplication', 'NestedIterators')
       expect(config['Duplication']).to include('enabled')
       expect(config['Duplication']['enabled']).to be_falsey
@@ -74,13 +76,13 @@ describe CodeComment do
       expect(config['NestedIterators']['enabled']).to be_falsey
     end
     it 'disables the smell if no options are specifed' do
-      config = CodeComment.new('# :reek:Duplication').config
+      config = Reek::Source::CodeComment.new('# :reek:Duplication').config
       expect(config).to include('Duplication')
       expect(config['Duplication']).to include('enabled')
       expect(config['Duplication']['enabled']).to be_falsey
     end
     it 'ignores smells after a space' do
-      config = CodeComment.new('# :reek: Duplication').config
+      config = Reek::Source::CodeComment.new('# :reek: Duplication').config
       expect(config).not_to include('Duplication')
     end
   end

data/spec/reek/source/object_source_spec.rb

@@ -1,6 +1,4 @@
-require 'spec_helper'
-
-include Reek
+require_relative '../../spec_helper'
 
 describe Dir do
   it 'reports correct smells via the Dir matcher' do

data/spec/reek/source/reference_collector_spec.rb

@@ -1,12 +1,11 @@
-require 'spec_helper'
-require 'reek/source/reference_collector'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/source/reference_collector'
 
-include Reek::Source
-
-describe ReferenceCollector do
+describe Reek::Source::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
+      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
+      Reek::Source::ReferenceCollector.new(syntax_tree).num_refs_to_self
     end
     it 'with no refs to self' do
       expect(refs_to_self('def no_envy(arga) arga.barg end')).to eq(0)

data/spec/reek/source/sexp_extensions_spec.rb

@@ -1,9 +1,7 @@
-require 'spec_helper'
-require 'reek/source/sexp_extensions'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/source/sexp_extensions'
 
-include Reek::Source
-
-describe SexpExtensions::DefNode do
+describe Reek::Source::SexpExtensions::DefNode do
   context 'with no parameters' do
     before :each do
       @node = s(:def, :hello, s(:args))
@@ -112,7 +110,7 @@ describe SexpExtensions::DefNode do
 
     it 'has a body extended with SexpNode' do
       b = @node.body
-      expect(b.class.included_modules.first).to eq SexpNode
+      expect(b.class.included_modules.first).to eq Reek::Source::SexpNode
     end
 
     it 'finds nodes in the body with #body_nodes' do
@@ -135,7 +133,7 @@ describe SexpExtensions::DefNode do
   end
 end
 
-describe SexpExtensions::DefsNode do
+describe Reek::Source::SexpExtensions::DefsNode do
   context 'with no parameters' do
     before :each do
       @node = s(:defs, s(:lvar, :obj), :hello, s(:args))
@@ -244,12 +242,12 @@ describe SexpExtensions::DefsNode do
 
     it 'has a body extended with SexpNode' do
       b = @node.body
-      expect(b.class.included_modules.first).to eq SexpNode
+      expect(b.class.included_modules.first).to eq Reek::Source::SexpNode
     end
   end
 end
 
-describe SexpExtensions::SendNode do
+describe Reek::Source::SexpExtensions::SendNode do
   context 'with no parameters' do
     before :each do
       @node = s(:send, nil, :hello)
@@ -281,7 +279,7 @@ describe SexpExtensions::SendNode do
   end
 end
 
-describe SexpExtensions::BlockNode do
+describe Reek::Source::SexpExtensions::BlockNode do
   context 'with no parameters' do
     before :each do
       @node = s(:block, s(:send, nil, :map), s(:args), nil)
@@ -313,7 +311,7 @@ describe SexpExtensions::BlockNode do
   end
 end
 
-describe SexpExtensions::ModuleNode do
+describe Reek::Source::SexpExtensions::ModuleNode do
   context 'with a simple name' do
     subject do
       mod = ast(:module, :Fred, nil)

data/spec/reek/source/sexp_formatter_spec.rb

@@ -1,17 +1,16 @@
-require 'spec_helper'
-require 'reek/source/sexp_formatter'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/source/sexp_formatter'
 
-include Reek::Source
-
-describe SexpFormatter do
+describe Reek::Source::SexpFormatter do
   describe '::format' do
     it 'formats a simple s-expression' do
-      result = SexpFormatter.format s(:lvar, :foo)
+      result = Reek::Source::SexpFormatter.format s(:lvar, :foo)
       expect(result).to eq('foo')
     end
 
     it 'formats a more complex s-expression' do
-      result = SexpFormatter.format s(:send, nil, :foo, s(:lvar, :bar))
+      ast = s(:send, nil, :foo, s(:lvar, :bar))
+      result = Reek::Source::SexpFormatter.format(ast)
       expect(result).to eq('foo(bar)')
     end
 
@@ -22,7 +21,7 @@ describe SexpFormatter do
               s(:begin,
                 s(:send, nil, :baz),
                 s(:send, nil, :qux)))
-      result = SexpFormatter.format ast
+      result = Reek::Source::SexpFormatter.format ast
 
       expect(result).to eq 'if foo ... end'
     end

data/spec/reek/source/sexp_node_spec.rb

@@ -1,9 +1,7 @@
-require 'spec_helper'
-require 'reek/source/sexp_node'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/source/sexp_node'
 
-include Reek::Source
-
-describe SexpNode do
+describe Reek::Source::SexpNode do
   context 'format' do
     it 'formats self' do
       @node = s(:self)

data/spec/reek/source/source_code_spec.rb

@@ -1,25 +1,25 @@
-require 'spec_helper'
+require_relative '../../spec_helper'
 require 'stringio'
-require 'reek/source/source_code'
+require_relative '../../../lib/reek/source/source_code'
 
-include Reek::Source
-
-describe SourceCode do
+describe Reek::Source::SourceCode do
   describe '#syntax_tree' do
     it 'associates comments with the AST' do
-      source_code = SourceCode.new("# this is\n# a comment\ndef foo; end", '(string)')
+      source = "# this is\n# a comment\ndef foo; end"
+      source_code = Reek::Source::SourceCode.new(source, '(string)')
       result = source_code.syntax_tree
       expect(result.comments).to eq "# this is\n# a comment"
     end
 
     it 'cleanly processes empty source' do
-      source_code = SourceCode.new('', '(string)')
+      source_code = Reek::Source::SourceCode.new('', '(string)')
       result = source_code.syntax_tree
       expect(result).to be_nil
     end
 
     it 'cleanly processes empty source with comments' do
-      source_code = SourceCode.new("# this is\n# a comment\n", '(string)')
+      source = "# this is\n# a comment\n"
+      source_code = Reek::Source::SourceCode.new(source, '(string)')
       result = source_code.syntax_tree
       expect(result).to be_nil
     end
@@ -29,7 +29,7 @@ describe SourceCode do
     let(:source_name) { 'Test source' }
     let(:error_message) { 'Error message' }
     let(:parser) { double('parser') }
-    let(:src) { SourceCode.new('', source_name, parser) }
+    let(:src) { Reek::Source::SourceCode.new('', source_name, parser) }
 
     before :each do
       @catcher = StringIO.new