mm_partial_update 0.1.0

data/test/models.rb

@@ -0,0 +1,20 @@
+class Person
+  include MongoMapper::Document
+  key :name, String
+  many :pets
+  one :favorite_pet, :class_name=>'Pet'
+end
+
+class Pet
+  include MongoMapper::EmbeddedDocument
+  key :name, String
+  key :age, Integer
+  many :fleas
+  one :favorite_flea, :class_name=>'Flea'
+end
+
+class Flea
+  include MongoMapper::EmbeddedDocument
+  key :name, String
+end
+

data/test/test_helper.rb

@@ -0,0 +1,96 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'mm_partial_update'
+require 'fileutils'
+require 'ostruct'
+
+require 'log_buddy'
+require 'matchy'
+require 'shoulda'
+
+class Test::Unit::TestCase
+  def Doc(name='Class', &block)
+    klass = Class.new
+    klass.class_eval do
+      include MongoMapper::Document
+      set_collection_name :test
+
+      if name
+        class_eval "def self.name; '#{name}' end"
+        class_eval "def self.to_s; '#{name}' end"
+      end
+    end
+
+    klass.class_eval(&block) if block_given?
+    klass.collection.remove
+    klass
+  end
+
+  def EDoc(name='Class', &block)
+    klass = Class.new
+    klass.class_eval do
+      include MongoMapper::EmbeddedDocument
+
+      if name
+        class_eval "def self.name; '#{name}' end"
+        class_eval "def self.to_s; '#{name}' end"
+      end
+    end
+
+    klass.class_eval(&block) if block_given?
+    klass
+  end
+
+  def drop_indexes(klass)
+    if klass.database.collection_names.include?(klass.collection.name)
+      klass.collection.drop_indexes
+    end
+  end
+
+  custom_matcher :be_true do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be true but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be true but it was"
+    receiver.eql?(true)
+  end
+
+  custom_matcher :be_false do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be false but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be false but it was"
+    receiver.eql?(false)
+  end
+
+  custom_matcher :have_error_on do |receiver, matcher, args|
+    receiver.valid?
+    attribute = args[0]
+    expected_message = args[1]
+
+    if expected_message.nil?
+      matcher.positive_failure_message = "#{receiver} had no errors on #{attribute}"
+      matcher.negative_failure_message = "#{receiver} had errors on #{attribute} #{receiver.errors.inspect}"
+      !receiver.errors[attribute].blank?
+    else
+      actual = receiver.errors[attribute]
+      matcher.positive_failure_message = %Q(Expected error on #{attribute} to be "#{expected_message}" but was "#{actual}")
+      matcher.negative_failure_message = %Q(Expected error on #{attribute} not to be "#{expected_message}" but was "#{actual}")
+      actual.include? expected_message
+    end
+  end
+
+  custom_matcher :have_index do |receiver, matcher, args|
+    index_name = args[0]
+    matcher.positive_failure_message = "#{receiver} does not have index named #{index_name}, but should"
+    matcher.negative_failure_message = "#{receiver} does have index named #{index_name}, but should not"
+    !receiver.collection.index_information.detect { |index| index[0] == index_name }.nil?
+  end
+end
+
+log_dir = File.expand_path('../../log', __FILE__)
+FileUtils.mkdir_p(log_dir) unless File.exist?(log_dir)
+logger = Logger.new(log_dir + '/test.log')
+
+LogBuddy.init(:logger => logger)
+MongoMapper.connection = Mongo::Connection.new('127.0.0.1', 27017, :logger => logger)
+MongoMapper.database = "mm-test-#{RUBY_VERSION.gsub('.', '-')}"
+MongoMapper.database.collections.each { |c| c.drop_indexes }

data/test/test_mm_partial_update.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class TestMmPartialUpdate < Test::Unit::TestCase
+  context "including mm_partial_update" do
+    should "include something or other" do
+      assert_equal defined?(MmPartialUpdate::Plugins::PartialUpdate), "constant"
+    end
+  end
+end

data/test/test_partial_update.rb

@@ -0,0 +1,221 @@
+require 'test_helper'
+require "models"
+
+class TestPartialUpdate < Test::Unit::TestCase
+
+  context "#prepare_update_command" do
+
+    context "on root documents" do
+
+      should "return an empty command if not changed" do
+        doc = Person.create!
+        doc.send(:prepare_update_command).to_h.empty?.should be_true
+      end
+
+      should "return to_mongo if the entity is new" do
+        doc = Person.new
+        doc.name = "hello"
+        doc.send(:prepare_update_command).to_h.should ==
+          {"$set"=>doc.to_mongo}
+      end
+
+      should "provide set changed fields" do
+        doc = Person.create
+        doc.name = "hello"
+        doc.send(:prepare_update_command).to_h.should ==
+          {"$set"=>{"name"=>"hello"}}
+      end
+
+      context "with changes to 'one' embedded associations" do
+        should "report a new child" do
+          doc = Person.create
+          doc.favorite_pet.build :name=>"Magma"
+          doc.send(:prepare_update_command).to_h.should == {
+            "$set"=>{'favorite_pet'=>doc.favorite_pet.to_mongo}
+          }
+        end
+
+        should "report changed child" do
+          doc = Person.new
+          doc.favorite_pet.build :name=>"Magma"
+          doc.save
+          doc.favorite_pet.name = "Ugly"
+          doc.send(:prepare_update_command).to_h.should == {
+            "$set"=>{"favorite_pet.name"=>"Ugly"}
+          }
+        end
+
+        should "report a deleted child" do
+          doc = Person.new
+          doc.favorite_pet.build :name=>"Magma"
+          doc.save
+          doc.favorite_pet = nil
+          doc.send(:prepare_update_command).to_h.should == {
+            "$set"=>{'favorite_pet'=>nil}
+          }
+        end
+
+      end
+      context "with changes to 'many' embedded associations" do
+        should "report a new child" do
+          doc = Person.create
+          doc.pets.build :name=>"Magma"
+          doc.send(:prepare_update_command).to_h.should == {
+            :pushes=>{"pets"=>[doc.pets[0].to_mongo]}
+          }
+        end
+
+        should "report a changed child" do
+          doc = Person.new
+          doc.pets.build :name=>"Magma"
+          doc.save!
+          doc.pets[0].name = "Ugly"
+          doc.send(:prepare_update_command).to_h.should == {
+            "$set"=>{"pets.0.name"=>"Ugly"}
+          }
+        end
+
+        should "report a deleted child" do
+          doc = Person.new
+          deleted = doc.pets.build :name=>"Magma"
+          doc.save!
+          doc.pets.pop
+          doc.send(:prepare_update_command).to_h.should ==  {
+            :pulls=>{"pets"=>[deleted._id]}
+          }
+        end
+
+        should "report a mix of added, modified and deleted" do
+          doc = Person.new
+          doc.pets.build :name => "Magma"
+          deleted = doc.pets.build :name => "Ugly"
+          doc.pets.build :name => "Bipolar"
+          doc.save!
+          doc.pets.reject! {|p|p.name=="Ugly"}
+          doc.pets[0].name = "Debris"
+          doc.pets.build :name => "Hades"
+          doc.send(:prepare_update_command).to_h.should == {
+            "$set"=>{"pets.0.name"=>"Debris"},
+            :pulls=>{"pets"=>[deleted._id]},
+            :pushes=>{"pets"=>[doc.pets[-1].to_mongo]}
+          }
+        end
+
+        should "update database selectors after save" do
+          doc = Person.new
+          doc.pets.build :name=>"Magma"
+          doc.pets.build :name=>"Ugly"
+          doc.pets.build :name=>"Bipolar"
+          doc.save!
+          doc.pets.reject! {|p|p.name=="Ugly"}
+          doc.save!
+          doc.pets.length.should == 2
+          doc.pets.each_with_index do |pet,index|
+            pet.instance_variable_get("@_database_position").should == index
+          end
+        end
+      end
+
+      context "with changes to nested one associations" do
+        should "report a new grandchild" do
+          doc = Person.new
+          pet = doc.pets.build :name=>"Magma"
+          doc.save!
+          pet.favorite_flea.build :name=>"Fleatus"
+          doc.send(:prepare_update_command).to_h.should == {
+            "$set"=>{"pets.0.favorite_flea"=>pet.favorite_flea.to_mongo}
+          }
+        end
+
+        should "report a modified grandchild" do
+          doc = Person.new
+          pet = doc.pets.build :name=>"Magma"
+          flea = pet.favorite_flea.build :name=>"Fleatus"
+          doc.save!
+          flea.name = "Fleatasia"
+          doc.send(:prepare_update_command).to_h.should == {
+            "$set"=>{"pets.0.favorite_flea.name"=>"Fleatasia"}
+          }
+        end
+
+        should "report a deleted grandchild" do
+          doc = Person.new
+          pet = doc.pets.build :name=>"Magma"
+          pet.favorite_flea.build :name=>"Fleatus"
+          doc.save!
+          pet.favorite_flea = nil
+          doc.send(:prepare_update_command).to_h.should == {
+            "$set"=>{"pets.0.favorite_flea"=>nil}
+          }
+        end
+      end
+
+      context "with changes to nested many associations" do
+        should "report a new grandchild" do
+          doc = Person.create
+          pet = doc.pets.build :name=>"Magma"
+          doc.save!
+          pet.fleas.build :name=>'Fleatus'
+          doc.send(:prepare_update_command).to_h.should == {
+            :pushes=>{"pets.0.fleas"=>[pet.fleas[0].to_mongo]}
+          }
+        end
+        should "report a changed grandchild" do
+          doc = Person.new
+          pet = doc.pets.build :name=>"Magma"
+          pet.fleas.build :name=>"Fleatus"
+          doc.save!
+          pet.fleas[0].name = "Fleatasia"
+          doc.send(:prepare_update_command).to_h.should == {
+            "$set"=>{"pets.0.fleas.0.name"=>"Fleatasia"}
+          }
+        end
+
+        should "report a deleted child" do
+          doc = Person.new
+          doc.pets.build :name=>"Magma"
+          doc.pets[0].fleas.build :name=>"Fleatus"
+          doc.save!
+          deleted = doc.pets[0].fleas.pop
+          doc.send(:prepare_update_command).to_h.should ==  {
+            :pulls=>{"pets.0.fleas"=>[deleted._id]}
+          }
+        end
+
+        should "report a mix of added, modified and deleted" do
+          doc = Person.new
+          pet = doc.pets.build :name=>"Magma"
+          pet.fleas.build :name => "Fleatus"
+          deleted = pet.fleas.build :name => "Fleatasia"
+          pet.fleas.build :name => "Soto"
+          doc.save!
+          pet.fleas.reject! {|f|f.name=="Fleatasia"}
+          pet.fleas[0].name = "Rinsai"
+          pet.fleas.build :name => "Dogen"
+          doc.send(:prepare_update_command).to_h.should == {
+            :pulls=>{"pets.0.fleas"=>[deleted._id]},
+            :pushes=>{"pets.0.fleas"=>[doc.pets[0].fleas[-1].to_mongo]},
+            "$set"=>{"pets.0.fleas.0.name"=>"Rinsai"}
+          }
+        end
+
+        should "update database selectors after save" do
+          doc = Person.new
+          pet = doc.pets.build :name=>"Magma"
+          pet.fleas.build :name=>"Fleatus"
+          pet.fleas.build :name=>"Soto"
+          pet.fleas.build :name=>"Rinsai"
+          doc.save!
+          pet.fleas.reject! {|p|p.name=="Soto"}
+          doc.save!
+          pet.fleas.length.should == 2
+          pet.fleas.each_with_index do |flea,index|
+            flea.instance_variable_get("@_database_position").should == index
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/test/test_update_command.rb

@@ -0,0 +1,133 @@
+require "test_helper"
+
+class TestUpdateCommand < Test::Unit::TestCase
+
+  context "UpdateCommand" do
+    setup do
+      @edoc = EDoc { key :name, String }
+      @doc = Doc { key :name, String }
+      @doc.many :children, :class=>@edoc
+
+      @command = MmPartialUpdate::UpdateCommand.new(@doc.new)
+      @defaults = {"a_field"=>2, "another_field"=>2}
+      @command.set nil, @defaults
+    end
+
+    context "#document_selector" do
+      should "be derived from the id of the root document" do
+        doc = @doc.new
+        edoc = doc.children.build
+        MmPartialUpdate::UpdateCommand.new(doc).document_selector.should == {:_id=>doc._id}
+        MmPartialUpdate::UpdateCommand.new(edoc).document_selector.should == {:_id=>doc._id}
+      end
+    end
+
+    context "#set" do
+
+      context "with a blank selector and replace = true" do
+        should "set the fields hash directly onto $set" do
+          @command.set(nil, {"a_different_field"=>3}, :replace=>{})
+          @command.to_h["$set"].should == {"a_different_field"=>3}
+        end
+      end
+
+      context "with a blank selector" do
+        should "merge the fields hash directly into $set" do
+          @command.set nil, {"a_different_field"=>3}
+          @command.to_h["$set"].should == {"a_different_field"=>3}.merge(@defaults)
+        end
+      end
+
+      context "with replace = true" do
+        should "replace the key at 'selector' with the fields hash" do
+          @command.set "sel", {"this"=>:that}
+          @command.set "sel", {"that"=>:this}, :replace=>true
+          @command.to_h["$set"]["sel"].should == {"that"=>:this}
+        end
+      end
+
+      context "with a selector and replace = false" do
+        should "merge each key of fields into $set, namespaced with the selector" do
+          @command.set "sel", {"that"=>:this, "the"=>:other}
+          @command.to_h["$set"].should == {"sel.that"=>:this, "sel.the"=>:other}.merge(@defaults)
+          @command.set "sel", {"that"=>:not_this, "b"=>:c}
+          @command.to_h["$set"].should == {"sel.that" => :not_this, "sel.the"=>:other,"sel.b"=>:c}.merge(@defaults)
+        end
+      end
+
+    end
+
+    context "#unset" do
+      should "add the selector to the $unset hash" do
+        @command.unset "a_field"
+        @command.to_h["$unset"].should == {"a_field"=>true}
+      end
+
+      should "nullify a field when :nullify=>true" do
+        @command.unset "a_field", :nullify=>true
+        @command.to_h["$set"].should == @defaults.merge("a_field"=>nil)
+      end
+
+    end
+
+    context "#push" do
+      should "add the field hash to the $pushAll array for the selector" do
+        @command.push "a_collection", {"a"=>:b, "c"=>:d}
+        @command.to_h[:pushes].should == {"a_collection" => [{"a"=>:b, "c"=>:d}]}
+      end
+
+      should "append the field hash to the$pushAll array for the selector" do
+        @command.push "a_collection", {"a"=>:b, "c"=>:d}
+        @command.push "a_collection", {"a"=>:e, "f"=>:g}
+        @command.to_h[:pushes].should == {"a_collection" => [{"a"=>:b, "c"=>:d},
+                                                                {"a"=>:e, "f"=>:g}]}
+        end
+    end
+
+    context "#pull" do
+      should "add the document id to the $pull array for the selector" do
+        @command.pull "a_collection", "123"
+        @command.to_h[:pulls].should == {"a_collection" => ["123"]}
+      end
+
+      should "append the doc id to the $pull array for the selector" do
+        @command.pull "a_collection", "123"
+        @command.pull "a_collection", "456"
+        @command.to_h[:pulls].should == {"a_collection" => ["123","456"]}
+      end
+    end
+
+    context "#merge" do
+      should "merge the commands hash with an incoming UpdateCommand" do
+        another = MmPartialUpdate::UpdateCommand.new(@doc.new)
+        another.set "this", {"that"=>"the other"}
+        another.unset "me"
+        another.push "a", {"a"=>:b}
+        another.pull "b", "c"
+        @command.merge(another).should == @command.to_h.merge(another.to_h)
+      end
+    end
+
+    context "#prepare_mongodb_commands" do
+      should "separate operations into sets, pulls and pushes" do
+        @command.set "a", {:b=>2}
+        @command.set "a.c", {"c"=>"d"}
+        @command.push "hi", {:ho=>true}
+        @command.push "hi", {:snack=>"yummy"}
+        @command.push "ho", {:cheeri=>0}
+        @command.pull "zig", "zag"
+        db_commands = @command.send(:prepare_mongodb_commands)
+        db_commands.length.should == 4
+
+        db_commands[0].should == {"$set"=>{"a.b"=>2, "a.c.c"=>"d"}.merge(@defaults)}
+        db_commands[1].should == {"$pull"=>{"zig"=>{"_id"=>{"$in"=>["zag"]}}}}
+        db_commands[2].should == {"$pushAll"=>{"hi"=>[{:ho=>true},{:snack=>"yummy"}]}}
+        db_commands[3].should == {"$pushAll"=>{"ho"=>[{:cheeri=>0}]}}
+      end
+
+    end
+
+
+  end
+end
+