rubocop 1.19.0 → 1.40.0

data/lib/rubocop/config_loader.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require 'yaml'
+require 'erb'
 require 'pathname'
+require 'yaml'
+require_relative 'config_finder'
 
 module RuboCop
   # Raised when a RuboCop configuration file is not found.
@@ -14,16 +16,16 @@ module RuboCop
   # during a run of the rubocop program, if files in several
   # directories are inspected.
   class ConfigLoader
-    DOTFILE = '.rubocop.yml'
-    XDG_CONFIG = 'config.yml'
+    DOTFILE = ConfigFinder::DOTFILE
     RUBOCOP_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
     DEFAULT_FILE = File.join(RUBOCOP_HOME, 'config', 'default.yml')
 
     class << self
       include FileFinder
 
-      attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops
-      attr_writer :default_configuration, :project_root
+      attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
+                    :ignore_unrecognized_cops
+      attr_writer :default_configuration
       attr_reader :loaded_features
 
       alias debug? debug
@@ -40,18 +42,18 @@ module RuboCop
 
         hash = load_yaml_configuration(path)
 
-        # Resolve requires first in case they define additional cops
         loaded_features = resolver.resolve_requires(path, hash)
         add_loaded_features(loaded_features)
 
-        add_missing_namespaces(path, hash)
-
         resolver.override_department_setting_for_cops({}, hash)
         resolver.resolve_inheritance_from_gems(hash)
         resolver.resolve_inheritance(path, hash, file, debug?)
-
         hash.delete('inherit_from')
 
+        # Adding missing namespaces only after resolving requires & inheritance,
+        # since both can introduce new cops that need to be considered here.
+        add_missing_namespaces(path, hash)
+
         Config.create(hash, path, check: check)
       end
 
@@ -93,14 +95,15 @@ module RuboCop
       # user's home directory is checked. If there's no .rubocop.yml
       # there either, the path to the default file is returned.
       def configuration_file_for(target_dir)
-        find_project_dotfile(target_dir) || find_user_dotfile ||
-          find_user_xdg_config || DEFAULT_FILE
+        ConfigFinder.find_config_path(target_dir)
       end
 
       def configuration_from_file(config_file, check: true)
         return default_configuration if config_file == DEFAULT_FILE
 
         config = load_file(config_file, check: check)
+        config.validate_after_resolution if check
+
         if ignore_parent_exclusion?
           print 'Ignoring AllCops/Exclude from parent folders' if debug?
         else
@@ -118,7 +121,7 @@ module RuboCop
       end
 
       def add_excludes_from_files(config, config_file)
-        exclusion_file = find_last_file_upwards(DOTFILE, config_file, project_root)
+        exclusion_file = find_last_file_upwards(DOTFILE, config_file, ConfigFinder.project_root)
 
         return unless exclusion_file
         return if PathUtil.relative_path(exclusion_file) == PathUtil.relative_path(config_file)
@@ -134,16 +137,22 @@ module RuboCop
         end
       end
 
-      # Returns the path rubocop inferred as the root of the project. No file
+      # Returns the path RuboCop inferred as the root of the project. No file
       # searches will go past this directory.
+      # @deprecated Use `RuboCop::ConfigFinder.project_root` instead.
       def project_root
-        @project_root ||= find_project_root
+        warn Rainbow(<<~WARNING).yellow
+          `RuboCop::ConfigLoader.project_root` is deprecated and will be removed in RuboCop 2.0. \
+          Use `RuboCop::ConfigFinder.project_root` instead.
+        WARNING
+
+        ConfigFinder.project_root
       end
 
       PENDING_BANNER = <<~BANNER
         The following cops were added to RuboCop, but are not configured. Please set Enabled to either `true` or `false` in your `.rubocop.yml` file.
 
-        Please also note that can also opt-in to new cops by default by adding this to your config:
+        Please also note that you can opt-in to new cops by default by adding this to your config:
           AllCops:
             NewCops: enable
       BANNER
@@ -161,7 +170,7 @@ module RuboCop
       def warn_pending_cop(cop)
         version = cop.metadata['VersionAdded'] || 'N/A'
 
-        warn Rainbow("#{cop.name}: # (new in #{version})").yellow
+        warn Rainbow("#{cop.name}: # new in #{version}").yellow
         warn Rainbow('  Enabled: true').yellow
       end
 
@@ -183,39 +192,6 @@ module RuboCop
         File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)
       end
 
