reek 4.7.2 → 4.7.3

data/lib/reek/context/ghost_context.rb

@@ -41,8 +41,6 @@ module Reek
                                             names: names
       end
 
-      def track_singleton_visibility(_visibility, _names); end
-
       def record_use_of_self
         parent.record_use_of_self
       end

data/lib/reek/context/module_context.rb

@@ -84,9 +84,6 @@ module Reek
         visibility_tracker.track_visibility children: instance_method_children,
                                             visibility: visibility,
                                             names: names
-      end
-
-      def track_singleton_visibility(visibility, names)
         visibility_tracker.track_singleton_visibility children: singleton_method_children,
                                                       visibility: visibility,
                                                       names: names

data/lib/reek/context_builder.rb

@@ -509,10 +509,8 @@ module Reek
     end
 
     def handle_send_for_modules(exp)
-      method_name = exp.name
-      arg_names = exp.arg_names
-      current_context.track_visibility(method_name, arg_names)
-      current_context.track_singleton_visibility(method_name, arg_names)
+      arg_names = exp.args.map { |arg| arg.children.first }
+      current_context.track_visibility(exp.name, arg_names)
       register_attributes(exp)
     end
 

data/lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb

@@ -7,7 +7,7 @@ module Reek
     # Gets raised when trying to configure a detector with an option
     # which is unknown to it.
     class BadDetectorConfigurationKeyInCommentError < BaseError
-      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-EOS.freeze
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE.freeze
 
         Error: You are trying to configure the smell detector '%s'
         in one of your source code comments with the unknown option %s.
@@ -22,7 +22,7 @@ module Reek
           * what custom options are available by checking the detector specific documentation in /docs
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 
-      EOS
+      MESSAGE
 
       def initialize(detector_name:, offensive_keys:, source:, line:, original_comment:)
         message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,

data/lib/reek/errors/bad_detector_in_comment_error.rb

@@ -8,7 +8,7 @@ module Reek
     # 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 < BaseError
-      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-EOS.freeze
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE.freeze
 
         Error: You are trying to configure an unknown smell detector '%s' in one
         of your source code comments.
@@ -22,7 +22,7 @@ module Reek
           * what smell detectors are available: https://github.com/troessner/reek/blob/master/docs/Code-Smells.md
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 
-      EOS
+      MESSAGE
 
       def initialize(detector_name:, source:, line:, original_comment:)
         message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,

data/lib/reek/errors/encoding_error.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised when Reek is unable to process the source due to an EncodingError
+    class EncodingError < BaseError
+      ENCODING_ERROR_TEMPLATE = <<-MESSAGE.freeze
+        !!!
+        Source '%s' cannot be processed by Reek due to an encoding error in the source file.
+
+        This is a problem that is outside of Reek's scope and should be fixed by you, the
+        user, in order for Reek being able to continue.
+        Check out this article for an idea on how to get started:
+        https://www.justinweiss.com/articles/3-steps-to-fix-encoding-problems-in-ruby/
+
+        Exception message:
+
+        %s
+
+        Original exception:
+
+        %s
+
+        !!!
+      MESSAGE
+
+      def initialize(origin:, original_exception:)
+        message = format(ENCODING_ERROR_TEMPLATE,
+                         origin,
+                         original_exception.message,
+                         original_exception.backtrace.join("\n\t"))
+        super message
+      end
+    end
+  end
+end

data/lib/reek/errors/garbage_detector_configuration_in_comment_error.rb

@@ -7,10 +7,10 @@ module Reek
     # Gets raised when trying to use a configuration for a detector
     # that can't be parsed into a hash.
     class GarbageDetectorConfigurationInCommentError < BaseError
-      BAD_DETECTOR_CONFIGURATION_MESSAGE = <<-EOS.freeze
+      BAD_DETECTOR_CONFIGURATION_MESSAGE = <<-MESSAGE.freeze
 
         Error: You are trying to configure the smell detector '%s'.
-        Unfortunately we can not parse the configuration you have given.
+        Unfortunately we cannot parse the configuration you have given.
         The source is '%s' and the comment belongs to the expression starting in line %d.
         Here's the original comment:
 
