rubocop-rails 2.26.2 → 2.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6d480f2ef30bba709b183d1a3b71dee6c0838ea2815975b5fd25ab5933277ad
-  data.tar.gz: 1d36f2779e44e1fa03437154f388bf2e865c3af810e0238f5ddc6580f024fd04
+  metadata.gz: 758b691d39a36d50333d038d5efc0615f3da32aa8b47f0a465f684586b15463c
+  data.tar.gz: 8cf337b9a94306e55af10e5c7f0ee1e607fe22b27ca02cde32ece30e0c8c9bb5
 SHA512:
-  metadata.gz: 5cc2521c185293872667eb2a23aaaadc4ddee8289b1f16c9fff1e6c87b9498708226a0147697acb9bcc3be69642c3f3ecc063b749056c0df1cdb065a224e4a3d
-  data.tar.gz: ea268a009b987a6f61008602d67a8e89659611b7469fe6c1b9c81825b5f9227391035866b2ec593e6109e91a470d607f6f4bb48fd11155b9177d59daf2301111
+  metadata.gz: b5841dbc4ae81e23e5eac1921e5752204e0c0dea5d17e0edd894329bd8d8764d0594b44a045f0d4f722d8b6927037f1b8817a1d29f444c75555ecd94feb8180d
+  data.tar.gz: 2adfb7937e87109d54e8fe596bc653528a62cfe87cebe7554ee1865a07daf5c3169fb7387bf6dacc59e71ee479ddd718c2775f2a1df573f5383b1f10fc27fd42

data/README.md

@@ -63,6 +63,42 @@ RuboCop::RakeTask.new do |task|
 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
 
 In Rails 6.1+, add the following `config.generators.after_generate` setting to

data/config/default.yml

@@ -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: ~
 
 Lint/NumberConversion:
   # Add Rails' duration methods to the ignore list for `Lint/NumberConversion`

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

@@ -21,6 +21,35 @@ module RuboCop
           migration_class?(class_node)
         end
       end
+
+      # rubocop:disable Style/DocumentDynamicEvalDefinition
+      %i[on_send on_csend on_block on_numblock on_class].each do |method|
+        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+          def #{method}(node)
+            return if already_migrated_file?
+
+            super if method(__method__).super_method
+          end
+        RUBY
+      end
+      # rubocop:enable Style/DocumentDynamicEvalDefinition
+
+      private
+
+      def already_migrated_file?
+        return false unless migrated_schema_version
+
+        match_data = File.basename(processed_source.file_path).match(/(?<timestamp>\d{14})/)
+        schema_version = match_data['timestamp'] if match_data
+
+        return false unless schema_version
+
+        schema_version <= migrated_schema_version.to_s # Ignore applied migration files.
+      end
+
+      def migrated_schema_version
+        config.for_all_cops.fetch('MigratedSchemaVersion', nil)
+      end
     end
   end
 end

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

@@ -7,6 +7,9 @@ module RuboCop
       # 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
+      # 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' # :nodoc:
 
       def minimum_target_rails_version(version)
         if respond_to?(:requires_gem)
@@ -33,11 +36,6 @@ module RuboCop
           @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/add_column_index.rb

@@ -19,6 +19,7 @@ module RuboCop
       class AddColumnIndex < Base
         extend AutoCorrector
         include RangeHelp
+        prepend MigrationsHelper
 
         MSG = '`add_column` does not accept an `index` key, use `add_index` instead.'
         RESTRICT_ON_SEND = %i[add_column].freeze

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

@@ -65,6 +65,7 @@ module RuboCop
       #   end
       class BulkChangeTable < Base
         include DatabaseTypeResolvable
+        prepend MigrationsHelper
 
         MSG_FOR_CHANGE_TABLE = <<~MSG.chomp
           You can combine alter queries using `bulk: true` options.

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

@@ -14,6 +14,8 @@ module RuboCop
       #   # good
       #   add_column :users, :saved
       class DangerousColumnNames < Base # rubocop:disable Metrics/ClassLength
