activerecord 1.0.0 → 2.0.0

data/lib/active_record/callbacks.rb

@@ -1,32 +1,32 @@
 require 'observer'
 
 module ActiveRecord
-  # Callbacks are hooks into the lifecycle of an Active Record object that allows you to trigger logic
-  # before or after an alteration of the object state. This can be used to make sure that associated and 
-  # dependent objects are deleted when destroy is called (by overwriting before_destroy) or to massage attributes
-  # before they're validated (by overwriting before_validation). As an example of the callbacks initiated, consider
-  # the Base#save call:
-  #
-  # * (-) save
-  # * (-) valid?
-  # * (1) before_validation
-  # * (2) before_validation_on_create
-  # * (-) validate
-  # * (-) validate_on_create
-  # * (4) after_validation
-  # * (5) after_validation_on_create 
-  # * (6) before_save
-  # * (7) before_create
-  # * (-) create
-  # * (8) after_create
-  # * (9) after_save
-  # 
-  # That's a total of nine callbacks, which gives you immense power to react and prepare for each state in the
-  # Active Record lifecyle.
+  # Callbacks are hooks into the lifecycle of an Active Record object that allow you to trigger logic
+  # before or after an alteration of the object state. This can be used to make sure that associated and
+  # dependent objects are deleted when destroy is called (by overwriting +before_destroy+) or to massage attributes
+  # before they're validated (by overwriting +before_validation+). As an example of the callbacks initiated, consider
+  # the <tt>Base#save</tt> call:
+  #
+  # * (-) <tt>save</tt>
+  # * (-) <tt>valid</tt>
+  # * (1) <tt>before_validation</tt>
+  # * (2) <tt>before_validation_on_create</tt>
+  # * (-) <tt>validate</tt>
+  # * (-) <tt>validate_on_create</tt>
+  # * (3) <tt>after_validation</tt>
+  # * (4) <tt>after_validation_on_create</tt>
+  # * (5) <tt>before_save</tt>
+  # * (6) <tt>before_create</tt>
+  # * (-) <tt>create</tt>
+  # * (7) <tt>after_create</tt>
+  # * (8) <tt>after_save</tt>
+  #
+  # That's a total of eight callbacks, which gives you immense power to react and prepare for each state in the
+  # Active Record lifecycle.
   #
   # Examples:
   #   class CreditCard < ActiveRecord::Base
-  #     # Strip everything but digits, so the user can specify "555 234 34" or 
+  #     # Strip everything but digits, so the user can specify "555 234 34" or
   #     # "5552-3434" or both will mean "55523434"
   #     def before_validation_on_create
   #       self.number = number.gsub(/[^0-9]/, "") if attribute_present?("number")
@@ -34,18 +34,19 @@ module ActiveRecord
   #   end
   #
   #   class Subscription < ActiveRecord::Base
-  #     # Automatically assign the signup date
-  #     def before_create
-  #       self.signed_up_on = Date.today
-  #     end
+  #     before_create :record_signup
+  #
+  #     private
+  #       def record_signup
+  #         self.signed_up_on = Date.today
+  #       end
   #   end
   #
   #   class Firm < ActiveRecord::Base
   #     # Destroys the associated clients and people when the firm is destroyed
-  #     def before_destroy
-  #       Client.destroy_all "client_of = #{id}"
-  #       Person.destroy_all "firm_id = #{id}"
-  #     end
+  #     before_destroy { |record| Person.destroy_all "firm_id = #{record.id}"   }
+  #     before_destroy { |record| Client.destroy_all "client_of = #{record.id}" }
+  #   end
   #
   # == Inheritable callback queues
   #
@@ -61,8 +62,8 @@ module ActiveRecord
   #     before_destroy :destroy_readers
   #   end
   #
-  # Now, when Topic#destroy is run only +destroy_author+ is called. When Reply#destroy is run both +destroy_author+ and
-  # +destroy_readers+ is called. Contrast this to the situation where we've implemented the save behavior through overwriteable
+  # Now, when <tt>Topic#destroy</tt> is run only +destroy_author+ is called. When <tt>Reply#destroy</tt> is run, both +destroy_author+ and
+  # +destroy_readers+ are called. Contrast this to the situation where we've implemented the save behavior through overwriteable
   # methods:
   #
   #   class Topic < ActiveRecord::Base
@@ -73,15 +74,19 @@ module ActiveRecord
   #     def before_destroy() destroy_readers end
   #   end
   #
-  # In that case, Reply#destroy would only run +destroy_readers+ and _not_ +destroy_author+. So use the callback macros when 
-  # you want to ensure that a certain callback is called for the entire hierarchy and the regular overwriteable methods when you
-  # want to leave it up to each descendent to decide whether they want to call +super+ and trigger the inherited callbacks.
+  # In that case, <tt>Reply#destroy</tt> would only run +destroy_readers+ and _not_ +destroy_author+. So, use the callback macros when
+  # you want to ensure that a certain callback is called for the entire hierarchy, and use the regular overwriteable methods
+  # when you want to leave it up to each descendent to decide whether they want to call +super+ and trigger the inherited callbacks.
+  #
+  # *IMPORTANT:* In order for inheritance to work for the callback queues, you must specify the callbacks before specifying the
+  # associations. Otherwise, you might trigger the loading of a child before the parent has registered the callbacks and they won't
+  # be inherited.
   #
   # == Types of callbacks
   #
-  # There are four types of callbacks accepted by the callback macros: Method references (symbol), callback objects, 
+  # There are four types of callbacks accepted by the callback macros: Method references (symbol), callback objects,
   # inline methods (using a proc), and inline eval methods (using a string). Method references and callback objects are the
-  # recommended approaches, inline methods using a proc is some times appropriate (such as for creating mix-ins), and inline
+  # recommended approaches, inline methods using a proc are sometimes appropriate (such as for creating mix-ins), and inline
   # eval methods are deprecated.
   #
   # The method reference callbacks work by specifying a protected or private method available in the object, like this:
@@ -115,8 +120,8 @@ module ActiveRecord
   #     def after_save(record)
   #       record.credit_card_number = decrypt(record.credit_card_number)
   #     end
-  #     
-  #     alias_method :after_initialize, :after_save
+  #
+  #     alias_method :after_find, :after_save
   #
   #     private
   #       def encrypt(value)
@@ -124,7 +129,7 @@ module ActiveRecord
   #       end
   #
   #       def decrypt(value)
-  #         # Secrecy is unvieled
+  #         # Secrecy is unveiled
   #       end
   #   end
   #
@@ -138,200 +143,199 @@ module ActiveRecord
   #     before_destroy 'self.class.delete_all "parent_id = #{id}"'
   #   end
   #
-  # Notice that single plings (') are used so the #{id} part isn't evaluated until the callback is triggered. Also note that these
+  # Notice that single quotes (') are used so the <tt>#{id}</tt> part isn't evaluated until the callback is triggered. Also note that these
   # inline callbacks can be stacked just like the regular ones:
   #
   #   class Topic < ActiveRecord::Base
-  #     before_destroy 'self.class.delete_all "parent_id = #{id}"', 
+  #     before_destroy 'self.class.delete_all "parent_id = #{id}"',
   #                    'puts "Evaluated after parents are destroyed"'
   #   end
   #
-  # == The after_find and after_initialize exceptions
+  # == The +after_find+ and +after_initialize+ exceptions
   #
-  # Because after_find and after_initialize is called for each object instantiated found by a finder, such as Base.find_all, we've had
-  # to implement a simple performance constraint (50% more speed on a simple test case). Unlike all the other callbacks, after_find and
-  # after_initialize can only be declared using an explicit implementation. So using the inheritable callback queue for after_find and
-  # after_initialize won't work.
+  # Because +after_find+ and +after_initialize+ are called for each object found and instantiated by a finder, such as <tt>Base.find(:all)</tt>, we've had
+  # to implement a simple performance constraint (50% more speed on a simple test case). Unlike all the other callbacks, +after_find+ and
+  # +after_initialize+ will only be run if an explicit implementation is defined (<tt>def after_find</tt>). In that case, all of the
+  # callback types will be called.
+  #
+  # == <tt>before_validation*</tt> returning statements
+  #
+  # If the returning value of a +before_validation+ callback can be evaluated to +false+, the process will be aborted and <tt>Base#save</tt> will return +false+.
+  # If <tt>Base#save!</tt> is called it will raise a +RecordNotSaved+ exception.
+  # Nothing will be appended to the errors object.
+  #
+  # == Canceling callbacks
+  #
+  # If a <tt>before_*</tt> callback returns +false+, all the later callbacks and the associated action are cancelled. If an <tt>after_*</tt> callback returns
+  # +false+, all the later callbacks are cancelled. Callbacks are generally run in the order they are defined, with the exception of callbacks
+  # defined as methods on the model, which are called last.
   module Callbacks
-    CALLBACKS = %w( 
-      after_find after_initialize before_save after_save before_create after_create before_update after_update before_validation 
+    CALLBACKS = %w(
+      after_find after_initialize before_save after_save before_create after_create before_update after_update before_validation
       after_validation before_validation_on_create after_validation_on_create before_validation_on_update
       after_validation_on_update before_destroy after_destroy
     )
 
-    def self.append_features(base) #:nodoc:
-      super
+    def self.included(base) #:nodoc:
+      base.extend Observable
 
-      base.extend(ClassMethods)
-      base.class_eval do
-        class << self
-          include Observable
-          alias_method :instantiate_without_callbacks, :instantiate
-          alias_method :instantiate, :instantiate_with_callbacks
-        end
+      [:create_or_update, :valid?, :create, :update, :destroy].each do |method|
+        base.send :alias_method_chain, method, :callbacks
       end
 
-      base.class_eval do
-        alias_method :initialize_without_callbacks, :initialize
-        alias_method :initialize, :initialize_with_callbacks
-
-        alias_method :create_or_update_without_callbacks, :create_or_update
-        alias_method :create_or_update, :create_or_update_with_callbacks
-
-        alias_method :valid_without_callbacks, :valid?
-        alias_method :valid?, :valid_with_callbacks
-
-        alias_method :create_without_callbacks, :create
-        alias_method :create, :create_with_callbacks
-
-        alias_method :update_without_callbacks, :update
-        alias_method :update, :update_with_callbacks
-
-        alias_method :destroy_without_callbacks, :destroy
-        alias_method :destroy, :destroy_with_callbacks
+      CALLBACKS.each do |method|
+        base.class_eval <<-"end_eval"
+          def self.#{method}(*callbacks, &block)
+            callbacks << block if block_given?
+            write_inheritable_array(#{method.to_sym.inspect}, callbacks)
+          end
+        end_eval
       end
-
-      CALLBACKS.each { |cb| base.class_eval("def self.#{cb}(*methods) write_inheritable_array(\"#{cb}\", methods) end") }
     end
 
-    module ClassMethods #:nodoc:
-      def instantiate_with_callbacks(record)
-        object = instantiate_without_callbacks(record)
-        object.callback(:after_find) if object.respond_to_without_attributes?(:after_find)
-        object.callback(:after_initialize) if object.respond_to_without_attributes?(:after_initialize)
-        object
-      end
-    end
+    # Is called when the object was instantiated by one of the finders, like <tt>Base.find</tt>.
+    #def after_find() end
 
-    # Is called when the object was instantiated by one of the finders, like Base.find.
-    # def after_find() end
+    # Is called after the object has been instantiated by a call to <tt>Base.new</tt>.
+    #def after_initialize() end
 
-    # Is called after the object has been instantiated by a call to Base.new.
-    # def after_initialize() end
-    def initialize_with_callbacks(attributes = nil) #:nodoc:
-      initialize_without_callbacks(attributes)
-      yield self if block_given?
-      after_initialize if respond_to_without_attributes?(:after_initialize)
-    end
-    
-    # Is called _before_ Base.save (regardless of whether it's a create or update save).
+    # Is called _before_ <tt>Base.save</tt> (regardless of whether it's a +create+ or +update+ save).
     def before_save() end
 
-    # Is called _after_ Base.save (regardless of whether it's a create or update save).
+    # Is called _after_ <tt>Base.save</tt> (regardless of whether it's a +create+ or +update+ save).
+    #
+    #  class Contact < ActiveRecord::Base
+    #    after_save { logger.info( 'New contact saved!' ) }
+    #  end
     def after_save()  end
     def create_or_update_with_callbacks #:nodoc:
-      callback(:before_save)
-      create_or_update_without_callbacks
+      return false if callback(:before_save) == false
+      result = create_or_update_without_callbacks
       callback(:after_save)
+      result
     end
+    private :create_or_update_with_callbacks
 
-    # Is called _before_ Base.save on new objects that haven't been saved yet (no record exists).
+    # Is called _before_ <tt>Base.save</tt> on new objects that haven't been saved yet (no record exists).
     def before_create() end
 
-    # Is called _after_ Base.save on new objects that haven't been saved yet (no record exists).
+    # Is called _after_ <tt>Base.save</tt> on new objects that haven't been saved yet (no record exists).
     def after_create() end
     def create_with_callbacks #:nodoc:
-      callback(:before_create)
-      create_without_callbacks
+      return false if callback(:before_create) == false
+      result = create_without_callbacks
       callback(:after_create)
+      result
     end
+    private :create_with_callbacks
 
-    # Is called _before_ Base.save on existing objects that has a record.
+    # Is called _before_ <tt>Base.save</tt> on existing objects that have a record.
     def before_update() end
 
-    # Is called _after_ Base.save on existing objects that has a record.
+    # Is called _after_ <tt>Base.save</tt> on existing objects that have a record.
     def after_update() end
 
     def update_with_callbacks #:nodoc:
-      callback(:before_update)
-      update_without_callbacks
+      return false if callback(:before_update) == false
+      result = update_without_callbacks
       callback(:after_update)
+      result
     end
+    private :update_with_callbacks
 
-    # Is called _before_ Validations.validate (which is part of the Base.save call).
+    # Is called _before_ <tt>Validations.validate</tt> (which is part of the <tt>Base.save</tt> call).
     def before_validation() end
 
-    # Is called _after_ Validations.validate (which is part of the Base.save call).
+    # Is called _after_ <tt>Validations.validate</tt> (which is part of the <tt>Base.save</tt> call).
     def after_validation() end
 
-    # Is called _before_ Validations.validate (which is part of the Base.save call) on new objects
+    # Is called _before_ <tt>Validations.validate</tt> (which is part of the <tt>Base.save</tt> call) on new objects
     # that haven't been saved yet (no record exists).
     def before_validation_on_create() end
 
-    # Is called _after_ Validations.validate (which is part of the Base.save call) on new objects
+    # Is called _after_ <tt>Validations.validate</tt> (which is part of the <tt>Base.save</tt> call) on new objects
     # that haven't been saved yet (no record exists).
     def after_validation_on_create()  end
 
-    # Is called _before_ Validations.validate (which is part of the Base.save call) on 
-    # existing objects that has a record.
+    # Is called _before_ <tt>Validations.validate</tt> (which is part of the <tt>Base.save</tt> call) on
+    # existing objects that have a record.
     def before_validation_on_update() end
 
-    # Is called _after_ Validations.validate (which is part of the Base.save call) on 
-    # existing objects that has a record.
+    # Is called _after_ <tt>Validations.validate</tt> (which is part of the <tt>Base.save</tt> call) on
+    # existing objects that have a record.
     def after_validation_on_update()  end
 
-    def valid_with_callbacks #:nodoc:
-      callback(:before_validation)
-      if new_record? then callback(:before_validation_on_create) else callback(:before_validation_on_update) end
+    def valid_with_callbacks? #:nodoc:
+      return false if callback(:before_validation) == false
+      if new_record? then result = callback(:before_validation_on_create) else result = callback(:before_validation_on_update) end
+      return false if result == false
 
-      result = valid_without_callbacks
+      result = valid_without_callbacks?
 
       callback(:after_validation)
       if new_record? then callback(:after_validation_on_create) else callback(:after_validation_on_update) end
-      
+
       return result
     end
 
-    # Is called _before_ Base.destroy.
+    # Is called _before_ <tt>Base.destroy</tt>.
+    #
+    # Note: If you need to _destroy_ or _nullify_ associated records first,
+    # use the <tt>:dependent</tt> option on your associations.
     def before_destroy() end
 
-    # Is called _after_ Base.destroy (and all the attributes have been frozen).
+    # Is called _after_ <tt>Base.destroy</tt> (and all the attributes have been frozen).
+    #
+    #  class Contact < ActiveRecord::Base
+    #    after_destroy { |record| logger.info( "Contact #{record.id} was destroyed." ) }
+    #  end
     def after_destroy()  end
     def destroy_with_callbacks #:nodoc:
-      callback(:before_destroy)
-      destroy_without_callbacks
+      return false if callback(:before_destroy) == false
+      result = destroy_without_callbacks
       callback(:after_destroy)
+      result
     end
 
-    def callback(callback_method) #:nodoc:
-      run_callbacks(callback_method)
-      send(callback_method)
-      notify(callback_method)
-    end
-
-    def run_callbacks(callback_method)
-      filters = self.class.read_inheritable_attribute(callback_method.to_s)
-      if filters.nil? then return end
-      filters.each do |filter| 
-        if Symbol === filter
-          self.send(filter)
-        elsif String === filter
-          eval(filter, binding)
-        elsif filter_block?(filter)
-          filter.call(self)
-        elsif filter_class?(filter, callback_method)
-          filter.send(callback_method, self)
-        else
-          raise(
-            ActiveRecordError, 
-            "Filters need to be either a symbol, string (to be eval'ed), proc/method, or " +
-            "class implementing a static filter method"
-          )
+    private
+      def callback(method)
+        notify(method)
+
+        callbacks_for(method).each do |callback|
+          result = case callback
+            when Symbol
+              self.send(callback)
+            when String
+              eval(callback, binding)
+            when Proc, Method
+              callback.call(self)
+            else
+              if callback.respond_to?(method)
+                callback.send(method, self)
+              else
+                raise ActiveRecordError, "Callbacks must be a symbol denoting the method to call, a string to be evaluated, a block to be invoked, or an object responding to the callback method."
+              end
+          end
+          return false if result == false
         end
+
+        result = send(method) if respond_to_without_attributes?(method)
+
+        return result
+      end
+
+      def callbacks_for(method)
+        self.class.read_inheritable_attribute(method.to_sym) or []
+      end
+
+      def invoke_and_notify(method)
+        notify(method)
+        send(method) if respond_to_without_attributes?(method)
+      end
+
+      def notify(method) #:nodoc:
+        self.class.changed
+        self.class.notify_observers(method, self)
       end
-    end
-    
-    def filter_block?(filter)
-      filter.respond_to?("call") && (filter.arity == 1 || filter.arity == -1)
-    end
-    
-    def filter_class?(filter, callback_method)
-      filter.respond_to?(callback_method)
-    end
-    
-    def notify(callback_method) #:nodoc:
-      self.class.changed
-      self.class.notify_observers(callback_method, self)
-    end
   end
-end
+end