rubocop-rails 2.19.1 → 2.30.3

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

@@ -21,12 +21,15 @@ module RuboCop
       #   # bad
       #   Time.now
       #   Time.parse('2015-03-02T19:05:37')
+      #   '2015-03-02T19:05:37'.to_time
       #
       #   # good
       #   Time.current
       #   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`.
@@ -44,18 +47,16 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Do not use `%<current>s` without zone. Use `%<prefer>s` instead.'
-
         MSG_ACCEPTABLE = 'Do not use `%<current>s` without zone. Use one of %<prefer>s instead.'
-
         MSG_LOCALTIME = 'Do not use `Time.localtime` without offset or zone.'
+        MSG_STRING_TO_TIME = 'Do not use `String#to_time` without zone. Use `Time.zone.parse` instead.'
 
         GOOD_METHODS = %i[zone zone_default find_zone find_zone!].freeze
-
         DANGEROUS_METHODS = %i[now local new parse at].freeze
-
         ACCEPTED_METHODS = %i[in_time_zone utc getlocal xmlschema iso8601 jisx0301 rfc3339 httpdate to_i to_f].freeze
+        TIMEZONE_SPECIFIER = /([A-Za-z]|[+-]\d{2}:?\d{2})\z/.freeze
 
-        TIMEZONE_SPECIFIER = /([A-z]|[+-]\d{2}:?\d{2})\z/.freeze
+        RESTRICT_ON_SEND = %i[to_time].freeze
 
         def on_const(node)
           mod, klass = *node
@@ -66,6 +67,16 @@ module RuboCop
           check_time_node(klass, node.parent) if klass == :Time
         end
 
+        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?
+          end
+        end
+        alias on_csend on_send
+
         private
 
         def autocorrect(corrector, node)
@@ -86,11 +97,9 @@ module RuboCop
         end
 
         def autocorrect_time_new(node, corrector)
-          if node.arguments?
-            corrector.replace(node.loc.selector, 'local')
-          else
-            corrector.replace(node.loc.selector, 'now')
-          end
+          replacement = replacement(node)
+
+          corrector.replace(node.loc.selector, replacement)
         end
 
         # remove redundant `.in_time_zone` from `Time.zone.now.in_time_zone`
@@ -172,7 +181,7 @@ module RuboCop
 
         def safe_method(method_name, node)
           if %w[new current].include?(method_name)
-            node.arguments? ? 'local' : 'now'
+            replacement(node)
           else
             method_name
           end
@@ -248,6 +257,12 @@ module RuboCop
               pair.key.sym_type? && pair.key.value == :in && !pair.value.nil_type?
             end
         end
+
+        def replacement(node)
+          return 'now' unless node.arguments?
+
+          node.first_argument.str_type? ? 'parse' : 'local'
+        end
       end
     end
   end

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

@@ -13,6 +13,12 @@ module RuboCop
       # error when rollback is desired, and to use `next` when commit is
       # desired.
       #
+      # 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
@@ -34,6 +40,11 @@ module RuboCop
       #     throw if user.active?
       #   end
       #
+      #   # bad, as `with_lock` implicitly opens a transaction too
+      #   ApplicationRecord.with_lock do
+      #     break if user.active?
+      #   end
+      #
       #   # good
       #   ApplicationRecord.transaction do
       #     # Rollback
@@ -45,12 +56,16 @@ module RuboCop
       #     # Commit
       #     next if user.active?
       #   end
+      #
+      # @example TransactionMethods: ["custom_transaction"]
+      #   # bad
+      #   CustomModel.custom_transaction do
+      #     return if user.active?
+      #   end
+      #
       class TransactionExitStatement < Base
-        MSG = <<~MSG.chomp
-          Exit statement `%<statement>s` is not allowed. Use `raise` (rollback) or `next` (commit).
-        MSG
-
-        RESTRICT_ON_SEND = %i[transaction with_lock].freeze
+        MSG = 'Exit statement `%<statement>s` is not allowed. Use `raise` (rollback) or `next` (commit).'
+        BUILT_IN_TRANSACTION_METHODS = %i[transaction with_lock].freeze
 
         def_node_search :exit_statements, <<~PATTERN
           ({return | break | send nil? :throw} ...)
@@ -65,10 +80,10 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return unless (parent = node.parent)
-          return unless parent.block_type? && parent.body
+          return if target_rails_version >= 7.2
+          return unless in_transaction_block?(node)
 
-          exit_statements(parent.body).each do |statement_node|
+          exit_statements(node.parent.body).each do |statement_node|
             next if statement_node.break_type? && nested_block?(statement_node)
 
             statement = statement(statement_node)