+        prepend MigrationsHelper
+
         COLUMN_TYPE_METHOD_NAMES = %i[
           bigint
           binary

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

@@ -106,6 +106,8 @@ module RuboCop
         end
 
         def option_key?(pair)
+          return false unless pair.respond_to?(:key)
+
           UNDERSCORED_OPTION_NAMES.include?(pair.key.source)
         end
 

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

@@ -19,20 +19,33 @@ module RuboCop
         extend TargetRailsVersion
 
         MSG = 'Use `Rails.env.local?` instead.'
+        MSG_NEGATED = 'Use `!Rails.env.local?` instead.'
         LOCAL_ENVIRONMENTS = %i[development? test?].to_set.freeze
 
         minimum_target_rails_version 7.1
 
-        # @!method rails_env_local_candidate?(node)
-        def_node_matcher :rails_env_local_candidate?, <<~PATTERN
+        # @!method rails_env_local_or?(node)
+        def_node_matcher :rails_env_local_or?, <<~PATTERN
           (or
             (send (send (const {cbase nil? } :Rails) :env) $%LOCAL_ENVIRONMENTS)
             (send (send (const {cbase nil? } :Rails) :env) $%LOCAL_ENVIRONMENTS)
           )
         PATTERN
 
+        # @!method rails_env_local_and?(node)
+        def_node_matcher :rails_env_local_and?, <<~PATTERN
+          (and
+            (send
+              (send (send (const {cbase nil? } :Rails) :env) $%LOCAL_ENVIRONMENTS)
+              :!)
+            (send
+              (send (send (const {cbase nil? } :Rails) :env) $%LOCAL_ENVIRONMENTS)
+              :!)
+          )
+        PATTERN
+
         def on_or(node)
-          rails_env_local_candidate?(node) do |*environments|
+          rails_env_local_or?(node) do |*environments|
             next unless environments.to_set == LOCAL_ENVIRONMENTS
 
             add_offense(node) do |corrector|
@@ -40,6 +53,16 @@ module RuboCop
             end
           end
         end
+
+        def on_and(node)
+          rails_env_local_and?(node) do |*environments|
+            next unless environments.to_set == LOCAL_ENVIRONMENTS
+
+            add_offense(node, message: MSG_NEGATED) do |corrector|
+              corrector.replace(node, '!Rails.env.local?')
+            end
+          end
+        end
       end
     end
   end

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

@@ -66,6 +66,8 @@ module RuboCop
 
         def on_send(node)
           check_for_file_join_with_rails_root(node)
+          return unless node.receiver
+
           check_for_rails_root_join_with_slash_separated_path(node)
           check_for_rails_root_join_with_string_arguments(node)
         end
@@ -76,6 +78,7 @@ module RuboCop
           rails_root_index = find_rails_root_index(node)
           slash_node = node.children[rails_root_index + 1]
           return unless slash_node&.str_type? && slash_node.source.start_with?(File::SEPARATOR)
+          return unless node.children[rails_root_index].children.first.send_type?
 
           register_offense(node, require_to_s: false) do |corrector|
             autocorrect_slash_after_rails_root_in_dstr(corrector, node, rails_root_index)

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

@@ -20,7 +20,7 @@ module RuboCop
       #
       class MigrationClassName < Base
         extend AutoCorrector
-        include MigrationsHelper
+        prepend MigrationsHelper
 
         MSG = 'Replace with `%<camelized_basename>s` that matches the file name.'
 

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

@@ -41,6 +41,7 @@ module RuboCop
       #   change_column_null :products, :category_id, false
       class NotNullColumn < Base
         include DatabaseTypeResolvable
+        prepend MigrationsHelper
 
         MSG = 'Do not add a NOT NULL column without a default value.'
         RESTRICT_ON_SEND = %i[add_column add_reference].freeze

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

@@ -9,6 +9,24 @@ module RuboCop
       # element in an enumerable. When called on an Active Record relation, it
       # results in a more efficient query that only selects the necessary key.
       #
+      # NOTE: If the receiver's relation is not loaded and `pluck` is used inside an iteration,
+      # it may result in N+1 queries because `pluck` queries the database on each iteration.
+      # This cop ignores offenses for `map/collect` when they are suspected to be part of an iteration
+      # to prevent such potential issues.
+      #
+      # [source,ruby]
+      # ----
+      # users = User.all
+      # 5.times do
+      #   users.map { |user| user[:foo] } # Only one query is executed
+      # end
+      #
+      # users = User.all
+      # 5.times do
+      #   users.pluck(:id) # A query is executed on every iteration
+      # end
+      # ----
+      #
       # @safety
       #   This cop is unsafe because model can use column aliases.
       #
@@ -42,6 +60,8 @@ module RuboCop
         PATTERN
 
         def on_block(node)
+          return if node.each_ancestor(:block, :numblock).any?
+
           pluck_candidate?(node) do |argument, key|
             next if key.regexp_type? || !use_one_block_argument?(argument)
 

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

@@ -174,7 +174,7 @@ module RuboCop
           parent = node.parent
           return false unless POSSIBLE_ENUMERABLE_BLOCK_METHODS.include?(parent.method_name)
 
-          parent.parent&.block_type? || parent.parent&.numblock_type? || parent.first_argument&.block_pass_type?
+          parent.block_literal? || parent.first_argument&.block_pass_type?
         end
 
         def sensitive_association_method?(node)

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

@@ -151,7 +151,7 @@ module RuboCop
       #     remove_index :users, column: :email
       #   end
       class ReversibleMigration < Base
-        include MigrationsHelper
+        prepend MigrationsHelper
 
         MSG = '%<action>s is not reversible.'
 

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

@@ -43,7 +43,7 @@ module RuboCop
       #     end
       #   end
       class ReversibleMigrationMethodDefinition < Base
-        include MigrationsHelper
+        prepend MigrationsHelper
 
         MSG = 'Migrations must contain either a `change` method, or both an `up` and a `down` method.'
 

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

@@ -244,7 +244,7 @@ module RuboCop
         end
 
         def operator_or_single_negative?(node)
-          node.or_type? || node.and_type? || single_negative?(node)
+          node.operator_keyword? || single_negative?(node)
         end
 
         def conditional?(parent)

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

@@ -23,6 +23,7 @@ module RuboCop
       #
       class SchemaComment < Base
         include ActiveRecordMigrationsHelper
+        prepend MigrationsHelper
 
         COLUMN_MSG = 'New database column without `comment`.'
         TABLE_MSG = 'New database table without `comment`.'

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

@@ -40,12 +40,13 @@ module RuboCop
             autocorrect(corrector, select_node, node, preferred_method)
           end
         end
+        alias on_csend on_send
 
         private
 
         def find_select_node(node, column_name)
           node.descendants.detect do |select_candidate|
-            next if !select_candidate.send_type? || !select_candidate.method?(:select)
+            next if !select_candidate.call_type? || !select_candidate.method?(:select)
 
             match_column_name?(select_candidate, column_name)
           end
@@ -53,7 +54,7 @@ module RuboCop
 
         # rubocop:disable Metrics/AbcSize
         def autocorrect(corrector, select_node, node, preferred_method)
-          corrector.remove(select_node.loc.dot || node.loc.dot)
+          corrector.remove(select_node.parent.loc.dot)
           corrector.remove(select_node.loc.selector.begin.join(select_node.source_range.end))
           corrector.replace(node.loc.selector.begin.join(node.source_range.end), preferred_method)
         end

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

@@ -68,7 +68,7 @@ module RuboCop
         end
 
         def using_squish?(node)
-          node.parent&.send_type? && node.parent&.method?(:squish)
+          node.parent&.send_type? && node.parent.method?(:squish)
         end
 
         def singleline_comments_present?(node)

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

@@ -18,8 +18,9 @@ module RuboCop
       #   t.boolean :active, default: true, null: false
       #
       class ThreeStateBooleanColumn < Base
-        MSG = 'Boolean columns should always have a default value and a `NOT NULL` constraint.'
+        prepend MigrationsHelper
 
+        MSG = 'Boolean columns should always have a default value and a `NOT NULL` constraint.'
         RESTRICT_ON_SEND = %i[add_column column boolean].freeze
 
         def_node_matcher :three_state_boolean?, <<~PATTERN

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

@@ -28,6 +28,8 @@ module RuboCop
       #   Time.zone.now
       #   Time.zone.parse('2015-03-02T19:05:37')
       #   Time.zone.parse('2015-03-02T19:05:37Z') # Respect ISO 8601 format with timezone specifier.
+      #   Time.parse('2015-03-02T19:05:37Z') # Also respects ISO 8601
+      #   '2015-03-02T19:05:37Z'.to_time # Also respects ISO 8601
       #
       # @example EnforcedStyle: flexible (default)
       #   # `flexible` allows usage of `in_time_zone` instead of `zone`.
@@ -67,6 +69,7 @@ module RuboCop
 
         def on_send(node)
           return if !node.receiver&.str_type? || !node.method?(:to_time)
+          return if attach_timezone_specifier?(node.receiver)
 
           add_offense(node.loc.selector, message: MSG_STRING_TO_TIME) do |corrector|
             corrector.replace(node, "Time.zone.parse(#{node.receiver.source})") unless node.csend_type?

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

@@ -15,6 +15,10 @@ module RuboCop
       #
       # If you are defining custom transaction methods, you can configure it with `TransactionMethods`.
       #
+      # NOTE: This cop is disabled on Rails >= 7.2 because transactions were restored
+      # to their historical behavior. In Rails 7.1, the behavior is controlled with
+      # the config `active_record.commit_transaction_on_non_local_return`.
+      #
       # @example
       #   # bad
       #   ApplicationRecord.transaction do
@@ -76,6 +80,7 @@ module RuboCop
         PATTERN
 
         def on_send(node)
+          return if target_rails_version >= 7.2
           return unless in_transaction_block?(node)
 
           exit_statements(node.parent.body).each do |statement_node|

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

@@ -89,7 +89,7 @@ module RuboCop
 
         def where_not?(node)
           receiver = node.receiver
-          receiver&.send_type? && receiver&.method?(:where)
+          receiver&.send_type? && receiver.method?(:where)
         end
 
         # rubocop:disable Metrics

data/lib/rubocop/rails/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Rails
     # This module holds the RuboCop Rails version information.
     module Version
-      STRING = '2.26.2'
+      STRING = '2.28.0'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.26.2
+  version: 2.28.0
 platform: ruby
 authors:
 - Bozhidar Batsov
 - Jonas Arvidsson
 - Yuji Nakayama
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-21 00:00:00.000000000 Z
+date: 2024-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -247,10 +246,9 @@ metadata:
   homepage_uri: https://docs.rubocop.org/rubocop-rails/
   changelog_uri: https://github.com/rubocop/rubocop-rails/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop-rails/
-  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.26/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.28/
   bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -265,8 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.1
 specification_version: 4
 summary: Automatic Rails code style checking tool.
 test_files: []