Adding upsert (before|after|around) callback

CHANGELOG.md

@@ -7,6 +7,14 @@ For instructions on upgrading to newer versions, visit
 
 ### New Features
 
+* A new callback has been introduced: `upsert`, which runs when calling
+  `document.upsert` since Mongoid does not know if the document is to be
+  treated as new or persisted. With this come the model callbacks:
+
+        before_upsert
+        after_upsert
+        around_upsert
+
 * \#2080/\#2087 The database or session that Mongoid persists to can now be
   overridden on a global level for cases where `Model#with` is not a viable
   option.

lib/mongoid/callbacks.rb

@@ -12,15 +12,18 @@ module Callbacks
       :after_initialize,
       :after_save,
       :after_update,
+      :after_upsert,
       :after_validation,
       :around_create,
       :around_destroy,
       :around_save,
       :around_update,
+      :around_upsert,
       :before_create,
       :before_destroy,
       :before_save,
       :before_update,
+      :before_upsert,
       :before_validation
     ]
 
@@ -30,7 +33,7 @@ module Callbacks
 
       define_model_callbacks :initialize, only: :after
       define_model_callbacks :build, only: :after
-      define_model_callbacks :create, :destroy, :save, :update
+      define_model_callbacks :create, :destroy, :save, :update, :upsert
     end
 
     # Run only the after callbacks for the specific event.

lib/mongoid/persistence.rb

@@ -3,6 +3,7 @@
 require "mongoid/persistence/deletion"
 require "mongoid/persistence/insertion"
 require "mongoid/persistence/modification"
+require "mongoid/persistence/upsertion"
 require "mongoid/persistence/operations"
 
 module Mongoid

lib/mongoid/persistence/operations/upsert.rb

@@ -7,7 +7,7 @@ module Operations
       # document has been modified or not, it will be sent to the db and Mongo
       # will determin whether or not to insert or update.
       class Upsert
-        include Modification, Operations
+        include Upsertion, Operations
 
         # Persist the upsert operation.
         #

lib/mongoid/persistence/upsertion.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Mongoid
+  module Persistence
+
+    # Contains common logic for upsert operations.
+    module Upsertion
+
+      # Wrap all the common upsert logic for root docments.
+      #
+      # @example Execute common upsert logic.
+      #   prepare do |doc|
+      #     collection.find({ :_id => 1 }).upsert({ name: "test" }, [ :upsert ])
+      #   end
+      #
+      # @param [ Proc ] block The block to call.
+      #
+      # @return [ true, false ] If the save passed or not.
+      #
+      # @since 3.0.0
+      def prepare(&block)
+        return false if validating? && document.invalid?(:update)
+        result = document.run_callbacks(:upsert) do
+          yield(document); true
+        end
+        document.post_persist unless result == false
+        result
+      end
+    end
+  end
+end

spec/app/models/band.rb

@@ -9,8 +9,13 @@ class Band
   field :likes, type: Integer
   field :views, type: Integer
   field :rating, type: Float
+  field :upserted, type: Boolean, default: false
 
   embeds_many :records, cascade_callbacks: true
   embeds_many :notes, as: :noteable, cascade_callbacks: true, validate: false
   embeds_one :label, cascade_callbacks: true
+
+  after_upsert do |doc|
+    doc.upserted = true
+  end
 end

spec/mongoid/persistence/operations/upsert_spec.rb

@@ -25,6 +25,10 @@
       it "returns true" do
         persisted.should be_true
       end
+
+      it "runs the upsert callbacks" do
+        band.upserted.should be_true
+      end
     end
 
     context "when the document is not new" do