mm_dirtier 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nathan Stults
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,117 @@
+ = Observables
+
+ 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.
+
+ == Installation
+
+ Observables is available as a RubyGem:
+
+     gem install mm_dirtier
+
+ == Observing the Observables
+
+ === Example:
+
+     #Getting an observable array
+
+     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>>
+
+     #Setting up a subscription
+
+     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]
+
+     #Clean up
+
+     ary.unsubscribe(subscription)
+     ary << 4 # => [1,2,3,3,4]
+
+     #Only listen to after_xxx
+
+     subscription = ary.subscribe(/after/) do |change_type,_|
+     puts "Change type:#{change_type}"
+     end
+
+     ary.concat([9,10,11])
+
+     #   Change type: after_added, changes: {:added=>[9,10,11]}
+     #   => [1,2,3,3,4,9,10,11]
+
+ 	ary.replace([3,2,1])
+
+ 	#   Change type: after_modified, changed: {:added=>[3,2,1], :removed=>[1,2,3,3,4,9,10,11]}
+ 	#	=> [3,2,1]
+
+     #Hashes work too
+
+     hsh = {:a=>:b}
+     hsh.can_be_observable? # => true
+     hsh.make_observable
+     hsh.subscribe { |type,args| ... }
+
+ == Special case: ownership
+
+ 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:
+
+ 	class Owner
+ 		def my_array
+ 			@my_array
+ 		end
+
+ 		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
+
+ 		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
+
+ * 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 (c) 2010 Nathan Stults. See LICENSE for details.

data/lib/mm_dirtier/extensions.rb

@@ -0,0 +1,43 @@
+module MongoMapper
+  module Plugins
+    module Associations
+      #By default, proxies should not be observable
+      class Proxy
+        def can_be_observable?
+          false
+        end
+      end
+
+      class ManyEmbeddedProxy
+        def can_be_observable?; true; end
+
+        def make_observable
+          class << self; include MmDirtier::ManyEmbeddedProxyListener; end unless observable?
+        end
+      end
+
+      class ManyEmbeddedPolymorphicProxy
+        def can_be_observable?; true; end
+
+        def make_observable
+          class << self; include MmDirtier::ManyEmbeddedProxyListener; end unless observable?
+        end
+      end
+
+      class InArrayProxy
+        def can_be_observable?; true; end
+        def make_observable
+          class << self; include MmDirtier::InArrayProxyListener;end unless observable?
+        end
+      end
+
+      class OneEmbeddedProxy
+        def can_be_observable?; true; end
+        def make_observable
+          class << self; include MmDirtier::OneEmbeddedProxyListener;end unless observable?
+        end
+      end
+
+    end
+  end
+end

data/lib/mm_dirtier/in_array_proxy_listener.rb

@@ -0,0 +1,20 @@
+module MmDirtier
+  module InArrayProxyListener
+    include Observables::Base
+
+    def ids
+      super.tap do |ids|
+
+        unless ids.observable?
+          ids.make_observable
+          ids.set_observer do |sender,type,args|
+            notifier.publish type, args
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/mm_dirtier/many_embedded_proxy_listener.rb

@@ -0,0 +1,13 @@
+module MmDirtier
+  module ManyEmbeddedProxyListener
+    include Observables::ArrayWatcher
+
+    #It appears that #make_observable operates on the underlying
+    #target, not on the proxy. Therefore, 'replace', which is proxied,
+    #does not get properly overriden. this is intended to fix that.
+    def replace(*args)
+      changes = changes_for(:modified,:replace,*args)
+      changing(:modified,:trigger=>:replace, :changes=>changes) {super}
+    end
+  end
+end

data/lib/mm_dirtier/one_embedded_proxy_listener.rb

@@ -0,0 +1,30 @@
+module MmDirtier
+  module OneEmbeddedProxyListener
+    include Observables::Base
+
+    def replace(val)
+      changing(:modifier) {super}
+    end
+
+    #This is a dirty hack.
+    #duplicable? has to return true,
+    #or the ActiveModel::Dirty will store
+    # the proxy in its change set,
+    # and then when you check for changes
+    # it will always reflect the latest value
+    # of its target, which isn't what is desired.
+    # However, duplicating an embedded document
+    # gives it a new object ID, which ruins the
+    # identity of the child and isn't what
+    # we want either. Thus this nasty, nasty
+    # business. There must be a better way,
+    # but at the moment it escapes me.
+    def duplicable?
+      true
+    end
+
+    def clone
+      target
+    end
+  end
+end

data/lib/mm_dirtier/one_proxy_listener.rb

@@ -0,0 +1,25 @@
+module MmDirtier
+  module OneProxyListener
+    include Observables::Base
+
+    def replace(val)
+      change_type = target.nil? ? :modified : :added
+      changes = changes_for(change_type,:replace,val)
+      changing(change_type,:trigger=>:replace, :changes=>changes) {super}
+    end
+
+    def changes_for(change_type, trigger_method, *args, &block)
+      prev = target.nil? ? nil : target.dup
+      if change_type == :added
+        lambda {{:added=>args}}
+      else
+        lambda{{:removed=>[prev], :added=>args}}
+      end
+    end
+
+    def dup
+      target.dup
+    end
+
+  end
+end

data/lib/mm_dirtier/plugins/dirtier.rb

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+module MmDirtier
+  module Plugins
+    module Dirtier
+
+      def self.included(model)
+        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
+
+        protected
+
+        def attribute_method?(attr)
+          #Since associations are storing their changes in the models
+          # normal dirty tracking system, then association names are
+          # valid attributes as far as dirty is concerned
+          super || !!associations.keys.detect { |a| a.to_s == attr.to_s }
+        end
+
+        private
+
+        def get_proxy(association)
+          #I can't imagine why, but super.tap{...} is causing errors here.
+          #Proxy meta monkey wierdness, no doubt.
+          proxy = super
+          key_name = proxy_key_name(proxy)
+          unless association.observable?
+            observe_if_observable(key_name,proxy)
+          end
+          return proxy
+        end
+
+        def proxy_key_name(proxy)
+          proxy.options[:in] ? proxy.options[:in] : proxy.association.name
+        end
+
+        def write_key(key, value)
+          old_value = read_key(key)
+          old_value.clear_observer if old_value && old_value.observable?
+          observe_if_observable(key, value) if value
+          super(key,value)
+        end
+
+        def value_changed?(key_name, old, value)
+          value = nil if keys[key_name] && keys[key_name].number? && value.blank?
+          old != value
+        end
+
+
+        def observe_if_observable(key, value)
+          key = key.to_s
+
+          if value.observable? || value.can_be_observable?
+
+            value.make_observable unless value.observable?
+            previous_values = nil
+            value.set_observer do |_,change_type,args|
+              if change_type.to_s =~ /before/
+                previous_values = attribute_was(key)
+                #previous_values = previous_values.nil? ? nil : previous_values.dup
+                previous_values = dup_if_required(previous_values)
+                attribute_will_change!(key) unless attribute_changed?(key)
+              else
+                changed_attributes.delete(key) unless value_changed?(key,previous_values,args.current_values)
+              end
+            end
+          end
+        end
+
+        def dup_if_required(val)
+          val.nil? || val.respond_to?(:_id) ? val : val.dup
+        end
+
+      end
+    end
+  end
+end

data/lib/mm_dirtier/version.rb

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

data/lib/mm_dirtier.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require "mongo_mapper"
+require "observables"
+
+base_dir = File.dirname(__FILE__)
+[
+ 'version',
+ 'many_embedded_proxy_listener',
+ 'in_array_proxy_listener',
+ 'one_embedded_proxy_listener',
+ 'extensions',
+ 'plugins/dirtier'
+].each {|req| require File.join(base_dir,'mm_dirtier',req)}
+
+
+MongoMapper::Document.append_inclusions(MmDirtier::Plugins::Dirtier)
+MongoMapper::EmbeddedDocument.append_inclusions(MmDirtier::Plugins::Dirtier)

data/test/functional/test_in_array_proxy.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+
+class InArrayProxyTest < Test::Unit::TestCase
+  def setup
+    @document = Doc { key :ary, Array }
+  end
+
+  context "marking changes on many in array proxies" do
+    setup do
+      @child = Doc { key :name, String }
+      @document.key :child_ids, Array
+      @document.many :children, :class=>@child, :in=>:child_ids
+    end
+
+    should "not happen if there are none" do
+      doc = @document.new
+      doc.child_ids_changed?.should be_false
+      doc.child_ids_change.should be_nil
+    end
+
+    should "happen when change happens" do
+      doc = @document.new
+      child = @child.create
+      doc.children << child
+      doc.child_ids_changed?.should be_true
+      doc.child_ids_was.should == []
+      doc.child_ids_change.should == [[], [child.id]]
+    end
+
+    should "track changes for the id array, not the association itself" do
+      doc = @document.new
+      child = @child.create
+      doc.children << child
+      doc.children_changed?.should be_false
+      doc.child_ids_changed?.should be_true
+    end
+
+    should "happen when modified in place" do
+      doc = @document.new
+      child = @child.create
+      doc.children << child
+      doc.save!
+      new_child = @child.new
+      doc.children << new_child
+      doc.child_ids_changed?.should be_true
+      doc.child_ids_was.should == [child.id]
+      doc.child_ids_change.should == [[child.id],[child.id,new_child.id]]
+    end
+
+    should "not be changed when loaded from the database" do
+      doc = @document.new
+      doc.children << @child.create
+      doc.changed?.should be_true
+      doc.save!
+      doc = @document.find(doc.id)
+      doc.changed?.should be_false
+      doc.child_ids_changed?.should be_false
+    end
+
+    should "happen when replaced" do
+      doc = @document.new
+      child = @child.create
+      doc.children << child
+      doc.save!
+      doc.child_ids_changed?.should be_false
+      new_child = @child.create
+      doc.children = [new_child]
+      doc.child_ids_changed?.should be_true
+      doc.child_ids_was.should == [child.id]
+      doc.child_ids_change.should == [[child.id],[new_child.id]]
+    end
+
+    should "detect when a collection is set to []" do
+      doc = @document.new
+      child = @child.create
+      doc.children << child
+      doc.save!
+      doc.children = []
+      doc.child_ids_changed?.should be_true
+      doc.child_ids_change.should == [[child.id],[]]
+    end
+  end
+end

data/test/functional/test_many_embedded_polymorphic_proxy.rb

@@ -0,0 +1,86 @@
+require 'test_helper'
+
+class Child
+  include MongoMapper::EmbeddedDocument
+end
+
+class ManyEmbeddedPolymorphicProxyTest < Test::Unit::TestCase
+
+  def setup
+    @document = Doc { key :name, String }
+  end
+
+  context "marking changes on many embedded proxies" do
+    setup do
+      @document.many :children, :polymorphic=>true, :class_name=>'Child'
+    end
+
+    should "not happen if there are none" do
+      doc = @document.new
+      doc.children_changed?.should be_false
+      doc.children_change.should be_nil
+    end
+
+    should "happen when change happens" do
+      doc = @document.new
+      child = doc.children.build
+      doc.children_changed?.should be_true
+      doc.children_was.should == []
+      doc.children_change.should == [[], [child]]
+    end
+
+    should "happen when modified in place" do
+      doc = @document.new
+      child = doc.children.build
+      doc.save!
+      new_child = Child.new
+      doc.children << new_child
+      doc.children_changed?.should be_true
+      doc.children_was.should == [child]
+      doc.children_change.should == [[child],[child,new_child]]
+    end
+
+    should "not be changed when loaded from the database" do
+      doc = @document.new
+      child = doc.children.build
+      doc.changed?.should be_true
+      doc.save!
+      doc = @document.find(doc.id)
+      doc.changed?.should be_false
+      doc.children_changed?.should be_false
+    end
+
+    should "happen when replaced" do
+      doc = @document.new
+      child = doc.children.build
+      doc.save!
+      doc.children_changed?.should be_false
+      new_child = Child.new
+
+      doc.children = [new_child]
+      doc.children_changed?.should be_true
+      doc.children_was.should == [child]
+      doc.children_change.should == [[child],[new_child]]
+    end
+
+    should "clear when modified in place back to the original state" do
+      doc = @document.new
+      child = doc.children.build
+      doc.save!
+      doc.children.build
+      doc.children_changed?.should be_true
+      doc.children.pop
+      doc.children_changed?.should be_false
+    end
+
+    should "detect when a collection is set to []" do
+      doc = @document.new
+      child = doc.children.build
+      doc.save!
+      doc.children = []
+      doc.children_changed?.should be_true
+      doc.children_change.should == [[child],[]]
+    end
+
+  end
+end

