rubocop-rails 2.32.0 → 2.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '009a04a87f7692e278ce16b061ff93814ada6644691ce2fdd4ac4c7659e68c4d'
-  data.tar.gz: 313e26b30279cf9ebba24f5f99bc78b2b44433b24bc3522a6d4261de1cf72282
+  metadata.gz: 3a61be89f227c5abed6543c4fb84957391ac66fdbadc7f7891a1876b7be0c193
+  data.tar.gz: f2e30c0c3e5a5cac32bae9ec0900a0e1fc382dda89f764f8a844b085ad2abffb
 SHA512:
-  metadata.gz: 1f7397609be46c75da8ff050ed1325db850c39df7d097d9faeb6984162b706ed92e203f151a30a68aa41b3af8fcdd63b7e76c51ebdcfe31980129a853d7cd8a3
-  data.tar.gz: 46006ebeb148838e1ae7f3dc56614b261fc90779c5e3772e163c9431034a89dbc614ef1cb1b913d5236fbc2b04708643fc27b593d8c0c4147898271c045cb4c7
+  metadata.gz: 8610629e8893c71c21d591cc68897f993699f20edab9cda08a18ce65d9bf67ac153830dffa144e18b2d9e4e204027684c18cbb02e822d01c9c40e35312709083
+  data.tar.gz: f7dc418f1cb2f4a38968b9a79ae17028368e10f2d529cba2de15954a2edc5c3f8ebf7bb35617b670cf7e8dab758ccb138c0387a0fd6caa31051ee5e803925c35

data/config/default.yml

@@ -91,6 +91,12 @@ Lint/UselessAccessModifier:
     - concern
     - concerning
 
+Lint/UselessMethodDefinition:
+  # Avoids conflict with `Rails/LexicallyScopedActionFilter` cop.
+  Exclude:
+    - '**/app/controllers/**/*.rb'
+    - '**/app/mailers/**/*.rb'
+
 Rails:
   Enabled: true
   DocumentationBaseURL: https://docs.rubocop.org/rubocop-rails
@@ -453,6 +459,7 @@ Rails/EnumSyntax:
   VersionAdded: '2.26'
   Include:
     - '**/app/models/**/*.rb'
+    - '**/lib/**/*.rb'
 
 Rails/EnumUniqueness:
   Description: 'Avoid duplicate integers in hash-syntax `enum` declaration.'
@@ -532,6 +539,13 @@ Rails/FindById:
   Enabled: 'pending'
   VersionAdded: '2.7'
 
+Rails/FindByOrAssignmentMemoization:
+  Description: 'Avoid memoizing `find_by` results with `||=`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#find-by-memoization'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '2.33'
+
 Rails/FindEach:
   Description: 'Prefer all.find_each over all.each.'
   StyleGuide: 'https://rails.rubystyle.guide#find-each'
@@ -647,8 +661,9 @@ Rails/IndexBy:
 Rails/IndexWith:
   Description: 'Prefer `index_with` over `each_with_object`, `to_h`, or `map`.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '2.5'
-  VersionChanged: '2.8'
+  VersionChanged: '2.33'
 
 Rails/Inquiry:
   Description: "Prefer Ruby's comparison operators over Active Support's `Array#inquiry` and `String#inquiry`."
@@ -742,6 +757,13 @@ Rails/NotNullColumn:
   Include:
     - db/**/*.rb
 
+Rails/OrderArguments:
+  Description: 'Prefer symbol arguments over strings in `order` method.'
+  StyleGuide: 'https://rails.rubystyle.guide/#order-arguments'
+  Enabled: pending
+  VersionAdded: '2.33'
+  Safe: false
+
 Rails/OrderById:
   Description: >-
                   Do not use the `id` column for ordering.
@@ -1126,7 +1148,7 @@ Rails/ThreeStateBooleanColumn:
 Rails/TimeZone:
   Description: 'Checks the correct usage of time zone aware methods.'
   StyleGuide: 'https://rails.rubystyle.guide#time'
-  Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
+  Reference: 'https://danilenko.org/2012/7/6/rails_timezones'
   Enabled: true
   SafeAutoCorrect: false
   VersionAdded: '0.30'

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

