reek 4.5.0 → 4.6.0

data/lib/reek/smell_detectors/control_parameter.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/data_clump.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/duplicate_method_call.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/feature_envy.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/instance_variable_assumption.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/irresponsible_module.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/long_parameter_list.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
-require_relative 'smell_configuration'
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/long_yield_list.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/manual_dispatch.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors
@@ -21,11 +20,10 @@ module Reek
       #
       # :reek:FeatureEnvy
       def sniff(ctx)
-        ctx.each_node(:send).flat_map do |node|
-          next unless node.name.equal?(:respond_to?)
-
-          smell_warning(context: ctx, lines: [node.line], message: MESSAGE)
-        end.compact
+        smelly_nodes = ctx.each_node(:send).select { |node| node.name == :respond_to? }
+        return [] if smelly_nodes.empty?
+        lines = smelly_nodes.map(&:line)
+        [smell_warning(context: ctx, lines: lines, message: MESSAGE)]
       end
     end
   end

data/lib/reek/smell_detectors/module_initialize.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors
@@ -23,13 +22,11 @@ module Reek
       # :reek:FeatureEnvy
       def sniff(ctx)
         ctx.local_nodes(:def) do |node|
-          if node.name.to_s == 'initialize'
-            return [
-              smell_warning(
-                context: ctx,
-                lines:   [ctx.exp.line],
-                message: 'has initialize method')
-            ]
+          if node.name == :initialize
+            return smell_warning(
+              context: ctx,
+              lines:   [ctx.exp.line],
+              message: 'has initialize method')
           end
         end
         []

data/lib/reek/smell_detectors/nested_iterators.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/nil_check.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/prima_donna_method.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors
@@ -29,6 +28,24 @@ module Reek
         [:class]
       end
 
+      #
+      # @param ctx [Context::ModuleContext]
+      # @return [Array<SmellWarning>]
+      #
+      # Given this code:
+      #
+      # class Alfa
+      #   def bravo!
+      #   end
+      # end
+      #
+      # An example `ctx` could look like this:
+      #
+      # s(:class,
+      #   s(:const, nil, :Alfa), nil,
+      #     s(:def, :bravo!,
+      #       s(:args), nil))
+      #
       def sniff(ctx)
         ctx.node_instance_methods.select do |method_sexp|
           prima_donna_method?(method_sexp, ctx)
@@ -46,6 +63,7 @@ module Reek
 
       def prima_donna_method?(method_sexp, ctx)
         return false unless method_sexp.ends_with_bang?
+        return false if ignore_method?(method_sexp, ctx)
         return false if version_without_bang_exists?(method_sexp, ctx)
         true
       end
@@ -56,6 +74,17 @@ module Reek
           sexp_item.name.to_s == method_sexp.name_without_bang
         end
       end
+
+      #
+      # @param method_node [Reek::AST::Node],
+      #   e.g. s(:def, :bravo!, s(:args), nil)
+      # @param ctx [Context::ModuleContext]
+      # @return [Boolean]
+      #
+      def ignore_method?(method_node, ctx)
+        ignore_method_names = value(EXCLUDE_KEY, ctx) # e.g. ["bravo!"]
+        ignore_method_names.include? method_node.name.to_s # method_node.name is e.g.: :bravo!
+      end
     end
   end
 end

data/lib/reek/smell_detectors/repeated_conditional.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require_relative '../ast/node'
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/subclassed_from_core_class.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/too_many_constants.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/too_many_instance_variables.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/too_many_methods.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/too_many_statements.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/uncommunicative_method_name.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/uncommunicative_module_name.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/uncommunicative_parameter_name.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/uncommunicative_variable_name.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/unused_parameters.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/unused_private_method.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
-require_relative '../context/method_context'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/utility_function.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require_relative '../ast/reference_collector'
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_warning.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+require 'forwardable'
+
+module Reek
+  #
+  # Reports a warning that a smell has been found.
+  #
+  # @public
+  #
+  # :reek:TooManyInstanceVariables: { max_instance_variables: 6 }
+  class SmellWarning
+    include Comparable
+    extend Forwardable
+
+    # @public
+    attr_reader :context, :lines, :message, :parameters, :smell_detector, :source
+    def_delegators :smell_detector, :smell_type
+
+    # @note When using Reek's public API, you should not create SmellWarning
+    #   objects yourself. This is why the initializer is not part of the
+    #   public API.
+    #
+    # :reek:LongParameterList: { max_params: 6 }
+    def initialize(smell_detector, context: '', lines:, message:,
+                   source:, parameters: {})
+      @smell_detector = smell_detector
+      @source         = source
+      @context        = context.to_s
+      @lines          = lines
+      @message        = message
+      @parameters     = parameters
+
+      freeze
+    end
+
+    # @public
+    def hash
+      identifying_values.hash
+    end
+
+    # @public
+    def <=>(other)
+      identifying_values <=> other.identifying_values
+    end
+
+    # @public
+    def eql?(other)
+      (self <=> other).zero?
+    end
+
+    # @public
+    def to_hash
+      stringified_params = Hash[parameters.map { |key, val| [key.to_s, val] }]
+      base_hash.merge(stringified_params)
+    end
+
+    alias yaml_hash to_hash
+
+    def base_message
+      "#{smell_type}: #{context} #{message}"
+    end
+
+    def smell_class
+      smell_detector.class
+    end
+
+    protected
+
+    def identifying_values
+      [smell_type, context, message, lines]
+    end
+
+    private
+
+    def base_hash
+      {
+        'context'        => context,
+        'lines'          => lines,
+        'message'        => message,
+        'smell_type'     => smell_type,
+        'source'         => source
+      }
+    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/should_reek_of.rb

