reek 2.2.1 → 3.0.0

data/spec/reek/{sexp → ast}/sexp_formatter_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/sexp/sexp_formatter'
+require_relative '../../../lib/reek/ast/sexp_formatter'
 
-RSpec.describe Reek::Sexp::SexpFormatter do
+RSpec.describe Reek::AST::SexpFormatter do
   describe '::format' do
     it 'formats a simple s-expression' do
       result = described_class.format s(:lvar, :foo)

data/spec/reek/cli/option_interpreter_spec.rb

@@ -1,6 +1,7 @@
 require_relative '../../spec_helper'
 
 require_relative '../../../lib/reek/cli/options'
+require_relative '../../../lib/reek/report/report'
 
 RSpec.describe Reek::CLI::OptionInterpreter do
   let(:options) { OpenStruct.new }
@@ -8,7 +9,7 @@ RSpec.describe Reek::CLI::OptionInterpreter do
 
   describe '#reporter' do
     it 'returns a Report::TextReport instance by default' do
-      expect(instance.reporter).to be_instance_of Reek::CLI::Report::TextReport
+      expect(instance.reporter).to be_instance_of Reek::Report::TextReport
     end
   end
 end

data/spec/reek/{core → cli}/warning_collector_spec.rb

@@ -1,10 +1,10 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/warning_collector'
+require_relative '../../../lib/reek/cli/warning_collector'
 require_relative '../../../lib/reek/smells/smell_warning'
 
-RSpec.describe Reek::Core::WarningCollector do
+RSpec.describe Reek::CLI::WarningCollector do
   before(:each) do
-    @collector = Reek::Core::WarningCollector.new
+    @collector = described_class.new
   end
 
   context 'when empty' do

data/spec/reek/{core/code_comment_spec.rb → code_comment_spec.rb}

@@ -1,7 +1,7 @@
-require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/code_comment'
+require_relative '../spec_helper'
+require_relative '../../lib/reek/code_comment'
 
-RSpec.describe Reek::Core::CodeComment do
+RSpec.describe Reek::CodeComment do
   context 'with an empty comment' do
     before :each do
       @comment = described_class.new('')

data/spec/reek/configuration/app_configuration_spec.rb

@@ -1,9 +1,9 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/configuration/app_configuration'
-require_relative '../../../lib/reek/core/smell_repository'
+require_relative '../../../lib/reek/smells/smell_repository'
 
 RSpec.describe Reek::Configuration::AppConfiguration do
