rubocop-rails 2.25.1 → 2.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b55703b258e4df9bae3a9a8c1b77a4fa143af6af3ed9b1b22118fd839d1ce06c
-  data.tar.gz: 24568d7d8d22d69469ae9a4aaf426ea45bf848989604a8744ab6493bc0b222a3
+  metadata.gz: '009a04a87f7692e278ce16b061ff93814ada6644691ce2fdd4ac4c7659e68c4d'
+  data.tar.gz: 313e26b30279cf9ebba24f5f99bc78b2b44433b24bc3522a6d4261de1cf72282
 SHA512:
-  metadata.gz: 47d5668b744967fc740b47552e9d05068fc5ce5c209a4a994a429262a0628b13e0f1e48d6a39018430fb7e874f88e4badbd9427219b9a77220e522d6706b1c3c
-  data.tar.gz: 242030d6fe9063d51f18e98869e2a048a4b7b847f0f6a25937fc3d9781dbb7749de8b015b3fa0b4933511b83487ad060fbdbf9adb7942a20bfc035d5fc9e2f04
+  metadata.gz: 1f7397609be46c75da8ff050ed1325db850c39df7d097d9faeb6984162b706ed92e203f151a30a68aa41b3af8fcdd63b7e76c51ebdcfe31980129a853d7cd8a3
+  data.tar.gz: 46006ebeb148838e1ae7f3dc56614b261fc90779c5e3772e163c9431034a89dbc614ef1cb1b913d5236fbc2b04708643fc27b593d8c0c4147898271c045cb4c7

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-23 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