@@ -106,7 +106,7 @@ module RuboCop
         send_node = node.each_ancestor(:call).first
         return false unless send_node
 
-        return true if WHERE_METHODS.include?(send_node.method_name)
+        return true if WHERE_METHODS.include?(send_node.method_name) && send_node.receiver != node
 
         receiver = send_node.receiver
         return false unless receiver&.send_type?

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

@@ -132,9 +132,13 @@ module RuboCop
         add_offense(
           node, message: "Prefer `#{new_method_name}` over `#{match_desc}`."
         ) do |corrector|
+          next if part_of_ignored_node?(node)
+
           correction = prepare_correction(node)
           execute_correction(corrector, node, correction)
         end
+
+        ignore_node(node)
       end
 
       def extract_captures(match)

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

@@ -76,7 +76,7 @@ module RuboCop
 
         def on_def(node)
           return unless trivial_delegate?(node)
-          return if private_or_protected_delegation(node)
+          return if private_or_protected_delegation?(node)
           return if module_function_declared?(node)
 
           register_offense(node)
@@ -163,8 +163,8 @@ module RuboCop
           end
         end
 
-        def private_or_protected_delegation(node)
-          private_or_protected_inline(node) || node_visibility(node) != :public
+        def private_or_protected_delegation?(node)
+          private_or_protected_inline?(node) || node_visibility(node) != :public
         end
 
         def module_function_declared?(node)
@@ -173,7 +173,7 @@ module RuboCop
           end
         end
 
-        def private_or_protected_inline(node)
+        def private_or_protected_inline?(node)
           processed_source[node.first_line - 1].strip.match?(/\A(private )|(protected )/)
         end
       end

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

@@ -94,7 +94,7 @@ module RuboCop
           filtered_nodes = association_nodes.reject { |node| node.method?(:belongs_to) }
           grouped_associations = filtered_nodes.group_by do |node|
             arguments = association(node).last
-            next unless arguments.count == 1
+            next unless arguments.one?
 
             if (class_name = class_name(arguments.first))
               class_name.source

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

@@ -24,45 +24,69 @@ module RuboCop
 
         minimum_target_rails_version 7.1
 
