mm_partial_update 0.1.0

data/lib/mm_partial_update/version.rb

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

data/test/functional/plugins/test_document.rb

@@ -0,0 +1,91 @@
+require 'test_helper'
+require "models"
+
+class TestDocumentPlugin < Test::Unit::TestCase
+
+  context "Document#save" do
+    should "respect persistence_strategy" do
+      Person.persistence_strategy(:changes_only)
+      #Person one should not have anything in the pets collection
+      person = Person.create! :name=>"Willard"
+
+      person2 = Person.find(person.id)
+      person2.pets.build :name=>"Magma"
+      person2.save!
+
+      person.name = "Timmy"
+      person.save!
+      person.reload
+      person.name.should == "Timmy"
+      person.pets.length.should == 1
+
+      Person.persistence_strategy(:full_document)
+    end
+  end
+
+  context "#save_to_collection" do
+
+    should "overwrite the document when the strategy is :full_document" do
+      #Person one should not have anything in the pets collection
+      person = Person.create! :name=>"Willard"
+
+      person2 = Person.find(person.id)
+      person2.pets.build :name=>"Magma"
+      person2.save!
+
+      person.name = "Timmy"
+      person.save_to_collection(:persistence_strategy=>:full_document) #this is the default
+      person.reload
+      person.name.should == "Timmy"
+      person.pets.length.should == 0
+    end
+
+
+    should "only save changes when the strategy is :changes_only" do
+      #Person one should not have anything in the pets collection
+      person = Person.create! :name=>"Willard"
+
+      person2 = Person.find(person.id)
+      person2.pets.build :name=>"Magma"
+      person2.save!
+
+      person.name = "Timmy"
+      person.save_to_collection(:changes_only=>true)
+      person.reload
+      person.name.should == "Timmy"
+      person.pets.length.should == 1
+    end
+
+  end
+
+  context "#determine_persistence_strategy" do
+    should "return a default strategy if none is set or provided" do
+      Person.new.send(:determine_persistence_strategy,{}).should == :full_document
+    end
+
+    should "return the plugin level persistence strategy if defined" do
+      MmPartialUpdate.default_persistence_strategy =  :changes_only
+      Person.new.send(:determine_persistence_strategy,{}).should == :changes_only
+      MmPartialUpdate.default_persistence_strategy = :full_document
+    end
+
+    should "use class level persistence strategy if defined" do
+      Person.persistence_strategy(:changes_only)
+      Person.new.send(:determine_persistence_strategy,{}).should == :changes_only
+      Person.persistence_strategy(:full_document)
+    end
+
+    should "use persistence strategy in the options if defined" do
+      Person.new.send(:determine_persistence_strategy,
+                      {:persistence_strategy=>:changes_only}).should == :changes_only
+    end
+
+    should "interpret :changes_only=>true in the options as a strategy of :changes_only" do
+      Person.new.send(:determine_persistence_strategy,:changes_only=>true).
+        should == :changes_only
+    end
+
+  end
+
+
+end

data/test/functional/plugins/test_embedded_document.rb

@@ -0,0 +1,112 @@
+require 'test_helper'
+require "models"
+
+class TestEmbeddedDocumentPlugin < Test::Unit::TestCase
+
+  context "#database_selector" do
+
+    should "be defined for new one relationships" do
+      person = Person.new
+      pet = person.favorite_pet.build
+      pet.database_selector.should == "favorite_pet"
+    end
+
+    should "be defined for one relationships loaded from the database" do
+      person = Person.new
+      person.favorite_pet.build
+      person.save!
+      person = Person.find(person.id)
+      person.favorite_pet.database_selector.should == "favorite_pet"
+    end
+
+    should "be defined for new many_embedded relationships" do
+      person = Person.new
+      pet = person.pets.build
+      pet.database_selector.should == "pets"
+    end
+
+    should "be defined for new many_embedded relationships loaded from the database" do
+      person = Person.new
+      person.pets.build
+      person.save!
+      person = Person.find(person.id)
+      person.pets[0].database_selector.should == "pets.0"
+    end
+
+    should "be defined for new nested one relationships" do
+      person = Person.new
+      person.pets.build
+      person.save!
+      person = Person.find(person.id)
+      flea = person.pets[0].favorite_flea.build
+      flea.database_selector.should == "pets.0.favorite_flea"
+    end
+
+    should "be defined for nested one relationships loaded from the database" do
+      person = Person.new
+      person.pets.build
+      person.pets[0].favorite_flea.build
+      person.save!
+      person = Person.find(person.id)
+      person.pets[0].favorite_flea.database_selector.should == "pets.0.favorite_flea"
+    end
+
+    should "be defined for new nested many relationships" do
+      person = Person.new
+      person.pets.build
+      person.save!
+      person = Person.find(person.id)
+      person.pets[0].fleas.build
+      person.pets[0].fleas[0].database_selector.should == "pets.0.fleas"
+    end
+
+    should "be defined for nested many relationships loaded from the database" do
+      person = Person.new
+      person.pets.build
+      person.pets[0].fleas.build
+      person.save!
+      person = Person.find(person.id)
+      person.pets[0].fleas[0].database_selector.should == "pets.0.fleas.0"
+    end
+
+  end
+
+  context "#save_changes" do
+
+    should "save an unsaved parent when a descendent is saved" 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"
+    end
+
+    should "create an embedded document that doesn't already exist" do
+      person = Person.create! :name=>"Nathan"
+      pet = person.pets.build :name=>"Magma", :age=>3
+      pet.save_changes
+      person.reload
+      person.pets.count.should == 1
+      person.pets[0].name.should == "Magma"
+      person.pets[0].age.should == 3
+    end
+
+    should "create an embedded document without saving the parent" do
+      person = Person.create! :name=>"Willard"
+      person.name = "Nevermore"
+      pet = person.pets.build :name=>"Magma"
+      pet.save_changes
+      pet.changed?.should be_false
+      person.changed?.should be_true
+      person.reload
+      person.name.should == "Willard"
+      person.pets.count.should == 1
+      person.pets[0].name.should == "Magma"
+    end
+
+  end
+
+end

data/test/functional/plugins/test_partial_update.rb

@@ -0,0 +1,101 @@
+require 'test_helper'
+require "models"
+
+class TestPartialUpdate < Test::Unit::TestCase
+  context "#save_changes" do
+    should "create unsaved entities" do
+      person = Person.new :name=>"Willard"
+      person.save_changes
+      person.reload
+      person.name.should == "Willard"
+      person.new?.should be_false
+    end
+
+    should "update a saved entity" do
+      person = Person.create! :name=>"Willard"
+      person.name = "Esteban"
+      person.save_changes
+      person.reload
+      person.name.should == "Esteban"
+    end
+
+    should "update changes to a saved entity, preserving unchanged values" do
+      person = Person.new :name=>"Willard"
+      person.pets.build :name=>"Magma", :age=>2
+      person.save!
+      person.name = "Esteban"
+      person.save_changes
+      person.reload
+      person.name.should == "Esteban"
+      person.pets.count.should == 1
+      person.pets[0].name.should == "Magma"
+      person.pets[0].age.should == 2
+    end
+
+    should "apply a variety of changes to a document graph" do
+      person = Person.new :name=>"Willard"
+      person.pets.build :name=>"Magma", :age=>3
+      person.pets.build :name=>"Debris"
+      person.pets.build :name=>"Timmy"
+      person.pets[0].favorite_flea.build :name=>"Fleatus"
+      person.pets[1].fleas.build :name=>"Fleatasia"
+      person.pets[1].fleas.build :name=>"Dogen Zenji"
+      person.favorite_pet.build :name=>"Soto", :age=>10_000
+      person.save!
+
+      person.pets.reject! {|p|p.name=="Timmy"}
+      person.name = "Fydor"
+      person.favorite_pet.age = 100_000
+      person.pets[0].favorite_flea = nil
+      person.pets[1].fleas[0].name = "The Horse Master"
+      person.pets[1].fleas.build :name=>"Raskolnikov", :age=>80
+
+      person.save_changes
+
+      person.reload
+
+      person.name.should == "Fydor"
+      person.pets.count.should == 2
+      person.pets[0].name.should == "Magma"
+      person.pets[1].name.should == "Debris"
+      person.pets[0].favorite_flea.should be_nil
+      person.pets[1].fleas[0].name.should == "The Horse Master"
+      person.favorite_pet.age.should == 100_000
+      person.pets[1].fleas.count.should == 3
+      person.pets[1].fleas[-1].name.should == "Raskolnikov"
+      person.pets[1].fleas[-1].age.should == 80
+    end
+
+    context "with dirty tracking" do
+      setup do
+        @person = Person.new :name=>"Willard"
+        @person.pets.build :name=>"Magma"
+        @person.save_changes
+      end
+
+      should "clear new flags when changes are saved" do
+        @person.new?.should be_false
+      end
+
+      should "clear new flags on descentends when changes are saved" do
+        @person.pets[0].new?.should be_false
+      end
+
+
+      should "clear dirty tracking when changes are saved" do
+        @person.changed?.should be_false
+      end
+
+      should "clear dirty tracking on descendents when changes are saved" do
+        @person.pets[0].changed?.should be_false
+      end
+    end
+
+    #context "when called on embedded documents" do
+    #  should "save a new embedded document" do
+    #    person = Person.create! :name=>"Willard"
+    #  end
+    #end
+
+  end
+end

