rubocop-rails 2.26.1 → 2.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5544e111596dd242dd77d44afe7e6999d1c339d3d6f6a03187a148495c836d1
-  data.tar.gz: 7da9bdcc53ee453774708dadfd1df0d1913736f78288781fa50ebfd465cc4042
+  metadata.gz: 8a20ef13a67612f99cb522625350e57836511b07a2666b75a8cbc556620adf01
+  data.tar.gz: 436aaa2f094779e0101e17d2cb56f4a7bdd64fbf14360e9e22102be13da413af
 SHA512:
-  metadata.gz: b9677c9549dc593121b1832432afdc18cc1b6f47435d4b4a39f4bc2e73ebb660252cd747dd0deaa0fe293d9e4c165467aad80115b1306e007d33d1c2c151ecbb
-  data.tar.gz: 1508e3913f537195067ff8129845729251043ad7bedea2c19879c24882036f2d15b31c0af6178d91dd64d21f5d7468460e9e3fbacb2ce4e499be76a03efb59dd
+  metadata.gz: 4d73f8ec4a0567acff57d0e39b267a24ee615e58d20114fa8fd37d5614ea2d4b3e6435c9ed34db322d7368086f9df150de0646c5e63cfd2987d0847dc3abd057
+  data.tar.gz: 93f42a0c60daec890a8cd363f588e37e5f65210d63dbb7e85e1c19cd32dc6459d6e593fbc3947b1cef832b981ca7b06bb5871c60cf6439a07e32c3df54257bcc

data/README.md

@@ -63,9 +63,29 @@ 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.
+
 ## 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 +104,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

@@ -17,12 +17,12 @@ 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: ~
 

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/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/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,8 +17,10 @@ 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.'
@@ -104,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

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

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/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.1'
+      STRING = '2.27.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.1
+  version: 2.27.0
 platform: ruby
 authors:
 - Bozhidar Batsov
 - Jonas Arvidsson
 - Yuji Nakayama
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-07 00:00:00.000000000 Z
+date: 2024-10-26 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.27/
   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.11
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: Automatic Rails code style checking tool.
 test_files: []