welo 0.1.0 → 0.1.1

data/TODO

@@ -1,9 +1,5 @@
 * Embeddings
   - merge the branch
   - use the complex serialization overhead only when needed loaded
-* Observations
-  - boil-down to a better API
-    + improve the DelayedObservation thing
-    + improve the Observer's eventing
 * Proxies
   - a class like observations to manipulate distant

data/lib/welo.rb

@@ -1,6 +1,6 @@
 
 module Welo
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
   AUTHORS = ['crapooze']
   WEBSITE = "http://github.com/crapooze/welo"
   LICENCE = "MIT"

data/lib/welo/core/observation.rb

@@ -22,6 +22,7 @@ module Welo
       raise ArgumentError.new("no such perspective: #{name} for #{resource}") unless persp
       st = self.new(*persp.fields, &blk)
       st.resource = resource
+      st.perspective = name
       st
     end
 
@@ -39,6 +40,10 @@ module Welo
       # of resource it's looking at.
       attr_accessor :resource
 
+      # The perspective of an ObservationStruct is the parts
+      # of resource it's looking at.
+      attr_accessor :perspective
+
       # Instanciates a new struct object (i.e., not a Struct class).  The
       # fields are populated from the key/value pairs from hash.  If the
       # structure fields correspond to a relationship, then a
@@ -62,34 +67,66 @@ module Welo
   # An Observer is an object which is responsible for creating resources
   # observations.
   class Observer
-    attr_reader :registrations, :models
-    def initialize(models=[])
+    Registration = Struct.new(:event_name, :cb)
+
+    # A hash mapping event name to their registrations
+    attr_reader :registrations
+
+    def initialize
       @registrations = {}
-      @models = models
     end
 
-    def event(name, obj)
-      registrations[name].each do |blk|
-        blk.call(obj)
+    # Calls all the callback for the registrations in one event named according 
+    # to the first parameter.
+    # A second parameter can be passed to the callbacks.
+    #
+    # The name :observation should be reserved to the observing duties.
+    # See observe_source for why.
+    def event(name, obj=nil)
+      regs = registrations[name]
+      return unless regs
+      regs.each do |reg|
+        reg.cb.call(obj)
       end
     end
 
+    # Registers a new callback given in the block parameter for the given event.
+    # Returns a Registration instance, you should keep track of this instance if 
+    # you plan to unregister it later.
     def register(event_name,&blk)
       registrations[event_name] ||= []
-      registrations[event_name] << blk 
+      reg = Registration.new(event_name,blk)
+      registrations[event_name] << reg
+      reg
     end
 
-    #TODO: unregister
+    # Removes exactly one registration given the Registration instance.
+    # The parameter should be a value previously returned by register on the 
+    # same object.
+    def unregister(registration)
+      regs = registrations[registration.event_name]
+      raise ArgumentError, "no registratons for #{registration.event_name}" unless regs
+      regs.delete(registration)
+    end
+
+    # Removes all the registrations for a given event name.
+    def unregister_all(event_name)
+      registrations.delete(event_name)
+    end
 
+    # Observe a source by calling it's observe method, and pushing it's
+    # successive yielded values into a new instance of observation_struct.
+    # Then calls the :observation event with the new observation as parameter.
     def observe_source(source, observation_struct)
-      data = source.observe
-      hash = {}
-      observation_struct.members.each do |sym|
-        hash[sym] = data[sym.to_s]
+      source.observe do |data|
+        hash = {}
+        observation_struct.members.each do |sym|
+          hash[sym] = data[sym.to_s]
+        end
+        obs = observation_struct.for_hash(hash)
+        obs._source_ = source
+        event(:observation, obs)
       end
-      obs = observation_struct.for_hash(hash)
-      obs._source_ = source
-      event(:observation, obs)
     end
   end
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: welo
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors: 
 - crapooze
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-18 00:00:00 -04:00
+date: 2011-04-10 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -54,23 +49,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: welo
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A light resource model for Ruby