reek 5.4.1 → 6.0.2

data/features/command_line_interface/options.feature

@@ -43,7 +43,7 @@ Feature: Reek can be controlled using command-line options
           -c, --config FILE                Read configuration options from FILE
               --smell SMELL                Only look for a specific smell.
                                            Call it like this: reek --smell MissingSafeMethod source.rb
-                                           Check out https://github.com/troessner/reek/blob/v5.4.1/docs/Code-Smells.md for a list of smells
+                                           Check out https://github.com/troessner/reek/blob/v6.0.2/docs/Code-Smells.md for a list of smells
               --stdin-filename FILE        When passing code in via pipe, assume this filename when checking file or directory rules in the config.
 
       Generate a todo list:
@@ -56,7 +56,6 @@ Feature: Reek can be controlled using command-line options
                                              yaml
                                              json
                                              xml
-                                             code_climate
 
       Text format options:
               --[no-]color                 Use colors for the output (default: true)
@@ -120,5 +119,5 @@ Feature: Reek can be controlled using command-line options
       UnusedPrivateMethod
       UtilityFunction
 
-      Check out https://github.com/troessner/reek/blob/v5.4.1/docs/Code-Smells.md for a details on each detector
+      Check out https://github.com/troessner/reek/blob/v6.0.2/docs/Code-Smells.md for a details on each detector
       """

data/features/configuration_files/schema_validation.feature

@@ -6,7 +6,7 @@ Feature: Validate schema
   Scenario: Our generated default configuration
     Given our default configuration file
     And the clean file "clean.rb"
-    When I run reek -c defaults.reek clean.rb
+    When I run reek -c defaults.reek.yml clean.rb
     Then it succeeds
     And it reports nothing
 

data/features/reports/codeclimate.feature

@@ -4,7 +4,7 @@ Feature: Report smells using Code Climate format
 
   Scenario: output is empty when there are no smells
     Given a directory called 'clean' containing two clean files
-    When I run reek --format code_climate clean
+    When I run the code climate reek runner
     Then it succeeds
     And it reports this Code Climate output:
     """
@@ -12,7 +12,7 @@ Feature: Report smells using Code Climate format
 
   Scenario: Indicate smells and print them as JSON when using files
     Given the smelly file 'smelly.rb'
-    When I run reek --format code_climate smelly.rb
+    When I run the code climate reek runner
     Then it reports this Code Climate output:
       """
       {

data/features/reports/json.feature

@@ -24,7 +24,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 4 ],
               "message": "has the name 'x'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.4.1/docs/Uncommunicative-Method-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Method-Name.md",
               "name": "x"
           },
           {
@@ -33,7 +33,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 5 ],
               "message": "has the variable name 'y'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.4.1/docs/Uncommunicative-Variable-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Variable-Name.md",
               "name": "y"
           }
       ]
@@ -53,7 +53,7 @@ Feature: Report smells using simple JSON layout
                   1
               ],
               "message": "has no descriptive comment",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.4.1/docs/Irresponsible-Module.md"
+              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.2/docs/Irresponsible-Module.md"
           }
       ]
       """

data/features/reports/reports.feature

@@ -182,8 +182,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.4.1/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.4.1/docs/Uncommunicative-Variable-Name.md]
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:
@@ -209,8 +209,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.4.1/docs/Uncommunicative-Method-Name.md]
-        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.4.1/docs/Uncommunicative-Variable-Name.md]
+        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Method-Name.md]
+        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:

data/features/reports/yaml.feature

@@ -25,7 +25,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeMethodName
         source: smelly.rb
         name: x
-        documentation_link: https://github.com/troessner/reek/blob/v5.4.1/docs/Uncommunicative-Method-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Method-Name.md
       - context: Smelly#x
         lines:
         - 5
@@ -33,7 +33,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeVariableName
         source: smelly.rb
         name: y
-        documentation_link: https://github.com/troessner/reek/blob/v5.4.1/docs/Uncommunicative-Variable-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Variable-Name.md
       """
 
   Scenario: Indicate smells and print them as yaml when using STDIN
@@ -48,5 +48,5 @@ Feature: Report smells using simple YAML layout
         lines:
         - 1
         message: has no descriptive comment
-        documentation_link: https://github.com/troessner/reek/blob/v5.4.1/docs/Irresponsible-Module.md
+        documentation_link: https://github.com/troessner/reek/blob/v6.0.2/docs/Irresponsible-Module.md
       """

