event_bus 0.0.1 → 0.0.2

data/lib/event_bus.rb

@@ -1,48 +1,81 @@
 require 'singleton'
 
 class EventBus
-  include Singleton
 
+  #
+  # Announce an event to any waiting listeners.
+  #
+  # @param event_name [String, Symbol] the name of your event
+  # @param details [Hash] the information you want to pass to the listeners
+  # @return the EventBus, ready to be called again.
+  #
   def self.announce(event_name, details)
-    instance.announce(event_name, details)
+    Registrations.instance.announce(event_name, details)
+    self
   end
 
-  def self.clear
-    instance.clear
+  #
+  # Register a single listener.
+  #
+  # @param pattern [String, Regex] listen for any events whose name matches this pattern
+  # @param listener the object to be notified when a matching event occurs
+  # @param method_name [Symbol] the method to be called on listener when a matching event occurs
+  # @return the EventBus, ready to be called again.
+  #
+  def self.listen_for(pattern, listener, method_name)
+    Registrations.instance.register(pattern, listener, method_name)
+    self
   end
 
-  def self.listen_for(pattern, listener, method_name)
-    instance.register(pattern, listener, method_name)
+  #
+  # Delete all current listener registrations
+  #
+  # @return the EventBus, ready to be called again.
+  #
+  def self.clear
+    Registrations.instance.clear
+    self
   end
 
+  #
+  # (experimental)
+  #
   def self.register(listener)
     listener.events_map.each do |pattern, method_name|
-      instance.register(pattern, listener, method_name)
+      Registrations.instance.register(pattern, listener, method_name)
     end
+    self
   end
 
-  Registration = Struct.new(:pattern, :listener, :method_name) do
-    def respond(event_name, details)
-      listener.send(method_name, details) if pattern === event_name
+  private
+
+  class Registrations
+    include Singleton
+
+    Registration = Struct.new(:pattern, :listener, :method_name) do
+      def respond(event_name, details)
+        listener.send(method_name, details) if pattern === event_name
+      end
     end
-  end
 
-  def initialize
-    clear
-  end
+    def initialize
+      clear
+    end
 
-  def announce(event_name, details)
-    @listeners.each do |listener|
-      listener.respond(event_name, details)
+    def announce(event_name, details)
+      @listeners.each do |listener|
+        listener.respond(event_name, details)
+      end
     end
-  end
 
-  def clear
-    @listeners = []
-  end
+    def clear
+      @listeners = []
+    end
+
+    def register(pattern, listener, method_name)
+      @listeners << Registration.new(pattern, listener, method_name)
+    end
 
-  def register(pattern, listener, method_name)
-    @listeners << Registration.new(pattern, listener, method_name)
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_bus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
+date: 2013-01-21 00:00:00.000000000 Z
 dependencies: []
 description: A simple pubsub event bus
 email: kevin@rutherford-software.com
@@ -18,7 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/event_bus.rb
-homepage: http://rubygems.org/gems/event_bus
+homepage: http://github.com/kevinrutherford/event_bus
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -43,3 +43,4 @@ signing_key:
 specification_version: 3
 summary: A simple pubsub event bus
 test_files: []
+has_rdoc: