reek 5.6.0 → 6.0.3

data/lib/reek/cli/options.rb

@@ -87,7 +87,7 @@ module Reek
 
       def set_banner
         program_name = parser.program_name
-        parser.banner = <<-BANNER.gsub(/^[ ]+/, '')
+        parser.banner = <<-BANNER.gsub(/^ +/, '')
           Usage: #{program_name} [options] [files]
 
           Examples:
@@ -131,9 +131,9 @@ module Reek
       def set_alternative_formatter_options
         parser.separator "\nReport format:"
         parser.on(
-          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml, :code_climate],
+          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml],
           'Report smells in the given format:',
-          '  html', '  text (default)', '  yaml', '  json', '  xml', '  code_climate') do |opt|
+          '  html', '  text (default)', '  yaml', '  json', '  xml') do |opt|
           self.report_format = opt
         end
       end

data/lib/reek/code_comment.rb

@@ -6,6 +6,7 @@ require_relative 'smell_detectors/base_detector'
 require_relative 'errors/bad_detector_in_comment_error'
 require_relative 'errors/bad_detector_configuration_key_in_comment_error'
 require_relative 'errors/garbage_detector_configuration_in_comment_error'
+require_relative 'errors/legacy_comment_separator_error'
 
 module Reek
   #
@@ -14,12 +15,10 @@ module Reek
   #
   class CodeComment
     CONFIGURATION_REGEX = /
-                          :reek: # prefix
-                          (\w+)  # smell detector e.g.: UncommunicativeVariableName
-                          (
-                            \s*
-                            (\{.*?\}) # optional details in hash style e.g.: { max_methods: 30 }
-                          )?
+                          :reek:     # prefix
+                          (\w+)      # smell detector e.g.: UncommunicativeVariableName
+                          (:?\s*)    # separator
+                          (\{.*?\})? # details in hash style e.g.: { max_methods: 30 }
                          /x.freeze
     SANITIZE_REGEX                 = /(#|\n|\s)+/.freeze # Matches '#', newlines and > 1 whitespaces.
     DISABLE_DETECTOR_CONFIGURATION = '{ enabled: false }'
@@ -38,7 +37,8 @@ module Reek
       @source            = source
       @config            = Hash.new { |hash, key| hash[key] = {} }
 
-      @original_comment.scan(CONFIGURATION_REGEX) do |detector_name, _option_string, options|
+      @original_comment.scan(CONFIGURATION_REGEX) do |detector_name, separator, options|
+        escalate_legacy_separator separator
         CodeCommentValidator.new(detector_name:    detector_name,
                                  original_comment: original_comment,
                                  line:             line,
@@ -64,6 +64,14 @@ module Reek
         strip
     end
 
+    def escalate_legacy_separator(separator)
+      return unless separator.start_with? ':'
+
+      raise Errors::LegacyCommentSeparatorError.new(original_comment: original_comment,
+                                                    source: source,
+                                                    line: line)
+    end
+
     #
     # A typical configuration via code comment looks like this:
     #
@@ -88,25 +96,22 @@ module Reek
       # @param source [String] path to source file or "string"
       # @param options [String] the configuration options as String for the detector that were
       #   extracted from the original comment
-      def initialize(detector_name:, original_comment:, line:, source:, options: {})
+      def initialize(detector_name:, original_comment:, line:, source:, options:)
         @detector_name    = detector_name
         @original_comment = original_comment
         @line             = line
         @source           = source
         @options          = options
-        @detector_class   = nil # We only know this one after our first initial checks
-        @parsed_options   = nil # We only know this one after our first initial checks
       end
 
       #
       # Method can raise the following errors:
+      #   * Errors::LegacyCommentSeparatorError
       #   * Errors::BadDetectorInCommentError
       #   * Errors::GarbageDetectorConfigurationInCommentError
       #   * Errors::BadDetectorConfigurationKeyInCommentError
       # @return [undefined]
       def validate
-        escalate_bad_detector
-        escalate_bad_detector_configuration
         escalate_unknown_configuration_key
       end
 
@@ -116,22 +121,12 @@ module Reek
                   :original_comment,
                   :line,
                   :source,
-                  :options,
-                  :detector_class,
-                  :parsed_options
-
-      def escalate_bad_detector
-        return if SmellDetectors::BaseDetector.valid_detector?(detector_name)
+                  :separator,
+                  :options
 
-        raise Errors::BadDetectorInCommentError.new(detector_name: detector_name,
-                                                    original_comment: original_comment,
-                                                    source: source,
-                                                    line: line)
-      end
-
-      def escalate_bad_detector_configuration
-        @parsed_options = YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION,
-                                         permitted_classes: [Regexp])
+      def parsed_options
+        @parsed_options ||= YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION,
+                                           permitted_classes: [Regexp])
       rescue Psych::SyntaxError
         raise Errors::GarbageDetectorConfigurationInCommentError.new(detector_name: detector_name,
                                                                      original_comment: original_comment,
@@ -140,8 +135,6 @@ module Reek
       end
 
       def escalate_unknown_configuration_key
-        @detector_class = SmellDetectors::BaseDetector.to_detector(detector_name)
-
         return if given_keys_legit?
 
         raise Errors::BadDetectorConfigurationKeyInCommentError.new(detector_name: detector_name,
@@ -151,6 +144,20 @@ module Reek
                                                                     line: line)
       end
 
+      def detector_class
+        @detector_class ||= SmellDetectors::BaseDetector.to_detector(detector_name)
+      rescue NameError
+        raise Errors::BadDetectorInCommentError.new(detector_name: detector_name,
+                                                    original_comment: original_comment,
+                                                    source: source,
+                                                    line: line)
+      end
+
+      # @return [Boolean] comment uses legacy three-colon format
+      def legacy_format?
+        separator.start_with? ':'
+      end
+
       # @return [Boolean] all keys in code comment are applicable to the detector in question
       def given_keys_legit?
         given_configuration_keys.subset? valid_detector_keys

data/lib/reek/configuration/app_configuration.rb

@@ -72,11 +72,12 @@ module Reek
 
       def load_values(values)
         values.each do |key, value|
-          if key == EXCLUDE_PATHS_KEY
+          case key
+          when EXCLUDE_PATHS_KEY
             excluded_paths.add value
-          elsif key == DIRECTORIES_KEY
+          when DIRECTORIES_KEY
             directory_directives.add value
-          elsif key == DETECTORS_KEY
+          when DETECTORS_KEY
             default_directive.add value
           end
         end

data/lib/reek/configuration/configuration_converter.rb

@@ -74,7 +74,7 @@ module Reek
         return unless configuration[DETECTORS_KEY]
 
         configuration[DETECTORS_KEY].tap do |detectors|
-          detectors.keys.each do |detector|
+          detectors.each_key do |detector|
             convertible_attributes(detectors[detector]).each do |attribute|
               detectors[detector][attribute] = detectors[detector][attribute].map do |item|
                 to_regex item
@@ -94,7 +94,7 @@ module Reek
         return unless configuration[DIRECTORIES_KEY]
 
         configuration[DIRECTORIES_KEY].tap do |directories|
-          directories.keys.each do |directory|
+          directories.each_key do |directory|
             directories[directory].each do |detector, configuration|
               convertible_attributes(configuration).each do |attribute|
                 directories[directory][detector][attribute] = directories[directory][detector][attribute].map do |item|

data/lib/reek/configuration/directory_directives.rb

@@ -53,10 +53,16 @@ module Reek
       # @quality :reek:FeatureEnvy
       def best_match_for(source_base_dir)
         keys.
-          select { |pathname| source_base_dir.to_s.match(glob_to_regexp(pathname.to_s)) }.
+          select do |pathname|
+            match?(source_base_dir, pathname) || match?(source_base_dir, pathname.expand_path)
+          end.
           max_by { |pathname| pathname.to_s.length }
       end
 
+      def match?(source_base_dir, pathname)
+        source_base_dir.to_s.match(glob_to_regexp(pathname.to_s))
+      end
+
       # Transform a glob pattern to a regexp.
       #
       # It changes:
@@ -78,7 +84,7 @@ module Reek
                      gsub('<<to_eol_wildcards>>', '.*').
                      gsub('<<to_wildcards>>', '.*')
                  else
-                   glob + '.*'
+                   "#{glob}.*"
                  end
 
         Regexp.new("^#{regexp}$", Regexp::IGNORECASE)
@@ -86,7 +92,7 @@ module Reek
 
       def error_message_for_invalid_smell_type(klass)
         "You are trying to configure smell type #{klass} but we can't find one with that name.\n" \
-          "Please make sure you spelled it right. (See 'docs/defaults.reek' in the Reek\n" \
+          "Please make sure you spelled it right. (See 'docs/defaults.reek.yml' in the Reek\n" \
           'repository for a list of all available smell types.)'
       end
     end

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/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.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/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/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