rubocop-rails 2.22.2 → 2.25.0

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

@@ -9,6 +9,10 @@ module RuboCop
       # `pick` avoids. When called on an Active Record relation, `pick` adds a
       # limit to the query so that only one value is fetched from the database.
       #
+      # Note that when `pick` is added to a relation with an existing limit, it
+      # causes a subquery to be added. In most cases this is undesirable, and
+      # care should be taken while resolving this violation.
+      #
       # @safety
       #   This cop is unsafe because `pluck` is defined on both `ActiveRecord::Relation` and `Enumerable`,
       #   whereas `pick` is only defined on `ActiveRecord::Relation` in Rails 6.0. This was addressed
@@ -28,13 +32,13 @@ module RuboCop
         extend AutoCorrector
         extend TargetRailsVersion
 
-        MSG = 'Prefer `pick(%<args>s)` over `pluck(%<args>s).first`.'
+        MSG = 'Prefer `pick(%<args>s)` over `%<current>s`.'
         RESTRICT_ON_SEND = %i[first].freeze
 
         minimum_target_rails_version 6.0
 
         def_node_matcher :pick_candidate?, <<~PATTERN
-          (send (send _ :pluck ...) :first)
+          (call (call _ :pluck ...) :first)
         PATTERN
 
         def on_send(node)
@@ -44,7 +48,7 @@ module RuboCop
             node_selector = node.loc.selector
             range = receiver_selector.join(node_selector)
 
-            add_offense(range, message: message(receiver)) do |corrector|
+            add_offense(range, message: message(receiver, range)) do |corrector|
               first_range = receiver.source_range.end.join(node_selector)
 
               corrector.remove(first_range)
@@ -52,11 +56,12 @@ module RuboCop
             end
           end
         end
+        alias on_csend on_send
 
         private
 
-        def message(receiver)
-          format(MSG, args: receiver.arguments.map(&:source).join(', '))
+        def message(receiver, current)
+          format(MSG, args: receiver.arguments.map(&:source).join(', '), current: current.source)
         end
       end
     end

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

@@ -38,7 +38,7 @@ module RuboCop
         minimum_target_rails_version 5.0
 
         def_node_matcher :pluck_candidate?, <<~PATTERN
-          ({block numblock} (send _ {:map :collect}) $_argument (send lvar :[] $_key))
+          ({block numblock} (call _ {:map :collect}) $_argument (send lvar :[] $_key))
         PATTERN
 
         def on_block(node)

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

@@ -34,7 +34,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[pluck].freeze
 
         def_node_matcher :pluck_id_call?, <<~PATTERN
-          (send _ :pluck {(sym :id) (send nil? :primary_key)})
+          (call _ :pluck {(sym :id) (send nil? :primary_key)})
         PATTERN
 
         def on_send(node)
@@ -47,6 +47,7 @@ module RuboCop
             corrector.replace(offense_range(node), 'ids')
           end
         end
+        alias on_csend on_send
 
         private
 

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

@@ -22,10 +22,13 @@ module RuboCop
       # @example
       #   # bad
       #   Post.where(user_id: User.active.pluck(:id))
+      #   Post.where(user_id: User.active.ids)
+      #   Post.where.not(user_id: User.active.pluck(:id))
       #
       #   # good
       #   Post.where(user_id: User.active.select(:id))
       #   Post.where(user_id: active_users.select(:id))
+      #   Post.where.not(user_id: active_users.select(:id))
       #
       # @example EnforcedStyle: conservative (default)
       #   # good
@@ -40,8 +43,9 @@ module RuboCop
         include ConfigurableEnforcedStyle
         extend AutoCorrector
 
-        MSG = 'Use `select` instead of `pluck` within `where` query method.'
-        RESTRICT_ON_SEND = %i[pluck].freeze
+        MSG_SELECT = 'Use `select` instead of `pluck` within `where` query method.'
+        MSG_IDS = 'Use `select(:id)` instead of `ids` within `where` query method.'
+        RESTRICT_ON_SEND = %i[pluck ids].freeze
 
         def on_send(node)
           return unless in_where?(node)
@@ -49,17 +53,26 @@ module RuboCop
 
           range = node.loc.selector
 
-          add_offense(range) do |corrector|
-            corrector.replace(range, 'select')
+          if node.method?(:ids)
+            replacement = 'select(:id)'
+            message = MSG_IDS
+          else
+            replacement = 'select'
+            message = MSG_SELECT
+          end
+
+          add_offense(range, message: message) do |corrector|
+            corrector.replace(range, replacement)
           end
         end
+        alias on_csend on_send
 
         private
 
         def root_receiver(node)
           receiver = node.receiver
 
-          if receiver&.send_type?
+          if receiver&.call_type?
             root_receiver(receiver)
           else
             receiver

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

@@ -34,8 +34,7 @@ module RuboCop
 
       # Detect redundant `all` used as a receiver for Active Record query methods.
       #
-      # NOTE: For the methods `delete_all` and `destroy_all`,
-      # this cop will only check cases where the receiver is a model.
+      # For the methods `delete_all` and `destroy_all`, this cop will only check cases where the receiver is a model.
       # It will ignore cases where the receiver is an association (e.g., `user.articles.all.delete_all`).
       # This is because omitting `all` from an association changes the methods
       # from `ActiveRecord::Relation` to `ActiveRecord::Associations::CollectionProxy`,

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

@@ -3,25 +3,30 @@
 module RuboCop
   module Cop
     module Rails
-      # Prefer `response.parsed_body` to `JSON.parse(response.body)`.
+      # Prefer `response.parsed_body` to custom parsing logic for `response.body`.
       #
       # @safety
-      #   This cop is unsafe because Content-Type may not be `application/json`. For example, the proprietary
-      #   Content-Type provided by corporate entities such as `application/vnd.github+json` is not supported at
-      #   `response.parsed_body` by default, so you still have to use `JSON.parse(response.body)` there.
+      #   This cop is unsafe because Content-Type may not be `application/json` or `text/html`.
+      #   For example, the proprietary Content-Type provided by corporate entities such as
+      #   `application/vnd.github+json` is not supported at `response.parsed_body` by default,
+      #   so you still have to use `JSON.parse(response.body)` there.
       #
       # @example
       #   # bad
       #   JSON.parse(response.body)
       #
+      #   # bad
+      #   Nokogiri::HTML.parse(response.body)
+      #
+      #   # bad
+      #   Nokogiri::HTML5.parse(response.body)
+      #
       #   # good
       #   response.parsed_body
       class ResponseParsedBody < Base
         extend AutoCorrector
         extend TargetRailsVersion
 
-        MSG = 'Prefer `response.parsed_body` to `JSON.parse(response.body)`.'
-
         RESTRICT_ON_SEND = %i[parse].freeze
 
         minimum_target_rails_version 5.0
@@ -38,12 +43,27 @@ module RuboCop
           )
         PATTERN
 
+        # @!method nokogiri_html_parse_response_body(node)
+        def_node_matcher :nokogiri_html_parse_response_body, <<~PATTERN
+          (send
+            (const
+              (const {nil? cbase} :Nokogiri)
+              ${:HTML :HTML5}
+            )
+            :parse
+            (send
+              (send nil? :response)
+              :body
+            )
+          )
+        PATTERN
+
         def on_send(node)
-          return unless json_parse_response_body?(node)
+          check_json_parse_response_body(node)
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
+          return unless target_rails_version >= 7.1
+
+          check_nokogiri_html_parse_response_body(node)
         end
 
         private
@@ -51,6 +71,28 @@ module RuboCop
         def autocorrect(corrector, node)
           corrector.replace(node, 'response.parsed_body')
         end
+
+        def check_json_parse_response_body(node)
+          return unless json_parse_response_body?(node)
+
+          add_offense(
+            node,
+            message: 'Prefer `response.parsed_body` to `JSON.parse(response.body)`.'
+          ) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        def check_nokogiri_html_parse_response_body(node)
+          return unless (const = nokogiri_html_parse_response_body(node))
+
+          add_offense(
+            node,
+            message: "Prefer `response.parsed_body` to `Nokogiri::#{const}.parse(response.body)`."
+          ) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
       end
     end
   end

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

@@ -17,7 +17,7 @@ module RuboCop
       #   # good
       #   def change
       #     change_table :users do |t|
-      #       t.remove :name, :string
+      #       t.remove :name, type: :string
       #     end
       #   end
       #

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

@@ -196,6 +196,8 @@ module RuboCop
         end
 
         def call_to_persisted?(node)
+          node = node.parent.condition if node.parenthesized_call? && node.parent.if_type?
+
           node.send_type? && node.method?(:persisted?)
         end
 

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

@@ -63,7 +63,7 @@ module RuboCop
         PATTERN
 
         def_node_matcher :good_insert?, <<~PATTERN
-          (send _ {:insert :insert!} _ {
+          (call _ {:insert :insert!} _ {
             !(hash ...)
             (hash <(pair (sym !{:returning :unique_by}) _) ...>)
           } ...)

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

@@ -69,9 +69,10 @@ module RuboCop
           return if !node.receiver&.str_type? || !node.method?(:to_time)
 
           add_offense(node.loc.selector, message: MSG_STRING_TO_TIME) do |corrector|
-            corrector.replace(node, "Time.zone.parse(#{node.receiver.source})")
+            corrector.replace(node, "Time.zone.parse(#{node.receiver.source})") unless node.csend_type?
           end
         end
+        alias on_csend on_send
 
         private
 

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

@@ -68,15 +68,23 @@ module RuboCop
           return unless uniq
 
           add_offense(node.loc.selector) do |corrector|
-            method = node.method_name
-
-            corrector.remove(dot_method_with_whitespace(method, node))
-            corrector.insert_before(node.receiver.loc.dot.begin, '.distinct')
+            autocorrect(corrector, node)
           end
         end
 
         private
 
+        def autocorrect(corrector, node)
+          method = node.method_name
+
+          corrector.remove(dot_method_with_whitespace(method, node))
+          if (dot = node.receiver.loc.dot)
+            corrector.insert_before(dot.begin, '.distinct')
+          else
+            corrector.insert_before(node.receiver, 'distinct.')
+          end
+        end
+
         def dot_method_with_whitespace(method, node)
           range_between(dot_method_begin_pos(method, node), node.loc.selector.end_pos)
         end

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

@@ -87,7 +87,7 @@ module RuboCop
 
         def environments
           @environments ||= begin
-            environments = cop_config['Environments'] || []
+            environments = cop_config['Environments'].dup || []
             environments << 'local' if target_rails_version >= 7.1
             environments
           end

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

@@ -7,6 +7,12 @@ module RuboCop
       # `ignored_columns` is necessary to drop a column from RDBMS, but you don't need it after the migration
       # to drop the column. You avoid forgetting to remove `ignored_columns` by this cop.
       #
+      # IMPORTANT: This cop can't be used to effectively check for unused columns because the development
+      # and production schema can be out of sync until the migration has been run on production. As such,
+      # this cop can cause `ignored_columns` to be removed even though the production schema still contains
+      # the column, which can lead to downtime when the migration is actually executed. Only enable this cop
+      # if you know your migrations will be run before any of your Rails applications boot with the modified code.
+      #
       # @example
       #   # bad
       #   class User < ApplicationRecord

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

@@ -29,7 +29,7 @@ module RuboCop
       #   validates :foo, numericality: true
       #   validates :foo, presence: true
       #   validates :foo, absence: true
-      #   validates :foo, size: true
+      #   validates :foo, length: true
       #   validates :foo, uniqueness: true
       #
       class Validation < Base
@@ -51,7 +51,7 @@ module RuboCop
           uniqueness
         ].freeze
 
-        RESTRICT_ON_SEND = TYPES.map { |p| "validates_#{p}_of".to_sym }.freeze
+        RESTRICT_ON_SEND = TYPES.map { |p| :"validates_#{p}_of" }.freeze
         ALLOWLIST = TYPES.map { |p| "validates :column, #{p}: value" }.freeze
 
         def on_send(node)
@@ -120,7 +120,9 @@ module RuboCop
         end
 
         def validate_type(node)
-          node.method_name.to_s.split('_')[1]
+          type = node.method_name.to_s.split('_')[1]
+
+          type == 'size' ? 'length' : type
         end
 
         def frozen_array_argument?(argument)

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

@@ -33,8 +33,8 @@ module RuboCop
 
         def_node_matcher :where_method_call?, <<~PATTERN
           {
-            (send _ :where (array $str_type? $_ ?))
-            (send _ :where $str_type? $_ ?)
+            (call _ :where (array $str_type? $_ ?))
+            (call _ :where $str_type? $_ ?)
           }
         PATTERN
 
@@ -55,6 +55,7 @@ module RuboCop
             end
           end
         end
+        alias on_csend on_send
 
         EQ_ANONYMOUS_RE = /\A([\w.]+)\s+=\s+\?\z/.freeze             # column = ?
         IN_ANONYMOUS_RE = /\A([\w.]+)\s+IN\s+\(\?\)\z/i.freeze       # column IN (?)

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

@@ -55,11 +55,11 @@ module RuboCop
         RESTRICT_ON_SEND = %i[exists?].freeze
 
         def_node_matcher :where_exists_call?, <<~PATTERN
-          (send (send _ :where $...) :exists?)
+          (call (call _ :where $...) :exists?)
         PATTERN
 
         def_node_matcher :exists_with_args?, <<~PATTERN
-          (send _ :exists? $...)
+          (call _ :exists? $...)
         PATTERN
 
         def on_send(node)
@@ -67,7 +67,7 @@ module RuboCop
             return unless convertable_args?(args)
 
             range = correction_range(node)
-            good_method = build_good_method(args)
+            good_method = build_good_method(args, dot: node.loc.dot)
             message = format(MSG, good_method: good_method, bad_method: range.source)
 
             add_offense(range, message: message) do |corrector|
@@ -75,6 +75,7 @@ module RuboCop
             end
           end
         end
+        alias on_csend on_send
 
         private
 
@@ -108,11 +109,11 @@ module RuboCop
           end
         end
 
-        def build_good_method(args)
+        def build_good_method(args, dot:)
           if exists_style?
             build_good_method_exists(args)
           elsif where_style?
-            build_good_method_where(args)
+            build_good_method_where(args, dot&.source || '.')
           end
         end
 
@@ -124,11 +125,11 @@ module RuboCop
           end
         end
 
-        def build_good_method_where(args)
+        def build_good_method_where(args, dot_source)
           if args.size > 1
-            "where(#{args.map(&:source).join(', ')}).exists?"
+            "where(#{args.map(&:source).join(', ')})#{dot_source}exists?"
           else
-            "where(#{args[0].source}).exists?"
+            "where(#{args[0].source})#{dot_source}exists?"
           end
         end
       end

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

@@ -36,7 +36,7 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return unless node.first_argument.sym_type?
+          return unless node.first_argument&.sym_type?
 
           root_receiver = root_receiver(node)
           where_node_and_argument(root_receiver) do |where_node, where_argument|
@@ -89,16 +89,20 @@ module RuboCop
           end
         end
 
+        # rubocop:disable Metrics/AbcSize
         def remove_where_method(corrector, node, where_node)
           range = range_between(where_node.loc.selector.begin_pos, where_node.loc.end.end_pos)
           if node.multiline? && !same_line?(node, where_node)
             range = range_by_whole_lines(range, include_final_newline: true)
-          else
+          elsif where_node.receiver
             corrector.remove(where_node.loc.dot)
+          else
+            corrector.remove(node.loc.dot)
           end
 
           corrector.remove(range)
         end
+        # rubocop:enable Metrics/AbcSize
 
         def same_line?(left_joins_node, where_node)
           left_joins_node.loc.selector.line == where_node.loc.selector.line

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

@@ -32,8 +32,8 @@ module RuboCop
 
         def_node_matcher :where_method_call?, <<~PATTERN
           {
-            (send _ :where (array $str_type? $_ ?))
-            (send _ :where $str_type? $_ ?)
+            (call _ :where (array $str_type? $_ ?))
+            (call _ :where $str_type? $_ ?)
           }
         PATTERN
 
@@ -46,7 +46,7 @@ module RuboCop
             column_and_value = extract_column_and_value(template_node, value_node)
             return unless column_and_value
 
-            good_method = build_good_method(*column_and_value)
+            good_method = build_good_method(node.loc.dot&.source, *column_and_value)
             message = format(MSG, good_method: good_method)
 
             add_offense(range, message: message) do |corrector|
@@ -54,6 +54,7 @@ module RuboCop
             end
           end
         end
+        alias on_csend on_send
 
         NOT_EQ_ANONYMOUS_RE = /\A([\w.]+)\s+(?:!=|<>)\s+\?\z/.freeze           # column != ?, column <> ?
         NOT_IN_ANONYMOUS_RE = /\A([\w.]+)\s+NOT\s+IN\s+\(\?\)\z/i.freeze       # column NOT IN (?)
@@ -86,13 +87,14 @@ module RuboCop
           [Regexp.last_match(1), value]
         end
 
-        def build_good_method(column, value)
+        def build_good_method(dot, column, value)
+          dot ||= '.'
           if column.include?('.')
             table, column = column.split('.')
 
-            "where.not(#{table}: { #{column}: #{value} })"
+            "where#{dot}not(#{table}: { #{column}: #{value} })"
           else
-            "where.not(#{column}: #{value})"
+            "where#{dot}not(#{column}: #{value})"
           end
         end
       end