unobservable 0.0.1 → 0.1.0

data/README.rdoc

@@ -1,16 +1,9 @@
 = unobservable
 
-Description goes here.
+Ruby's Observable mixin is often characterized as an Event Handler library.  In reality, it only provides basic
+support for "Property Changed" notifications.
 
-== Contributing to unobservable
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+Unobservable strives to be a general-purpose Event Handler library.
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/unobservable.rb

@@ -1,9 +1,96 @@
+require 'set'
 
 module Unobservable
-  
+
+  def self.instance_events_for(mod, include_supers = true)
+    raise TypeError, "Only modules and classes can have instance_events" unless mod.is_a? Module
+
+    contributors = [mod]
+    if include_supers
+      contributors += mod.included_modules
+      contributors += mod.ancestors[1...-1] if mod.is_a? Class
+    end
+
+    retval = Set.new
+    
+    contributors.each do |c|
+      if c.instance_variable_defined? :@unobservable_instance_events
+        c.instance_variable_get(:@unobservable_instance_events).each do |e|
+          retval.add(e)
+        end
+      end
+    end
+    
+    return retval.to_a
+  end
+
+  module ModuleSupport
+    def instance_events(include_supers = true)
+      if include_supers == false
+        @unobservable_instance_events ||= Set.new
+        return @unobservable_instance_events.to_a
+      else
+        return Unobservable.instance_events_for(self, true)
+      end
+    end
+
+
+    private
+    def attr_event(*names)
+      @unobservable_instance_events ||= Set.new
+      
+      names.each do |n|
+        @unobservable_instance_events.add(n.to_sym)
+        define_method n do
+          return event(n)
+        end
+      end
+      
+      return @unobservable_instance_events.to_a
+    end
+  end
+
+
+
+
+  module Support
+
+    def self.included(other_mod)
+      other_mod.extend ModuleSupport
+    end
+
+    def events
+      unobservable_events_map.keys
+    end
+    
+    def event(name)
+      unobservable_events_map[name]
+    end
+
+    private
+    def unobservable_events_map
+      @unobservable_events_map ||= initialize_unobservable_events_map(self.class)
+    end
+
+
+    def initialize_unobservable_events_map(clazz)
+      retval = {}
+      if clazz.respond_to? :instance_events
+        clazz.instance_events.each do |e|
+          retval[e] = Event.new
+        end
+      end
+
+      return retval
+    end
+    
+  end
+
+
+
   class Event
     attr_reader :handlers
-    
+
     def initialize
       @handlers = []
     end
@@ -21,10 +108,12 @@ module Unobservable
       elsif args.size == 2
         return args[0].method(args[1])
       end
-      
+
       raise ArgumentError, "Unable to create an event handler using the given arguments"
     end
-    
+
+    # Registers the given event handler so that it will be
+    # invoked when the event is raised.
     def register(*args, &block)
       h = handler_for(*args, &block)
       @handlers << h
@@ -42,8 +131,11 @@ module Unobservable
         return nil
       end
     end
-    
-    
+
+
+    # Pass the specific arguments / block to all of the
+    # event handlers.  Return true if there was at least
+    # 1 event handler; return false otherwise.
     def call(*args, &block)
       if @handlers.empty?
         return false
@@ -52,12 +144,16 @@ module Unobservable
         @handlers.each do |h|
           h.call(*args, &block)
         end
-        
+
         return true
       end
     end
-    
-    
+
+
   end
   
-end
+
+
+end
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unobservable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -107,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4412780719784246563
+      hash: -507085936034972992
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: