rubocop 0.72.0 → 0.76.0

data/lib/rubocop/config_loader.rb

@@ -46,7 +46,7 @@ module RuboCop
 
         add_missing_namespaces(path, hash)
 
-        resolver.resolve_inheritance_from_gems(hash, hash.delete('inherit_gem'))
+        resolver.resolve_inheritance_from_gems(hash)
         resolver.resolve_inheritance(path, hash, file, debug?)
 
         hash.delete('inherit_from')
@@ -199,6 +199,8 @@ module RuboCop
           raise(TypeError, "Malformed configuration in #{absolute_path}")
         end
 
+        check_cop_config_value(hash)
+
         hash
       end
 
@@ -220,6 +222,22 @@ module RuboCop
         end
       end
 
+      def check_cop_config_value(hash, parent = nil)
+        hash.each do |key, value|
+          check_cop_config_value(value, key) if value.is_a?(Hash)
+
+          next unless %w[Enabled
+                         Safe
+                         SafeAutoCorrect
+                         AutoCorrect].include?(key) && value.is_a?(String)
+
+          abort(
+            "Property #{Rainbow(key).yellow} of cop #{Rainbow(parent).yellow}" \
+            " is supposed to be a boolean and #{Rainbow(value).yellow} is not."
+          )
+        end
+      end
+
       # Read the specified file, or exit with a friendly, concise message on
       # stderr. Care is taken to use the standard OS exit code for a "file not
       # found" error.
@@ -240,11 +258,11 @@ module RuboCop
             yaml_code,
             permitted_classes: [Regexp, Symbol],
             permitted_symbols: [],
-            aliases: false,
+            aliases: true,
             filename: filename
           )
         else
-          YAML.safe_load(yaml_code, [Regexp, Symbol], [], false, filename)
+          YAML.safe_load(yaml_code, [Regexp, Symbol], [], true, filename)
         end
       end
     end

data/lib/rubocop/config_loader_resolver.rb

@@ -35,7 +35,8 @@ module RuboCop
       end
     end
 
-    def resolve_inheritance_from_gems(hash, gems)
+    def resolve_inheritance_from_gems(hash)
+      gems = hash.delete('inherit_gem')
       (gems || {}).each_pair do |gem_name, config_path|
         if gem_name == 'rubocop'
           raise ArgumentError,
@@ -73,7 +74,7 @@ module RuboCop
 
       opts = { inherit_mode: config['inherit_mode'] || {},
                unset_nil: unset_nil }
-      Config.new(merge(default_configuration, config, opts), config_file)
+      Config.new(merge(default_configuration, config, **opts), config_file)
     end
 
     # Return a recursive merge of two hashes. That is, a normal hash merge,
@@ -92,7 +93,7 @@ module RuboCop
         elsif should_union?(base_hash, key, opts[:inherit_mode])
           result[key] = base_hash[key] | derived_hash[key]
         elsif opts[:debug]
-          warn_on_duplicate_setting(base_hash, derived_hash, key, opts)
+          warn_on_duplicate_setting(base_hash, derived_hash, key, **opts)
         end
       end
       result

