ohm-contrib 0.0.13 → 0.0.14

data/.gitignore

@@ -19,4 +19,6 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
-.rvmrc
+/.rvmrc
+/.yardoc
+/doc

data/VERSION

@@ -1 +1 @@
-0.0.13
+0.0.14

data/lib/ohm/contrib/callbacks.rb

@@ -0,0 +1,165 @@
+module Ohm
+  # Minimalist callback support for Ohm::Model.
+  #
+  # @example
+  #
+  #   class Post < Ohm::Model
+  #     include Ohm::Callbacks
+  #
+  #     before :validate, :clean_decimals
+  #
+  #     before :create, :timestamp!
+  #     before :save,   :recalc_votes
+  #
+  #     after  :create, :post_to_twitter!
+  #     after  :save,   :sync_ids
+  #
+  #   protected
+  #     def clean_decimals
+  #       # sanitize the decimal values here
+  #     end
+  #
+  #     def timestamp!
+  #       # do timestamping code here
+  #     end
+  #
+  #     def recalc_votes
+  #       # do something here
+  #     end
+  #
+  #     def post_to_twitter!
+  #       # do twitter posting here
+  #     end
+  #
+  #     def sync_ids
+  #       # do something with the ids
+  #     end
+  #   end
+  #
+ 
+  module Callbacks
+    def self.included(base)
+      base.extend Macros
+    end
+
+    module Macros
+      # Use to add a before callback on `method`. Only symbols
+      # are allowed, no string eval, no block option also.
+      #
+      # @example
+      #
+      #   class Post < Ohm::Model
+      #     include Ohm::Callbacks
+      #
+      #     before :create, :timestamp!
+      #     before :save,   :recalc_votes
+      #
+      #   protected
+      #     def timestamp!
+      #       # do timestamping code here
+      #     end
+      #
+      #     def recalc_votes
+      #       # do something here
+      #     end
+      #   end
+      #
+      # @param [Symbol] method the method type, `:validate`, `:create`, or `:save`
+      # @param [Symbol] callback the name of the method to execute
+      # @return [Array<callback>, nil] the callback wrapped in an array or nil 
+      #   if the callback exists
+      def before(method, callback)
+        unless callbacks[:before][method].include? callback
+          callbacks[:before][method] << callback
+        end
+      end
+
+      # Use to add an after callback on `method`. Only symbols
+      # are allowed, no string eval, no block option also.
+      #
+      # @example
+      #
+      #   class Post < Ohm::Model
+      #     include Ohm::Callbacks
+      #
+      #     after  :create, :post_to_twitter!
+      #     after  :save,   :sync_ids
+      #
+      #   protected
+      #     def post_to_twitter!
+      #       # do twitter posting here
+      #     end
+      #
+      #     def sync_ids
+      #       # do something with the ids
+      #     end
+      #   end
+      #
+      # @param [Symbol] method the method type, `:validate`, `:create`, or `:save`
+      # @param [Symbol] callback the name of the method to execute
+      # @return [Array<callback>, nil] the callback in an array or nil if the 
+      #   callback exists
+      def after(method, callback)
+        callbacks[:after][method] << callback
+      end
+      
+      # @private internally used to maintain the state of callbacks
+      def callbacks
+        @callbacks ||= Hash.new { |h, k| h[k] = Hash.new { |h, k| h[k] = [] }}
+      end
+    end
+  
+    # Overrides the validate method of Ohm::Model. This is a bit tricky,
+    # since typically you override this. Make sure you do something like:
+    #
+    #   def validate
+    #     super
+    #
+    #     # do your assertions
+    #   end
+    #
+    # This ensures that you call this method when you defined your own validate
+    # method.
+    #
+    # In all honesty, I don't see the value of putting this here, and I'm still
+    # weighing if this is _really_ needed.
+    def validate
+      execute_callback(:before, :validate)
+      super
+      execute_callback(:after, :validate)
+    end
+    
+    # The overriden create of Ohm::Model. It checks if the
+    # model is valid, and executes all before :create callbacks.
+    #
+    # If the create succeeds, all after :create callbacks are
+    # executed.
+    def create
+      execute_callback(:before, :create)  if valid?
+
+      super.tap do |is_created|
+        execute_callback(:after, :create)  if is_created
+      end
+    end
+  
+    # The overridden save of Ohm::Model. It checks if the model
+    # is valid, and executes all before :save callbacks.
+    #
+    # If the save also succeeds, all after :save callbacks are
+    # executed.
+    def save
+      execute_callback(:before, :save)  if valid?
+
+      super.tap do |is_saved|
+        execute_callback(:after, :save)  if is_saved
+      end
+    end
+
+  private
+    def execute_callback(position, method)
+      self.class.callbacks[position][method].each do |callback|
+        __send__(callback)
+      end
+    end
+  end
+end

data/lib/ohm/contrib.rb

@@ -1,6 +1,6 @@
 module Ohm
   module Contrib
-    VERSION = '0.0.13'
+    VERSION = '0.0.14'
   end
 
   autoload :Boundaries,        "ohm/contrib/boundaries"
@@ -11,4 +11,5 @@ module Ohm
   autoload :ExtraValidations,  "ohm/contrib/extra_validations"
   autoload :Typecast,          "ohm/contrib/typecast"
   autoload :Locking,           "ohm/contrib/locking"
+  autoload :Callbacks,         "ohm/contrib/callbacks"
 end

data/ohm-contrib.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ohm-contrib}
-  s.version = "0.0.13"
+  s.version = "0.0.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril David"]
-  s.date = %q{2010-05-21}
+  s.date = %q{2010-05-23}
   s.description = %q{Highly decoupled drop-in functionality for Ohm models}
   s.email = %q{cyx.ucron@gmail.com}
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "lib/ohm/contrib.rb",
      "lib/ohm/contrib/boundaries.rb",
