volt 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af78d5a1516b7a9eff62b7c5a78ce4cf79ff12aa
-  data.tar.gz: 79f9315c28e7f8805145b0cabbbcf340d6a7d14c
+  metadata.gz: 2390fa6b2d27296a6a761e1bbf575bd07cebc42d
+  data.tar.gz: a9520a04804d30eca3619a436918e81987eb7b41
 SHA512:
-  metadata.gz: 3783e9990493225b42f8806aa7987b423a6a65fc04d81e07171fdd4df0c9cf137c91b62ed2ad83088e5494bd7e3db65f8ac717efebe6edca067b19070221f9a3
-  data.tar.gz: 3ac4b68cb199e7c532967037add881ef766774032763bd8889d19d67f181419800392ef1aeca094f7d2c07a75c82634b38faf70e07d9d097f1a5e5e650f0809c
+  metadata.gz: 66c6eea2b57285e84f61480db89912df81dbcc82f204e36df68e1bd512a0d716249ee89bda9fab91900909d76e6d48daa4e218c47c77b93b43b3b987b47d6a6a
+  data.tar.gz: c59669709786b49c15976d09f9895d1d8952c08bfd6d7b3604fd6f364493ecea0ea5aa0bcf7ee270470c6424584785c122f050d2dd7e373f3c733b6a6396dfc1

data/Readme.md

