unobservable 0.4.0 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/unobservable.rb

@@ -6,19 +6,28 @@ module Unobservable
   # not that module includes the Unobservable::ModuleSupport mixin.  If
   # include_supers = true, then the list will also contain instance events
   # defined by superclasses and included modules.  By default, include_supers = true
-  def self.instance_events_for(mod, include_supers = true)
+  def self.instance_events_for(mod, all = true)
     raise TypeError, "Only modules and classes can have instance_events" unless mod.is_a? Module
 
     contributors = [mod]
-    if include_supers
+    if all
       contributors += mod.included_modules
-      contributors += mod.ancestors[1...-1] if mod.is_a? Class
+      if mod.is_a? Class
+        ancestors = mod.ancestors
+        if ancestors[0] == mod
+          contributors += ancestors[1..-1]
+        else
+          contributors += ancestors
+        end
+      end
     end
 
     self.collect_instance_events_defined_by(contributors)
   end
 
 
+  # Produces a list of instance events that are explicitly defined by at least
+  # one of the specified modules.
   def self.collect_instance_events_defined_by(contributors)
     retval = Set.new
     
@@ -68,15 +77,23 @@ module Unobservable
 
   module Support
 
+    # When an individual object EXTENDS the Support module, then
+    # we must ensure that the object's singleton class EXTENDS
+    # ModuleSupport.
     def self.extended(obj)
       obj.singleton_class.extend ModuleSupport
     end
     
+    # When a class/module INCLUDES the Support module, then we
+    # must ensure that the class/module also EXTENDS ModuleSupport.
     def self.included(other_mod)
       other_mod.extend ModuleSupport
     end
     
 
+    # Obtains the list of events that are unique to this object.
+    # If all = true, then this list will also include events that
+    # were defined within a module that the object extended.
     def singleton_events(all = true)
       if all
         contributors  = self.singleton_class.included_modules
@@ -88,15 +105,21 @@ module Unobservable
       end
     end
 
-    
+    # Defines an event directly on the object.
     def define_singleton_event(*name)
       self.singleton_class.send(:attr_event, *name)
     end
 
+    # Obtains the names of the events that are supported by this object.  If
+    # all = false, then this list will only contain the names of the instance
+    # events that are explicitly defined by the object's class.
     def events(all = true)
       self.singleton_class.instance_events(all)
     end
     
+    
+    # Returns the Event that has the specified name.  A NameError will be raised
+    # if the object does not define any event that has the given name.
     def event(name)
       @unobservable_events_map ||= {}
       e = @unobservable_events_map[name]
@@ -112,6 +135,9 @@ module Unobservable
     end
 
     private
+    
+    # Calls the Event that has the specified name.  A NameError will be raised
+    # if the object does not define any event that has the given name.
     def raise_event(name, *args, &block)
       event(name).call(*args, &block)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unobservable
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-21 00:00:00.000000000 Z
+date: 2012-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2089249244928206460
+      hash: 4239055306913314612
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: