volt 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a2b3f88f704f2e2438faffed5fc2039fa2ba4c2
-  data.tar.gz: 5030c30dbc621f0ceb393b8fad31abdab9cff17c
+  metadata.gz: 1ee2e73e30b22aed5bdde21f95777558f38b2922
+  data.tar.gz: b0a44bf831aff120f0209c2ea8a4ab49190ea06e
 SHA512:
-  metadata.gz: 7f88181450bad8a2aa0552a0bc52e69f5c0c1c5901e8f2f44edacf80b9f98dd92ca87345f90b51615955451af41d8089010f2e7e5ee5d99ccc9ed8789efd2cb8
-  data.tar.gz: e4b3a917332a57e3d524129c817787246b76ba78333b305c942c2fccf393d49981b6e4a0c28e48aaf60f4e91212dc5a869341e031cb1c28fb9b44cc4e2453609
+  metadata.gz: 0340cad62884b63d9c757754582696aaaf5c66fe06b8263591782944b9af667ed60d33a3acc2a185140d4d0600415fe64237af54f6b1ef0f91aed20062a159b1
+  data.tar.gz: 379371a5cf9dca4819d648acd08760b9b685d3b5ac73c865397245e2f3dddf1b41954c62896c8f0ec49898af3b1853561939792571dbded97d5aa98e734af485

data/Readme.md

@@ -68,25 +68,27 @@ You can access the volt console with:
 2. [Rendering](#rendering)
   1. [Reactive Values](#reactive-values)
     1. [ReactiveValue Gotchyas](#reactivevalue-gotchyas)
-  2. [Bindings](#bindings)
+3. [Views](#views)
+  1. [Bindings](#bindings)
     1. [Content Binding](#content-binding)
     2. [If Binding](#if-binding)
     3. [Each Binding](#each-binding)
     4. [Attribute Bindings](#attribute-bindings)
-3. [Models](#models)
+    5. [Escaping](#escaping)
+4. [Models](#models)
   1. [Provided Collections](#provided-collections)
   2. [Reactive Models](#reactive-models)
   3. [Model Events](#model-events)
   4. [Automatic Model Conversion](#automatic-model-conversion)
-4. [Controllers](#controllers)
-5. [Components](#components)
+5. [Controllers](#controllers)
+6. [Components](#components)
   1. [Assets](#assets)
   2. [Component Generator](#component-generator)
   3. [Provided Components](#provided-components)
     1. [Notices](#notices)
     2. [Flash](#flash)
-6. [Controls](#controls)
-7. [Routes](#routes)
+7. [Controls](#controls)
+8. [Routes](#routes)
   1. [Routes file](#routes-file)
 
 
@@ -238,9 +240,21 @@ You can call .with on any ReactiveValue.  .with will return a new ReactiveValue
     # => 15
 ```
 
+# Views
+
+Views in Volt are use a templating language similar to handlebars.  They can be broken up into sections, a section header looks like the following:
+
+```html
+<:Body>
+```
+
+Section headers should start with a capital letter so as not to be confused with [controls](#controls).  Section headers do not use close tags.  If section headers are not provided, the body section is assumed.
+
+Section's help you split up different parts of the same content (title and body usually), but within the same file.
+
 ## Bindings
 
-Now that you understand the basics of ReactiveValue's, we can discuss bindings.  In Volt, you code your views in a handlebar's like template language.  Volt provides severial bindings, which handle rendering of something for you.  Content bindings are anything inbetween { and }
+One you understand the basics of ReactiveValue's, we can discuss bindings.  In Volt, you code your views in a handlebar's like template language.  Volt provides severial bindings, which handle rendering of something for you.  Content bindings are anything inbetween { and }
 
 ### Content binding
 
@@ -318,6 +332,14 @@ If the value of a checked attribute is true, the checkbox will be shown checked.
 
 If you have a controller at app/home/controller/index_controller.rb, and a view at app/home/views/index/index.html, all methods called are called on the controller.
 
+## Escaping
+
+When you need to use { and } outside of bindings.  Anything in a triple mustache will be escaped and not processed as a binding:
+
+```html
+{{{ bindings look like: {this}  }}}
+```
+
 # Models
 
 Volt's concept of a model is slightly different from many frameworks where a model is the name for the ORM to the database.  In Volt a model is a class where you can store data easily.  Where that data stored is not the concern of the model, but the class that created the model.  Lets first see how to use a model.

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.7.1

data/lib/volt/cli/asset_compile.rb

@@ -1,11 +1,51 @@
 class CLI
-  
+
   desc "precompile", "precompile all application assets"
   def precompile
+    require 'fileutils'
+    require 'opal'
     require 'volt'
     require 'volt/server/rack/component_paths'
-    
-    puts ComponentPaths.new(Volt.root).components.inspect
+    require 'volt/server/rack/component_code'
+    require 'volt/server/rack/opal_files'
+
+
+    write_component_js
+    write_sprockets
   end
-  
+
+  private
+    def write_sprockets
+      root_path ||= Dir.pwd
+      Volt.root = root_path
+
+      @app_path = File.expand_path(File.join(root_path, "app"))
+
+      @component_paths = ComponentPaths.new(root_path)
+      @app = Rack::Builder.new
+
+      # Serve the opal files
+      opal_files = OpalFiles.new(@app, @app_path, @component_paths)
+      opal_files.environment.each_file do |file_path|
+        unless file_path.to_s[/[.]rb$/]
+          puts "FILE: #{file_path}"
+        end
+      end
+    end
+
+    def write_component_js
+      component_paths = ComponentPaths.new(Volt.root)
+
+      code = ComponentCode.new('home', component_paths).code
+
+      javascript_code = Opal.compile(code)
+
+      components_folder = File.join(Volt.root, '/public/components')
+      puts "CF: #{components_folder}"
+      FileUtils.mkdir_p(components_folder)
+      File.open(File.join(components_folder, '/home.js'), 'w') do |file|
+        file.write(javascript_code)
+      end
+    end
+
 end

data/lib/volt/models.rb

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

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

@@ -0,0 +1,65 @@
+require 'volt/models/persistors/base'
+require 'volt/utils/local_storage'
+require 'json'
+
+module Persistors
+
+  # Backs a collection in the local store
+  class LocalStore < Base
+    def initialize(model)
+      @model = model
+    end
+
+    # Find the root for this model
+    def root_model
+      node = @model
+
+      loop do
+        parent = node.parent
+        if parent
+          node = parent
+        else
+          break
+        end
+      end
+
+      return node
+    end
+
+    # Called when a model is added to the collection
+    def added(model, index)
+      root_model.persistor.save_all
+    end
+
+    def loaded
+      # When the main model is first loaded, we pull in the data from the
+      # store if it exists
+      if @model.path == []
+        json_data = LocalStorage['volt-store']
+        if json_data
+          root_attributes = JSON.parse(json_data)
+
+          @loading_data = true
+          root_attributes.each_pair do |key, value|
+            @model.send(:"#{key}=", value)
+          end
+          @loading_data = nil
+        end
+      end
+    end
+
+    # Callled when an item is changed (or removed)
+    def changed(attribute_name)
+      root_model.persistor.save_all
+    end
+
+    # Called on the root
+    def save_all
+      return if @loading_data
+
+      json_data = JSON.dump(@model.to_h.deep_cur)
+
+      LocalStorage['volt-store'] = json_data
+    end
+  end
+end

data/lib/volt/page/page.rb

@@ -32,7 +32,7 @@ require 'volt/page/draw_cycle'
 require 'volt/page/tasks'
 
 class Page
-  attr_reader :url, :params, :page, :store, :flash, :templates, :routes, :draw_cycle, :events
+  attr_reader :url, :params, :page, :templates, :routes, :draw_cycle, :events
 
   def initialize
     # debugger
@@ -41,8 +41,6 @@ class Page
 
     # Run the code to setup the page
     @page = 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)
     @params = @url.params
@@ -67,6 +65,18 @@ class Page
     end
   end
 
+  def flash
+    @flash ||= ReactiveValue.new(Model.new({}, persistor: Persistors::Flash))
+  end
+
+  def store
+    @store ||= ReactiveValue.new(Model.new({}, persistor: Persistors::StoreFactory.new(tasks)))
+  end
+
+  def local_store
+    @local_store ||= ReactiveValue.new(Model.new({}, persistor: Persistors::LocalStore))
+  end
+
   def tasks
     @tasks ||= Tasks.new(self)
   end

data/lib/volt/server/component_handler.rb

@@ -1,8 +1,6 @@
 require 'stringio'
 require 'volt'
-require 'volt/server/html_parser/view_parser'
-require 'volt/server/component_templates'
-require 'volt/server/rack/asset_files'
+require 'volt/server/rack/component_code'
 
 class ComponentHandler
   def initialize(component_paths)
@@ -15,13 +13,7 @@ class ComponentHandler
     # TODO: Sanatize template path
     component_name = req.path.strip.gsub(/^\/components\//, '').gsub(/[.]js$/, '')
 
-    code = ''
-
-    asset_files = AssetFiles.new(component_name, @component_paths)
-    asset_files.component_paths.each do |component_path, component_name|
-      code << ComponentTemplates.new(component_path, component_name).code
-      code << "\n\n"
-    end
+    code = ComponentCode.new(component_name, @component_paths).code
 
     javascript_code = Opal.compile(code)
 

data/lib/volt/server/component_templates.rb

@@ -1,13 +1,30 @@
+require 'volt/server/html_parser/view_parser'
+
 # Initialize with the path to a component and returns all the front-end
 # setup code (for controllers, models, views, and routes)
 class ComponentTemplates
-  def initialize(component_path, component_name)
+  def initialize(component_path, component_name, client=true)
     @component_path = component_path
     @component_name = component_name
+    @client = true
   end
 
   def code
-    return generate_controller_code + generate_view_code + generate_model_code + generate_routes_code
+    code = generate_view_code
+    if @client
+      # On the backend, we just need the views
+      code << generate_controller_code + generate_model_code + generate_routes_code
+    end
+
+    return code
+  end
+
+  def page_reference
+    if @client
+      '$page'
+    else
+      'page'
+    end
   end
 
   def generate_view_code
@@ -20,7 +37,6 @@ class ComponentTemplates
       template_path = view_path[views_path.size..((-1 * ('.html'.size + 1)))]
       template_path = "#{@component_name}/#{template_path}"
 
-      # all_templates = TemplateParser.new(File.read(view_path), template_path)
       all_templates = ViewParser.new(File.read(view_path), template_path)
 
       binding_initializers = []
@@ -35,11 +51,9 @@ class ComponentTemplates
 
         binding_code = "{#{binding_code.join(', ')}}"
 
-        code << "$page.add_template(#{name.inspect}, #{template['html'].inspect}, #{binding_code})\n"
+        code << "#{page_reference}.add_template(#{name.inspect}, #{template['html'].inspect}, #{binding_code})\n"
       end
     end
-    # puts "--------------"
-    # puts "CODE: #{code}"
 
     return code
   end
@@ -64,7 +78,7 @@ class ComponentTemplates
 
       model_name = model_path.match(/([^\/]+)[.]rb$/)[1]
 
-      code << "$page.add_model(#{model_name.inspect})\n\n"
+      code << "#{page_reference}.add_model(#{model_name.inspect})\n\n"
     end
 
     return code
@@ -75,7 +89,7 @@ class ComponentTemplates
     routes_path = "#{@component_path}/config/routes.rb"
 
     if File.exists?(routes_path)
-      code << "$page.add_routes do\n"
+      code << "#{page_reference}.add_routes do\n"
       code << "\n" + File.read(routes_path) + "\n"
       code << "end\n\n"
     end

data/lib/volt/server/rack/asset_files.rb

@@ -1,4 +1,5 @@
-# Used to get a list of the assets from the dependencies files.
+# Used to get a list of the assets and other included components
+# from the dependencies.rb files.
 class AssetFiles
   def initialize(component_name, component_paths)
     @component_paths = component_paths

data/lib/volt/server/rack/component_code.rb

@@ -0,0 +1,25 @@
+require 'volt/server/html_parser/view_parser'
+require 'volt/server/component_templates'
+require 'volt/server/rack/asset_files'
+
+# Takes in the name and all component paths and has a .code
+# method that returns all of the ruby setup code for the component.
+class ComponentCode
+  def initialize(component_name, component_paths, client=true)
+    @component_name = component_name
+    @component_paths = component_paths
+    @client = client
+  end
+
+  def code
+    code = ''
+
+    asset_files = AssetFiles.new(@component_name, @component_paths)
+    asset_files.component_paths.each do |component_path, component_name|
+      code << ComponentTemplates.new(component_path, component_name, @client).code
+      code << "\n\n"
+    end
+
+    return code
+  end
+end

data/lib/volt/server/rack/component_html_renderer.rb

@@ -0,0 +1,21 @@
+require 'volt/page/page'
+
+# A rack app that renders the html for a component on the backend.
+class ComponentHtmlRenderer
+  def initialize
+
+  end
+
+  def call(env)
+    req = Rack::Request.new(env)
+    path = req.path
+
+    # For now just assume home
+    component_name = 'home'
+
+    page = Page.new
+
+    component_paths = ComponentPaths.new(Volt.root)
+    code = ComponentCode.new(component_name, component_paths).code
+  end
+end

data/lib/volt/utils/local_storage.rb

@@ -0,0 +1,49 @@
+if RUBY_PLATFORM == 'opal'
+  module LocalStorage
+    def self.[](key)
+      %x{
+        var val = localStorage.getItem(key);
+        return val === null ? nil : val;
+      }
+    end
+
+    def self.[]=(key, value)
+      `localStorage.setItem(key, value)`
+    end
+
+    def self.clear
+      `localStorage.clear()`
+      self
+    end
+
+    def self.delete(key)
+      %x{
+        var val = localStorage.getItem(key);
+        localStorage.removeItem(key);
+        return val === null ? nil : val;
+      }
+    end
+  end
+else
+  module LocalStorage
+    @@store = {}
+    def self.[](key)
+      @@store[key]
+    end
+
+    def self.[]=(key, value)
+      @@store[key] = value
+    end
+
+    def self.clear
+      @@store = {}
+
+      self
+    end
+
+    def self.delete(key)
+      @@store.delete(key)
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: volt
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Ryan Stout
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -450,6 +450,7 @@ files:
 - lib/volt/models/persistors/array_store.rb
 - lib/volt/models/persistors/base.rb
 - lib/volt/models/persistors/flash.rb
+- lib/volt/models/persistors/local_store.rb
 - lib/volt/models/persistors/model_identity_map.rb
 - lib/volt/models/persistors/model_store.rb
 - lib/volt/models/persistors/params.rb
@@ -510,6 +511,8 @@ files:
 - lib/volt/server/html_parser/view_parser.rb
 - lib/volt/server/html_parser/view_scope.rb
 - lib/volt/server/rack/asset_files.rb
+- lib/volt/server/rack/component_code.rb
+- lib/volt/server/rack/component_html_renderer.rb
 - lib/volt/server/rack/component_paths.rb
 - lib/volt/server/rack/index_files.rb
 - lib/volt/server/rack/opal_files.rb
@@ -521,6 +524,7 @@ files:
 - lib/volt/utils/ejson.rb
 - lib/volt/utils/generic_counting_pool.rb
 - lib/volt/utils/generic_pool.rb
+- lib/volt/utils/local_storage.rb
 - lib/volt/volt/environment.rb
 - spec/apps/file_loading/app/bootstrap/assets/js/bootstrap.js
 - spec/apps/file_loading/app/main/assets/js/test1.js