reek 4.5.6 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c4b9b3b7dc545af9ebbca5f6f24442fa31e6082
-  data.tar.gz: 8deb694c3389aeb962fbeef331eab9ba4706ee0e
+  metadata.gz: 5c827e3718e3a4f1524fdaf0d6c28df6e86b671b
+  data.tar.gz: 9755661abe970fb1499ee2b9de2f6d701b8c8ee2
 SHA512:
-  metadata.gz: d8fc3081171e7e5cf12b19b4ba8c1a46590d5d197d8baf6373a759a88f90f092da133282d50f7a292bcb0fe812c6890d3db87c02b1620af434b8d3c579aa3592
-  data.tar.gz: 2474e384c11004a10ede8186caa46a504a0d5a8fdc9b2e5ded5b8fd6bd34b3ffc3f922c04ffce0ed75530002f8fc11ba2bd73ea047a8feb9c5a7dfd7149cbbbf
+  metadata.gz: 77122032bb96bbd32994195c9745acc214ecfbfff7963348aff01239402deefb74032883eed3762df8eda34c6054447a5ca076dfe707a9a1460a5c14bc85ddf7
+  data.tar.gz: e86a819d479502f6f091c6d6f8b7d1b6c1aae20779131a3e6e62445eb048db3f1f0e1226b59a0b11ca82e9f3c4471578ce4c71c19d0a1fdff96b51f8f5e7d752

data/.rubocop.yml

@@ -49,12 +49,6 @@ RSpec/DescribeClass:
 RSpec/ExampleLength:
   Enabled: false
 
-# FIXME: Find a better way to block output during specs, and fix relevant examples.
-RSpec/ExpectOutput:
-  Exclude:
-    - 'spec/reek/cli/command/todo_list_command_spec.rb'
-    - 'spec/reek/source/source_code_spec.rb'
-
 # FIXME: Split up files to avoid offenses
 RSpec/MultipleDescribes:
   Exclude:
@@ -79,13 +73,6 @@ RSpec/NestedGroups:
   Exclude:
     - 'spec/reek/cli/application_spec.rb'
 
-# FIXME: Update specs to avoid offenses
-RSpec/VerifiedDoubles:
-  Exclude:
-    - 'spec/reek/context/code_context_spec.rb'
-    - 'spec/reek/context/method_context_spec.rb'
-    - 'spec/reek/context/module_context_spec.rb'
-
 # rubocop-rspec expects a CodeClimate namespace to go with the code_climate directory.
 RSpec/FilePath:
   Exclude:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## 4.6.0 (2017-04-04)
+
+* (IanWhitney) Implement `--force-exclusion` flag
+* (mvz) Raise Reek-specific error on parse errors
+
 ## 4.5.6 (2017-02-17)
 
 * (mvz) Raise on errors inside of Examiner#smells instead of outputting to STDERR

data/Gemfile

@@ -12,12 +12,12 @@ group :development do
   gem 'factory_girl',  '~> 4.0'
   gem 'rake',          '~> 12.0'
   gem 'rspec',         '~> 3.0'
-  gem 'simplecov',     '~> 0.13.0'
+  gem 'simplecov',     '~> 0.14.0'
   gem 'yard',          '~> 0.9.5'
 
   if RUBY_VERSION >= '2.3'
     gem 'rubocop',       '~> 0.47.1'
-    gem 'rubocop-rspec', '~> 1.10.0'
+    gem 'rubocop-rspec', '~> 1.13.0'
   end
 
   platforms :mri do

data/README.md

@@ -475,7 +475,7 @@ Or just run the whole test suite:
 bundle exec rake
 ```
 
-This will run the tests (RSpec and Cucumber), RuboCop and Reek itself.
+This will run the RSpec tests, RuboCop and Reek itself.
 
 You can also run:
 
@@ -484,7 +484,7 @@ bundle exec rake ci
 ```
 
 This will run everything the default task runs and also
-[Ataru](https://github.com/CodePadawans/ataru). This is the task that we run on
+our Cucumber features and [Ataru](https://github.com/CodePadawans/ataru). This is the task that we run on
 Travis as well and that determines if your pull request is green or red.
 
 Another useful Rake task is the `console` task. This will throw you right into an environment where you can play around with Reeks modules and classes:
@@ -557,6 +557,9 @@ Just add this to your configuration file:
     enabled: false
   UtilityFunction:
     enabled: false
+"app/mailers":
+  InstanceVariableAssumption:
+    enabled: false
 ```
 
 Be careful though, Reek does not merge your configuration entries, so if you already have a directory directive for "app/controllers" or "app/helpers" you need to update those directives instead of copying the above YAML sample into your configuration file.

data/features/command_line_interface/options.feature

@@ -67,6 +67,8 @@ Feature: Reek can be controlled using command-line options
               --sort-by SORTING            Sort reported files by the given criterium:
                                              smelliness ("smelliest" files first)
                                              none (default - output in processing order)
+              --force-exclusion            Force excluding files specified in the configuration `exclude_paths`
+                                             even if they are explicitly passed as arguments
 
      Exit codes:
               --success-exit-code CODE     The exit code when no smells are found (default: 0)

data/features/command_line_interface/stdin.feature

@@ -35,5 +35,5 @@ Feature: Reek reads from $stdin when no files are given
   Scenario: syntax error causes the source to be ignored
     When I pass "= invalid syntax =" to reek
     Then it reports a parsing error
-    Then it succeeds
+    And the exit status indicates an error
     And it reports nothing

data/features/configuration_files/exclude_paths_directives.feature

@@ -22,3 +22,22 @@ Feature: Exclude paths directives
     When I run `reek -c config.reek .`
     Then it succeeds
     And it reports nothing
+  Scenario: Using a file name within an excluded directory
+    Given a file named "bad_files_live_here/smelly.rb" with:
+      """
+      # A smelly example class
+      class Smelly
+        def alfa(bravo); end
+      end
+      """
+    And a file named "config.reek" with:
+      """
+      ---
+      exclude_paths:
+        - bad_files_live_here
+      """
+    When I run `reek -c config.reek bad_files_live_here/smelly.rb`
+    Then the exit status indicates smells
+    When I run `reek -c config.reek --force-exclusion bad_files_live_here/smelly.rb`
+    Then it succeeds
+    And it reports nothing

data/features/todo_list.feature

@@ -1,5 +1,4 @@
-Feature:
-
+Feature: Auto-generate a todo file
   Write a Reek configuration as a kind of todo list that will prevent Reek
   from reporting smells on the current code.
   This can then be worked on later on.

data/lib/reek/ast/sexp_extensions/arguments.rb

@@ -8,11 +8,6 @@ module Reek
           children.first
         end
 
-        # Other is a symbol?
-        def ==(other)
-          name == other
-        end
-
         def marked_unused?
           plain_name.start_with?('_')
         end

data/lib/reek/ast/sexp_extensions/constant.rb

@@ -4,6 +4,7 @@ module Reek
     module SexpExtensions
       # Utility methods for :const nodes.
       module ConstNode
+        # TODO: name -> full_name, simple_name -> name
         def name
           if namespace
             "#{namespace.format_to_ruby}::#{simple_name}"

data/lib/reek/cli/application.rb

@@ -18,7 +18,6 @@ module Reek
 
       def initialize(argv)
         @options = configure_options(argv)
-        @status = options.success_exit_code
         @configuration = configure_app_configuration(options.config_file)
         @command = command_class.new(options: options,
                                      sources: sources,
@@ -31,7 +30,6 @@ module Reek
 
       private
 
-      attr_accessor :status
       attr_reader :command, :options
 
       def configure_options(argv)
@@ -81,11 +79,11 @@ module Reek
       end
 
       def working_directory_as_source
-        Source::SourceLocator.new(['.'], configuration: configuration).sources
+        Source::SourceLocator.new(['.'], configuration: configuration, options: options).sources
       end
 
       def sources_from_argv
-        Source::SourceLocator.new(argv, configuration: configuration).sources
+        Source::SourceLocator.new(argv, configuration: configuration, options: options).sources
       end
 
       def source_from_pipe

data/lib/reek/cli/options.rb

@@ -11,8 +11,8 @@ module Reek
     #
     # See {file:docs/Command-Line-Options.md} for details.
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 11 }
-    # :reek:TooManyMethods: { max_methods: 17 }
+    # :reek:TooManyInstanceVariables: { max_instance_variables: 12 }
+    # :reek:TooManyMethods: { max_methods: 18 }
     # :reek:Attribute: { enabled: false }
     #
     class Options
@@ -27,7 +27,8 @@ module Reek
                     :sorting,
                     :success_exit_code,
                     :failure_exit_code,
-                    :generate_todo_list
+                    :generate_todo_list,
+                    :force_exclusion
 
       def initialize(argv = [])
         @argv               = argv
@@ -41,6 +42,7 @@ module Reek
         @success_exit_code  = Status::DEFAULT_SUCCESS_EXIT_CODE
         @failure_exit_code  = Status::DEFAULT_FAILURE_EXIT_CODE
         @generate_todo_list = false
+        @force_exclusion    = false
 
         set_up_parser
       end
@@ -51,6 +53,10 @@ module Reek
         self
       end
 
+      def force_exclusion?
+        @force_exclusion
+      end
+
       private
 
       # TTY output generally means the output will not undergo further
@@ -121,7 +127,7 @@ module Reek
         end
       end
 
-      # :reek:TooManyStatements: { max_statements: 6 }
+      # :reek:TooManyStatements: { max_statements: 7 }
       def set_report_formatting_options
         parser.separator "\nText format options:"
         set_up_color_option
@@ -129,6 +135,7 @@ module Reek
         set_up_location_formatting_options
         set_up_progress_formatting_options
         set_up_sorting_option
+        set_up_force_exclusion_option
       end
 
       def set_up_color_option
@@ -175,6 +182,14 @@ module Reek
         end
       end
 
+      def set_up_force_exclusion_option
+        parser.on('--force-exclusion',
+                  'Force excluding files specified in the configuration `exclude_paths`',
+                  '  even if they are explicitly passed as arguments') do |force_exclusion|
+          self.force_exclusion = force_exclusion
+        end
+      end
+
       # :reek:DuplicateMethodCall: { max_calls: 2 }
       def set_exit_codes
         parser.separator "\nExit codes:"

data/lib/reek/errors/parse_error.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised when Reek is unable to process the source
+    class ParseError < BaseError
+      MESSAGE_TEMPLATE = '%s: %s: %s'.freeze
+
+      def initialize(origin:, original_exception:)
+        message = format(MESSAGE_TEMPLATE,
+                         origin,
+                         original_exception.class.name,
+                         original_exception.message)
+        super message
+      end
+    end
+  end
+end

data/lib/reek/source/source_code.rb

@@ -5,6 +5,7 @@ Reek::CLI::Silencer.silently do
 end
 require_relative '../tree_dresser'
 require_relative '../ast/node'
+require_relative '../errors/parse_error'
 
 # Opt in to new way of representing lambdas
 Parser::Builders::Default.emit_lambda = true
@@ -87,7 +88,7 @@ module Reek
             begin
               ast, comments = parser.parse_with_comments(source, origin)
             rescue Racc::ParseError, Parser::SyntaxError => error
-              $stderr.puts "#{origin}: #{error.class.name}: #{error}"
+              raise Errors::ParseError, origin: origin, original_exception: error
             end
 
             # See https://whitequark.github.io/parser/Parser/Source/Comment/Associator.html

data/lib/reek/source/source_locator.rb

@@ -11,7 +11,8 @@ module Reek
       # Initialize with the paths we want to search.
       #
       # paths - a list of paths as Strings
-      def initialize(paths, configuration: Configuration::AppConfiguration.default)
+      def initialize(paths, configuration: Configuration::AppConfiguration.default, options: Reek::CLI::Options.new)
+        @options = options
         @paths = paths.flat_map do |string|
           path = Pathname.new(string)
           current_directory?(path) ? path.entries : path
@@ -29,7 +30,7 @@ module Reek
 
       private
 
-      attr_reader :configuration, :paths
+      attr_reader :configuration, :paths, :options
 
       # :reek:TooManyStatements: { max_statements: 7 }
       # :reek:NestedIterators: { max_allowed_nesting: 2 }
@@ -44,12 +45,23 @@ module Reek
             if path.directory?
               ignore_path?(path) ? Find.prune : next
             elsif ruby_file?(path)
-              relevant_paths << path
+              relevant_paths << path unless ignore_file?(path)
             end
           end
         end
       end
 
+      def ignore_file?(path)
+        if options.force_exclusion?
+          path.ascend do |ascendant|
+            break true if path_excluded?(ascendant)
+            false
+          end
+        else
+          false
+        end
+      end
+
       def path_excluded?(path)
         configuration.path_excluded?(path)
       end

data/lib/reek/spec.rb

@@ -98,6 +98,8 @@ module Reek
     #       "reek_only_of" will fail in that case.
     #   2.) "reek_only_of" doesn't support the additional smell_details hash.
     #
+    # @param smell_type [Symbol, String, Class] The "smell type" to check for.
+    #
     # @public
     #
     # :reek:UtilityFunction

data/lib/reek/version.rb

@@ -7,6 +7,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.5.6'.freeze
+    STRING = '4.6.0'.freeze
   end
 end

data/spec/factories/factories.rb

@@ -4,14 +4,6 @@ require_relative '../../lib/reek/smell_warning'
 require_relative '../../lib/reek/cli/options'
 
 FactoryGirl.define do
-  factory :context, class: Reek::Context::CodeContext do
-    skip_create
-
-    initialize_with do
-      new(nil, nil)
-    end
-  end
-
   factory :method_context, class: Reek::Context::MethodContext do
     skip_create
     transient do

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
+        result = Reek::CLI::Silencer.silently { command.execute }
         expect(result).to eq(Reek::CLI::Status::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)
-      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
+        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/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/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

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

@@ -16,19 +16,19 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
                           source:         'a/ruby/source/file.rb')
       end
 
-      it 'it computes the fingerprint' do
+      it 'computes the fingerprint' do
         expect(computed).to eq expected_fingerprint
       end
     end
 
     context 'with code at a specific location' do
       let(:lines) { [1] }
-      it_should_behave_like 'computes a fingerprint with no parameters'
+      it_behaves_like 'computes a fingerprint with no parameters'
     end
 
     context 'with code at a different location' do
       let(:lines) { [5] }
-      it_should_behave_like 'computes a fingerprint with no parameters'
+      it_behaves_like 'computes a fingerprint with no parameters'
     end
 
     context 'when the fingerprint should not be computed' do
@@ -41,7 +41,7 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
                           source:         'a/ruby/source/file.rb')
       end
 
-      it 'it returns nil' do
+      it 'returns nil' do
         expect(computed).to be_nil
       end
     end
@@ -66,14 +66,14 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
       let(:name) { 'bravo' }
       let(:expected_fingerprint) { '9c3fd378178118a67e9509f87cae24f9' }
 
-      it_should_behave_like 'computes a fingerprint with identifying parameters'
+      it_behaves_like 'computes a fingerprint with identifying parameters'
     end
 
     context 'when the name is another thing it has another fingerprint' do
       let(:name) { 'echo' }
       let(:expected_fingerprint) { 'd2a6d2703ce04cca65e7300b7de4b89f' }
 
-      it_should_behave_like 'computes a fingerprint with identifying parameters'
+      it_behaves_like 'computes a fingerprint with identifying parameters'
     end
 
     shared_examples_for 'computes a fingerprint with identifying and non-identifying parameters' do
@@ -98,7 +98,7 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
       let(:lines) { [1, 7, 10, 13, 15] }
       let(:expected_fingerprint) { '238733f4f51ba5473dcbe94a43ec5400' }
 
-      it_should_behave_like 'computes a fingerprint with identifying and non-identifying parameters'
+      it_behaves_like 'computes a fingerprint with identifying and non-identifying parameters'
     end
 
     context 'when the non-identifying parameters change, it computes the same fingerprint' do
@@ -107,7 +107,7 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
       let(:lines) { [1, 7, 10, 13, 15, 17, 19, 20, 25] }
       let(:expected_fingerprint) { '238733f4f51ba5473dcbe94a43ec5400' }
 
-      it_should_behave_like 'computes a fingerprint with identifying and non-identifying parameters'
+      it_behaves_like 'computes a fingerprint with identifying and non-identifying parameters'
     end
 
     context 'but when the identifying parameters change, it computes a different fingerprint' do
@@ -116,7 +116,7 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
       let(:lines) { [1, 7, 10, 13, 15] }
       let(:expected_fingerprint) { 'e0c35e9223cc19bdb9a04fb3e60573e1' }
 
-      it_should_behave_like 'computes a fingerprint with identifying and non-identifying parameters'
+      it_behaves_like 'computes a fingerprint with identifying and non-identifying parameters'
     end
   end
 end

data/spec/reek/smell_warning_spec.rb

@@ -30,14 +30,14 @@ RSpec.describe Reek::SmellWarning do
       let(:first) { build(:smell_warning, smell_detector: duplication_detector) }
       let(:second) { build(:smell_warning, smell_detector: feature_envy_detector) }
 
-      it_should_behave_like 'first sorts ahead of second'
+      it_behaves_like 'first sorts ahead of second'
     end
 
     context 'smells differing only by lines' do
       let(:first) { build(:smell_warning, smell_detector: feature_envy_detector, lines: [2]) }
       let(:second) { build(:smell_warning, smell_detector: feature_envy_detector, lines: [3]) }
 
-      it_should_behave_like 'first sorts ahead of second'
+      it_behaves_like 'first sorts ahead of second'
     end
 
     context 'smells differing only by context' do
@@ -46,7 +46,7 @@ RSpec.describe Reek::SmellWarning do
         build(:smell_warning, smell_detector: duplication_detector, context: 'second')
       end
 
-      it_should_behave_like 'first sorts ahead of second'
+      it_behaves_like 'first sorts ahead of second'
     end
 
     context 'smells differing only by message' do
@@ -59,7 +59,7 @@ RSpec.describe Reek::SmellWarning do
                               context: 'ctx', message: 'second message')
       end
 
-      it_should_behave_like 'first sorts ahead of second'
+      it_behaves_like 'first sorts ahead of second'
     end
 
     context 'smell name takes precedence over message' do
@@ -70,7 +70,7 @@ RSpec.describe Reek::SmellWarning do
         build(:smell_warning, smell_detector: utility_function_detector, message: 'first message')
       end
 
-      it_should_behave_like 'first sorts ahead of second'
+      it_behaves_like 'first sorts ahead of second'
     end
 
     context 'smells differing everywhere' do
@@ -86,7 +86,7 @@ RSpec.describe Reek::SmellWarning do
                               message: "has the variable name '@s'")
       end
 
-      it_should_behave_like 'first sorts ahead of second'
+      it_behaves_like 'first sorts ahead of second'
     end
   end
 

data/spec/reek/source/source_code_spec.rb

@@ -26,36 +26,15 @@ RSpec.describe Reek::Source::SourceCode do
   end
 
   context 'when the parser fails' do
-    let(:catcher) { StringIO.new }
     let(:source_name) { 'Test source' }
     let(:error_message) { 'Error message' }
     let(:parser) { class_double(Parser::Ruby23) }
     let(:src) { described_class.new(code: '', origin: source_name, parser: parser) }
 
-    before { $stderr = catcher }
-
     shared_examples_for 'handling and recording the error' do
-      it 'does not raise an error' do
-        src.syntax_tree
-      end
-
-      it 'returns an empty syntax tree' do
-        expect(src.syntax_tree).to be_nil
-      end
-
-      it 'records the syntax error' do
-        src.syntax_tree
-        expect(catcher.string).to match(error_class.name)
-      end
-
-      it 'records the source name' do
-        src.syntax_tree
-        expect(catcher.string).to match(source_name)
-      end
-
-      it 'records the error message' do
-        src.syntax_tree
-        expect(catcher.string).to match(error_message)
+      it 'raises an informative error' do
+        expect { src.syntax_tree }.
+          to raise_error(/#{source_name}: #{error_class.name}: #{error_message}/)
       end
     end
 
@@ -68,7 +47,7 @@ RSpec.describe Reek::Source::SourceCode do
           and_raise error_class.new(diagnostic)
       end
 
-      it_should_behave_like 'handling and recording the error'
+      it_behaves_like 'handling and recording the error'
     end
 
     context 'with a Racc::ParseError' do
@@ -79,7 +58,7 @@ RSpec.describe Reek::Source::SourceCode do
           and_raise(error_class.new(error_message))
       end
 
-      it_should_behave_like 'handling and recording the error'
+      it_behaves_like 'handling and recording the error'
     end
 
     context 'with a generic error' do
@@ -91,10 +70,8 @@ RSpec.describe Reek::Source::SourceCode do
       end
 
       it 'raises the error' do
-        expect { src.syntax_tree }.to raise_error
+        expect { src.syntax_tree }.to raise_error error_class
       end
     end
-
-    after { $stderr = STDERR }
   end
 end

data/spec/reek/source/source_locator_spec.rb

@@ -29,34 +29,66 @@ RSpec.describe Reek::Source::SourceLocator do
       end
     end
 
+    # rubocop:disable RSpec/NestedGroups
     context 'exclude paths' do
       let(:configuration) do
         test_configuration_for(CONFIG_PATH.join('with_excluded_paths.reek'))
       end
 
-      let(:path) { SAMPLES_PATH.join('source_with_exclude_paths') }
+      let(:options) { instance_double('Reek::CLI::Options', force_exclusion?: false) }
 
-      let(:expected_paths) do
-        [path.join('nested/uncommunicative_parameter_name.rb')]
-      end
+      context 'when the path is a file name in an excluded directory' do
+        let(:path) { SAMPLES_PATH.join('source_with_exclude_paths', 'ignore_me', 'uncommunicative_method_name.rb') }
 
-      let(:paths_that_are_expected_to_be_ignored) do
-        [
-          path.join('ignore_me/uncommunicative_method_name.rb'),
-          path.join('nested/ignore_me_as_well/irresponsible_module.rb')
-        ]
-      end
+        context 'when options.force_exclusion? is true' do
+          before do
+            allow(options).to receive(:force_exclusion?).and_return(true)
+          end
 
-      it 'does not use excluded paths' do
-        sources = described_class.new([path], configuration: configuration).sources
-        expect(sources).not_to include(*paths_that_are_expected_to_be_ignored)
+          it 'excludes this file' do
+            sources = described_class.new([path], configuration: configuration, options: options).sources
+            expect(sources).not_to include(path)
+          end
+        end
+
+        context 'when options.force_exclusion? is false' do
+          before do
+            allow(options).to receive(:force_exclusion?).and_return(false)
+          end
+
+          it 'includes this file' do
+            sources = described_class.new([path], configuration: configuration, options: options).sources
+            expect(sources).to include(path)
+          end
+        end
       end
 
-      it 'scans directories that are not excluded' do
-        sources = described_class.new([path], configuration: configuration).sources
-        expect(sources).to eq expected_paths
+      context 'when path is a directory' do
+        let(:path) { SAMPLES_PATH.join('source_with_exclude_paths') }
+
+        let(:expected_paths) do
+          [path.join('nested/uncommunicative_parameter_name.rb')]
+        end
+
+        let(:paths_that_are_expected_to_be_ignored) do
+          [
+            path.join('ignore_me/uncommunicative_method_name.rb'),
+            path.join('nested/ignore_me_as_well/irresponsible_module.rb')
+          ]
+        end
+
+        it 'does not use excluded paths' do
+          sources = described_class.new([path], configuration: configuration, options: options).sources
+          expect(sources).not_to include(*paths_that_are_expected_to_be_ignored)
+        end
+
+        it 'scans directories that are not excluded' do
+          sources = described_class.new([path], configuration: configuration).sources
+          expect(sources).to eq expected_paths
+        end
       end
     end
+    # rubocop:enable RSpec/NestedGroups
 
     context 'non-Ruby paths' do
       let(:path) { SAMPLES_PATH.join('source_with_non_ruby_files') }

data/spec/reek/spec/should_reek_only_of_spec.rb

@@ -36,14 +36,14 @@ RSpec.describe Reek::Spec::ShouldReekOnlyOf do
   context 'with no smells' do
     let(:smells) { [] }
 
-    it_should_behave_like 'no match'
+    it_behaves_like 'no match'
   end
 
   context 'with 1 non-matching smell' do
     let(:control_couple_detector) { build(:smell_detector, smell_type: 'ControlParameter') }
     let(:smells) { [build(:smell_warning, smell_detector: control_couple_detector)] }
 
-    it_should_behave_like 'no match'
+    it_behaves_like 'no match'
   end
 
   context 'with 2 non-matching smells' do
@@ -56,7 +56,7 @@ RSpec.describe Reek::Spec::ShouldReekOnlyOf do
       ]
     end
 
-    it_should_behave_like 'no match'
+    it_behaves_like 'no match'
   end
 
   context 'with 1 non-matching and 1 matching smell' do
@@ -70,7 +70,7 @@ RSpec.describe Reek::Spec::ShouldReekOnlyOf do
       ]
     end
 
-    it_should_behave_like 'no match'
+    it_behaves_like 'no match'
   end
 
   context 'with 1 matching smell' do

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'timeout'
 require_relative '../lib/reek'
 require_relative '../lib/reek/spec'
 require_relative '../lib/reek/ast/ast_node_class_map'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.5.6
+  version: 4.6.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-18 00:00:00.000000000 Z
+date: 2017-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -229,6 +229,7 @@ files:
 - lib/reek/errors/base_error.rb
 - lib/reek/errors/garbage_detector_configuration_in_comment_error.rb
 - lib/reek/errors/incomprehensible_source_error.rb
+- lib/reek/errors/parse_error.rb
 - lib/reek/examiner.rb
 - lib/reek/logging_error_handler.rb
 - lib/reek/rake/task.rb
@@ -438,7 +439,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby