rubocop-rails 2.35.4 → 2.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45b000a9e63ce4154fb6b1acbb97c84253448ead8bac7539aa773dbc1a7e3f8b
-  data.tar.gz: 26646956ab4da49c53a4d9105771e83658b07c65912799e5eea7f4d88e5f399f
+  metadata.gz: 5fcf30164d8e9727b16702ab937a902890c342d02c1865e4588295a355380f7a
+  data.tar.gz: 8c88a959e8b7b07e6751c6a385302deabc39f8bf328278b979d62c46becaccc7
 SHA512:
-  metadata.gz: f8e1594a6edae31940c736c45a37966d09d02ada59afad3146b8941c4668b500c288e30da7293ae34d6ee38d1e2fc47b69900c8afa8f7e598da92e91d55f4d46
-  data.tar.gz: 15994ecea386276d46a19c17ec5bc962138a1476b4508f36353a9fb10e20f6fb30a1b1d78f837d9beef9980103a9786160d50b1fc610f06a092bc874b9621050
+  metadata.gz: bc070f9148d8b3b8d87c06cf95ae2b604eb81758548cfab082a38300760ac714ac0d1741e19c8c7d604563868be6b03b4c1b1bdc87af6d7999a4386aa37701d4
+  data.tar.gz: 14e8a2fa9886a93625e49678688e7b00e2075bfcfa00a04adc23c3de5d3b8e9fd3c5be88b19e532d4cd30b1dc746320b273f0a2c7f7b984625e1a6874f16d649

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

@@ -42,7 +42,7 @@ module RuboCop
         end
 
         def on_send(node)
-          return if node.parent&.block_type?
+          return if node.block_literal?
 
           interpolated_string_passed_to_debug(node) do |arguments|
             range = replacement_range(node)

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

@@ -5,22 +5,34 @@ module RuboCop
     module Rails
       # Checks for usage of `Rails.env` which can be replaced with Feature Flags
       #
+      # The cop does not flag `Rails.env.local?`, the built-in alias for
+      # "development or test" introduced in Rails 7.1. Unlike per-environment
+      # predicates such as `development?` or `production?`, `local?` expresses
+      # the intent of guarding code that must only ever run in development or
+      # test (sanity checks, devtools, seed data) rather than gating an
+      # environment rollout, so a Feature Flag is not a suitable replacement.
+      #
       # @example
       #
       #   # bad
-      #   Rails.env.production? || Rails.env.local?
+      #   Rails.env.production? || Rails.env.development?
       #
       #   # good
       #   if FeatureFlag.enabled?(:new_feature)
       #     # new feature code
       #   end
       #
+      #   # good
+      #   raise 'This should never run in production' unless Rails.env.local?
+      #
       class Env < Base
         MSG = 'Use Feature Flags or config instead of `Rails.env`.'
         RESTRICT_ON_SEND = %i[env].freeze
         # This allow list is derived from:
         # (Rails.env.methods - Object.instance_methods).select { |m| m.to_s.end_with?('?') }
-        # and then removing the environment specific methods like development?, test?, production?, local?
+        # and then removing the environment specific methods like development?, test?, and production?.
+        # `local?` is kept on the allow list because it intentionally expresses
+        # "development or test" rather than a single environment rollout.
         ALLOWED_LIST = Set.new(
           %i[
             unicode_normalized?
@@ -38,6 +50,7 @@ module RuboCop
             valid_encoding?
             ascii_only?
             between?
+            local?
           ]
         ).freeze
 

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

@@ -294,6 +294,8 @@ module RuboCop
             false
           when :remove
             target_rails_version >= 6.1 && all_hash_key?(node.last_argument, :type)
+          when :remove_index
+            reversible_remove_index?(node)
           when :change_default, :change_column_default, :change_table_comment,
                :change_column_comment
             all_hash_key?(node.last_argument, :from, :to)
@@ -302,6 +304,12 @@ module RuboCop
           end
         end
 
+        def reversible_remove_index?(node)
+          return true if node.arguments.any? { |arg| !arg.hash_type? }
+
+          all_hash_key?(node.last_argument, :column)
+        end
+
         def within_change_method?(node)
           node.each_ancestor(:def).any? do |ancestor|
             ancestor.method?(:change)

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

@@ -12,8 +12,10 @@ module RuboCop
       #   foo.try!(:bar)
       #   foo.try!(:bar, baz)
       #   foo.try!(:bar) { |e| e.baz }
+      #   foo.try!(&:bar)
       #
       #   foo.try!(:[], 0)
+      #   foo.try!(:==, baz)
       #
       #   # good
       #   foo.try(:bar)
@@ -23,20 +25,28 @@ module RuboCop
       #   foo&.bar
       #   foo&.bar(baz)
       #   foo&.bar { |e| e.baz }
+      #   foo&.[](0)
+      #   foo&.==(baz)
       #
       # @example ConvertTry: true
       #   # bad
       #   foo.try!(:bar)
       #   foo.try!(:bar, baz)
       #   foo.try!(:bar) { |e| e.baz }
+      #   foo.try!(&:bar)
       #   foo.try(:bar)
       #   foo.try(:bar, baz)
       #   foo.try(:bar) { |e| e.baz }
+      #   foo.try(&:bar)
+      #   foo.try(:[], 0)
+      #   foo.try(:==, baz)
       #
       #   # good
       #   foo&.bar
       #   foo&.bar(baz)
       #   foo&.bar { |e| e.baz }
+      #   foo&.[](0)
+      #   foo&.==(baz)
       class SafeNavigation < Base
         include RangeHelp
         extend AutoCorrector
@@ -51,6 +61,11 @@ module RuboCop
           (send _ ${:try :try!} $_ ...)
         PATTERN
 
+        # Extracts the method name from a symbol-to-proc block argument, e.g. `:foo` from `try(&:foo)`.
+        def_node_matcher :symbol_proc_method, <<~PATTERN
+          (block_pass (sym $_))
+        PATTERN
+
         def self.autocorrect_incompatible_with
           [Style::RedundantSelf]
         end
@@ -58,11 +73,16 @@ module RuboCop
         def on_send(node)
           try_call(node) do |try_method, dispatch|
             return if try_method == :try && !cop_config['ConvertTry']
-            return unless dispatch.sym_type? && dispatch.value.match?(/\w+[=!?]?/)
+            return unless dispatch.sym_type? || symbol_proc_method(dispatch)
+            # When a `try` is nested in another `try`'s argument, correcting both at once
+            # produces overlapping replacements. Correct the outer one first and defer the
+            # inner one to a subsequent pass.
+            return if part_of_ignored_node?(node)
 
             add_offense(node, message: format(MSG, try: try_method)) do |corrector|
               autocorrect(corrector, node)
             end
+            ignore_node(node)
           end
         end
 
@@ -70,7 +90,6 @@ module RuboCop
 
         def autocorrect(corrector, node)
           method_node, *params = *node.arguments
-          method = method_node.source[1..]
 
           range = if node.receiver
                     range_between(node.loc.dot.begin_pos, node.source_range.end_pos)
@@ -79,13 +98,16 @@ module RuboCop
                     node
                   end
 
-          corrector.replace(range, replacement(method, params))
+          corrector.replace(range, replacement(method_node, params))
         end
 
-        def replacement(method, params)
+        def replacement(method_node, params)
+          return "&.#{symbol_proc_method(method_node)}" if method_node.block_pass_type?
+
+          method = method_node.source[1..]
           new_params = params.map(&:source).join(', ')
 
-          if method.end_with?('=')
+          if setter_method?(method)
             "&.#{method[0...-1]} = #{new_params}"
           elsif params.empty?
             "&.#{method}"
@@ -93,6 +115,12 @@ module RuboCop
             "&.#{method}(#{new_params})"
           end
         end
+
+        # Operator methods such as `==` and `[]=` also end with `=`, but they are not setters
+        # and must keep the explicit call form (e.g. `&.==(bar)`, `&.[]=(key, value)`).
+        def setter_method?(method)
+          method.match?(/\A\w+=\z/)
+        end
       end
     end
   end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ClassLength
 module RuboCop
   module Cop
     module Rails
@@ -303,13 +304,20 @@ module RuboCop
         def implicit_return?(node)
           return false unless cop_config['AllowImplicitReturn']
 
-          node = assignable_node(node)
+          node = last_expression_in_begin(assignable_node(node))
           method, sibling_index = find_method_with_sibling_index(node.parent)
           return false unless method&.type?(:def, :any_block)
 
           method.children.size == node.sibling_index + sibling_index
         end
 
+        # A multiline method or block body is wrapped in a `begin` node, so climb
+        # to it when the node is the last expression, to detect the implicit return.
+        def last_expression_in_begin(node)
+          node = node.parent while node.parent&.begin_type? && node.right_sibling.nil?
+          node
+        end
+
         def find_method_with_sibling_index(node, sibling_index = 1)
           return node, sibling_index unless node&.or_type?
 
@@ -348,3 +356,4 @@ module RuboCop
     end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/rubocop/rails/migration_file_skippable.rb

@@ -29,10 +29,6 @@ module RuboCop
         super if method(__method__).super_method
       end
 
-      def self.apply_to_cops!
-        RuboCop::Cop::Registry.all.each { |cop| cop.prepend(MigrationFileSkippable) }
-      end
-
       private
 
       def already_migrated_file?

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.35.4'
+      STRING = '2.36.0'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

data/lib/rubocop-rails.rb

@@ -12,7 +12,8 @@ require_relative 'rubocop/rails/plugin'
 require_relative 'rubocop/cop/rails_cops'
 
 require_relative 'rubocop/rails/migration_file_skippable'
-RuboCop::Rails::MigrationFileSkippable.apply_to_cops!
+
+RuboCop::Cop::Base.prepend(RuboCop::Rails::MigrationFileSkippable)
 
 RuboCop::Cop::Style::HashExcept.minimum_target_ruby_version(2.0)
 
@@ -39,3 +40,11 @@ RuboCop::Cop::Style::RedundantSelf.singleton_class.prepend(
     end
   end
 )
+
+RuboCop::Cop::Style::TrailingCommaInArguments.singleton_class.prepend(
+  Module.new do
+    def autocorrect_incompatible_with
+      super.push(RuboCop::Cop::Rails::LinkToBlank)
+    end
+  end
+)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.35.4
+  version: 2.36.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -269,7 +269,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.35/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.36/
   bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
   rubygems_mfa_required: 'true'
   default_lint_roller_plugin: RuboCop::Rails::Plugin
@@ -287,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Automatic Rails code style checking tool.
 test_files: []