mm_dirtier 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,117 +1,98 @@
- = Observables
+= mm-dirtier
 
- Observables implements observable arrays and hashes by way of the ActiveModel::Notifier, the same mechanism
- underlying the instrumentation API in Rails3. Observables collections broadcast detailed change information for
- any state-modifying operations, including specific elements added or removed, when that information is practically
- obtainable.
+mm-dirtier is a MongoMapper plugin that extends dirty tracking to the entire object graph. The default dirty tracking implementation in MongoMapper will only track dirty attributes for top level documents, and does not detect changes to hash or array keys. mm-dirtier, which currently only works with the Rails3 branch of MongoMapper, will record changes throughout your entire document hierarchy, including in place modifications to embedded array and hash keys.
 
- == Installation
+== Installation
 
- Observables is available as a RubyGem:
+mm-dirtier is available as a RubyGem:
 
      gem install mm_dirtier
 
- == Observing the Observables
+To activate the plugin, add 'mm_dirtier' to your gemfile and
 
- === Example:
+     include 'mm_dirtier'
 
-     #Getting an observable array
+when your app is initialized. mm-dirtier will take care of plugging itself into MongoMapper::Document and MongoMapper::EmbeddedDocument.
 
-     ary = [1,2,3] #or, ary = Observables::Array.new([1,2,3]), or, hsh = Observables::Hash
-     ary.observable? # => false
-     ary.can_be_observable? # => true
-     ary.make_observable => #<Class:#<Array:0x56a84a8>>
+== Usage
 
-     #Setting up a subscription
+mm-dirtier was created to serve a single purpose: to enable MongoMapper to automatically persist changes to documents via MongoDB's atomic opererators.
+Whether or not the deep dirty tracking mm-dirtier provides has any use beyond that, I have no idea. For that reason I will simply provide a basic sample of plugin usage in this readme. If anyone conceives of a use for this plugin beyond document persistence and wants to know more, add an issue to the tracker stating as much and I'll expand the documentation.
 
-     subscription = ary.subscribe do |change_type,args|
-         puts "Change type: #{change_type}"
-         puts "Trigger: #{args.trigger}"
-         puts "Changes: #{args.changes.inspect}"
-         puts "---"
-     end
-
-     #Do stuff
-
-     ary << 3
-     #   Change type: before_added
-     #   Trigger: <<
-     #   Changes: {:added=>[3]}
-     #   ---
-     #   Change type: after_added
-     #   Trigger: <<
-     #   Changes: {:added=>[3]}
-     #   => [1,2,3,3]
+=== Example:
 
-     #Clean up
+     class Procedure
+       include MongoMapper::EmbeddedDocument
 
-     ary.unsubscribe(subscription)
-     ary << 4 # => [1,2,3,3,4]
+       key :name, String
+     end
 
-     #Only listen to after_xxx
+     class Diagnosis
+       include MongoMapper::Document
 
-     subscription = ary.subscribe(/after/) do |change_type,_|
-     puts "Change type:#{change_type}"
+       key :name, String
      end
 
-     ary.concat([9,10,11])
+     class Patient
+       include MongoMapper::Document
 
-     #   Change type: after_added, changes: {:added=>[9,10,11]}
-     #   => [1,2,3,3,4,9,10,11]
+       key :name, String
+       key :nicknames, Array
+       key :address, Hash
 
- 	ary.replace([3,2,1])
+       one  :procedure
+       many :procedures
+       many :diagnosis_ids, Array
+       many :diagnoses, :in => :diagnosis_ids
+     end
 
- 	#   Change type: after_modified, changed: {:added=>[3,2,1], :removed=>[1,2,3,3,4,9,10,11]}
- 	#	=> [3,2,1]
+     p = Patient.create :name=>"Nathan Stults"
+     p.changed? => false
+     p.nicknames << "Col. Easy Andy"
+     p.changed? => true
+     p.nicknames_changed? => true
+     p.nicknames_change => [[],["Col. Easy Andy"]]
 
-     #Hashes work too
+     p.address["city"] = "Santa Rosa"
+     p.address_changed? => true
+     p.address_change => [{},{"city"=>"Santa Rosa"}]
 
-     hsh = {:a=>:b}
-     hsh.can_be_observable? # => true
-     hsh.make_observable
-     hsh.subscribe { |type,args| ... }
+     p.procedure.build :name => "Labotomy"
+     p.procedure_changed? => true
+     p.procedure_change => [nil,<Class ...>]
+     p.procedure.changed? => true
+     p.procedure.name_changed? => true
 
- == Special case: ownership
+     p.procedures.build(:name=>"Labotomy")
+     p.procedures_changed? => true
+     p.procedures_change? => [[],[<Class...]]
+     p.procedures[0].changed? => true
+     p.procedures[0].name_changed? => true
+     p.procedures[0].name_change => [nil,"Labotomy"]
 
- Observables was created to assist in the implementation of proper dirty tracking for in-place modifications
- to embedded collections in ORM's, particularly for documented oriented databases, where
- this is a common situation. In this scenario and similar scenarios, observable collections
- will only be subscribed to by the object that owns them. However, the parent object
- may own any number of child collections. To avoid having to manage myriad subscription
- objects, each observable collection can have a single 'observer' - and will manage the
- subscription to that observer like so:
+     #in_array associations are a little different than embedded associations
+     #because what is actually stored on the document is only the array of ids
+     #then that is what is tracked for changed.
+     p.diagnoses << Diagnosis.create(:name=>"Aspergers Syndrom")
+     p.diagnosis_ids_changed? => true
+     p.diagnosis_ids_change => [[],[BSON::ObjectId('...')]]
 
- 	class Owner
- 		def my_array
- 			@my_array
- 		end
+     p.save
 
- 		def my_array=(new_array)
- 			@my_array.clear_observer if @my_array
- 			@my_array = new_array.tap {|a|a.make_observable}
- 			@my_array.set_observer(self, :pattern=>/before/, :callback_method=>:my_array_before_change)
- 			#Acceptable alernatives are:
- 			#  @my_array.set_observer { |type,args| ... }
- 			#  @my_array.set_observer(self, :pattern=>/before/) { |sender,type,args| ... }
- 		end
+     p.changed? => false
+     p.procedure.changed? => false
+     p.procedures[0].changed? => false
 
- 		def my_array_before_change(sender,type,args)
- 			#sender = @my_array
- 			#do something interesting, like, say, attribute_will_change!(:my_array)
- 		end
 
- 	end
 
- == Note on Patches/Pull Requests
+== Note on Patches/Pull Requests
 
- * Fork the project.
- * Make your feature addition or bug fix.
- * Add tests for it. This is important so I don't break it in a
-   future version unintentionally.
- * Commit, do not mess with rakefile, version, or history.
-   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
- * Send me a pull request. Bonus points for topic branches.
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
 
- == Copyright
+== Copyright
 
- Copyright (c) 2010 Nathan Stults. See LICENSE for details.
+Copyright (c) 1776 Nathan Stults. See LICENSE for details.

data/lib/mm_dirtier/plugins/dirtier.rb

@@ -4,12 +4,13 @@ module MmDirtier
     module Dirtier
 
       def self.included(model)
+        model.plugin MongoMapper::Plugins::Dirty unless
+          model.plugins.include?(MongoMapper::Plugins::Dirty)
         model.plugin MmDirtier::Plugins::Dirtier
       end
 
       def self.configure(model)
-        model.plugin MongoMapper::Plugins::Dirty unless
-          model.plugins.include?(MongoMapper::Plugins::Dirty)
+
       end
 
       module InstanceMethods

data/lib/mm_dirtier/version.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 module MongoMapper
   module Dirtier
-    Version = '0.1.0'
+    Version = '0.1.1'
   end
-end
+end

data/test/functional/test_one_embedded_proxy.rb

@@ -2,13 +2,17 @@ require 'test_helper'
 
 class OneEmbeddedProxyTest < Test::Unit::TestCase
   def setup
-    @document = Doc { key :ary, Array }
+    @document = Doc("Doc") { key :ary, Array }
   end
 
   context "marking changes on one embedded  proxies" do
     setup do
-      @child = EDoc { key :name, String }
+      @child = EDoc("Child") { key :name, String }
+      @child.plugin MongoMapper::Plugins::Dirty
+      @child.plugin MmDirtier::Plugins::Dirtier
       @document.one :child, :class=>@child
+      @child.one :grandchild, :class=>@child
+
     end
 
     should "not happen if there are none" do
@@ -36,7 +40,7 @@ class OneEmbeddedProxyTest < Test::Unit::TestCase
       doc.child_changed?.should be_false
     end
 
-    should "detect when a collection is set to nil" do
+    should "detect when a child is set to nil" do
       doc = @document.new
       c = doc.child.build
       doc.save!
@@ -64,5 +68,18 @@ class OneEmbeddedProxyTest < Test::Unit::TestCase
       doc.child.name = "hi there"
       doc.child_changed?.should be_false
     end
+
+    should "detect deletion on a nested embedded one" do
+      doc = @document.new
+      child = doc.child.build
+      grandchild = child.grandchild.build
+      doc.save!
+      child.name = "tada"
+      child.grandchild = nil
+      child.grandchild_changed?.should be_true
+      change = child.grandchild_change
+      change[0].should == grandchild
+      change[1].should be_nil
+    end
   end
 end

data/test/test_helper.rb

@@ -29,7 +29,8 @@ class Test::Unit::TestCase
   end
 
   def EDoc(name='Class', &block)
-    klass = Class.new do
+    klass = Class.new
+    klass.class_eval do
       include MongoMapper::EmbeddedDocument
 
       if name

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mm_dirtier
 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
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-16 00:00:00 -07:00
+date: 2010-10-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency