mm_partial_update 0.1.0 → 0.1.1

data/README.rdoc

@@ -14,7 +14,11 @@ To activate the plugin, add 'mm_partial_update' to your gemfile
 
 == Usage
 
-mm-partial-update does not, by default, change MongoMappers normal mode of operation. Although mm-partial-update can be configured, either at a global level or on a model by model basis, to use a partial update strategy for all persistence operations, out of the box it simply adds a "save_changes" method to both MongoMapper::Document and MongoMapper::EmbeddedDocument, which will persist, using MongoDB's atomic operators, any changes to the target document or embedded document as well as any descendents of the target document or embedded document.
+mm-partial-update does not, by default, change MongoMappers normal mode of operation. Although mm-partial-update can be configured, either at a global level or on a model by model basis, to use a partial update strategy for all persistence operations, out of the box it simply adds #save_changes and #save_changes! methods to both MongoMapper::Document and MongoMapper::EmbeddedDocument. #save_changes(!) will persist any changes to the target document using MongoDB's atomic operators, ideal for making small changes to large documents or for concurrent modification of documents by multiple processes.
+
+As you might expect, #save_changes and #save_changes! mirror the behavior of #save and #save!, in that #save_changes will return false if the document (or embedded document) having its changes saved fails validation, whereas #save_changes! will raise a MongoMapper::InvalidDocument error.
+
+Both methods behave identically to their native MongoMapper counterparts with respect to both validations and callbacks.
 
 === For example:
 
@@ -35,11 +39,25 @@ mm-partial-update does not, by default, change MongoMappers normal mode of opera
 
      person = Person.create! :name=>"Willard"
      person.name = "Poe"
-     person.save_changes #only saves the changed fields (in this case name=>"Poe"
+     person.save_changes! #only saves the changed fields (in this case name=>"Poe"
+
+You can also persist only a part of a document:
+
+     person = Person.create! :name=>"Willard"
+     person.name = "Benji"
+     pet = person.pets.build :name=>"Magma"
+
+     person.changed? #= > true
+     pet.changed? # => true
+
+     pet.save_changes
+
+     pet.changed? # => false
+     person.changed? # => true
 
-However, in addition to #save_changes, partial saves can be enabled globally:
+In addition to #save_changes(!), partial saves can be enabled globally:
 
-     MmPartialUpdate.persistence_strategy = :changes_only
+     MmPartialUpdate.default_persistence_strategy = :changes_only
 
 Or on a model by model basis:
 
@@ -50,7 +68,7 @@ Or on a model by model basis:
        many :pets
      end
 
-When enabled globally, all calls to save or save! will result in a partial update (with the exception of new documents). When enabled on a particular model, calls to save or save! on instances of that model and any subclasses of that model will result in partial updates. This is useful if you have a number of models but only one or two require partial saves for a particular use case, such as concurrent modification by more than one process.
+When enabled globally, all calls to #save or #save! across all models will simply delegate to #save_changes or #save_changes!, resulting in a partial update. When enabled on a particular model, calls to save or save! on instances of that model and any subclasses of that model will result in partial updates.
 
 == Known Issues & Limitations
 

data/lib/mm_partial_update/plugins/document.rb

@@ -10,11 +10,15 @@ module MmPartialUpdate
 
         module InstanceMethods
 
+          def create_or_update_changes(options={})
+            new? ? save(:validate=>false, :safe=>options[:safe]) : super
+          end
+
           def save_to_collection(options={})
             strategy = determine_persistence_strategy(options)
             return super if new? || strategy == :full_document
 
-            save_changes(options)
+            save_changes(options.merge(:validate=>false, :callbacks=>false))
           end
 
           private

data/lib/mm_partial_update/plugins/embedded_document.rb

@@ -10,6 +10,11 @@ module MmPartialUpdate
 
         module InstanceMethods
 
+          def create_or_update_changes(options={})
+            assert_root_saved
+            super
+          end
+
           def database_selector
             selector = @_association_name.to_s
             selector = "#{_parent_document.database_selector}.#{selector}" if
@@ -34,6 +39,10 @@ module MmPartialUpdate
             end
           end
 
+          def assert_root_saved
+            raise "You are attempting to save changes to an embedded document, but the root document has not yet been saved. You must save changes to the root document before you can call save_changes any of its embedded documents" if _root_document.new?
+          end
+
         end
 
       end

data/lib/mm_partial_update/plugins/partial_update.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+require "mongo_mapper/exceptions.rb"
+
 module MmPartialUpdate
   module Plugins
     module PartialUpdate
@@ -27,25 +28,21 @@ module MmPartialUpdate
       module InstanceMethods
 
         def save_changes(options={})
-          #We can't update an embedded document if the root isn't saved
-          #The clear_changes call is added here because dirty
-          #tracking happens further up the call chain than save_to_collection
-          #under normal circumstances, so we have to inject it
-          return _root_document.save_to_collection(options).tap {clear_changes} if
-            _root_document.new?
-
-          #persist changes to self and descendents
-          update_command  = prepare_update_command
-          update_command.execute()
+          options.assert_valid_keys(:validate, :callbacks, :safe, :changes_only)
+          options.reverse_merge!(:validate=>true, :callbacks=>true)
+          !options[:validate] || valid? ? create_or_update_changes(options) : false
+        end
 
-          #clear dirty tracking
-          @_new = false
-          clear_changes
-          associations.each do |_, association|
-            proxy = get_proxy(association)
-            proxy.save_to_collection(options) if
-              proxy.proxy_respond_to?(:save_to_collection)
-          end
+        def save_changes!(options={})
+          options.assert_valid_keys(:callbacks, :safe, :changes_only)
+          save_changes(options) || raise(MongoMapper::DocumentNotValid.new(self))
+        end
+
+        def create_or_update_changes(options={})
+          #assert_root_saved
+          update_command  = prepare_update_command
+          execute_command(update_command, options)
+          clear_changes_to_subtree(options)
         end
 
         def prepare_update_command
@@ -86,6 +83,29 @@ module MmPartialUpdate
           proxy
         end
 
+        def clear_changes_to_subtree(options)
+          @_new = false
+          clear_changes
+          associations.each do |_, association|
+            proxy = get_proxy(association)
+            proxy.save_to_collection(options) if
+              proxy.proxy_respond_to?(:save_to_collection)
+          end
+        end
+
+        def execute_command(update_command,options)
+           if options[:callbacks]
+             context = new? ? :create : :update
+             run_callbacks(:save) do
+              run_callbacks(context) do
+                update_command.execute()
+              end
+            end
+          else
+            update_command.execute()
+           end
+        end
+
       end
 
     end

data/lib/mm_partial_update/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 module MmPartialUpdate
-    Version = '0.1.0'
+    Version = '0.1.1'
 end

data/test/callbacks_support.rb

@@ -0,0 +1,27 @@
+#from MongoMapper test suite
+module CallbacksSupport
+  def self.included base
+    base.key :name, String
+
+    [ :after_find,        :after_initialize,
+      :before_validation, :after_validation,
+      :before_create,     :after_create,
+      :before_update,     :after_update,
+      :before_save,       :after_save,
+      :before_destroy,    :after_destroy
+    ].each do |callback|
+      base.send(callback) do
+        history << callback.to_sym
+      end
+    end
+  end
+
+  def history
+    @history ||= []
+  end
+
+  def clear_history
+    embedded_associations.each { |a| self.send(a.name).each(&:clear_history) }
+    @history = nil
+  end
+end

data/test/functional/plugins/test_embedded_document.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 require "models"
 
+
 class TestEmbeddedDocumentPlugin < Test::Unit::TestCase
 
   context "#database_selector" do
@@ -73,15 +74,10 @@ class TestEmbeddedDocumentPlugin < Test::Unit::TestCase
 
   context "#save_changes" do
 
-    should "save an unsaved parent when a descendent is saved" do
+    should "fails when a descendent is saved with an unsaved root" do
       person = Person.new :name=>"Willard"
       pet = person.pets.build :name=>"Magma"
-      pet.save_changes
-      person = Person.find(person.id)
-      person.should_not be_nil
-      person.name.should == "Willard"
-      person.pets.count.should == 1
-      person.pets[0].name.should == "Magma"
+      assert_raises(RuntimeError) { pet.save_changes }
     end
 
     should "create an embedded document that doesn't already exist" do

data/test/functional/plugins/test_partial_update.rb

@@ -91,11 +91,73 @@ class TestPartialUpdate < Test::Unit::TestCase
       end
     end
 
-    #context "when called on embedded documents" do
-    #  should "save a new embedded document" do
-    #    person = Person.create! :name=>"Willard"
-    #  end
-    #end
+  end
+
+  context "#save_changes!" do
+
+    should "raise an exception if the document isn't valid" do
+      person = ValidatedPerson.new
+      assert_raise(MongoMapper::DocumentNotValid) { person.save_changes! }
+    end
+
+    should "not raise an exception if the document is valid" do
+      person = ValidatedPerson.new :name=>"Willard"
+      assert_nothing_thrown { person.save_changes! }
+    end
+
+    should "raise an exception when saving an embedded document that isn't valid" do
+      person = ValidatedPerson.create! :name=>"Willard"
+      pet = person.validated_pets.build
+      assert_raise(MongoMapper::DocumentNotValid) {pet.save_changes!}
+    end
+
+    should "raise an exception when saving an embedded 'one' document that isn't valid" do
+      person = ValidatedPerson.create! :name=>"Willard"
+      pet = person.validated_pet.build
+      assert_raise(MongoMapper::DocumentNotValid) {pet.save_changes!}
+    end
+
+  end
+
+  context "callbacks" do
+
+    should "happen for new top level documents" do
+      p = Person.new :name=>"Willard"
+      p.clear_history
+      p.save_changes
+      p.history.should == [:before_validation, :after_validation,
+                           :before_save, :before_create, :after_create, :after_save]
+    end
+
+    should "happen for updated top level documents" do
+      p = Person.create :name=>"Willard"
+      p.clear_history
+      p.name = "Timmy"
+      p.save_changes
+      p.history.should == [:before_validation, :after_validation,
+                           :before_save, :before_update, :after_update, :after_save]
+    end
+
+    should "happen for new embedded documents" do
+      p = Person.create :name=>"Willard"
+      pet = p.pets.build :name=>"Magma"
+      pet.clear_history
+      pet.save_changes
+      pet.history.should == [:before_validation, :after_validation,
+                             :before_save, :before_create, :after_create, :after_save]
+    end
+
+    should "happen for updated embedded documents" do
+      p = Person.new :name=>"Willard"
+      pet = p.pets.build :name=>"Magma"
+      p.save!
+      pet.clear_history
+      pet.name = "Debris"
+      pet.save_changes
+      pet.history.should == [:before_validation, :after_validation,
+                             :before_save, :before_update, :after_update, :after_save]
+    end
 
   end
+
 end

data/test/models.rb

@@ -1,18 +1,35 @@
+require "callbacks_support"
+
 class Person
   include MongoMapper::Document
+  include CallbacksSupport
+
   key :name, String
   many :pets
   one :favorite_pet, :class_name=>'Pet'
+
+
+end
+
+class ValidatedPerson < Person
+  validates_presence_of :name
+  one :validated_pet
+  many :validated_pets
 end
 
 class Pet
   include MongoMapper::EmbeddedDocument
+  include CallbacksSupport
   key :name, String
   key :age, Integer
   many :fleas
   one :favorite_flea, :class_name=>'Flea'
 end
 
+class ValidatedPet < Pet
+  validates_presence_of :name
+end
+
 class Flea
   include MongoMapper::EmbeddedDocument
   key :name, String

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mm_partial_update
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Nathan Stults
@@ -128,6 +128,7 @@ files:
 - lib/mm_partial_update/one_embedded_proxy.rb
 - lib/mm_partial_update/version.rb
 - lib/mm_partial_update/update_command.rb
+- test/callbacks_support.rb
 - test/test_helper.rb
 - test/test_update_command.rb
 - test/functional/plugins/test_embedded_document.rb