+     "lib/ohm/contrib/callbacks.rb",
      "lib/ohm/contrib/extra_validations.rb",
      "lib/ohm/contrib/locking.rb",
      "lib/ohm/contrib/number_validations.rb",
@@ -36,6 +37,7 @@ Gem::Specification.new do |s|
      "test/helper.rb",
      "test/test_ohm_boundaries.rb",
      "test/test_ohm_contrib.rb",
+     "test/test_ohm_contrib_callbacks.rb",
      "test/test_ohm_extra_validations.rb",
      "test/test_ohm_number_validations.rb",
      "test/test_ohm_timestamping.rb",
@@ -52,6 +54,7 @@ Gem::Specification.new do |s|
     "test/helper.rb",
      "test/test_ohm_boundaries.rb",
      "test/test_ohm_contrib.rb",
+     "test/test_ohm_contrib_callbacks.rb",
      "test/test_ohm_extra_validations.rb",
      "test/test_ohm_number_validations.rb",
      "test/test_ohm_timestamping.rb",

data/test/test_ohm_contrib_callbacks.rb

@@ -0,0 +1,117 @@
+require "helper"
+
+class OhmContribCallbacksTest < Test::Unit::TestCase
+  class Post < Ohm::Model
+    include Ohm::Callbacks
+
+    attribute :body
+    
+    before :validate, :do_before_validate
+    after  :validate, :do_after_validate
+
+    before :create,   :do_before_create
+    after  :create,   :do_after_create
+
+    before :save,     :do_before_save
+    after  :save,     :do_after_save
+
+    def validate
+      super
+
+      assert_present :body
+    end
+
+    def did?(action)
+      instance_variable_get("@#{ action }")
+    end
+
+  protected
+    def do_before_validate() @do_before_validate = true  end
+    def do_after_validate()  @do_after_validate = true   end
+    def do_before_create()   @do_before_create = true    end
+    def do_after_create()    @do_after_create = true     end
+    def do_before_save()     @do_before_save = true      end
+    def do_after_save()      @do_after_save = true       end
+  end
+
+  context "on save when invalid state" do
+    setup do
+      @post = Post.new
+      @post.save
+    end
+    
+    should "still call before / after validate" do
+      assert @post.did?(:do_before_validate)      
+      assert @post.did?(:do_after_validate)
+    end
+
+    should "not call all other callbacks" do
+      assert ! @post.did?(:do_before_create)
+      assert ! @post.did?(:do_after_create)
+      assert ! @post.did?(:do_before_save)
+      assert ! @post.did?(:do_after_save)
+    end
+  end
+
+  context "on save when valid state" do
+    setup do
+      @post = Post.new(:body => "The Body")
+      @post.save
+    end
+    
+    should "call all callbacks" do
+      assert @post.did?(:do_before_validate)
+      assert @post.did?(:do_after_validate)
+      assert @post.did?(:do_before_create)
+      assert @post.did?(:do_after_create)
+      assert @post.did?(:do_before_save)
+      assert @post.did?(:do_after_save)
+    end
+  end
+
+  context "on save of an existing object" do
+    setup do
+      @post = Post.create(:body => "The Body")
+      @post = Post[@post.id]
+
+      @post.save
+    end
+    
+    should "not call create related callbacks" do
+      assert ! @post.did?(:do_before_create)
+      assert ! @post.did?(:do_after_create)
+    end
+
+    should "call the rest of the callbacks" do
+      assert @post.did?(:do_before_validate)
+      assert @post.did?(:do_after_validate)
+      assert @post.did?(:do_before_save)
+      assert @post.did?(:do_after_save)
+    end    
+  end
+
+  context "on save of an existing invalid object" do
+    setup do
+      @post = Post.create(:body => "The Body")
+      @post = Post[@post.id]
+
+      @post.body = nil
+      @post.save
+    end
+
+    should "call validation related callbacks" do
+      assert @post.did?(:do_before_validate)
+      assert @post.did?(:do_after_validate)
+    end
+   
+    should "not call create related callbacks" do
+      assert ! @post.did?(:do_before_create)
+      assert ! @post.did?(:do_after_create)
+    end
+
+    should "also not call save related callbacks" do
+      assert ! @post.did?(:do_before_save)
+      assert ! @post.did?(:do_after_save)
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 13
-  version: 0.0.13
+  - 14
+  version: 0.0.14
 platform: ruby
 authors: 
 - Cyril David
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-21 00:00:00 +08:00
+date: 2010-05-23 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -95,6 +95,7 @@ files:
 - VERSION
 - lib/ohm/contrib.rb
 - lib/ohm/contrib/boundaries.rb
+- lib/ohm/contrib/callbacks.rb
 - lib/ohm/contrib/extra_validations.rb
 - lib/ohm/contrib/locking.rb
 - lib/ohm/contrib/number_validations.rb
@@ -106,6 +107,7 @@ files:
 - test/helper.rb
 - test/test_ohm_boundaries.rb
 - test/test_ohm_contrib.rb
+- test/test_ohm_contrib_callbacks.rb
 - test/test_ohm_extra_validations.rb
 - test/test_ohm_number_validations.rb
 - test/test_ohm_timestamping.rb
@@ -146,6 +148,7 @@ test_files:
 - test/helper.rb
 - test/test_ohm_boundaries.rb
 - test/test_ohm_contrib.rb
+- test/test_ohm_contrib_callbacks.rb
 - test/test_ohm_extra_validations.rb
 - test/test_ohm_number_validations.rb
 - test/test_ohm_timestamping.rb