rubocop-rails 2.26.2 → 2.32.0

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

@@ -6,7 +6,72 @@ module RuboCop
     module IndexMethod # rubocop:disable Metrics/ModuleLength
       RESTRICT_ON_SEND = %i[each_with_object to_h map collect []].freeze
 
-      def on_block(node) # rubocop:todo InternalAffairs/NumblockHandler
+      # Internal helper class to hold match data
+      Captures = ::Struct.new(
+        :transformed_argname,
+        :transforming_body_expr
+      ) do
+        def noop_transformation?
+          transforming_body_expr.lvar_type? && transforming_body_expr.children == [transformed_argname]
+        end
+      end
+
+      # Internal helper class to hold autocorrect data
+      Autocorrection = ::Struct.new(:match, :block_node, :leading, :trailing) do
+        def self.from_each_with_object(node, match)
+          new(match, node, 0, 0)
+        end
+
+        def self.from_to_h(node, match)
+          new(match, node, 0, 0)
+        end
+
+        def self.from_map_to_h(node, match)
+          if node.block_literal?
+            strip_trailing_chars = 0
+          else
+            map_range = node.children.first.source_range
+            node_range = node.source_range
+            strip_trailing_chars = node_range.end_pos - map_range.end_pos
+          end
+
+          new(match, node.children.first, 0, strip_trailing_chars)
+        end
+
+        def self.from_hash_brackets_map(node, match)
+          new(match, node.children.last, "#{node.receiver.source}[".length, ']'.length)
+        end
+
+        def strip_prefix_and_suffix(node, corrector)
+          expression = node.source_range
+          corrector.remove_leading(expression, leading)
+          corrector.remove_trailing(expression, trailing)
+        end
+
+        def set_new_method_name(new_method_name, corrector)
+          range = block_node.send_node.loc.selector
+          if (send_end = block_node.send_node.loc.end)
+            # If there are arguments (only true in the `each_with_object` case)
+            range = range.begin.join(send_end)
+          end
+          corrector.replace(range, new_method_name)
+        end
+
+        def set_new_arg_name(transformed_argname, corrector)
+          return unless block_node.block_type?
+
+          corrector.replace(block_node.arguments, "|#{transformed_argname}|")
+        end
+
+        def set_new_body_expression(transforming_body_expr, corrector)
+          body_source = transforming_body_expr.source
+          body_source = "{ #{body_source} }" if transforming_body_expr.hash_type? && !transforming_body_expr.braces?
+
+          corrector.replace(block_node.body, body_source)
+        end
+      end
+
+      def on_block(node)
         on_bad_each_with_object(node) do |*match|
           handle_possible_offense(node, match, 'each_with_object')
         end
@@ -18,6 +83,9 @@ module RuboCop
         end
       end
 
+      alias on_numblock on_block
+      alias on_itblock on_block
+
       def on_send(node)
         on_bad_map_to_h(node) do |*match|
           handle_possible_offense(node, match, 'map { ... }.to_h')
@@ -100,66 +168,6 @@ module RuboCop
         correction.set_new_arg_name(captures.transformed_argname, corrector)
         correction.set_new_body_expression(captures.transforming_body_expr, corrector)
       end
-
-      # Internal helper class to hold match data
-      Captures = ::Struct.new(
-        :transformed_argname,
-        :transforming_body_expr
-      ) do
-        def noop_transformation?
-          transforming_body_expr.lvar_type? && transforming_body_expr.children == [transformed_argname]
-        end
-      end
-
-      # Internal helper class to hold autocorrect data
-      Autocorrection = ::Struct.new(:match, :block_node, :leading, :trailing) do
-        def self.from_each_with_object(node, match)
-          new(match, node, 0, 0)
-        end
-
-        def self.from_to_h(node, match)
-          new(match, node, 0, 0)
-        end
-
-        def self.from_map_to_h(node, match)
-          strip_trailing_chars = 0
-
-          unless node.parent&.block_type?
-            map_range = node.children.first.source_range
-            node_range = node.source_range
-            strip_trailing_chars = node_range.end_pos - map_range.end_pos
-          end
-
-          new(match, node.children.first, 0, strip_trailing_chars)
-        end
-
-        def self.from_hash_brackets_map(node, match)
-          new(match, node.children.last, "#{node.receiver.source}[".length, ']'.length)
-        end
-
-        def strip_prefix_and_suffix(node, corrector)
-          expression = node.source_range
-          corrector.remove_leading(expression, leading)
-          corrector.remove_trailing(expression, trailing)
-        end
-
-        def set_new_method_name(new_method_name, corrector)
-          range = block_node.send_node.loc.selector
-          if (send_end = block_node.send_node.loc.end)
-            # If there are arguments (only true in the `each_with_object` case)
-            range = range.begin.join(send_end)
-          end
-          corrector.replace(range, new_method_name)
-        end
-
-        def set_new_arg_name(transformed_argname, corrector)
-          corrector.replace(block_node.arguments, "|#{transformed_argname}|")
-        end
-
-        def set_new_body_expression(transforming_body_expr, corrector)
-          corrector.replace(block_node.body, transforming_body_expr.source)
-        end
-      end
     end
   end
 end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Common functionality for cops working with routes.
