reek 4.5.0 → 4.6.0

data/spec/reek/cli/command/todo_list_command_spec.rb

@@ -4,34 +4,25 @@ require_lib 'reek/cli/options'
 
 RSpec.describe Reek::CLI::Command::TodoListCommand do
   let(:nil_check) { build :smell_detector, smell_type: :NilCheck }
-  let(:feature_envy) { build :smell_detector, smell_type: :FeatureEnvy }
   let(:nested_iterators) { build :smell_detector, smell_type: :NestedIterators }
-  let(:too_many_statements) { build :smell_detector, smell_type: :TooManyStatements }
 
   describe '#execute' do
     let(:options) { Reek::CLI::Options.new [] }
     let(:configuration) { instance_double 'Reek::Configuration::AppConfiguration' }
+    let(:sources) { [source_file] }
 
     let(:command) do
       described_class.new(options: options,
-                          sources: [],
+                          sources: sources,
                           configuration: configuration)
     end
 
     before do
-      $stdout = StringIO.new
-      allow(File).to receive(:write)
-    end
-
-    after(:all) do
-      $stdout = STDOUT
+      allow(File).to receive(:write).with(described_class::FILE_NAME, String)
     end
 
     context 'smells found' do
-      before do
-        smells = [build(:smell_warning, context: 'Foo#bar')]
-        allow(command).to receive(:scan_for_smells).and_return(smells)
-      end
+      let(:source_file) { SMELLY_FILE }
 
       it 'shows a proper message' do
         expected = "\n'.todo.reek' generated! You can now use this as a starting point for your configuration.\n"
@@ -39,70 +30,22 @@ RSpec.describe Reek::CLI::Command::TodoListCommand do
       end
 
       it 'returns a success code' do
-        result = command.execute
-        expect(result).to eq(Reek::CLI::Options::DEFAULT_SUCCESS_EXIT_CODE)
-      end
-
-      it 'writes a todo file' do
-        command.execute
-        expected_yaml = { 'FeatureEnvy' => { 'exclude' => ['Foo#bar'] } }.to_yaml
-        expect(File).to have_received(:write).with(described_class::FILE_NAME, expected_yaml)
-      end
-    end
-
-    context 'smells with duplicate context found' do
-      before do
-        smells = [
-          build(:smell_warning, context: 'Foo#bar', smell_detector: feature_envy),
-          build(:smell_warning, context: 'Foo#bar', smell_detector: feature_envy)
-        ]
-        allow(command).to receive(:scan_for_smells).and_return(smells)
+        result = Reek::CLI::Silencer.silently { command.execute }
+        expect(result).to eq(Reek::CLI::Status::DEFAULT_SUCCESS_EXIT_CODE)
       end
 
-      it 'writes the context into the todo file once' do
-        command.execute
-        expected_yaml = { 'FeatureEnvy' => { 'exclude' => ['Foo#bar'] } }.to_yaml
-        expect(File).to have_received(:write).with(described_class::FILE_NAME, expected_yaml)
-      end
-    end
-
-    context 'smells with default exclusions found' do
-      let(:smell) { build :smell_warning, smell_detector: too_many_statements, context: 'Foo#bar' }
-
-      before do
-        allow(command).to receive(:scan_for_smells).and_return [smell]
-      end
-
-      it 'includes the default exclusions in the generated yaml' do
-        command.execute
-        expected_yaml = { 'TooManyStatements' => { 'exclude' => ['initialize', 'Foo#bar'] } }.to_yaml
-        expect(File).to have_received(:write).with(described_class::FILE_NAME, expected_yaml)
-      end
-    end
-
-    context 'smells of different types found' do
-      before do
-        smells = [
-          build(:smell_warning, context: 'Foo#bar', smell_detector: nil_check),
-          build(:smell_warning, context: 'Bar#baz', smell_detector: nested_iterators)
-        ]
-        allow(command).to receive(:scan_for_smells).and_return(smells)
-      end
-
-      it 'writes the context into the todo file once' do
-        command.execute
+      it 'writes a todo file with exclusions for each smell' do
+        Reek::CLI::Silencer.silently { command.execute }
         expected_yaml = {
-          'NilCheck' => { 'exclude' => ['Foo#bar'] },
-          'NestedIterators' => { 'exclude' => ['Bar#baz'] }
+          'UncommunicativeMethodName' => { 'exclude' => ['Smelly#x'] },
+          'UncommunicativeVariableName' => { 'exclude' => ['Smelly#x'] }
         }.to_yaml
         expect(File).to have_received(:write).with(described_class::FILE_NAME, expected_yaml)
       end
     end
 
     context 'no smells found' do
