callback 0.1.0 → 0.2.0

data/CHANGES

@@ -1,3 +1,7 @@
+2006-11-04 (0.2.0)
+  * Added register_callback as an alias to define_callback. Added unregistration of callbacks in the
+    unregister_callback and undefine_callback methods.
+
 2006-11-03 (0.1.0)
   * Initial Rubyforge Version. Simple callback library. Supports registering and notifying callbacks.
     Does not yet support unregistering callbacks.

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/clean'
 require 'rake/rdoctask'
 
 PKG_NAME = "callback"
-PKG_VERSION   = "0.1.0"
+PKG_VERSION   = "0.2.0"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_FILES = FileList[
   '[A-Z]*',

data/lib/callback/callback.rb

@@ -1,15 +1,21 @@
 module Callback
-  def define_callback(key, &callback)
-    callbacks.define(key, &callback)
+  def define_callback(key, callback_proc=nil, &callback_block)
+    callbacks.define(key, callback_proc, &callback_block)
   end
+  alias_method :register_callback, :define_callback
 
+  def undefine_callback(key, callback_proc)
+    callbacks.undefine(key, callback_proc)
+  end
+  alias_method :unregister_callback, :undefine_callback
+
+  protected
   def notify_callbacks(key, *args, &error_handler)
     callbacks.notify(key, *args, &error_handler)
   end
-  protected :notify_callbacks
 
+  private
   def callbacks
     @callbacks ||= CallbackContainer.new
   end
-  private :callbacks
 end

data/lib/callback/callback_container.rb

@@ -6,8 +6,20 @@ module Callback
       end
     end
 
-    def define(key, &callback)
+    def define(key, callback_proc=nil, &callback_block)
+      callback = extract_callback(callback_block, callback_proc) do
+        raise "You must define the callback that accepts the call method."
+      end
       @callback_registry[key] << callback
+      callback
+    end
+
+    def undefine(key, callback_proc)
+      callback = extract_callback(callback_proc) do
+        raise "You may only undefine callbacks that use the call method."
+      end
+      @callback_registry[key].delete callback
+      callback
     end
 
     def notify(key, *args, &error_handler)
@@ -19,5 +31,19 @@ module Callback
         end
       end
     end
+
+    protected
+    def extract_callback(first_choice_callback, second_choice_callback = nil)
+      callback = nil
+      if first_choice_callback
+        callback = first_choice_callback
+      elsif second_choice_callback
+        callback = second_choice_callback
+      end
+      unless callback.respond_to? :call
+        yield
+      end
+      return callback
+    end
   end
 end

data/spec/callback_spec.rb

@@ -10,18 +10,74 @@ context "A Callback" do
     end
   end
 
-  specify "should be notified" do
-    callback_key = :create
-    passed_callback_argument = nil
-    @callback_object.define_callback(callback_key) do |callback_argument|
-      passed_callback_argument = callback_argument
+  specify "should be registered as a block and notified" do
+    specify_registration_and_notification do |callback_key, expected_callback|
+      @callback_object.register_callback(callback_key, &expected_callback)
     end
+  end
 
-    expected_argument = Object.new
-    @callback_object.notify_callbacks(callback_key, expected_argument)
-    passed_callback_argument.should_equal expected_argument
+  specify "should be defined as a block and notified" do
+    specify_registration_and_notification do |callback_key, expected_callback|
+      @callback_object.define_callback(callback_key, &expected_callback)
+    end
+  end
+
+  specify "should be registered as a proc and notified" do
+    specify_registration_and_notification do |callback_key, expected_callback|
+      @callback_object.register_callback(callback_key, expected_callback)
+    end
   end
 
+  specify "should be defined as a proc and notified" do
+    specify_registration_and_notification do |callback_key, expected_callback|
+      @callback_object.define_callback(callback_key, expected_callback)
+    end
+  end
+
+  specify "define should require callback with the call method" do
+    proc do
+      specify_registration_and_notification do |callback_key, expected_callback|
+        @callback_object.define_callback(callback_key)
+      end
+    end.should_raise(RuntimeError, "You must define the callback that accepts the call method.")
+  end
+
+  specify "register should require callback with the call method" do
+    proc do
+      specify_registration_and_notification do |callback_key, expected_callback|
+        @callback_object.register_callback(callback_key)
+      end
+    end.should_raise(RuntimeError, "You must define the callback that accepts the call method.")
+  end
+
+  specify "should unregister a proc" do
+    specify_unregistration do |callback_key, callback|
+      @callback_object.unregister_callback callback_key, callback
+    end
+  end
+
+  specify "should undefine a proc" do
+    specify_unregistration do |callback_key, callback|
+      @callback_object.undefine_callback callback_key, callback
+    end
+  end
+
+  specify "undefine should require callback with the call method" do
+    proc do
+      specify_unregistration do |callback_key, expected_callback|
+        @callback_object.undefine_callback(callback_key, nil)
+      end
+    end.should_raise(RuntimeError, "You may only undefine callbacks that use the call method.")
+  end
+
+  specify "unregister should require callback with the call method" do
+    proc do
+      specify_unregistration do |callback_key, expected_callback|
+        @callback_object.unregister_callback(callback_key, nil)
+      end
+    end.should_raise(RuntimeError, "You may only undefine callbacks that use the call method.")
+  end
+  
   specify "should handle errors" do
     @callback_object.define_callback(:error_callback) do
       raise "First Error"
@@ -42,4 +98,32 @@ context "A Callback" do
   specify "should not fail with nothing to notify" do
     @callback_object.notify_callbacks(:foobar, :argument)
   end
+
+  protected
+  def specify_registration_and_notification
+    callback_key = :create
+    passed_callback_argument = nil
+    expected_callback = proc do |callback_argument|
+      passed_callback_argument = callback_argument
+    end
+
+    returned_callback = yield(callback_key, expected_callback)
+    returned_callback.should_equal expected_callback
+
+    expected_argument = Object.new
+    @callback_object.notify_callbacks(callback_key, expected_argument)
+    passed_callback_argument.should_equal expected_argument
+  end
+
+  def specify_unregistration
+    callback_key = :create
+    callback_called = false
+    callback = @callback_object.define_callback(callback_key) do
+      callback_called = true
+    end
+
+    yield(callback_key, callback)
+    @callback_object.notify_callbacks(callback_key)
+    callback_called.should_equal false
+  end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: callback
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2006-11-03 00:00:00 -08:00
+  version: 0.2.0
+date: 2006-11-04 00:00:00 -08:00
 summary: A simple callback library for ruby objects.
 require_paths: 
 - lib