volt 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0ae38f2f69535b60b4fe850f9c6a9073da98b75
-  data.tar.gz: a2a08253c6f76f71ac495ec91d13efa4a35f0a98
+  metadata.gz: 11fd8a0c37e1e364ca98038498604a3b897aa391
+  data.tar.gz: 6aafe7c02f864bc4da06dffe7c380675c92b9931
 SHA512:
-  metadata.gz: f39067395499d7b5bd46088b343612d9dc8b79d1fa5b53885777fa9deb5bde1f42215f6ab111264935636e0a7971d8212edd3f235a49df6c2f388aec62a01c44
-  data.tar.gz: a0713dc5334f151bd05bf9b95e879be1b02ae4cd59ae1e9f8bbdbf90e9474f9ff35286f2b998f66d91f1247cc05ddc07c49f3996fbfc9b7ff672bc97619abbf0
+  metadata.gz: 74414b633710710e1d06d2124b7f9101ebee14170eab47e40fa1f7d8733e857f63a19d1d65e08c1c9c8003c2bc317e4437c323f51ccb98d19c953a25cbdd6633
+  data.tar.gz: 477753ecfdf1a92b631544c98622f46a686eb3d850fb16f9ff48f811232d51d396c0001de9f05dde62943d4d47d65d3b06ece931dfa256a266a26a6680a9bd8e

data/VERSION

@@ -1 +1 @@
-0.4.9
+0.4.10

data/app/volt/tasks/channel_tasks.rb

@@ -7,7 +7,7 @@ class ChannelTasks
     @channel = channel
   end
   
-  def add_listener(channel_name)
+  def add_listener(channel_name, scope={})
     # Track every channel that is listening
     @@listeners[channel_name] ||= []
     @@listeners[channel_name] << @channel
@@ -18,7 +18,7 @@ class ChannelTasks
     @@channel_listeners[@channel][channel_name] = true
   end
   
-  def remove_listener(channel_name)
+  def remove_listener(channel_name, scope={})
     if @@listeners[channel_name]
       @@listeners[channel_name].delete(@channel)
       if @@channel_listeners[@channel]

data/lib/volt/console.rb

@@ -7,7 +7,6 @@ class Console
 
     require 'volt/extra_core/extra_core'
     require 'volt/models'
-    require 'volt/models/params'
     require 'volt/server/template_parser'
     require 'volt'
     require 'volt/page/page'

data/lib/volt/controllers/model_controller.rb

@@ -1,6 +1,24 @@
 class ModelController
-  def initialize(model=nil)
-    @model = model
+  def initialize
+    self.model = @@default_model
+  end
+  
+  def self.model(val)
+    @@default_model = val
+  end
+  
+  # Sets the current model on this controller
+  def model=(val)
+    if val.is_a?(Symbol) || val.is_a?(String)
+      collections = [:page, :store, :params]
+      if collections.include?(val.to_sym)
+        @model = self.send(val)
+      else
+        raise "#{val} is not the name of a valid model, choose from: #{collections.join(', ')}"
+      end
+    else
+      @model = model
+    end
   end
   
   def page

data/lib/volt/models.rb

@@ -1,6 +1,8 @@
 require 'volt/extra_core/extra_core'
 require 'volt/reactive/reactive_value'
 require 'volt/models/model'
-require 'volt/models/params'
-require 'volt/models/store'
+require 'volt/models/persistors/store_factory'
+require 'volt/models/persistors/array_store'
+require 'volt/models/persistors/model_store'
+require 'volt/models/persistors/params'
 

data/lib/volt/models/array_model.rb

@@ -3,15 +3,19 @@ require 'volt/models/model_wrapper'
 class ArrayModel < ReactiveArray
   include ModelWrapper
   
-  attr_reader :parent, :path
+  attr_reader :parent, :path, :persistor, :options
 
