rubocop 1.79.2 → 1.88.0

data/config/obsoletion.yml

@@ -145,6 +145,10 @@ changed_parameters:
   - cops: Layout/CaseIndentation
     parameters: IndentWhenRelativeTo
     alternative: EnforcedStyle
+  - cops: Layout/LineLength
+    parameters: IgnoreCopDirectives
+    alternative: AllowCopDirectives
+    severity: warning
   - cops:
       - Lint/BlockAlignment
       - Layout/BlockAlignment
@@ -167,7 +171,7 @@ changed_parameters:
     reason: "`SafeMode` has been removed. Use `SafeAutoCorrect` instead."
   - cops: Bundler/GemComment
     parameters: Whitelist
-    alternative: IgnoredGems
+    alternative: AllowedGems
   - cops:
       - Lint/SafeNavigationChain
       - Lint/SafeNavigationConsistency
@@ -234,6 +238,26 @@ changed_parameters:
     reason: "`AllowOnlyRestArgument` has no effect with TargetRubyVersion >= 3.2."
     severity: warning
     minimum_ruby_version: 3.2
+  - cops: Bundler/GemComment
+    parameters: IgnoredGems
+    alternative: AllowedGems
+    severity: warning
+  - cops: Lint/NumberConversion
+    parameters: IgnoredClasses
+    alternative: AllowedClasses
+    severity: warning
+  - cops: Lint/MissingCopEnableDirective
+    parameters: MaximumRangeSize
+    alternative: MaxRangeSize
+    severity: warning
+  - cops: Metrics/CollectionLiteralLength
+    parameters: LengthThreshold
+    alternative: Max
+    severity: warning
+  - cops: Style/FetchEnvVar
+    parameters: AllowedVars
+    alternative: AllowedVariables
+    severity: warning
 
 # Enforced styles that have been removed or replaced
 changed_enforced_styles:
@@ -241,3 +265,8 @@ changed_enforced_styles:
     parameters: EnforcedStyle
     value: rails
     alternative: indented_internal_methods
+  - cops: Style/EmptyClassDefinition
+    parameters: EnforcedStyle
+    value: class_definition
+    alternative: class_keyword
+    severity: warning

data/exe/rubocop

@@ -12,13 +12,6 @@ if RuboCop::Server.running?
   exit_status = RuboCop::Server::ClientCommand::Exec.new.run
 else
   require 'rubocop'
-
-  cli = RuboCop::CLI.new
-
-  time_start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-  exit_status = cli.run
-  elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - time_start
-
-  puts "Finished in #{elapsed_time} seconds" if cli.options[:debug] || cli.options[:display_time]
+  exit_status = RuboCop::CLI.new.run
 end
 exit exit_status

data/lib/rubocop/cache_config.rb

@@ -25,5 +25,34 @@ module RuboCop
 
       File.join(root, 'rubocop_cache')
     end
+
+    # Lightweight cache root computation that reads CacheRootDirectory from
+    # the toplevel config file and environment variables without going through
+    # the full ConfigStore/ConfigLoader. This method can be used, for example,
+    # before loading configuration files. Please note that this method doesn't
+    # take into account any `inherit_from` dependencies.
+    def self.root_dir_from_toplevel_config(cache_root_override = nil)
+      root_dir do
+        next cache_root_override if cache_root_override
+
+        config_path = ConfigFinder.find_config_path(PathUtil.pwd)
+        file_contents = File.read(config_path)
+
+        # Returns early if `CacheRootDirectory` is not used before requiring `erb` or `yaml`.
+        next unless file_contents.include?('CacheRootDirectory')
+
+        require 'erb'
+        require 'yaml'
+        yaml_code = ERB.new(file_contents).result
+        config_yaml = YAML.safe_load(yaml_code, permitted_classes: [Regexp, Symbol], aliases: true)
+
+        # For compatibility with Ruby 3.0 or lower.
+        if Gem::Version.new(Psych::VERSION) < Gem::Version.new('4.0.0')
+          config_yaml == false ? nil : config_yaml
+        end
+
+        config_yaml&.dig('AllCops', 'CacheRootDirectory')
+      end
+    end
   end
 end

data/lib/rubocop/cli/command/auto_generate_config.rb

@@ -24,13 +24,45 @@ module RuboCop
 
         def run
           add_formatter
+          use_temporary_cache
+          reset_auto_gen_tmp_dir
           reset_config_and_auto_gen_file
           line_length_contents = maybe_run_line_length_cop
