rubocop 1.53.0 → 1.90.0

data/config/internal_affairs.yml

@@ -0,0 +1,31 @@
+# Configuration for InternalAffairs cops. This file will be
+# automatically loaded when `rubocop/cop/internal_affairs` is required.
+# Only do this when developing custom cops or a RuboCop extension.
+
+InternalAffairs/CopDescription:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/ExampleHeredocDelimiter:
+  Include:
+    - 'spec/rubocop/cop/**/*.rb'
+
+InternalAffairs/ExampleDescription:
+  Include:
+    - 'spec/rubocop/cop/**/*.rb'
+
+InternalAffairs/NodeTypeGroup:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/OnSendWithoutOnCSend:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/UndefinedConfig:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/UselessMessageAssertion:
+  Include:
+    - '**/*_spec.rb'

data/config/obsoletion.yml

@@ -31,6 +31,9 @@ renamed:
   Lint/UnneededRequireStatement: Lint/RedundantRequireStatement
   Lint/UnneededSplatExpansion: Lint/RedundantSplatExpansion
   Metrics/LineLength: Layout/LineLength
+  Naming/PredicateName:
+    new_name: Naming/PredicatePrefix
+    severity: warning
   Naming/UncommunicativeBlockParamName: Naming/BlockParameterName
   Naming/UncommunicativeMethodParamName: Naming/MethodParameterName
   Style/AccessorMethodName: Naming/AccessorMethodName
@@ -43,7 +46,9 @@ renamed:
   Style/MethodCallParentheses: Style/MethodCallWithoutArgsParentheses
   Style/MethodName: Naming/MethodName
   Style/OpMethod: Naming/BinaryOperatorParameterName
-  Style/PredicateName: Naming/PredicateName
+  Style/PredicateName:
+    new_name: Naming/PredicatePrefix
+    severity: warning
   Style/SingleSpaceBeforeFirstArg: Layout/SpaceBeforeFirstArg
   Style/UnneededCapitalW: Style/RedundantCapitalW
   Style/UnneededCondition: Style/RedundantCondition
@@ -140,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
@@ -162,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
@@ -177,10 +186,10 @@ changed_parameters:
   - cops: Naming/HeredocDelimiterNaming
     parameters: Blacklist
     alternative: ForbiddenDelimiters
-  - cops: Naming/PredicateName
+  - cops: Naming/PredicatePrefix
     parameters: NamePrefixBlacklist
     alternative: ForbiddenPrefixes
-  - cops: Naming/PredicateName
+  - cops: Naming/PredicatePrefix
     parameters: NameWhitelist
     alternative: AllowedMethods
   - cops:
@@ -224,6 +233,31 @@ changed_parameters:
       - AllowedMethods
       - AllowedPatterns
     severity: warning
+  - cops: Style/ArgumentsForwarding
+    parameters: AllowOnlyRestArgument
+    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:
@@ -231,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

@@ -8,16 +8,10 @@ server_cli = RuboCop::Server::CLI.new
 exit_status = server_cli.run
 exit exit_status if server_cli.exit?
 
-if RuboCop::Server.running?
+if RuboCop::Server.forward_to_server?
   exit_status = RuboCop::Server::ClientCommand::Exec.new.run
 else
-  require 'benchmark'
   require 'rubocop'
-
-  cli = RuboCop::CLI.new
-
-  time = Benchmark.realtime { exit_status = cli.run }
-
-  puts "Finished in #{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/cached_data.rb

@@ -22,7 +22,7 @@ module RuboCop
 
     def serialize_offense(offense)
       status = :uncorrected if %i[corrected corrected_with_todo].include?(offense.status)
-      {
+      hash = {
         # Calling #to_s here ensures that the serialization works when using
         # other json serializers such as Oj. Some of these gems do not call
         # #to_s implicitly.
@@ -35,6 +35,10 @@ module RuboCop
         cop_name: offense.cop_name,
         status:   status || offense.status
       }
+      # Only offenses suppressed by a directive can carry one, so keep the key out of the
+      # common case rather than writing a null for every cached offense.
+      hash[:justification] = offense.justification if offense.justification
+      hash
     end
 
     def message(offense)
@@ -45,13 +49,30 @@ module RuboCop
 
     # Restore an offense object loaded from a JSON file.
     def deserialize_offenses(offenses)
-      source_buffer = Parser::Source::Buffer.new(@filename)
-      source_buffer.source = File.read(@filename, encoding: Encoding::UTF_8)
       offenses.map! do |o|
-        location = Parser::Source::Range.new(source_buffer,
-                                             o['location']['begin_pos'],
-                                             o['location']['end_pos'])
-        Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym)
+        location = location_from_source_buffer(o)
+        Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym,
+                         justification: o['justification'])
+      end
+    end
+
+    def location_from_source_buffer(offense)
+      begin_pos = offense['location']['begin_pos']
+      end_pos = offense['location']['end_pos']
+      if begin_pos.zero? && end_pos.zero?
+        Cop::Offense::NO_LOCATION
+      else
+        Parser::Source::Range.new(source_buffer, begin_pos, end_pos)
+      end
+    end
+
+    # Delay creation until needed. Some type of offenses will have no buffer associated with them
+    # and be global only. For these, trying to create the buffer will likely fail, for example
+    # because of unknown encoding comments.
+    def source_buffer
+      @source_buffer ||= begin
+        source = File.read(@filename, encoding: Encoding::UTF_8)
+        Parser::Source::Buffer.new(@filename, source: source)
       end
     end
   end

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

@@ -10,30 +10,68 @@ module RuboCop
 
         AUTO_GENERATED_FILE = '.rubocop_todo.yml'
         YAML_OPTIONAL_DOC_START = /\A---(\s+#|\s*\z)/.freeze
+        PLACEHOLDER = '###rubocop:inherit_here'
 
         PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
         PHASE_2 = 'Phase 2 of 2: run all cops'
 
         PHASE_1_OVERRIDDEN = '(skipped because the default Layout/LineLength:Max is overridden)'
         PHASE_1_DISABLED = '(skipped because Layout/LineLength is disabled)'
-        PHASE_1_SKIPPED = '(skipped because a list of cops is passed to the `--only` flag)'
+        PHASE_1_SKIPPED_ONLY_COPS =
+          '(skipped because a list of cops is passed to the `--only` flag)'
+        PHASE_1_SKIPPED_ONLY_EXCLUDE =
+          '(skipped because only excludes will be generated due to `--auto-gen-only-exclude` flag)'
 
         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 !line_length_enabled?(@config_store.for_pwd)
+          if only_exclude?
+            skip_line_length_cop(PHASE_1_SKIPPED_ONLY_EXCLUDE)
+          elsif !line_length_enabled?(@config_store.for_pwd)
             skip_line_length_cop(PHASE_1_DISABLED)
           elsif !same_max_line_length?(@config_store.for_pwd, ConfigLoader.default_configuration)
             skip_line_length_cop(PHASE_1_OVERRIDDEN)
           elsif options_has_only_flag?
-            skip_line_length_cop(PHASE_1_SKIPPED)
+            skip_line_length_cop(PHASE_1_SKIPPED_ONLY_COPS)
           else
             run_line_length_cop
           end
@@ -64,6 +102,10 @@ module RuboCop
           @options[:only]
         end
 
+        def only_exclude?
+          @options[:auto_gen_only_exclude]
+        end
+
         # Do an initial run with only Layout/LineLength so that cops that
         # depend on Layout/LineLength:Max get the correct value for that
         # parameter.
@@ -73,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
@@ -89,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
@@ -125,28 +167,31 @@ module RuboCop
 
         def existing_configuration(config_file)
           File.read(config_file, encoding: Encoding::UTF_8)
-              .sub(/^inherit_from: *[^\n]+/, '')
-              .sub(/^inherit_from: *(\n *- *[^\n]+)+/, '')
+              .sub(/^inherit_from: *[^\n]+/, PLACEHOLDER)
+              .sub(/^inherit_from: *(\n *- *[^\n]+)+/, PLACEHOLDER)
         end
 
         def write_config_file(file_name, file_string, rubocop_yml_contents)
           lines = /\S/.match?(rubocop_yml_contents) ? rubocop_yml_contents.split("\n", -1) : []
-          doc_start_index = lines.index { |line| YAML_OPTIONAL_DOC_START.match?(line) } || -1
-          lines.insert(doc_start_index + 1, "inherit_from:#{file_string}\n")
-          File.write(file_name, lines.join("\n"))
+          unless rubocop_yml_contents&.include?(PLACEHOLDER)
+            doc_start_index = lines.index { |line| YAML_OPTIONAL_DOC_START.match?(line) } || -1
+            lines.insert(doc_start_index + 1, PLACEHOLDER)
+          end
+          File.write(file_name, lines.join("\n")
+                                     .sub(/#{PLACEHOLDER}\n*/o, "inherit_from:#{file_string}\n\n")
+                                     .sub(/\n\n+\Z/, "\n"))
         end
 
         def relative_path_to_todo_from_options_config
-          return AUTO_GENERATED_FILE if !@options[:config] || options_config_in_root?
+          return AUTO_GENERATED_FILE unless @options[:config]
 
-          base = Pathname.new('.')
-          config_dir = Pathname.new(File.dirname(@options[:config]))
+          base = Pathname.new(PathUtil.pwd)
+          config_dir = Pathname.new(@options[:config]).realpath.dirname
 
-          "#{base.relative_path_from(config_dir)}/#{AUTO_GENERATED_FILE}"
-        end
+          # Don't have the path start with `/`
+          return AUTO_GENERATED_FILE if config_dir == base
 
-        def options_config_in_root?
-          File.dirname(@options[:config]) == '.'
+          "#{base.relative_path_from(config_dir)}/#{AUTO_GENERATED_FILE}"
         end
       end
     end

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

@@ -30,6 +30,10 @@ module RuboCop
 
           maybe_print_corrected_source
 
+          merge_todo_audit_status(runner_status(runner, all_pass_or_excluded))
+        end
+
+        def runner_status(runner, all_pass_or_excluded)
           if runner.aborting?
             STATUS_INTERRUPTED
           elsif all_pass_or_excluded && runner.errors.empty?
@@ -39,6 +43,33 @@ module RuboCop
           end
         end
 
+        def merge_todo_audit_status(status)
+          return status if status == STATUS_INTERRUPTED || !@options[:report_unused_todo_entries]
+
+          audit_status = report_unused_todo_entries
+          status == STATUS_SUCCESS ? audit_status : status
+        end
+
+        def report_unused_todo_entries
+          audit = TodoAudit.new(@config_store, @options)
+          unused = audit.unused_entries
+
+          if unused.nil?
+            warn Rainbow("No `#{audit.todo_file}` found; nothing to audit.").yellow
+            return STATUS_SUCCESS
+          end
+          return STATUS_SUCCESS if unused.empty?
+
+          print_unused_todo_entries(audit.todo_file, unused)
+          STATUS_OFFENSES
+        end
+
+        def print_unused_todo_entries(todo_file, unused)
+          noun = unused.size == 1 ? 'entry' : 'entries'
+          warn Rainbow("\n#{unused.size} unused todo #{noun} found in `#{todo_file}`:").red
+          unused.each { |entry| warn "  #{entry.cop_name}: #{entry.path}" }
+        end
+
         def with_redirect
           if @options[:stderr]
             orig_stdout = $stdout
@@ -71,14 +102,14 @@ module RuboCop
 
           warn Rainbow("\n#{pluralize(errors.size, 'error')} occurred:").red
 
-          errors.each { |error| warn error }
+          errors.each { |error| warn Rainbow(error).red }
 
-          warn <<~WARNING
+          warn Rainbow(<<~WARNING.strip).yellow
             Errors are usually caused by RuboCop bugs.
-            Please, report your problems to RuboCop's issue tracker.
+            Please, update to the latest RuboCop version if not already in use, and report a bug if the issue still occurs on this version.
             #{bug_tracker_uri}
             Mention the following information in the issue report:
-            #{RuboCop::Version.version(debug: true)}
+            #{RuboCop::Version.verbose}
           WARNING
         end
 

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

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require_relative '../../lsp/server'
-
 module RuboCop
   class CLI
     module Command
       # Start Language Server Protocol of RuboCop.
       # @api private
-      class Lsp < Base
+      class LSP < Base
         self.command_name = :lsp
 
         def run
-          RuboCop::Lsp::Server.new(@config_store).start
+          # Load on demand, `language-server-protocol` is heavy to require.
+          require_relative '../../lsp/server'
+          RuboCop::LSP::Server.new(@config_store).start
         end
       end
     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

@@ -9,11 +9,31 @@ module RuboCop
       class ShowCops < Base
         self.command_name = :show_cops
 
+        ExactMatcher = Struct.new(:pattern) do
+          def match?(name)
+            name == pattern
+          end
+        end
+
+        WildcardMatcher = Struct.new(:pattern) do
+          def match?(name)
+            File.fnmatch(pattern, name, File::FNM_PATHNAME)
+          end
+        end
+
         def initialize(env)
           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?('*')
+              WildcardMatcher.new(pattern)
+            else
+              ExactMatcher.new(pattern)
+            end
+          end
         end
 
         def run
@@ -24,9 +44,9 @@ module RuboCop
 
         def print_available_cops
           registry = Cop::Registry.global
-          show_all = @options[:show_cops].empty?
+          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)
@@ -56,7 +76,9 @@ module RuboCop
 
         def selected_cops_of_department(cops, department)
           cops_of_department(cops, department).select do |cop|
-            @options[:show_cops].include?(cop.cop_name)
+            @cop_matchers.any? do |matcher|
+              matcher.match?(cop.cop_name)
+            end
           end
         end
 

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,11 +25,11 @@ module RuboCop
           puts Cop::Documentation.default_base_url if cops_array.empty?
 
           cops_array.each do |cop_name|
-            cop = registry_hash[cop_name]
+            cop = Cop::Registry.global.find_by_cop_name(cop_name)
+            next unless cop
 
-            next if cop.empty?
-
-            puts Cop::Documentation.url_for(cop.first, @config)
+            url = Cop::Documentation.url_for(cop, @config)
+            puts url if url
           end
 
           puts
@@ -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'
@@ -97,7 +97,13 @@ module RuboCop
         end
 
         def loaded_extensions
-          @config_store.for_pwd.loaded_features.to_a
+          rubocop_config = @config_store.for_pwd
+
+          plugin_names = rubocop_config.loaded_plugins.map do |plugin|
+            plugin.about.name
+          end
+
+          plugin_names + rubocop_config.loaded_features.to_a
         end
 
         def installed_and_not_loaded_extensions

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

@@ -9,8 +9,8 @@ module RuboCop
         self.command_name = :version
 
         def run
-          puts RuboCop::Version.version(debug: false) if @options[:version]
-          puts RuboCop::Version.version(debug: true, env: env) if @options[:verbose_version]
+          puts RuboCop::Version::STRING if @options[:version]
+          puts RuboCop::Version.verbose(env: env) if @options[:verbose_version]
         end
       end
     end