welo 0.0.7 → 0.1.0

data/TODO

@@ -2,6 +2,8 @@
   - merge the branch
   - use the complex serialization overhead only when needed loaded
 * Observations
-  - make them more useful
+  - boil-down to a better API
+    + improve the DelayedObservation thing
+    + improve the Observer's eventing
 * Proxies
-  - a class like observations
+  - a class like observations to manipulate distant

data/lib/welo/core/observation.rb

@@ -1,35 +1,95 @@
 
 module Welo
+  # DelayedObservation is a class representing a subsequent observation.
+  DelayedObservation = Struct.new(:observation, :relationship, :path)
+
+  # An ObservationStruct is a special Struct (i.e. a class whose 
+  # instances are structures).
   ObservationStruct = Class.new(Struct) do
+    # The source for an observation instance is the object from which it could
+    # be observed. Many applications may not matter, but some do.
+    attr_accessor :_source_
+    alias :source :_source_
+
+    # Creates a new structure, class which fields correspond to the perspective
+    # named name in resource.  If a block is passed, then it is evaluated in
+    # the context of the new structure (like Struct.new { ... }).
+    #
+    # Normally, this method would be inherited by the structure, but we do not want to.
+    # Thus we undef it in self.inherited (see self.inherited).
+    def self.new_for_resource_in_perspective(resource, name, &blk)
+      persp = resource.perspective(name)
+      raise ArgumentError.new("no such perspective: #{name} for #{resource}") unless persp
+      st = self.new(*persp.fields, &blk)
+      st.resource = resource
+      st
+    end
+
+    # Hook to remove the new_for_resource_in_perspective methods, which is
+    # designed only for ObservationStruct but is inherited by the Struct
+    # classes if nothing is done.
+    def self.inherited(klass)
+      klass.instance_eval do 
+        undef :new_for_resource_in_perspective
+      end
+    end
+
     class << self
-      attr_accessor :maker, :perspective
+      # The resource of an ObservationStruct is the type 
+      # of resource it's looking at.
+      attr_accessor :resource
+
+      # 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
+      # DelayedObservation object is created. It will then be the
+      # responsibility of the developper to continue observing the delayed
+      # observation or not.
       def for_hash(hash)
         vals = members.map do |k|
-          hash[k]
+          rel = resource.relationship(k)
+          if rel
+            DelayedObservation.new(self, rel, hash[k])
+          else
+            hash[k]
+          end
         end
         self.new(*vals)
       end
     end
   end
 
-  class ObservationMaker
-    attr_accessor :resource, :structures
-    def initialize(res=nil)
-      @resource = res
-      @structures = {}
+  # An Observer is an object which is responsible for creating resources
+  # observations.
+  class Observer
+    attr_reader :registrations, :models
+    def initialize(models=[])
+      @registrations = {}
+      @models = models
     end
 
-    def structure(name=:default, &blk)
-      @structures[name] ||= create_structure!(name, &blk)
+    def event(name, obj)
+      registrations[name].each do |blk|
+        blk.call(obj)
+      end
     end
 
-    def create_structure!(name, &blk)
-      persp = resource.perspective(name)
-      raise ArgumentError.new("no such perspective: #{name} for #{resource}") unless persp
-      st = ObservationStruct.new(*persp.fields, &blk)
-      st.maker = self
-      st.perspective = name
-      st
+    def register(event_name,&blk)
+      registrations[event_name] ||= []
+      registrations[event_name] << blk 
+    end
+
+    #TODO: unregister
+
+    def observe_source(source, observation_struct)
+      data = source.observe
+      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
   end
 end

data/lib/welo.rb

@@ -1,9 +1,9 @@
 
 module Welo
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
   AUTHORS = ['crapooze']
   WEBSITE = "http://github.com/crapooze/welo"
   LICENCE = "MIT"
-  autoload :Resource, 'welo/base/resource'
-  autoload :ObservationMaker, 'welo/core/observation'
+  require 'welo/base/resource'
+  require 'welo/core/observation'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: welo
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 7
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors: 
 - crapooze
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-03 00:00:00 +01:00
+date: 2011-03-18 00:00:00 -04:00
 default_executable: 
 dependencies: []