-      before do
-        allow(command).to receive(:scan_for_smells).and_return []
-      end
+      let(:source_file) { CLEAN_FILE }
 
       it 'shows a proper message' do
         expected = "\n'.todo.reek' not generated because there were no smells found!\n"
@@ -110,12 +53,12 @@ RSpec.describe Reek::CLI::Command::TodoListCommand do
       end
 
       it 'returns a success code' do
-        result = command.execute
-        expect(result).to eq Reek::CLI::Options::DEFAULT_SUCCESS_EXIT_CODE
+        result = Reek::CLI::Silencer.silently { command.execute }
+        expect(result).to eq Reek::CLI::Status::DEFAULT_SUCCESS_EXIT_CODE
       end
 
       it 'does not write a todo file' do
-        command.execute
+        Reek::CLI::Silencer.silently { command.execute }
         expect(File).not_to have_received(:write)
       end
     end

data/spec/reek/cli/options_spec.rb

@@ -32,6 +32,10 @@ RSpec.describe Reek::CLI::Options do
       allow($stdout).to receive_messages(tty?: false)
       expect(options.progress_format).to eq :quiet
     end
+
+    it 'sets force_exclusion to false by default' do
+      expect(options.force_exclusion?).to be false
+    end
   end
 
   describe 'parse' do

data/spec/reek/code_comment_spec.rb

@@ -142,4 +142,51 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
       end.to raise_error(Reek::Errors::GarbageDetectorConfigurationInCommentError)
     end
   end
+
+  describe 'validating configuration keys' do
+    context 'basic options mispelled' do
+      it 'raises BadDetectorConfigurationKeyInCommentError' do
+        expect do
+          # exclude -> exlude and enabled -> nabled
+          comment = '# :reek:UncommunicativeMethodName { exlude: alfa, nabled: true }'
+          FactoryGirl.build(:code_comment, comment: comment)
+        end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
+      end
+    end
+
+    context 'basic options not mispelled' do
+      it 'does not raise' do
+        expect do
+          comment = '# :reek:UncommunicativeMethodName { exclude: alfa, enabled: true }'
+          FactoryGirl.build(:code_comment, comment: comment)
+        end.not_to raise_error
+      end
+
+      it 'does not raise on regexps' do
+        expect do
+          comment = '# :reek:UncommunicativeMethodName { exclude: !ruby/regexp /alfa/ }'
+          FactoryGirl.build(:code_comment, comment: comment)
+        end.not_to raise_error
+      end
+    end
+
+    context 'unknown custom options' do
+      it 'raises BadDetectorConfigurationKeyInCommentError' do
+        expect do
+          # max_copies -> mx_copies and min_clump_size -> mn_clump_size
+          comment = '# :reek:DataClump { mx_copies: 4, mn_clump_size: 3 }'
+          FactoryGirl.build(:code_comment, comment: comment)
+        end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
+      end
+    end
+
+    context 'valid custom options' do
+      it 'does not raise' do
+        expect do
+          comment = '# :reek:DataClump { max_copies: 4, min_clump_size: 3 }'
+          FactoryGirl.build(:code_comment, comment: comment)
+        end.not_to raise_error
+      end
+    end
+  end
 end

data/spec/reek/configuration/configuration_file_finder_spec.rb

@@ -32,8 +32,9 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
     end
 
     it 'returns the file even if it’s just ‘.reek’' do
-      found = described_class.find(current: CONFIG_PATH)
-      expect(found).to eq(CONFIG_PATH.join('.reek'))
+      single_configuration_file_dir = CONFIG_PATH.join('single_configuration_file')
+      found = described_class.find(current: single_configuration_file_dir)
+      expect(found).to eq(single_configuration_file_dir.join('.reek'))
     end
 
     it 'returns the file in home if traversing from the current dir fails' do
@@ -91,25 +92,47 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
       end
     end
 
-    describe '.load_from_file' do
-      let(:sample_configuration_loaded) do
-        {
-          'UncommunicativeVariableName' => { 'enabled' => false },
-          'UncommunicativeMethodName'   => { 'enabled' => false }
-        }
+    context 'more than one configuration file' do
+      let(:path) { CONFIG_PATH.join('more_than_one_configuration_file') }
+
+      it 'prints a message on STDERR' do
+        expected_message = "Error: Found multiple configuration files 'regular.reek', 'todo.reek'"
+        expect do
+          begin
+            described_class.find(current: path)
+          rescue SystemExit
+          end
+        end.to output(/#{expected_message}/).to_stderr
       end
 
-      it 'loads the configuration from given file' do
-        configuration = described_class.load_from_file(CONFIG_PATH.join('full_mask.reek'))
-        expect(configuration).to eq(sample_configuration_loaded)
+      it 'exits' do
+        Reek::CLI::Silencer.silently do
+          expect do
+            described_class.find(current: path)
+          end.to raise_error(SystemExit)
+        end
       end
     end
+  end
 
-    private
+  describe '.load_from_file' do
+    let(:sample_configuration_loaded) do
+      {
+        'UncommunicativeVariableName' => { 'enabled' => false },
+        'UncommunicativeMethodName'   => { 'enabled' => false }
+      }
+    end
 
-    def skip_if_a_config_in_tempdir
-      found = described_class.find(current: Pathname.new(Dir.tmpdir))
-      skip "skipped: #{found} exists and would fail this test" if found
+    it 'loads the configuration from given file' do
+      configuration = described_class.load_from_file(CONFIG_PATH.join('full_mask.reek'))
+      expect(configuration).to eq(sample_configuration_loaded)
     end
   end
+
+  private
+
+  def skip_if_a_config_in_tempdir
+    found = described_class.find(current: Pathname.new(Dir.tmpdir))
+    skip "skipped: #{found} exists and would fail this test" if found
+  end
 end

data/spec/reek/context/code_context_spec.rb

@@ -5,7 +5,7 @@ require_lib 'reek/context/module_context'
 RSpec.describe Reek::Context::CodeContext do
   context 'name recognition' do
     let(:ctx)       { described_class.new(nil, exp) }
-    let(:exp)       { double('exp') }
+    let(:exp)       { instance_double('Reek::AST::SexpExtensions::ModuleNode') }
     let(:exp_name)  { 'random_name' }
     let(:full_name) { "::::::::::::::::::::#{exp_name}" }
 
@@ -45,7 +45,7 @@ RSpec.describe Reek::Context::CodeContext do
     context 'when there is an outer' do
       let(:ctx)        { described_class.new(outer, exp) }
       let(:outer_name) { 'another_random sting' }
-      let(:outer)      { described_class.new(nil, double('exp1')) }
+      let(:outer)      { described_class.new(nil, instance_double('Reek::AST::Node')) }
 
       before do
         ctx.register_with_parent outer
@@ -167,7 +167,7 @@ RSpec.describe Reek::Context::CodeContext do
     let(:expression) { Reek::Source::SourceCode.from(src).syntax_tree }
     let(:outer) { nil }
     let(:context) { described_class.new(outer, expression) }
-    let(:sniffer) { double('sniffer') }
+    let(:sniffer) { class_double('Reek::SmellDetectors::BaseDetector') }
 
     before do
       context.register_with_parent(outer)
@@ -181,7 +181,7 @@ RSpec.describe Reek::Context::CodeContext do
     end
 
     context 'when there is an outer context' do
-      let(:outer) { described_class.new(nil, double('exp1')) }
+      let(:outer) { described_class.new(nil, instance_double('Reek::AST::Node')) }
 
       before do
         allow(outer).to receive(:config_for).with(sniffer).and_return(
@@ -196,9 +196,9 @@ RSpec.describe Reek::Context::CodeContext do
   end
 
   describe '#register_with_parent' do
-    let(:context) { described_class.new(nil, double('exp1')) }
-    let(:first_child) { described_class.new(context, double('exp2')) }
-    let(:second_child) { described_class.new(context, double('exp3')) }
+    let(:context) { described_class.new(nil, instance_double('Reek::AST::Node')) }
+    let(:first_child) { described_class.new(context, instance_double('Reek::AST::Node')) }
+    let(:second_child) { described_class.new(context, instance_double('Reek::AST::Node')) }
 
     it "appends the element to the parent context's list of children" do
       first_child.register_with_parent context
@@ -209,9 +209,9 @@ RSpec.describe Reek::Context::CodeContext do
   end
 
   describe '#each' do
-    let(:context) { described_class.new(nil, double('exp1')) }
-    let(:first_child) { described_class.new(context, double('exp2')) }
-    let(:second_child) { described_class.new(context, double('exp3')) }
+    let(:context) { described_class.new(nil, instance_double('Reek::AST::Node')) }
+    let(:first_child) { described_class.new(context, instance_double('Reek::AST::Node')) }
+    let(:second_child) { described_class.new(context, instance_double('Reek::AST::Node')) }
 
     it 'yields each child' do
       first_child.register_with_parent context

data/spec/reek/context/method_context_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe Reek::Context::MethodContext do
   let(:method_context) { described_class.new(nil, exp) }
 
   describe '#matches?' do
-    let(:exp) { double('exp').as_null_object }
+    let(:exp) { instance_double('Reek::AST::SexpExtensions::ModuleNode').as_null_object }
 
     before do
       allow(exp).to receive(:full_name).at_least(:once).and_return('mod')

data/spec/reek/context/module_context_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe Reek::Context::ModuleContext do
       module Fred
         def simple(x) x + 1; end
       end
-    ').to reek_of(:UncommunicativeParameterName, name: 'x')
+    ').to reek_of(:UncommunicativeParameterName, name: 'x', context: 'Fred#simple')
   end
 
   it 'does not report module with empty class' do
@@ -28,9 +28,13 @@ RSpec.describe Reek::Context::ModuleContext do
   end
 
   describe '#track_visibility' do
-    let(:context) { described_class.new(nil, double('exp1')) }
-    let(:first_child) { Reek::Context::MethodContext.new(context, double('exp2', type: :def, name: :foo)) }
-    let(:second_child) { Reek::Context::MethodContext.new(context, double('exp3', type: :def)) }
+    let(:main_exp) { instance_double('Reek::AST::Node') }
+    let(:first_def) { instance_double('Reek::AST::SexpExtensions::DefNode', name: :foo) }
+    let(:second_def) { instance_double('Reek::AST::SexpExtensions::DefNode') }
+
+    let(:context) { described_class.new(nil, main_exp) }
+    let(:first_child) { Reek::Context::MethodContext.new(context, first_def) }
+    let(:second_child) { Reek::Context::MethodContext.new(context, second_def) }
 
     it 'sets visibility on subsequent child contexts' do
       context.append_child_context first_child

data/spec/reek/{smell_detectors/detector_repository_spec.rb → detector_repository_spec.rb}

@@ -1,8 +1,8 @@
-require_relative '../../spec_helper'
+require_relative '../spec_helper'
 require_lib 'reek/smell_detectors/base_detector'
-require_lib 'reek/smell_detectors/detector_repository'
+require_lib 'reek/detector_repository'
 
-RSpec.describe Reek::SmellDetectors::DetectorRepository do
+RSpec.describe Reek::DetectorRepository do
   describe '.smell_types' do
     let(:smell_types) { described_class.smell_types }
 

data/spec/reek/examiner_spec.rb

@@ -28,14 +28,14 @@ RSpec.describe Reek::Examiner do
   context 'with a fragrant String' do
     let(:examiner) { described_class.new('def good() true; end') }
 
-    it_should_behave_like 'no smells found'
+    it_behaves_like 'no smells found'
   end
 
   context 'with a smelly String' do
     let(:examiner) { described_class.new('def fine() y = 4; end') }
     let(:expected_first_smell) { 'UncommunicativeVariableName' }
 
-    it_should_behave_like 'one smell found'
+    it_behaves_like 'one smell found'
   end
 
   context 'with a partially masked smelly File' do
@@ -48,13 +48,13 @@ RSpec.describe Reek::Examiner do
     let(:path) { CONFIG_PATH.join('partial_mask.reek') }
     let(:expected_first_smell) { 'UncommunicativeVariableName' }
 
-    it_should_behave_like 'one smell found'
+    it_behaves_like 'one smell found'
   end
 
   context 'with a fragrant File' do
     let(:examiner) { described_class.new(CLEAN_FILE) }
 
-    it_should_behave_like 'no smells found'
+    it_behaves_like 'no smells found'
   end
 
   describe '.new' do
@@ -87,7 +87,7 @@ RSpec.describe Reek::Examiner do
       examiner = described_class.new code, filter_by_smells: ['DuplicateMethodCall']
 
       smell = examiner.smells.first
-      expect(smell).to be_a(Reek::SmellDetectors::SmellWarning)
+      expect(smell).to be_a(Reek::SmellWarning)
       expect(smell.message).to eq("calls 'bar.call_me()' 2 times")
     end
 
@@ -111,41 +111,40 @@ RSpec.describe Reek::Examiner do
       let(:source) { 'class C; def does_crash_reek; end; end' }
 
       let(:examiner) do
-        detector_repository = instance_double 'Reek::SmellDetectors::DetectorRepository'
+        detector_repository = instance_double 'Reek::DetectorRepository'
         allow(detector_repository).to receive(:examine) do
           raise ArgumentError, 'Looks like bad source'
         end
-        class_double('Reek::SmellDetectors::DetectorRepository').as_stubbed_const
-        allow(Reek::SmellDetectors::DetectorRepository).to receive(:eligible_smell_types)
-        allow(Reek::SmellDetectors::DetectorRepository).to receive(:new).and_return detector_repository
+        class_double('Reek::DetectorRepository').as_stubbed_const
+        allow(Reek::DetectorRepository).to receive(:eligible_smell_types)
+        allow(Reek::DetectorRepository).to receive(:new).and_return detector_repository
 
         described_class.new source
       end
 
-      it 'returns no smell warnings' do
-        Reek::CLI::Silencer.silently do
-          expect(examiner.smells).to be_empty
-        end
+      it 'raises an incomprehensible source error' do
+        expect { examiner.smells }.to raise_error Reek::Errors::IncomprehensibleSourceError
       end
 
-      it 'prints the origin' do
+      it 'explains the origin of the error' do
         origin = 'string'
-        expect { examiner.smells }.to output(/#{origin}/).to_stderr
+        expect { examiner.smells }.to raise_error.with_message(/#{origin}/)
       end
 
       it 'explains what to do' do
         explanation = 'Please double check your Reek configuration'
-        expect { examiner.smells }.to output(/#{explanation}/).to_stderr
+        expect { examiner.smells }.to raise_error.with_message(/#{explanation}/)
       end
 
-      it 'contains a message' do
+      it 'contains the original error message' do
         original = 'Looks like bad source'
-        expect { examiner.smells }.to output(/#{original}/).to_stderr
+        expect { examiner.smells }.to raise_error.with_message(/#{original}/)
       end
     end
   end
 
   describe 'bad comment config' do
+    let(:examiner) { described_class.new(source) }
     context 'unknown smell detector' do
       let(:source) do
         <<-EOS
@@ -154,21 +153,21 @@ RSpec.describe Reek::Examiner do
         EOS
       end
 
-      it 'prints out a proper message' do
-        expected_output = "You are trying to configure an unknown smell detector 'DoesNotExist'"
+      it 'raises a bad detector name error' do
+        expect { examiner.smells }.to raise_error Reek::Errors::BadDetectorInCommentError
+      end
+
+      it 'explains the reason for the error' do
+        message = "You are trying to configure an unknown smell detector 'DoesNotExist'"
 
-        expect do
-          described_class.new(source).smells
-        end.to output(/#{expected_output}/).to_stderr
+        expect { examiner.smells }.to raise_error.with_message(/#{message}/)
       end
 
-      it 'prints out a line and a source' do
-        expected_output = "The source is 'string' and the comment belongs "\
-                          'to the expression starting in line 2.'
+      it 'explains the origin of the error' do
+        details = "The source is 'string' and the comment belongs "\
+                  'to the expression starting in line 2.'
 
-        expect do
-          described_class.new(source).smells
-        end.to output(/#{expected_output}/).to_stderr
+        expect { examiner.smells }.to raise_error.with_message(/#{details}/)
       end
     end
 
@@ -180,21 +179,21 @@ RSpec.describe Reek::Examiner do
         EOS
       end
 
-      it 'prints out a proper message' do
-        expected_output = "Error: You are trying to configure the smell detector 'UncommunicativeMethodName'"
+      it 'raises a garbarge configuration error' do
+        expect { examiner.smells }.to raise_error Reek::Errors::GarbageDetectorConfigurationInCommentError
+      end
+
+      it 'explains the reason for the error' do
+        message = "Error: You are trying to configure the smell detector 'UncommunicativeMethodName'"
 
-        expect do
-          described_class.new(source).smells
-        end.to output(/#{expected_output}/).to_stderr
+        expect { examiner.smells }.to raise_error.with_message(/#{message}/)
       end
 
-      it 'prints out a line and a source' do
-        expected_output = "The source is 'string' and "\
-                          'the comment belongs to the expression starting in line 2'
+      it 'explains the origin of the error' do
+        details = "The source is 'string' and the comment belongs "\
+                  'to the expression starting in line 2.'
 
-        expect do
-          described_class.new(source).smells
-        end.to output(/#{expected_output}/).to_stderr
+        expect { examiner.smells }.to raise_error.with_message(/#{details}/)
       end
     end
   end

data/spec/reek/logging_error_handler_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../spec_helper'
+require_lib 'reek/logging_error_handler'
+
+RSpec.describe Reek::LoggingErrorHandler do
+  describe '#handle' do
+    let(:exception) { RuntimeError.new('some message') }
+    let(:handler) { described_class.new }
+
+    it "outputs the exception's message to stderr" do
+      expect { handler.handle(exception) }.
+        to output(/some message/).to_stderr
+    end
+
+    it 'indicates the exception has been appropriately handled' do
+      result = false
+
+      Reek::CLI::Silencer.silently do
+        result = handler.handle(exception)
+      end
+
+      expect(result).to be_truthy
+    end
+  end
+end

data/spec/reek/report/code_climate/code_climate_configuration_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../../../spec_helper'
+require_lib 'reek/report/code_climate/code_climate_configuration'
+
+RSpec.describe Reek::Report::CodeClimateConfiguration do
+  yml = described_class.load
+  smell_types = Reek::SmellDetectors::BaseDetector.descendants.map do |descendant|
+    descendant.name.demodulize
+  end
+
+  smell_types.each do |name|
+    config = yml.fetch(name)
+    it "provides remediation_points for #{name}" do
+      expect(config['remediation_points']).to be_a Integer
+    end
+
+    it "provides content for #{name}" do
+      expect(config['content']).to be_a String
+    end
+  end
+
+  it 'does not include extraneous configuration' do
+    expect(smell_types).to match_array(yml.keys)
+  end
+end