From 08547c34618646e157366cb207a8df9c6ccb2eb5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cristi=C3=A1n=20P=C3=A9rez?= <cristian@wenoa.studio>
Date: Mon, 17 Jun 2024 13:34:54 -0300
Subject: [PATCH] MONGOID-5786: Fix some compatibility issues with Enumerable
 API (#5831)

* Fix compatibility with Enumerable#sum API

* Update documentation for the sum() method

* Update documentation for sum() method

---------

Co-authored-by: Jamis Buck <jamis.buck@mongodb.com>
---
 lib/mongoid/contextual/aggregable/memory.rb       |  5 +++--
 lib/mongoid/contextual/aggregable/mongo.rb        |  7 +++++--
 spec/mongoid/contextual/aggregable/memory_spec.rb | 11 +++++++++++
 spec/mongoid/contextual/aggregable/mongo_spec.rb  | 11 +++++++++++
 4 files changed, 30 insertions(+), 4 deletions(-)

diff --git a/lib/mongoid/contextual/aggregable/memory.rb b/lib/mongoid/contextual/aggregable/memory.rb
index 7e328fae92..ae4aacffd2 100644
--- a/lib/mongoid/contextual/aggregable/memory.rb
+++ b/lib/mongoid/contextual/aggregable/memory.rb
@@ -90,11 +90,12 @@ def min(field = nil)
         # @example Get the sum for the provided block.
         #   aggregable.sum(&:likes)
         #
-        # @param [ Symbol ] field The field to sum.
+        # @param [ Symbol | Numeric ] field The field to sum, or the intial
+        #   value of the sum when a block is given.
         #
         # @return [ Numeric ] The sum value.
         def sum(field = nil)
-          return super() if block_given?
+          return super(field || 0) if block_given?
 
           aggregate_by(field, :sum) || 0
         end
diff --git a/lib/mongoid/contextual/aggregable/mongo.rb b/lib/mongoid/contextual/aggregable/mongo.rb
index 1b050281f5..a7972ae0a2 100644
--- a/lib/mongoid/contextual/aggregable/mongo.rb
+++ b/lib/mongoid/contextual/aggregable/mongo.rb
@@ -96,11 +96,14 @@ def min(field = nil)
         # @example Get the sum for the provided block.
         #   aggregable.sum(&:likes)
         #
-        # @param [ Symbol ] field The field to sum.
+        # @param [ Symbol | Numeric ] field The field to sum, or the initial
+        #    value of the sum when a block is given.
         #
         # @return [ Float ] The sum value.
         def sum(field = nil)
-          block_given? ? super() : aggregates(field)["sum"] || 0
+          return super(field || 0) if block_given?
+
+          aggregates(field)["sum"] || 0
         end
 
         private
diff --git a/spec/mongoid/contextual/aggregable/memory_spec.rb b/spec/mongoid/contextual/aggregable/memory_spec.rb
index c485044f23..804bbce8d5 100644
--- a/spec/mongoid/contextual/aggregable/memory_spec.rb
+++ b/spec/mongoid/contextual/aggregable/memory_spec.rb
@@ -570,5 +570,16 @@
         expect(sum).to eq(1500)
       end
     end
+
+    context "when provided a block with initial value" do
+
+      let(:sum) do
+        context.sum(500, &:likes)
+      end
+
+      it "returns the sum for the provided block starting from initial value" do
+        expect(sum).to eq(2000)
+      end
+    end
   end
 end
diff --git a/spec/mongoid/contextual/aggregable/mongo_spec.rb b/spec/mongoid/contextual/aggregable/mongo_spec.rb
index 75615da870..307b708c28 100644
--- a/spec/mongoid/contextual/aggregable/mongo_spec.rb
+++ b/spec/mongoid/contextual/aggregable/mongo_spec.rb
@@ -515,6 +515,17 @@
           expect(sum).to eq(1500)
         end
       end
+
+      context "when provided a block with initial value" do
+
+        let(:sum) do
+          context.sum(500, &:likes)
+        end
+
+        it "returns the sum for the provided block starting from initial value" do
+          expect(sum).to eq(2000)
+        end
+      end
     end
   end