-  let(:sample_configuration_path) { 'spec/samples/simple_configuration.reek' }
+  let(:sample_configuration_path) { 'spec/samples/configuration/simple_configuration.reek' }
   let(:sample_configuration_loaded) do
     {
       'UncommunicativeVariableName' => { 'enabled' => false },
@@ -12,32 +12,32 @@ RSpec.describe Reek::Configuration::AppConfiguration do
   end
   let(:default_configuration) { Hash.new }
 
-  after(:each) { Reek::Configuration::AppConfiguration.reset }
+  after(:each) { described_class.reset }
 
   describe '.initialize_with' do
     it 'loads a configuration file if it can find one' do
       finder = Reek::Configuration::ConfigurationFileFinder
       allow(finder).to receive(:find).and_return sample_configuration_path
-      expect(Reek::Configuration::AppConfiguration.configuration).to eq(default_configuration)
+      expect(described_class.configuration).to eq(default_configuration)
 
-      Reek::Configuration::AppConfiguration.initialize_with(nil)
-      expect(Reek::Configuration::AppConfiguration.configuration).to eq(sample_configuration_loaded)
+      described_class.initialize_with(nil)
+      expect(described_class.configuration).to eq(sample_configuration_loaded)
     end
 
     it 'leaves the default configuration untouched if it can\'t find one' do
       allow(Reek::Configuration::ConfigurationFileFinder).to receive(:find).and_return nil
-      expect(Reek::Configuration::AppConfiguration.configuration).to eq(default_configuration)
+      expect(described_class.configuration).to eq(default_configuration)
 
-      Reek::Configuration::AppConfiguration.initialize_with(nil)
-      expect(Reek::Configuration::AppConfiguration.configuration).to eq(default_configuration)
+      described_class.initialize_with(nil)
+      expect(described_class.configuration).to eq(default_configuration)
     end
   end
 
   describe '.configure_smell_repository' do
     it 'should configure a given smell_repository' do
-      Reek::Configuration::AppConfiguration.load_from_file(sample_configuration_path)
-      smell_repository = Reek::Core::SmellRepository.new('def m; end')
-      Reek::Configuration::AppConfiguration.configure_smell_repository smell_repository
+      described_class.load_from_file(sample_configuration_path)
+      smell_repository = Reek::Smells::SmellRepository.new('def m; end')
+      described_class.configure_smell_repository smell_repository
 
       expect(smell_repository.detectors[Reek::Smells::DataClump]).to be_enabled
       expect(smell_repository.detectors[Reek::Smells::UncommunicativeVariableName]).
@@ -46,20 +46,33 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
   end
 
+  describe '.exclude_paths' do
+    let(:config_path) { 'spec/samples/configuration/with_excluded_paths.reek' }
+
+    it 'should return all paths to exclude' do
+      with_test_config(config_path) do
+        expect(described_class.exclude_paths).to eq [
+          'spec/samples/source_with_exclude_paths/ignore_me',
+          'spec/samples/source_with_exclude_paths/nested/ignore_me_as_well'
+        ]
+      end
+    end
+  end
+
   describe '.load_from_file' do
     it 'loads the configuration from given file' do
-      Reek::Configuration::AppConfiguration.load_from_file(sample_configuration_path)
-      expect(Reek::Configuration::AppConfiguration.configuration).to eq(sample_configuration_loaded)
+      described_class.load_from_file(sample_configuration_path)
+      expect(described_class.configuration).to eq(sample_configuration_loaded)
     end
   end
 
   describe '.reset' do
     it 'resets the configuration' do
-      Reek::Configuration::AppConfiguration.load_from_file(sample_configuration_path)
+      described_class.load_from_file(sample_configuration_path)
 
-      expect(Reek::Configuration::AppConfiguration.configuration).to eq(sample_configuration_loaded)
-      Reek::Configuration::AppConfiguration.reset
-      expect(Reek::Configuration::AppConfiguration.configuration).to eq(default_configuration)
+      expect(described_class.configuration).to eq(sample_configuration_loaded)
+      described_class.reset
+      expect(described_class.configuration).to eq(default_configuration)
     end
   end
 end

data/spec/reek/{core → context}/code_context_spec.rb

@@ -1,9 +1,9 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/method_context'
-require_relative '../../../lib/reek/core/module_context'
-require_relative '../../../lib/reek/core/stop_context'
+require_relative '../../../lib/reek/context/method_context'
+require_relative '../../../lib/reek/context/module_context'
+require_relative '../../../lib/reek/context/root_context'
 
-RSpec.describe Reek::Core::CodeContext do
+RSpec.describe Reek::Context::CodeContext do
   context 'name recognition' do
     before :each do
       @exp_name = 'random_name'    # SMELL: could use a String.random here
@@ -11,8 +11,7 @@ RSpec.describe Reek::Core::CodeContext do
       @exp = double('exp')
       allow(@exp).to receive(:name).and_return(@exp_name)
       allow(@exp).to receive(:full_name).and_return(@full_name)
-      allow(@exp).to receive(:comments).and_return('')
-      @ctx = Reek::Core::CodeContext.new(nil, @exp)
+      @ctx = Reek::Context::CodeContext.new(nil, @exp)
     end
     it 'gets its short name from the exp' do
       expect(@ctx.name).to eq(@exp_name)
@@ -42,7 +41,7 @@ RSpec.describe Reek::Core::CodeContext do
         @outer_name = 'another_random sting'
         allow(outer).to receive(:full_name).at_least(:once).and_return(@outer_name)
         allow(outer).to receive(:config).and_return({})
-        @ctx = Reek::Core::CodeContext.new(outer, @exp)
+        @ctx = Reek::Context::CodeContext.new(outer, @exp)
       end
       it 'creates the correct full name' do
         expect(@ctx.full_name).to eq("#{@full_name}")
@@ -58,10 +57,10 @@ RSpec.describe Reek::Core::CodeContext do
 
   context 'generics' do
     it 'should pass unknown method calls down the stack' do
-      stop = Reek::Core::StopContext.new
+      stop = Reek::Context::RootContext.new
       def stop.bananas(arg1, arg2) arg1 + arg2 + 43 end
-      element = Reek::Core::ModuleContext.new(stop, s(:module, :mod, nil))
-      element = Reek::Core::MethodContext.new(element, s(:def, :bad, s(:args), nil))
+      element = Reek::Context::ModuleContext.new(stop, s(:module, :mod, nil))
+      element = Reek::Context::MethodContext.new(element, s(:def, :bad, s(:args), nil))
       expect(element.bananas(17, -5)).to eq(55)
     end
   end
@@ -72,7 +71,7 @@ RSpec.describe Reek::Core::CodeContext do
         @module_name = 'Emptiness'
         src = "module #{@module_name}; end"
         ast = Reek::Source::SourceCode.from(src).syntax_tree
-        @ctx = Reek::Core::CodeContext.new(nil, ast)
+        @ctx = Reek::Context::CodeContext.new(nil, ast)
       end
 
       it 'yields no calls' do
@@ -104,7 +103,7 @@ RSpec.describe Reek::Core::CodeContext do
         @method_name = 'calloo'
         src = "module #{@module_name}; def #{@method_name}; puts('hello') end; end"
         ast = Reek::Source::SourceCode.from(src).syntax_tree
-        @ctx = Reek::Core::CodeContext.new(nil, ast)
+        @ctx = Reek::Context::CodeContext.new(nil, ast)
       end
       it 'yields no ifs' do
         @ctx.each_node(:if, []) { |exp| raise "#{exp} yielded by empty module!" }
@@ -156,7 +155,7 @@ end
 EOS
 
       ast = Reek::Source::SourceCode.from(src).syntax_tree
-      ctx = Reek::Core::CodeContext.new(nil, ast)
+      ctx = Reek::Context::CodeContext.new(nil, ast)
       expect(ctx.each_node(:if, []).length).to eq(3)
     end
   end
@@ -164,12 +163,12 @@ EOS
   describe '#config_for' do
     let(:expression) { double('exp') }
     let(:outer) { nil }
-    let(:context) { Reek::Core::CodeContext.new(outer, expression) }
+    let(:context) { Reek::Context::CodeContext.new(outer, expression) }
     let(:sniffer) { double('sniffer') }
 
     before :each do
       allow(sniffer).to receive(:smell_type).and_return('DuplicateMethodCall')
-      allow(expression).to receive(:comments).and_return(
+      allow(expression).to receive(:full_comment).and_return(
         ':reek:DuplicateMethodCall: { allow_calls: [ puts ] }')
     end
 

data/spec/reek/{core → context}/method_context_spec.rb

@@ -1,12 +1,12 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/method_context'
-require_relative '../../../lib/reek/core/stop_context'
+require_relative '../../../lib/reek/context/method_context'
+require_relative '../../../lib/reek/context/root_context'
 
-RSpec.describe Reek::Core::MethodContext, 'matching' do
+RSpec.describe Reek::Context::MethodContext, 'matching' do
   before :each do
     exp = double('exp').as_null_object
     expect(exp).to receive(:full_name).at_least(:once).and_return('mod')
-    @element = Reek::Core::MethodContext.new(Reek::Core::StopContext.new, exp)
+    @element = Reek::Context::MethodContext.new(Reek::Context::RootContext.new, exp)
   end
 
   it 'should recognise itself in a collection of names' do
@@ -20,10 +20,10 @@ RSpec.describe Reek::Core::MethodContext, 'matching' do
   end
 end
 
-RSpec.describe Reek::Core::MethodContext do
+RSpec.describe Reek::Context::MethodContext do
   let(:mc) do
     sexp = s(:def, :foo, s(:args, s(:arg, :bar)), nil)
-    Reek::Core::MethodContext.new(Reek::Core::StopContext.new, sexp)
+    Reek::Context::MethodContext.new(Reek::Context::RootContext.new, sexp)
   end
 
   describe '#envious_receivers' do
@@ -51,10 +51,10 @@ RSpec.describe Reek::Core::MethodContext do
   end
 end
 
-RSpec.describe Reek::Core::MethodParameters, 'default assignments' do
+RSpec.describe Reek::Context::MethodParameters, 'default assignments' do
   def assignments_from(src)
     exp = Reek::Source::SourceCode.from(src).syntax_tree
-    ctx = Reek::Core::MethodContext.new(Reek::Core::StopContext.new, exp)
+    ctx = Reek::Context::MethodContext.new(Reek::Context::RootContext.new, exp)
     ctx.parameters.default_assignments
   end
 

data/spec/reek/{core → context}/module_context_spec.rb

@@ -1,8 +1,8 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/module_context'
-require_relative '../../../lib/reek/core/stop_context'
+require_relative '../../../lib/reek/context/module_context'
+require_relative '../../../lib/reek/context/root_context'
 
-RSpec.describe Reek::Core::ModuleContext do
+RSpec.describe Reek::Context::ModuleContext do
   it 'should report module name for smell in method' do
     expect('
       module Fred
@@ -19,7 +19,7 @@ module Fred
   end
 end
 
-RSpec.describe Reek::Core::ModuleContext do
+RSpec.describe Reek::Context::ModuleContext do
   it 'should recognise global constant' do
     expect('# module for test
 module ::Global

data/spec/reek/context/root_context_spec.rb

@@ -0,0 +1,14 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/context/root_context'
+
+RSpec.describe Reek::Context::RootContext do
+  before :each do
+    @root = Reek::Context::RootContext.new
+  end
+
+  context 'full_name' do
+    it 'reports full context' do
+      expect(@root.full_name).to eq('')
+    end
+  end
+end

data/spec/reek/{core → context}/singleton_method_context_spec.rb

@@ -1,11 +1,11 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/singleton_method_context'
-require_relative '../../../lib/reek/core/stop_context'
+require_relative '../../../lib/reek/context/singleton_method_context'
+require_relative '../../../lib/reek/context/root_context'
 
-RSpec.describe Reek::Core::SingletonMethodContext do
+RSpec.describe Reek::Context::SingletonMethodContext do
   let(:smc) do
     sexp = s(:def, :foo, s(:args, s(:arg, :bar)), nil)
-    Reek::Core::SingletonMethodContext.new(Reek::Core::StopContext.new, sexp)
+    Reek::Context::SingletonMethodContext.new(Reek::Context::RootContext.new, sexp)
   end
 
   describe '#envious_receivers' do

data/spec/reek/{core/examiner_spec.rb → examiner_spec.rb}

@@ -1,5 +1,5 @@
-require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/examiner'
+require_relative '../spec_helper'
+require_relative '../../lib/reek/examiner'
 
 RSpec.shared_examples_for 'no smells found' do
   it 'is not smelly' do
@@ -22,7 +22,7 @@ RSpec.shared_examples_for 'one smell found' do
   end
 end
 
-RSpec.describe Reek::Core::Examiner do
+RSpec.describe Reek::Examiner do
   before :each do
     @expected_first_smell = 'NestedIterators'
   end
@@ -44,45 +44,6 @@ RSpec.describe Reek::Core::Examiner do
     it_should_behave_like 'one smell found'
   end
 
-  context 'with a partially masked smelly Dir' do
-    around(:each) do |example|
-      with_test_config('spec/samples/all_but_one_masked/masked.reek') do
-        example.run
-      end
-    end
-
-    before :each do
-      smelly_dir = Dir['spec/samples/all_but_one_masked/*.rb']
-      @examiner = described_class.new(smelly_dir)
-    end
-
-    it_should_behave_like 'one smell found'
-  end
-
-  context 'with a fragrant Dir' do
-    before :each do
-      clean_dir = Dir['spec/samples/three_clean_files/*.rb']
-      @examiner = described_class.new(clean_dir)
-    end
-
-    it_should_behave_like 'no smells found'
-  end
-
-  context 'with a smelly Dir masked by a dotfile' do
-    around(:each) do |example|
-      with_test_config('spec/samples/masked_by_dotfile/.reek') do
-        example.run
-      end
-    end
-
-    before :each do
-      smelly_dir = Dir['spec/samples/masked_by_dotfile/*.rb']
-      @examiner = described_class.new(smelly_dir)
-    end
-
-    it_should_behave_like 'one smell found'
-  end
-
   context 'with a partially masked smelly File' do
     around(:each) do |example|
       with_test_config('spec/samples/all_but_one_masked/masked.reek') do

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

@@ -1,12 +1,12 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/examiner'
-require_relative '../../../lib/reek/cli/report/report'
+require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/report/report'
 
-RSpec.describe Reek::CLI::Report::HTMLReport do
-  let(:instance) { Reek::CLI::Report::HTMLReport.new }
+RSpec.describe Reek::Report::HTMLReport do
+  let(:instance) { Reek::Report::HTMLReport.new }
 
   context 'with an empty source' do
-    let(:examiner) { Reek::Core::Examiner.new('') }
+    let(:examiner) { Reek::Examiner.new('') }
 
     before do
       instance.add_examiner examiner

data/spec/reek/report/json_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::JSONReport do
+  let(:instance) { Reek::Report::JSONReport.new }
+
+  context 'empty source' do
+    let(:examiner) { Reek::Examiner.new('') }
+
+    before do
+      instance.add_examiner examiner
+    end
+
+    it 'prints empty json' do
+      expect { instance.show }.to output(/^\[\]$/).to_stdout
+    end
+  end
+end

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

@@ -1,23 +1,23 @@
 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/cli/report/heading_formatter'
+require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/report/report'
+require_relative '../../../lib/reek/report/formatter'
+require_relative '../../../lib/reek/report/heading_formatter'
 require 'rainbow'
 
-RSpec.describe Reek::CLI::Report::TextReport do
+RSpec.describe Reek::Report::TextReport do
   let(:report_options) do
     {
-      warning_formatter: Reek::CLI::Report::SimpleWarningFormatter.new,
-      report_formatter: Reek::CLI::Report::Formatter,
-      heading_formatter: Reek::CLI::Report::HeadingFormatter::Quiet
+      warning_formatter: Reek::Report::SimpleWarningFormatter.new,
+      report_formatter: Reek::Report::Formatter,
+      heading_formatter: Reek::Report::HeadingFormatter::Quiet
     }
   end
-  let(:instance) { Reek::CLI::Report::TextReport.new report_options }
+  let(:instance) { Reek::Report::TextReport.new report_options }
 
   context 'with a single empty source' do
     before do
-      instance.add_examiner Reek::Core::Examiner.new('')
+      instance.add_examiner Reek::Examiner.new('')
     end
 
     it 'has an empty quiet_report' do
@@ -27,8 +27,8 @@ RSpec.describe Reek::CLI::Report::TextReport do
 
   context 'with non smelly files' do
     before do
-      instance.add_examiner(Reek::Core::Examiner.new('def simple() puts "a" end'))
-      instance.add_examiner(Reek::Core::Examiner.new('def simple() puts "a" end'))
+      instance.add_examiner(Reek::Examiner.new('def simple() puts "a" end'))
+      instance.add_examiner(Reek::Examiner.new('def simple() puts "a" end'))
     end
 
     context 'with colors disabled' do
@@ -54,8 +54,8 @@ RSpec.describe Reek::CLI::Report::TextReport do
 
   context 'with a couple of smells' do
     before do
-      instance.add_examiner(Reek::Core::Examiner.new('def simple(a) a[3] end'))
-      instance.add_examiner(Reek::Core::Examiner.new('def simple(a) a[3] end'))
+      instance.add_examiner(Reek::Examiner.new('def simple(a) a[3] end'))
+      instance.add_examiner(Reek::Examiner.new('def simple(a) a[3] end'))
     end
 
     context 'with colors disabled' do