rubocop-rails 2.30.2 → 2.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69854cebe11dde8160c57b94c6ebbe60e7df48c1357aae64b932f73bb2f230ad
-  data.tar.gz: 04b388703ccde52554cb01f0e04a50291beada4dec9199fbb46b3dd750d8a4ff
+  metadata.gz: 3a61be89f227c5abed6543c4fb84957391ac66fdbadc7f7891a1876b7be0c193
+  data.tar.gz: f2e30c0c3e5a5cac32bae9ec0900a0e1fc382dda89f764f8a844b085ad2abffb
 SHA512:
-  metadata.gz: 79fda1fbb14ab98b4472576b7cb776294f3c46eb56c3b0751e47c5fba308615b4f1579a41ea3b14a8c2fb22e19e693ea1e615fe48c5d9fff6f8c857ef887a53f
-  data.tar.gz: f219f779b57f3ecd44937c02e85872058b453bdd7ce5c83cc1d6ac05175b2c93c01d2548a02c9b46ca26bc2dca6af116611a9d9595d81b53e5a165e47a8b6cf4
+  metadata.gz: 8610629e8893c71c21d591cc68897f993699f20edab9cda08a18ce65d9bf67ac153830dffa144e18b2d9e4e204027684c18cbb02e822d01c9c40e35312709083
+  data.tar.gz: f7dc418f1cb2f4a38968b9a79ae17028368e10f2d529cba2de15954a2edc5c3f8ebf7bb35617b670cf7e8dab758ccb138c0387a0fd6caa31051ee5e803925c35

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
 

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
@@ -77,6 +77,26 @@ 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
+
+Lint/UselessMethodDefinition:
+  # Avoids conflict with `Rails/LexicallyScopedActionFilter` cop.
+  Exclude:
+    - '**/app/controllers/**/*.rb'
+    - '**/app/mailers/**/*.rb'
+
 Rails:
   Enabled: true
   DocumentationBaseURL: https://docs.rubocop.org/rubocop-rails
@@ -107,8 +127,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.'
@@ -123,7 +143,7 @@ Rails/ActionOrder:
     - update
     - destroy
   Include:
-    - app/controllers/**/*.rb
+    - '**/app/controllers/**/*.rb'
 
 Rails/ActiveRecordAliases:
   Description: >-
@@ -140,7 +160,7 @@ Rails/ActiveRecordCallbacksOrder:
   Enabled: 'pending'
   VersionAdded: '2.7'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/ActiveRecordOverride:
   Description: >-
@@ -151,7 +171,7 @@ Rails/ActiveRecordOverride:
   VersionAdded: '0.67'
   VersionChanged: '2.18'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/ActiveSupportAliases:
   Description: >-
@@ -238,7 +258,7 @@ Rails/AttributeDefaultBlockValue:
   Enabled: pending
   VersionAdded: '2.9'
   Include:
-    - 'app/models/**/*'
+    - '**/app/models/**/*'
 
 Rails/BelongsTo:
   Description: >-
@@ -297,8 +317,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: >-
@@ -353,11 +373,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.'
@@ -428,7 +450,7 @@ 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.'
@@ -436,14 +458,15 @@ Rails/EnumSyntax:
   Severity: warning
   VersionAdded: '2.26'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
+    - '**/lib/**/*.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?`.'
@@ -462,11 +485,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
 
@@ -478,11 +501,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.'
@@ -516,6 +539,13 @@ Rails/FindById:
   Enabled: 'pending'
   VersionAdded: '2.7'
 
+Rails/FindByOrAssignmentMemoization:
+  Description: 'Avoid memoizing `find_by` results with `||=`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#find-by-memoization'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '2.33'
+
 Rails/FindEach:
   Description: 'Prefer all.find_each over all.each.'
   StyleGuide: 'https://rails.rubystyle.guide#find-each'
@@ -544,7 +574,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.'
@@ -552,14 +582,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.'
@@ -590,7 +620,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.'
@@ -619,8 +649,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`.'
@@ -631,8 +661,9 @@ Rails/IndexBy:
 Rails/IndexWith:
   Description: 'Prefer `index_with` over `each_with_object`, `to_h`, or `map`.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '2.5'
-  VersionChanged: '2.8'
+  VersionChanged: '2.33'
 
 Rails/Inquiry:
   Description: "Prefer Ruby's comparison operators over Active Support's `Array#inquiry` and `String#inquiry`."
@@ -649,7 +680,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."
@@ -658,8 +689,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.'
@@ -677,7 +708,7 @@ Rails/MailerName:
   SafeAutoCorrect: false
   VersionAdded: '2.7'
   Include:
-    - app/mailers/**/*.rb
+    - '**/app/mailers/**/*.rb'
 
 Rails/MatchRoute:
   Description: >-
@@ -687,8 +718,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.'
@@ -704,8 +735,8 @@ Rails/MultipleRoutePaths:
   Severity: warning
   VersionAdded: '2.29'
   Include:
-    - config/routes.rb
-    - config/routes/**/*.rb
+    - '**/config/routes.rb'
+    - '**/config/routes/**/*.rb'
 
 Rails/NegateInclude:
   Description: 'Prefer `collection.exclude?(obj)` over `!collection.include?(obj)`.'
@@ -726,6 +757,13 @@ Rails/NotNullColumn:
   Include:
     - db/**/*.rb
 
+Rails/OrderArguments:
+  Description: 'Prefer symbol arguments over strings in `order` method.'
+  StyleGuide: 'https://rails.rubystyle.guide/#order-arguments'
+  Enabled: pending
+  VersionAdded: '2.33'
+  Safe: false
+
 Rails/OrderById:
   Description: >-
                   Do not use the `id` column for ordering.
@@ -741,10 +779,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.'
@@ -816,7 +854,7 @@ Rails/RakeEnvironment:
     - '**/Rakefile'
     - '**/*.rake'
   Exclude:
-    - 'lib/capistrano/tasks/**/*.rake'
+    - '**/lib/capistrano/tasks/**/*.rake'
 
 Rails/ReadWriteAttribute:
   Description: >-
@@ -827,7 +865,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.
@@ -846,7 +884,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.'
@@ -1017,7 +1055,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)`.'
@@ -1086,7 +1124,7 @@ Rails/StrongParametersExpect:
   Reference: 'https://api.rubyonrails.org/classes/ActionController/Parameters.html#method-i-expect'
   Enabled: pending
   Include:
-    - app/controllers/**/*.rb
+    - '**/app/controllers/**/*.rb'
   SafeAutoCorrect: false
   VersionAdded: '2.29'
 
@@ -1097,7 +1135,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.'
@@ -1110,7 +1148,7 @@ Rails/ThreeStateBooleanColumn:
 Rails/TimeZone:
   Description: 'Checks the correct usage of time zone aware methods.'
   StyleGuide: 'https://rails.rubystyle.guide#time'
-  Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
+  Reference: 'https://danilenko.org/2012/7/6/rails_timezones'
   Enabled: true
   SafeAutoCorrect: false
   VersionAdded: '0.30'
@@ -1181,7 +1219,7 @@ Rails/UniqueValidationWithoutIndex:
   Enabled: true
   VersionAdded: '2.5'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/UnknownEnv:
   Description: 'Use correct environment name.'
@@ -1200,7 +1238,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.'
@@ -1214,7 +1252,7 @@ Rails/Validation:
   VersionAdded: '0.9'
   VersionChanged: '0.41'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/WhereEquals:
   Description: 'Pass conditions to `where` and `where.not` as a hash instead of manually constructing SQL.'

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

@@ -103,10 +103,10 @@ 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)
+        return true if WHERE_METHODS.include?(send_node.method_name) && send_node.receiver != node
 
         receiver = send_node.receiver
         return false unless receiver&.send_type?

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)

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

@@ -58,7 +58,7 @@ module RuboCop
         end
 
         def set_new_arg_name(transformed_argname, corrector)
-          return if block_node.numblock_type?
+          return unless block_node.block_type?
 
           corrector.replace(block_node.arguments, "|#{transformed_argname}|")
         end
@@ -84,6 +84,7 @@ module RuboCop
       end
 
       alias on_numblock on_block
+      alias on_itblock on_block
 
       def on_send(node)
         on_bad_map_to_h(node) do |*match|
@@ -131,9 +132,13 @@ module RuboCop
         add_offense(
           node, message: "Prefer `#{new_method_name}` over `#{match_desc}`."
         ) do |corrector|
