reek 4.7.3 → 4.8.0

data/lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb

@@ -9,12 +9,12 @@ module Reek
     class BadDetectorConfigurationKeyInCommentError < BaseError
       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.
-        The source is '%s' and the comment belongs to the expression starting in line %d.
+        Error: You are trying to configure the smell detector '%<detector>s'
+        in one of your source code comments with the unknown option %<option>s.
+        The source is '%<source>s' and the comment belongs to the expression starting in line %<line>d.
         Here's the original comment:
 
-        %s
+        %<comment>s
 
         Please see the Reek docs for:
           * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
@@ -26,11 +26,11 @@ module Reek
 
       def initialize(detector_name:, offensive_keys:, source:, line:, original_comment:)
         message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,
-                         detector_name,
-                         offensive_keys,
-                         source,
-                         line,
-                         original_comment)
+                         detector: detector_name,
+                         option: offensive_keys,
+                         source: source,
+                         line: line,
+                         comment: original_comment)
         super message
       end
     end

data/lib/reek/errors/bad_detector_in_comment_error.rb

@@ -10,12 +10,12 @@ module Reek
     class BadDetectorInCommentError < BaseError
       UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE.freeze
 
-        Error: You are trying to configure an unknown smell detector '%s' in one
+        Error: You are trying to configure an unknown smell detector '%<detector>s' in one
         of your source code comments.
-        The source is '%s' and the comment belongs to the expression starting in line %d.
+        The source is '%<source>s' and the comment belongs to the expression starting in line %<line>d.
         Here's the original comment:
 
-        %s
+        %<comment>s
 
         Please see the Reek docs for:
           * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
@@ -26,10 +26,10 @@ module Reek
 
       def initialize(detector_name:, source:, line:, original_comment:)
         message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,
-                         detector_name,
-                         source,
-                         line,
-                         original_comment)
+                         detector: detector_name,
+                         source: source,
+                         line: line,
+                         comment: original_comment)
         super message
       end
     end

data/lib/reek/errors/base_error.rb

@@ -4,6 +4,9 @@ module Reek
   module Errors
     # Base class for all runtime Reek errors
     class BaseError < ::RuntimeError
+      def long_message
+        message
+      end
     end
   end
 end

data/lib/reek/errors/encoding_error.rb

@@ -6,9 +6,11 @@ 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
+      TEMPLATE = "Source '%<source>s' cannot be processed by Reek due to an encoding error in the source file.".freeze
+
+      LONG_TEMPLATE = <<-MESSAGE.freeze
         !!!
-        Source '%s' cannot be processed by Reek due to an encoding error in the source file.
+        %<message>s
 
         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.
@@ -17,21 +19,24 @@ module Reek
 
         Exception message:
 
-        %s
+        %<exception>s
 
-        Original exception:
+        Original backtrace:
 
-        %s
+        %<original>s
 
         !!!
       MESSAGE
 
-      def initialize(origin:, original_exception:)
-        message = format(ENCODING_ERROR_TEMPLATE,
-                         origin,
-                         original_exception.message,
-                         original_exception.backtrace.join("\n\t"))
-        super message
+      def initialize(origin:)
+        super format(TEMPLATE, source: origin)
+      end
+
+      def long_message
+        format(LONG_TEMPLATE,
+               message: message,
+               exception: cause.inspect,
+               original: cause.backtrace.join("\n\t"))
       end
     end
   end

data/lib/reek/errors/garbage_detector_configuration_in_comment_error.rb

@@ -9,12 +9,12 @@ module Reek
     class GarbageDetectorConfigurationInCommentError < BaseError
       BAD_DETECTOR_CONFIGURATION_MESSAGE = <<-MESSAGE.freeze
 
-        Error: You are trying to configure the smell detector '%s'.
+        Error: You are trying to configure the smell detector '%<detector>s'.
         Unfortunately we cannot parse the configuration you have given.
