reek 5.5.0 → 6.0.3

data/lib/reek/configuration/excluded_paths.rb

@@ -14,7 +14,8 @@ module Reek
       # @param paths [String]
       # @return [undefined]
       def add(paths)
-        paths.each { |path| self << Pathname(path) }
+        paths.flat_map { |path| Dir[path] }.
+          each { |path| self << Pathname(path) }
       end
     end
   end

data/lib/reek/context/code_context.rb

@@ -51,7 +51,7 @@ module Reek
       # @return [Enumerator]
       #
       def each(&block)
-        return enum_for(:each) unless block_given?
+        return enum_for(:each) unless block
 
         yield self
         children.each do |child|

data/lib/reek/context/module_context.rb

@@ -66,6 +66,8 @@ module Reek
         CodeComment.new(comment: exp.leading_comment).descriptive?
       end
 
+      CONSTANT_SEXP_TYPES = [:casgn, :class, :module].freeze
+
       # A namespace module is a module (or class) that is only there for namespacing
       # purposes, and thus contains only nested constants, modules or classes.
       #
@@ -78,7 +80,7 @@ module Reek
         return false if exp.type == :casgn
 
         children = exp.direct_children
-        children.any? && children.all? { |child| [:casgn, :class, :module].include? child.type }
+        children.any? && children.all? { |child| CONSTANT_SEXP_TYPES.include? child.type }
       end
 
       def track_visibility(visibility, names)

data/lib/reek/context/refinement_context.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'module_context'
+
+module Reek
+  module Context
+    #
+    # A context wrapper for any refinement blocks found in a syntax tree.
+    #
+    class RefinementContext < ModuleContext
+      def full_name
+        exp.call.args.first.name
+      end
+    end
+  end
+end

data/lib/reek/context_builder.rb

@@ -5,6 +5,7 @@ require_relative 'context/class_context'
 require_relative 'context/ghost_context'
 require_relative 'context/method_context'
 require_relative 'context/module_context'
+require_relative 'context/refinement_context'
 require_relative 'context/root_context'
 require_relative 'context/send_context'
 require_relative 'context/singleton_attribute_context'
@@ -20,7 +21,7 @@ module Reek
   # counting. Ideally `ContextBuilder` would only build up the context tree and leave the
   # statement and reference counting to the contexts.
   #
-  # @quality :reek:TooManyMethods { max_methods: 31 }
+  # @quality :reek:TooManyMethods { max_methods: 32 }
   # @quality :reek:UnusedPrivateMethod { exclude: [ !ruby/regexp /process_/ ] }
   # @quality :reek:DataClump
   class ContextBuilder
@@ -263,9 +264,16 @@ module Reek
     #
     # Counts non-empty blocks as one statement.
     #
+    # A refinement block is handled differently and causes a RefinementContext
+    # to be opened.
+    #
     def process_block(exp, _parent)
       increase_statement_count_by(exp.block)
-      process(exp)
+      if exp.call.name == :refine
+        handle_refinement_block(exp)
+      else
+        process(exp)
+      end
     end
 
     # Handles `begin` and `kwbegin` nodes. `begin` nodes are created implicitly
@@ -508,6 +516,12 @@ module Reek
       end
     end
 
+    def handle_refinement_block(exp)
+      inside_new_context(Context::RefinementContext, exp) do
+        process(exp)
+      end
+    end
+
     def handle_send_for_modules(exp)
       arg_names = exp.args.map { |arg| arg.children.first }
       current_context.track_visibility(exp.name, arg_names)

data/lib/reek/errors/legacy_comment_separator_error.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised for old-style comment configuration format.
+    class LegacyCommentSeparatorError < BaseError
+      MESSAGE = <<-MESSAGE
+        Error: You are using the legacy configuration format (including three
+        colons) to configure Reek in one your source code comments.
+
+        The source is '%<source>s' and the comment belongs to the expression
+        starting in line %<line>d.
+
+        Here's the original comment:
+
+        %<comment>s
+
+        Please see the Reek docs for information on how to configure Reek via
+        source code comments: #{DocumentationLink.build('Smell Suppression')}
+
+        Update the offensive comment and re-run Reek.
+
+      MESSAGE
+
+      def initialize(source:, line:, original_comment:)
+        message = format(MESSAGE,
+                         source: source,
+                         line: line,
+                         comment: original_comment)
+        super message
+      end
+    end
+  end
+end

data/lib/reek/examiner.rb

@@ -105,11 +105,11 @@ module Reek
     rescue Errors::BaseError
       raise
     rescue EncodingError
-      raise Errors::EncodingError, origin: origin
+      raise Errors::EncodingError.new(origin: origin)
     rescue Parser::SyntaxError
-      raise Errors::SyntaxError, origin: origin
+      raise Errors::SyntaxError.new(origin: origin)
     rescue StandardError
-      raise Errors::IncomprehensibleSourceError, origin: origin
+      raise Errors::IncomprehensibleSourceError.new(origin: origin)
     end
 
     def syntax_tree

data/lib/reek/report.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'report/code_climate'
 require_relative 'report/html_report'
 require_relative 'report/json_report'
 require_relative 'report/text_report'
@@ -17,12 +16,11 @@ module Reek
   # Reek reporting functionality.
   module Report
     REPORT_CLASSES = {
-      yaml:         YAMLReport,
-      json:         JSONReport,
-      html:         HTMLReport,
-      xml:          XMLReport,
-      text:         TextReport,
-      code_climate: CodeClimateReport
+      yaml: YAMLReport,
+      json: JSONReport,
+      html: HTMLReport,
+      xml:  XMLReport,
+      text: TextReport
     }.freeze
 
     LOCATION_FORMATTERS = {

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

@@ -59,7 +59,7 @@ BooleanParameter:
 
     ## Getting rid of the smell
 
-    This is highly dependant on your exact architecture, but looking at the example above what you could do is:
+    This is highly dependent on your exact architecture, but looking at the example above what you could do is:
 
     * Move everything in the `if` branch into a separate method
     * Move everything in the `else` branch into a separate method

data/lib/reek/report/code_climate/code_climate_report.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../base_report'
+require_relative 'code_climate_formatter'
 
 module Reek
   module Report
@@ -12,7 +13,7 @@ module Reek
     class CodeClimateReport < BaseReport
       def show(out = $stdout)
         smells.map do |smell|
-          out.print warning_formatter.format_code_climate_hash(smell)
+          out.print CodeClimateFormatter.new(smell).render
         end
       end
     end

data/lib/reek/report/simple_warning_formatter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'code_climate/code_climate_formatter'
-
 module Reek
   module Report
     #
@@ -17,11 +15,6 @@ module Reek
         "#{location_formatter.format(warning)}#{warning.base_message}"
       end
 
-      # @quality :reek:UtilityFunction
-      def format_code_climate_hash(warning)
-        CodeClimateFormatter.new(warning).render
-      end
-
       def format_list(warnings)
         warnings.map { |warning| "  #{format(warning)}" }.join("\n")
       end

data/lib/reek/report/text_report.rb

@@ -11,8 +11,8 @@ module Reek
     #
     class TextReport < BaseReport
       # @public
-      def initialize(*args)
-        super(*args)
+      def initialize(**args)
+        super
 
         print progress_formatter.header
       end

data/lib/reek/smell_detectors/base_detector.rb

@@ -19,6 +19,7 @@ module Reek
     # @quality :reek:TooManyMethods { max_methods: 18 }
     class BaseDetector
       attr_reader :config
+
       # The name of the config field that lists the names of code contexts
       # that should not be checked. Add this field to the config for each
       # smell that should ignore this code element.
@@ -121,15 +122,6 @@ module Reek
           @descendants ||= []
         end
 
-        #
-        # @param detector [String] the detector in question, e.g. 'DuplicateMethodCall'
-        # @return [Boolean]
-        #
-        def valid_detector?(detector)
-          descendants.map { |descendant| descendant.to_s.split('::').last }.
-            include?(detector)
-        end
-
         #
         # Transform a detector name to the corresponding constant.
         # Note that we assume a valid name - exceptions are not handled here.

data/lib/reek/smell_detectors/boolean_parameter.rb

@@ -14,6 +14,8 @@ module Reek
     #
     # See {file:docs/Boolean-Parameter.md} for details.
     class BooleanParameter < BaseDetector
+      BOOLEAN_VALUES = [:true, :false].freeze
+
       #
       # Checks whether the given method has any Boolean parameters.
       #
@@ -21,7 +23,7 @@ module Reek
       #
       def sniff
         context.default_assignments.select do |_parameter, value|
-          [:true, :false].include?(value.type)
+          BOOLEAN_VALUES.include?(value.type)
         end.map do |parameter, _value|
           smell_warning(
             lines: [source_line],

data/lib/reek/smell_detectors/data_clump.rb

@@ -51,7 +51,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        MethodGroup.new(context, min_clump_size, max_copies).clumps.map do |clump, methods|
+        clumps.map do |clump, methods|
           methods_length = methods.length
           smell_warning(
             lines: methods.map(&:line),
@@ -72,72 +72,39 @@ module Reek
       private
 
       def max_copies
-        value(MAX_COPIES_KEY, context)
+        @max_copies ||= value(MAX_COPIES_KEY, context)
       end
 
       def min_clump_size
-        value(MIN_CLUMP_SIZE_KEY, context)
+        @min_clump_size ||= value(MIN_CLUMP_SIZE_KEY, context)
       end
-    end
-  end
 
-  # Represents a group of methods
-  # @private
-  class MethodGroup
-    def initialize(ctx, min_clump_size, max_copies)
-      @min_clump_size = min_clump_size
-      @max_copies = max_copies
-      @candidate_methods = ctx.node_instance_methods.map do |defn_node|
-        CandidateMethod.new(defn_node)
+      def candidate_methods
+        @candidate_methods ||= context.node_instance_methods
       end
-    end
 
-    def candidate_clumps
-      candidate_methods.each_cons(max_copies + 1).map do |methods|
-        common_argument_names_for(methods)
-      end.select do |clump|
-        clump.length >= min_clump_size
-      end.uniq
-    end
-
-    # @quality :reek:UtilityFunction
-    def common_argument_names_for(methods)
-      methods.map(&:arg_names).inject(:&)
-    end
-
-    def methods_containing_clump(clump)
-      candidate_methods.select { |method| clump & method.arg_names == clump }
-    end
-
-    def clumps
-      candidate_clumps.map do |clump|
-        [clump, methods_containing_clump(clump)]
+      def candidate_clumps
+        candidate_methods.each_cons(max_copies + 1).map do |methods|
+          common_argument_names_for(methods)
+        end.select do |clump|
+          clump.length >= min_clump_size
+        end.uniq
       end
-    end
-
-    private
 
-    attr_reader :candidate_methods, :max_copies, :min_clump_size
-  end
-
-  # A method definition and a copy of its parameters
-  # @private
-  class CandidateMethod
-    extend Forwardable
-
-    def_delegators :defn, :line, :name
+      # @quality :reek:UtilityFunction
+      def common_argument_names_for(methods)
+        methods.map(&:arg_names).inject(:&).compact.sort
+      end
 
-    def initialize(defn_node)
-      @defn = defn_node
-    end
+      def methods_containing_clump(clump)
+        candidate_methods.select { |method| clump & method.arg_names == clump }
+      end
 
-    def arg_names
-      # TODO: Is all this sorting still needed?
-      @arg_names ||= defn.arg_names.compact.sort
+      def clumps
+        candidate_clumps.map do |clump|
+          [clump, methods_containing_clump(clump)]
+        end
+      end
     end
-
-    private
-
-    attr_reader :defn
   end
 end

data/lib/reek/smell_detectors/nil_check.rb

@@ -24,8 +24,7 @@ module Reek
 
       def detect_nodes
         finders = [NodeFinder.new(context, :send, NilCallNodeDetector),
-                   NodeFinder.new(context, :when, NilWhenNodeDetector),
-                   NodeFinder.new(context, :csend, SafeNavigationNodeDetector)]
+                   NodeFinder.new(context, :when, NilWhenNodeDetector)]
         finders.flat_map(&:smelly_nodes)
       end
 
@@ -88,16 +87,6 @@ module Reek
           node.condition_list.any? { |it| it.type == :nil }
         end
       end
-
-      # Detect safe navigation. Returns true for all nodes, since all :csend
-      # nodes are considered smelly.
-      module SafeNavigationNodeDetector
-        module_function
-
-        def detect(_node)
-          true
-        end
-      end
     end
   end
 end

data/lib/reek/smell_detectors/subclassed_from_core_class.rb

@@ -43,13 +43,9 @@ module Reek
       end
 
       def build_smell_warning(ancestor_name)
-        smell_attributes = {
-          lines:      [source_line],
-          message:    "inherits from core class '#{ancestor_name}'",
-          parameters: { ancestor: ancestor_name }
-        }
-
-        smell_warning(smell_attributes)
+        smell_warning(lines:      [source_line],
+                      message:    "inherits from core class '#{ancestor_name}'",
+                      parameters: { ancestor: ancestor_name })
       end
     end
   end

data/lib/reek/smell_detectors/uncommunicative_variable_name.rb

@@ -74,7 +74,7 @@ module Reek
       end
 
       def uncommunicative_variable_name?(name)
-        sanitized_name = name.to_s.gsub(/^[@\*\&]*/, '')
+        sanitized_name = name.to_s.gsub(/^[@*&]*/, '')
         !acceptable_name?(sanitized_name)
       end
 

data/lib/reek/smell_warning.rb

@@ -31,8 +31,7 @@ module Reek
     #   public API.
     #
     # @quality :reek:LongParameterList { max_params: 6 }
-    def initialize(smell_type, context: '', lines:, message:,
-                   source:, parameters: {})
+    def initialize(smell_type, lines:, message:, source:, context: '', parameters: {})
       @smell_type = smell_type
       @source     = source
       @context    = context.to_s