rubocop-rails 2.26.0 → 2.26.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c18cefb961b3100a871e2411c7a029244eda6998d793e3ece62aef1adcd4c571
-  data.tar.gz: 24cde448ef91e689e05a2357c1aa0cbcc4d61630f1bb6e7fcaf8999ff7678105
+  metadata.gz: c6d480f2ef30bba709b183d1a3b71dee6c0838ea2815975b5fd25ab5933277ad
+  data.tar.gz: 1d36f2779e44e1fa03437154f388bf2e865c3af810e0238f5ddc6580f024fd04
 SHA512:
-  metadata.gz: 7be18be7c11552f4a8d460e4833b57881ec3244d3abc7509ef3f9aa78533e3ff77e0ac60cd1737c608c8a724aed4b37fd1faed06ccb689aabf1e0a21970beef6
-  data.tar.gz: fb09716c5cb563cff4eaa33e68f0657424dce2650a9c7da8e37e6876ee8ee12a942ef2b096cb5604ee5a457a7f951dbd2198d290d0f5e0486c04b36e5a2679bc
+  metadata.gz: 5cc2521c185293872667eb2a23aaaadc4ddee8289b1f16c9fff1e6c87b9498708226a0147697acb9bcc3be69642c3f3ecc063b749056c0df1cdb065a224e4a3d
+  data.tar.gz: ea268a009b987a6f61008602d67a8e89659611b7469fe6c1b9c81825b5f9227391035866b2ec593e6109e91a470d607f6f4bb48fd11155b9177d59daf2301111

data/README.md

@@ -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

@@ -212,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.'

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

@@ -72,13 +72,13 @@ module RuboCop
           if (node = context.each_ancestor(:if, :rescue).first)
             return false if use_redirect_to?(context)
 
-            context = node.rescue_type? ? node.parent : node
+            context = node
+          elsif context.right_siblings.empty?
+            return true
           end
+          context = context.right_siblings
 
-          siblings = context.right_siblings
-          return true if siblings.empty?
-
-          siblings.compact.any? do |render_candidate|
+          context.compact.any? do |render_candidate|
             render?(render_candidate)
           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/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/compact_blank.rb

@@ -25,6 +25,8 @@ module RuboCop
       #   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
@@ -44,7 +46,8 @@ module RuboCop
         extend TargetRailsVersion
 
         MSG = 'Use `%<preferred_method>s` instead.'
-        RESTRICT_ON_SEND = %i[reject delete_if select keep_if].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
 
@@ -64,19 +67,20 @@ module RuboCop
 
         def_node_matcher :select_with_block?, <<~PATTERN
           (block
-            (send _ {:select :keep_if})
+            (send _ {:select :filter :keep_if})
             $(args ...)
             (send
               $(lvar _) :present?))
         PATTERN
 
         def_node_matcher :select_with_block_pass?, <<~PATTERN
