reek 4.5.5 → 4.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f744d82cb65c9d8b3d9f360ed948e1bf7944299a
-  data.tar.gz: e74921da8bed3e617aeb1a80d9085f0876c80f38
+  metadata.gz: 6c4b9b3b7dc545af9ebbca5f6f24442fa31e6082
+  data.tar.gz: 8deb694c3389aeb962fbeef331eab9ba4706ee0e
 SHA512:
-  metadata.gz: 04bc673256d4145a067b4cbe45d9d0d7a2bfd5170779a6ee2520dedc73ec09abbbad073e17d40dd2cbbd70dbab2f5ea297608a244b448fd71020c4525dc76cc9
-  data.tar.gz: d43b2c46f59d642e127edc26813058937e90ee10811ca5484f6487f2a2908c3bd313a53317a7c00c166b4553d54dbb35b894cc7d8dc9d068fcd3f34c0fe98052
+  metadata.gz: d8fc3081171e7e5cf12b19b4ba8c1a46590d5d197d8baf6373a759a88f90f092da133282d50f7a292bcb0fe812c6890d3db87c02b1620af434b8d3c579aa3592
+  data.tar.gz: 2474e384c11004a10ede8186caa46a504a0d5a8fdc9b2e5ded5b8fd6bd34b3ffc3f922c04ffce0ed75530002f8fc11ba2bd73ea047a8feb9c5a7dfd7149cbbbf

data/.travis.yml

@@ -1,4 +1,5 @@
 sudo: false
+dist: trusty
 cache: bundler
 language: ruby
 bundler_args: --without debugging
@@ -6,23 +7,24 @@ script: bundle exec rake ci
 rvm:
   - 2.1
   - 2.2
-  - 2.3.0
-  - rbx-2
+  - 2.3
+  - 2.4
+  - jruby-9.1.7.0
+  - jruby-head
   - ruby-head
+  - rubinius-3
 matrix:
-  include:
-    - rvm: jruby
-      env: JRUBY_OPTS='--2.0 --server -Xcompile.invokedynamic=false'
-    - rvm: jruby-head
-      env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false'
   allow_failures:
-    - rvm: jruby
+    - rvm: jruby-9.1.7.0
     - rvm: jruby-head
-    - rvm: rbx-2
     - rvm: ruby-head
+    - rvm: rubinius-3
   fast_finish: true
 before_install:
-  - gem install bundler
+  - rvm use @global
+  - gem uninstall bundler -x
+  - gem install bundler --version=1.13.7
+  - bundler --version
 notifications:
   email:
     - timo.roessner@googlemail.com

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## 4.5.6 (2017-02-17)
+
+* (mvz) Raise on errors inside of Examiner#smells instead of outputting to STDERR
+* (mvz) Update parser dependency
+
 ## 4.5.5 (2017-02-05)
 
 * (mvz) Load YAML in code comments safely
@@ -25,10 +30,10 @@
 
 ## 4.5.0 (2016-10-12)
 
-* (maxjacobson) Emit fingerprints in Code Climate reporter
-* (mvz) Disable progress for piped output
-* (mvz) Update progress formatter to match changed file location
 * (jhubert) Add progress formatters for showing progress on each file
+* (mvz) Update progress formatter to match changed file location
+* (mvz) Disable progress for piped output
+* (maxjacobson) Emit fingerprints in Code Climate reporter
 
 ## 4.4.4 (2016-09-29)
 

data/Dockerfile

@@ -20,6 +20,7 @@ USER ${user}
 
 WORKDIR ${app_dir}
 
+RUN gem install rake
 RUN bundle install --without debugging development
 
 VOLUME ${code_dir}

data/Gemfile

@@ -10,10 +10,9 @@ group :development do
   gem 'ataru',         '~> 0.2.0'
   gem 'cucumber',      '~> 2.0'
   gem 'factory_girl',  '~> 4.0'
-  gem 'mutant-rspec',  '~> 0.8.8'
   gem 'rake',          '~> 12.0'
   gem 'rspec',         '~> 3.0'
-  gem 'simplecov',     '~> 0.12.0'
+  gem 'simplecov',     '~> 0.13.0'
   gem 'yard',          '~> 0.9.5'
 
   if RUBY_VERSION >= '2.3'

data/README.md

@@ -483,7 +483,9 @@ You can also run:
 bundle exec rake ci
 ```
 
-This will run everything the default task runs and also [Ataru](https://github.com/CodePadawans/ataru) and [Mutant](https://github.com/mbj/mutant). This is the task that we run on Travis as well and that determines if your pull request is green or red.
+This will run everything the default task runs and also
+[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:
 

data/docs/Nil-Check.md

@@ -17,7 +17,7 @@ Given
 class Klass
   def nil_checker(argument)
     if argument.nil?
-      puts "argument isn't nil!"
+      puts "argument is nil!"
     end
   end
 end

data/lib/reek/cli/command/report_command.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require_relative 'base_command'
 require_relative '../../examiner'
+require_relative '../../logging_error_handler'
 require_relative '../../report'
 
 module Reek
@@ -23,7 +24,8 @@ module Reek
           sources.each do |source|
             reporter.add_examiner Examiner.new(source,
                                                filter_by_smells: smell_names,
-                                               configuration: configuration)
+                                               configuration: configuration,
+                                               error_handler: LoggingErrorHandler.new)
           end
         end
 

data/lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+require_relative 'base_error'
 
 module Reek
   module Errors
     # Gets raised when trying to configure a detector with an option
     # which is unknown to it.
-    class BadDetectorConfigurationKeyInCommentError < RuntimeError
+    class BadDetectorConfigurationKeyInCommentError < BaseError
       UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-EOS.freeze
 
         Error: You are trying to configure the smell detector '%s'

data/lib/reek/errors/bad_detector_in_comment_error.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+require_relative 'base_error'
 
 module Reek
   module Errors
     # Gets raised when trying to configure a detector which is unknown to us.
     # This might happen for multiple reasons. The users might have a typo in
     # his comment or he might use a detector that does not exist anymore.
-    class BadDetectorInCommentError < RuntimeError
+    class BadDetectorInCommentError < BaseError
       UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-EOS.freeze
 
         Error: You are trying to configure an unknown smell detector '%s' in one

data/lib/reek/errors/base_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Reek
+  module Errors
+    # Base class for all runtime Reek errors
+    class BaseError < ::RuntimeError
+    end
+  end
+end

data/lib/reek/errors/garbage_detector_configuration_in_comment_error.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+require_relative 'base_error'
 
 module Reek
   module Errors
     # Gets raised when trying to use a configuration for a detector
     # that can't be parsed into a hash.
-    class GarbageDetectorConfigurationInCommentError < RuntimeError
+    class GarbageDetectorConfigurationInCommentError < BaseError
       BAD_DETECTOR_CONFIGURATION_MESSAGE = <<-EOS.freeze
 
         Error: You are trying to configure the smell detector '%s'.

data/lib/reek/errors/incomprehensible_source_error.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised when Reek is unable to process the source
+    class IncomprehensibleSourceError < BaseError
+      INCOMPREHENSIBLE_SOURCE_TEMPLATE = <<-EOS.freeze
+        !!!
+        Source %s can not be processed by Reek.
+
+        This is most likely either a bug in your Reek configuration (config file or
+        source code comments) or a Reek bug.
+
+        Please double check your Reek configuration taking the original exception
+        below into account -  you might have misspelled a smell detector for instance.
+        (In the future Reek will handle configuration errors more gracefully, something
+        we are working on already).
+
+        If you feel that this is not a problem with your Reek configuration but with
+        Reek itself it would be great if you could report this back to the Reek
+        team by opening up a corresponding issue at https://github.com/troessner/reek/issues.
+
+        Please make sure to include the source in question, the Reek version
+        and the original exception below.
+
+        Exception message:
+
+        %s
+
+        Original exception:
+
+        %s
+
+        !!!
+      EOS
+
+      def initialize(origin:, original_exception:)
+        message = format(INCOMPREHENSIBLE_SOURCE_TEMPLATE,
+                         origin,
+                         original_exception.message,
+                         original_exception.backtrace.join("\n\t"))
+        super message
+      end
+    end
+  end
+end

data/lib/reek/examiner.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 require_relative 'context_builder'
-require_relative 'errors/bad_detector_in_comment_error'
-require_relative 'errors/garbage_detector_configuration_in_comment_error'
 require_relative 'detector_repository'
+require_relative 'errors/incomprehensible_source_error'
 require_relative 'source/source_code'
 
 module Reek
@@ -11,35 +10,13 @@ module Reek
   #
   # @public
   class Examiner
-    INCOMPREHENSIBLE_SOURCE_TEMPLATE = <<-EOS.freeze
-      !!!
-      Source %s can not be processed by Reek.
-
-      This is most likely either a bug in your Reek configuration (config file or
-      source code comments) or a Reek bug.
-
-      Please double check your Reek configuration taking the original exception
-      below into account -  you might have misspelled a smell detector for instance.
-      (In the future Reek will handle configuration errors more gracefully, something
-      we are working on already).
-
-      If you feel that this is not a problem with your Reek configuration but with
-      Reek itself it would be great if you could report this back to the Reek
-      team by opening up a corresponding issue at https://github.com/troessner/reek/issues.
-
-      Please make sure to include the source in question, the Reek version
-      and the original exception below.
-
-      Exception message:
-
-      %s
-
-      Original exception:
-
-      %s
+    # Handles no errors
+    class NullHandler
+      def handle(_exception)
+        false
+      end
+    end
 
-      !!!
-    EOS
     #
     # Creates an Examiner which scans the given +source+ for code smells.
     #
@@ -57,11 +34,13 @@ module Reek
     def initialize(source,
                    filter_by_smells: [],
                    configuration: Configuration::AppConfiguration.default,
-                   detector_repository_class: DetectorRepository)
+                   detector_repository_class: DetectorRepository,
+                   error_handler: NullHandler.new)
       @source              = Source::SourceCode.from(source)
       @smell_types         = detector_repository_class.eligible_smell_types(filter_by_smells)
       @detector_repository = detector_repository_class.new(smell_types: @smell_types,
                                                            configuration: configuration.directive_for(description))
+      @error_handler       = error_handler
     end
 
     # @return [String] origin of the source being analysed
@@ -120,16 +99,8 @@ module Reek
       return [] unless syntax_tree
       begin
         examine_tree
-      rescue Errors::BadDetectorInCommentError,
-             Errors::GarbageDetectorConfigurationInCommentError,
-             Errors::BadDetectorConfigurationKeyInCommentError => exception
-        warn exception
-        []
-      rescue StandardError => exception
-        warn format(INCOMPREHENSIBLE_SOURCE_TEMPLATE,
-                    origin,
-                    exception.message,
-                    exception.backtrace.join("\n\t"))
+      rescue Errors::BaseError => exception
+        raise unless @error_handler.handle exception
         []
       end
     end
@@ -142,6 +113,10 @@ module Reek
       ContextBuilder.new(syntax_tree).context_tree.flat_map do |element|
         detector_repository.examine(element)
       end
+    rescue Errors::BaseError
+      raise
+    rescue StandardError => exception
+      raise Errors::IncomprehensibleSourceError, origin: origin, original_exception: exception
     end
   end
 end

data/lib/reek/logging_error_handler.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require_relative 'errors/bad_detector_configuration_key_in_comment_error'
+require_relative 'errors/bad_detector_in_comment_error'
+require_relative 'errors/garbage_detector_configuration_in_comment_error'
+require_relative 'errors/incomprehensible_source_error'
+
+module Reek
+  # Handles errors by logging to stderr
+  class LoggingErrorHandler
+    def handle(exception)
+      warn exception
+      true
+    end
+  end
+end

data/lib/reek/report/code_climate/code_climate_configuration.yml

@@ -432,7 +432,7 @@ LongYieldList:
 ManualDispatch:
   remediation_points: 350_000
   content: |
-    Reek reports a _Manual Dispatch_ smell if it finds source code that manually checks whether an object responds to a method before that method is called. Manual dispatch is a type of [Simulated Polymorphism](Simulated-Polymorphism.md) which leads to code that is harder to reason about, debug, and refactor.
+    Reek reports a _Manual Dispatch_ smell if it finds source code that manually checks whether an object responds to a method before that method is called. Manual dispatch is a type of Simulated Polymorphism which leads to code that is harder to reason about, debug, and refactor.
 
     ## Example
 

data/lib/reek/version.rb

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

data/reek.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |s|
   s.summary = 'Code smell detector for Ruby'
 
   s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.4.0'
-  s.add_runtime_dependency 'parser',                '~> 2.3.1', '>= 2.3.1.2'
+  s.add_runtime_dependency 'parser',                '< 2.5', '>= 2.3.1.2'
   s.add_runtime_dependency 'rainbow',               '~> 2.0'
 end

data/spec/reek/examiner_spec.rb

@@ -122,30 +122,29 @@ RSpec.describe Reek::Examiner do
         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/spec_helper.rb

@@ -84,9 +84,9 @@ RSpec.configure do |config|
     mocks.verify_doubled_constant_names = true
   end
 
-  # Avoid infinitely running tests. This is mainly useful when running mutant.
-  # Set the DEBUG environment variable to something truthy like '1' to disable
-  # this and allow using pry without specs failing.
+  # Avoid infinitely running tests. This is mainly useful when running a
+  # mutation tester. Set the DEBUG environment variable to something truthy
+  # like '1' to disable this and allow using pry without specs failing.
   unless ENV['DEBUG']
     config.around(:each) do |example|
       Timeout.timeout(5, &example)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.5.5
+  version: 4.5.6
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-05 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -31,9 +31,9 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.1.2
@@ -41,9 +41,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.1.2
@@ -226,8 +226,11 @@ files:
 - lib/reek/detector_repository.rb
 - lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb
 - lib/reek/errors/bad_detector_in_comment_error.rb
+- 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/examiner.rb
+- lib/reek/logging_error_handler.rb
 - lib/reek/rake/task.rb
 - lib/reek/report.rb
 - lib/reek/report/base_report.rb
@@ -351,6 +354,7 @@ files:
 - spec/reek/context_builder_spec.rb
 - spec/reek/detector_repository_spec.rb
 - spec/reek/examiner_spec.rb
+- spec/reek/logging_error_handler_spec.rb
 - spec/reek/rake/task_spec.rb
 - spec/reek/report/code_climate/code_climate_configuration_spec.rb
 - spec/reek/report/code_climate/code_climate_fingerprint_spec.rb
@@ -407,7 +411,6 @@ files:
 - tasks/ataru.rake
 - tasks/configuration.rake
 - tasks/console.rake
-- tasks/mutant.rake
 - tasks/reek.rake
 - tasks/rubocop.rake
 - tasks/test.rake

data/tasks/mutant.rake

@@ -1,14 +0,0 @@
-desc 'Runs mutant'
-task :mutant do
-  command = <<-EOS
-    RUBY_THREAD_VM_STACK_SIZE=64000\
-    bundle exec mutant\
-      --include lib\
-      --require reek\
-      --use rspec\
-      --since master^\
-      --jobs 4 'Reek*'
-  EOS
-  system command
-  abort unless $CHILD_STATUS.success?
-end