+    module RoutesHelper
+      extend NodePattern::Macros
+
+      HTTP_METHODS = %i[get post put patch delete].freeze
+
+      def_node_matcher :routes_draw?, <<~PATTERN
+        (send (send _ :routes) :draw)
+      PATTERN
+
+      def within_routes?(node)
+        node.each_ancestor(:block).any? { |block| routes_draw?(block.send_node) }
+      end
+    end
+  end
+end

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/add_column_index.rb

@@ -19,6 +19,7 @@ module RuboCop
       class AddColumnIndex < Base
         extend AutoCorrector
         include RangeHelp
+        include 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/arel_star.rb

@@ -5,14 +5,14 @@ module RuboCop
     module Rails
       # Prevents usage of `"*"` on an Arel::Table column reference.
       #
-      # Using `arel_table["*"]` causes the outputted string to be a literal
-      # quoted asterisk (e.g. <tt>`my_model`.`*`</tt>). This causes the
-      # database to look for a column named <tt>`*`</tt> (or `"*"`) as opposed
+      # Using `arel_table["\*"]` causes the outputted string to be a literal
+      # quoted asterisk (e.g. `my_model`.`*`). This causes the
+      # database to look for a column named `\*` (or `"*"`) as opposed
       # to expanding the column list as one would likely expect.
       #
       # @safety
-      #   This cop's autocorrection is unsafe because it turns a quoted `*` into
-      #   an SQL `*`, unquoted. `*` is a valid column name in certain databases
+      #   This cop's autocorrection is unsafe because it turns a quoted `\*` into
+      #   an SQL `*`, unquoted. `\*` is a valid column name in certain databases
       #   supported by Rails, and even though it is usually a mistake,
       #   it might denote legitimate access to a column named `*`.
       #

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

@@ -66,7 +66,7 @@ module RuboCop
 
         def_node_matcher :match_belongs_to_with_options, <<~PATTERN
           (send _ :belongs_to ...
-            (hash <$(pair (sym :required) ${true false}) ...>)
+            (hash <$(pair (sym :required) $boolean) ...>)
           )
         PATTERN
 

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

@@ -123,7 +123,7 @@ module RuboCop
         def on_if(node)
           return unless cop_config['UnlessPresent']
           return unless node.unless?
-          return if node.else? && config.for_cop('Style/UnlessElse')['Enabled']
+          return if node.else? && config.cop_enabled?('Style/UnlessElse')
 
           unless_present?(node) do |method_call, receiver|
             range = unless_condition(node, method_call)

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

@@ -65,6 +65,7 @@ module RuboCop
       #   end
       class BulkChangeTable < Base
         include DatabaseTypeResolvable
+        include MigrationsHelper
 
         MSG_FOR_CHANGE_TABLE = <<~MSG.chomp
           You can combine alter queries using `bulk: true` options.

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

@@ -79,7 +79,7 @@ module RuboCop
         end
 
         def allowed_name?(argument)
-          return false unless argument.str_type? || argument.sym_type?
+          return false unless argument.type?(:str, :sym)
 
           !/^[a-zA-Z-][a-zA-Z\-0-9]*$/.match?(argument.value)
         end

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
+        include MigrationsHelper
+
         COLUMN_TYPE_METHOD_NAMES = %i[
           bigint
           binary

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

@@ -15,6 +15,9 @@ module RuboCop
       # without using the `delegate` method will be a violation.
       # When set to `false`, this case is legal.
       #
+      # It is disabled for controllers in order to keep controller actions
+      # explicitly defined.
+      #
       # @example
       #   # bad
       #   def bar
@@ -68,12 +71,13 @@ module RuboCop
 
         def_node_matcher :delegate?, <<~PATTERN
           (def _method_name _args
-            (send {(send nil? _) (self)} _ ...))
+            (send {(send nil? _) (self) (send (self) :class) ({cvar gvar ivar} _) (const _ _)} _ ...))
         PATTERN
 
         def on_def(node)
           return unless trivial_delegate?(node)
           return if private_or_protected_delegation(node)
+          return if module_function_declared?(node)
 
           register_offense(node)
         end
@@ -82,15 +86,40 @@ module RuboCop
 
         def register_offense(node)
           add_offense(node.loc.keyword) do |corrector|
