reek 2.2.1 → 3.0.0

data/spec/reek/{cli → report}/xml_report_spec.rb

@@ -1,13 +1,13 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/examiner'
-require_relative '../../../lib/reek/cli/report/report'
-require_relative '../../../lib/reek/cli/report/formatter'
+require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/report/report'
+require_relative '../../../lib/reek/report/formatter'
 
-RSpec.describe Reek::CLI::Report::XMLReport do
-  let(:instance) { Reek::CLI::Report::XMLReport.new }
+RSpec.describe Reek::Report::XMLReport do
+  let(:instance) { Reek::Report::XMLReport.new }
 
   context 'empty source' do
-    let(:examiner) { Reek::Core::Examiner.new('') }
+    let(:examiner) { Reek::Examiner.new('') }
 
     before do
       instance.add_examiner examiner
@@ -19,7 +19,7 @@ RSpec.describe Reek::CLI::Report::XMLReport do
   end
 
   context 'source with voliations' do
-    let(:examiner) { Reek::Core::Examiner.new('def simple(a) a[0] end') }
+    let(:examiner) { Reek::Examiner.new('def simple(a) a[0] end') }
 
     before do
       allow(File).to receive(:realpath).and_return('/some/path')

data/spec/reek/report/yaml_report_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/report/report'
+require_relative '../../../lib/reek/report/formatter'
+
+RSpec.describe Reek::Report::YAMLReport do
+  let(:instance) { Reek::Report::YAMLReport.new }
+
+  context 'empty source' do
+    let(:examiner) { Reek::Examiner.new('') }
+
+    before do
+      instance.add_examiner examiner
+    end
+
+    it 'prints empty yaml' do
+      expect { instance.show }.to output(/^--- \[\]\n.*$/).to_stdout
+    end
+  end
+end

data/spec/reek/smells/attribute_spec.rb

@@ -1,11 +1,12 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/smells/attribute'
+require_relative '../../../lib/reek/smells/smell_configuration'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::Attribute do
   let(:config) do
     {
-      Attribute: { Reek::Core::SmellConfiguration::ENABLED_KEY => true }
+      Attribute: { Reek::Smells::SmellConfiguration::ENABLED_KEY => true }
     }
   end
 

data/spec/reek/smells/boolean_parameter_spec.rb

@@ -75,7 +75,7 @@ RSpec.describe Reek::Smells::BooleanParameter do
 
     it 'reports the fields correctly' do
       src = 'def cc(arga = true) end'
-      ctx = Reek::Core::MethodContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+      ctx = Reek::Context::MethodContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
       @detector.examine(ctx)
       smells = @detector.smells_found.to_a
       expect(smells.length).to eq(1)

data/spec/reek/smells/class_variable_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/smells/class_variable'
-require_relative '../../../lib/reek/core/module_context'
+require_relative '../../../lib/reek/context/module_context'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::ClassVariable do
@@ -15,12 +15,12 @@ RSpec.describe Reek::Smells::ClassVariable do
   context 'with no class variables' do
     it 'records nothing in the class' do
       exp = ast(:class, :Fred)
-      expect(@detector.examine_context(Reek::Core::CodeContext.new(nil, exp))).to be_empty
+      expect(@detector.examine_context(Reek::Context::CodeContext.new(nil, exp))).to be_empty
     end
 
     it 'records nothing in the module' do
       exp = ast(:module, :Fred)
-      expect(@detector.examine_context(Reek::Core::CodeContext.new(nil, exp))).to be_empty
+      expect(@detector.examine_context(Reek::Context::CodeContext.new(nil, exp))).to be_empty
     end
   end
 
@@ -28,7 +28,7 @@ RSpec.describe Reek::Smells::ClassVariable do
     shared_examples_for 'one variable found' do
       before :each do
         ast = Reek::Source::SourceCode.from(@src).syntax_tree
-        @smells = @detector.examine_context(Reek::Core::CodeContext.new(nil, ast))
+        @smells = @detector.examine_context(Reek::Context::CodeContext.new(nil, ast))
       end
 
       it 'records only that class variable' do
@@ -99,7 +99,7 @@ RSpec.describe Reek::Smells::ClassVariable do
         #{@class_variable} = {}
       end
     EOS
-    ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+    ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
     @warning = @detector.examine_context(ctx)[0]
     expect(@warning.source).to eq(@source_name)
     expect(@warning.smell_category).to eq(described_class.smell_category)

data/spec/reek/smells/control_parameter_spec.rb

@@ -272,7 +272,7 @@ RSpec.describe Reek::Smells::ControlParameter do
           puts "hello" if arg
         end
       EOS
-      ctx = Reek::Core::MethodContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+      ctx = Reek::Context::MethodContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
       smells = @detector.examine(ctx)
       expect(smells.length).to eq(1)
       @warning = smells[0]

data/spec/reek/smells/data_clump_spec.rb

@@ -25,7 +25,7 @@ RSpec.shared_examples_for 'a data clump detector' do
           def third(pa, pb) pa - pb + @fred; end
         end
       EOS
-      ctx = Reek::Core::ModuleContext.new(nil, Reek::Source::SourceCode.from(@src).syntax_tree)
+      ctx = Reek::Context::ModuleContext.new(nil, Reek::Source::SourceCode.from(@src).syntax_tree)
       detector = build(:smell_detector, smell_type: :DataClump)
       @smells = detector.examine_context(ctx)
     end

data/spec/reek/smells/duplicate_method_call_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/smells/duplicate_method_call'
-require_relative '../../../lib/reek/core/code_context'
-require_relative '../../../lib/reek/core/tree_walker'
+require_relative '../../../lib/reek/context/code_context'
+require_relative '../../../lib/reek/tree_walker'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::DuplicateMethodCall do
@@ -16,7 +16,7 @@ RSpec.describe Reek::Smells::DuplicateMethodCall do
           other[@thing]
         end
       EOS
-      ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+      ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
       smells = @detector.examine_context(ctx)
       expect(smells.length).to eq(1)
       @warning = smells[0]

data/spec/reek/smells/feature_envy_spec.rb

@@ -231,7 +231,7 @@ RSpec.describe Reek::Smells::FeatureEnvy do
         end
       EOS
       source = Reek::Source::SourceCode.from(src)
-      @mctx = Reek::Core::TreeWalker.new.process_def(source.syntax_tree)
+      @mctx = Reek::TreeWalker.new.process_def(source.syntax_tree)
       @smells = @detector.examine_context(@mctx)
     end
 

data/spec/reek/smells/irresponsible_module_spec.rb

@@ -1,17 +1,9 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/code_context'
+require_relative '../../../lib/reek/context/code_context'
 require_relative '../../../lib/reek/smells/irresponsible_module'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::IrresponsibleModule do
-  before(:each) do
-    @bad_module_name = 'WrongUn'
-    @source_name = 'dummy_source'
-    @detector = build(:smell_detector, smell_type: :IrresponsibleModule, source: @source_name)
-  end
-
-  it_should_behave_like 'SmellDetector'
-
   it 'does not report re-opened modules' do
     src = <<-EOS
       # Abstract base class
@@ -27,19 +19,12 @@ RSpec.describe Reek::Smells::IrresponsibleModule do
       # test class
       class Responsible; end
     EOS
-    ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
-    expect(@detector.examine_context(ctx)).to be_empty
+    expect(src).not_to reek_of(:IrresponsibleModule)
   end
 
   it 'reports a class without a comment' do
-    src = "class #{@bad_module_name}; end"
-    ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
-    smells = @detector.examine_context(ctx)
-    expect(smells.length).to eq(1)
-    expect(smells[0].smell_category).to eq(Reek::Smells::IrresponsibleModule.smell_category)
-    expect(smells[0].smell_type).to eq(Reek::Smells::IrresponsibleModule.smell_type)
-    expect(smells[0].lines).to eq([1])
-    expect(smells[0].parameters[:name]).to eq(@bad_module_name)
+    src = 'class BadClass; end'
+    expect(src).to reek_of :IrresponsibleModule, name: 'BadClass'
   end
 
   it 'reports a class with an empty comment' do
@@ -47,7 +32,7 @@ RSpec.describe Reek::Smells::IrresponsibleModule do
       #
       #
       #
-      class #{@bad_module_name}; end
+      class BadClass; end
     EOS
     expect(src).to reek_of :IrresponsibleModule
   end
@@ -63,14 +48,25 @@ RSpec.describe Reek::Smells::IrresponsibleModule do
     expect(src).to reek_of(:IrresponsibleModule)
   end
 
-  it 'reports a fq module name correctly' do
+  it 'reports a class with a trailing comment' do
+    src = <<-EOS
+      class BadClass
+      end # end BadClass
+    EOS
+    expect(src).to reek_of(:IrresponsibleModule)
+  end
+
+  it 'reports a fully qualified class name correctly' do
     src = 'class Foo::Bar; end'
-    ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
-    smells = @detector.examine_context(ctx)
-    expect(smells.length).to eq(1)
-    expect(smells[0].smell_category).to eq(described_class.smell_category)
-    expect(smells[0].smell_type).to eq(described_class.smell_type)
-    expect(smells[0].parameters[:name]).to eq('Foo::Bar')
-    expect(smells[0].context).to match(/#{smells[0].parameters['name']}/)
+    expect(src).to reek_of :IrresponsibleModule, name: 'Foo::Bar'
+  end
+
+  context 'when a smell is reported' do
+    before do
+      @source_name = 'dummy_source'
+      @detector = build(:smell_detector, smell_type: :IrresponsibleModule, source: @source_name)
+    end
+
+    it_should_behave_like 'SmellDetector'
   end
 end

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/code_context'
+require_relative '../../../lib/reek/context/code_context'
 require_relative '../../../lib/reek/smells/long_parameter_list'
 require_relative 'smell_detector_shared'
 
@@ -89,7 +89,7 @@ RSpec.describe Reek::Smells::LongParameterList do
           true
         end
       EOS
-      ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+      ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
       @smells = @detector.examine_context(ctx)
       @warning = @smells[0]
     end

data/spec/reek/smells/long_yield_list_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/code_context'
+require_relative '../../../lib/reek/context/code_context'
 require_relative '../../../lib/reek/smells/long_yield_list'
 require_relative 'smell_detector_shared'
 
@@ -38,7 +38,7 @@ RSpec.describe Reek::Smells::LongYieldList do
           yield(arga,argb,arga,argb)
           end
       EOS
-      ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+      ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
       @smells = @detector.examine_context(ctx)
       @warning = @smells[0]
     end

data/spec/reek/smells/nested_iterators_spec.rb

@@ -237,7 +237,7 @@ RSpec.describe Reek::Smells::NestedIterators do
           end
         end
       EOS
-      ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+      ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
       @warning = @detector.examine_context(ctx)[0]
     end
 

data/spec/reek/smells/nil_check_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/code_context'
+require_relative '../../../lib/reek/context/code_context'
 require_relative '../../../lib/reek/smells/nil_check'
 require_relative 'smell_detector_shared'
 
@@ -11,7 +11,7 @@ RSpec.describe Reek::Smells::NilCheck do
         foo.nil?
       end
       EOS
-      ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+      ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
       detector = build(:smell_detector, smell_type: :NilCheck, source: 'source_name')
       smells = detector.examine_context(ctx)
       expect(smells[0].lines).to eq [2]

data/spec/reek/smells/prima_donna_method_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/module_context'
+require_relative '../../../lib/reek/context/module_context'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::PrimaDonnaMethod do
@@ -15,8 +15,8 @@ RSpec.describe Reek::Smells::PrimaDonnaMethod do
     let(:detector) { build(:smell_detector, smell_type: :PrimaDonnaMethod, source: 'source_name') }
     let(:src)      { 'class C; def m!; end; end' }
     let(:ctx)      do
-      Reek::Core::ModuleContext.new(nil,
-                                    Reek::Source::SourceCode.from(src).syntax_tree)
+      Reek::Context::ModuleContext.new(nil,
+                                       Reek::Source::SourceCode.from(src).syntax_tree)
     end
 
     it 'should be reported' do

data/spec/reek/smells/repeated_conditional_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/smells/repeated_conditional'
-require_relative '../../../lib/reek/core/code_context'
+require_relative '../../../lib/reek/context/code_context'
 require_relative 'smell_detector_shared'
 require_relative '../../../lib/reek/source/source_code'
 
@@ -15,7 +15,7 @@ RSpec.describe Reek::Smells::RepeatedConditional do
   context 'with no conditionals' do
     it 'gathers an empty hash' do
       ast = Reek::Source::SourceCode.from('module Stable; end').syntax_tree
-      ctx = Reek::Core::CodeContext.new(nil, ast)
+      ctx = Reek::Context::CodeContext.new(nil, ast)
       expect(@detector.conditional_counts(ctx).length).to eq(0)
     end
   end
@@ -23,7 +23,7 @@ RSpec.describe Reek::Smells::RepeatedConditional do
   context 'with a test of block_given?' do
     it 'does not record the condition' do
       ast = Reek::Source::SourceCode.from('def fred() yield(3) if block_given?; end').syntax_tree
-      ctx = Reek::Core::CodeContext.new(nil, ast)
+      ctx = Reek::Context::CodeContext.new(nil, ast)
       expect(@detector.conditional_counts(ctx).length).to eq(0)
     end
   end
@@ -31,7 +31,7 @@ RSpec.describe Reek::Smells::RepeatedConditional do
   context 'with an empty condition' do
     it 'does not record the condition' do
       ast = Reek::Source::SourceCode.from('def fred() case; when 3; end; end').syntax_tree
-      ctx = Reek::Core::CodeContext.new(nil, ast)
+      ctx = Reek::Context::CodeContext.new(nil, ast)
       expect(@detector.conditional_counts(ctx).length).to eq(0)
     end
   end
@@ -58,7 +58,7 @@ RSpec.describe Reek::Smells::RepeatedConditional do
       EOS
 
       ast = Reek::Source::SourceCode.from(src).syntax_tree
-      @ctx = Reek::Core::CodeContext.new(nil, ast)
+      @ctx = Reek::Context::CodeContext.new(nil, ast)
       @conds = @detector.conditional_counts(@ctx)
     end
 
@@ -94,7 +94,7 @@ RSpec.describe Reek::Smells::RepeatedConditional do
       EOS
 
       ast = Reek::Source::SourceCode.from(src).syntax_tree
-      ctx = Reek::Core::CodeContext.new(nil, ast)
+      ctx = Reek::Context::CodeContext.new(nil, ast)
       @conds = @detector.conditional_counts(ctx)
     end
 

data/spec/reek/{core → smells}/smell_configuration_spec.rb

@@ -1,9 +1,9 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/smell_configuration'
+require_relative '../../../lib/reek/smells/smell_configuration'
 
-RSpec.describe Reek::Core::SmellConfiguration do
+RSpec.describe Reek::Smells::SmellConfiguration do
   it 'returns the default value when key not found' do
-    cf = Reek::Core::SmellConfiguration.new({})
+    cf = described_class.new({})
     expect(cf.value('fred', nil, 27)).to eq(27)
   end
 
@@ -12,7 +12,7 @@ RSpec.describe Reek::Core::SmellConfiguration do
       @base_config = { 'enabled' => true, 'exclude' => [],
                        'reject' => [/^.$/, /[0-9]$/, /[A-Z]/],
                        'accept' => ['_'] }
-      @smell_config = Reek::Core::SmellConfiguration.new(@base_config)
+      @smell_config = described_class.new(@base_config)
     end
 
     it { expect(@smell_config.merge!({})).to eq(@base_config) }

data/spec/reek/smells/smell_detector_shared.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/smell_configuration'
+require_relative '../../../lib/reek/smells/smell_configuration'
 
 RSpec.shared_examples_for 'SmellDetector' do
   context 'exception matching follows the context' do
@@ -21,7 +21,7 @@ RSpec.shared_examples_for 'SmellDetector' do
 
   context 'configuration' do
     it 'becomes disabled when disabled' do
-      enabled_key = Reek::Core::SmellConfiguration::ENABLED_KEY
+      enabled_key = Reek::Smells::SmellConfiguration::ENABLED_KEY
       @detector.configure_with(enabled_key => false)
       expect(@detector).not_to be_enabled
     end

data/spec/reek/{core → smells}/smell_repository_spec.rb

@@ -1,9 +1,10 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/smell_repository'
+require_relative '../../../lib/reek/smells/smell_detector'
+require_relative '../../../lib/reek/smells/smell_repository'
 
-RSpec.describe Reek::Core::SmellRepository do
+RSpec.describe Reek::Smells::SmellRepository do
   describe '.smell_types' do
-    let(:smell_types) { Reek::Core::SmellRepository.smell_types }
+    let(:smell_types) { described_class.smell_types }
 
     it 'should include existing smell_types' do
       expect(smell_types).to include(Reek::Smells::IrresponsibleModule)
@@ -19,7 +20,7 @@ RSpec.describe Reek::Core::SmellRepository do
     end
 
     it "should raise an ArgumentError if smell to configure doesn't exist" do
-      repository = Reek::Core::SmellRepository.new
+      repository = described_class.new
       expect { repository.configure('SomethingNonExistant', {}) }.
         to raise_error ArgumentError,
                        'Unknown smell type SomethingNonExistant found in configuration'

data/spec/reek/smells/too_many_instance_variables_spec.rb

@@ -72,7 +72,7 @@ RSpec.describe Reek::Smells::TooManyInstanceVariables do
         end
       end
     EOS
-    ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+    ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
     @warning = @detector.examine_context(ctx)[0]
     expect(@warning.source).to eq(@source_name)
     expect(@warning.smell_category).to eq(Reek::Smells::TooManyInstanceVariables.smell_category)