@@ -25,7 +25,7 @@ module Reek
                      configuration = Configuration::AppConfiguration.default)
         @smell_type = normalize smell_type_or_class
         @smell_details = smell_details
-        configuration.load_values(smell_type => { SmellDetectors::SmellConfiguration::ENABLED_KEY => true })
+        configuration.load_values(smell_type => { SmellConfiguration::ENABLED_KEY => true })
         @configuration = configuration
       end
 

data/lib/reek/spec.rb

@@ -48,10 +48,10 @@ module Reek
     # Checks the target source code for instances of "smell type"
     # and returns true only if it can find one of them that matches.
     #
-    # You could pass many different types of input here:
+    # You can pass the smell type you want to check for as String or as Symbol:
+    #
     #   - :UtilityFunction
     #   - "UtilityFunction"
-    #   - Reek::Smells::UtilityFunction
     #
     # It is recommended to pass this as a symbol like :UtilityFunction. However we don't
     # enforce this.
@@ -70,7 +70,7 @@ module Reek
     # @example Without smell_details
     #
     #   reek_of(:FeatureEnvy)
-    #   reek_of(Reek::Smells::UtilityFunction)
+    #   reek_of(:UtilityFunction)
     #
     # @example With smell_details
     #
@@ -79,7 +79,7 @@ module Reek
     #
     # @example From a real spec
     #
-    #   expect(src).to reek_of(Reek::Smells::DuplicateMethodCall, name: '@other.thing')
+    #   expect(src).to reek_of(:DuplicateMethodCall, name: '@other.thing')
     #
     # @public
     #
@@ -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.0'.freeze
+    STRING = '4.6.0'.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/factories/factories.rb

@@ -1,17 +1,9 @@
 require_relative '../../lib/reek/smell_detectors'
 require_relative '../../lib/reek/smell_detectors/base_detector'
-require_relative '../../lib/reek/smell_detectors/smell_warning'
+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
@@ -34,7 +26,7 @@ FactoryGirl.define do
     end
   end
 
-  factory :smell_warning, class: Reek::SmellDetectors::SmellWarning do
+  factory :smell_warning, class: Reek::SmellWarning do
     skip_create
     smell_detector
     context 'self'

data/spec/quality/reek_source_spec.rb

@@ -1,9 +1,11 @@
 require_relative '../spec_helper'
 
 RSpec.describe 'Reek source code' do
-  it 'has no smells' do
-    Pathname.glob('lib/**/*.rb').each do |pathname|
-      expect(pathname).not_to reek
+  Pathname.glob('lib/**/*.rb').each do |pathname|
+    describe pathname do
+      it 'has no smells' do
+        expect(pathname).not_to reek
+      end
     end
   end
 end

data/spec/reek/ast/reference_collector_spec.rb

@@ -43,22 +43,5 @@ RSpec.describe Reek::AST::ReferenceCollector do
     it 'ignores global variables' do
       expect(refs_to_self('def no_envy(arga) $s2.to_a; $s2[arga] end')).to eq(0)
     end
-
-    it 'ignores global variables' do
-      src = <<-EOS
-        def accept(t, pat = /.*/nm, &block)
-          if pat
-            pat.respond_to?(:match) or raise TypeError, "has no `match'"
-          else
-            pat = t if t.respond_to?(:match)
-          end
-          unless block
-            block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
-          end
-          @atype[t] = [pat, block]
-        end
-      EOS
-      expect(refs_to_self(src)).to eq(2)
-    end
   end
 end

data/spec/reek/cli/application_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe Reek::CLI::Application do
         end
       end
       expect(call).to raise_error(SystemExit) do |error|
-        expect(error.status).to eq Reek::CLI::Options::DEFAULT_ERROR_EXIT_CODE
+        expect(error.status).to eq Reek::CLI::Status::DEFAULT_ERROR_EXIT_CODE
       end
     end
   end
@@ -100,6 +100,30 @@ RSpec.describe Reek::CLI::Application do
                configuration: Reek::Configuration::AppConfiguration,
                options: Reek::CLI::Options)
       end
+
+      context 'when source files are excluded through configuration' do
+        let(:app) { described_class.new ['--config', 'some_file.reek', '.'] }
+
+        before do
+          allow(Reek::Configuration::AppConfiguration).
+            to receive(:from_path).
+            with(Pathname.new('some_file.reek')).
+            and_return configuration
+        end
+
+        it 'uses configuration for excluded paths' do
+          expected_sources = Reek::Source::SourceLocator.
+            new(['.'], configuration: configuration).sources
+          expect(expected_sources).not_to include(path_excluded_in_configuration)
+
+          app.execute
+
+          expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
+            with(sources: expected_sources,
+                 configuration: configuration,
+                 options: Reek::CLI::Options)
+        end
+      end
     end
   end
 end

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

@@ -26,7 +26,7 @@ RSpec.describe Reek::CLI::Command::ReportCommand do
         result = Reek::CLI::Silencer.silently do
           command.execute
         end
-        expect(result).to eq Reek::CLI::Options::DEFAULT_SUCCESS_EXIT_CODE
+        expect(result).to eq Reek::CLI::Status::DEFAULT_SUCCESS_EXIT_CODE
       end
     end
 
@@ -37,7 +37,7 @@ RSpec.describe Reek::CLI::Command::ReportCommand do
         result = Reek::CLI::Silencer.silently do
           command.execute
         end
-        expect(result).to eq Reek::CLI::Options::DEFAULT_FAILURE_EXIT_CODE
+        expect(result).to eq Reek::CLI::Status::DEFAULT_FAILURE_EXIT_CODE
       end
     end
   end