@@ -5,7 +5,8 @@
 
 A [RuboCop](https://github.com/rubocop/rubocop) extension focused on enforcing Rails best practices and coding conventions.
 
-Note: This repository manages rubocop-rails gem (>= 2.0.0). rubocop-rails gem (<= 1.5.0) has been renamed to [rubocop-rails_config](https://rubygems.org/gems/rubocop-rails_config) gem.
+> [!IMPORTANT]
+> This repository manages rubocop-rails gem (>= 2.0.0). rubocop-rails gem (<= 1.5.0) has been renamed to [rubocop-rails_config](https://rubygems.org/gems/rubocop-rails_config) gem.
 
 ## Installation
 
@@ -31,13 +32,13 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-rails
+plugins: rubocop-rails
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-rails
 ```
@@ -45,27 +46,64 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop Rails
 cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```sh
-$ rubocop --require rubocop-rails
+$ rubocop --plugin rubocop-rails
 ```
 
-Note: `--rails` option is required while `rubocop` command supports `--rails` option.
-
 ### Rake task
 
 ```ruby
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rails'
+  task.plugins << 'rubocop-rails'
 end
 ```
 
+## RuboCop Rails configuration
+
+The following settings specific to RuboCop Rails can be configured in `.rubocop.yml`.
+
+### `AllCops: TargetRailsVersion`
+
+What version of Rails is the inspected code using? If a value is specified
+for `TargetRailsVersion` then it is used. Acceptable values are specified
+as a float (e.g., 7.2); the patch version of Rails should not be included.
+
+```yaml
+AllCops:
+  TargetRailsVersion: 7.2
+```
+
+If `TargetRailsVersion` is not set, RuboCop will parse the Gemfile.lock or
+gems.locked file to find the version of Rails that has been bound to the
+application. If neither of those files exist, RuboCop will use Rails 5.0
+as the default.
+
+### `AllCops: MigratedSchemaVersion`
+
+By specifying the `MigratedSchemaVersion` option, migration files that have already been run can be ignored.
+When `MigratedSchemaVersion: '20241225000000'` is set, migration files lower than or equal to '20241225000000' will be ignored.
+For example, to ignore db/migrate/20241225000000_create_articles.rb and earlier migrations you would configure it the following way:
+
+```yaml
+AllCops:
+  MigratedSchemaVersion: '20241225000000'
+```
+
+This prevents inspecting schema settings for already applied migration files.
+Changing already applied migrations should be avoided because it can lead to the schema getting out of sync
+between your local copy and what it actually is in production, depending on when `bin/rails db:migrate` was executed.
+If you want to modify your schema to comply with the cops, you should instead create new migrations.
+
 ## Rails configuration tip
 
-If you are using Rails 6.1 or newer, add the following `config.generators.after_generate` setting to
+In Rails 6.1+, add the following `config.generators.after_generate` setting to
 your `config/environments/development.rb` to apply RuboCop autocorrection to code generated by `bin/rails g`.
 
 ```ruby
@@ -84,6 +122,20 @@ It uses `rubocop -A` to apply `Style/FrozenStringLiteralComment` and other unsaf
 `rubocop -A` is unsafe autocorrection, but code generated by default is simple and less likely to
 be incompatible with `rubocop -A`. If you have problems you can replace it with `rubocop -a` instead.
 
+In Rails 7.2+, it is recommended to use `config.generators.apply_rubocop_autocorrect_after_generate!` instead of the above setting:
+
+```diff
+ # config/environments/development.rb
+ Rails.application.configure do
+   (snip)
+   # Apply autocorrection by RuboCop to files generated by `bin/rails generate`.
+-  # config.generators.apply_rubocop_autocorrect_after_generate!
++  config.generators.apply_rubocop_autocorrect_after_generate!
+ end
+```
+
+You only need to uncomment.
+
 ## The Cops
 
 All cops are located under

data/config/default.yml

@@ -6,7 +6,7 @@ inherit_mode:
 
 AllCops:
   Exclude:
-    - app/assets/**/*
+    - '**/app/assets/**/*'
     - bin/*
     # Exclude db/schema.rb and db/[CONFIGURATION_NAMESPACE]_schema.rb by default.
     # See: https://guides.rubyonrails.org/active_record_multiple_databases.html#setting-up-your-application
@@ -17,14 +17,18 @@ AllCops:
   # Enable checking Active Support extensions.
   # See: https://docs.rubocop.org/rubocop/configuration.html#enable-checking-active-support-extensions
   ActiveSupportExtensionsEnabled: true
-  # What version of Rails is the inspected code using?  If a value is specified
-  # for TargetRailsVersion then it is used.  Acceptable values are specified
-  # as a float (i.e. 5.1); the patch version of Rails should not be included.
-  # If TargetRailsVersion is not set, RuboCop will parse the Gemfile.lock or
+  # What version of Rails is the inspected code using? If a value is specified
+  # for `TargetRailsVersion` then it is used. Acceptable values are specified
+  # as a float (e.g., 7.2); the patch version of Rails should not be included.
+  # If `TargetRailsVersion` is not set, RuboCop will parse the Gemfile.lock or
   # gems.locked file to find the version of Rails that has been bound to the
-  # application.  If neither of those files exist, RuboCop will use Rails 5.0
+  # application. If neither of those files exist, RuboCop will use Rails 5.0
   # as the default.
   TargetRailsVersion: ~
+  # By specifying `MigratedSchemaVersion` option, migration files that have been migrated can be ignored.
+  # When `MigratedSchemaVersion: '20241231000000'` is set. Migration files lower than or equal to '20250101000000' will be ignored.
+  # For example, this is the timestamp in db/migrate/20250101000000_create_articles.rb.
+  MigratedSchemaVersion: '19700101000000' # NOTE: Used as a sentinel value for the UNIX epoch time.
 
 Lint/NumberConversion:
   # Add Rails' duration methods to the ignore list for `Lint/NumberConversion`
@@ -73,6 +77,20 @@ Lint/SafeNavigationChain:
     - try!
     - in?
 
+Lint/UselessAccessModifier:
+  # Add methods from `ActiveSupport::Concern` and `Module::Concerning`:
+  # https://api.rubyonrails.org/classes/ActiveSupport/Concern.html
+  # https://api.rubyonrails.org/classes/Module/Concerning
+  inherit_mode:
+    merge:
+      - ContextCreatingMethods
+  ContextCreatingMethods:
+    - class_methods
+    - included
+    - prepended
+    - concern
+    - concerning
+
 Rails:
   Enabled: true
   DocumentationBaseURL: https://docs.rubocop.org/rubocop-rails
@@ -103,8 +121,8 @@ Rails/ActionFilter:
     - action
     - filter
   Include:
-    - app/controllers/**/*.rb
-    - app/mailers/**/*.rb
+    - '**/app/controllers/**/*.rb'
+    - '**/app/mailers/**/*.rb'
 
 Rails/ActionOrder:
   Description: 'Enforce consistent ordering of controller actions.'
@@ -119,7 +137,7 @@ Rails/ActionOrder:
     - update
     - destroy
   Include:
-    - app/controllers/**/*.rb
+    - '**/app/controllers/**/*.rb'
 
 Rails/ActiveRecordAliases:
   Description: >-
@@ -136,7 +154,7 @@ Rails/ActiveRecordCallbacksOrder:
   Enabled: 'pending'
   VersionAdded: '2.7'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/ActiveRecordOverride:
   Description: >-
@@ -147,7 +165,7 @@ Rails/ActiveRecordOverride:
   VersionAdded: '0.67'
   VersionChanged: '2.18'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/ActiveSupportAliases:
   Description: >-
@@ -212,7 +230,9 @@ Rails/ApplicationRecord:
   Enabled: true
   SafeAutoCorrect: false
   VersionAdded: '0.49'
-  VersionChanged: '2.5'
+  VersionChanged: '2.26'
+  Exclude:
+    - db/**/*.rb
 
 Rails/ArelStar:
   Description: 'Enforces `Arel.star` instead of `"*"` for expanded columns.'
@@ -232,7 +252,7 @@ Rails/AttributeDefaultBlockValue:
   Enabled: pending
   VersionAdded: '2.9'
   Include:
-    - 'app/models/**/*'
+    - '**/app/models/**/*'
 
 Rails/BelongsTo:
   Description: >-
@@ -291,8 +311,8 @@ Rails/ContentTag:
   # https://puma.io/puma/Puma/DSL.html#tag-instance_method
   # No helpers are used in normal models and configs.
   Exclude:
-    - app/models/**/*.rb
-    - config/**/*.rb
+    - '**/app/models/**/*.rb'
+    - '**/config/**/*.rb'
 
 Rails/CreateTableWithTimestamps:
   Description: >-
@@ -347,11 +367,13 @@ Rails/Delegate:
   Description: 'Prefer delegate method for delegations.'
   Enabled: true
   VersionAdded: '0.21'
-  VersionChanged: '0.50'
+  VersionChanged: '2.30'
   # When set to true, using the target object as a prefix of the
   # method name without using the `delegate` method will be a
   # violation. When set to false, this case is legal.
   EnforceForPrefixed: true
+  Exclude:
+    - '**/app/controllers/**/*.rb'
 
 Rails/DelegateAllowBlank:
   Description: 'Do not use allow_blank as an option to delegate.'
@@ -422,14 +444,22 @@ Rails/EnumHash:
   Enabled: true
   VersionAdded: '2.3'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
+
+Rails/EnumSyntax:
+  Description: 'Use positional arguments over keyword arguments when defining enums.'
+  Enabled: pending
+  Severity: warning
+  VersionAdded: '2.26'
+  Include:
+    - '**/app/models/**/*.rb'
 
 Rails/EnumUniqueness:
   Description: 'Avoid duplicate integers in hash-syntax `enum` declaration.'
   Enabled: true
   VersionAdded: '0.46'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/EnvLocal:
   Description: 'Use `Rails.env.local?` instead of `Rails.env.development? || Rails.env.test?`.'
@@ -448,11 +478,11 @@ Rails/EnvironmentVariableAccess:
   VersionAdded: '2.10'
   VersionChanged: '2.24'
   Include:
-    - app/**/*.rb
-    - config/initializers/**/*.rb
-    - lib/**/*.rb
+    - '**/app/**/*.rb'
+    - '**/config/initializers/**/*.rb'
+    - '**/lib/**/*.rb'
   Exclude:
-    - lib/**/*.rake
+    - '**/lib/**/*.rake'
   AllowReads: false
   AllowWrites: false
 
@@ -464,11 +494,11 @@ Rails/Exit:
   Enabled: true
   VersionAdded: '0.41'
   Include:
-    - app/**/*.rb
-    - config/**/*.rb
-    - lib/**/*.rb
+    - '**/app/**/*.rb'
+    - '**/config/**/*.rb'
+    - '**/lib/**/*.rb'
   Exclude:
-    - lib/**/*.rake
+    - '**/lib/**/*.rake'
 
 Rails/ExpandedDateRange:
   Description: 'Checks for expanded date range.'
@@ -530,7 +560,7 @@ Rails/HasAndBelongsToMany:
   Enabled: true
   VersionAdded: '0.12'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/HasManyOrHasOneDependent:
   Description: 'Define the dependent option to the has_many and has_one associations.'
@@ -538,14 +568,14 @@ Rails/HasManyOrHasOneDependent:
   Enabled: true
   VersionAdded: '0.50'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/HelperInstanceVariable:
   Description: 'Do not use instance variables in helpers.'
   Enabled: true
   VersionAdded: '2.0'
   Include:
-    - app/helpers/**/*.rb
+    - '**/app/helpers/**/*.rb'
 
 Rails/HttpPositionalArguments:
   Description: 'Use keyword arguments instead of positional arguments in http method calls.'
@@ -576,7 +606,7 @@ Rails/I18nLazyLookup:
     - lazy
     - explicit
   Include:
-    - 'app/controllers/**/*.rb'
+    - '**/app/controllers/**/*.rb'
 
 Rails/I18nLocaleAssignment:
   Description: 'Prefer the usage of `I18n.with_locale` instead of manually updating `I18n.locale` value.'
@@ -605,8 +635,8 @@ Rails/IgnoredSkipActionFilterOption:
   Enabled: true
   VersionAdded: '0.63'
   Include:
-    - app/controllers/**/*.rb
-    - app/mailers/**/*.rb
+    - '**/app/controllers/**/*.rb'
+    - '**/app/mailers/**/*.rb'
 
 Rails/IndexBy:
   Description: 'Prefer `index_by` over `each_with_object`, `to_h`, or `map`.'
@@ -635,7 +665,7 @@ Rails/InverseOf:
   VersionAdded: '0.52'
   IgnoreScopes: false
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/LexicallyScopedActionFilter:
   Description: "Checks that methods specified in the filter's `only` or `except` options are explicitly defined in the class."
@@ -644,8 +674,8 @@ Rails/LexicallyScopedActionFilter:
   Safe: false
   VersionAdded: '0.52'
   Include:
-    - app/controllers/**/*.rb
-    - app/mailers/**/*.rb
+    - '**/app/controllers/**/*.rb'
+    - '**/app/mailers/**/*.rb'
 
 Rails/LinkToBlank:
   Description: 'Checks that `link_to` with a `target: "_blank"` have a `rel: "noopener"` option passed to them.'
@@ -663,7 +693,7 @@ Rails/MailerName:
   SafeAutoCorrect: false
   VersionAdded: '2.7'
   Include:
-    - app/mailers/**/*.rb
+    - '**/app/mailers/**/*.rb'
 
 Rails/MatchRoute:
   Description: >-
@@ -673,8 +703,8 @@ Rails/MatchRoute:
   Enabled: 'pending'
   VersionAdded: '2.7'
   Include:
-    - config/routes.rb
-    - config/routes/**/*.rb
+    - '**/config/routes.rb'
+    - '**/config/routes/**/*.rb'
 
 Rails/MigrationClassName:
   Description: 'The class name of the migration should match its file name.'
@@ -684,6 +714,15 @@ Rails/MigrationClassName:
   Include:
     - db/**/*.rb
 
+Rails/MultipleRoutePaths:
+  Description: 'Checks for mapping a route with multiple paths, which is deprecated and will be removed in Rails 8.1.'
+  Enabled: pending
+  Severity: warning
+  VersionAdded: '2.29'
+  Include:
+    - '**/config/routes.rb'
+    - '**/config/routes/**/*.rb'
+
 Rails/NegateInclude:
   Description: 'Prefer `collection.exclude?(obj)` over `!collection.include?(obj)`.'
   StyleGuide: 'https://rails.rubystyle.guide#exclude'
@@ -718,10 +757,10 @@ Rails/Output:
   VersionAdded: '0.15'
   VersionChanged: '0.19'
   Include:
-    - app/**/*.rb
-    - config/**/*.rb
+    - '**/app/**/*.rb'
+    - '**/config/**/*.rb'
     - db/**/*.rb
-    - lib/**/*.rb
+    - '**/lib/**/*.rb'
 
 Rails/OutputSafety:
   Description: 'The use of `html_safe` or `raw` may be a security risk.'
@@ -793,7 +832,7 @@ Rails/RakeEnvironment:
     - '**/Rakefile'
     - '**/*.rake'
   Exclude:
-    - 'lib/capistrano/tasks/**/*.rake'
+    - '**/lib/capistrano/tasks/**/*.rake'
 
 Rails/ReadWriteAttribute:
   Description: >-
@@ -804,7 +843,7 @@ Rails/ReadWriteAttribute:
   VersionAdded: '0.20'
   VersionChanged: '0.29'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/RedundantActiveRecordAllMethod:
   Description: Detect redundant `all` used as a receiver for Active Record query methods.
@@ -823,7 +862,7 @@ Rails/RedundantAllowNil:
   Enabled: true
   VersionAdded: '0.67'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/RedundantForeignKey:
   Description: 'Checks for associations where the `:foreign_key` option is redundant.'
@@ -994,7 +1033,7 @@ Rails/ScopeArgs:
   VersionAdded: '0.19'
   VersionChanged: '2.12'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/SelectMap:
   Description: 'Checks for uses of `select(:column_name)` with `map(&:column_name)`.'
@@ -1058,6 +1097,15 @@ Rails/StripHeredoc:
   Enabled: pending
   VersionAdded: '2.15'
 
+Rails/StrongParametersExpect:
+  Description: 'Enforces the use of `ActionController::Parameters#expect` as a method for strong parameter handling.'
+  Reference: 'https://api.rubyonrails.org/classes/ActionController/Parameters.html#method-i-expect'
+  Enabled: pending
+  Include:
+    - '**/app/controllers/**/*.rb'
+  SafeAutoCorrect: false
+  VersionAdded: '2.29'
+
 Rails/TableNameAssignment:
   Description: >-
     Do not use `self.table_name =`. Use Inflections or `table_name_prefix` instead.
@@ -1065,7 +1113,7 @@ Rails/TableNameAssignment:
   Enabled: false
   VersionAdded: '2.14'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/ThreeStateBooleanColumn:
   Description: 'Add a default value and a `NOT NULL` constraint to boolean columns.'
@@ -1149,7 +1197,7 @@ Rails/UniqueValidationWithoutIndex:
   Enabled: true
   VersionAdded: '2.5'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/UnknownEnv:
   Description: 'Use correct environment name.'
@@ -1168,7 +1216,7 @@ Rails/UnusedIgnoredColumns:
   VersionAdded: '2.11'
   VersionChanged: '2.25'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/UnusedRenderContent:
   Description: 'Do not specify body content for a response with a non-content status code.'
@@ -1182,15 +1230,15 @@ Rails/Validation:
   VersionAdded: '0.9'
   VersionChanged: '0.41'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/WhereEquals:
-  Description: 'Pass conditions to `where` as a hash instead of manually constructing SQL.'
+  Description: 'Pass conditions to `where` and `where.not` as a hash instead of manually constructing SQL.'
   StyleGuide: 'https://rails.rubystyle.guide/#hash-conditions'
   Enabled: 'pending'
   SafeAutoCorrect: false
   VersionAdded: '2.9'
-  VersionChanged: '2.10'
+  VersionChanged: '2.26'
 
 Rails/WhereExists:
   Description: 'Prefer `exists?(...)` over `where(...).exists?`.'
@@ -1234,6 +1282,10 @@ Rails/WhereRange:
 Style/AndOr:
   EnforcedStyle: conditionals
 
+Style/CollectionCompact:
+  AllowedReceivers:
+    - params
+
 Style/FormatStringToken:
   AllowedMethods:
     - redirect

data/lib/rubocop/cop/mixin/active_record_helper.rb

@@ -87,7 +87,7 @@ module RuboCop
 
         options.each_pair.find do |pair|
           next unless pair.key.sym_type? && pair.key.value == :foreign_key
-          next unless pair.value.sym_type? || pair.value.str_type?
+          next unless pair.value.type?(:sym, :str)
 
           break pair.value.value.to_s
         end
@@ -103,7 +103,7 @@ module RuboCop
       end
 
       def in_where?(node)
-        send_node = node.each_ancestor(:send, :csend).first
+        send_node = node.each_ancestor(:call).first
         return false unless send_node
 
         return true if WHERE_METHODS.include?(send_node.method_name)

data/lib/rubocop/cop/mixin/active_record_migrations_helper.rb

@@ -22,9 +22,9 @@ module RuboCop
       ].freeze
 
       def_node_matcher :create_table_with_block?, <<~PATTERN
-        (block
+        (any_block
           (send nil? :create_table ...)
-          (args (arg _var))
+          { _ | (args (arg _var)) }
           _)
       PATTERN
     end

data/lib/rubocop/cop/mixin/database_type_resolvable.rb

@@ -29,8 +29,8 @@ module RuboCop
       end
 
       def database_from_env
-        url = ENV['DATABASE_URL'].presence
-        return unless url
+        url = ENV.fetch('DATABASE_URL', '')
+        return if url.blank?
 
         case url
         when %r{\A(mysql2|trilogy)://}

data/lib/rubocop/cop/mixin/enforce_superclass.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
 module RuboCop
-  module Cop
+  module Cop # rubocop:disable Style/Documentation
+    # The EnforceSuperclass module is also defined in `rubocop` (for backwards
+    # compatibility), so here we remove it before (re)defining it, to avoid
+    # warnings about methods in the module being redefined.
+    remove_const(:EnforceSuperclass) if defined?(EnforceSuperclass)
+
     # Common functionality for enforcing a specific superclass.
     module EnforceSuperclass
       def self.included(base)