@@ -21,7 +21,7 @@ module Reek
           * what smell detectors are available: https://github.com/troessner/reek/blob/master/docs/Code-Smells.md
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 
-      EOS
+      MESSAGE
 
       def initialize(detector_name:, source:, line:, original_comment:)
         message = format(BAD_DETECTOR_CONFIGURATION_MESSAGE,

data/lib/reek/errors/incomprehensible_source_error.rb

@@ -6,11 +6,11 @@ module Reek
   module Errors
     # Gets raised when Reek is unable to process the source
     class IncomprehensibleSourceError < BaseError
-      INCOMPREHENSIBLE_SOURCE_TEMPLATE = <<-EOS.freeze
+      INCOMPREHENSIBLE_SOURCE_TEMPLATE = <<-MESSAGE.freeze
         !!!
-        Source %s can not be processed by Reek.
+        Source %s cannot be processed by Reek.
 
-        This is most likely either a bug in your Reek configuration (config file or
+        This is most likely either a problem in your Reek configuration (config file or
         source code comments) or a Reek bug.
 
         Please double check your Reek configuration taking the original exception
@@ -34,7 +34,7 @@ module Reek
         %s
 
         !!!
-      EOS
+      MESSAGE
 
       def initialize(origin:, original_exception:)
         message = format(INCOMPREHENSIBLE_SOURCE_TEMPLATE,

data/lib/reek/examiner.rb

@@ -95,18 +95,26 @@ module Reek
     #
     # @return [Array<SmellWarning>] the smells found in the source
     #
-    # :reek:TooManyStatements { max_statements: 8 }
+    # :reek:TooManyStatements { max_statements: 6 }
     def run
       if source.valid_syntax? && syntax_tree
-        begin
-          examine_tree
-        rescue Errors::BaseError => exception
-          raise unless @error_handler.handle exception
-          []
-        end
+        examine_tree
       else
         SmellDetectors::Syntax.smells_from_source(source)
       end
+    rescue StandardError => exception
+      wrapper = wrap_exception exception
+      raise wrapper unless @error_handler.handle wrapper
+      []
+    end
+
+    def wrap_exception(exception)
+      case exception
+      when Errors::BaseError
+        exception
+      else
+        Errors::IncomprehensibleSourceError.new(origin: origin, original_exception: exception)
+      end
     end
 
     def syntax_tree
@@ -117,10 +125,6 @@ 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/rake/task.rb

@@ -73,10 +73,14 @@ module Reek
         @name          = name
         @reek_opts     = ENV['REEK_OPTS'] || ''
         @fail_on_error = true
-        @source_files  = FileList[ENV['REEK_SRC'] || 'lib/**/*.rb']
         @verbose       = false
 
         yield self if block_given?
+
+        if (reek_src = ENV['REEK_SRC'])
+          @source_files = FileList[reek_src]
+        end
+        @source_files ||= FileList['lib/**/*.rb']
         define_task
       end
 

data/lib/reek/smell_detectors/attribute.rb

@@ -16,10 +16,6 @@ module Reek
     #
     # TODO: Catch attributes declared "by hand"
     class Attribute < BaseDetector
-      def initialize(*args)
-        super
-      end
-
       def self.contexts # :nodoc:
         [:sym]
       end
@@ -29,10 +25,10 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def sniff(ctx)
-        attributes_in(ctx).map do |_attribute, line|
+      def sniff
+        attributes_in_context.map do |_attribute, line|
           smell_warning(
-            context: ctx,
+            context: context,
             lines: [line],
             message: 'is a writable attribute')
         end
@@ -40,10 +36,9 @@ module Reek
 
       private
 
-      # :reek:UtilityFunction
-      def attributes_in(module_ctx)
-        if module_ctx.visibility == :public
-          call_node = module_ctx.exp
+      def attributes_in_context
+        if context.visibility == :public
+          call_node = expression
           [[call_node.name, call_node.line]]
         else
           []

data/lib/reek/smell_detectors/base_detector.rb

@@ -41,7 +41,7 @@ module Reek
         return [] unless enabled?
         return [] if exception?
 
-        sniff(context)
+        sniff
       end
 
       def self.todo_configuration_for(smells)
@@ -54,6 +54,14 @@ module Reek
 
       attr_reader :context
 
+      def expression
+        @expression ||= context.exp
+      end
+
+      def source_line
+        @line ||= expression.line
+      end
+
       def exception?
         context.matches?(value(EXCLUDE_KEY, context))
       end

data/lib/reek/smell_detectors/boolean_parameter.rb

@@ -19,14 +19,13 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      # :reek:FeatureEnvy
-      def sniff(ctx)
-        ctx.default_assignments.select do |_parameter, value|
+      def sniff
+        context.default_assignments.select do |_parameter, value|
           [:true, :false].include?(value.type)
         end.map do |parameter, _value|
           smell_warning(
-            context: ctx,
-            lines: [ctx.exp.line],
+            context: context,
+            lines: [source_line],
             message: "has boolean parameter '#{parameter}'",
             parameters: { parameter: parameter.to_s })
         end

data/lib/reek/smell_detectors/class_variable.rb

@@ -24,10 +24,10 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def sniff(ctx)
-        class_variables_in(ctx.exp).map do |variable, lines|
+      def sniff
+        class_variables_in_context.map do |variable, lines|
           smell_warning(
-            context: ctx,
+            context: context,
             lines: lines,
             message: "declares the class variable '#{variable}'",
             parameters: { name: variable.to_s })
@@ -39,14 +39,13 @@ module Reek
       # in the given module.
       #
       # :reek:TooManyStatements: { max_statements: 7 }
-      # :reek:FeatureEnvy
-      def class_variables_in(exp)
+      def class_variables_in_context
         result = Hash.new { |hash, key| hash[key] = [] }
         collector = proc do |cvar_node|
           result[cvar_node.name].push(cvar_node.line)
         end
         [:cvar, :cvasgn, :cvdecl].each do |stmt_type|
-          exp.each_node(stmt_type, [:class, :module], &collector)
+          expression.each_node(stmt_type, [:class, :module], &collector)
         end
         result
       end

data/lib/reek/smell_detectors/control_parameter.rb

@@ -50,11 +50,11 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       # :reek:FeatureEnvy
-      def sniff(ctx)
-        ControlParameterCollector.new(ctx).control_parameters.map do |control_parameter|
+      def sniff
+        ControlParameterCollector.new(context).control_parameters.map do |control_parameter|
           argument = control_parameter.name.to_s
           smell_warning(
-            context: ctx,
+            context: context,
             lines: control_parameter.lines,
             message: "is controlled by argument '#{argument}'",
             parameters: { argument: argument })

data/lib/reek/smell_detectors/data_clump.rb

@@ -50,14 +50,11 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      # :reek:FeatureEnvy
-      def sniff(ctx)
-        max_copies = value(MAX_COPIES_KEY, ctx)
-        min_clump_size = value(MIN_CLUMP_SIZE_KEY, ctx)
-        MethodGroup.new(ctx, min_clump_size, max_copies).clumps.map do |clump, methods|
+      def sniff
+        MethodGroup.new(context, min_clump_size, max_copies).clumps.map do |clump, methods|
           methods_length = methods.length
           smell_warning(
-            context: ctx,
+            context: context,
             lines: methods.map(&:line),
             message: "takes parameters #{DataClump.print_clump(clump)} " \
                      "to #{methods_length} methods",
@@ -72,6 +69,16 @@ module Reek
       def self.print_clump(clump)
         "[#{clump.map { |parameter| "'#{parameter}'" }.join(', ')}]"
       end
+
+      private
+
+      def max_copies
+        value(MAX_COPIES_KEY, context)
+      end
+
+      def min_clump_size
+        value(MIN_CLUMP_SIZE_KEY, context)
+      end
     end
   end
 

data/lib/reek/smell_detectors/duplicate_method_call.rb

@@ -37,26 +37,33 @@ module Reek
       end
 
       #
-      # Looks for duplicate calls within the body of the method +ctx+.
+      # Looks for duplicate calls within the body of the method context.
       #
       # @return [Array<SmellWarning>]
       #
-      # :reek:FeatureEnvy
-      # :reek:DuplicateMethodCall: { max_calls: 2 }
-      def sniff(ctx)
-        max_allowed_calls = value(MAX_ALLOWED_CALLS_KEY, ctx)
-        allow_calls = value(ALLOW_CALLS_KEY, ctx)
-
-        collector = CallCollector.new(ctx, max_allowed_calls, allow_calls)
+      def sniff
+        collector = CallCollector.new(context, max_allowed_calls, allow_calls)
         collector.smelly_calls.map do |found_call|
+          call = found_call.call
+          occurs = found_call.occurs
           smell_warning(
-            context: ctx,
+            context: context,
             lines: found_call.lines,
-            message: "calls '#{found_call.call}' #{found_call.occurs} times",
-            parameters: { name: found_call.call, count: found_call.occurs })
+            message: "calls '#{call}' #{occurs} times",
+            parameters: { name: call, count: occurs })
         end
       end
 
+      private
+
+      def max_allowed_calls
+        value(MAX_ALLOWED_CALLS_KEY, context)
+      end
+
+      def allow_calls
+        value(ALLOW_CALLS_KEY, context)
+      end
+
       # Collects information about a single found call
       class FoundCall
         def initialize(call_node)

data/lib/reek/smell_detectors/feature_envy.rb

@@ -42,11 +42,11 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def sniff(ctx)
-        return [] unless ctx.references_self?
-        envious_receivers(ctx).map do |name, lines|
+      def sniff
+        return [] unless context.references_self?
+        envious_receivers.map do |name, lines|
           smell_warning(
-            context: ctx,
+            context: context,
             lines: lines,
             message: "refers to '#{name}' more than self (maybe move it to another class?)",
             parameters: { name: name.to_s })
@@ -55,9 +55,11 @@ module Reek
 
       private
 
-      # :reek:UtilityFunction
-      def envious_receivers(ctx)
-        refs = ctx.refs
+      def refs
+        @refs ||= context.refs
+      end
+
+      def envious_receivers
         return {} if refs.self_is_max?
         refs.most_popular
       end