-        The source is '%s' and the comment belongs to the expression starting in line %d.
+        The source is '%<source>s' and the comment belongs to the expression starting in line %<line>d.
         Here's the original comment:
 
-        %s
+        %<comment>s
 
         Please see the Reek docs for:
           * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
@@ -25,10 +25,10 @@ module Reek
 
       def initialize(detector_name:, source:, line:, original_comment:)
         message = format(BAD_DETECTOR_CONFIGURATION_MESSAGE,
-                         detector_name,
-                         source,
-                         line,
-                         original_comment)
+                         detector: detector_name,
+                         source: source,
+                         line: line,
+                         comment: original_comment)
         super message
       end
     end

data/lib/reek/errors/incomprehensible_source_error.rb

@@ -6,42 +6,40 @@ module Reek
   module Errors
     # Gets raised when Reek is unable to process the source
     class IncomprehensibleSourceError < BaseError
-      INCOMPREHENSIBLE_SOURCE_TEMPLATE = <<-MESSAGE.freeze
-        !!!
-        Source %s cannot be processed by Reek.
+      TEMPLATE = 'Source %<source>s cannot be processed by Reek.'.freeze
 
-        This is most likely either a problem in your Reek configuration (config file or
-        source code comments) or a Reek bug.
+      LONG_TEMPLATE = <<-MESSAGE.freeze
+        !!!
+        %<message>s
 
-        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).
+        This is most likely a Reek bug.
 
-        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.
+        It would be great if you could report this back to the Reek team by opening 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.
+        Please make sure to include the source in question, the Reek version and the
+        original exception below.
 
         Exception message:
 
-        %s
+        %<exception>s
 
         Original exception:
 
-        %s
+        %<original>s
 
         !!!
       MESSAGE
 
-      def initialize(origin:, original_exception:)
-        message = format(INCOMPREHENSIBLE_SOURCE_TEMPLATE,
-                         origin,
-                         original_exception.message,
-                         original_exception.backtrace.join("\n\t"))
-        super message
+      def initialize(origin:)
+        super format(TEMPLATE, source: origin)
+      end
+
+      def long_message
+        format(LONG_TEMPLATE,
+               message: message,
+               exception: cause.inspect,
+               original: cause.backtrace.join("\n\t"))
       end
     end
   end

data/lib/reek/examiner.rb

@@ -3,6 +3,7 @@
 require_relative 'context_builder'
 require_relative 'detector_repository'
 require_relative 'errors/incomprehensible_source_error'
+require_relative 'errors/encoding_error'
 require_relative 'source/source_code'
 
 module Reek
@@ -95,26 +96,24 @@ module Reek
     #
     # @return [Array<SmellWarning>] the smells found in the source
     #
-    # :reek:TooManyStatements { max_statements: 6 }
     def run
-      if source.valid_syntax? && syntax_tree
-        examine_tree
-      else
-        SmellDetectors::Syntax.smells_from_source(source)
+      wrap_exceptions do
+        examine_tree || report_syntax_errors
       end
     rescue StandardError => exception
-      wrapper = wrap_exception exception
-      raise wrapper unless @error_handler.handle wrapper
+      raise unless @error_handler.handle exception
       []
     end
 
-    def wrap_exception(exception)
-      case exception
-      when Errors::BaseError
-        exception
-      else
-        Errors::IncomprehensibleSourceError.new(origin: origin, original_exception: exception)
-      end
+    # :reek:TooManyStatements { max_statements: 6 }
+    def wrap_exceptions
+      yield
+    rescue Errors::BaseError
+      raise
+    rescue EncodingError
+      raise Errors::EncodingError, origin: origin
+    rescue StandardError
+      raise Errors::IncomprehensibleSourceError, origin: origin
     end
 
     def syntax_tree
@@ -122,9 +121,14 @@ module Reek
     end
 
     def examine_tree
+      return unless syntax_tree
       ContextBuilder.new(syntax_tree).context_tree.flat_map do |element|
         detector_repository.examine(element)
       end
     end
+
+    def report_syntax_errors
+      SmellDetectors::Syntax.smells_from_source(source)
+    end
   end
 end

data/lib/reek/logging_error_handler.rb

@@ -1,15 +1,17 @@
 # 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'
+require_relative 'errors/base_error'
 
 module Reek
   # Handles errors by logging to stderr
   class LoggingErrorHandler
     def handle(exception)
-      warn exception
+      case exception
+      when Errors::BaseError
+        warn exception.long_message
+      else
+        warn exception
+      end
       true
     end
   end

data/lib/reek/smell_detectors/class_variable.rb

@@ -25,7 +25,8 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        class_variables_in_context.map do |variable, lines|
+        class_variables_in_context.map do |variable, occurences|
+          lines = occurences.map(&:line)
           smell_warning(
             context: context,
             lines: lines,
@@ -38,16 +39,8 @@ module Reek
       # Collects the names of the class variables declared and/or used
       # in the given module.
       #
-      # :reek:TooManyStatements: { max_statements: 7 }
       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|
-          expression.each_node(stmt_type, [:class, :module], &collector)
-        end
-        result
+        context.local_nodes([:cvar, :cvasgn, :cvdecl]).group_by(&:name)
       end
     end
   end

data/lib/reek/smell_detectors/duplicate_method_call.rb

@@ -121,7 +121,7 @@ module Reek
         # :reek:TooManyStatements: { max_statements: 6 }
         # :reek:DuplicateMethodCall: { max_calls: 2 }
         def collect_calls(result)
-          context.each_node(:send, [:mlhs]) do |call_node|
+          context.local_nodes(:send, [:mlhs]) do |call_node|
             next if call_node.object_creation_call?
             next if simple_method_call? call_node
             result[call_node].record(call_node)

data/lib/reek/smell_detectors/instance_variable_assumption.rb

@@ -55,17 +55,9 @@ module Reek
 
       def variables_from_context
         method_expressions.map do |method|
-          method.find_nodes(assumption_nodes, ignored_nodes).map(&:name)
+          method.each_node(:ivar, [:or_asgn]).map(&:name)
         end.flatten
       end
-
-      def assumption_nodes
-        [:ivar]
-      end
-
-      def ignored_nodes
-        [:or_asgn]
-      end
     end
   end
 end

data/lib/reek/smell_detectors/manual_dispatch.rb

@@ -20,7 +20,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        smelly_nodes = context.each_node(:send).select { |node| node.name == :respond_to? }
+        smelly_nodes = context.local_nodes(:send).select { |node| node.name == :respond_to? }
         return [] if smelly_nodes.empty?
         lines = smelly_nodes.map(&:line)
         [smell_warning(context: context, lines: lines, message: MESSAGE)]

data/lib/reek/smell_detectors/module_initialize.rb

@@ -21,7 +21,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        context.local_nodes(:def) do |node|
+        context.defined_instance_methods.each do |node|
           if node.name == :initialize
             return smell_warning(
               context: context,

data/lib/reek/smell_detectors/nested_iterators.rb

@@ -97,7 +97,8 @@ module Reek
       # :reek:TooManyStatements: { max_statements: 6 }
       def scout(exp:, depth:)
         return [] unless exp
-        exp.find_nodes([:block]).flat_map do |iterator|
+        # Find all non-nested blocks in this expression
+        exp.each_node([:block], [:block]).flat_map do |iterator|
           new_depth = increment_depth(iterator, depth)
           # 1st case: we recurse down the given block of the iterator. In this case
           # we need to check if we should increment the depth.

data/lib/reek/smell_detectors/too_many_constants.rb

@@ -35,7 +35,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        count = context.each_node(:casgn, IGNORED_NODES).delete_if(&:defines_module?).length
+        count = context.local_nodes(:casgn).reject(&:defines_module?).length
 
         return [] if count <= max_allowed_constants
 

data/lib/reek/smell_detectors/uncommunicative_variable_name.rb

@@ -92,11 +92,11 @@ module Reek
       end
 
       def find_assignment_variable_names(accumulator)
-        assignment_nodes = expression.each_node(:lvasgn, [:class, :module, :defs, :def])
+        assignment_nodes = expression.each_node(:lvasgn, [:class, :module, :defs, :def]).to_a
 
         case expression.type
         when :class, :module
-          assignment_nodes += expression.each_node(:ivasgn, [:class, :module])
+          assignment_nodes += expression.each_node(:ivasgn, [:class, :module]).to_a
         end
 
         assignment_nodes.each { |asgn| accumulator[asgn.children.first].push(asgn.line) }

data/lib/reek/smell_detectors/utility_function.rb

@@ -71,7 +71,7 @@ module Reek
       private
 
       def num_helper_methods
-        context.local_nodes(:send).length
+        context.local_nodes(:send).to_a.length
       end
 
       def ignore_method?

data/lib/reek/source/source_code.rb

@@ -2,12 +2,11 @@
 
 require_relative '../cli/silencer'
 Reek::CLI::Silencer.silently do
-  require 'parser/ruby24'
+  require 'parser/ruby25'
 end
 require_relative '../tree_dresser'
 require_relative '../ast/node'
 require_relative '../ast/builder'
-require_relative '../errors/encoding_error'
 
 # Opt in to new way of representing lambdas
 Reek::AST::Builder.emit_lambda = true
@@ -54,11 +53,6 @@ module Reek
         end
       end
 
-      # @return [true|false] Returns true if parsed file does not have any syntax errors.
-      def valid_syntax?
-        diagnostics.none? { |diagnostic| [:error, :fatal].include?(diagnostic.level) }
-      end
-
       def diagnostics
         parse_if_needed
         @diagnostics
@@ -105,34 +99,26 @@ module Reek
       # where each node is possibly adorned with our SexpExtensions (see ast/ast_node_class_map
       # and ast/sexp_extensions for details).
       #
-      # @param parser [Parser::Ruby24]
+      # @param parser [Parser::Ruby25]
       # @param source [String] - Ruby code
       # @return [Anonymous subclass of Reek::AST::Node] the AST presentation
       #         for the given source
-      # :reek:TooManyStatements { max_statements: 8 }
+      # :reek:TooManyStatements { max_statements: 6 }
       def parse(parser, source)
-        begin
-          buffer = Parser::Source::Buffer.new(origin, 1)
-          source.force_encoding(Encoding::UTF_8)
-          buffer.source = source
-        rescue EncodingError => exception
-          raise Errors::EncodingError, origin: origin, original_exception: exception
-        end
-        begin
-          ast, comments = parser.parse_with_comments(buffer)
-        rescue Parser::SyntaxError # rubocop:disable Lint/HandleExceptions
-          # All errors are in diagnostics. No need to handle exception.
-        end
+        buffer = Parser::Source::Buffer.new(origin, 1)
+        source.force_encoding(Encoding::UTF_8)
+        buffer.source = source
+        ast, comments = parser.parse_with_comments(buffer)
 
         # See https://whitequark.github.io/parser/Parser/Source/Comment/Associator.html
-        comment_map = Parser::Source::Comment.associate(ast, comments) if ast
+        comment_map = Parser::Source::Comment.associate(ast, comments)
         TreeDresser.new.dress(ast, comment_map)
       end
 
       # :reek:TooManyStatements: { max_statements: 6 }
       # :reek:FeatureEnvy
       def default_parser
-        Parser::Ruby24.new(AST::Builder.new).tap do |parser|
+        Parser::Ruby25.new(AST::Builder.new).tap do |parser|
           diagnostics = parser.diagnostics
           diagnostics.all_errors_are_fatal = false
           diagnostics.ignore_warnings      = false