-          run_all_cops(line_length_contents)
+          result = run_all_cops(line_length_contents)
+          reset_auto_gen_tmp_dir
+          result
+        ensure
+          # `auto_gen_tmp_dir` points `ExcludeLimit.tmp_dir` at this command's
+          # tmp directory. Clear that process-global state on the way out so
+          # later in-process callers (e.g. other specs in the same test worker)
+          # don't read this run's leftover directory.
+          RuboCop::ExcludeLimit.tmp_dir = nil
         end
 
         private
 
+        def use_temporary_cache
+          # Use a separate cache directory to ensure MinDigits and Max values are calculated.
+          # This allows parallel execution (which requires cache) while ensuring MinDigits
+          # and Max values are computed, since the cache starts empty.
+          @options[:cache_root] = auto_gen_tmp_dir.join('cache').to_s
+        end
+
+        def reset_auto_gen_tmp_dir
+          auto_gen_tmp_dir.rmtree if auto_gen_tmp_dir.exist?
+          auto_gen_tmp_dir.mkpath
+        end
+
+        def auto_gen_tmp_dir
+          @auto_gen_tmp_dir ||= Pathname.new(
+            RuboCop::CacheConfig.root_dir_from_toplevel_config
+          ).join('auto-gen-tmp').tap do |path|
+            path.mkpath
+            # Set the temp directory path for ExcludeLimit to use
+            RuboCop::ExcludeLimit.tmp_dir = path
+          end
+        end
+
         def maybe_run_line_length_cop
           if only_exclude?
             skip_line_length_cop(PHASE_1_SKIPPED_ONLY_EXCLUDE)
@@ -83,7 +115,7 @@ module RuboCop
           execute_runner
           @options.delete(:only)
           @config_store = ConfigStore.new
-          @config_store.options_config = @options[:config] if @options[:config]
+          @config_store.apply_options!(@options)
           # Save the todo configuration of the LineLength cop.
           File.read(AUTO_GENERATED_FILE).lines.drop_while { |line| line.start_with?('#') }.join
         end
@@ -99,7 +131,7 @@ module RuboCop
 
         def reset_config_and_auto_gen_file
           @config_store = ConfigStore.new
-          @config_store.options_config = @options[:config] if @options[:config]
+          @config_store.apply_options!(@options)
           File.open(AUTO_GENERATED_FILE, 'w') {} # create or truncate if exists
           add_inheritance_from_auto_generated_file(@options[:config])
         end
@@ -153,7 +185,7 @@ module RuboCop
         def relative_path_to_todo_from_options_config
           return AUTO_GENERATED_FILE unless @options[:config]
 
-          base = Pathname.new(Dir.pwd)
+          base = Pathname.new(PathUtil.pwd)
           config_dir = Pathname.new(@options[:config]).realpath.dirname
 
           # Don't have the path start with `/`

data/lib/rubocop/cli/command/list_enabled_cops_for.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Lists the cops that will inspect the given file or directory.
+      # @api private
+      class ListEnabledCopsFor < Base
+        self.command_name = :list_enabled_cops_for
+
+        def initialize(env)
+          super
+
+          # Load the configs so the require()s are done for custom cops
+          @config = @config_store.for(@options[:list_enabled_cops_for])
+        end
+
+        def run
+          print_available_cops
+        end
+
+        private
+
+        def print_available_cops
+          registry = Cop::Registry.global
+
+          registry.departments.sort.each do |department|
+            puts cops_of_department(registry, department).sort
+          end
+        end
+
+        def cops_of_department(registry, department)
+          registry.with_department(department)
+                  .map(&:cop_name)
+                  .select { |cop_name| @config.cop_enabled?(cop_name) }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli/command/lsp.rb

@@ -9,7 +9,7 @@ module RuboCop
         self.command_name = :lsp
 
         def run
-          # Load on demand, `languge-server-protocol` is heavy to require.
+          # Load on demand, `language-server-protocol` is heavy to require.
           require_relative '../../lsp/server'
           RuboCop::LSP::Server.new(@config_store).start
         end

data/lib/rubocop/cli/command/mcp.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Start Model Context Protocol of RuboCop.
+      # @api private
+      class MCP < Base
+        self.command_name = :mcp
+
+        def run
+          require_relative '../../mcp/server'
+
+          RuboCop::MCP::Server.new(@config_store).start
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli/command/show_cops.rb

@@ -25,7 +25,7 @@ module RuboCop
           super
 
           # Load the configs so the require()s are done for custom cops
-          @config = @config_store.for(Dir.pwd)
+          @config = @config_store.for(PathUtil.pwd)
 
           @cop_matchers = @options[:show_cops].map do |pattern|
             if pattern.include?('*')
@@ -46,7 +46,7 @@ module RuboCop
           registry = Cop::Registry.global
           show_all = @cop_matchers.empty?
 
-          puts "# Available cops (#{registry.length}) + config for #{Dir.pwd}: " if show_all
+          puts "# Available cops (#{registry.length}) + config for #{PathUtil.pwd}: " if show_all
 
           registry.departments.sort!.each do |department|
             print_cops_of_department(registry, department, show_all)

data/lib/rubocop/cli/command/show_docs_url.rb

@@ -12,7 +12,7 @@ module RuboCop
         def initialize(env)
           super
 
-          @config = @config_store.for(Dir.pwd)
+          @config = @config_store.for(PathUtil.pwd)
         end
 
         def run
@@ -25,10 +25,10 @@ module RuboCop
           puts Cop::Documentation.default_base_url if cops_array.empty?
 
           cops_array.each do |cop_name|
-            cop = registry_hash[cop_name]
-            next if cop.empty?
+            cop = Cop::Registry.global.find_by_cop_name(cop_name)
+            next unless cop
 
-            url = Cop::Documentation.url_for(cop.first, @config)
+            url = Cop::Documentation.url_for(cop, @config)
             puts url if url
           end
 
@@ -38,10 +38,6 @@ module RuboCop
         def cops_array
           @cops_array ||= @options[:show_docs_url]
         end
-
-        def registry_hash
-          @registry_hash ||= Cop::Registry.global.to_h
-        end
       end
     end
   end

data/lib/rubocop/cli/command/suggest_extensions.rb

@@ -60,7 +60,7 @@ module RuboCop
         def print_opt_out_instruction
           puts
           puts 'You can opt out of this message by adding the following to your config ' \
-               '(see https://docs.rubocop.org/rubocop/extensions.html#extension-suggestions ' \
+               '(see https://docs.rubocop.org/rubocop/plugins.html#plugin-suggestions ' \
                'for more options):'
           puts '  AllCops:'
           puts '    SuggestExtensions: false'

data/lib/rubocop/cli.rb

@@ -13,7 +13,7 @@ module RuboCop
     DEFAULT_PARALLEL_OPTIONS = %i[
       color config debug display_style_guide display_time display_only_fail_level_offenses
       display_only_failed editor_mode except extra_details fail_level fix_layout format formatters
-      ignore_disable_comments lint only only_guide_cops require safe
+      ignore_disable_comments lint only only_guide_cops out require safe
       autocorrect safe_autocorrect autocorrect_all
     ].freeze
 
@@ -37,6 +37,8 @@ module RuboCop
     #
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def run(args = ARGV)
+      time_start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
       @options, paths = Options.new.parse(args)
       @env = Environment.new(@options, @config_store, paths)
 
@@ -64,7 +66,7 @@ module RuboCop
       STATUS_INTERRUPTED
     rescue Finished
       STATUS_SUCCESS
-    rescue OptionParser::InvalidOption => e
+    rescue OptionParser::ParseError => e
       warn e.message
       warn 'For usage information, use --help'
       STATUS_ERROR
@@ -72,6 +74,11 @@ module RuboCop
       warn e.message
       warn e.backtrace
       STATUS_ERROR
+    ensure
+      elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - time_start
+      if @options[:debug] || @options[:display_time]
+        puts "Finished in #{elapsed_time.round(5)} seconds"
+      end
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
@@ -159,8 +166,11 @@ module RuboCop
       set_options_to_pending_cops_reporter
       handle_editor_mode
 
-      @config_store.options_config = @options[:config] if @options[:config]
-      @config_store.force_default_config! if @options[:force_default_config]
+      @config_store.apply_options!(@options)
+      # Set cache root after apply_options! to ensure force_default_config is applied first.
+      early_cache_root = ConfigLoader.cache_root(@options[:cache_root])
+      ConfigLoader.cache_root = ResultCache.cache_root(@config_store, @options[:cache_root])
+      warn_if_cache_root_changed(early_cache_root, ConfigLoader.cache_root)
 
       handle_exiting_options
 
@@ -179,6 +189,8 @@ module RuboCop
       ConfigLoader.enable_pending_cops = @options[:enable_pending_cops]
       ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
       ConfigLoader.ignore_unrecognized_cops = @options[:ignore_unrecognized_cops]
+      ConfigLoader.enabled_by_default = @options[:enable_all_cops]
+      ConfigLoader.disabled_by_default = @options[:disable_all_cops]
     end
 
     def set_options_to_pending_cops_reporter
@@ -190,17 +202,15 @@ module RuboCop
       RuboCop::LSP.enable if @options[:editor_mode]
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def handle_exiting_options
       return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }
 
       run_command(:version) if @options[:version] || @options[:verbose_version]
-      run_command(:show_cops) if @options[:show_cops]
-      run_command(:show_docs_url) if @options[:show_docs_url]
-      run_command(:lsp) if @options[:lsp]
+      %i[show_cops list_enabled_cops_for show_docs_url lsp mcp].each do |name|
+        run_command(name) if @options[name]
+      end
       raise Finished
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     def apply_default_formatter
       # This must be done after the options have already been processed,
@@ -219,5 +229,21 @@ module RuboCop
     def report_pending_cops
       PendingCopsReporter.warn_if_needed(@config_store.for_pwd)
     end
+
+    def warn_if_cache_root_changed(early, desired)
+      return if early == desired
+      # Normalize paths to avoid false positives from symlink resolution differences
+      if File.exist?(early) && File.exist?(desired) &&
+         File.realpath(early) == File.realpath(desired)
+        return
+      end
+
+      warn Rainbow(
+        "Warning: Remote configuration cache files were stored in `#{early}` " \
+        "because a desired cache root (`#{desired}`) was not set at the top level. " \
+        'Consider setting `AllCops: CacheRootDirectory` in your toplevel configuration file, ' \
+        'using the `RUBOCOP_CACHE_ROOT` environment variable, or using CLI options.'
+      ).yellow
+    end
   end
 end

data/lib/rubocop/comment_config.rb

@@ -34,6 +34,7 @@ module RuboCop
     def initialize(processed_source)
       @processed_source = processed_source
       @no_directives = !processed_source.raw_source.include?('rubocop')
+      @stack = []
     end
 
     def cop_enabled_at_line?(cop, line_number)
@@ -69,6 +70,7 @@ module RuboCop
     def extra_enabled_comments_with_names(extras:, names:)
       each_directive do |directive|
         next unless comment_only_line?(directive.line_number)
+        next if directive.push? || directive.pop?
 
         if directive.enabled_all?
           handle_enable_all(directive, names, extras)
@@ -93,16 +95,25 @@ module RuboCop
       end
     end
 
-    def analyze # rubocop:todo Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def analyze
       return {} if @no_directives
 
       analyses = Hash.new { |hash, key| hash[key] = CopAnalysis.new([], nil) }
       inject_disabled_cops_directives(analyses)
 
       each_directive do |directive|
-        directive.cop_names.each do |cop_name|
-          cop_name = qualified_cop_name(cop_name)
-          analyses[cop_name] = analyze_cop(analyses[cop_name], directive)
+        if directive.push?
+          restore_point = analyses.transform_values(&:dup)
+          @stack.push(restore_point)
+          apply_push(analyses, resolve_push_cops(directive), directive.line_number)
+        elsif directive.pop?
+          pop_state(analyses, directive.line_number) if @stack.any?
+        else
+          directive.cop_names.each do |cop_name|
+            cop_name = qualified_cop_name(cop_name)
+            analyses[cop_name] = analyze_cop(analyses[cop_name], directive)
+          end
         end
       end
 
@@ -111,6 +122,45 @@ module RuboCop
         hash[cop_name] = cop_line_ranges(analysis)
       end
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+
+    def resolve_push_cops(directive)
+      directive.push_args.transform_values do |names|
+        names.flat_map { |name| expand_cop_name(name) }
+      end
+    end
+
+    def expand_cop_name(name)
+      registry = Cop::Registry.global
+      cops = registry.department?(name) ? registry.names_for_department(name) : [name]
+      cops.map { |c| qualified_cop_name(c) }
+    end
+
+    def apply_push(analyses, resolved_cops, line)
+      resolved_cops.each do |op, cops|
+        cops.each { |cop| apply_cop_op(analyses, op, cop, line) }
+      end
+    end
+
+    def apply_cop_op(analyses, operation, cop, line)
+      analysis = analyses[cop]
+      if operation == '-' && !analysis.start_line_number
+        analyses[cop] = CopAnalysis.new(analysis.line_ranges, line)
+      elsif operation == '+' && analysis.start_line_number
+        analyses[cop] =
+          CopAnalysis.new(analysis.line_ranges + [analysis.start_line_number..line], nil)
+      end
+    end
+
+    def pop_state(analyses, line)
+      restore_point = @stack.pop
+      (restore_point.keys | analyses.keys).each do |cop|
+        current = analyses[cop]
+        new_range = current.start_line_number ? [current.start_line_number..(line - 1)] : []
+        new_start = restore_point[cop]&.start_line_number ? line : nil
+        analyses[cop] = CopAnalysis.new(current.line_ranges + new_range, new_start)
+      end
+    end
 
     def inject_disabled_cops_directives(analyses)
       registry.disabled(config).each do |cop|