@@ -80,6 +95,13 @@ module RuboCop
 
         private
 
+        def in_transaction_block?(node)
+          return false unless transaction_method_name?(node.method_name)
+          return false unless (parent = node.parent)
+
+          parent.any_block_type? && parent.body
+        end
+
         def statement(statement_node)
           if statement_node.return_type?
             'return'
@@ -91,7 +113,16 @@ module RuboCop
         end
 
         def nested_block?(statement_node)
-          !statement_node.ancestors.find(&:block_type?).method?(:transaction)
+          name = statement_node.ancestors.find(&:any_block_type?).children.first.method_name
+          !transaction_method_name?(name)
+        end
+
+        def transaction_method_name?(method_name)
+          BUILT_IN_TRANSACTION_METHODS.include?(method_name) || transaction_method?(method_name)
+        end
+
+        def transaction_method?(method_name)
+          cop_config.fetch('TransactionMethods', []).include?(method_name.to_s)
         end
       end
     end

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

@@ -51,43 +51,28 @@ module RuboCop
 
         MSG = 'Use `distinct` before `pluck`.'
         RESTRICT_ON_SEND = %i[uniq].freeze
-        NEWLINE = "\n"
-        PATTERN = '[!^block (send (send %<type>s :pluck ...) :uniq ...)]'
 
-        def_node_matcher :conservative_node_match, format(PATTERN, type: 'const')
-
-        def_node_matcher :aggressive_node_match, format(PATTERN, type: '_')
+        def_node_matcher :uniq_before_pluck, '[!^any_block $(send $(send _ :pluck ...) :uniq ...)]'
 
         def on_send(node)
-          uniq = if style == :conservative
-                   conservative_node_match(node)
-                 else
-                   aggressive_node_match(node)
-                 end
-
-          return unless uniq
-
-          add_offense(node.loc.selector) do |corrector|
-            method = node.method_name
+          uniq_before_pluck(node) do |uniq_node, pluck_node|
+            next if style == :conservative && !pluck_node.receiver&.const_type?
 
-            corrector.remove(dot_method_with_whitespace(method, node))
-            corrector.insert_before(node.receiver.loc.dot.begin, '.distinct')
+            add_offense(uniq_node.loc.selector) do |corrector|
+              autocorrect(corrector, uniq_node, pluck_node)
+            end
           end
         end
 
         private
 
-        def dot_method_with_whitespace(method, node)
-          range_between(dot_method_begin_pos(method, node), node.loc.selector.end_pos)
-        end
-
-        def dot_method_begin_pos(method, node)
-          lines = node.source.split(NEWLINE)
+        def autocorrect(corrector, uniq_node, pluck_node)
+          corrector.remove(range_between(pluck_node.loc.end.end_pos, uniq_node.loc.selector.end_pos))
 
-          if lines.last.strip == ".#{method}"
-            node.source.rindex(NEWLINE)
+          if (dot = pluck_node.loc.dot)
+            corrector.insert_before(dot.begin, '.distinct')
           else
-            node.loc.dot.begin_pos
+            corrector.insert_before(pluck_node, 'distinct.')
           end
         end
       end

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

@@ -31,11 +31,11 @@ module RuboCop
         RESTRICT_ON_SEND = %i[validates].freeze
 
         def on_send(node)
-          return unless uniqueness_part(node)
-          return if condition_part?(node)
           return unless schema
+          return unless (uniqueness_part = uniqueness_part(node))
+          return if uniqueness_part.falsey_literal? || condition_part?(node, uniqueness_part)
 
-          klass, table, names = find_schema_information(node)
+          klass, table, names = find_schema_information(node, uniqueness_part)
           return unless names
           return if with_index?(klass, table, names)
 
@@ -44,12 +44,12 @@ module RuboCop
 
         private
 
-        def find_schema_information(node)
+        def find_schema_information(node, uniqueness_part)
           klass = class_node(node)
           return unless klass
 
           table = schema.table_by(name: table_name(klass))
-          names = column_names(node)
+          names = column_names(node, uniqueness_part)
 
           [klass, table, names]
         end
@@ -71,12 +71,12 @@ module RuboCop
           end
         end
 
-        def column_names(node)
+        def column_names(node, uniqueness_part)
           arg = node.first_argument
-          return unless arg.str_type? || arg.sym_type?
+          return unless arg.type?(:str, :sym)
 
           ret = [arg.value]
-          names_from_scope = column_names_from_scope(node)
+          names_from_scope = column_names_from_scope(uniqueness_part)
           ret.concat(names_from_scope) if names_from_scope
 
           ret = ret.flat_map do |name|
@@ -90,11 +90,10 @@ module RuboCop
           ret.include?(nil) ? nil : ret.to_set
         end
 
-        def column_names_from_scope(node)
-          uniq = uniqueness_part(node)
-          return unless uniq.hash_type?
+        def column_names_from_scope(uniqueness_part)
+          return unless uniqueness_part.hash_type?
 
-          scope = find_scope(uniq)
+          scope = find_scope(uniqueness_part)
           return unless scope
 
           scope = unfreeze_scope(scope)
@@ -125,8 +124,8 @@ module RuboCop
         end
 
         def uniqueness_part(node)
-          pairs = node.arguments.last
-          return unless pairs.hash_type?
+          pairs = node.last_argument
+          return unless pairs&.hash_type?
 
           pairs.each_pair.find do |pair|
             next unless pair.key.sym_type? && pair.key.value == :uniqueness
@@ -135,14 +134,11 @@ module RuboCop
           end
         end
 
-        def condition_part?(node)
-          pairs = node.arguments.last
-          return unless pairs.hash_type?
-
+        def condition_part?(node, uniqueness_node)
+          pairs = node.last_argument
+          return false unless pairs.hash_type?
           return true if condition_hash_part?(pairs, keys: %i[if unless])
-
-          uniqueness_node = uniqueness_part(node)
-          return unless uniqueness_node&.hash_type?
+          return false unless uniqueness_node.hash_type?
 
           condition_hash_part?(uniqueness_node, keys: %i[if unless conditions])
         end

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

@@ -86,7 +86,11 @@ module RuboCop
         end
 
         def environments
-          cop_config['Environments']
+          @environments ||= begin
+            environments = cop_config['Environments'].dup || []
+            environments << 'local' if target_rails_version >= 7.1
+            environments
+          end
         end
       end
     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/unused_render_content.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # If you try to render content along with a non-content status code (100-199, 204, 205, or 304),