data/test/functional/test_many_embedded_proxy.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+
+class ManyEmbeddedProxyTest < Test::Unit::TestCase
+  def setup
+    @document = Doc { key :ary, Array }
+  end
+
+  context "marking changes on many embedded proxies" do
+    setup do
+      @child = EDoc { key :name, String }
+      @document.many :children, :class=>@child
+    end
+
+    should "not happen if there are none" do
+      doc = @document.new
+      doc.children_changed?.should be_false
+      doc.children_change.should be_nil
+    end
+
+    should "happen when change happens" do
+      doc = @document.new
+      child = doc.children.build
+      doc.children_changed?.should be_true
+      doc.children_was.should == []
+      doc.children_change.should == [[], [child]]
+    end
+
+    should "happen when modified in place" do
+      doc = @document.new
+      child = doc.children.build
+      doc.save!
+      new_child = @child.new
+      doc.children << new_child
+      doc.children_changed?.should be_true
+      doc.children_was.should == [child]
+      doc.children_change.should == [[child],[child,new_child]]
+    end
+
+    should "not be changed when loaded from the database" do
+      doc = @document.new
+      child = doc.children.build
+      doc.changed?.should be_true
+      doc.save!
+      doc = @document.find(doc.id)
+      doc.changed?.should be_false
+      doc.children_changed?.should be_false
+    end
+
+    should "happen when replaced" do
+      doc = @document.new
+      child = doc.children.build
+      doc.save!
+      doc.children_changed?.should be_false
+      new_child = @child.new
+      doc.children = [new_child]
+      doc.children_changed?.should be_true
+      doc.children_was.should == [child]
+      doc.children_change.should == [[child],[new_child]]
+    end
+
+    should "clear when modified in place back to the original state" do
+      doc = @document.new
+      child = doc.children.build
+      doc.save!
+      doc.children.build
+      doc.children_changed?.should be_true
+      doc.children.pop
+      doc.children_changed?.should be_false
+    end
+
+    should "detect when a collection is set to []" do
+      doc = @document.new
+      child = doc.children.build
+      doc.save!
+      doc.children = []
+      doc.children_changed?.should be_true
+      doc.children_change.should == [[child],[]]
+    end
+
+  end
+end

data/test/functional/test_non_embedded_proxies.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class NonEmbeddedProxyTest < Test::Unit::TestCase
+  def setup
+    @document = Doc { key :name, String }
+    @refdoc = Doc { key :name, String }
+  end
+
+  context "changes on many documents proxy" do
+    setup do
+      @document.many :refs, :class=>@refdoc
+    end
+
+    should "not happen" do
+      doc = @document.new
+      doc.refs.build
+      doc.changed?.should be_false
+    end
+
+  end
+end

data/test/functional/test_observable_keys.rb

@@ -0,0 +1,58 @@
+
+require 'test_helper'
+
+class ObservableKeysTest < Test::Unit::TestCase
+  def setup
+    @document = Doc { key :ary, Array }
+  end
+
+  context "marking changes on observable keys" do
+    should "not happen if there are none" do
+      doc = @document.new
+      doc.ary_changed?.should be_false
+      doc.ary_change.should be_nil
+    end
+
+    should "happen when change happens" do
+      doc = @document.new
+      doc.ary = %w(Golly Gee Willikers Batman)
+      doc.ary_changed?.should be_true
+      doc.ary_was.should == []
+      doc.ary_change.should == [[], %w(Golly Gee Willikers Batman)]
+    end
+
+    should "happen when modified in place" do
+      doc = @document.new
+      doc.ary = %w(Golly Gee Willikers Batman)
+      doc.save!
+      doc.ary.push('POW!')
+      doc.ary_changed?.should be_true
+      doc.ary_was.should == %w(Golly Gee Willikers Batman)
+      doc.ary_change.should == [%w(Golly Gee Willikers Batman),%w(Golly Gee Willikers Batman POW!)]
+    end
+
+    should "clear when modified in place back to the original state" do
+      doc = @document.new
+      doc.ary = %w(Golly Gee Willikers Batman)
+      doc.save!
+      doc.ary.push('POW!')
+      doc.ary_changed?.should be_true
+      doc.ary.pop
+      doc.ary_changed?.should be_false
+    end
+
+    should "not flag changes when an array removed from a doc is changed" do
+      doc = @document.new
+      doc.ary = %w(hi there)
+      a1 = doc.ary
+      doc.ary = %w(huggy bear)
+      a2 = doc.ary
+      doc.save!
+      a1 << "huggy bear"
+      doc.ary_changed?.should be_false
+      a2.unshift("hi there")
+      doc.ary_changed?.should be_true
+    end
+
+  end
+end

data/test/functional/test_one_embedded_proxy.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+class OneEmbeddedProxyTest < Test::Unit::TestCase
+  def setup
+    @document = Doc { key :ary, Array }
+  end
+
+  context "marking changes on one embedded  proxies" do
+    setup do
+      @child = EDoc { key :name, String }
+      @document.one :child, :class=>@child
+    end
+
+    should "not happen if there are none" do
+      doc = @document.new
+      doc.child_changed?.should be_false
+      doc.child_change.should be_nil
+    end
+
+    should "happen when change happens" do
+      doc = @document.new
+      child = @child.new
+      doc.child = child
+      doc.child_changed?.should be_true
+      doc.child_was.should == nil
+      doc.child_change.should == [nil, child]
+    end
+
+    should "not be changed when loaded from the database" do
+      doc = @document.new
+      doc.child = @child.new
+      doc.changed?.should be_true
+      doc.save!
+      doc = @document.find(doc.id)
+      doc.changed?.should be_false
+      doc.child_changed?.should be_false
+    end
+
+    should "detect when a collection is set to nil" do
+      doc = @document.new
+      c = doc.child.build
+      doc.save!
+      doc.child = nil
+      doc.child_changed?.should be_true
+      changes = doc.child_change
+      changes[0].should == c
+      changes[1].should be_nil
+    end
+
+    should "remove changes when set back to its original value" do
+      doc = @document.new
+      child = doc.child.build
+      doc.save!
+      doc.child = @child.new
+      doc.child_changed?.should be_true
+      doc.child = child
+      doc.child_changed?.should be_false
+    end
+
+    should "ignore in place changes to child attributes" do
+      doc = @document.new
+      child = doc.child.build
+      doc.save!
+      doc.child.name = "hi there"
+      doc.child_changed?.should be_false
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,95 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'mm_dirtier'
+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 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_dirtier.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class TestMongoMapperDirtier < Test::Unit::TestCase
+  context "including mm_dirtier" do
+    should "include something or other" do
+      assert_equal defined?(MongoMapper::Dirtier), "constant"
+    end
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification 
+name: mm_dirtier
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nathan Stults
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :runtime
+  name: observables
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rake
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: log_buddy
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  name: jnunemaker-matchy
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 11
+        version: "2.11"
+  type: :development
+  name: shoulda
+  prerelease: false
+  version_requirements: *id005
+description: 
+email: 
+- hereiam@sonic.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mm_dirtier/in_array_proxy_listener.rb
+- lib/mm_dirtier/extensions.rb
+- lib/mm_dirtier/one_embedded_proxy_listener.rb
+- lib/mm_dirtier/plugins/dirtier.rb
+- lib/mm_dirtier/version.rb
+- lib/mm_dirtier/one_proxy_listener.rb
+- lib/mm_dirtier/many_embedded_proxy_listener.rb
+- lib/mm_dirtier.rb
+- test/test_helper.rb
+- test/test_mm_dirtier.rb
+- test/functional/test_many_embedded_polymorphic_proxy.rb
+- test/functional/test_one_embedded_proxy.rb
+- test/functional/test_observable_keys.rb
+- test/functional/test_many_embedded_proxy.rb
+- test/functional/test_in_array_proxy.rb
+- test/functional/test_non_embedded_proxies.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/PlasticLizard/mm_dirtier
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Even dirtier dirty tracking for MongoMapper
+test_files: []
+