rubocop-rails 2.27.0 → 2.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a20ef13a67612f99cb522625350e57836511b07a2666b75a8cbc556620adf01
-  data.tar.gz: 436aaa2f094779e0101e17d2cb56f4a7bdd64fbf14360e9e22102be13da413af
+  metadata.gz: 758b691d39a36d50333d038d5efc0615f3da32aa8b47f0a465f684586b15463c
+  data.tar.gz: 8cf337b9a94306e55af10e5c7f0ee1e607fe22b27ca02cde32ece30e0c8c9bb5
 SHA512:
-  metadata.gz: 4d73f8ec4a0567acff57d0e39b267a24ee615e58d20114fa8fd37d5614ea2d4b3e6435c9ed34db322d7368086f9df150de0646c5e63cfd2987d0847dc3abd057
-  data.tar.gz: 93f42a0c60daec890a8cd363f588e37e5f65210d63dbb7e85e1c19cd32dc6459d6e593fbc3947b1cef832b981ca7b06bb5871c60cf6439a07e32c3df54257bcc
+  metadata.gz: b5841dbc4ae81e23e5eac1921e5752204e0c0dea5d17e0edd894329bd8d8764d0594b44a045f0d4f722d8b6927037f1b8817a1d29f444c75555ecd94feb8180d
+  data.tar.gz: 2adfb7937e87109d54e8fe596bc653528a62cfe87cebe7554ee1865a07daf5c3169fb7387bf6dacc59e71ee479ddd718c2775f2a1df573f5383b1f10fc27fd42

data/README.md

@@ -83,6 +83,22 @@ 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

@@ -25,6 +25,10 @@ AllCops:
   # 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/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/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

@@ -54,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/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/rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.27.0
+  version: 2.28.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -9,7 +9,7 @@ authors:
 - Yuji Nakayama
 bindir: bin
 cert_chain: []
-date: 2024-10-26 00:00:00.000000000 Z
+date: 2024-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -246,7 +246,7 @@ 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.27/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.28/
   bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []
@@ -263,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.6.1
 specification_version: 4
 summary: Automatic Rails code style checking tool.
 test_files: []