volt 0.4.5 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 305dc41dfe5a91e98dafe5bf8c8fba5ffa852a75
-  data.tar.gz: ba78dc36acf5a28d045370705ec0f3951da6c63c
+  metadata.gz: 6dc382e28cc1e24d1fc62104d3eac49143a473f0
+  data.tar.gz: d9cfbd13dfb26f582c15f11dde6167ce107f00c3
 SHA512:
-  metadata.gz: 55c12c5bf660a07a4d16eb862e35d6b1997078123ae8f1433c290d3bc74d9920a07208cd82e0c6ec625e843ec752d9f9fd3a0c3968fda15d083219c7d90d295b
-  data.tar.gz: 9c708dca0c19de659bccd3f9827fa6846f571bcfe562db08c5969f80aa95adc8e9073d84cd511f984e7a5dec5143a47b311b4b9bb0d38f2261c6d7df609c5e07
+  metadata.gz: c40b106ac5195a1df566437905708891744f290e8386c29897c235657d9e4c945ae87dda6582e908261b04c6510583478aabdcd994d78ba1f82468d306a62739
+  data.tar.gz: ff4b2bc4553bc7829ab50162c3f848cf98535d06eb5b03af03cc0840066135de5c8fe27568b5798fe04972c10e6a2bb4b4c1839b1efbc4890533d64595fb2937

data/Readme.md

@@ -68,6 +68,8 @@ 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. [Components](#components)
   1. [Assets](#assets)
   2. [Component Generator](#component-generator)
@@ -325,6 +327,25 @@ Above I mentioned that Volt comes with many different models accessable from a c
 
 Because all models provided by Volt are wrapped in a ReactiveValue, you can register listeners on them and be updated when values change.  You can also call methods on their values and get updates when the source's change.  Bindings also setup listeners.  Models should be the main place you store all data in Volt.  While you can use ReactiveValue's manually, most of the time you will want to just use something like the page model.
 
+## Model Events
+
+Models trigger events when their data is updated.  Currently models emit three events: changed, added, and removed.  For example:
+
+    model = Model.new
+    
+    model._name.on('changed') { puts 'name changed' }
+    model._name = 'Ryan'
+    # => name changed
+    
+    model._items.on('added') { puts 'item added' }
+    model._items << 1
+    # => item added
+
+    model._items.on('removed') { puts 'item removed' }
+    model._items.delete_at(0)
+    # => item removed
+
+
 # Controllers
 
 A controller can be any class in Volt, however it is common to have that class inherit from ModelController.  A model controller lets you specify a model that the controller works off of.  This is a common pattern in Volt.  To assign the current model, simply set @model to one of the provided models in the initializer.

data/VERSION

@@ -1 +1 @@
-0.4.5
+0.4.7

data/docs/WHY.md

@@ -0,0 +1,50 @@
+# Why Volt?
+
+Volt is a new web framework.  You use Ruby for both your client and server code.  Volt helps you break your code into reusable components.  It handles managing all assets and dependencies for you.  Volt automatically updates your pages for you when your model data changes and sync's that data to the database for you.  By providing reusable structure and handling common tasks, Volt lets you build web app's really fast!
+
+# Features
+
+## Components
+
+Volt projects are broken into components.  Components are easy to create and simple to reuse.  They are easily shared and only require one line of code to insert into your project.  Volt provides many common components out of the box.
+
+## Reactive
+
+Data in volt is reactive by default.  Changes to the data is automatically updated in the DOM.
+
+
+## Data Syncing
+
+A lot of modern web development is moving data between the front-end to the back-end.  Volt eliminates all of that work.  Model's on the front-end automatically sync to the back-end, and vice versa.  Validations are run on both sides for security.  Models on the front-end are automatically updated whenever they are changed anywhere else (another browser, a background task, etc..)
+
+
+## Speed
+
+Volt's reactive objects contain extra data about how to propigate events.  Things that don't need to be updated when data changes aren't.  Volt uses an intellegent managed draw cycle to do efficient DOM updates.  Only the changed part of the page is re-rendered.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+# Why Ruby
+
+In web development today, JavaScript gets to be the default language by virtue of being in the browser.  JavaScript is a very good language, but it has a lot of warts.  (See http://wtfjs.com/ for some great examples)  Some of these can introduce bugs, others are just difficult to deal with.  JavaScript was rushed to market quickly and standardized very quickly.  Ruby was used by a small community for years while most of the kinks were worked out.  Ruby also has some great concepts such as [uniform access](http://en.wikipedia.org/wiki/Uniform_access_principle), [mixin's](http://en.wikipedia.org/wiki/Mixin), [duck typing](http://en.wikipedia.org/wiki/Duck_typing), and [blocks](http://yehudakatz.com/2012/01/10/javascript-needs-blocks/) to name a few.  While many of these features can be implemented in JavaScript in userland, few are standardardized and the solutions are seldom eloquent.
+
+[5,10,1].sort()
+// [1, 10, 5]
+
+Uniform access and duck typing provides us with the ability to make reactive objects that have the exact same interface as a normal object.  This is a big win, nothing new to learn to do reactive programming.  They can also be used interchangably with regular objects.
+
+# Why Opal
+
+Opal is really an increadiable project, and the core team has done a great job.  Ruby and JavaScript are similar in a lot of ways.  This lets Opal compile to JavaScript that is very readable.  This also means that Opal's performance is great.  You'll find that in most cases Ruby code runs with no performance penality compared to the eqivilent JavaScript code.

data/lib/volt/cli.rb

@@ -29,6 +29,9 @@ class CLI < Thor
     # source maps and non-source maps.
     if File.exists?("config.ru") && File.exists?("Gemfile")
       FileUtils.rm_rf("tmp/.")
+    else
+      say("Current folder is not a Volt project", :red)
+      return
     end
 
     ENV['SERVER'] = 'true'
@@ -44,7 +47,7 @@ class CLI < Thor
     # 
     # EM.run do
     #   thin = Rack::Handler.get("thin")
-    #   thin.run(Server.new.app, Port: 5000)
+    #   thin.run(Server.new.app, Port: 3000)
     # end
   end
   

data/lib/volt/console.rb

@@ -19,7 +19,7 @@ class Console
         
     app_path = File.expand_path(File.join(Dir.pwd, "app"))
     component_paths = ComponentPaths.new
-    component_paths.add_tasks_to_load_path
+    component_paths.setup_components_load_path
 
     Pry.config.prompt_name = 'volt'
 

data/lib/volt/page/bindings/attribute_binding.rb

@@ -91,9 +91,9 @@ class AttributeBinding < BaseBinding
     # aren't responsible for it being there.
     case @attribute_name
     when 'value'
-      element.off('input.attrbind')
+      element.off('input.attrbind', nil)
     when 'checked'
-      element.off('change.attrbind')
+      element.off('change.attrbind', nil)
     end
     
     if @update_listener

data/lib/volt/server.rb

@@ -57,7 +57,6 @@ class Server
   
   def setup_change_listener
     # Setup the listeners for file changes
-    puts "Listen for changes at #{@app_path}"
     listener = Listen.to("#{@app_path}/") do |modified, added, removed|
       ChannelHandler.send_message_all(nil, 'reload')
     end
@@ -94,7 +93,7 @@ class Server
     
     # Handle socks js connection
     if RUBY_PLATFORM != 'java'
-      component_paths.add_tasks_to_load_path
+      component_paths.setup_components_load_path
       ChannelHandler.dispatcher = Dispatcher.new
       
       @app.map "/channel" do

data/lib/volt/server/component_handler.rb

@@ -2,7 +2,7 @@ require 'stringio'
 require 'volt'
 require 'volt/server/template_parser'
 require 'volt/server/component_templates'
-require 'volt/server/rack/component_files'
+require 'volt/server/rack/asset_files'
 
 class ComponentHandler
   def initialize(component_paths)
@@ -17,8 +17,8 @@ class ComponentHandler
 
     code = ''
   
-    component_files = ComponentFiles.new(component_name, @component_paths, true)
-    component_files.component_paths.each do |component_path, component_name|
+    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

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

@@ -0,0 +1,106 @@
+# Used to get a list of the assets from the dependencies
+class AssetFiles
+  def initialize(component_name, component_paths)
+    @component_paths = component_paths
+    @assets = []
+    @included_components = {}
+    @components = []
+    
+    component('volt')
+    component(component_name)
+  end
+  
+  def load_dependencies(path)
+    if path
+      dependencies_file = File.join(path, "config/dependencies.rb")
+    else
+      raise "Unable to find component #{component_name.inspect}"
+    end
+    
+    if File.exists?(dependencies_file)
+      # Run the dependencies file in this asset files context
+      code = File.read(dependencies_file)
+      instance_eval(code)
+    end
+  end
+  
+  def component(name)
+    unless @included_components[name]
+      # Get the path to the component
+      path = @component_paths.component_path(name)
+
+      # Track that we added
+      @included_components[name] = true
+
+      # Load the dependencies
+      load_dependencies(path)
+      
+      # Add any assets
+      add_assets(path)
+      @components << [path, name]
+    end
+  end
+  
+  def components
+    @included_components.keys
+  end
+  
+  def javascript_file(url)
+    @assets << [:javascript_file, url]
+  end
+
+  def css_file(url)
+    @assets << [:css_file, url]
+  end
+  
+  def component_paths
+    return @components
+  end
+  
+  def add_assets(path)
+    asset_folder = File.join(path, 'assets')
+    if File.directory?(asset_folder)
+      @assets << [:folder, asset_folder]
+    end
+  end
+  
+  
+  def javascript_files(opal_files)
+    javascript_files = []
+    @assets.each do |type, path|
+      case type
+      when :folder
+        javascript_files += Dir["#{path}/**/*.js"].map {|folder| '/assets' + folder[path.size..-1] }
+      when :javascript_file
+        javascript_files << path
+      end
+    end
+    
+    opal_js_files = []
+    if Volt.source_maps?
+      opal_js_files += opal_files.environment['volt/page/page'].to_a.map {|v| '/assets/' + v.logical_path + '?body=1' }
+    else
+      opal_js_files << '/assets/volt/page/page.js'
+    end
+    opal_js_files << '/components/home.js'
+
+    javascript_files += opal_js_files
+    
+    return javascript_files
+  end
+  
+  def css_files
+    css_files = []
+    @assets.each do |type, path|
+      case type
+      when :folder
+        css_files += Dir["#{path}/**/*.{css,scss}"].map {|folder| '/assets' + folder[path.size..-1].gsub(/[.]scss$/, '') }
+      when :css_file
+        css_files << path
+      end
+    end
+    
+    return css_files
+  end
+  
+end

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

@@ -1,3 +1,4 @@
+# ComponentPaths gives an array of every folder where you find a component.
 class ComponentPaths
   def initialize(root=nil)
     @root = root || Dir.pwd
@@ -27,6 +28,7 @@ class ComponentPaths
     return files.flatten
   end
   
+  # returns an array of every folder that is a component
   def components
     return @components if @components
     
@@ -45,7 +47,8 @@ class ComponentPaths
     return @components
   end
   
-  def add_tasks_to_load_path
+  # Makes each components classes available on the load path
+  def setup_components_load_path
     components.each do |name,component_folders|
       component_folders.each do |component_folder|
         Dir["#{component_folder}/tasks"].each do |tasks_folder|
@@ -55,6 +58,7 @@ class ComponentPaths
     end
   end
   
+  # Returns the path for a specific component
   def component_path(name)
     folders = components[name]
     

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

@@ -1,4 +1,4 @@
-require 'volt/server/rack/component_files'
+require 'volt/server/rack/asset_files'
 require 'volt/router/routes'
 
 # Serves the main pages

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

@@ -5,8 +5,10 @@ class OpalFiles
   attr_reader :environment
   
   def initialize(builder, app_path, component_paths)
-    ::Opal::Processor.source_map_enabled = Volt.source_maps?
-    # Opal::Processor.arity_check_enabled = true
+    Opal::Processor.source_map_enabled = Volt.source_maps?
+    
+    # Don't run arity checks in production
+    # Opal::Processor.arity_check_enabled = !Volt.env.production?
     # Opal::Processor.dynamic_require_severity = :raise
 
     @component_paths = component_paths

data/spec/server/rack/asset_files_spec.rb

@@ -0,0 +1,25 @@
+if RUBY_PLATFORM != 'opal'
+  require 'volt/server/rack/asset_files'
+
+  describe AssetFiles do
+    before do
+      spec_app_root = File.join(File.dirname(__FILE__), "../..")
+    
+      path_to_main = File.join(File.dirname(__FILE__), "../../app/main")
+      @component_paths = ComponentPaths.new(spec_app_root)
+    end
+  
+    it "should return the dependencies list" do
+      main = AssetFiles.new("main", @component_paths)
+    
+      components = main.components
+      expect(components).to eq(['volt', 'main', 'shared', 'bootstrap', "slideshow"])
+    end
+  
+    it "should list all JS files" do
+      main = AssetFiles.new("main", @component_paths)
+    
+      expect(main.javascript_files(nil)).to eq(["/assets/js/jquery-2.0.3.js", "/assets/js/sockjs-0.2.1.min.js", "/assets/js/bootstrap.js", "/assets/js/test2.js", "/assets/js/test3.js", "/assets/js/test1.js", "/assets/volt/page/page.js", "/components/home.js"])
+    end
+  end
+end

data/templates/project/app/home/config/routes.rb

@@ -1,4 +1,4 @@
-get "/about", _controller: 'about'
+get "/about", _page: 'about'
 
 # The main route
 get '/'

data/templates/project/app/home/views/index/index.html

@@ -1,5 +1,5 @@
 <:title>
-  {#template params._controller.or('home'), "title"}
+  {#template params._page.or('home'), "title"}
 </:title>
 
 <:body>
@@ -14,7 +14,7 @@
       <h3 class="text-muted">Project name</h3>
     </div>
     
-    {#template params._controller.or('home')}
+    {#template params._page.or('home')}
     
     <div class="footer">
       <p>&copy; Company 2014</p>
@@ -24,7 +24,7 @@
 </:body>
 
 <:nav>
-  <li class="{#if params._controller.or('') == page}active{/}">
+  <li class="{#if params._page.or('') == page}active{/}">
     <a href="/{page}">{text}</a>
   </li>
 </:nav>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: volt
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.7
 platform: ruby
 authors:
 - Ryan Stout
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -297,11 +297,13 @@ files:
 - app/volt/assets/css/notices.css.scss
 - 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/tasks/channel_tasks.rb
 - app/volt/tasks/store_tasks.rb
 - app/volt/views/notices/index.html
 - bin/volt
 - docs/GETTING_STARTED.md
+- docs/WHY.md
 - lib/volt.rb
 - lib/volt/benchmark/benchmark.rb
 - lib/volt/cli.rb
@@ -374,7 +376,7 @@ files:
 - lib/volt/server/component_handler.rb
 - lib/volt/server/component_templates.rb
 - lib/volt/server/if_binding_setup.rb
-- lib/volt/server/rack/component_files.rb
+- lib/volt/server/rack/asset_files.rb
 - lib/volt/server/rack/component_paths.rb
 - lib/volt/server/rack/index_files.rb
 - lib/volt/server/rack/opal_files.rb
@@ -401,7 +403,7 @@ files:
 - spec/models/string_extensions_spec.rb
 - spec/page/sub_context_spec.rb
 - spec/router/routes_spec.rb
-- spec/server/rack/component_files_spec.rb
+- spec/server/rack/asset_files_spec.rb
 - spec/server/rack/component_paths_spec.rb
 - spec/server/template_parser_spec.rb
 - spec/spec_helper.rb
@@ -486,7 +488,7 @@ test_files:
 - spec/models/string_extensions_spec.rb
 - spec/page/sub_context_spec.rb
 - spec/router/routes_spec.rb
-- spec/server/rack/component_files_spec.rb
+- spec/server/rack/asset_files_spec.rb
 - spec/server/rack/component_paths_spec.rb
 - spec/server/template_parser_spec.rb
 - spec/spec_helper.rb

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

@@ -1,109 +0,0 @@
-require 'volt/server/rack/component_paths'
-require 'volt'
-
-# Takes in the path to a component and gets all other components
-# required from this one
-class ComponentFiles
-  def initialize(component_name, component_paths, main_component=false)
-    @component_name = component_name
-    @component_paths = component_paths
-    @asset_folders = []
-    @components = [component_name]
-    @main_component = main_component
-    
-    if @main_component
-      # puts "ADD VOLT"
-      # Add in volt's JS files first
-      component('volt')
-    end
-    
-    load_child_components
-    add_asset_folder(component_name)
-  end
-  
-  def components
-    @components
-  end
-  
-  def component(name)
-    # Load any sub-requires
-    child_files = ComponentFiles.new(name, @component_paths)
-    new_components = child_files.components
-    
-    # remove any we already have
-    new_components = new_components - @components
-    new_components.each {|nc| add_asset_folder(nc) }
-    
-    @components += new_components
-    
-    return @components
-  end
-  
-  def add_asset_folder(component_name)
-    path = path_to_component(component_name)
-    
-    asset_folder = File.join(path, 'assets')
-    if File.directory?(asset_folder)
-      @asset_folders << asset_folder
-    end
-  end
-  
-  def path_to_component(name=nil)
-    @component_paths.component_path(name || @component_name)
-  end
-  
-  def component_paths
-    @components.map {|c| [path_to_component(c), c] }
-  end
-  
-  def load_child_components
-    path = path_to_component
-    if path
-      dependencies_file = File.join(path_to_component, "config/dependencies.rb")
-    else
-      raise "Unable to find component #{@component_name.inspect}"
-    end
-    
-    if File.exists?(dependencies_file)
-      # Run the dependencies file in this ComponentFiles context
-      code = File.read(dependencies_file)
-      instance_eval(code)
-    end
-  end
-  
-  # Returns every asset folder that is included from this component.
-  # This means this components assets folder and any in the dependency chain.
-  def asset_folders
-    files = []
-    @asset_folders.each do |asset_folder|
-      files << yield(asset_folder)
-    end
-    
-    return files.flatten
-  end
-  
-  
-  def javascript_files(opal_files)
-    javascript_files = asset_folders do |asset_folder|
-      Dir["#{asset_folder}/**/*.js"].map {|path| '/assets' + path[asset_folder.size..-1] }
-    end
-    
-    opal_js_files = []
-    if Volt.source_maps?
-      opal_js_files += opal_files.environment['volt/page/page'].to_a.map {|v| '/assets/' + v.logical_path + '?body=1' }
-    else
-      opal_js_files << '/assets/volt/page/page.js'
-    end
-    opal_js_files << '/components/home.js'
-
-    javascript_files.insert(2, *opal_js_files)
-    
-    return javascript_files
-  end
-
-  def css_files
-    asset_folders do |asset_folder|
-      Dir["#{asset_folder}/**/*.{css,scss}"].map {|path| '/assets' + path[asset_folder.size..-1].gsub(/[.]scss$/, '') }
-    end
-  end
-end

data/spec/server/rack/component_files_spec.rb

@@ -1,25 +0,0 @@
-if RUBY_PLATFORM != 'opal'
-  require 'volt/server/rack/component_files'
-
-  describe ComponentFiles do
-    before do
-      spec_app_root = File.join(File.dirname(__FILE__), "../..")
-    
-      path_to_main = File.join(File.dirname(__FILE__), "../../app/main")
-      @component_paths = ComponentPaths.new(spec_app_root)
-    end
-  
-    it "should return the dependencies list" do
-      main = ComponentFiles.new("main", @component_paths)
-    
-      components = main.components
-      expect(components).to eq(['main', 'shared', 'bootstrap', "slideshow"])
-    end
-  
-    it "should list all JS files" do
-      main = ComponentFiles.new("main", @component_paths)
-    
-      expect(main.javascript_files(nil)).to eq(["/assets/js/test2.js", "/assets/js/bootstrap.js", "/assets/volt/page/page.js", "/components/home.js", "/assets/js/test3.js", "/assets/js/test1.js"])
-    end
-  end
-end