-  def initialize(array=[], parent=nil, path=nil)
-    @parent = parent
-    @path = path || []
+  def initialize(array=[], options={})
+    @options = options
+    @parent = options[:parent]
+    @path = options[:path] || []
+    @persistor = setup_persistor(options[:persistor])
     
     array = wrap_values(array)
     
     super(array)
+    
+    @persistor.loaded if @persistor
   end
   
   def attributes
@@ -23,6 +27,8 @@ class ArrayModel < ReactiveArray
     args = wrap_values(args)
     
     super(*args)
+    
+    @persistor.added(args[0]) if @persistor
   end
   
   # Make sure it gets wrapped
@@ -36,7 +42,7 @@ class ArrayModel < ReactiveArray
     args = wrap_values(args)
     super(*args)
   end
-  
+
   def new_model(*args)
     Model.new(*args)
   end
@@ -44,4 +50,12 @@ class ArrayModel < ReactiveArray
   def new_array_model(*args)
     ArrayModel.new(*args)
   end
+  
+  private
+    # Takes the persistor if there is one and
+    def setup_persistor(persistor)
+      if persistor
+        @persistor = persistor.new(self)
+      end
+    end
 end

data/lib/volt/models/model.rb

@@ -18,7 +18,7 @@ class Model
   include ObjectTracking
   
   attr_accessor :attributes
-  attr_reader :parent, :path
+  attr_reader :parent, :path, :persistor, :options
   
   def nil?
     attributes.nil?
@@ -32,15 +32,27 @@ class Model
     attributes.true?
   end
   
-  def initialize(attributes={}, parent=nil, path=nil, class_paths=nil)
-    @parent = parent
-    @path = path || []
+  def initialize(attributes={}, options={})
+    @options = options
+    @parent = options[:parent]
+    @path = options[:path] || []
+    @class_paths = options[:class_paths]
+    @persistor = setup_persistor(options[:persistor])
+
     self.attributes = wrap_values(attributes)
+    
+    @persistor.loaded if @persistor
   end
   
   # Pass the comparison through
   def ==(val)
-    attributes == val
+    if val.is_a?(Model)
+      # Use normal comparison for a model
+      return super
+    else
+      # Compare to attributes otherwise
+      return attributes == val
+    end
   end
   
   # Pass through needed
@@ -48,6 +60,17 @@ class Model
     !attributes
   end
   
+  # Pass to the persisotr
+  def event_added(event, scope_provider, first)
+    @persistor.event_added(event, scope_provider, first) if @persistor
+  end
+  
+  # Pass to the persistor
+  def event_removed(event, no_more_events)
+    @persistor.event_removed(event, no_more_events) if @persistor
+  end
+  
+  
   tag_method(:delete) do
     destructive!
   end
@@ -88,6 +111,9 @@ class Model
     
     attributes[attribute_name] = wrap_value(value, [attribute_name])
     trigger_by_attribute!('changed', attribute_name)
+    
+    # Let the persistor know something changed
+    @persistor.changed(attribute_name) if @persistor
   end
   
   # When reading an attribute, we need to handle reading on:
@@ -112,7 +138,11 @@ class Model
 
   # Get a new model, make it easy to override
   def read_new_model(method_name)
-    return new_model(nil, self, path + [method_name])
+    if @persistor && @persistor.respond_to?(:read_new_model)
+      @persistor.read_new_model(method_name)
+    else
+      return new_model(nil, @options.merge(parent: self, path: path + [method_name]))
+    end
   end
   
   def return_undefined_method(method_name)
@@ -168,7 +198,11 @@ class Model
   end
   # Initialize an empty array and append to it
   def <<(value)
-    @parent.expand!
+    if @parent
+      @parent.expand!
+    else
+      raise "Model data should be stored in sub collections."
+    end
 
     # Grab the last section of the path, so we can do the assign on the parent
     path = @path.last