data/lib/rubocop/config_obsoletion.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This class handles obsolete configuration.
+  class ConfigObsoletion
+    RENAMED_COPS = {
+      'Lint/UnneededCopDisableDirective' => 'Lint/RedundantCopDisableDirective',
+      'Lint/UnneededCopEnableDirective' => 'Lint/RedundantCopEnableDirective',
+      'Lint/UnneededRequireStatement' => 'Lint/RedundantRequireStatement',
+      'Lint/UnneededSplatExpansion' => 'Lint/RedundantSplatExpansion',
+      'Style/SingleSpaceBeforeFirstArg' => 'Layout/SpaceBeforeFirstArg',
+      'Style/MethodCallParentheses' => 'Style/MethodCallWithoutArgsParentheses',
+      'Style/DeprecatedHashMethods' => 'Style/PreferredHashMethods',
+      'Style/OpMethod' => 'Naming/BinaryOperatorParameterName',
+      'Style/UnneededCapitalW' => 'Style/RedundantCapitalW',
+      'Style/UnneededCondition' => 'Style/RedundantCondition',
+      'Style/UnneededInterpolation' => 'Style/RedundantInterpolation',
+      'Style/UnneededPercentQ' => 'Style/RedundantPercentQ',
+      'Style/UnneededSort' => 'Style/RedundantSort',
+      'Layout/FirstParameterIndentation' => 'Layout/IndentFirstArgument',
+      'Layout/IndentArray' => 'Layout/IndentFirstArrayElement',
+      'Layout/IndentHash' => 'Layout/IndentFirstHashElement'
+    }.map do |old_name, new_name|
+      [old_name, "The `#{old_name}` cop has been renamed to `#{new_name}`."]
+    end
+
+    MOVED_COPS = {
+      'Security' => 'Lint/Eval',
+      'Naming' => %w[Style/ClassAndModuleCamelCase Style/ConstantName
+                     Style/FileName Style/MethodName Style/PredicateName
+                     Style/VariableName Style/VariableNumber
+                     Style/AccessorMethodName Style/AsciiIdentifiers],
+      'Layout' => %w[Lint/BlockAlignment Lint/EndAlignment
+                     Lint/DefEndAlignment],
+      'Lint' => 'Style/FlipFlop'
+    }.map do |new_department, old_names|
+      Array(old_names).map do |old_name|
+        [old_name, "The `#{old_name}` cop has been moved to " \
+                   "`#{new_department}/#{old_name.split('/').last}`."]
+      end
+    end
+
+    REMOVED_COPS = {
+      'Rails/DefaultScope' => nil,
+      'Layout/SpaceAfterControlKeyword' => 'Layout/SpaceAroundKeyword',
+      'Layout/SpaceBeforeModifierKeyword' => 'Layout/SpaceAroundKeyword',
+      'Style/SpaceAfterControlKeyword' => 'Layout/SpaceAroundKeyword',
+      'Style/SpaceBeforeModifierKeyword' => 'Layout/SpaceAroundKeyword',
+      'Style/TrailingComma' => 'Style/TrailingCommaInArguments, ' \
+                               'Style/TrailingCommaInArrayLiteral, and/or ' \
+                               'Style/TrailingCommaInHashLiteral',
+      'Style/TrailingCommaInLiteral' => 'Style/TrailingCommaInArrayLiteral ' \
+                                        'and/or ' \
+                                        'Style/TrailingCommaInHashLiteral',
+      'Lint/RescueWithoutErrorClass' => 'Style/RescueStandardError'
+    }.map do |old_name, other_cops|
+      if other_cops
+        more = ". Please use #{other_cops} instead".gsub(%r{[A-Z]\w+/\w+},
+                                                         '`\&`')
+      end
+      [old_name, "The `#{old_name}` cop has been removed#{more}."]
+    end
+
+    REMOVED_COPS_WITH_REASON = {
+      'Lint/InvalidCharacterLiteral' => 'it was never being actually triggered',
+      'Lint/SpaceBeforeFirstArg' =>
+        'it was a duplicate of `Layout/SpaceBeforeFirstArg`. Please use ' \
+        '`Layout/SpaceBeforeFirstArg` instead'
+    }.map do |cop_name, reason|
+      [cop_name, "The `#{cop_name}` cop has been removed since #{reason}."]
+    end
+
+    SPLIT_COPS = {
+      'Style/MethodMissing' =>
+        'The `Style/MethodMissing` cop has been split into ' \
+        '`Style/MethodMissingSuper` and `Style/MissingRespondToMissing`.'
+    }.to_a
+
+    OBSOLETE_COPS = Hash[*(RENAMED_COPS + MOVED_COPS + REMOVED_COPS +
+                           REMOVED_COPS_WITH_REASON + SPLIT_COPS).flatten]
+
+    OBSOLETE_PARAMETERS = [
+      {
+        cops: %w[Layout/SpaceAroundOperators Style/SpaceAroundOperators],
+        parameters: 'MultiSpaceAllowedForOperators',
+        alternative: 'If your intention was to allow extra spaces for ' \
+                     'alignment, please use AllowForAlignment: true instead.'
+      },
+      {
+        cops: 'Style/Encoding',
+        parameters: %w[EnforcedStyle SupportedStyles
+                       AutoCorrectEncodingComment],
+        alternative: 'Style/Encoding no longer supports styles. ' \
+                     'The "never" behavior is always assumed.'
+      },
+      {
+        cops: 'Style/IfUnlessModifier',
+        parameters: 'MaxLineLength',
+        alternative: '`Style/IfUnlessModifier: MaxLineLength` has been ' \
+                     'removed. Use `Metrics/LineLength: Max` instead'
+      },
+      {
+        cops: 'Style/WhileUntilModifier',
+        parameters: 'MaxLineLength',
+        alternative: '`Style/WhileUntilModifier: MaxLineLength` has been ' \
+                     'removed. Use `Metrics/LineLength: Max` instead'
+      },
+      {
+        cops: 'AllCops',
+        parameters: 'RunRailsCops',
+        alternative: "Use the following configuration instead:\n" \
+                     "Rails:\n  Enabled: true"
+      },
+      {
+        cops: 'Layout/CaseIndentation',
+        parameters: 'IndentWhenRelativeTo',
+        alternative: '`IndentWhenRelativeTo` has been renamed to ' \
+                     '`EnforcedStyle`'
+      },
+      {
+        cops: %w[Lint/BlockAlignment Layout/BlockAlignment Lint/EndAlignment
+                 Layout/EndAlignment Lint/DefEndAlignment
+                 Layout/DefEndAlignment],
+        parameters: 'AlignWith',
+        alternative: '`AlignWith` has been renamed to `EnforcedStyleAlignWith`'
+      },
+      {
+        cops: 'Rails/UniqBeforePluck',
+        parameters: 'EnforcedMode',
+        alternative: '`EnforcedMode` has been renamed to `EnforcedStyle`'
+      },
+      {
+        cops: 'Style/MethodCallWithArgsParentheses',
+        parameters: 'IgnoredMethodPatterns',
+        alternative: '`IgnoredMethodPatterns` has been renamed to ' \
+                     '`IgnoredPatterns`'
+      },
+      {
+        cops: %w[Performance/Count Performance/Detect],
+        parameters: 'SafeMode',
+        alternative: '`SafeMode` has been removed. ' \
+                     'Use `SafeAutoCorrect` instead.'
+      }
+    ].freeze
+
+    OBSOLETE_ENFORCED_STYLES = [
+      {
+        cop: 'Layout/IndentationConsistency',
+        parameter: 'EnforcedStyle',
+        enforced_style: 'rails',
+        alternative: '`EnforcedStyle: rails` has been renamed to ' \
+                     '`EnforcedStyle: indented_internal_methods`'
+      }
+    ].freeze
+
+    def initialize(config)
+      @config = config
+    end
+
+    def reject_obsolete_cops_and_parameters
+      messages = [obsolete_cops, obsolete_parameters,
+                  obsolete_enforced_style].flatten.compact
+      return if messages.empty?
+
+      raise ValidationError, messages.join("\n")
+    end
+
+    private
+
+    def obsolete_cops
+      OBSOLETE_COPS.map do |cop_name, message|
+        next unless @config.key?(cop_name) ||
+                    @config.key?(Cop::Badge.parse(cop_name).cop_name)
+
+        message + "\n(obsolete configuration found in " \
+                  "#{smart_loaded_path}, please update it)"
+      end
+    end
+
+    def obsolete_enforced_style
+      OBSOLETE_ENFORCED_STYLES.map do |params|
+        obsolete_enforced_style_message(params[:cop], params[:parameter],
+                                        params[:enforced_style],
+                                        params[:alternative])
+      end
+    end
+
+    def obsolete_enforced_style_message(cop, param, enforced_style, alternative)
+      style = @config[cop]&.detect { |key, _| key.start_with?(param) }
+
+      return unless style && style[1] == enforced_style
+
+      "obsolete `#{param}: #{enforced_style}` (for #{cop}) found in " \
+      "#{smart_loaded_path}\n#{alternative}"
+    end
+
+    def obsolete_parameters
+      OBSOLETE_PARAMETERS.map do |params|
+        obsolete_parameter_message(params[:cops], params[:parameters],
+                                   params[:alternative])
+      end
+    end
+
+    def obsolete_parameter_message(cops, parameters, alternative)
+      Array(cops).map do |cop|
+        obsolete_parameters = Array(parameters).select do |param|
+          @config[cop]&.key?(param)
+        end
+        next if obsolete_parameters.empty?
+
+        obsolete_parameters.map do |parameter|
+          "obsolete parameter #{parameter} (for #{cop}) found in " \
+          "#{smart_loaded_path}\n#{alternative}"
+        end
+      end
+    end
+
+    def smart_loaded_path
+      PathUtil.smart_path(@config.loaded_path)
+    end
+  end
+end

data/lib/rubocop/config_validator.rb

@@ -0,0 +1,248 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module RuboCop
+  # Handles validation of configuration, for example cop names, parameter
+  # names, and Ruby versions.
+  class ConfigValidator
+    extend Forwardable
+
+    COMMON_PARAMS = %w[Exclude Include Severity inherit_mode
+                       AutoCorrect StyleGuide Details].freeze
+    INTERNAL_PARAMS = %w[Description StyleGuide
+                         VersionAdded VersionChanged VersionRemoved
+                         Reference Safe SafeAutoCorrect].freeze
+
+    # 2.3 is the oldest officially supported Ruby version.
+    DEFAULT_RUBY_VERSION = 2.3
+    KNOWN_RUBIES = [2.3, 2.4, 2.5, 2.6, 2.7].freeze
+    OBSOLETE_RUBIES = {
+      1.9 => '0.50', 2.0 => '0.50', 2.1 => '0.58', 2.2 => '0.69'
+    }.freeze
+    RUBY_VERSION_FILENAME = '.ruby-version'
+
+    def_delegators :@config,
+                   :smart_loaded_path, :for_all_cops, :find_file_upwards,
+                   :base_dir_for_path_parameters, :bundler_lock_file_path
+
+    def initialize(config)
+      @config = config
+      @config_obsoletion = ConfigObsoletion.new(config)
+    end
+
+    def validate
+      # Don't validate RuboCop's own files. Avoids infinite recursion.
+      return if @config.internal?
+
+      valid_cop_names, invalid_cop_names = @config.keys.partition do |key|
+        ConfigLoader.default_configuration.key?(key)
+      end
+
+      @config_obsoletion.reject_obsolete_cops_and_parameters
+
+      warn_about_unrecognized_cops(invalid_cop_names)
+      check_target_ruby
+      validate_parameter_names(valid_cop_names)
+      validate_enforced_styles(valid_cop_names)
+      validate_syntax_cop
+      reject_mutually_exclusive_defaults
+    end
+
+    def target_ruby_version
+      @target_ruby_version ||= begin
+        if for_all_cops['TargetRubyVersion']
+          @target_ruby_version_source = :rubocop_yml
+
+          for_all_cops['TargetRubyVersion'].to_f
+        elsif target_ruby_version_from_version_file
+          @target_ruby_version_source = :ruby_version_file
+
+          target_ruby_version_from_version_file
+        elsif target_ruby_version_from_bundler_lock_file
+          @target_ruby_version_source = :bundler_lock_file
+
+          target_ruby_version_from_bundler_lock_file
+        else
+          DEFAULT_RUBY_VERSION
+        end
+      end
+    end
+
+    def validate_section_presence(name)
+      return unless @config.key?(name) && @config[name].nil?
+
+      raise ValidationError,
+            "empty section #{name} found in #{smart_loaded_path}"
+    end
+
+    private
+
+    def check_target_ruby
+      return if KNOWN_RUBIES.include?(target_ruby_version)
+
+      msg = if OBSOLETE_RUBIES.include?(target_ruby_version)
+              "RuboCop found unsupported Ruby version #{target_ruby_version} " \
+              "in #{target_ruby_source}. #{target_ruby_version}-compatible " \
+              'analysis was dropped after version ' \
+              "#{OBSOLETE_RUBIES[target_ruby_version]}."
+            else
+              'RuboCop found unknown Ruby version ' \
+              "#{target_ruby_version.inspect} in #{target_ruby_source}."
+            end
+
+      msg += "\nSupported versions: #{KNOWN_RUBIES.join(', ')}"
+
+      raise ValidationError, msg
+    end
+
+    def warn_about_unrecognized_cops(invalid_cop_names)
+      invalid_cop_names.each do |name|
+        # There could be a custom cop with this name. If so, don't warn
+        next if Cop::Cop.registry.contains_cop_matching?([name])
+
+        # Special case for inherit_mode, which is a directive that we keep in
+        # the configuration (even though it's not a cop), because it's easier
+        # to do so than to pass the value around to various methods.
+        next if name == 'inherit_mode'
+
+        warn Rainbow("Warning: unrecognized cop #{name} found in " \
+                     "#{smart_loaded_path}").yellow
+      end
+    end
+
+    def validate_syntax_cop
+      syntax_config = @config['Lint/Syntax']
+      default_config = ConfigLoader.default_configuration['Lint/Syntax']
+
+      return unless syntax_config &&
+                    default_config.merge(syntax_config) != default_config
+
+      raise ValidationError,
+            "configuration for Syntax cop found in #{smart_loaded_path}\n" \
+            'It\'s not possible to disable this cop.'
+    end
+
+    def validate_parameter_names(valid_cop_names)
+      valid_cop_names.each do |name|
+        validate_section_presence(name)
+        each_invalid_parameter(name) do |param, supported_params|
+          # FIXME: Remove .to_s, which works around a JRuby bug:
+          #   https://github.com/jruby/jruby/issues/5935
+          warn Rainbow(<<~MESSAGE).yellow.to_s
+            Warning: #{name} does not support #{param} parameter.
+
+            Supported parameters are:
+
+              - #{supported_params.join("\n  - ")}
+          MESSAGE
+        end
+      end
+    end
+
+    def each_invalid_parameter(cop_name)
+      default_config = ConfigLoader.default_configuration[cop_name]
+
+      @config[cop_name].each_key do |param|
+        next if COMMON_PARAMS.include?(param) || default_config.key?(param)
+
+        supported_params = default_config.keys - INTERNAL_PARAMS
+
+        yield param, supported_params
+      end
+    end
+
+    def validate_enforced_styles(valid_cop_names)
+      valid_cop_names.each do |name|
+        styles = @config[name].select { |key, _| key.start_with?('Enforced') }
+
+        styles.each do |style_name, style|
+          supported_key = RuboCop::Cop::Util.to_supported_styles(style_name)
+          valid = ConfigLoader.default_configuration[name][supported_key]
+
+          next unless valid
+          next if valid.include?(style)
+          next if validate_support_and_has_list(name, style, valid)
+
+          msg = "invalid #{style_name} '#{style}' for #{name} found in " \
+            "#{smart_loaded_path}\n" \
+            "Valid choices are: #{valid.join(', ')}"
+          raise ValidationError, msg
+        end
+      end
+    end
+
+    def validate_support_and_has_list(name, formats, valid)
+      ConfigLoader.default_configuration[name]['AllowMultipleStyles'] &&
+        formats.is_a?(Array) &&
+        formats.all? { |format| valid.include?(format) }
+    end
+
+    def target_ruby_source
+      case @target_ruby_version_source
+      when :ruby_version_file
+        "`#{RUBY_VERSION_FILENAME}`"
+      when :bundler_lock_file
+        "`#{bundler_lock_file_path}`"
+      when :rubocop_yml
+        "`TargetRubyVersion` parameter (in #{smart_loaded_path})"
+      end
+    end
+
+    def ruby_version_file
+      @ruby_version_file ||=
+        find_file_upwards(RUBY_VERSION_FILENAME, base_dir_for_path_parameters)
+    end
+
+    def target_ruby_version_from_version_file
+      file = ruby_version_file
+      return unless file && File.file?(file)
+
+      @target_ruby_version_from_version_file ||=
+        File.read(file).match(/\A(ruby-)?(?<version>\d+\.\d+)/) do |md|
+          md[:version].to_f
+        end
+    end
+
+    def target_ruby_version_from_bundler_lock_file
+      @target_ruby_version_from_bundler_lock_file ||=
+        read_ruby_version_from_bundler_lock_file
+    end
+
+    def read_ruby_version_from_bundler_lock_file
+      lock_file_path = bundler_lock_file_path
+      return nil unless lock_file_path
+
+      in_ruby_section = false
+      File.foreach(lock_file_path) do |line|
+        # If ruby is in Gemfile.lock or gems.lock, there should be two lines
+        # towards the bottom of the file that look like:
+        #     RUBY VERSION
+        #       ruby W.X.YpZ
+        # We ultimately want to match the "ruby W.X.Y.pZ" line, but there's
+        # extra logic to make sure we only start looking once we've seen the
+        # "RUBY VERSION" line.
+        in_ruby_section ||= line.match(/^\s*RUBY\s*VERSION\s*$/)
+        next unless in_ruby_section
+
+        # We currently only allow this feature to work with MRI ruby. If jruby
+        # (or something else) is used by the project, it's lock file will have a
+        # line that looks like:
+        #     RUBY VERSION
+        #       ruby W.X.YpZ (jruby x.x.x.x)
+        # The regex won't match in this situation.
+        result = line.match(/^\s*ruby\s+(\d+\.\d+)[p.\d]*\s*$/)
+        return result.captures.first.to_f if result
+      end
+    end
+
+    def reject_mutually_exclusive_defaults
+      disabled_by_default = for_all_cops['DisabledByDefault']
+      enabled_by_default = for_all_cops['EnabledByDefault']
+      return unless disabled_by_default && enabled_by_default
+
+      msg = 'Cops cannot be both enabled by default and disabled by default'
+      raise ValidationError, msg
+    end
+  end
+end