mongomatic 0.6.5 → 0.7.0

data/README.rdoc

@@ -201,6 +201,35 @@ Mongomatic doesn't have any kind of special support for relationship management
     end
   end
 
+== Observers
+
+Mongomatic does have one thing in common with ActiveRecord and that is observers. You can add observers to your class to decouple distinct functionality in callbacks. To add observation to your model you must include the Mongomatic::Observable module. All observers inherit from Mongomatic::Observer. 
+
+Unlike ActiveRecord the existence of a CollectionNameObserver will automatically add the observer the CollectionName class. Instead you must use the observer macro or CollectionName.add_observer
+
+You can add your own observers to CollectionName using CollectionName.add_observer(klass).
+
+  class MyCustomCallbacks < Mongomatic::Observer
+    def after_insert_or_update
+      puts "after insert or update"
+    end
+  end
+
+  class Person < Mongomatic::Base
+    include Mongomatic::Observable
+    observer :PersonObserver
+    observer MyCustomCallbacks
+  end
+
+  # this observer is automatically added to the Person class
+  class PersonObserver < Mongomatic::Observer
+    def after_insert(instance)
+      puts "new person inserted"
+    end 
+  end
+
+It is worth noting that you should be careful the operations you perform on the instance of your class passed to the observer callbacks. Calling operations that invoke callbacks can result in an infinite loop if improperly structured. To avoid this future implementations may only pass the document (instance of Mongomatic::MHash) to observers.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/lib/mongomatic/base.rb

@@ -147,7 +147,18 @@ module Mongomatic
       field, hash = hash_for_field(key.to_s, true)
       hash[field]
     end
-    
+   
+    ##
+    # Same as Hash#delete
+    #
+    # mydoc.delete("name")
+    #  => "Ben"
+    # mydoc.has_hey?("name")
+    #  => false
+    def delete(key)
+      @doc.delete(key)
+    end
+
     # Fetch a field (just like a hash):
     #  mydoc["name"]
     #   => "Ben"
@@ -297,6 +308,8 @@ module Mongomatic
     end
     
     def do_callback(meth)
+      notify(meth) if self.class.included_modules.include?(Mongomatic::Observable) # TODO entire block is smelly, doesnt belong here 
+      
       return false unless respond_to?(meth, true)
       send(meth)
     end

data/lib/mongomatic/errors.rb

@@ -32,6 +32,14 @@ module Mongomatic
       !(@errors.any? { |k,v| v && !v.empty? })
     end
     
+    def any?
+      !empty?
+    end
+    
+    def count
+      @errors.values.inject(0) { |sum, errors| sum += errors.size }
+    end
+    
     def full_messages
       full_messages = []
       @errors.each do |field, messages|

data/lib/mongomatic/observable.rb

@@ -0,0 +1,46 @@
+module Mongomatic
+  module Observable
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+    
+    def notify(meth, opts = {})
+      self.class.observers.each do |observer|
+        @observer_cache ||= {}
+        unless observer_klass = @observer_cache[observer]
+          @observer_cache[observer] = observer_klass = Object.const_get(observer) if Module.const_defined?(observer)
+        end
+        
+        if observer_klass
+          instance = observer_klass.new
+          instance.send(meth, self, opts) if instance.respond_to?(meth)
+        end
+      end
+    end
+    
+    module ClassMethods
+      def observers
+        @observers ||= []
+      end
+      
+      def add_observer(klass)
+        @observers ||= []
+        @observers << klass.to_s.to_sym unless @observers.include?(klass.to_s.to_sym)
+      end
+      alias :observer :add_observer
+      
+      def has_observer?(klass_or_sym)
+        case klass_or_sym
+        when Symbol
+          @observers.include?(klass)
+        else
+          @observers.include?(klass.to_s.to_sym)
+        end
+      end
+      
+      def remove_observers
+        @observers = []
+      end
+    end
+  end
+end

data/lib/mongomatic/observer.rb

@@ -0,0 +1,4 @@
+module Mongomatic
+  class Observer
+  end
+end

data/lib/mongomatic.rb

@@ -5,11 +5,14 @@ gem "activesupport", ">= 2.3.5"
 require "bson"
 require "mongo"
 
