events 0.9.3 → 0.9.4

data/lib/events.rb

@@ -1,19 +1,6 @@
 module Events # :nodoc:
   UncaughtError = Class.new(StandardError)
   
-  class OnceProxy # :nodoc:
-    attr_reader :event, :caller, :delegate
-    
-    def initialize(event, caller, delegate)
-      @event, @caller, @delegate = event, caller, delegate
-    end
-    
-    def call(*args)
-      caller.remove_listener(event, self)
-      delegate.call(*args)
-    end
-  end
-  
   # The Events::Emitter mixin provides a clone of the Node.js EventEmitter API
   # for Ruby.
   # 
@@ -42,6 +29,24 @@ module Events # :nodoc:
   # they raise an Events::UncaughtError exception.
   # 
   module Emitter
+    DEFAULT_MAX_LISTENERS = 10
+    
+    def max_listeners
+      @max_listeners || DEFAULT_MAX_LISTENERS
+    end
+    private :max_listeners
+    
+    # :call-seq: emitter.max_listeners = integer -> integer
+    #
+    # By default an EventEmitter will print a warning if more than 10 listeners
+    # are added to it. This is a useful default which helps finding memory
+    # leaks. Obviously not all Emitters should be limited to 10. This method
+    # allows that to be increased. Set to zero for unlimited.
+    # 
+    def max_listeners=(value)
+      @max_listeners = value
+    end
+    alias set_max_listeners max_listeners=
     
     # :call-seq: emitter.listeners(event) -> array
     # 
@@ -57,16 +62,18 @@ module Events # :nodoc:
     # Execute each of the listeners in order with the supplied arguments.
     # 
     def emit(event, *args)
-      listeners = listeners(event).dup
+      listeners = @listeners && @listeners.key?(event) && @listeners[event]
       
-      if event == :error && listeners.empty?
+      if event == :error && (!listeners || listeners.empty?)
         raise args.first if args.first.kind_of?(Exception)
         raise Events::UncaughtError.new("Uncaught, unspecified 'error' event.")
+      elsif listeners
+        listeners.dup.each do |listener|
+          listener.call(*args)
+        end.any?
+      else
+        false
       end
-      
-      listeners.each do |listener|
-        listener.call(*args)
-      end.any?
     end
     
     # :call-seq: emitter.on(event) {|args...| block} -> emitter
@@ -81,13 +88,31 @@ module Events # :nodoc:
     # with a #call method).
     # 
     def add_listener(event, proc=nil, &block)
-      emit(:new_listener, event, proc || block)
-      listeners(event).push(proc || block)
+      listener = proc || block
+      unless listener.respond_to?(:call)
+        raise ArgumentError.new("Listener must respond to #call")
+      end
+      emit(:new_listener, event, listener)
+      
+      event_listeners = listeners(event)
+      
+      current = event_listeners.length
+      if max_listeners && max_listeners > 0 && current > max_listeners &&
+        (!event_listeners.respond_to?(:warned?) || !event_listeners.warned?)
+        warn(caller[1] +
+          ": warning: possible EventEmitter memory leak detected. " <<
+          "#{current} listeners added. " <<
+          "Use Emitter#max_listeners = n to increase limit.")
+        def event_listeners.warned?
+          true
+        end
+      end
+      
+      event_listeners.push(listener)
       self
     end
     alias on add_listener
     
-    
     # :call-seq: emitter.once(event) {|args...| block} -> emitter
     # emitter.once(event, proc) -> emitter
     # 
@@ -98,7 +123,11 @@ module Events # :nodoc:
     #   end
     # 
     def once(event, proc=nil, &block)
-      add_listener(event, OnceProxy.new(event, self, proc || block))
+      once = Proc.new do |*args|
+        remove_listener(event, once)
+        (proc || block).call(args)
+      end
+      add_listener(event, once)
     end
     
     # :call-seq: emitter.remove_listener(event, proc) -> emitter
@@ -106,7 +135,10 @@ module Events # :nodoc:
     # Remove a listener from the listener array for the specified event.
     # 
     def remove_listener(event, proc)
-      listeners(event).delete(proc)
+      if @listeners && @listeners.key?(event)
+        @listeners[event].delete(proc)
+        @listeners.delete(event) if @listeners[event].empty?
+      end
       self
     end
     
@@ -115,7 +147,10 @@ module Events # :nodoc:
     # Removes all listeners from the listener array for the specified event.
     # 
     def remove_all_listeners(event)
-      listeners(event).clear
+      if @listeners && @listeners.key?(event)
+        @listeners[event].clear
+        @listeners.delete(event)
+      end
       self
     end
   end

data/readme.rdoc

@@ -49,6 +49,13 @@ first time the event is fired, after which it is removed.
 
 Remove a listener from the listener array for the specified event.
 
+  emitter.max_listeners = n
+
+By default an EventEmitter will print a warning if more than 10 listeners
+are added to it. This is a useful default which helps finding memory
+leaks. Obviously not all Emitters should be limited to 10. This method
+allows that to be increased. Set to zero for unlimited.
+
   emitter.listeners(event)
 
 Returns an array of listeners for the specified event. This array can be

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: events
 version: !ruby/object:Gem::Version 
-  hash: 61
+  hash: 51
   prerelease: false
   segments: 
   - 0
   - 9
-  - 3
-  version: 0.9.3
+  - 4
+  version: 0.9.4
 platform: ruby
 authors: 
 - Matthew Sadler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-30 00:00:00 +00:00
+date: 2011-02-05 00:00:00 +00:00
 default_executable: 
 dependencies: []