-            body = node.body
+            receiver = determine_register_offense_receiver(node.body.receiver)
+            delegation = build_delegation(node, receiver)
 
-            receiver = body.receiver.self_type? ? 'self' : ":#{body.receiver.method_name}"
+            corrector.replace(node, delegation)
+          end
+        end
 
-            delegation = ["delegate :#{body.method_name}", "to: #{receiver}"]
-            delegation << ['prefix: true'] if node.method?(prefixed_method_name(node.body))
+        def determine_register_offense_receiver(receiver)
+          case receiver.type
+          when :self
+            'self'
+          when :const
+            full_name = full_const_name(receiver)
+            full_name.include?('::') ? ":'#{full_name}'" : ":#{full_name}"
+          when :cvar, :gvar, :ivar
+            ":#{receiver.source}"
+          else
+            ":#{receiver.method_name}"
+          end
+        end
+
+        def build_delegation(node, receiver)
+          delegation = ["delegate :#{node.body.method_name}", "to: #{receiver}"]
+          delegation << ['prefix: true'] if node.method?(prefixed_method_name(node.body))
+          delegation.join(', ')
+        end
 
-            corrector.replace(node, delegation.join(', '))
+        def full_const_name(node)
+          return unless node.const_type?
+          unless node.namespace
+            return node.absolute? ? "::#{node.source}" : node.source
           end
+
+          "#{full_const_name(node.namespace)}::#{node.short_name}"
         end
 
         def trivial_delegate?(def_node)
@@ -120,13 +149,30 @@ module RuboCop
         def prefixed_method_name(body)
           return '' if body.receiver.self_type?
 
-          [body.receiver.method_name, body.method_name].join('_').to_sym
+          [determine_prefixed_method_receiver_name(body.receiver), body.method_name].join('_').to_sym
+        end
+
+        def determine_prefixed_method_receiver_name(receiver)
+          case receiver.type
+          when :cvar, :gvar, :ivar
+            receiver.source
+          when :const
+            full_const_name(receiver)
+          else
+            receiver.method_name.to_s
+          end
         end
 
         def private_or_protected_delegation(node)
           private_or_protected_inline(node) || node_visibility(node) != :public
         end
 
+        def module_function_declared?(node)
+          node.each_ancestor(:module, :begin).any? do |ancestor|
+            ancestor.children.any? { |child| child.send_type? && child.method?(:module_function) }
+          end
+        end
+
         def private_or_protected_inline(node)
           processed_source[node.first_line - 1].strip.match?(/\A(private )|(protected )/)
         end

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

@@ -63,11 +63,15 @@ module RuboCop
         private
 
         def register_offense(name, nodes, message_template)
-          nodes.each do |node|
-            add_offense(node, message: format(message_template, name: name)) do |corrector|
-              next if same_line?(nodes.last, node)
+          last_node = nodes.last
 
-              corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
+          nodes.each_with_index do |node, index|
+            add_offense(node, message: format(message_template, name: name)) do |corrector|
+              if index.zero?
+                corrector.replace(node, last_node.source)
+              else
+                corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
+              end
             end
           end
         end

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

@@ -45,12 +45,10 @@ module RuboCop
           return if node.parent&.block_type?
 
           interpolated_string_passed_to_debug(node) do |arguments|
-            message = format(MSG)
-
             range = replacement_range(node)
             replacement = replacement_source(node, arguments)
 
-            add_offense(range, message: message) do |corrector|
+            add_offense(range) do |corrector|
               corrector.replace(range, replacement)
             end
           end

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

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

@@ -6,6 +6,9 @@ module RuboCop
       # Identifies usages of file path joining process to use `Rails.root.join` clause.
       # It is used to add uniformity when joining paths.
       #
+      # NOTE: This cop ignores leading slashes in string literal arguments for `Rails.root.join`
+      #       and multiple slashes in string literal arguments for `Rails.root.join` and `File.join`.
+      #
       # @example EnforcedStyle: slashes (default)
       #   # bad
       #   Rails.root.join('app', 'models', 'goober')
@@ -66,6 +69,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 +81,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)
@@ -94,7 +100,7 @@ module RuboCop
 
         def check_for_file_join_with_rails_root(node)
           return unless file_join_nodes?(node)
-          return unless node.arguments.any? { |e| rails_root_nodes?(e) }
+          return unless valid_arguments_for_file_join_with_rails_root?(node.arguments)
 
           register_offense(node, require_to_s: true) do |corrector|
             autocorrect_file_join(corrector, node) unless node.first_argument.array_type?
@@ -105,8 +111,7 @@ module RuboCop
           return unless style == :slashes
           return unless rails_root_nodes?(node)
           return unless rails_root_join_nodes?(node)
-          return unless node.arguments.size > 1
-          return unless node.arguments.all?(&:str_type?)
+          return unless valid_string_arguments_for_rails_root_join?(node.arguments)
 
           register_offense(node, require_to_s: false) do |corrector|
             autocorrect_rails_root_join_with_string_arguments(corrector, node)
@@ -117,15 +122,42 @@ module RuboCop
           return unless style == :arguments
           return unless rails_root_nodes?(node)
           return unless rails_root_join_nodes?(node)
-          return unless node.arguments.any? { |arg| string_with_slash?(arg) }
+          return unless valid_slash_separated_path_for_rails_root_join?(node.arguments)
 
           register_offense(node, require_to_s: false) do |corrector|
             autocorrect_rails_root_join_with_slash_separated_path(corrector, node)
           end
         end
 
-        def string_with_slash?(node)
-          node.str_type? && node.source.include?(File::SEPARATOR)
+        def valid_arguments_for_file_join_with_rails_root?(arguments)
+          return false unless arguments.any? { |arg| rails_root_nodes?(arg) }
+
+          arguments.none? { |arg| arg.variable? || arg.const_type? || string_contains_multiple_slashes?(arg) }
+        end
+
+        def valid_string_arguments_for_rails_root_join?(arguments)
+          return false unless arguments.size > 1
+          return false unless arguments.all?(&:str_type?)
+
+          arguments.none? { |arg| string_with_leading_slash?(arg) || string_contains_multiple_slashes?(arg) }
+        end
+
+        def valid_slash_separated_path_for_rails_root_join?(arguments)
+          return false unless arguments.any? { |arg| string_contains_slash?(arg) }
+
+          arguments.none? { |arg| string_with_leading_slash?(arg) || string_contains_multiple_slashes?(arg) }
+        end
+
+        def string_contains_slash?(node)
+          node.str_type? && node.value.include?(File::SEPARATOR)
+        end
+
+        def string_contains_multiple_slashes?(node)
+          node.str_type? && node.value.include?('//')
+        end
+
+        def string_with_leading_slash?(node)
+          node.str_type? && node.value.start_with?(File::SEPARATOR)
         end
 
         def register_offense(node, require_to_s:, &block)
@@ -170,7 +202,17 @@ module RuboCop
         end
 
         def autocorrect_file_join(corrector, node)
+          replace_receiver_with_rails_root(corrector, node)
+          remove_first_argument_with_comma(corrector, node)
+          process_arguments(corrector, node.arguments)
+          append_to_string_conversion(corrector, node)
+        end
+
+        def replace_receiver_with_rails_root(corrector, node)
           corrector.replace(node.receiver, 'Rails.root')
+        end
+
+        def remove_first_argument_with_comma(corrector, node)
           corrector.remove(
             range_with_surrounding_space(
               range_with_surrounding_comma(
@@ -180,9 +222,19 @@ module RuboCop
               side: :right
             )
           )
-          node.arguments.filter(&:str_type?).each do |argument|
-            corrector.replace(argument, argument.value.delete_prefix('/').inspect)
+        end
+
+        def process_arguments(corrector, arguments)
+          arguments.each do |argument|
+            if argument.str_type?
+              corrector.replace(argument, argument.value.delete_prefix('/').inspect)
+            elsif argument.array_type?
+              corrector.replace(argument, "*#{argument.source}")
+            end
           end
+        end
+
+        def append_to_string_conversion(corrector, node)
           corrector.insert_after(node, '.to_s')
         end
 
@@ -203,7 +255,7 @@ module RuboCop
 
         def autocorrect_rails_root_join_with_slash_separated_path(corrector, node)
           node.arguments.each do |argument|
-            next unless string_with_slash?(argument)
+            next unless string_contains_slash?(argument)
 
             index = argument.source.index(File::SEPARATOR)
             rest = inner_range_of(argument).adjust(begin_pos: index - 1)

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

@@ -40,6 +40,10 @@ module RuboCop
           (hash (kwsplat _))
         PATTERN
 
+        def_node_matcher :forwarded_kwrestarg?, <<~PATTERN
+          (hash (forwarded-kwrestarg))
+        PATTERN
+
         def_node_matcher :include_rack_test_methods?, <<~PATTERN
           (send nil? :include
             (const
@@ -83,7 +87,9 @@ module RuboCop
           end
         end
 
+        # rubocop:disable Metrics/CyclomaticComplexity
         def needs_conversion?(data)
+          return false if data.forwarded_args_type? || forwarded_kwrestarg?(data)
           return true unless data.hash_type?
           return false if kwsplat_hash?(data)
 
@@ -91,6 +97,7 @@ module RuboCop
             special_keyword_arg?(pair.key) || (format_arg?(pair.key) && data.pairs.one?)
           end
         end
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         def special_keyword_arg?(node)
           node.sym_type? && KEYWORD_ARGS.include?(node.value)