rubocop 1.69.2 → 1.73.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45af4a986637b8c3dacb16d942870c2138501ae834e79c0875b81bbf09644b54
-  data.tar.gz: 65961fc4cb25730ad9528201e22a82427def59f6ad5f048cd01a0ca89a437c3c
+  metadata.gz: a4215b7d095dfd177a36af3bdf5d5aecd786877a6feca3480078d9cb1a5917ad
+  data.tar.gz: fc20be6f63f1a0e3c06cd2fc13f8619f872e9a81642dfa833f90f88f70997857
 SHA512:
-  metadata.gz: aa6eb7a2cbf39d99cbda0faff3dfe690a61e9665847c21669bc9a005f9ac316e9404a8babc8cadf7f033bf82afcf317c8c503ede2306e8b3a8c211abaa878cb9
-  data.tar.gz: 126f20d27ebf2e0098d0a1039230fea4178d2a196693db8c75326a7f3fdc797b1f030af3d116f2d74f69bb70cc033372ede6836962b2c47632a9ecf4f524dd56
+  metadata.gz: aee7de1fa54b8b7108f5ad7f29c3fbc1818547f28507010dca91adc0f648b02ce519c96846d2ad98407d8f8847047cd8f88547e7d5c81028d0f54cfafb44500b
+  data.tar.gz: afc90ab7e887e183ddfac0bf49e9f644c04564e7fd605423d29f2848f6cc509f2394fd642eccd8870d105b21055a5cb4d0dea051b92ba47ef3befbf5b7d3dad5

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-24 Bozhidar Batsov
+Copyright (c) 2012-25 Bozhidar Batsov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -52,7 +52,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.69', require: false
+gem 'rubocop', '~> 1.73', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.
@@ -241,11 +241,11 @@ Become a sponsor and get your logo on our README on GitHub with a link to your s
 <a href="https://opencollective.com/rubocop/organization/28/website" target="_blank"><img src="https://opencollective.com/rubocop/organization/28/avatar.svg"></a>
 <a href="https://opencollective.com/rubocop/organization/29/website" target="_blank"><img src="https://opencollective.com/rubocop/organization/29/avatar.svg"></a>
 
-## Changelog
+## Release Notes
 
-RuboCop's changelog is available [here](CHANGELOG.md).
+RuboCop's release notes are available [here](https://github.com/rubocop/rubocop/releases).
 
 ## Copyright
 
-Copyright (c) 2012-2024 Bozhidar Batsov. See [LICENSE.txt](LICENSE.txt) for
+Copyright (c) 2012-2025 Bozhidar Batsov. See [LICENSE.txt](LICENSE.txt) for
 further details.

data/config/default.yml

@@ -1616,6 +1616,12 @@ Lint/AmbiguousRegexpLiteral:
   VersionAdded: '0.17'
   VersionChanged: '0.83'
 
+Lint/ArrayLiteralInRegexp:
+  Description: 'Checks for an array literal interpolated inside a regexp.'
+  Enabled: pending
+  VersionAdded: '1.71'
+  SafeAutoCorrect: false
+
 Lint/AssignmentInCondition:
   Description: "Don't use assignment in conditions."
   StyleGuide: '#safe-assignment-in-condition'
@@ -1665,6 +1671,11 @@ Lint/ConstantOverwrittenInRescue:
   Enabled: pending
   VersionAdded: '1.31'
 
+Lint/ConstantReassignment:
+  Description: 'Checks for constant reassignments.'
+  Enabled: pending
+  VersionAdded: '1.70'
+
 Lint/ConstantResolution:
   Description: 'Check that constants are fully qualified with `::`.'
   Enabled: false
@@ -1674,6 +1685,11 @@ Lint/ConstantResolution:
   # Restrict this cop from only looking at certain names
   Ignore: []
 
+Lint/CopDirectiveSyntax:
+  Description: 'Checks that `# rubocop:` directives are strictly formatted.'
+  Enabled: pending
+  VersionAdded: '1.72'
+
 Lint/Debugger:
   Description: 'Check for debugger calls.'
   Enabled: true
@@ -2030,6 +2046,7 @@ Lint/LambdaWithoutLiteralBlock:
 Lint/LiteralAsCondition:
   Description: 'Checks of literals used in conditions.'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.51'
 
 Lint/LiteralAssignmentInCondition:
@@ -2243,9 +2260,8 @@ Lint/RedundantRegexpQuantifiers:
 Lint/RedundantRequireStatement:
   Description: 'Checks for unnecessary `require` statement.'
   Enabled: true
-  SafeAutoCorrect: false
   VersionAdded: '0.76'
-  VersionChanged: '1.57'
+  VersionChanged: '1.73'
 
 Lint/RedundantSafeNavigation:
   Description: 'Checks for redundant safe navigation calls.'
@@ -2274,6 +2290,11 @@ Lint/RedundantStringCoercion:
   VersionAdded: '0.19'
   VersionChanged: '0.77'
 
+Lint/RedundantTypeConversion:
+  Description: 'Checks for redundantly converting a literal to the same type.'
+  Enabled: pending
+  VersionAdded: '1.72'
+
 Lint/RedundantWithIndex:
   Description: 'Checks for redundant `with_index`.'
   Enabled: true
@@ -2402,6 +2423,12 @@ Lint/ShadowingOuterLocalVariable:
   Enabled: true
   VersionAdded: '0.9'
 
+Lint/SharedMutableDefault:
+  Description: 'Checks for mutable literals used as default arguments during Hash initialization.'
+  StyleGuide: '#no-mutable-defaults'
+  Enabled: pending
+  VersionAdded: '1.70'
+
 Lint/StructNewOverride:
   Description: 'Disallow overriding the `Struct` built-in methods via `Struct.new`.'
   Enabled: true
@@ -2416,6 +2443,12 @@ Lint/SuppressedException:
   VersionAdded: '0.9'
   VersionChanged: '1.12'
 
+Lint/SuppressedExceptionInNumberConversion:
+  Description: 'Checks for cases where exceptions unrelated to the numeric constructors may be unintentionally swallowed.'
+  Enabled: pending
+  SafeAutoCorrect: false
+  VersionAdded: '1.72'
+
 Lint/SymbolConversion:
   Description: 'Checks for unnecessary symbol conversions.'
   Enabled: pending
@@ -2571,6 +2604,11 @@ Lint/UselessAssignment:
   VersionAdded: '0.11'
   VersionChanged: '1.66'
 
+Lint/UselessConstantScoping:
+  Description: 'Checks for useless constant scoping.'
+  Enabled: pending
+  VersionAdded: '1.72'
+
 Lint/UselessDefined:
   Description: 'Checks for calls to `defined?` with strings and symbols. The result of such a call will always be truthy.'
   Enabled: pending
@@ -3024,6 +3062,8 @@ Naming/PredicateName:
   MethodDefinitionMacros:
     - define_method
     - define_singleton_method
+  # Use Sorbet's T::Boolean return type to detect predicate methods.
+  UseSorbetSigs: false
   # Exclude Rspec specs because there is a strong convention to write spec
   # helpers in the form of `have_something` or `be_something`.
   Exclude:
@@ -3041,13 +3081,15 @@ Naming/VariableName:
   StyleGuide: '#snake-case-symbols-methods-vars'
   Enabled: true
   VersionAdded: '0.50'
-  VersionChanged: '1.8'
+  VersionChanged: '1.73'
   EnforcedStyle: snake_case
   SupportedStyles:
     - snake_case
     - camelCase
   AllowedIdentifiers: []
   AllowedPatterns: []
+  ForbiddenIdentifiers: []
+  ForbiddenPatterns: []
 
 Naming/VariableNumber:
   Description: 'Use the configured style when numbering symbols, methods and variables.'
@@ -3136,13 +3178,14 @@ Style/AccessModifierDeclarations:
   Description: 'Checks style of how access modifiers are used.'
   Enabled: true
   VersionAdded: '0.57'
-  VersionChanged: '0.81'
+  VersionChanged: '1.70'
   EnforcedStyle: group
   SupportedStyles:
     - inline
     - group
   AllowModifiersOnSymbols: true
   AllowModifiersOnAttrs: true
+  AllowModifiersOnAliasMethod: true
   SafeAutoCorrect: false
 
 Style/AccessorGrouping:
@@ -3881,6 +3924,8 @@ Style/EndlessMethod:
     - allow_single_line
     - allow_always
     - disallow
+    - require_single_line
+    - require_always
 
 Style/EnvHome:
   Description: "Checks for consistent usage of `ENV['HOME']`."
@@ -4051,6 +4096,9 @@ Style/FrozenStringLiteralComment:
     # exist in a file.
     - never
   SafeAutoCorrect: false
+  Exclude:
+    # Prevent the Ruby warning: `'frozen_string_literal' is ignored after any tokens` when using Active Admin.
+    - '**/*.arb'
 
 Style/GlobalStdStream:
   Description: 'Enforces the use of `$stdout/$stderr/$stdin` instead of `STDOUT/STDERR/STDIN`.'
@@ -4129,6 +4177,14 @@ Style/HashLikeCase:
   # to trigger this cop
   MinBranchesCount: 3
 
+Style/HashSlice:
+  Description: >-
+                 Checks for usages of `Hash#reject`, `Hash#select`, and `Hash#filter` methods
+                 that can be replaced with `Hash#slice` method.
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.71'
+
 Style/HashSyntax:
   Description: >-
                  Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax
@@ -4316,6 +4372,11 @@ Style/IpAddresses:
     - '**/gems.rb'
     - '**/*.gemspec'
 
+Style/ItAssignment:
+  Description: 'Checks for assignment to `it` inside a block.'
+  Enabled: pending
+  VersionAdded: '1.70'
+
 Style/KeywordArgumentsMerging:
   Description: >-
                  When passing an existing hash as keyword arguments, provide additional arguments
@@ -5047,6 +5108,9 @@ Style/RedundantCondition:
   Description: 'Checks for unnecessary conditional expressions.'
   Enabled: true
   VersionAdded: '0.76'
+  VersionChanged: '1.73'
+  AllowedMethods:
+    - nonzero?
 
 Style/RedundantConditional:
   Description: "Don't return true/false from a conditional."
@@ -5059,7 +5123,7 @@ Style/RedundantConstantBase:
   VersionAdded: '1.40'
 
 Style/RedundantCurrentDirectoryInPath:
-  Description: 'Checks for uses a redundant current directory in path.'
+  Description: 'Checks for a redundant current directory in a path given to `require_relative`.'
   Enabled: pending
   VersionAdded: '1.53'
 
@@ -5111,6 +5175,13 @@ Style/RedundantFilterChain:
   VersionAdded: '1.52'
   VersionChanged: '1.57'
 
+Style/RedundantFormat:
+  Description: 'Checks for usages of `Kernel#format` or `Kernel#sprintf` with only a single argument.'
+  Enabled: pending
+  SafeAutoCorrect: false
+  VersionAdded: '1.72'
+  VersionChanged: '1.72'
+
 Style/RedundantFreeze:
   Description: "Checks usages of Object#freeze on immutable objects."
   Enabled: true
@@ -5637,14 +5708,17 @@ Style/TrailingCommaInArrayLiteral:
   StyleGuide: '#no-trailing-array-commas'
   Enabled: true
   VersionAdded: '0.53'
-  # If `comma`, the cop requires a comma after the last item in an array,
-  # but only when each item is on its own line.
-  # If `consistent_comma`, the cop requires a comma after the last item of all
-  # non-empty, multiline array literals.
+  # If `comma`, the cop requires a comma after the last item in an array, but only when each item is
+  # on its own line.
+  # If `consistent_comma`, the cop requires a comma after the last item of all non-empty, multiline
+  # array literals.
+  # If `diff_comma`, the cop requires a comma after the last item of all non-empty, multiline array
+  # literals, but only when that last item immediately precedes a newline.
   EnforcedStyleForMultiline: no_comma
   SupportedStylesForMultiline:
     - comma
     - consistent_comma
+    - diff_comma
     - no_comma
 
 Style/TrailingCommaInBlockArgs:
@@ -5656,14 +5730,17 @@ Style/TrailingCommaInBlockArgs:
 Style/TrailingCommaInHashLiteral:
   Description: 'Checks for trailing comma in hash literals.'
   Enabled: true
-  # If `comma`, the cop requires a comma after the last item in a hash,
-  # but only when each item is on its own line.
-  # If `consistent_comma`, the cop requires a comma after the last item of all
-  # non-empty, multiline hash literals.
+  # If `comma`, the cop requires a comma after the last item in a hash, but only when each item is
+  # on its own line.
+  # If `consistent_comma`, the cop requires a comma after the last item of all non-empty, multiline
+  # hash literals.
+  # If `diff_comma`, the cop requires a comma after the last item of all non-empty, multiline hash
+  # literals, but only when that last item immediately precedes a newline.
   EnforcedStyleForMultiline: no_comma
   SupportedStylesForMultiline:
     - comma
     - consistent_comma
+    - diff_comma
     - no_comma
   VersionAdded: '0.53'
 

data/config/internal_affairs.yml

@@ -6,6 +6,22 @@ InternalAffairs/CopDescription:
   Include:
     - 'lib/rubocop/cop/**/*.rb'
 
+InternalAffairs/ExampleHeredocDelimiter:
+  Include:
+    - 'spec/rubocop/cop/**/*.rb'
+
+InternalAffairs/ExampleDescription:
+  Include:
+    - 'spec/rubocop/cop/**/*.rb'
+
+InternalAffairs/OnSendWithoutOnCSend:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/UndefinedConfig:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
 InternalAffairs/UselessMessageAssertion:
   Include:
     - '**/*_spec.rb'

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

@@ -71,11 +71,11 @@ 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.verbose}

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)
+
+          @cop_matchers = @options[:show_cops].map do |pattern|
+            if pattern.include?('*')
+              WildcardMatcher.new(pattern)
+            else
+              ExactMatcher.new(pattern)
+            end
+          end
         end
 
         def run
@@ -24,7 +44,7 @@ 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
 
@@ -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/suggest_extensions.rb

@@ -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/comment_config.rb

@@ -87,7 +87,7 @@ module RuboCop
           next unless directive.enabled?
           next if directive.all_cops?
 
-          cops.merge(directive.cop_names)
+          cops.merge(directive.raw_cop_names)
         end
         cops
       end
@@ -205,7 +205,7 @@ module RuboCop
       directive.cop_names.each do |name|
         if directive.disabled?
           names[name] += 1
-        elsif (names[name]).positive?
+        elsif names[name].positive?
           names[name] -= 1
         else
           extras[directive.comment] << name

data/lib/rubocop/config.rb

@@ -16,6 +16,7 @@ module RuboCop
 
     CopConfig = Struct.new(:name, :metadata)
 
+    EMPTY_CONFIG = {}.freeze
     DEFAULT_RAILS_VERSION = 5.0
     attr_reader :loaded_path
 
@@ -44,6 +45,10 @@ module RuboCop
     end
     # rubocop:enable Metrics/AbcSize
 
+    def loaded_plugins
+      @loaded_plugins ||= ConfigLoader.loaded_plugins
+    end
+
     def loaded_features
       @loaded_features ||= ConfigLoader.loaded_features
     end
@@ -80,10 +85,7 @@ module RuboCop
 
     def make_excludes_absolute
       each_key do |key|
-        @validator.validate_section_presence(key)
-        next unless self[key]['Exclude']
-
-        self[key]['Exclude'].map! do |exclude_elem|
+        dig(key, 'Exclude')&.map! do |exclude_elem|
           if exclude_elem.is_a?(String) && !absolute?(exclude_elem)
             File.expand_path(File.join(base_dir_for_path_parameters, exclude_elem))
           else
@@ -123,6 +125,13 @@ module RuboCop
       @for_cop[cop]
     end
 
+    # @return [Config, Hash] for the given cop / cop name.
+    # If the given cop is enabled, returns its configuration hash.
+    # Otherwise, returns an empty hash.
+    def for_enabled_cop(cop)
+      cop_enabled?(cop) ? for_cop(cop) : EMPTY_CONFIG
+    end
+
     # @return [Config] for the given cop merged with that of its department (if any)
     # Note: the 'Enabled' attribute is same as that returned by `for_cop`
     def for_badge(badge)
@@ -159,6 +168,10 @@ module RuboCop
       @for_all_cops ||= self['AllCops'] || {}
     end
 
+    def cop_enabled?(name)
+      !!for_cop(name)['Enabled']
+    end
+
     def disabled_new_cops?
       for_all_cops['NewCops'] == 'disable'
     end

data/lib/rubocop/config_loader.rb

@@ -33,22 +33,33 @@ module RuboCop
       attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
                     :ignore_unrecognized_cops
       attr_writer :default_configuration
-      attr_reader :loaded_features
+      attr_reader :loaded_plugins, :loaded_features
 
       alias debug? debug
       alias ignore_parent_exclusion? ignore_parent_exclusion
 
       def clear_options
         @debug = nil
+        @loaded_plugins = Set.new
         @loaded_features = Set.new
+        @disable_pending_cops = nil
+        @enable_pending_cops = nil
+        @ignore_parent_exclusion = nil
+        @ignore_unrecognized_cops = nil
         FileFinder.root_level = nil
       end
 
+      # rubocop:disable Metrics/AbcSize
       def load_file(file, check: true)
         path = file_path(file)
 
         hash = load_yaml_configuration(path)
 
+        rubocop_config = Config.create(hash, path, check: false)
+        plugins = hash.delete('plugins')
+        loaded_plugins = resolver.resolve_plugins(rubocop_config, plugins)
+        add_loaded_plugins(loaded_plugins)
+
         loaded_features = resolver.resolve_requires(path, hash)
         add_loaded_features(loaded_features)
 
@@ -63,6 +74,7 @@ module RuboCop
 
         Config.create(hash, path, check: check)
       end
+      # rubocop:enable Metrics/AbcSize
 
       def load_yaml_configuration(absolute_path)
         file_contents = read_file(absolute_path)
@@ -151,14 +163,35 @@ module RuboCop
         end
       end
 
-      # @api private
-      def inject_defaults!(project_root)
-        path = File.join(project_root, 'config', 'default.yml')
-        config = load_file(path)
-        new_config = ConfigLoader.merge_with_default(config, path)
-        puts "configuration from #{path}" if debug?
-        @default_configuration = new_config
+      # This API is primarily intended for testing and documenting plugins.
+      # When testing a plugin using `rubocop/rspec/support`, the plugin is loaded automatically,
+      # so this API is usually not needed. It is intended to be used only when implementing tests
+      # that do not use `rubocop/rspec/support`.
+      # rubocop:disable Metrics/MethodLength
+      def inject_defaults!(config_yml_path)
+        if Pathname(config_yml_path).directory?
+          # TODO: Since the warning noise is expected to be high until some time after the release,
+          # warnings will only be issued when `RUBYOPT=-w` is specified.
+          # To proceed step by step, the next step is to remove `$VERBOSE` and always issue warning.
+          # Eventually, `project_root` will no longer be accepted.
+          if $VERBOSE
+            warn Rainbow(<<~MESSAGE).yellow, uplevel: 1
+              Use config YAML file path instead of project root directory.
+              e.g., `path/to/config/default.yml`
+            MESSAGE
+          end
+          # NOTE: For compatibility.
+          project_root = config_yml_path
+          path = File.join(project_root, 'config', 'default.yml')
+          config = load_file(path)
+        else
+          hash = ConfigLoader.load_yaml_configuration(config_yml_path.to_s)
+          config = Config.new(hash, config_yml_path).tap(&:make_excludes_absolute)
+        end
+
+        @default_configuration = ConfigLoader.merge_with_default(config, path)
       end
+      # rubocop:enable Metrics/MethodLength
 
       # Returns the path RuboCop inferred as the root of the project. No file
       # searches will go past this directory.
@@ -192,6 +225,13 @@ module RuboCop
         resolver.merge_with_default(config, config_file, unset_nil: unset_nil)
       end
 
+      # @api private
+      # Used to add plugins that were required inside a config or from
+      # the CLI using `--plugin`.
+      def add_loaded_plugins(loaded_plugins)
+        @loaded_plugins.merge(Array(loaded_plugins))
+      end
+
       # @api private
       # Used to add features that were required inside a config or from
       # the CLI using `--require`.