-        # @!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)
-          )
+        # @!method rails_env_local?(node)
+        def_node_matcher :rails_env_local?, <<~PATTERN
+          (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)
-              :!)
-          )
+        # @!method not_rails_env_local?(node)
+        def_node_matcher :not_rails_env_local?, <<~PATTERN
+          (send #rails_env_local? :!)
         PATTERN
 
         def on_or(node)
-          rails_env_local_or?(node) do |*environments|
-            next unless environments.to_set == LOCAL_ENVIRONMENTS
+          lhs, rhs = *node.children
+          return unless rails_env_local?(rhs)
 
-            add_offense(node) do |corrector|
-              corrector.replace(node, 'Rails.env.local?')
-            end
+          nodes = [rhs]
+
+          if rails_env_local?(lhs)
+            nodes << lhs
+          elsif lhs.or_type? && rails_env_local?(lhs.rhs)
+            nodes << lhs.rhs
+          end
+
+          return unless environments(nodes).to_set == LOCAL_ENVIRONMENTS
+
+          range = offense_range(nodes)
+          add_offense(range) do |corrector|
+            corrector.replace(range, 'Rails.env.local?')
           end
         end
 
         def on_and(node)
-          rails_env_local_and?(node) do |*environments|
-            next unless environments.to_set == LOCAL_ENVIRONMENTS
+          lhs, rhs = *node.children
+          return unless not_rails_env_local?(rhs)
+
+          nodes = [rhs]
+
+          if not_rails_env_local?(lhs)
+            nodes << lhs
+          elsif lhs.operator_keyword? && not_rails_env_local?(lhs.rhs)
+            nodes << lhs.rhs
+          end
 
-            add_offense(node, message: MSG_NEGATED) do |corrector|
-              corrector.replace(node, '!Rails.env.local?')
-            end
+          return unless environments(nodes).to_set == LOCAL_ENVIRONMENTS
+
+          range = offense_range(nodes)
+          add_offense(range, message: MSG_NEGATED) do |corrector|
+            corrector.replace(range, '!Rails.env.local?')
           end
         end
+
+        private
+
+        def environments(nodes)
+          if nodes[0].method?(:!)
+            nodes.map { |node| node.receiver.method_name }
+          else
+            nodes.map(&:method_name)
+          end
+        end
+
+        def offense_range(nodes)
+          nodes[1].source_range.begin.join(nodes[0].source_range.end)
+        end
       end
     end
   end

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

@@ -190,7 +190,7 @@ module RuboCop
           else
             replace_with_rails_root_join(corrector, rails_root_node, argument_source)
           end
-          node.children[rails_root_index + 1..].each { |child| corrector.remove(child) }
+          node.children[(rails_root_index + 1)..].each { |child| corrector.remove(child) }
         end
 
         def autocorrect_extension_after_rails_root_join_in_dstr(corrector, node, rails_root_index, extension_node)
@@ -281,7 +281,7 @@ module RuboCop
         end
 
         def extract_rails_root_join_argument_source(node, rails_root_index)
-          node.children[rails_root_index + 1..].map(&:source).join.delete_prefix(File::SEPARATOR)
+          node.children[(rails_root_index + 1)..].map(&:source).join.delete_prefix(File::SEPARATOR)
         end
 
         def extension_node?(node)

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Avoid memoizing `find_by` results with `||=`.
+      #
+      # It is common to see code that attempts to memoize `find_by` result by `||=`,
+      # but `find_by` may return `nil`, in which case it is not memoized as intended.
+      #
+      # @safety
+      #   This cop is unsafe because detected `find_by` may not be Active Record's method,
+      #   or the code may have a different purpose than memoization.
+      #
+      # @example
+      #   # bad
+      #   def current_user
+      #     @current_user ||= User.find_by(id: session[:user_id])
+      #   end
+      #
+      #   # good
+      #   def current_user
+      #     if instance_variable_defined?(:@current_user)
+      #       @current_user
+      #     else
+      #       @current_user = User.find_by(id: session[:user_id])
+      #     end
+      #   end
+      class FindByOrAssignmentMemoization < Base
+        extend AutoCorrector
+
+        MSG = 'Avoid memoizing `find_by` results with `||=`.'
+
+        RESTRICT_ON_SEND = %i[find_by].freeze
+
+        def_node_matcher :find_by_or_assignment_memoization, <<~PATTERN
+          (or_asgn
+            (ivasgn $_)
+            $(send _ :find_by ...)
+          )
+        PATTERN
+
+        def on_send(node)
+          assignment_node = node.parent
+          find_by_or_assignment_memoization(assignment_node) do |varible_name, find_by|
+            next if assignment_node.each_ancestor(:if).any?
+
+            add_offense(assignment_node) do |corrector|
+              corrector.replace(
+                assignment_node,
+                <<~RUBY.rstrip
+                  if instance_variable_defined?(:#{varible_name})
+                    #{varible_name}
+                  else
+                    #{varible_name} = #{find_by.source}
+                  end
+                RUBY
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,11 @@ module RuboCop
       # an enumerable into a hash where the keys are the original elements.
       # Rails provides the `index_with` method for this purpose.
       #
+      # @safety
+      #   This cop is marked as unsafe autocorrection, because `nil.to_h` returns {}
+      #   but `nil.with_index` throws `NoMethodError`. Therefore, autocorrection is not
+      #   compatible if the receiver is nil.
+      #
       # @example
       #   # bad
       #   [1, 2, 3].each_with_object({}) { |el, h| h[el] = foo(el) }

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Prefer symbol arguments over strings in `order` method.
+      #
+      # @safety
+      #   Cop is unsafe because the receiver might not be an Active Record query.
+      #
+      # @example
+      #   # bad
+      #   User.order('name')
+      #   User.order('name DESC')
+      #
+      #   # good
+      #   User.order(:name)
+      #   User.order(name: :desc)
+      #
+      class OrderArguments < Base
+        extend AutoCorrector
+
+        MSG = 'Prefer `%<prefer>s` instead.'
+
+        RESTRICT_ON_SEND = %i[order].freeze
+
+        def_node_matcher :string_order, <<~PATTERN
+          (call _ :order (str $_value)+)
+        PATTERN
+
+        ORDER_EXPRESSION_REGEX = /\A(\w+) ?(asc|desc)?\z/i.freeze
+
+        def on_send(node)
+          return unless (current_expressions = string_order(node))
+          return unless (preferred_expressions = replacement(current_expressions))
+
+          offense_range = find_offense_range(node)
+          add_offense(offense_range, message: format(MSG, prefer: preferred_expressions)) do |corrector|
+            corrector.replace(offense_range, preferred_expressions)
+          end
+        end
+        alias on_csend on_send
+
+        private
+
+        def find_offense_range(node)
+          node.first_argument.source_range.join(node.last_argument.source_range)
+        end
+
+        def replacement(order_expressions)
+          order_arguments = order_expressions.flat_map { |expr| expr.split(',') }
+          order_arguments.map! { |arg| extract_column_and_direction(arg.strip) }
+
+          return if order_arguments.any?(&:nil?)
+
+          convert_to_preferred_arguments(order_arguments).join(', ')
+        end
+
+        def convert_to_preferred_arguments(order_expressions)
+          use_hash = false
+          order_expressions.map do |column, direction|
+            if direction == :asc && !use_hash
+              ":#{column}"
+            else
+              use_hash = true
+              "#{column}: :#{direction}"
+            end
+          end
+        end
+
+        def extract_column_and_direction(order_expression)
+          return unless (column, direction = ORDER_EXPRESSION_REGEX.match(order_expression)&.captures)
+
+          [column.downcase, direction&.downcase&.to_sym || :asc]
+        end
+      end
+    end
+  end
+end

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

@@ -38,9 +38,11 @@ module RuboCop
             ...)
         PATTERN
 
+        # rubocop:disable Metrics/CyclomaticComplexity
         def on_send(node)
           return if node.parent&.call_type? || node.block_node
           return if !output?(node) && !io_output?(node)
+          return if node.arguments.any? { |arg| arg.type?(:hash, :block_pass) }
 
           range = offense_range(node)
 
@@ -48,6 +50,7 @@ module RuboCop
             corrector.replace(range, 'Rails.logger.debug')
           end
         end
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         private
 

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

@@ -27,6 +27,9 @@ module RuboCop
       # end
       # ----
       #
+      # If a method call has no receiver, like `do_something { users.map { |user| user[:foo] }`,
+      # it is not considered part of an iteration and will be detected.
+      #
       # @safety
       #   This cop is unsafe because model can use column aliases.
       #
@@ -59,9 +62,9 @@ module RuboCop
           (any_block (call _ {:map :collect}) $_argument (send lvar :[] $_key))
         PATTERN
 
-        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def on_block(node)
-          return if node.each_ancestor(:any_block).any?
+          return if node.each_ancestor(:any_block).first&.receiver
 
           pluck_candidate?(node) do |argument, key|
             next if key.regexp_type? || !use_one_block_argument?(argument)
@@ -79,7 +82,7 @@ module RuboCop
             register_offense(node, key)
           end
         end
-        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         alias on_numblock on_block
         alias on_itblock on_block
 

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

@@ -74,7 +74,7 @@ module RuboCop
             $[
               (hash <$(pair (sym :presence) true) ...>)         # presence: true
               !(hash <$(pair (sym :strict) {true const}) ...>)  # strict: true
-              !(hash <$(pair (sym {:if :unless}) _) ...>)       # if: some_condition or unless: some_condition
+              !(hash <$(pair (sym {:if}) _) ...>)               # if: some_condition or unless: some_condition
             ]
           )
         PATTERN
@@ -211,12 +211,12 @@ module RuboCop
 
         def non_optional_belongs_to(node, keys)
           keys.select do |key|
-            belongs_to = belongs_to_for(node, key)
+            belongs_to = belongs_to_for?(node, key)
             belongs_to && !optional?(belongs_to)
           end
         end
 
-        def belongs_to_for(model_class_node, key)
+        def belongs_to_for?(model_class_node, key)
           if key.to_s.end_with?('_id')
             normalized_key = key.to_s.delete_suffix('_id').to_sym
             belongs_to?(model_class_node, key: normalized_key, fk: key)

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

@@ -71,7 +71,7 @@ module RuboCop
         def on_block(node)
           return unless node.method?(:with_options)
           return unless (body = node.body)
-          return unless all_block_nodes_in(body).count.zero?
+          return unless all_block_nodes_in(body).none?
 
           send_nodes = all_send_nodes_in(body)
           return unless redundant_receiver?(send_nodes, node)

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

@@ -156,7 +156,7 @@ module RuboCop
           return unless persist_method?(node)
           return if return_value_assigned?(node)
           return if implicit_return?(node)
-          return if check_used_in_condition_or_compound_boolean(node)
+          return if check_used_in_condition_or_compound_boolean?(node)
           return if argument?(node)
           return if explicit_return?(node)
           return if checked_immediately?(node)
@@ -227,7 +227,7 @@ module RuboCop
           array
         end
 
-        def check_used_in_condition_or_compound_boolean(node)
+        def check_used_in_condition_or_compound_boolean?(node)
           return false unless in_condition_or_compound_boolean?(node)
 
           register_offense(node, CREATE_CONDITIONAL_MSG) unless MODIFY_PERSIST_METHODS.include?(node.method_name)

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

@@ -97,9 +97,11 @@ module RuboCop
 
         def in_transaction_block?(node)
           return false unless transaction_method_name?(node.method_name)
-          return false unless (parent = node.parent)
+          return false unless node.parent&.body
 
-          parent.any_block_type? && parent.body
+          node.right_siblings.none? do |sibling|
+            sibling.respond_to?(:loop_keyword?) && sibling.loop_keyword?
+          end
         end
 
         def statement(statement_node)

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

@@ -63,7 +63,7 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          find_offenses(node) do |args|
+          find_offenses?(node) do |args|
             return unless convertable_args?(args)
 
             range = correction_range(node)
@@ -87,7 +87,7 @@ module RuboCop
           style == :exists
         end
 
-        def find_offenses(node, &block)
+        def find_offenses?(node, &block)
           if exists_style?
             where_exists_call?(node, &block)
           elsif where_style?

data/lib/rubocop/cop/rails_cops.rb

@@ -58,6 +58,7 @@ require_relative 'rails/expanded_date_range'
 require_relative 'rails/file_path'
 require_relative 'rails/find_by'
 require_relative 'rails/find_by_id'
+require_relative 'rails/find_by_or_assignment_memoization'
 require_relative 'rails/find_each'
 require_relative 'rails/freeze_time'
 require_relative 'rails/has_and_belongs_to_many'
@@ -82,6 +83,7 @@ require_relative 'rails/migration_class_name'
 require_relative 'rails/multiple_route_paths'
 require_relative 'rails/negate_include'
 require_relative 'rails/not_null_column'
+require_relative 'rails/order_arguments'
 require_relative 'rails/order_by_id'
 require_relative 'rails/output'
 require_relative 'rails/output_safety'

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.32.0'
+      STRING = '2.33.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.32.0
+  version: 2.33.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -9,7 +9,7 @@ authors:
 - Yuji Nakayama
 bindir: bin
 cert_chain: []
-date: 2025-05-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,6 +164,7 @@ files:
 - lib/rubocop/cop/rails/file_path.rb
 - lib/rubocop/cop/rails/find_by.rb
 - lib/rubocop/cop/rails/find_by_id.rb
+- lib/rubocop/cop/rails/find_by_or_assignment_memoization.rb
 - lib/rubocop/cop/rails/find_each.rb
 - lib/rubocop/cop/rails/freeze_time.rb
 - lib/rubocop/cop/rails/has_and_belongs_to_many.rb
@@ -188,6 +189,7 @@ files:
 - lib/rubocop/cop/rails/multiple_route_paths.rb
 - lib/rubocop/cop/rails/negate_include.rb
 - lib/rubocop/cop/rails/not_null_column.rb
+- lib/rubocop/cop/rails/order_arguments.rb
 - lib/rubocop/cop/rails/order_by_id.rb
 - lib/rubocop/cop/rails/output.rb
 - lib/rubocop/cop/rails/output_safety.rb
@@ -264,7 +266,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.32/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.33/
   bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
   rubygems_mfa_required: 'true'
   default_lint_roller_plugin: RuboCop::Rails::Plugin
@@ -282,7 +284,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Automatic Rails code style checking tool.
 test_files: []