@@ -136,29 +186,21 @@ module RuboCop
       return analysis unless directive.disabled?
 
       line = directive.line_number
-      start_line = analysis.start_line_number
-
-      CopAnalysis.new(analysis.line_ranges + [(line..line)], start_line)
+      CopAnalysis.new(analysis.line_ranges + [(line..line)], analysis.start_line_number)
     end
 
     def analyze_disabled(analysis, directive)
       line = directive.line_number
       start_line = analysis.start_line_number
-
-      # Cop already disabled on this line, so we end the current disabled
-      # range before we start a new range.
-      return CopAnalysis.new(analysis.line_ranges + [start_line..line], line) if start_line
-
-      CopAnalysis.new(analysis.line_ranges, line)
+      new_ranges = start_line ? analysis.line_ranges + [start_line..line] : analysis.line_ranges
+      CopAnalysis.new(new_ranges, line)
     end
 
     def analyze_rest(analysis, directive)
       line = directive.line_number
       start_line = analysis.start_line_number
-
-      return CopAnalysis.new(analysis.line_ranges + [start_line..line], nil) if start_line
-
-      CopAnalysis.new(analysis.line_ranges, nil)
+      new_ranges = start_line ? analysis.line_ranges + [start_line..line] : analysis.line_ranges
+      CopAnalysis.new(new_ranges, nil)
     end
 
     def cop_line_ranges(analysis)

data/lib/rubocop/config.rb

@@ -217,6 +217,9 @@ module RuboCop
       for_all_cops['StringLiteralsFrozenByDefault']
     end
 
+    # Returns true if the file matches any include pattern. If a block is given, the block is called
+    # to determine if the pattern is relevant (true returned by the block) or should be skipped
+    # (false returned).
     def file_to_include?(file)
       relative_file_path = path_relative_to_config(file)
 
@@ -228,11 +231,9 @@ module RuboCop
       absolute_file_path = File.expand_path(file)
 
       patterns_to_include.any? do |pattern|
-        if block_given?
-          yield pattern, relative_file_path, absolute_file_path
-        else
-          match_path?(pattern, relative_file_path) || match_path?(pattern, absolute_file_path)
-        end
+        next if block_given? && !yield(pattern)
+
+        match_relative_or_absolute_path?(pattern, relative_file_path, absolute_file_path)
       end
     end
 
@@ -242,10 +243,7 @@ module RuboCop
       # `bundler-console` conveys `Bundler::Console`).
       return true if File.extname(file) == '.gemspec'
 
-      file_to_include?(file) do |pattern, relative_path, absolute_path|
-        /[A-Z]/.match?(pattern.to_s) &&
-          (match_path?(pattern, relative_path) || match_path?(pattern, absolute_path))
-      end
+      file_to_include?(file) { |pattern| /[A-Z]/.match?(pattern.to_s) }
     end
 
     # Returns true if there's a chance that an Include pattern matches hidden
@@ -286,7 +284,7 @@ module RuboCop
            loaded_path != File.join(Dir.home, ConfigLoader::DOTFILE)
           File.expand_path(File.dirname(loaded_path))
         else
-          Dir.pwd
+          PathUtil.pwd
         end
     end
 
@@ -345,6 +343,12 @@ module RuboCop
 
     private
 
+    def match_relative_or_absolute_path?(pattern, relative_file_path, absolute_file_path)
+      should_use_absolute_path = absolute?(pattern.to_s) || pattern.to_s.start_with?('..') ||
+                                 relative_file_path.start_with?('..')
+      match_path?(pattern, should_use_absolute_path ? absolute_file_path : relative_file_path)
+    end
+
     # @return [Float, nil] The Rails version as a `major.minor` Float.
     def target_rails_version_from_bundler_lock_file
       @target_rails_version_from_bundler_lock_file ||= read_rails_version_from_bundler_lock_file

data/lib/rubocop/config_finder.rb

@@ -30,7 +30,7 @@ module RuboCop
       private
 
       def find_project_root
-        pwd = Dir.pwd
+        pwd = PathUtil.pwd
         gems_file = find_last_file_upwards('Gemfile', pwd) || find_last_file_upwards('gems.rb', pwd)
         return unless gems_file