rubocop-rails 2.23.1 → 2.26.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f90e14aba3397c0edacdc63f7dd9d5b83ed7d79382041f5f37e3201dea96c3db
-  data.tar.gz: 31ebefe705b4148901128b2b5feb5948b737acdd5fae210f8da6cec845f17023
+  metadata.gz: c6d480f2ef30bba709b183d1a3b71dee6c0838ea2815975b5fd25ab5933277ad
+  data.tar.gz: 1d36f2779e44e1fa03437154f388bf2e865c3af810e0238f5ddc6580f024fd04
 SHA512:
-  metadata.gz: b90a96dae0688c93975260b480c2add1449c5ca21503a071453464f63ba030713501e1d20e2ea4fdf3385a58d1cf71003e2ede718ec9b6aa80e86e4a82be00a7
-  data.tar.gz: ad4ed3bbe86f2d1179766c512f347aaa21ea6e18e8af5a00f07eb20098c6c3c0103955ba4366bf952528773b7b2ff6a21af52369969227fd05233138a1060708
+  metadata.gz: 5cc2521c185293872667eb2a23aaaadc4ddee8289b1f16c9fff1e6c87b9498708226a0147697acb9bcc3be69642c3f3ecc063b749056c0df1cdb065a224e4a3d
+  data.tar.gz: ea268a009b987a6f61008602d67a8e89659611b7469fe6c1b9c81825b5f9227391035866b2ec593e6109e91a470d607f6f4bb48fd11155b9177d59daf2301111

data/README.md

@@ -1,7 +1,7 @@
 # RuboCop Rails
 
 [![Gem Version](https://badge.fury.io/rb/rubocop-rails.svg)](https://badge.fury.io/rb/rubocop-rails)
-[![CircleCI](https://circleci.com/gh/rubocop/rubocop-rails.svg?style=svg)](https://circleci.com/gh/rubocop/rubocop-rails)
+[![CI](https://github.com/rubocop/rubocop-rails/actions/workflows/test.yml/badge.svg)](https://github.com/rubocop/rubocop-rails/actions/workflows/test.yml)
 
 A [RuboCop](https://github.com/rubocop/rubocop) extension focused on enforcing Rails best practices and coding conventions.
 
@@ -65,7 +65,7 @@ end
 
 ## 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 +84,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

@@ -165,6 +165,7 @@ Rails/ActiveSupportOnLoad:
     - 'https://guides.rubyonrails.org/engines.html#available-load-hooks'
   SafeAutoCorrect: false
   VersionAdded: '2.16'
+  VersionChanged: '2.24'
 
 Rails/AddColumnIndex:
   Description: >-
@@ -211,7 +212,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.'
@@ -423,6 +426,14 @@ Rails/EnumHash:
   Include:
     - 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
@@ -445,9 +456,10 @@ Rails/EnvironmentVariableAccess:
   # TODO: Set to `pending` status in RuboCop Rails 2 series when migration doc will be written.
   Enabled: false
   VersionAdded: '2.10'
-  VersionChanged: '2.11'
+  VersionChanged: '2.24'
   Include:
     - app/**/*.rb
+    - config/initializers/**/*.rb
     - lib/**/*.rb
   Exclude:
     - lib/**/*.rake
@@ -691,7 +703,7 @@ Rails/NegateInclude:
   VersionChanged: '2.9'
 
 Rails/NotNullColumn:
-  Description: 'Do not add a NOT NULL column without a default value.'
+  Description: 'Do not add a NOT NULL column without a default value to existing tables.'
   Enabled: true
   VersionAdded: '0.43'
   VersionChanged: '2.20'
@@ -1016,8 +1028,9 @@ Rails/SkipsModelValidations:
                  See reference for more information.
   Reference: 'https://guides.rubyonrails.org/active_record_validations.html#skipping-validations'
   Enabled: true
+  Safe: false
   VersionAdded: '0.47'
-  VersionChanged: '2.7'
+  VersionChanged: '2.25'
   ForbiddenMethods:
     - decrement!
     - decrement_counter
@@ -1161,8 +1174,9 @@ Rails/UnknownEnv:
 
 Rails/UnusedIgnoredColumns:
   Description: 'Remove a column that does not exist from `ignored_columns`.'
-  Enabled: pending
+  Enabled: false
   VersionAdded: '2.11'
+  VersionChanged: '2.25'
   Include:
     - app/models/**/*.rb
 
@@ -1181,12 +1195,12 @@ Rails/Validation:
     - 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?`.'
@@ -1219,10 +1233,21 @@ Rails/WhereNotWithMultipleConditions:
   VersionAdded: '2.17'
   VersionChanged: '2.18'
 
+Rails/WhereRange:
+  Description: 'Use ranges in `where` instead of manually constructing SQL.'
+  StyleGuide: 'https://rails.rubystyle.guide/#where-ranges'
+  Enabled: pending
+  SafeAutoCorrect: false
+  VersionAdded: '2.25'
+
 # Accept `redirect_to(...) and return` and similar cases.
 Style/AndOr:
   EnforcedStyle: conditionals
 
+Style/CollectionCompact:
+  AllowedReceivers:
+    - params
+
 Style/FormatStringToken:
   AllowedMethods:
     - redirect

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

@@ -39,7 +39,12 @@ module RuboCop
       end
 
       def schema
-        RuboCop::Rails::SchemaLoader.load(target_ruby_version)
+        # For compatibility with RuboCop 1.61.0 or lower.
+        if respond_to?(:parser_engine)
+          RuboCop::Rails::SchemaLoader.load(target_ruby_version, parser_engine)
+        else
+          RuboCop::Rails::SchemaLoader.load(target_ruby_version, :parser_whitequark)
+        end
       end
 
       def table_name(class_node)

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

@@ -4,13 +4,40 @@ module RuboCop
   module Cop
     # Common functionality for checking target rails version.
     module TargetRailsVersion
+      # Informs the base RuboCop gem that it the Rails version is checked via `requires_gem` API,
+      # without needing to call this `#support_target_rails_version` method.
+      USES_REQUIRES_GEM_API = true
+
       def minimum_target_rails_version(version)
-        @minimum_target_rails_version = version
+        if respond_to?(:requires_gem)
+          case version
+          when Integer, Float then requires_gem(TARGET_GEM_NAME, ">= #{version}")
+          when String then requires_gem(TARGET_GEM_NAME, version)
+          end
+        else
+          # Fallback path for previous versions of RuboCop which don't support the `requires_gem` API yet.
+          @minimum_target_rails_version = version
+        end
       end
 
       def support_target_rails_version?(version)
-        @minimum_target_rails_version <= version
+        if respond_to?(:requires_gem)
+          return false unless gem_requirements
+
+          gem_requirement = gem_requirements[TARGET_GEM_NAME]
+          return true unless gem_requirement # If we have no requirement, then we support all versions
+
+          gem_requirement.satisfied_by?(Gem::Version.new(version))
+        else
+          # Fallback path for previous versions of RuboCop which don't support the `requires_gem` API yet.
+          @minimum_target_rails_version <= version
+        end
       end
+
+      # Look for `railties` instead of `rails`, to support apps that only use a subset of `rails`
+      # See https://github.com/rubocop/rubocop/pull/11289
+      TARGET_GEM_NAME = 'railties'
+      private_constant :TARGET_GEM_NAME
     end
   end
 end

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

@@ -99,6 +99,8 @@ module RuboCop
 
         def use_redirect_to?(context)
           context.right_siblings.compact.any? do |sibling|
+            # Unwrap `return redirect_to :index`
+            sibling = sibling.children.first if sibling.return_type? && sibling.children.one?
             sibling.send_type? && sibling.method?(:redirect_to)
           end
         end

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

@@ -92,11 +92,7 @@ module RuboCop
         end
 
         def range_with_comments(node)
-          # rubocop:todo InternalAffairs/LocationExpression
-          # Using `RuboCop::Ext::Comment#source_range` requires RuboCop > 1.46,
-          # which introduces https://github.com/rubocop/rubocop/pull/11630.
-          ranges = [node, *processed_source.ast_with_comments[node]].map { |comment| comment.loc.expression }
-          # rubocop:enable InternalAffairs/LocationExpression
+          ranges = [node, *processed_source.ast_with_comments[node]].map(&:source_range)
           ranges.reduce do |result, range|
             add_range(result, range)
           end

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

@@ -123,11 +123,7 @@ module RuboCop
         end
 
         def inline_comment?(comment)
-          # rubocop:todo InternalAffairs/LocationExpression
-          # Using `RuboCop::Ext::Comment#source_range` requires RuboCop > 1.46,
-          # which introduces https://github.com/rubocop/rubocop/pull/11630.
-          !comment_line?(comment.loc.expression.source_line)
-          # rubocop:enable InternalAffairs/LocationExpression
+          !comment_line?(comment.source_range.source_line)
         end
 
         def start_line_position(node)

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

@@ -55,15 +55,35 @@ module RuboCop
           'ActiveSupport::TestCase' => 'active_support_test_case'
         }.freeze
 
+        RAILS_5_2_LOAD_HOOKS = {
+          'ActiveRecord::ConnectionAdapters::SQLite3Adapter' => 'active_record_sqlite3adapter'
+        }.freeze
+
+        RAILS_7_1_LOAD_HOOKS = {
+          'ActiveRecord::TestFixtures' => 'active_record_fixtures',
+          'ActiveModel::Model' => 'active_model',
+          'ActionText::EncryptedRichText' => 'action_text_encrypted_rich_text',
+          'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter' => 'active_record_postgresqladapter',
+          'ActiveRecord::ConnectionAdapters::Mysql2Adapter' => 'active_record_mysql2adapter',
+          'ActiveRecord::ConnectionAdapters::TrilogyAdapter' => 'active_record_trilogyadapter'
+        }.freeze
+
         def on_send(node)
           receiver, method, arguments = *node # rubocop:disable InternalAffairs/NodeDestructuring
-          return unless receiver && (hook = LOAD_HOOKS[receiver.const_name])
+          return unless arguments && (hook = hook_for_const(receiver&.const_name))
 
           preferred = "ActiveSupport.on_load(:#{hook}) { #{method} #{arguments.source} }"
           add_offense(node, message: format(MSG, prefer: preferred, current: node.source)) do |corrector|
             corrector.replace(node, preferred)
           end
         end
+
+        def hook_for_const(const_name)
+          hook = LOAD_HOOKS[const_name]
+          hook ||= RAILS_5_2_LOAD_HOOKS[const_name] if target_rails_version >= 5.2
+          hook ||= RAILS_7_1_LOAD_HOOKS[const_name] if target_rails_version >= 7.1
+          hook
+        end
       end
     end
   end

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

@@ -5,6 +5,10 @@ module RuboCop
     module Rails
       # Checks that models subclass `ApplicationRecord` with Rails 5.0.
       #
+      # It is a common practice to define models inside migrations in order to retain forward
+      # compatibility by avoiding loading any application code. And so migration files are excluded
+      # by default for this cop.
+      #
       # @safety
       #   This cop's autocorrection is unsafe because it may let the logic from `ApplicationRecord`
       #   sneak into an Active Record model that is not purposed to inherit logic common among other

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

@@ -113,8 +113,10 @@ module RuboCop
         MYSQL_COMBINABLE_ALTER_METHODS = %i[rename_column add_index remove_index].freeze
 
         POSTGRESQL_COMBINABLE_TRANSFORMATIONS = %i[change_default].freeze
+        POSTGRESQL_COMBINABLE_TRANSFORMATIONS_SINCE_6_1 = %i[change_null].freeze
 
         POSTGRESQL_COMBINABLE_ALTER_METHODS = %i[change_column_default].freeze
+        POSTGRESQL_COMBINABLE_ALTER_METHODS_SINCE_6_1 = %i[change_column_null].freeze
 
         def on_def(node)
           return unless support_bulk_alter?
@@ -138,9 +140,9 @@ module RuboCop
           return unless support_bulk_alter?
           return unless node.command?(:change_table)
           return if include_bulk_options?(node)
-          return unless node.block_node
+          return unless (body = node.block_node&.body)
 
-          send_nodes = send_nodes_from_change_table_block(node.block_node.body)
+          send_nodes = send_nodes_from_change_table_block(body)
 
           add_offense_for_change_table(node) if count_transformations(send_nodes) > 1
         end
@@ -196,7 +198,9 @@ module RuboCop
           when MYSQL
             COMBINABLE_ALTER_METHODS + MYSQL_COMBINABLE_ALTER_METHODS
           when POSTGRESQL
-            COMBINABLE_ALTER_METHODS + POSTGRESQL_COMBINABLE_ALTER_METHODS
+            result = COMBINABLE_ALTER_METHODS + POSTGRESQL_COMBINABLE_ALTER_METHODS
+            result += POSTGRESQL_COMBINABLE_ALTER_METHODS_SINCE_6_1 if target_rails_version >= 6.1
+            result
           end
         end
 
@@ -205,7 +209,9 @@ module RuboCop
           when MYSQL
             COMBINABLE_TRANSFORMATIONS + MYSQL_COMBINABLE_TRANSFORMATIONS
           when POSTGRESQL
-            COMBINABLE_TRANSFORMATIONS + POSTGRESQL_COMBINABLE_TRANSFORMATIONS
+            result = COMBINABLE_TRANSFORMATIONS + POSTGRESQL_COMBINABLE_TRANSFORMATIONS
+            result += POSTGRESQL_COMBINABLE_TRANSFORMATIONS_SINCE_6_1 if target_rails_version >= 6.1
+            result
           end
         end
 

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

@@ -16,7 +16,6 @@ module RuboCop
       #   And `compact_blank!` has different implementations for `Array`, `Hash`, and
       #   `ActionController::Parameters`.
       #   `Array#compact_blank!`, `Hash#compact_blank!` are equivalent to `delete_if(&:blank?)`.
-      #   `ActionController::Parameters#compact_blank!` is equivalent to `reject!(&:blank?)`.
       #   If the cop makes a mistake, autocorrected code may get unexpected behavior.
       #
       # @example
@@ -24,6 +23,10 @@ module RuboCop
       #   # bad
       #   collection.reject(&:blank?)
       #   collection.reject { |_k, v| v.blank? }
+      #   collection.select(&:present?)
+      #   collection.select { |_k, v| v.present? }
+      #   collection.filter(&:present?)
+      #   collection.filter { |_k, v| v.present? }
       #
       #   # good
       #   collection.compact_blank
@@ -31,8 +34,8 @@ module RuboCop
       #   # bad
       #   collection.delete_if(&:blank?)            # Same behavior as `Array#compact_blank!` and `Hash#compact_blank!`
       #   collection.delete_if { |_k, v| v.blank? } # Same behavior as `Array#compact_blank!` and `Hash#compact_blank!`
-      #   collection.reject!(&:blank?)              # Same behavior as `ActionController::Parameters#compact_blank!`
-      #   collection.reject! { |_k, v| v.blank? }   # Same behavior as `ActionController::Parameters#compact_blank!`
+      #   collection.keep_if(&:present?)            # Same behavior as `Array#compact_blank!` and `Hash#compact_blank!`
+      #   collection.keep_if { |_k, v| v.present? } # Same behavior as `Array#compact_blank!` and `Hash#compact_blank!`
       #
       #   # good
       #   collection.compact_blank!
@@ -43,25 +46,41 @@ module RuboCop
         extend TargetRailsVersion
 
         MSG = 'Use `%<preferred_method>s` instead.'
-        RESTRICT_ON_SEND = %i[reject delete_if reject!].freeze
+        RESTRICT_ON_SEND = %i[reject delete_if select filter keep_if].freeze
+        DESTRUCTIVE_METHODS = %i[delete_if keep_if].freeze
 
         minimum_target_rails_version 6.1
 
         def_node_matcher :reject_with_block?, <<~PATTERN
           (block
-            (send _ {:reject :delete_if :reject!})
+            (send _ {:reject :delete_if})
             $(args ...)
             (send
               $(lvar _) :blank?))
         PATTERN
 
         def_node_matcher :reject_with_block_pass?, <<~PATTERN
-          (send _ {:reject :delete_if :reject!}
+          (send _ {:reject :delete_if}
             (block_pass
               (sym :blank?)))
         PATTERN
 
+        def_node_matcher :select_with_block?, <<~PATTERN
+          (block
+            (send _ {:select :filter :keep_if})
+            $(args ...)
+            (send
+              $(lvar _) :present?))
+        PATTERN
+
+        def_node_matcher :select_with_block_pass?, <<~PATTERN
+          (send _ {:select :filter :keep_if}
+            (block-pass
+              (sym :present?)))
+        PATTERN
+
         def on_send(node)
+          return if target_ruby_version < 2.6 && node.method?(:filter)
           return unless bad_method?(node)
 
           range = offense_range(node)
@@ -75,8 +94,10 @@ module RuboCop
 
         def bad_method?(node)
           return true if reject_with_block_pass?(node)
+          return true if select_with_block_pass?(node)
 
-          if (arguments, receiver_in_block = reject_with_block?(node.parent))
+          arguments, receiver_in_block = reject_with_block?(node.parent) || select_with_block?(node.parent)
+          if arguments
             return use_single_value_block_argument?(arguments, receiver_in_block) ||
                    use_hash_value_block_argument?(arguments, receiver_in_block)
           end
@@ -103,7 +124,7 @@ module RuboCop
         end
 
         def preferred_method(node)
-          node.method?(:reject) ? 'compact_blank' : 'compact_blank!'
+          DESTRUCTIVE_METHODS.include?(node.method_name) ? 'compact_blank!' : 'compact_blank'
         end
       end
     end

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

@@ -31,7 +31,7 @@ module RuboCop
           time
         ].to_set.freeze
 
-        # Generated from `ActiveRecord::AttributeMethods.dangerous_attribute_methods` on activerecord 7.1.0.
+        # Generated from `ActiveRecord::AttributeMethods.dangerous_attribute_methods` on activerecord 7.1.3.
         # rubocop:disable Metrics/CollectionLiteralLength
         DANGEROUS_COLUMN_NAMES = %w[
           __callbacks
@@ -290,7 +290,6 @@ module RuboCop
           new_record
           no_touching
           normalize_reflection_attribute
-          object_id
           partial_inserts
           partial_updates
           perform_validations

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

@@ -12,10 +12,10 @@ module RuboCop
       # The cop also reports warnings when you are using `to_time` method,
       # because it doesn't know about Rails time zone either.
       #
-      # Two styles are supported for this cop. When `EnforcedStyle` is 'strict'
+      # Two styles are supported for this cop. When `EnforcedStyle` is `strict`
       # then the Date methods `today`, `current`, `yesterday`, and `tomorrow`
       # are prohibited and the usage of both `to_time`
-      # and 'to_time_in_current_zone' are reported as warning.
+      # and `to_time_in_current_zone` are reported as warning.
       #
       # When `EnforcedStyle` is `flexible` then only `Date.today` is prohibited.
       #

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

@@ -12,6 +12,12 @@ module RuboCop
       #
       # @example
       #   # bad
+      #   enum :status, [:active, :archived]
+      #
+      #   # good
+      #   enum :status, { active: 0, archived: 1 }
+      #
+      #   # bad
       #   enum status: [:active, :archived]
       #
       #   # good
@@ -23,7 +29,11 @@ module RuboCop
         MSG = 'Enum defined as an array found in `%<enum>s` enum declaration. Use hash syntax instead.'
         RESTRICT_ON_SEND = %i[enum].freeze
 
-        def_node_matcher :enum?, <<~PATTERN
+        def_node_matcher :enum_with_array?, <<~PATTERN
+          (send nil? :enum $_ ${array} ...)
+        PATTERN
+
+        def_node_matcher :enum_with_old_syntax?, <<~PATTERN
           (send nil? :enum (hash $...))
         PATTERN
 
@@ -32,17 +42,19 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          enum?(node) do |pairs|
+          target_rails_version >= 7.0 && enum_with_array?(node) do |key, array|
+            add_offense(array, message: message(key)) do |corrector|
+              corrector.replace(array, build_hash(array))
+            end
+          end
+
+          enum_with_old_syntax?(node) do |pairs|
             pairs.each do |pair|
               key, array = array_pair?(pair)
               next unless key
 
-              add_offense(array, message: format(MSG, enum: enum_name(key))) do |corrector|
-                hash = array.children.each_with_index.map do |elem, index|
-                  "#{source(elem)} => #{index}"
-                end.join(', ')
-
-                corrector.replace(array, "{#{hash}}")
+              add_offense(array, message: message(key)) do |corrector|
+                corrector.replace(array, build_hash(array))
               end
             end
           end
@@ -50,6 +62,10 @@ module RuboCop
 
         private
 
+        def message(key)
+          format(MSG, enum: enum_name(key))
+        end
+
         def enum_name(key)
           case key.type
           when :sym, :str
@@ -69,6 +85,13 @@ module RuboCop
             elem.source
           end
         end
+
+        def build_hash(array)
+          hash = array.children.each_with_index.map do |elem, index|
+            "#{source(elem)} => #{index}"
+          end.join(', ')
+          "{#{hash}}"
+        end
       end
     end
   end