volt 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f31285f8d34376239bed9e92cb9dec093f8331e
-  data.tar.gz: 9fe3e6d4e61cf93734a72fd92f41df30ffc672f1
+  metadata.gz: 5a11e880b0dfbda45e1a83176460f5723748a8f9
+  data.tar.gz: 600654cace56d7e79b31f61519dbe11d2b6ecf02
 SHA512:
-  metadata.gz: 098e047b75cf968bdd84634d5b1262600678f2765c73e759d5e5f4fb94503b20485ca1146fcf23fd0e039aee9fc186240c9dbfef732ac567deeed68463b04b03
-  data.tar.gz: 3ef0821f1ec5f15e02d174f6016f2a83a2d9f2c482d805c2baacfdba972b647f69345261bcedd13c9a1763eed7a21fa3df6f2f83c95bbd2185052d45fffbf00e
+  metadata.gz: 7a59388069aadc3a45416d72284f56e67b0b1f5a8eb46f5dd8807e0706abfb24bd35e645554892c15e1091837c1193a907c54b42190e1cc2201ff46ff9ec0b5c
+  data.tar.gz: b99c2138d7ab5d24bbad34cec8d0ce561fab2717d9b570280bc1ca74c2e06bb71c0a2abe9c6edd8a43614bfdf597d283f0e85f3f8500b283c2736a389e2a25a1

data/Readme.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/volt.png)](http://badge.fury.io/rb/volt)
+[![Code Climate](https://codeclimate.com/github/voltrb/volt.png)](https://codeclimate.com/github/voltrb/volt)
+
 # Volt
 
 NOTE: VOLT IS STILL IN DEVELOPMENT, DON'T USE IT FOR ANYTHING SERIOUS YET

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/docs/GUIDE.md

@@ -4,7 +4,7 @@ This guide will take you through creating a basic web application in Volt.  This
 
 To get started, install volt:
 
-    gem install voltframework
+    gem install volt
 
 Then create a new project:
 
@@ -19,8 +19,8 @@ This will setup a basic project.  Now lets run the server.
 
 When a user interacts with a web page, typically we want to do two things:
 
-1) Change application state
-2) Update the DOM
+1. Change application state
+2. Update the DOM
 
 For example when a user clicks to add a new todo item to a todo list, we might create a JavaScript object to represent the todo item, then add an item to the list's DOM.  A lot of work needs to be done to make sure that the JavaScript object and the DOM always stay in sync.
 

data/lib/volt.rb

@@ -1,8 +1,6 @@
 class Volt
   def self.root
     @root ||= File.expand_path(Dir.pwd)
-    
-    # File.expand_path(File.join(File.dirname(__FILE__), "../"))
   end
   
   def self.server?

data/lib/volt/cli.rb

@@ -6,7 +6,7 @@ class CLI < Thor
   
   desc "new PROJECT_NAME", "generates a new project."
   def new(name)
-    directory(".", name)
+    directory("project", name)
     
     say "Bundling Gems...."
     `cd #{name} ; bundle`
@@ -26,6 +26,19 @@ class CLI < Thor
     Thin::Runner.new(['start']).run!
   end
   
+  desc "gem GEM", "Creates a gem where you can share a component"
+  method_option :bin, :type => :boolean, :default => false, :aliases => '-b', :banner => "Generate a binary for your library."
+  method_option :test, :type => :string, :lazy_default => 'rspec', :aliases => '-t', :banner => "Generate a test directory for your library: 'rspec' is the default, but 'minitest' is also supported."
+  method_option :edit, :type => :string, :aliases => "-e",
+                :lazy_default => [ENV['BUNDLER_EDITOR'], ENV['VISUAL'], ENV['EDITOR']].find{|e| !e.nil? && !e.empty? },
+                :required => false, :banner => "/path/to/your/editor",
+                :desc => "Open generated gemspec in the specified editor (defaults to $EDITOR or $BUNDLER_EDITOR)"
+  def gem(name)
+    require 'volt/cli/new_gem'
+    
+    NewGem.new(self, name, options)
+  end  
+  
   def self.source_root
     File.expand_path(File.join(File.dirname(__FILE__), '../../templates'))
   end

data/lib/volt/cli/new_gem.rb

@@ -0,0 +1,116 @@
+require "net/http"
+require "uri"
+require 'fileutils'
+
+# Creates a new "volt" gem, which can be used to easily repackage
+# components.
+class NewGem  
+  def initialize(thor, name, options)
+    @thor = thor
+    @component_name = name.chomp("/")
+    @name = "volt-" + @component_name # remove trailing slash if present
+
+    if gem_is_available?
+      @thor.say("#{@name} is available!  Making gem files.", :green)
+    else
+      @thor.say("There is already a gem named #{@name}.  Please choose a different name.", :red)
+      return
+    end
+    
+    @options = options
+    @namespaced_path = @name.tr('-', '/')
+    @opts = gem_options
+    @target = File.join(Dir.pwd, @name)
+    
+    copy_files
+    copy_options
+  end
+  
+  # Check with the rubygems api to see if this gem name is available.
+  def gem_is_available?
+    @thor.say("Check if #{@name} is available as a gem name.", :yellow)
+    uri = URI.parse("https://rubygems.org/api/v1/gems/#{@name}.json")
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+  
+    request = Net::HTTP::Get.new(uri.request_uri)
+    response = http.request(request)
+
+    return response.code == "404"
+  rescue SocketError => e
+    # rubygems is down, skip check
+    return true
+  end
+  
+  def copy_files
+    @thor.directory("newgem/app/newgem", File.join("#{@target}", "app/#{@component_name}"))
+    copy("newgem/Gemfile.tt", "Gemfile")
+    copy("newgem/Rakefile.tt", "Rakefile")
+    copy("newgem/README.md.tt", "README.md")
+    copy("newgem/gitignore.tt", ".gitignore")
+    copy("newgem/newgem.gemspec.tt", "#{@name}.gemspec")
+    copy("newgem/lib/newgem.rb.tt", "lib/#{@namespaced_path}.rb")
+    copy("newgem/VERSION", "VERSION")
+    FileUtils.mkdir_p(File.join(@target, "lib/#{@namespaced_path}"))
+  end
+    
+  def copy_options
+    if @options[:bin]
+      copy("newgem/bin/newgem.tt", "bin/#{@name}")
+    end
+    case @options[:test]
+    when 'rspec'
+      copy("newgem/rspec.tt", ".rspec")
+      copy("newgem/spec/spec_helper.rb.tt", "spec/spec_helper.rb")
+      copy("newgem/spec/newgem_spec.rb.tt", "spec/#{@namespaced_path}_spec.rb")
+    when 'minitest'
+      copy("newgem/test/minitest_helper.rb.tt", "test/minitest_helper.rb")
+      copy("newgem/test/test_newgem.rb.tt", "test/test_#{@namespaced_path}.rb")
+    end
+    puts "Initializing git repo in #{@target}"
+    Dir.chdir(@target) { `git init`; `git add .` }
+
+    if @options[:edit]
+      run("#{@options["edit"]} \"#{gemspec_dest}\"")  # Open gemspec in editor
+    end
+  end
+  
+  private
+    def copy(from, to)
+      @thor.template(File.join(from), File.join(@target, to), @opts)
+    end
+  
+    def gem_options
+      constant_name = get_constant_name
+      constant_array = constant_name.split('::')
+      git_user_name = `git config user.name`.chomp
+      git_user_email = `git config user.email`.chomp
+  
+      opts = {
+        :name            => @name,
+        :namespaced_path => @namespaced_path,
+        :constant_name   => constant_name,
+        :constant_array  => constant_array,
+        :author          => git_user_name.empty? ? "TODO: Write your name" : git_user_name,
+        :email           => git_user_email.empty? ? "TODO: Write your email address" : git_user_email,
+        :test            => @options[:test],
+        :volt_version_base => volt_version_base
+      }
+    
+      return opts
+    end
+    
+    def volt_version_base
+      version_path = File.join(File.dirname(__FILE__), '../../../VERSION')
+      File.read(version_path).split('.').tap {|v| v[v.size-1] = 0 }.join('.')
+    end
+    
+    def get_constant_name
+      constant_name = @name.split('_').map{|p| p[0..0].upcase + p[1..-1] }.join
+      constant_name = constant_name.split('-').map{|q| q[0..0].upcase + q[1..-1] }.join('::') if constant_name =~ /-/
+      
+      return constant_name
+    end
+  
+end

data/lib/volt/controllers/model_controller.rb

@@ -19,6 +19,10 @@ class ModelController
     $page.url 
   end
   
+  def channel
+    $page.channel
+  end
+  
   def controller
     @controller ||= ReactiveValue.new(Model.new)
   end

data/lib/volt/router/routes.rb

@@ -12,19 +12,20 @@ class Routes
   end
   
   def get(path, options)
-    if path.index(':')
-      sections = path.split(/([:][^:\/]+)/)
+    if path.index('{') && path.index('}')
+      sections = path.split(/(\{[^\}]+\})/)
+      sections = sections.reject {|v| v == '' }
       
       sections.each do |section|