-          (send _ {:select :keep_if}
+          (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)
@@ -120,7 +124,7 @@ module RuboCop
         end
 
         def preferred_method(node)
-          node.method?(:reject) || node.method?(:select) ? 'compact_blank' : 'compact_blank!'
+          DESTRUCTIVE_METHODS.include?(node.method_name) ? 'compact_blank!' : 'compact_blank'
         end
       end
     end

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

@@ -17,14 +17,19 @@ module RuboCop
       #
       class EnumSyntax < Base
         extend AutoCorrector
+        extend TargetRubyVersion
         extend TargetRailsVersion
 
+        minimum_target_ruby_version 3.0
         minimum_target_rails_version 7.0
 
         MSG = 'Enum defined with keyword arguments in `%<enum>s` enum declaration. Use positional arguments instead.'
         MSG_OPTIONS = 'Enum defined with deprecated options in `%<enum>s` enum declaration. Remove the `_` prefix.'
         RESTRICT_ON_SEND = %i[enum].freeze
-        OPTION_NAMES = %w[prefix suffix scopes default].freeze
+
+        # From https://github.com/rails/rails/blob/v7.2.1/activerecord/lib/active_record/enum.rb#L231
+        OPTION_NAMES = %w[prefix suffix scopes default instance_methods].freeze
+        UNDERSCORED_OPTION_NAMES = OPTION_NAMES.map { |option| "_#{option}" }.freeze
 
         def_node_matcher :enum?, <<~PATTERN
           (send nil? :enum (hash $...))
@@ -34,14 +39,6 @@ module RuboCop
           (send nil? :enum $_ ${array hash} $_)
         PATTERN
 
-        def_node_matcher :enum_values, <<~PATTERN
-          (pair $_ ${array hash})
-        PATTERN
-
-        def_node_matcher :enum_options, <<~PATTERN
-          (pair $_ $_)
-        PATTERN
-
         def on_send(node)
           check_and_correct_keyword_args(node)
           check_enum_options(node)
@@ -52,10 +49,9 @@ module RuboCop
         def check_and_correct_keyword_args(node)
           enum?(node) do |pairs|
             pairs.each do |pair|
-              key, values = enum_values(pair)
-              next unless key
+              next if option_key?(pair)
 
-              correct_keyword_args(node, key, values, pairs[1..])
+              correct_keyword_args(node, pair.key, pair.value, pairs[1..])
             end
           end
         end
@@ -63,9 +59,11 @@ module RuboCop
         def check_enum_options(node)
           enum_with_options?(node) do |key, _, options|
             options.children.each do |option|
-              name, = enum_options(option)
+              next unless option_key?(option)
 
-              add_offense(name, message: format(MSG_OPTIONS, enum: enum_name_value(key))) if name.source[0] == '_'
+              add_offense(option.key, message: format(MSG_OPTIONS, enum: enum_name_value(key))) do |corrector|
+                corrector.replace(option.key, option.key.source.delete_prefix('_'))
+              end
             end
           end
         end
@@ -107,6 +105,10 @@ module RuboCop
           end
         end
 
+        def option_key?(pair)
+          UNDERSCORED_OPTION_NAMES.include?(pair.key.source)
+        end
+
         def correct_options(options)
           corrected_options = options.map do |pair|
             name = if pair.key.source[0] == '_'

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

@@ -97,7 +97,7 @@ module RuboCop
           return unless node.arguments.any? { |e| rails_root_nodes?(e) }
 
           register_offense(node, require_to_s: true) do |corrector|
-            autocorrect_file_join(corrector, node)
+            autocorrect_file_join(corrector, node) unless node.first_argument.array_type?
           end
         end
 

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

@@ -11,7 +11,7 @@ module RuboCop
       #   3.day.ago
       #   1.months.ago
       #   5.megabyte
-      #   1.gigabyte
+      #   1.gigabytes
       #
       #   # good
       #   3.days.ago

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

@@ -98,8 +98,6 @@ module RuboCop
         end
 
         def on_or(node)
-          return unless cop_config['NilOrEmpty']
-
           exists_and_not_empty?(node) do |var1, var2|
             return unless var1 == var2
 

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

@@ -3,35 +3,6 @@
 module RuboCop
   module Cop
     module Rails
-      # TODO: In the future, please support only RuboCop 1.52+ and use `RuboCop::Cop::AllowedReceivers`:
-      #       https://github.com/rubocop/rubocop/blob/v1.52.0/lib/rubocop/cop/mixin/allowed_receivers.rb
-      #       At that time, this duplicated module implementation can be removed.
-      module AllowedReceivers
-        def allowed_receiver?(receiver)
-          receiver_name = receiver_name(receiver)
-
-          allowed_receivers.include?(receiver_name)
-        end
-
-        def receiver_name(receiver)
-          return receiver_name(receiver.receiver) if receiver.receiver && !receiver.receiver.const_type?
-
-          if receiver.send_type?
-            if receiver.receiver
-              "#{receiver_name(receiver.receiver)}.#{receiver.method_name}"
-            else
-              receiver.method_name.to_s
-            end
-          else
-            receiver.source
-          end
-        end
-
-        def allowed_receivers
-          cop_config.fetch('AllowedReceivers', [])
-        end
-      end
-
       # Detect redundant `all` used as a receiver for Active Record query methods.
       #
       # For the methods `delete_all` and `destroy_all`, this cop will only check cases where the receiver is a model.

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

@@ -40,7 +40,7 @@ module RuboCop
         def on_send(node)
           association_with_foreign_key(node) do |type, name, options, foreign_key_pair, foreign_key|
             if redundant?(node, type, name, options, foreign_key)
-              add_offense(foreign_key_pair.source_range) do |corrector|
+              add_offense(foreign_key_pair) do |corrector|
                 range = range_with_surrounding_space(foreign_key_pair.source_range, side: :left)
                 range = range_with_surrounding_comma(range, :left)
 

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

@@ -78,7 +78,7 @@ module RuboCop
 
           send_nodes.each do |send_node|
             receiver = send_node.receiver
-            add_offense(receiver.source_range) do |corrector|
+            add_offense(receiver) do |corrector|
               autocorrect(corrector, send_node, node)
             end
           end

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

@@ -43,7 +43,7 @@ module RuboCop
             return if reflection_class_name.value.send_type? && reflection_class_name.value.receiver.nil?
             return if reflection_class_name.value.lvar_type? && str_assigned?(reflection_class_name)
 
-            add_offense(reflection_class_name.source_range) do |corrector|
+            add_offense(reflection_class_name) do |corrector|
               autocorrect(corrector, reflection_class_name)
             end
           end

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

@@ -34,7 +34,7 @@ module RuboCop
           referer?(node) do
             return unless node.method?(wrong_method_name)
 
-            add_offense(node.source_range) do |corrector|
+            add_offense(node) do |corrector|
               corrector.replace(node, "request.#{style}")
             end
           end

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

@@ -23,6 +23,8 @@ module RuboCop
       #   File.binread(Rails.root.join('db', 'schema.rb'))
       #   File.write(Rails.root.join('db', 'schema.rb'), content)
       #   File.binwrite(Rails.root.join('db', 'schema.rb'), content)
+      #   Dir.glob(Rails.root.join('db', 'schema.rb'))
+      #   Dir[Rails.root.join('db', 'schema.rb')]
       #
       #   # good
       #   Rails.root.join('db', 'schema.rb').open
@@ -31,12 +33,13 @@ module RuboCop
       #   Rails.root.join('db', 'schema.rb').binread
       #   Rails.root.join('db', 'schema.rb').write(content)
       #   Rails.root.join('db', 'schema.rb').binwrite(content)
+      #   Rails.root.glob("db/schema.rb")
       #
       class RootPathnameMethods < Base # rubocop:disable Metrics/ClassLength
         extend AutoCorrector
         include RangeHelp
 
-        MSG = '`%<rails_root>s` is a `Pathname` so you can just append `#%<method>s`.'
+        MSG = '`%<rails_root>s` is a `Pathname`, so you can use `%<replacement>s`.'
 
         DIR_GLOB_METHODS = %i[[] glob].to_set.freeze
 
@@ -188,13 +191,14 @@ module RuboCop
 
         def on_send(node)
           evidence(node) do |method, path, args, rails_root|
-            add_offense(node, message: format(MSG, method: method, rails_root: rails_root.source)) do |corrector|
-              replacement = if dir_glob?(node)
-                              build_path_glob_replacement(path)
-                            else
-                              build_path_replacement(path, method, args)
-                            end
+            replacement = if dir_glob?(node)
+                            build_path_glob_replacement(path)
+                          else
+                            build_path_replacement(path, method, args)
+                          end
 
+            message = format(MSG, rails_root: rails_root.source, replacement: replacement)
+            add_offense(node, message: message) do |corrector|
               corrector.replace(node, replacement)
             end
           end

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

@@ -100,7 +100,8 @@ module RuboCop
         end
 
         def forbidden_methods
-          obsolete_result = cop_config['Blacklist']
+          # TODO: Remove when RuboCop Rails 3 releases.
+          obsolete_result = cop_config['Blacklist'] # rubocop:disable InternalAffairs/UndefinedConfig
           if obsolete_result
             warn '`Blacklist` has been renamed to `ForbiddenMethods`.' unless @displayed_forbidden_warning
             @displayed_forbidden_warning = true
@@ -111,7 +112,8 @@ module RuboCop
         end
 
         def allowed_methods
-          obsolete_result = cop_config['Whitelist']
+          # TODO: Remove when RuboCop Rails 3 releases.
+          obsolete_result = cop_config['Whitelist'] # rubocop:disable InternalAffairs/UndefinedConfig
           if obsolete_result
             warn '`Whitelist` has been renamed to `AllowedMethods`.' unless @displayed_allowed_warning
             @displayed_allowed_warning = true

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

@@ -74,6 +74,7 @@ module RuboCop
           range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
         end
 
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
         def extract_column_and_value(template_node, value_node)
           value =
             case template_node.value
@@ -90,8 +91,12 @@ module RuboCop
               return
             end
 
-          [Regexp.last_match(1), value]
+          column_qualifier = Regexp.last_match(1)
+          return if column_qualifier.count('.') > 1
+
+          [column_qualifier, value]
         end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
         def build_good_method(method_name, column, value)
           if column.include?('.')

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

@@ -68,6 +68,7 @@ module RuboCop
           range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
         end
 
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
         def extract_column_and_value(template_node, value_node)
           value =
             case template_node.value
@@ -84,8 +85,12 @@ module RuboCop
               return
             end
 
-          [Regexp.last_match(1), value]
+          column_qualifier = Regexp.last_match(1)
+          return if column_qualifier.count('.') > 1
+
+          [column_qualifier, value]
         end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
         def build_good_method(dot, column, value)
           dot ||= '.'

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

@@ -140,6 +140,8 @@ module RuboCop
                 rhs = pair2.value
               end
             end
+          else
+            return
           end
 
           if lhs
@@ -150,7 +152,10 @@ module RuboCop
             rhs_source = parentheses_needed?(rhs) ? "(#{rhs.source})" : rhs.source
           end
 
-          [Regexp.last_match(1), "#{lhs_source}#{operator}#{rhs_source}"] if operator
+          column_qualifier = Regexp.last_match(1)
+          return if column_qualifier.count('.') > 1
+
+          [column_qualifier, "#{lhs_source}#{operator}#{rhs_source}"] if operator
         end
         # rubocop:enable 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.0'
+      STRING = '2.26.2'
 
       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.26.0
+  version: 2.26.2
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-24 00:00:00.000000000 Z
+date: 2024-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -265,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Automatic Rails code style checking tool.