data/test/functional/test_update_command.rb

@@ -0,0 +1,261 @@
+require "test_helper"
+require "models"
+
+class TestUpdateCommand < Test::Unit::TestCase
+
+  context "#execute" do
+    setup do
+      @person = Person.new
+      @command = MmPartialUpdate::UpdateCommand.new(@person)
+    end
+
+    context "with no commands" do
+      should "do nothing" do
+        @command.execute
+        Person.find(@person.id).should be_nil
+      end
+    end
+
+    context "on a new document" do
+      should "create a document if it doesn't previouly exist" do
+        @command.set nil,"a_value"=>"for you"
+        @command.execute
+        (person = Person.find(@person.id)).should_not be_nil
+        person.a_value.should == "for you"
+      end
+    end
+
+    context "on an existing document" do
+      should "update the existing document" do
+        @person.save!
+        @command.set nil, "another_value"=>"in the house"
+        @command.execute
+        (person = Person.find(@person.id)).should_not be_nil
+      end
+
+      should "preserve previous values" do
+        @person["a_value"] = "was here"
+        @person.save!
+        @command.set nil, "another_value"=>"in the house"
+        @command.execute
+        (person = Person.find(@person.id)).should_not be_nil
+        person.a_value.should == "was here"
+      end
+
+      context "#set" do
+        should "set a variety of direct keys on the document" do
+          @command.set nil, "a"=>"b", "c"=>1, "d"=>[1,2,3]
+          @command.execute
+          person = Person.find(@person.id)
+          person.a.should == "b"
+          person.c.should == 1
+          person.d.should == [1,2,3]
+        end
+
+        should "create sub-objects" do
+          @command.set "favorite_pet", Pet.new(:name=>"Magma", :age=>3).to_mongo
+          @command.execute
+          @person.reload
+          @person.favorite_pet.should_not be_nil
+          @person.favorite_pet.name.should == "Magma"
+          @person.favorite_pet.age.should == 3
+        end
+
+        should "update sub-objects" do
+          pet = @person.favorite_pet.build :name=>"Magma"
+          @person.save!
+          @command.set "favorite_pet", {:name=>"Timmy"}
+          @command.execute
+          @person.reload
+          @person.favorite_pet.name.should == "Timmy"
+        end
+
+        should "expand sub-objects" do
+          pet = @person.favorite_pet.build :name=>"Magma"
+          @person.save!
+          @command.set "favorite_pet", {:age=>9}
+          @command.execute
+          @person.reload
+          @person.favorite_pet.age.should == 9
+        end
+
+        should "create deep objects" do
+          pet = @person.favorite_pet.build :name=>"Magma"
+          @person.save!
+          @command.set "favorite_pet.favorite_flea", Flea.new(:name=>"Fleatus").to_mongo, :replace=>true
+          @command.execute
+          @person.reload
+          @person.favorite_pet.favorite_flea.should_not be_nil
+          @person.favorite_pet.favorite_flea.name.should == "Fleatus"
+        end
+
+        should "update deep objects" do
+          pet = @person.favorite_pet.build :name=>"Magma"
+          flea = pet.favorite_flea.build :name=>"Fleatus"
+          @person.save!
+          @command.set "favorite_pet.favorite_flea", {:name=>"Fleatasia"}
+          @command.execute
+          @person.reload
+          @person.favorite_pet.favorite_flea.name.should == "Fleatasia"
+        end
+
+        should "update objects in arrays" do
+          @person.pets.build :name=>"Magma"
+          @person.save!
+          @command.set "pets.0", {:name=>"Timmy"}
+          @command.execute
+          @person.reload
+          @person.pets[0].name.should == "Timmy"
+        end
+
+        should "update objects in deep arrays" do
+          pet = @person.pets.build :name=>"Magma"
+          flea = pet.fleas.build :name=>"Fleatus"
+          @person.save!
+          @command.set "pets.0.fleas.0", :name=>"Fleatasia"
+          @command.execute
+          @person.reload
+          @person.pets[0].fleas[0].name.should == "Fleatasia"
+        end
+
+      end
+
+      context "#unset" do
+        should "remove a specified key" do
+          @person.name = "I am the walrus"
+          @person.save!
+          @command.unset "name"
+          @command.execute
+          #reload doesn't work here, because of MM implementation
+          #which will not apply values to fields
+          #that don't appear in the result set
+          person = Person.find(@person.id)
+          person.name.should be_nil
+        end
+      end
+
+      context "#push" do
+        should "add objects to arrays" do
+          @command.push "pets", :name=>"Magma", :age=>2
+          @command.execute
+          @person.reload
+          @person.pets.count.should == 1
+          @person.pets[0].name.should == "Magma"
+          @person.pets[0].age.should == 2
+        end
+
+        should "append objects to arrays" do
+          @person.pets.build :name=>"Magma"
+          @person.save!
+          @command.push "pets", :name=>"Timmy"
+          @command.execute
+          @person.reload
+          @person.pets.count.should == 2
+          @person.pets[1].name.should == "Timmy"
+        end
+
+        should "add objects to deep arrays" do
+          @person.pets.build :name=>"Magma"
+          @person.save!
+          @command.push "pets.0.fleas", :name=>"Fleatus"
+          @command.execute
+          @person.reload
+          @person.pets[0].fleas.count.should == 1
+          @person.pets[0].fleas[0].name.should == "Fleatus"
+        end
+
+        should "add multiple objects to an array" do
+          @command.push "pets", :name=>"Magma"
+          @command.push "pets", :name=>"Timmy"
+          @command.execute
+          @person.reload
+          @person.pets.count.should == 2
+          @person.pets[0].name.should == "Magma"
+          @person.pets[1].name.should == "Timmy"
+        end
+
+
+      end
+
+      context "#pull" do
+        should "remove objects from arrays" do
+          pet = @person.pets.build :name=>"Magma"
+          @person.save!
+          @command.pull "pets", pet._id
+          @command.execute
+          @person.reload
+          @person.pets.count.should == 0
+        end
+
+        should "remove objects from deep arrays" do
+          pet = @person.pets.build :name=>"Magma"
+          flea = pet.fleas.build :name=>"Fleatus"
+          @person.save!
+          @command.pull "pets.0.fleas", flea.id
+          @command.execute
+          @person.reload
+          @person.pets[0].fleas.count.should == 0
+        end
+
+        should "remove multiple objects from arrays" do
+          @person.pets.build :name=>"Magma"
+          @person.pets.build :name=>"Timmy"
+          @person.pets.build :name=>"Debris"
+          @person.save!
+          @command.pull "pets", @person.pets[0].id
+          @command.pull "pets", @person.pets[2].id
+
+          undeleted = @person.pets[1].id
+
+          @command.execute
+          @person.reload
+          @person.pets.count.should == 1
+          @person.pets[0].id.should == undeleted
+        end
+
+      end
+
+      context "with a variety of commands" do
+        should "correctly persist the document" do
+          @person.name = "Nathan"
+          @person.pets.build :name=>"Magma"
+          @person.pets.build :name=>"Timmy", :age=>3
+          @person.favorite_pet.build :name=>"Debris", :age=>1
+          @person.pets[0].favorite_flea.build :name=>"Fleatus"
+          @person.pets[1].fleas.build :name=>"Fleatasia"
+          @person.save!
+
+          @command.set nil, :name=>"Willard"
+          @command.push "pets", :name=>"Dogen", :age=>2
+          @command.pull "pets", @person.pets[1].id
+          @command.set "pets.0", :age => 99
+          @command.set "pets.0.favorite_flea", :name=>"Fleasy"
+          @command.set "pets.1.favorite_flea", {:_id=>BSON::ObjectId.new, :name=>"Rinzai"}, :replace=>true
+          @command.push "pets.0.fleas", :_id=>BSON::ObjectId.new, :name=>"Soto"
+          @command.push "pets.0.fleas", :_id=>BSON::ObjectId.new, :name=>"Basho"
+
+          @command.execute
+          @person.reload
+
+          @person.name.should == "Willard"
+          @person.pets.count.should == 2
+          @person.pets[0].name.should == "Magma"
+          @person.pets[1].name.should == "Dogen"
+          @person.pets[1].age.should == 2
+          @person.pets[0].age.should == 99
+          @person.favorite_pet.name.should == "Debris"
+          @person.pets[1].favorite_flea.should be_nil
+          @person.pets[1].fleas.count.should == 0
+          @person.pets[0].fleas.count.should == 2
+          @person.pets[0].fleas[0].name.should == "Soto"
+          @person.pets[0].fleas[1].name.should == "Basho"
+
+        end
+      end
+
+    end
+
+
+  end
+
+end