@@ -176,7 +210,7 @@ class Model
     
     if result.nil?
       # If this isn't a model yet, instantiate it
-      @parent.send(:"#{path}=", new_array_model([], @parent, @path))
+      @parent.send(:"#{path}=", new_array_model([], @options))
       result = @parent.send(path)
     end
 
@@ -187,7 +221,7 @@ class Model
   end
   
   def inspect
-    "<#{self.class.to_s} #{attributes.inspect}>"
+    "<#{self.class.to_s}:#{object_id} #{attributes.inspect}>"
   end
   
   
@@ -214,4 +248,12 @@ class Model
         trigger_by_attribute!(event, key, *args)
       end
     end
+    
+    # Takes the persistor if there is one and
+    def setup_persistor(persistor)
+      if persistor
+        @persistor = persistor.new(self)
+      end
+    end
+    
 end

data/lib/volt/models/model_wrapper.rb

@@ -3,9 +3,9 @@ module ModelWrapper
   # model.
   def wrap_value(value, lookup)
     if value.cur.is_a?(Array)
-      value = new_array_model(value, self, path + lookup)
+      value = new_array_model(value, @options.merge(parent: self, path: path + lookup))
     elsif value.cur.is_a?(Hash)
-      value = new_model(value, self, path + lookup)
+      value = new_model(value, @options.merge(parent: self, path: path + lookup))
     end
     
     return value

data/lib/volt/models/persistors/array_store.rb

@@ -0,0 +1,79 @@
+require 'volt/models/persistors/store'
+
+module Persistors
+  class ArrayStore < Store
+    
+    # Called when a collection loads
+    def loaded
+      scope = {}
+    
+    
+    
+      # Scope to the parent
+      if @model.path.size > 1
+        parent = @model.parent
+        
+        parent.persistor.ensure_setup if parent.persistor
+        puts @model.parent.inspect
+        
+        if parent && (attrs = parent.attributes) && attrs[:_id].true?
+          scope[:"#{@model.path[-3].singularize}_id"] = attrs[:_id]
+        end
+      end
+      
+      puts "Load At Scope: #{scope.inspect}"
+      
+      query(scope)
+      
+      change_channel_connection('add', 'added')
+      change_channel_connection('add', 'removed')
+    end
+    
+    def query(query)
+      @tasks.call('StoreTasks', 'find', @model.path.last, query) do |results|
+        # TODO: Globals evil, replace
+        $loading_models = true
+        
+        new_options = @model.options.merge(path: @model.path + [:[]], parent: @model)
+        
+        results.each do |result|
+          @model << Model.new(result, new_options)
+        end
+        $loading_models = false
+      end
+    end
+    
+    def channel_name
+      @model.path[-1]
+    end
+    
+    
+    # When a model is added to this collection, we call its "changed"
+    # method.  This should trigger a save.
+    def added(model)      
+      unless $loading_models
+        model.persistor.changed
+      end
+      
+      if model.persistor
+        # Tell the persistor it was added
+        model.persistor.add_to_collection
+      end
+    end
+    
+    def removed(model)      
+      if model.persistor
+        # Tell the persistor it was removed
+        model.persistor.remove_from_collection
+      end
+      
+      if $loading_models
+        return
+      else
+        puts "delete #{channel_name} - #{model.attributes[:_id]}"
+        @tasks.call('StoreTasks', 'delete', channel_name, model.attributes[:_id])
+      end
+    end
+    
+  end
+end

data/lib/volt/models/persistors/base.rb

@@ -0,0 +1,24 @@
+module Persistors
+  # Implements the base persistor functionality.
+  class Base
+    def loaded
+    end
+    
+    def changed(attribute_name)
+    end
+    
+    def added(model)
+    end
+    
+    # For removed, the default action is to call changed for it
+    def removed(attribute_name)
+      changed(attribute_name)
+    end
+    
+    def event_added(event, scope_provider, first)
+    end
+    
+    def event_removed(event, no_more_events)
+    end
+  end
+end

data/lib/volt/models/persistors/model_store.rb

@@ -0,0 +1,140 @@
+require 'volt/models/persistors/store'
+
+module Persistors
+  class ModelStore < Store
+    ID_CHARS = [('a'..'z'), ('A'..'Z'), ('0'..'9')].map {|v| v.to_a }.flatten
+  
+    @@identity_map = {}
+    
+    attr_reader :model
+    
+    def add_to_collection
+      @in_collection = true
+      ensure_setup
+      changed
+    end
+    
+    def remove_from_collection
+      @in_collection = false
+      stop_listening_for_changes
+    end
+    
+    # Called the first time a value is assigned into this model
+    def ensure_setup
+      if @model.attributes
+        @model.attributes[:_id] ||= generate_id
+
+        if !model_in_identity_map?
+          @@identity_map[@model.attributes[:_id]] ||= self
+        end
+
+        # Check to see if we already have listeners setup
+        if @model.listeners[:changed]
+          listen_for_changes
+        end
+      end
+    end
+    
+    def model_in_identity_map?
+      @@identity_map[@model.attributes[:_id]]
+    end
+    
+    # Create a random unique id that can be used as the mongo id as well
+    def generate_id
+      id = []
+      12.times { id << ID_CHARS.sample }
+    
+      return id.join
+    end
+    
+    # Called when the model changes
+    def changed(attribute_name=nil)
+      # puts "CHANGED: #{attribute_name.inspect} - #{@model.inspect}"
+      ensure_setup
+      
+      path_size = @model.path.size
+      if !(defined?($loading_models) && $loading_models) && @tasks && path_size > 0 && !@model.nil?      
+        if path_size > 3 && (parent = @model.parent) && source = parent.parent
+          @model.attributes[:"#{@model.path[-4].singularize}_id"] = source._id
+        end
+      
+        puts "Save: #{collection} - #{self_attributes.inspect} - #{@model.path.inspect}"
+        @tasks.call('StoreTasks', 'save', collection, self_attributes)
+      end
+    end
+
+    def listen_for_changes
+      unless @change_listening
+        if @in_collection
+          @change_listening = true
+          change_channel_connection("add")
+        end
+      end
+    end
+    
+    def stop_listening_for_changes
+      if @change_listening
+        @change_listening = false
+        change_channel_connection("remove")
+      end
+    end
+
+    def event_added(event, scope_provider, first)
+      if first && event == :changed
+        # Start listening
+        ensure_setup
+        listen_for_changes
+      end
+    end
+  
+    def event_removed(event, no_more_events)
+      if no_more_events && event == :changed
+        # Stop listening
+        stop_listening_for_changes
+      end
+    end
+
+    def channel_name
+       @channel_name ||= "#{@model.path[-2]}##{@model.attributes[:_id]}"
+    end
+    
+    # Finds the model in its parent collection and deletes it.
+    def delete!
+      if @model.path.size == 0
+        raise "Not in a collection"
+      end
+    
+      @model.parent.delete(@model)
+    end
+    
+    # Update the models based on the id/identity map.  Usually these requests
+    # will come from the backend.
+    def self.update(model_id, data)
+      persistor = @@identity_map[model_id]
+    
+      if persistor
+        data.each_pair do |key, value|
+          if key != '_id'
+            persistor.model.send(:"#{key}=", value)
+          end
+        end
+      end
+    end
+    
+    def self.from_id(id)
+      @@identity_map[id]
+    end
+
+    private
+      # Return the attributes that are only for this store, not any sub-associations.
+      def self_attributes
+        # Don't store any sub-stores, those will do their own saving.
+        @model.attributes.reject {|k,v| v.is_a?(Model) || v.is_a?(ArrayModel) }    
+      end
+    
+      def collection
+        @model.path[-2]
+      end
+    
+  end
+end