Merge pull request rails#55269 from fatkodima/delete_all-annotate

Fix `annotate` comments to propagate to `update_all`/`delete_all`

Author: fatkodima

activerecord/lib/arel/crud.rb

@@ -21,6 +21,7 @@ def compile_update(values, key = nil)
       um.offset(offset)
       um.order(*orders)
       um.wheres = constraints
+      um.comment(comment)
       um.key = key
 
       um.ast.groups = @ctx.groups
@@ -34,6 +35,7 @@ def compile_delete(key = nil)
       dm.offset(offset)
       dm.order(*orders)
       dm.wheres = constraints
+      dm.comment(comment)
       dm.key = key
       dm.ast.groups = @ctx.groups
       @ctx.havings.each { |h| dm.having(h) }

activerecord/lib/arel/delete_manager.rb

@@ -28,5 +28,10 @@ def having(expr)
       @ast.havings << expr
       self
     end
+
+    def comment(value)
+      @ast.comment = value
+      self
+    end
   end
 end

activerecord/lib/arel/nodes/delete_statement.rb

@@ -3,7 +3,7 @@
 module Arel # :nodoc: all
   module Nodes
     class DeleteStatement < Arel::Nodes::Node
-      attr_accessor :relation, :wheres, :groups, :havings, :orders, :limit, :offset, :key
+      attr_accessor :relation, :wheres, :groups, :havings, :orders, :limit, :offset, :comment, :key
 
       def initialize(relation = nil, wheres = [])
         super()
@@ -14,6 +14,7 @@ def initialize(relation = nil, wheres = [])
         @orders = []
         @limit = nil
         @offset = nil
+        @comment = nil
         @key = nil
       end
 
@@ -24,7 +25,7 @@ def initialize_copy(other)
       end
 
       def hash
-        [self.class, @relation, @wheres, @orders, @limit, @offset, @key].hash
+        [self.class, @relation, @wheres, @orders, @limit, @offset, @comment, @key].hash
       end
 
       def eql?(other)
@@ -36,6 +37,7 @@ def eql?(other)
           self.havings == other.havings &&
           self.limit == other.limit &&
           self.offset == other.offset &&
+          self.comment == other.comment &&
           self.key == other.key
       end
       alias :== :eql?

activerecord/lib/arel/nodes/update_statement.rb

@@ -3,7 +3,7 @@
 module Arel # :nodoc: all
   module Nodes
     class UpdateStatement < Arel::Nodes::Node
-      attr_accessor :relation, :wheres, :values, :groups, :havings, :orders, :limit, :offset, :key
+      attr_accessor :relation, :wheres, :values, :groups, :havings, :orders, :limit, :offset, :comment, :key
 
       def initialize(relation = nil)
         super()
@@ -15,6 +15,7 @@ def initialize(relation = nil)
         @orders   = []
         @limit    = nil
         @offset   = nil
+        @comment  = nil
         @key      = nil
       end
 
@@ -25,7 +26,7 @@ def initialize_copy(other)
       end
 
       def hash
-        [@relation, @wheres, @values, @orders, @limit, @offset, @key].hash
+        [@relation, @wheres, @values, @orders, @limit, @offset, @comment, @key].hash
       end
 
       def eql?(other)
@@ -38,6 +39,7 @@ def eql?(other)
           self.orders == other.orders &&
           self.limit == other.limit &&
           self.offset == other.offset &&
+          self.comment == other.comment &&
           self.key == other.key
       end
       alias :== :eql?

activerecord/lib/arel/select_manager.rb

@@ -255,8 +255,12 @@ def source
     end
 
     def comment(*values)
-      @ctx.comment = Nodes::Comment.new(values)
-      self
+      if values.any?
+        @ctx.comment = Nodes::Comment.new(values)
+        self
+      else
+        @ctx.comment
+      end
     end
 
     private

activerecord/lib/arel/update_manager.rb

@@ -45,5 +45,10 @@ def having(expr)
       @ast.havings << expr
       self
     end
+
+    def comment(value)
+      @ast.comment = value
+      self
+    end
   end
 end

activerecord/lib/arel/visitors/dot.rb

@@ -150,6 +150,7 @@ def visit_Arel_Nodes_UpdateStatement(o)
           visit_edge o, "orders"
           visit_edge o, "limit"
           visit_edge o, "offset"
+          visit_edge o, "comment"
           visit_edge o, "key"
         end
 
@@ -159,6 +160,7 @@ def visit_Arel_Nodes_DeleteStatement(o)
           visit_edge o, "orders"
           visit_edge o, "limit"
           visit_edge o, "offset"
+          visit_edge o, "comment"
           visit_edge o, "key"
         end
 

activerecord/lib/arel/visitors/postgresql.rb

@@ -29,6 +29,7 @@ def visit_Arel_Nodes_UpdateStatement(o, collector)
           collect_nodes_for o.wheres, collector, " WHERE ", " AND "
           collect_nodes_for o.orders, collector, " ORDER BY "
           maybe_visit o.limit, collector
+          maybe_visit o.comment, collector
         end
 
         # In the simple case, PostgreSQL allows us to place FROM or JOINs directly into the UPDATE

activerecord/lib/arel/visitors/sqlite.rb

@@ -29,6 +29,7 @@ def visit_Arel_Nodes_UpdateStatement(o, collector)
           collect_nodes_for o.wheres, collector, " WHERE ", " AND "
           collect_nodes_for o.orders, collector, " ORDER BY "
           maybe_visit o.limit, collector
+          maybe_visit o.comment, collector
         end
 
         def prepare_update_statement(o)

activerecord/lib/arel/visitors/to_sql.rb

@@ -35,6 +35,7 @@ def visit_Arel_Nodes_DeleteStatement(o, collector)
           collect_nodes_for o.wheres, collector, " WHERE ", " AND "
           collect_nodes_for o.orders, collector, " ORDER BY "
           maybe_visit o.limit, collector
+          maybe_visit o.comment, collector
         end
 
         def visit_Arel_Nodes_UpdateStatement(o, collector)
@@ -48,6 +49,7 @@ def visit_Arel_Nodes_UpdateStatement(o, collector)
           collect_nodes_for o.wheres, collector, " WHERE ", " AND "
           collect_nodes_for o.orders, collector, " ORDER BY "
           maybe_visit o.limit, collector
+          maybe_visit o.comment, collector
         end
 
         def visit_Arel_Nodes_InsertStatement(o, collector)