-        if section[0] == ':'
-          options[section[1..-1]] = nil
+        if section[0] == '{' && section[-1] == '}'
+          options[section[1..-2]] = nil
         end
       end
       path = Proc.new do |params|
         # Create a path using the params in the path
         sections.map do |section|
-          if section[0] == ':'
-            params[section[1..-1]]
+          if section[0] == '{' && section[-1] == '}'
+            params[section[1..-2]]
           else
             section
           end
@@ -73,7 +74,9 @@ class Routes
   
     def params_match_options?(params, options)
       options.each_pair do |key, value|
-        if value == nil || value != params.send(key)
+        # A nil value means it can match anything, so we don't want to
+        # fail on nil.        
+        if value != nil && value != params.send(key)
           return false
         end
       end

data/lib/volt/server.rb

@@ -8,114 +8,54 @@ require "sprockets-sass"
 require "sass"
 
 require 'volt/extra_core/extra_core'
-require 'volt/server/request_handler'
 require 'volt/server/component_handler'
 if RUBY_PLATFORM != 'java'
   require 'volt/server/channel_handler'
 end
-require 'volt/server/source_map_server'
-
-class Index
-
-  def initialize(app, files)
-    @app = app
-    @files = files
-  end
-
-  def call(env)
-    if %w[/ /demo /blog /todos /page3 /page4].include?(env['PATH_INFO']) || env['PATH_INFO'][0..5] == '/todos'
-      [200, { 'Content-Type' => 'text/html' }, [html]]
-    else
-      @app.call env
-    end
-  end
-  
-  def html
-    index_path = File.expand_path(File.join(Dir.pwd, "public/index.html"))
-    html = File.read(index_path)
-    
-    ERB.new(html).result(binding)
-  end
-end
-
-
-
-SOURCE_MAPS = !!ENV['MAPS']
-
-Opal::Processor.source_map_enabled = SOURCE_MAPS
-# Opal::Processor.arity_check_enabled = true
-# Opal::Processor.dynamic_require_severity = :raise
-
+require 'volt/server/rack/component_paths'
+require 'volt/server/rack/index_files'
+require 'volt/server/rack/opal_files'
 
 
 class Server
-  def self.app
-
-    builder = Rack::Builder.new do
-      use Rack::CommonLogger
-      # run RequestHandler.new
-
-      use Rack::ShowExceptions
-
-      map '/components' do
-        run ComponentHandler.new
-      end
-
-      environment = Opal::Environment.new
-      
-      app_path = File.expand_path(File.join(Dir.pwd, "app"))
-      environment.append_path(app_path)
-      
-      volt_gem_lib_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-      environment.append_path(volt_gem_lib_path)
-  
-      # Add the opal load paths
-      Opal.paths.each do |path|
-        environment.append_path(path)
-      end
-  
-      # opal-jquery gem
-      spec = Gem::Specification.find_by_name("opal-jquery")
-      environment.append_path(spec.gem_dir + "/opal")
-
-  
-      map '/assets' do
-        run environment
-      end
-  
-      if SOURCE_MAPS
-        source_maps = SourceMapServer.new(environment)
+  def initialize
+    @app_path = File.expand_path(File.join(Dir.pwd, "app"))
+    @component_paths = ComponentPaths.new
+  end
   
-        map(source_maps.prefix) do
-          run source_maps
-        end
-      end
+  def app
+    @app = Rack::Builder.new
+    @app.use Rack::CommonLogger
+    @app.use Rack::ShowExceptions
 
-      if RUBY_PLATFORM != 'java'
-        map "/channel" do
-          run Rack::SockJS.new(ChannelHandler)#, :websocket => false
-        end
-      end
+    @app.map '/components' do
+      run ComponentHandler.new
+    end
 
-      if SOURCE_MAPS
-        files = environment['volt/templates/page'].to_a.map {|v| v.logical_path }
-      else
-        files = []
+    # Serve the main html files from public, also figure out
+    # which JS/CSS files to serve.
+    @app.use IndexFiles, @component_paths
+    
+    # Serve the opal files
+    OpalFiles.new(@app, @app_path, @component_paths)
+    
+    # Handle socks js connection
+    if RUBY_PLATFORM != 'java'
+      @app.map "/channel" do
+        run Rack::SockJS.new(ChannelHandler)#, :websocket => false
       end
-
-      use Index, files
-
-      use Rack::Static,
-        :urls => ["/"],
-        :root => "public",
-        :index => "",
-        :header_rules => [
-          [:all, {'Cache-Control' => 'public, max-age=86400'}]
-        ]
-  
-      run lambda{ |env| [ 404, { 'Content-Type'  => 'text/html' }, ['404 - page not found'] ] }
     end
     
-    return builder
+    @app.use Rack::Static,
+      :urls => ["/"],
+      :root => "public",
+      :index => "",
+      :header_rules => [
+        [:all, {'Cache-Control' => 'public, max-age=86400'}]
+      ]
+
+    @app.run lambda{ |env| [ 404, { 'Content-Type'  => 'text/html' }, ['404 - page not found'] ] }
+    
+    return @app
   end
 end

data/lib/volt/server/channel_handler.rb

@@ -2,7 +2,7 @@ require 'json'
 require 'sockjs/session'
 
 class ChannelHandler < SockJS::Session
-  def self.message_all
+  def self.message_all(message)
     @@channels.each do |channel|
       channel.send(message)
     end

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

@@ -0,0 +1,97 @@
+require 'volt/server/rack/component_paths'
+
+SOURCE_MAPS = !!ENV['MAPS'] unless defined?(SOURCE_MAPS)
+
+# Takes in the path to a component and gets all other components
+# required from this one
+class ComponentFiles
+  def initialize(component_name, component_paths)
+    @component_name = component_name
+    @component_paths = component_paths
+    @asset_folders = []
+    @components = [component_name]
+    
+    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 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)
+      puts "CODE: #{code.inspect}"
+      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
+    if SOURCE_MAPS
+      javascript_files = environment['volt/templates/page'].to_a.map {|v| '/assets/' + v.logical_path + '?body=1' }
+    else
+      javascript_files = ['/assets/volt/templates/page.js']
+    end
+    
+    javascript_files << '/components/home.js'
+    javascript_files += asset_folders do |asset_folder|
+      Dir["#{asset_folder}/**/*.js"].map {|path| '/assets' + path[asset_folder.size..-1] }
+    end
+    
+    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