+          next if part_of_ignored_node?(node)
+
           correction = prepare_correction(node)
           execute_correction(corrector, node, correction)
         end
+
+        ignore_node(node)
       end
 
       def extract_captures(match)

data/lib/rubocop/cop/rails/arel_star.rb

@@ -5,14 +5,14 @@ module RuboCop
     module Rails
       # Prevents usage of `"*"` on an Arel::Table column reference.
       #
-      # Using `arel_table["*"]` causes the outputted string to be a literal
-      # quoted asterisk (e.g. <tt>`my_model`.`*`</tt>). This causes the
-      # database to look for a column named <tt>`*`</tt> (or `"*"`) as opposed
+      # Using `arel_table["\*"]` causes the outputted string to be a literal
+      # quoted asterisk (e.g. `my_model`.`*`). This causes the
+      # database to look for a column named `\*` (or `"*"`) as opposed
       # to expanding the column list as one would likely expect.
       #
       # @safety
-      #   This cop's autocorrection is unsafe because it turns a quoted `*` into
-      #   an SQL `*`, unquoted. `*` is a valid column name in certain databases
+      #   This cop's autocorrection is unsafe because it turns a quoted `\*` into
+      #   an SQL `*`, unquoted. `\*` is a valid column name in certain databases
       #   supported by Rails, and even though it is usually a mistake,
       #   it might denote legitimate access to a column named `*`.
       #

data/lib/rubocop/cop/rails/delegate.rb

@@ -15,6 +15,9 @@ module RuboCop
       # without using the `delegate` method will be a violation.
       # When set to `false`, this case is legal.
       #
+      # It is disabled for controllers in order to keep controller actions
+      # explicitly defined.
+      #
       # @example
       #   # bad
       #   def bar
@@ -73,7 +76,7 @@ module RuboCop
 
         def on_def(node)
           return unless trivial_delegate?(node)
-          return if private_or_protected_delegation(node)
+          return if private_or_protected_delegation?(node)
           return if module_function_declared?(node)
 
           register_offense(node)
@@ -160,8 +163,8 @@ module RuboCop
           end
         end
 
-        def private_or_protected_delegation(node)
-          private_or_protected_inline(node) || node_visibility(node) != :public
+        def private_or_protected_delegation?(node)
+          private_or_protected_inline?(node) || node_visibility(node) != :public
         end
 
         def module_function_declared?(node)
@@ -170,7 +173,7 @@ module RuboCop
           end
         end
 
-        def private_or_protected_inline(node)
+        def private_or_protected_inline?(node)
           processed_source[node.first_line - 1].strip.match?(/\A(private )|(protected )/)
         end
       end

data/lib/rubocop/cop/rails/duplicate_association.rb

@@ -94,7 +94,7 @@ module RuboCop
           filtered_nodes = association_nodes.reject { |node| node.method?(:belongs_to) }
           grouped_associations = filtered_nodes.group_by do |node|
             arguments = association(node).last
-            next unless arguments.count == 1
+            next unless arguments.one?
 
             if (class_name = class_name(arguments.first))
               class_name.source

data/lib/rubocop/cop/rails/eager_evaluation_log_message.rb

@@ -45,12 +45,10 @@ module RuboCop
           return if node.parent&.block_type?
 
           interpolated_string_passed_to_debug(node) do |arguments|
-            message = format(MSG)
-
             range = replacement_range(node)
             replacement = replacement_source(node, arguments)
 
-            add_offense(range, message: message) do |corrector|
+            add_offense(range) do |corrector|
               corrector.replace(range, replacement)
             end
           end