data/features/step_definitions/reek_steps.rb

@@ -2,7 +2,11 @@ When /^I run reek (.*)$/ do |args|
   reek(args)
 end
 
-When /^I pass "([^\"]*)" to reek *(.*)$/ do |stdin, args|
+When 'I run the code climate reek runner' do
+  run_command_and_stop 'code_climate_reek'
+end
+
+When /^I pass "([^"]*)" to reek *(.*)$/ do |stdin, args|
   reek_with_pipe(stdin, args)
 end
 

data/features/step_definitions/sample_file_steps.rb

@@ -44,8 +44,8 @@ Given(/^a configuration file '(.+)'$/) do |filename|
 end
 
 Given(/^our default configuration file$/) do
-  default_configuration = File.read SAMPLES_DIR.join('..').join('docs').join('defaults.reek.yml')
-  write_file('defaults.reek', default_configuration)
+  default_configuration = File.read Reek::DEFAULT_SMELL_CONFIGURATION
+  write_file('defaults.reek.yml', default_configuration)
 end
 
 When(/^I run "reek (.*?)" in a subdirectory$/) do |args|

data/features/support/env.rb

@@ -1,11 +1,10 @@
 require_relative '../../lib/reek'
 require_relative '../../lib/reek/cli/application'
 require 'aruba/cucumber'
-require 'active_support/core_ext/string/strip'
 
 begin
   require 'pry-byebug'
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError # rubocop:disable Lint/SuppressedException
 end
 
 #

data/lib/reek.rb

@@ -8,6 +8,7 @@ require_relative 'reek/examiner'
 require_relative 'reek/report'
 
 module Reek
+  DEFAULT_SMELL_CONFIGURATION = File.join(__dir__, '../docs/defaults.reek.yml').freeze
   DEFAULT_CONFIGURATION_FILE_NAME = '.reek.yml'
   DETECTORS_KEY = 'detectors'
   EXCLUDE_PATHS_KEY = 'exclude_paths'

data/lib/reek/ast/sexp_extensions/arguments.rb

@@ -93,6 +93,17 @@ module Reek
       module ShadowargNode
         include ArgNodeBase
       end
+
+      # Utility methods for :forward_args nodes.
+      # rubocop:disable Naming/ClassAndModuleCamelCase
+      module Forward_ArgsNode
+        include ArgNodeBase
+
+        def anonymous_splat?
+          true
+        end
+      end
+      # rubocop:enable Naming/ClassAndModuleCamelCase
     end
   end
 end

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,39 +121,41 @@ module Reek
                   :original_comment,
                   :line,
                   :source,
-                  :options,
-                  :detector_class,
-                  :parsed_options
-
-      def escalate_bad_detector
-        return if SmellDetectors::BaseDetector.valid_detector?(detector_name)
-
-        raise Errors::BadDetectorInCommentError, detector_name: detector_name,
-                                                 original_comment: original_comment,
-                                                 source: source,
-                                                 line: line
-      end
+                  :separator,
+                  :options
 
-      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, detector_name: detector_name,
-                                                                  original_comment: original_comment,
-                                                                  source: source,
-                                                                  line: line
+        raise Errors::GarbageDetectorConfigurationInCommentError.new(detector_name: detector_name,
+                                                                     original_comment: original_comment,
+                                                                     source: source,
+                                                                     line: line)
       end
 
       def escalate_unknown_configuration_key
-        @detector_class = SmellDetectors::BaseDetector.to_detector(detector_name)
-
         return if given_keys_legit?
 
-        raise Errors::BadDetectorConfigurationKeyInCommentError, detector_name: detector_name,
-                                                                 offensive_keys: configuration_keys_difference,
-                                                                 original_comment: original_comment,
-                                                                 source: source,
-                                                                 line: line
+        raise Errors::BadDetectorConfigurationKeyInCommentError.new(detector_name: detector_name,
+                                                                    offensive_keys: configuration_keys_difference,
+                                                                    original_comment: original_comment,
+                                                                    source: source,
+                                                                    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

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