-      def find_project_dotfile(target_dir)
-        find_file_upwards(DOTFILE, target_dir, project_root)
-      end
-
-      def find_project_root
-        pwd = Dir.pwd
-        gems_file = find_last_file_upwards('Gemfile', pwd) || find_last_file_upwards('gems.rb', pwd)
-        return unless gems_file
-
-        File.dirname(gems_file)
-      end
-
-      def find_user_dotfile
-        return unless ENV.key?('HOME')
-
-        file = File.join(Dir.home, DOTFILE)
-        return file if File.exist?(file)
-      end
-
-      def find_user_xdg_config
-        xdg_config_home = expand_path(ENV.fetch('XDG_CONFIG_HOME', '~/.config'))
-        xdg_config = File.join(xdg_config_home, 'rubocop', XDG_CONFIG)
-        return xdg_config if File.exist?(xdg_config)
-      end
-
-      def expand_path(path)
-        File.expand_path(path)
-      rescue ArgumentError
-        # Could happen because HOME or ID could not be determined. Fall back on
-        # using the path literally in that case.
-        path
-      end
-
       def resolver
         @resolver ||= ConfigLoaderResolver.new
       end

data/lib/rubocop/config_loader_resolver.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'yaml'
 require 'pathname'
+require 'yaml'
 
 module RuboCop
   # A help class for ConfigLoader that handles configuration resolution.
@@ -11,11 +11,7 @@ module RuboCop
       config_dir = File.dirname(path)
       hash.delete('require').tap do |loaded_features|
         Array(loaded_features).each do |feature|
-          if feature.start_with?('.')
-            require(File.join(config_dir, feature))
-          else
-            require(feature)
-          end
+          FeatureLoader.load(config_directory_path: config_dir, feature: feature)
         end
       end
     end
@@ -74,7 +70,7 @@ module RuboCop
     # Merges the given configuration with the default one. If
     # AllCops:DisabledByDefault is true, it changes the Enabled params so that
     # only cops from user configuration are enabled. If
-    # AllCops::EnabledByDefault is true, it changes the Enabled params so that
+    # AllCops:EnabledByDefault is true, it changes the Enabled params so that
     # only cops explicitly disabled in user configuration are disabled.
     def merge_with_default(config, config_file, unset_nil:)
       default_configuration = ConfigLoader.default_configuration
@@ -179,7 +175,7 @@ module RuboCop
 
     def determine_inherit_mode(hash, key)
       cop_cfg = hash[key]
-      local_inherit = cop_cfg.delete('inherit_mode') if cop_cfg.is_a?(Hash)
+      local_inherit = cop_cfg['inherit_mode'] if cop_cfg.is_a?(Hash)
       local_inherit || hash['inherit_mode'] || {}
     end
 

data/lib/rubocop/config_obsoletion/changed_parameter.rb

@@ -12,6 +12,11 @@ module RuboCop
 
         if alternative
           "#{base}\n`#{parameter}` has been renamed to `#{alternative.chomp}`."
+        elsif alternatives
+          "#{base}\n`#{parameter}` has been renamed to #{to_sentence(alternatives.map do |item|
+                                                                       "`#{item}`"
+                                                                     end,
+                                                                     connector: 'and/or')}."
         else
           "#{base}\n#{reason.chomp}"
         end

data/lib/rubocop/config_obsoletion/extracted_cop.rb

@@ -33,7 +33,9 @@ module RuboCop
         return old_name unless old_name.end_with?('*')
 
         # Handle whole departments (expressed as `Department/*`)
-        config.keys.grep(Regexp.new("^#{department}"))
+        config.keys.select do |key|
+          key == department || key.start_with?("#{department}/")
+        end
       end
 
       def feature_loaded?

data/lib/rubocop/config_obsoletion/parameter_rule.rb

@@ -32,6 +32,10 @@ module RuboCop
         metadata['alternative']
       end
 
+      def alternatives
+        metadata['alternatives']
+      end
+
       def reason
         metadata['reason']
       end

data/lib/rubocop/config_obsoletion.rb

@@ -47,10 +47,15 @@ module RuboCop
 
     # Default rules for obsoletions are in config/obsoletion.yml
     # Additional rules files can be added with `RuboCop::ConfigObsoletion.files << filename`
-    def load_rules
+    def load_rules # rubocop:disable Metrics/AbcSize
       rules = self.class.files.each_with_object({}) do |filename, hash|
         hash.merge!(YAML.safe_load(File.read(filename))) do |_key, first, second|
-          first.merge(second)
+          case first
+          when Hash
+            first.merge(second)
+          when Array
+            first.concat(second)
+          end
         end
       end
 

data/lib/rubocop/config_validator.rb

@@ -44,7 +44,6 @@ module RuboCop
       check_obsoletions
 
       alert_about_unrecognized_cops(invalid_cop_names)
-      check_target_ruby
       validate_new_cops_parameter
       validate_parameter_names(valid_cop_names)
       validate_enforced_styles(valid_cop_names)
@@ -52,6 +51,15 @@ module RuboCop
       reject_mutually_exclusive_defaults
     end
 
+    # Validations that should only be run after all config resolving has
+    # taken place:
+    # * The target ruby version is only checked once the entire inheritance
+    # chain has been loaded so that only the final value is validated, and
+    # any obsolete but overridden values are ignored.
+    def validate_after_resolution
+      check_target_ruby
+    end
+
     def target_ruby_version
       target_ruby.version
     end
@@ -94,6 +102,22 @@ module RuboCop
     end
 
     def alert_about_unrecognized_cops(invalid_cop_names)
+      unknown_cops = list_unknown_cops(invalid_cop_names)
+
+      return if unknown_cops.empty?
+
+      if ConfigLoader.ignore_unrecognized_cops
+        warn Rainbow('The following cops or departments are not ' \
+                     'recognized and will be ignored:').yellow
+        warn unknown_cops.join("\n")
+
+        return
+      end
+
+      raise ValidationError, unknown_cops.join("\n")
+    end
+
+    def list_unknown_cops(invalid_cop_names)
       unknown_cops = []
       invalid_cop_names.each do |name|
         # There could be a custom cop with this name. If so, don't warn
@@ -111,7 +135,8 @@ module RuboCop
 
         unknown_cops << message
       end
-      raise ValidationError, unknown_cops.join("\n") if unknown_cops.any?
+
+      unknown_cops
     end
 
     def suggestion(name)
@@ -219,7 +244,7 @@ module RuboCop
         next unless cop_config.is_a?(Hash)
         next unless cop_config['Safe'] == false && cop_config['SafeAutoCorrect'] == true
 
-        msg = 'Unsafe cops cannot have a safe auto-correction ' \
+        msg = 'Unsafe cops cannot have a safe autocorrection ' \
               "(section #{name} in #{smart_loaded_path})"
         raise ValidationError, msg
       end
@@ -240,8 +265,8 @@ module RuboCop
     # FIXME: Handling colors in exception messages like this is ugly.
     def msg_not_boolean(parent, key, value)
       "#{Rainbow('').reset}" \
-        "Property #{Rainbow(key).yellow} of cop #{Rainbow(parent).yellow}" \
-        " is supposed to be a boolean and #{Rainbow(value).yellow} is not."
+        "Property #{Rainbow(key).yellow} of cop #{Rainbow(parent).yellow} " \
+        "is supposed to be a boolean and #{Rainbow(value).yellow} is not."
     end
   end
 end

data/lib/rubocop/cop/autocorrect_logic.rb

@@ -8,8 +8,12 @@ module RuboCop
         autocorrect_requested? && correctable? && autocorrect_enabled?
       end
 
+      def autocorrect_with_disable_uncorrectable?
+        autocorrect_requested? && disable_uncorrectable? && autocorrect_enabled?
+      end
+
       def autocorrect_requested?
-        @options.fetch(:auto_correct, false)
+        @options.fetch(:autocorrect, false)
       end
 
       def correctable?
@@ -30,7 +34,9 @@ module RuboCop
 
         return false if cop_config['AutoCorrect'] == false
 
-        return safe_autocorrect? if @options.fetch(:safe_auto_correct, false)
+        # :safe_autocorrect is a derived option based on several command-line
+        # arguments - see Rubocop::Options#add_autocorrection_options
+        return safe_autocorrect? if @options.fetch(:safe_autocorrect, false)
 
         true
       end

data/lib/rubocop/cop/badge.rb

@@ -15,11 +15,17 @@ module RuboCop
       def self.for(class_name)
         parts = class_name.split('::')
         name_deep_enough = parts.length >= 4
-        new(name_deep_enough ? parts[2..-1] : parts.last(2))
+        new(name_deep_enough ? parts[2..] : parts.last(2))
       end
 
       def self.parse(identifier)
-        new(identifier.split('/'))
+        new(identifier.split('/').map { |i| camel_case(i) })
+      end
+
+      def self.camel_case(name_part)
+        return 'RSpec' if name_part == 'rspec'
+
+        name_part.gsub(/^\w|_\w/) { |match| match[-1, 1].upcase }
       end
 
       def initialize(class_name_parts)

data/lib/rubocop/cop/base.rb

@@ -24,7 +24,7 @@ module RuboCop
     # `add_global_offense`. Use the `processed_source` method to
     # get the currently processed source being investigated.
     #
-    # In case of invalid syntax / unparseable content,
+    # In case of invalid syntax / unparsable content,
     # the callback `on_other_file` is called instead of all the other
     # `on_...` callbacks.
     #
@@ -48,7 +48,7 @@ module RuboCop
       InvestigationReport = Struct.new(:cop, :processed_source, :offenses, :corrector)
 
       # List of methods names to restrict calls for `on_send` / `on_csend`
-      RESTRICT_ON_SEND = Set[].freeze
+      RESTRICT_ON_SEND = Set[].freeze # rubocop:disable InternalAffairs/UselessRestrictOnSend
 
       # List of cops that should not try to autocorrect at the same
       # time as this cop
@@ -158,7 +158,7 @@ module RuboCop
         Registry.global.dismiss(self)
       end
 
-      # Returns if class supports auto_correct.
+      # Returns if class supports autocorrect.
       # It is recommended to extend AutoCorrector instead of overriding
       def self.support_autocorrect?
         false
@@ -220,10 +220,14 @@ module RuboCop
         @config.target_rails_version
       end
 
+      def active_support_extensions_enabled?
+        @config.active_support_extensions_enabled?
+      end
+
       def relevant_file?(file)
         file == RuboCop::AST::ProcessedSource::STRING_SOURCE_NAME ||
-          file_name_matches_any?(file, 'Include', true) &&
-            !file_name_matches_any?(file, 'Exclude', false)
+          (file_name_matches_any?(file, 'Include', true) &&
+            !file_name_matches_any?(file, 'Exclude', false))
       end
 
       def excluded_file?(file)
@@ -408,15 +412,8 @@ module RuboCop
         patterns = cop_config[parameter]
         return default_result unless patterns
 
-        path = nil
-        patterns.any? do |pattern|
-          # Try to match the absolute path, as Exclude properties are absolute.
-          next true if match_path?(pattern, file)
-
-          # Try with relative path.
-          path ||= config.path_relative_to_config(file)
-          match_path?(pattern, path)
-        end
+        patterns = OptimizedPatterns.from(patterns)
+        patterns.match?(config.path_relative_to_config(file)) || patterns.match?(file)
       end
 
       def enabled_line?(line_number)

data/lib/rubocop/cop/bundler/duplicated_gem.rb

@@ -38,19 +38,15 @@ module RuboCop
       class DuplicatedGem < Base
         include RangeHelp
 
-        MSG = 'Gem `%<gem_name>s` requirements already given on line '\
+        MSG = 'Gem `%<gem_name>s` requirements already given on line ' \
               '%<line_of_first_occurrence>d of the Gemfile.'
 
         def on_new_investigation
           return if processed_source.blank?
 
           duplicated_gem_nodes.each do |nodes|
-            nodes[1..-1].each do |node|
-              register_offense(
-                node,
-                node.first_argument.to_a.first,
-                nodes.first.first_line
-              )
+            nodes[1..].each do |node|
+              register_offense(node, node.first_argument.to_a.first, nodes.first.first_line)
             end
           end
         end
@@ -68,7 +64,7 @@ module RuboCop
         end
 
         def conditional_declaration?(nodes)
-          parent = nodes[0].parent
+          parent = nodes[0].each_ancestor.find { |ancestor| !ancestor.begin_type? }
           return false unless parent&.if_type? || parent&.when_type?
 
           root_conditional_node = parent.if_type? ? parent : parent.parent

data/lib/rubocop/cop/bundler/gem_comment.rb

@@ -88,7 +88,7 @@ module RuboCop
         CHECKED_OPTIONS_CONFIG = 'OnlyFor'
         VERSION_SPECIFIERS_OPTION = 'version_specifiers'
         RESTRICTIVE_VERSION_SPECIFIERS_OPTION = 'restrictive_version_specifiers'
-        RESTRICTIVE_VERSION_PATTERN = /<|~>/.freeze
+        RESTRICTIVE_VERSION_PATTERN = /\A\s*(?:<|~>|\d|=)/.freeze
         RESTRICT_ON_SEND = %i[gem].freeze
 
         def on_send(node)
@@ -152,8 +152,8 @@ module RuboCop
         def restrictive_version_specified_gem?(node)
           return unless version_specified_gem?(node)
 
-          node.arguments
-              .any? { |arg| arg&.str_type? && RESTRICTIVE_VERSION_PATTERN.match?(arg.to_s) }
+          node.arguments[1..]
+              .any? { |arg| arg&.str_type? && RESTRICTIVE_VERSION_PATTERN.match?(arg.value) }
         end
 
         def contains_checked_options?(node)

data/lib/rubocop/cop/bundler/gem_filename.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Bundler
+      # Verifies that a project contains Gemfile or gems.rb file and correct
+      # associated lock file based on the configuration.
+      #
+      # @example EnforcedStyle: Gemfile (default)
+      #   # bad
+      #   Project contains gems.rb and gems.locked files
+      #
+      #   # bad
+      #   Project contains Gemfile and gems.locked file
+      #
+      #   # good
+      #   Project contains Gemfile and Gemfile.lock
+      #
+      # @example EnforcedStyle: gems.rb
+      #   # bad
+      #   Project contains Gemfile and Gemfile.lock files
+      #
+      #   # bad
+      #   Project contains gems.rb and Gemfile.lock file
+      #
+      #   # good
+      #   Project contains gems.rb and gems.locked files
+      class GemFilename < Base
+        include ConfigurableEnforcedStyle
+        include RangeHelp
+
+        MSG_GEMFILE_REQUIRED = '`gems.rb` file was found but `Gemfile` is required ' \
+                               '(file path: %<file_path>s).'
+        MSG_GEMS_RB_REQUIRED = '`Gemfile` was found but `gems.rb` file is required ' \
+                               '(file path: %<file_path>s).'
+        MSG_GEMFILE_MISMATCHED = 'Expected a `Gemfile.lock` with `Gemfile` but found ' \
+                                 '`gems.locked` file (file path: %<file_path>s).'
+        MSG_GEMS_RB_MISMATCHED = 'Expected a `gems.locked` file with `gems.rb` but found ' \
+                                 '`Gemfile.lock` (file path: %<file_path>s).'
+        GEMFILE_FILES = %w[Gemfile Gemfile.lock].freeze
+        GEMS_RB_FILES = %w[gems.rb gems.locked].freeze
+
+        def on_new_investigation
+          file_path = processed_source.file_path
+          basename = File.basename(file_path)
+          return if expected_gemfile?(basename)
+
+          register_offense(file_path, basename)
+        end
+
+        private
+
+        def register_offense(file_path, basename)
+          register_gemfile_offense(file_path, basename) if gemfile_offense?(basename)
+          register_gems_rb_offense(file_path, basename) if gems_rb_offense?(basename)
+        end
+
+        def register_gemfile_offense(file_path, basename)
+          message = case basename
+                    when 'gems.rb'
+                      MSG_GEMFILE_REQUIRED
+                    when 'gems.locked'
+                      MSG_GEMFILE_MISMATCHED
+                    end
+
+          add_global_offense(format(message, file_path: file_path))
+        end
+
+        def register_gems_rb_offense(file_path, basename)
+          message = case basename
+                    when 'Gemfile'
+                      MSG_GEMS_RB_REQUIRED
+                    when 'Gemfile.lock'
+                      MSG_GEMS_RB_MISMATCHED
+                    end
+
+          add_global_offense(format(message, file_path: file_path))
+        end
+
+        def gemfile_offense?(basename)
+          gemfile_required? && GEMS_RB_FILES.include?(basename)
+        end
+
+        def gems_rb_offense?(basename)
+          gems_rb_required? && GEMFILE_FILES.include?(basename)
+        end
+
+        def expected_gemfile?(basename)
+          (gemfile_required? && GEMFILE_FILES.include?(basename)) ||
+            (gems_rb_required? && GEMS_RB_FILES.include?(basename))
+        end
+
+        def gemfile_required?
+          style == :Gemfile
+        end
+
+        def gems_rb_required?
+          style == :'gems.rb'
+        end
+      end
+    end
+  end
+end