steering 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'json', '~> 1.6.5'
+gem 'rake', '~> 0.9.2.2'
+
+# Specify your gem's dependencies in steering.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrew White
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Steering
+
+Steering is a bridge to the [Handlebars.js][1] template precompiler. By precompiling your templates you can speed up page loading in two ways - firstly the final compilation step is much quicker as the template source code does not have to be parsed and the size of the library can be reduced by using the smaller runtime library if all your templates are precompiled.
+
+    require "steering"
+    
+    Steering.compile(File.read("template.hb"))
+    # => "function(...) {...}"
+    
+    context = Steering.context_for("Hello {{ name }}")
+    context.call("template", :name => "Andrew")
+    # => "Hello Andrew"
+    
+    Steering.render("Hello {{ name }}", :name => "world")
+    # => "Hello world"
+
+## Installation
+
+    $ gem install steering
+
+## Dependencies
+
+This library depends on the `steering-source` gem which is updated any time a new version of Handlebars.js is released (The `steering-source` gem's version number is synced with each official Handlebars.js release). This way you can build against different versions of Handlebars.js by requiring the correct version of the `steering-source` gem.
+
+In addition, you can use this library with unreleased versions of Handlebars.js by setting the `HANDLEBARS_SOURCE_PATH` and `HANDLEBARS_RUNTIME_PATH` environment variable:
+
+    export HANDLEBARS_SOURCE_PATH=/path/to/handlebars.js
+    export HANDLEBARS_RUNTIME_PATH=/path/to/handlebars.runtime.js
+
+### ExecJS
+
+The [ExecJS][2] library is used to automatically choose the best JavaScript engine for your platform. Check out its [README][3] for a complete list of supported engines.
+
+## Acknowledgements
+
+The structure and code patterns for this gem were derived from the [Ruby Eco][4] gem
+
+[1]: https://github.com/wycats/handlebars.js
+[2]: https://github.com/sstephenson/execjs
+[3]: https://github.com/sstephenson/execjs/blob/master/README.md
+[4]: https://github.com/sstephenson/ruby-eco

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "rake/testtask"
+require "bundler/gem_tasks"
+
+desc "Default: run handlebars unit tests."
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs += %w[lib test]
+  t.pattern = "test/**/*_test.rb"
+  t.warning = true
+end

data/lib/steering.rb

@@ -0,0 +1,63 @@
+require "execjs"
+require "steering/source"
+
+module Steering
+  module Source
+    def self.path
+      @path ||= ENV["HANDLEBARS_SOURCE_PATH"] || bundled_path
+    end
+
+    def self.path=(path)
+      @contents = @version = @context = nil
+      @path = path
+    end
+
+    def self.contents
+      @contents ||= File.read(path)
+    end
+
+    def self.context
+      @context ||= ExecJS.compile(contents)
+    end
+
+    def self.runtime_path
+      @runtime_path ||= ENV["HANDLEBARS_RUNTIME_PATH"] || bundled_runtime_path
+    end
+
+    def self.runtime_path=(runtime_path)
+      @runtime = nil
+      @runtime_path = runtime_path
+    end
+
+    def self.runtime
+      @runtime_contents ||= File.read(runtime_path)
+    end
+
+    def self.version
+      @version ||= context.eval("Handlebars.VERSION")
+    end
+  end
+
+  class << self
+    def version
+      Source.version
+    end
+
+    def compile(template)
+      template = template.read if template.respond_to?(:read)
+      Source.context.call("Handlebars.precompile", template, { :knownHelpers => known_helpers })
+    end
+
+    def context_for(template, extra = "")
+      ExecJS.compile("#{Source.runtime}; #{extra}; var template = Handlebars.template(#{compile(template)})")
+    end
+
+    def known_helpers
+      Source.known_helpers
+    end
+
+    def render(template, locals = {})
+      context_for(template).call("template", locals)
+    end
+  end
+end

data/lib/steering/version.rb

@@ -0,0 +1,3 @@
+module Steering
+  VERSION = "1.0.0"
+end

data/steering.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "steering/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "steering"
+  gem.version       = Steering::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Andrew White"]
+  gem.email         = ["andyw@pixeltrix.co.uk"]
+  gem.homepage      = "https://github.com/pixeltrix/steering"
+
+  gem.summary       = %q{Ruby Handlebars.js Compiler}
+  gem.description   = %q{Steering is a bridge to the official JavaScript Handlebars.js compiler.}
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'execjs', '>= 1.3.0'
+  gem.add_runtime_dependency 'steering-source', '>= 1.0.beta.6'
+end

data/test/steering_test.rb

@@ -0,0 +1,46 @@
+require "steering"
+require "stringio"
+require "test/unit"
+
+class SteeringTest < Test::Unit::TestCase
+  JS_FUNCTION_PATTERN = /^function\s*\(.*?\)\s*\{.*\}$/m
+
+  def test_version
+    assert_equal Steering::Source::VERSION, Steering.version
+  end
+
+  def test_compile
+    assert_match JS_FUNCTION_PATTERN, Steering.compile("Hello {{ name }}")
+  end
+
+  def test_compile_with_io
+    io = StringIO.new("Hello {{ name }}")
+    assert_equal Steering.compile("Hello {{ name }}"), Steering.compile(io)
+  end
+
+  def test_compilation_error
+    assert_raise ExecJS::ProgramError do
+      Steering.compile("{{ name")
+    end
+  end
+
+  def test_context_for
+    context = Steering.context_for("Hello {{ name }}")
+    assert_equal "Hello Andrew", context.call("template", :name => "Andrew")
+  end
+
+  def test_render
+    assert_equal "Hello Andrew", Steering.render("Hello {{ name }}", :name => "Andrew")
+  end
+
+  def test_runtime_error
+    helper = "Handlebars.registerHelper('throw', function(arg) { throw arg; })"
+    context = Steering.context_for("Hello {{ throw foo }}", helper)
+
+    begin
+      context.call("template", :foo => "bar")
+    rescue ExecJS::ProgramError => e
+      assert_equal "bar", e.message
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: steering
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andrew White
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: execjs
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: steering-source
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 2469281371
+        segments: 
+        - 1
+        - 0
+        - beta
+        - 6
+        version: 1.0.beta.6
+  type: :runtime
+  version_requirements: *id002
+description: Steering is a bridge to the official JavaScript Handlebars.js compiler.
+email: 
+- andyw@pixeltrix.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/steering.rb
+- lib/steering/version.rb
+- steering.gemspec
+- test/steering_test.rb
+homepage: https://github.com/pixeltrix/steering
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.14
+signing_key: 
+specification_version: 3
+summary: Ruby Handlebars.js Compiler
+test_files: 
+- test/steering_test.rb