@@ -69,14 +69,19 @@ You can access the volt console with:
     3. [Each Binding](#each-binding)
     4. [Attribute Bindings](#attribute-bindings)
 2. [Models](#models)
-  1. [Reactive Models](#reactive-models)
-  2. [Model Events](#model-events)
-  3. [Provided Collections](#provided-collections)
-3. [Components](#components)
+  1. [Provided Collections](#provided-collections)
+  2. [Reactive Models](#reactive-models)
+  3. [Model Events](#model-events)
+  4. [Automatic Model Conversion](#automatic-model-conversion)
+3. [Controllers](#controllers)
+4. [Components](#components)
   1. [Assets](#assets)
   2. [Component Generator](#component-generator)
-4. [Controls](#controls)
-5. [Routes](#routes)
+  3. [Provided Components](#provided-components)
+    1. [Notices](#notices)
+    2. [Flash](#flash)
+5. [Controls](#controls)
+6. [Routes](#routes)
   1. [Routes file](#routes-file)
 
 
@@ -525,6 +530,30 @@ Once the gem is ready, you can release it to ruby gems with:
 
 Remove the path: option in the gemfile if you wish to use the rubygems version.
 
+## Provided Components
+
+Volt provides a few components to make web developers lives easier.
+
+### Notices
+
+Volt automatically places ```<:volt:notices />``` into views.  This shows notices for the following:
+
+1. flash messages
+2. connection status (when a disconnect happens, lets the user know why and when a reconnect will be attempted)
+3. page reloading notices (in development)
+
+### Flash
+
+As part of the notices component explained above, you can append messages to any collection on the flash model.
+
+Each collection represents a different type of "flash".  Common examples are ```_notices, _warnings, and _errors```  Using different collections allows you to change how you want the flash displayed.  For example, you might want ```_notices``` and ```_errors``` to show with different colors. 
+
+```ruby
+    flash._notices << "message to flash"
+```
+
+These messages will show for 5 seconds, then disappear (both from the screen and the collection). 
+
 # Controls
 
 Everyone wishes that we could predict the scope and required features for each part of our application, but in the real world, things we don't expect to grow large often do and things we think will be large don't end up that way.  Controls let you quickly setup reusable code/views.  The location of the control's code can be moved as it grows without changing the way controls are invoked.
@@ -639,7 +668,3 @@ Controllers provide a .channel method, that you can use to get the status of the
 | retry_count | the number of reconnection attempts that have been made without a successful connection |
 | reconnect_interval | the time until the next reconnection attempt (in seconds) |
 
-
-## Notices
-
-Volt ships with a component that provies notices for things like dropped backend connections, flash messages, etc...  

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.5.4

data/app/volt/controllers/notices_controller.rb

@@ -0,0 +1,4 @@
+class Volt
+  class NoticesController < ModelController
+  end
+end

data/app/volt/views/notices/index.html

@@ -2,7 +2,7 @@
 {#if page._reloading}
   <div class="notices alert alert-info">Reloading...</div>
 {/}
-{#if !channel.connected?}
+{#if channel.status == :reconnecting}
   <div class="notices alert alert-info">
     Connection Lost... {channel.error}...
     {#if channel.reconnect_interval}  Reconnecting in {(channel.reconnect_interval / 1000.0).round} sec{/}
@@ -10,7 +10,9 @@
 {/}
 {#if !flash.empty?}
   <div class="notices alert alert-info">
-    <p>{flash._notice}</p>
+    {#each flash._notices as notice}
+      <p>{notice}</p>
+    {/}
   </div>
 {/}
 </:body>

data/lib/volt/models.rb

@@ -5,4 +5,5 @@ require 'volt/models/persistors/store_factory'
 require 'volt/models/persistors/array_store'
 require 'volt/models/persistors/model_store'
 require 'volt/models/persistors/params'
+require 'volt/models/persistors/flash'
 

data/lib/volt/models/array_model.rb

@@ -30,7 +30,7 @@ class ArrayModel < ReactiveArray
     
     super(*args)
     
-    @persistor.added(args[0]) if @persistor
+    @persistor.added(args[0], @array.size-1) if @persistor
   end
   
   # Make sure it gets wrapped

data/lib/volt/models/model.rb

@@ -239,7 +239,7 @@ class Model
   end
   
   def inspect
-    "<#{self.class.to_s}:#{object_id} #{attributes.inspect}>"
+    "<#{self.class.to_s} #{attributes.inspect}>"
   end
   
   def [](val)

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

@@ -7,7 +7,7 @@ module Persistors
     def changed(attribute_name)
     end
     
-    def added(model)
+    def added(model, index)
     end
     
     # For removed, the default action is to call changed for it

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

@@ -0,0 +1,32 @@
+require 'volt/models/persistors/base'
+
+module Persistors
+  class Flash < Base
+    def initialize(model)
+      @model = model
+    end
+    
+    def added(model, index)
+      if Volt.client?        
+        # Setup a new timer for clearing the flash.
+        %x{
+          setTimeout(function() {
+            self.$clear_model(model);
+          }, 5000);
+        }
+      end
+    end
+    
+    def clear_model(model)
+      @model.delete(model)
+      
+      # Clear out the parent collection (usually the main flash)
+      # Makes it so flash.empty? reflects if there is any outstanding
+      # flashes.
+      if @model.size == 0
+        collection_name = @model.path[-1]
+        @model.parent.delete(collection_name)
+      end
+    end
+  end
+end

data/lib/volt/page/page.rb

@@ -42,7 +42,7 @@ class Page
     
     # Run the code to setup the page
     @page = ReactiveValue.new(Model.new)
-    @flash = ReactiveValue.new(Model.new)
+    @flash = ReactiveValue.new(Model.new({}, persistor: Persistors::Flash))
     @store = ReactiveValue.new(Model.new({}, persistor: Persistors::StoreFactory.new(tasks)))
     
     @url = ReactiveValue.new(URL.new)
@@ -134,6 +134,8 @@ class Page
     # Setup to render template
     Element.find('body').html = "<!-- $CONTENT --><!-- $/CONTENT -->"
 
+    load_stored_page
+
     # Do the initial url params parse
     @url_tracker.url_updated(true)
 
@@ -150,6 +152,25 @@ class Page
     end
     TemplateRenderer.new(title_target, main_controller, "main", "home/index/index/title")
   end
+  
+  # When the page is reloaded from the backend, we store the $page.page, so we
+  # can reload the page in the exact same state.  Speeds up development.
+  def load_stored_page
+    if Volt.client?
+      if `sessionStorage`
+        page_obj_str = nil
+        
+        `page_obj_str = sessionStorage.getItem('___page');`
+        `if (page_obj_str) {`
+          `sessionStorage.removeItem('___page');`
+
+          JSON.parse(page_obj_str).each_pair do |key, value|
+            self.page.send(:"#{key}=", value)
+          end
+        `}`
+      end
+    end
+  end
 end
 
 if Volt.client?

data/lib/volt/page/tasks.rb

@@ -93,6 +93,15 @@ class Tasks
   
   def reload
     puts "RELOAD"
+    # Stash the current page value
+    value = JSON.dump($page.page.cur.to_h)
+    
+    # If this browser supports session storage, store the page, so it will
+    # be in the same state when we reload.
+    if `sessionStorage`
+      `sessionStorage.setItem('___page', value);`
+    end
+    
     $page.page._reloading = true
     `window.location.reload(false);`
   end

data/spec/models/persistors/store_spec.rb

@@ -22,7 +22,7 @@ describe Persistors::Store do
     
     @model = ArrayModel.new([1,2,3], persistor: persistor)
     
-    expect(persistor_instance).to receive(:added).with(4)
+    expect(persistor_instance).to receive(:added).with(4,3)
     
     @model << 4
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: volt
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Ryan Stout
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-31 00:00:00.000000000 Z
+date: 2014-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -326,6 +326,7 @@ files:
 - app/volt/assets/js/jquery-2.0.3.js
 - app/volt/assets/js/sockjs-0.2.1.min.js
 - app/volt/config/dependencies.rb
+- app/volt/controllers/notices_controller.rb
 - app/volt/tasks/channel_tasks.rb
 - app/volt/tasks/store_tasks.rb
 - app/volt/views/notices/index.html
@@ -357,6 +358,7 @@ files:
 - lib/volt/models/model_wrapper.rb
 - lib/volt/models/persistors/array_store.rb
 - lib/volt/models/persistors/base.rb
+- lib/volt/models/persistors/flash.rb
 - lib/volt/models/persistors/model_store.rb
 - lib/volt/models/persistors/params.rb
 - lib/volt/models/persistors/store.rb