-begin
+require 'active_support/version'
+
+if ActiveSupport::VERSION::MAJOR == 3
+  gem     'i18n', '>= 0.4.2'
   require 'active_support/core_ext/object/blank' # newer versions of active_support (>= 3.0)
   require 'active_support/core_ext/hash' # newer versions of active_support (>= 3.0)
-rescue LoadError => e
-  require 'active_support/all' # support older versions of active_support (<= 2.3.5)
+else
+  require 'active_support'
 end
 
 module Mongomatic
@@ -29,6 +32,8 @@ module Mongomatic
   end
 end
 
+require "#{File.dirname(__FILE__)}/mongomatic/observer"
+require "#{File.dirname(__FILE__)}/mongomatic/observable"
 require "#{File.dirname(__FILE__)}/mongomatic/exceptions"
 require "#{File.dirname(__FILE__)}/mongomatic/util"
 require "#{File.dirname(__FILE__)}/mongomatic/m_hash"

data/test/helper.rb

@@ -99,13 +99,21 @@ class Thing < Mongomatic::Base
 end
 
 class Foobar < Mongomatic::Base
+  include Mongomatic::Observable
+  observer :FoobarObserver
+  
   def validate
     errors << ["color", "must not be blank"] if self["color"].blank?
     errors << "missing style" if self["style"].blank?
   end
 end
 
+class RigObserver < Mongomatic::Observer
+end
+
 class Rig < Mongomatic::Base
+  include Mongomatic::Observable
+  
   # :cast => true, :raise => false is the default
   typed_field "age",                :type => :fixnum,  :cast => true
   typed_field "manufacturer.name",  :type => :string,  :cast => true

data/test/test_observable.rb

@@ -0,0 +1,200 @@
+require 'helper'
+require 'minitest/autorun'
+
+class MyCoolCallbacks < Mongomatic::Observer
+end
+
+class ThingObserver < Mongomatic::Observer
+end
+
+class FoobarObserver < Mongomatic::Observer
+  class << self
+    attr_accessor :observable_instance, :observer_opts
+    
+    def observer_tests
+      @observer_tests || []
+    end
+  
+    def add_observer_test_val(val)
+      @observer_tests ||= []
+      @observer_tests << val
+    end
+  end
+  
+  def do_something(instance, opts)
+    self.class.observer_opts = opts
+    self.class.add_observer_test_val(:do_something)
+  end
+  
+  def before_validate(instance, opts)
+    self.class.observable_instance = instance
+    self.class.add_observer_test_val(:before_validate)
+  end
+  
+  def after_validate(instance, opts)
+    self.class.add_observer_test_val(:after_validate)
+  end
+  
+  def before_insert(instance, opts)
+    self.class.add_observer_test_val(:before_insert)
+  end
+  
+  def before_insert_or_update(instance, opts)
+    self.class.add_observer_test_val(:before_insert_or_update)
+  end
+  
+  def after_insert_or_update(instance, opts)
+    self.class.add_observer_test_val(:after_insert_or_update)
+  end
+  
+  def after_insert(instance, opts)
+    self.class.add_observer_test_val(:after_insert)
+  end
+
+  def before_update(instance, opts)
+    self.class.add_observer_test_val(:before_update)
+  end
+  
+  def after_update(instance, opts)
+    self.class.add_observer_test_val(:after_update)
+  end
+  
+  def before_remove(instance, opts)
+    self.class.add_observer_test_val(:before_remove)
+  end
+  
+  def after_remove(instance, opts)
+    self.class.add_observer_test_val(:after_remove)
+  end
+end
+
+class TestObservable < MiniTest::Unit::TestCase
+  def test_add_observer_to_class
+    Person.send(:include, Mongomatic::Observable)
+    Person.remove_observers
+    
+    assert_equal [], Person.observers
+    
+    Person.add_observer(MyCoolCallbacks)
+    assert_equal Person.observers, [:MyCoolCallbacks]
+  end
+  
+  def test_add_observer_to_class_as_symbol
+    Person.send(:include, Mongomatic::Observable)
+    Person.remove_observers
+    
+    assert_equal [], Person.observers
+    Person.add_observer(:MyCoolCallbacks)
+    
+    assert_equal Person.observers, [:MyCoolCallbacks]
+  end
+  
+  def test_add_observer_using_directive
+     assert_equal Foobar.observers, [:FoobarObserver]
+  end
+  
+  def test_does_not_bomb_with_nonexistent_observer
+    Person.send(:include, Mongomatic::Observable)
+    Person.remove_observers
+    
+    Person.add_observer(:DoesNotExist)
+    p = Person.new
+    
+    p.valid?
+  end
+  
+  def test_passes_instance_to_observer
+    f = Foobar.new
+    f.valid?
+    
+    assert_equal f, FoobarObserver.observable_instance
+  end
+  
+  def test_before_validate
+    f = Foobar.new
+    f.valid?
+    
+    assert FoobarObserver.observer_tests.include?(:before_validate)
+  end
+  
+  def test_after_validate
+    f = Foobar.new
+    f.valid?
+    
+    assert FoobarObserver.observer_tests.include?(:after_validate)
+  end
+  
+  def test_before_insert
+    f = Foobar.new('style' => 'cool', 'color' => 'green')
+    f.insert
+    
+    assert FoobarObserver.observer_tests.include?(:before_insert)
+  end
+  
+  def test_after_insert
+    f = Foobar.new('style' => 'cool', 'color' => 'green')
+    f.insert
+    
+    assert FoobarObserver.observer_tests.include?(:after_insert)
+  end
+  
+  def test_before_insert_or_update
+    f = Foobar.new('style' => 'cool', 'color' => 'green')
+    f.insert
+    
+    assert FoobarObserver.observer_tests.include?(:before_insert_or_update)
+  end
+  
+  def test_after_insert_or_update
+    f = Foobar.new('style' => 'cool', 'color' => 'green')
+    f.insert
+    
+    assert FoobarObserver.observer_tests.include?(:after_insert_or_update)
+  end
+  
+  def test_before_update
+    f = Foobar.new('style' => 'cool', 'color' => 'green')
+    f.insert
+    f.update
+    
+    assert FoobarObserver.observer_tests.include?(:before_update)
+  end
+  
+  def test_after_update
+    f = Foobar.new('style' => 'cool', 'color' => 'green')
+    f.insert
+    f.update
+    
+    assert FoobarObserver.observer_tests.include?(:after_update)
+  end
+  
+  def test_before_remove
+    f = Foobar.new('style' => 'cool', 'color' => 'green')
+    f.insert
+    f.remove
+    
+    assert FoobarObserver.observer_tests.include?(:before_remove)
+  end
+  
+  def test_after_remove
+    f = Foobar.new('style' => 'cool', 'color' => 'green')
+    f.insert
+    f.remove
+    
+    assert FoobarObserver.observer_tests.include?(:after_remove)
+  end
+  
+  def test_custom_callback
+    opts = {:a => 1234}
+    f = Foobar.new('style' => 'cool', 'color' => 'green')
+    class << f
+      def do_something
+        notify(:do_something, {:a => 1234})
+      end
+    end
+    f.do_something
+    
+    assert FoobarObserver.observer_tests.include?(:do_something)
+    assert_equal opts, FoobarObserver.observer_opts
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 5
-  version: 0.6.5
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Ben Myles
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-16 00:00:00 -08:00
+date: 2010-11-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -99,6 +99,8 @@ files:
 - lib/mongomatic/expectations/present.rb
 - lib/mongomatic/m_hash.rb
 - lib/mongomatic/modifiers.rb
+- lib/mongomatic/observable.rb
+- lib/mongomatic/observer.rb
 - lib/mongomatic/type_converters.rb
 - lib/mongomatic/typed_fields.rb
 - lib/mongomatic/util.rb
@@ -109,6 +111,7 @@ files:
 - test/test_find.rb
 - test/test_misc.rb
 - test/test_modifiers.rb
+- test/test_observable.rb
 - test/test_persistence.rb
 - test/test_typed_fields.rb
 - test/test_validations.rb
@@ -117,8 +120,8 @@ homepage: http://mongomatic.com/
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -150,6 +153,7 @@ test_files:
 - test/test_find.rb
 - test/test_misc.rb
 - test/test_modifiers.rb
+- test/test_observable.rb
 - test/test_persistence.rb
 - test/test_typed_fields.rb
 - test/test_validations.rb