+      # it will be dropped from the response.
+      #
+      # This cop checks for uses of `render` which specify both body content and a non-content status.
+      #
+      # @example
+      #   # bad
+      #   render 'foo', status: :continue
+      #   render status: 100, plain: 'Ruby!'
+      #
+      #   # good
+      #   head :continue
+      #   head 100
+      class UnusedRenderContent < Base
+        include RangeHelp
+
+        MSG = 'Do not specify body content for a response with a non-content status code'
+        RESTRICT_ON_SEND = %i[render].freeze
+        NON_CONTENT_STATUS_CODES = Set[*100..199, 204, 205, 304] & ::Rack::Utils::SYMBOL_TO_STATUS_CODE.values
+        NON_CONTENT_STATUSES = Set[
+          *::Rack::Utils::SYMBOL_TO_STATUS_CODE.invert.fetch_values(*NON_CONTENT_STATUS_CODES)
+        ]
+        BODY_OPTIONS = Set[
+          :action,
+          :body,
+          :content_type,
+          :file,
+          :html,
+          :inline,
+          :json,
+          :js,
+          :layout,
+          :plain,
+          :raw,
+          :template,
+          :text,
+          :xml
+        ]
+
+        def_node_matcher :non_content_status?, <<~PATTERN
+          (pair
+            (sym :status)
+            {(sym NON_CONTENT_STATUSES) (int NON_CONTENT_STATUS_CODES)}
+          )
+        PATTERN
+
+        def_node_matcher :unused_render_content?, <<~PATTERN
+          (send nil? :render {
+            (hash <#non_content_status? $(pair (sym BODY_OPTIONS) _) ...>) |
+            $({str sym} _) (hash <#non_content_status? ...>)
+          })
+        PATTERN
+
+        def on_send(node)
+          unused_render_content?(node) do |unused_content_node|
+            add_offense(unused_content_node)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ module RuboCop
       # @example
       #   # bad
       #   validates_acceptance_of :foo
+      #   validates_comparison_of :foo
       #   validates_confirmation_of :foo
       #   validates_exclusion_of :foo
       #   validates_format_of :foo
@@ -22,6 +23,7 @@ module RuboCop
       #   # good
       #   validates :foo, acceptance: true
       #   validates :foo, confirmation: true
+      #   validates :foo, comparison: true
       #   validates :foo, exclusion: true
       #   validates :foo, format: true
       #   validates :foo, inclusion: true
@@ -29,7 +31,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
@@ -39,6 +41,7 @@ module RuboCop
 
         TYPES = %w[
           acceptance
+          comparison
           confirmation
           exclusion
           format
@@ -51,16 +54,16 @@ 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)
           return if node.receiver
+          return unless (last_argument = node.last_argument)
 
           range = node.loc.selector
 
           add_offense(range, message: message(node)) do |corrector|
-            last_argument = node.arguments.last
             return if !last_argument.literal? && !last_argument.splat_type? && !frozen_array_argument?(last_argument)
 
             corrector.replace(range, 'validates')
@@ -120,7 +123,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

@@ -4,7 +4,8 @@ module RuboCop
   module Cop
     module Rails
       # Identifies places where manually constructed SQL
-      # in `where` can be replaced with `where(attribute: value)`.
+      # in `where` and `where.not` can be replaced with
+      # `where(attribute: value)` and `where.not(attribute: value)`.
       #
       # @safety
       #   This cop's autocorrection is unsafe because is may change SQL.
@@ -13,6 +14,7 @@ module RuboCop
       # @example
       #   # bad
       #   User.where('name = ?', 'Gabe')
+      #   User.where.not('name = ?', 'Gabe')
       #   User.where('name = :name', name: 'Gabe')
       #   User.where('name IS NULL')
       #   User.where('name IN (?)', ['john', 'jane'])
@@ -21,6 +23,7 @@ module RuboCop
       #
       #   # good
       #   User.where(name: 'Gabe')
+      #   User.where.not(name: 'Gabe')
       #   User.where(name: nil)
       #   User.where(name: ['john', 'jane'])
       #   User.where(users: { name: 'Gabe' })
@@ -29,25 +32,27 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Use `%<good_method>s` instead of manually constructing SQL.'
-        RESTRICT_ON_SEND = %i[where].freeze
+        RESTRICT_ON_SEND = %i[where not].freeze
 
         def_node_matcher :where_method_call?, <<~PATTERN
           {
-            (send _ :where (array $str_type? $_ ?))
-            (send _ :where $str_type? $_ ?)
+            (call _ {:where :not} (array $str_type? $_ ?))
+            (call _ {:where :not} $str_type? $_ ?)
           }
         PATTERN
 
         def on_send(node)
+          return if node.method?(:not) && !where_not?(node)
+
           where_method_call?(node) do |template_node, value_node|
             value_node = value_node.first
 
             range = offense_range(node)
 
-            column_and_value = extract_column_and_value(template_node, value_node)
-            return unless column_and_value
+            column, value = extract_column_and_value(template_node, value_node)
+            return unless value
 
-            good_method = build_good_method(*column_and_value)
+            good_method = build_good_method(node.method_name, column, value)
             message = format(MSG, good_method: good_method)
 
             add_offense(range, message: message) do |corrector|
@@ -55,6 +60,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 (?)
@@ -68,11 +74,12 @@ module RuboCop
           range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
         end
 
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
         def extract_column_and_value(template_node, value_node)
           value =
             case template_node.value
             when EQ_ANONYMOUS_RE, IN_ANONYMOUS_RE
-              value_node.source
+              value_node&.source
             when EQ_NAMED_RE, IN_NAMED_RE
               return unless value_node&.hash_type?
 
@@ -84,18 +91,28 @@ module RuboCop
               return
             end
 
-          [Regexp.last_match(1), value]
+          column_qualifier = Regexp.last_match(1)
+          return if column_qualifier.count('.') > 1
+
+          [column_qualifier, value]
         end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
-        def build_good_method(column, value)
+        def build_good_method(method_name, column, value)
           if column.include?('.')
             table, column = column.split('.')
 
-            "where(#{table}: { #{column}: #{value} })"
+            "#{method_name}(#{table}: { #{column}: #{value} })"
           else
-            "where(#{column}: #{value})"
+            "#{method_name}(#{column}: #{value})"
           end
         end
+
+        def where_not?(node)
+          return false unless (receiver = node.receiver)
+
+          receiver.send_type? && receiver.method?(:where)
+        end
       end
     end
   end

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

@@ -39,7 +39,6 @@ module RuboCop
       #   # bad
       #   User.exists?(name: 'john')
       #   User.exists?(['name = ?', 'john'])
-      #   User.exists?('name = ?', 'john')
       #   user.posts.exists?(published: true)
       #
       #   # good
@@ -56,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)
@@ -68,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|
@@ -76,6 +75,7 @@ module RuboCop
             end
           end
         end
+        alias on_csend on_send
 
         private
 
@@ -109,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
 
@@ -125,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