rubocop-rails 2.14.2 → 2.19.1

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks for consistent uses of `to_fs` or `to_formatted_s`,
+      # depending on the cop's configuration.
+      #
+      # @example EnforcedStyle: to_fs (default)
+      #
+      #   # bad
+      #   time.to_formatted_s(:db)
+      #
+      #   # good
+      #   time.to_fs(:db)
+      #
+      # @example EnforcedStyle: to_formatted_s
+      #
+      #   # bad
+      #   time.to_fs(:db)
+      #
+      #   # good
+      #   time.to_formatted_s(:db)
+      #
+      class ToFormattedS < Base
+        include ConfigurableEnforcedStyle
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        minimum_target_rails_version 7.0
+
+        MSG = 'Use `%<prefer>s` instead.'
+        RESTRICT_ON_SEND = %i[to_formatted_s to_fs].freeze
+
+        def on_send(node)
+          return if node.method?(style)
+
+          add_offense(node.loc.selector, message: format(MSG, prefer: style)) do |corrector|
+            corrector.replace(node.loc.selector, style)
+          end
+        end
+        alias on_csend on_send
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Identifies passing any argument to `#to_s`.
+      #
+      # @safety
+      #   This cop is marked as unsafe because it may detect `#to_s` calls
+      #   that are not related to Active Support implementation.
+      #
+      # @example
+      #
+      #   # bad
+      #   obj.to_s(:delimited)
+      #
+      #   # good
+      #   obj.to_formatted_s(:delimited)
+      #
+      class ToSWithArgument < Base
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        # These types are defined by the following files in ActiveSupport:
+        #   lib/active_support/core_ext/array/conversions.rb
+        #   lib/active_support/core_ext/date/conversions.rb
+        #   lib/active_support/core_ext/date_time/conversions.rb
+        #   lib/active_support/core_ext/numeric/conversions.rb
+        #   lib/active_support/core_ext/range/conversions.rb
+        #   lib/active_support/core_ext/time/conversions.rb
+        #   lib/active_support/time_with_zone.rb
+        EXTENDED_FORMAT_TYPES = Set.new(
+          %i[
+            currency
+            db
+            delimited
+            human
+            human_size
+            inspect
+            iso8601
+            long
+            long_ordinal
+            nsec
+            number
+            percentage
+            phone
+            rfc822
+            rounded
+            short
+            time
+            usec
+          ]
+        )
+
+        MSG = 'Use `to_formatted_s` instead.'
+
+        RESTRICT_ON_SEND = %i[to_s].freeze
+
+        minimum_target_rails_version 7.0
+
+        def on_send(node)
+          return unless rails_extended_to_s?(node)
+
+          add_offense(node.loc.selector) do |corrector|
+            corrector.replace(node.loc.selector, 'to_formatted_s')
+          end
+        end
+        alias on_csend on_send
+
+        private
+
+        def rails_extended_to_s?(node)
+          node.first_argument&.sym_type? && EXTENDED_FORMAT_TYPES.include?(node.first_argument.value)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Identifies top-level `HashWithIndifferentAccess`.
+      # This has been soft-deprecated since Rails 5.1.
+      #
+      # @example
+      #   # bad
+      #   HashWithIndifferentAccess.new(foo: 'bar')
+      #
+      #   # good
+      #   ActiveSupport::HashWithIndifferentAccess.new(foo: 'bar')
+      #
+      class TopLevelHashWithIndifferentAccess < Base
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        minimum_target_rails_version 5.1
+
+        MSG = 'Avoid top-level `HashWithIndifferentAccess`.'
+
+        # @!method top_level_hash_with_indifferent_access?(node)
+        #   @param [RuboCop::AST::ConstNode] node
+        #   @return [Boolean]
+        def_node_matcher :top_level_hash_with_indifferent_access?, <<~PATTERN
+          (const {nil? cbase} :HashWithIndifferentAccess)
+        PATTERN
+
+        # @param [RuboCop::AST::ConstNode] node
+        def on_const(node)
+          return unless top_level_hash_with_indifferent_access?(node)
+          return if node.parent&.class_type? && node.parent.ancestors.any?(&:module_type?)
+
+          add_offense(node) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        private
+
+        def autocorrect(corrector, node)
+          corrector.insert_before(node.location.name, 'ActiveSupport::')
+        end
+      end
+    end
+  end
+end

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

@@ -3,10 +3,10 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of exit statements (namely `return`,
+      # Checks for the use of exit statements (namely `return`,
       # `break` and `throw`) in transactions. This is due to the eventual
       # unexpected behavior when using ActiveRecord >= 7, where transactions
-      # exitted using these statements are being rollbacked rather than
+      # exited using these statements are being rollbacked rather than
       # committed (pre ActiveRecord 7 behavior).
       #
       # As alternatives, it would be more intuitive to explicitly raise an
@@ -29,6 +29,11 @@ module RuboCop
       #     throw if user.active?
       #   end
       #
+      #   # bad, as `with_lock` implicitly opens a transaction too
+      #   user.with_lock do
+      #     throw if user.active?
+      #   end
+      #
       #   # good
       #   ApplicationRecord.transaction do
       #     # Rollback
@@ -40,25 +45,31 @@ module RuboCop
       #     # Commit
       #     next if user.active?
       #   end
-      #
-      # @see https://github.com/rails/rails/commit/15aa4200e083
       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].freeze
+        RESTRICT_ON_SEND = %i[transaction with_lock].freeze
 
         def_node_search :exit_statements, <<~PATTERN
           ({return | break | send nil? :throw} ...)
         PATTERN
 
+        def_node_matcher :rescue_body_return_node?, <<~PATTERN
+          (:resbody ...
+            ...
+            ({return | break | send nil? :throw} ...)
+            ...
+          )
+        PATTERN
+
         def on_send(node)
           return unless (parent = node.parent)
           return unless parent.block_type? && parent.body
 
           exit_statements(parent.body).each do |statement_node|
-            next if in_rescue?(statement_node) || nested_block?(statement_node)
+            next if statement_node.break_type? && nested_block?(statement_node)
 
             statement = statement(statement_node)
             message = format(MSG, statement: statement)
@@ -79,13 +90,7 @@ module RuboCop
           end
         end
 
-        def in_rescue?(statement_node)
-          statement_node.ancestors.find(&:rescue_type?)
-        end
-
         def nested_block?(statement_node)
-          return false unless statement_node.break_type?
-
           !statement_node.ancestors.find(&:block_type?).method?(:transaction)
         end
       end

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

@@ -54,11 +54,9 @@ module RuboCop
         NEWLINE = "\n"
         PATTERN = '[!^block (send (send %<type>s :pluck ...) :uniq ...)]'
 
-        def_node_matcher :conservative_node_match,
-                         format(PATTERN, type: 'const')
+        def_node_matcher :conservative_node_match, format(PATTERN, type: 'const')
 
-        def_node_matcher :aggressive_node_match,
-                         format(PATTERN, type: '_')
+        def_node_matcher :aggressive_node_match, format(PATTERN, type: '_')
 
         def on_send(node)
           uniq = if style == :conservative
@@ -80,8 +78,7 @@ module RuboCop
         private
 
         def dot_method_with_whitespace(method, node)
-          range_between(dot_method_begin_pos(method, node),
-                        node.loc.selector.end_pos)
+          range_between(dot_method_begin_pos(method, node), node.loc.selector.end_pos)
         end
 
         def dot_method_begin_pos(method, node)

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Rails
       # When you define a uniqueness validation in Active Record model,
-      # you also should add a unique index for the column. There are two reasons
+      # you also should add a unique index for the column. There are two reasons.
       # First, duplicated records may occur even if Active Record's validation
       # is defined.
       # Second, it will cause slow queries. The validation executes a `SELECT`
@@ -56,12 +56,10 @@ module RuboCop
 
         def with_index?(klass, table, names)
           # Compatibility for Rails 4.2.
-          add_indicies = schema.add_indicies_by(table_name: table_name(klass))
+          add_indices = schema.add_indices_by(table_name: table_name(klass))
 
-          (table.indices + add_indicies).any? do |index|
-            index.unique &&
-              (index.columns.to_set == names ||
-               include_column_names_in_expression_index?(index, names))
+          (table.indices + add_indices).any? do |index|
+            index.unique && (index.columns.to_set == names || include_column_names_in_expression_index?(index, names))
           end
         end
 
@@ -141,11 +139,20 @@ module RuboCop
           pairs = node.arguments.last
           return 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?
+
+          condition_hash_part?(uniqueness_node, keys: %i[if unless conditions])
+        end
+
+        def condition_hash_part?(pairs, keys:)
           pairs.each_pair.any? do |pair|
             key = pair.key
             next unless key.sym_type?
 
-            key.value == :if || key.value == :unless
+            keys.include?(key.value)
           end
         end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that environments called with `Rails.env` predicates
+      # Checks that environments called with `Rails.env` predicates
       # exist.
       # By default the cop allows three environments which Rails ships with:
       # `development`, `test`, and `production`.
@@ -19,8 +19,7 @@ module RuboCop
       #   Rails.env == 'production'
       class UnknownEnv < Base
         MSG = 'Unknown environment `%<name>s`.'
-        MSG_SIMILAR = 'Unknown environment `%<name>s`. ' \
-                      'Did you mean `%<similar>s`?'
+        MSG_SIMILAR = 'Unknown environment `%<name>s`. Did you mean `%<similar>s`?'
 
         def_node_matcher :rails_env?, <<~PATTERN
           (send
@@ -79,8 +78,7 @@ module RuboCop
 
         def unknown_env_predicate?(name)
           name = name.to_s
-          name.end_with?('?') &&
-            !environments.include?(name[0..-2])
+          name.end_with?('?') && !environments.include?(name[0..-2])
         end
 
         def unknown_env_name?(name)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop suggests you remove a column that does not exist in the schema from `ignored_columns`.
+      # Suggests you remove a column that does not exist in the schema from `ignored_columns`.
       # `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.
       #
@@ -28,12 +28,16 @@ module RuboCop
           (send self :ignored_columns= $array)
         PATTERN
 
+        def_node_matcher :appended_ignored_columns, <<~PATTERN
+          (op-asgn (send self :ignored_columns) :+ $array)
+        PATTERN
+
         def_node_matcher :column_name, <<~PATTERN
           ({str sym} $_)
         PATTERN
 
         def on_send(node)
-          return unless (columns = ignored_columns(node))
+          return unless (columns = ignored_columns(node) || appended_ignored_columns(node))
           return unless schema
 
           table = table(node)
@@ -43,6 +47,7 @@ module RuboCop
             check_column_existence(column_node, table)
           end
         end
+        alias on_op_asgn on_send
 
         private
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of old-style attribute validation macros.
+      # Checks for the use of old-style attribute validation macros.
       #
       # @example
       #   # bad
@@ -35,8 +35,7 @@ module RuboCop
       class Validation < Base
         extend AutoCorrector
 
-        MSG = 'Prefer the new style validations `%<prefer>s` over ' \
-              '`%<current>s`.'
+        MSG = 'Prefer the new style validations `%<prefer>s` over `%<current>s`.'
 
         TYPES = %w[
           acceptance
@@ -62,8 +61,7 @@ module RuboCop
 
           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)
+            return if !last_argument.literal? && !last_argument.splat_type? && !frozen_array_argument?(last_argument)
 
             corrector.replace(range, 'validates')
             correct_validate_type(corrector, node)
@@ -104,10 +102,7 @@ module RuboCop
         end
 
         def correct_validate_type_for_hash(corrector, node, arguments)
-          corrector.replace(
-            arguments.loc.expression,
-            "#{validate_type(node)}: #{braced_options(arguments)}"
-          )
+          corrector.replace(arguments, "#{validate_type(node)}: #{braced_options(arguments)}")
         end
 
         def correct_validate_type_for_array(corrector, node, arguments, loc)
@@ -121,10 +116,7 @@ module RuboCop
                           end
           end
 
-          corrector.replace(
-            loc.expression,
-            "#{attributes.join(', ')}, #{validate_type(node)}: true"
-          )
+          corrector.replace(loc.expression, "#{attributes.join(', ')}, #{validate_type(node)}: true")
         end
 
         def validate_type(node)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop identifies places where manually constructed SQL
+      # Identifies places where manually constructed SQL
       # in `where` can be replaced with `where(attribute: value)`.
       #
       # @safety
@@ -65,7 +65,7 @@ module RuboCop
         private
 
         def offense_range(node)
-          range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos)
+          range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
         end
 
         def extract_column_and_value(template_node, value_node)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces consistent style when using `exists?`.
+      # Enforces consistent style when using `exists?`.
       #
       # Two styles are supported for this cop. When EnforcedStyle is 'exists'
       # then the cop enforces `exists?(...)` over `where(...).exists?`.
@@ -12,7 +12,7 @@ module RuboCop
       # `where(...).exists?` over `exists?(...)`.
       #
       # @safety
-      #   This cop is unsafe for auto-correction because the behavior may change on the following case:
+      #   This cop is unsafe for autocorrection because the behavior may change on the following case:
       #
       #   [source,ruby]
       #   ----
@@ -105,7 +105,7 @@ module RuboCop
           if exists_style?
             node.receiver.loc.selector.join(node.loc.selector)
           elsif where_style?
-            node.loc.selector.with(end_pos: node.loc.expression.end_pos)
+            node.loc.selector.with(end_pos: node.source_range.end_pos)
           end
         end
 

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

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Use `where.missing(...)` to find missing relationship records.
+      #
+      # This cop is enabled in Rails 6.1 or higher.
+      #
+      # @example
+      #   # bad
+      #   Post.left_joins(:author).where(authors: { id: nil })
+      #
+      #   # good
+      #   Post.where.missing(:author)
+      #
+      class WhereMissing < Base
+        include RangeHelp
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        MSG = 'Use `where.missing(:%<left_joins_association>s)` instead of ' \
+              '`%<left_joins_method>s(:%<left_joins_association>s).where(%<where_association>s: { id: nil })`.'
+        RESTRICT_ON_SEND = %i[left_joins left_outer_joins].freeze
+
+        minimum_target_rails_version 6.1
+
+        # @!method where_node_and_argument(node)
+        def_node_search :where_node_and_argument, <<~PATTERN
+          $(send ... :where (hash <(pair $(sym _) (hash (pair (sym :id) (nil))))...> ))
+        PATTERN
+
+        # @!method missing_relationship(node)
+        def_node_search :missing_relationship, <<~PATTERN
+          (pair (sym _) (hash (pair (sym :id) (nil))))
+        PATTERN
+
+        def on_send(node)
+          return unless node.first_argument.sym_type?
+
+          root_receiver = root_receiver(node)
+          where_node_and_argument(root_receiver) do |where_node, where_argument|
+            next unless root_receiver == root_receiver(where_node)
+            next unless same_relationship?(where_argument, node.first_argument)
+
+            range = range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
+            register_offense(node, where_node, where_argument, range)
+            break
+          end
+        end
+
+        private
+
+        def root_receiver(node)
+          parent = node.parent
+          if !parent&.send_type? || parent.method?(:or) || parent.method?(:and)
+            node
+          else
+            root_receiver(parent)
+          end
+        end
+
+        def same_relationship?(where, left_joins)
+          where.value.to_s.match?(/^#{left_joins.value}s?$/)
+        end
+
+        def register_offense(node, where_node, where_argument, range)
+          add_offense(range, message: message(node, where_argument)) do |corrector|
+            corrector.replace(node.loc.selector, 'where.missing')
+            if multi_condition?(where_node.first_argument)
+              replace_where_method(corrector, where_node)
+            else
+              remove_where_method(corrector, node, where_node)
+            end
+          end
+        end
+
+        def replace_where_method(corrector, where_node)
+          missing_relationship(where_node) do |where_clause|
+            corrector.remove(replace_range(where_clause))
+          end
+        end
+
+        def replace_range(child)
+          if (right_sibling = child.right_sibling)
+            range_between(child.source_range.begin_pos, right_sibling.source_range.begin_pos)
+          else
+            range_between(child.left_sibling.source_range.end_pos, child.source_range.end_pos)
+          end
+        end
+
+        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
+            corrector.remove(where_node.loc.dot)
+          end
+
+          corrector.remove(range)
+        end
+
+        def same_line?(left_joins_node, where_node)
+          left_joins_node.loc.selector.line == where_node.loc.selector.line
+        end
+
+        def multi_condition?(where_arg)
+          where_arg.children.count > 1
+        end
+
+        def message(node, where_argument)
+          format(MSG, left_joins_association: node.first_argument.value, left_joins_method: node.method_name,
+                      where_association: where_argument.value)
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop identifies places where manually constructed SQL
+      # Identifies places where manually constructed SQL
       # in `where` can be replaced with `where.not(...)`.
       #
       # @example
@@ -64,7 +64,7 @@ module RuboCop
         private
 
         def offense_range(node)
-          range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos)
+          range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
         end
 
         def extract_column_and_value(template_node, value_node)

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Identifies calls to `where.not` with multiple hash arguments.
+      #
+      # The behavior of `where.not` changed in Rails 6.1. Prior to the change,
+      # `.where.not(trashed: true, role: 'admin')` evaluated to
+      # `WHERE trashed != TRUE AND role != 'admin'`.
+      # From Rails 6.1 onwards, this executes the query
+      # `WHERE NOT (trashed == TRUE AND roles == 'admin')`.
+      #
+      # @example
+      #   # bad
+      #   User.where.not(trashed: true, role: 'admin')
+      #   User.where.not(trashed: true, role: ['moderator', 'admin'])
+      #   User.joins(:posts).where.not(posts: { trashed: true, title: 'Rails' })
+      #
+      #   # good
+      #   User.where.not(trashed: true)
+      #   User.where.not(role: ['moderator', 'admin'])
+      #   User.where.not(trashed: true).where.not(role: ['moderator', 'admin'])
+      #   User.where.not('trashed = ? OR role = ?', true, 'admin')
+      class WhereNotWithMultipleConditions < Base
+        MSG = 'Use a SQL statement instead of `where.not` with multiple conditions.'
+        RESTRICT_ON_SEND = %i[not].freeze
+
+        def_node_matcher :where_not_call?, <<~PATTERN
+          (send (send _ :where) :not $...)
+        PATTERN
+
+        def on_send(node)
+          where_not_call?(node) do |args|
+            next unless args[0]&.hash_type?
+            next unless multiple_arguments_hash? args[0]
+
+            range = node.receiver.loc.selector.with(end_pos: node.source_range.end_pos)
+
+            add_offense(range)
+          end
+        end
+
+        private
+
+        def multiple_arguments_hash?(hash)
+          return true if hash.pairs.size >= 2
+          return false unless hash.values[0]&.hash_type?
+
+          multiple_arguments_hash?(hash.values[0])
+        end
+      end
+    end
+  end
+end