steering 1.0.0 → 1.1.0

data/README.md

@@ -1,16 +1,29 @@
 # 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.
+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.
+
+    $ irb
 
     require "steering"
-    
-    Steering.compile(File.read("template.hb"))
-    # => "function(...) {...}"
-    
+    # => true
+
+    Steering.compile(File.read("example/mytemplate.handlebars"))
+    # => "function(Handlebars,...) {...}"
+
+    # This will create a file called "mytemplate.js" in the supplied
+    # example folder and return the size of the resulting file in bytes.
+    # Make sure to load "index.html" before and after in your favourite browser!
+    Steering.compile_to_file("example/mytemplate.handlebars", "example/mytemplate.js")
+    # => 1069
+
     context = Steering.context_for("Hello {{ name }}")
     context.call("template", :name => "Andrew")
     # => "Hello Andrew"
-    
+
     Steering.render("Hello {{ name }}", :name => "world")
     # => "Hello world"
 
@@ -20,21 +33,76 @@ Steering is a bridge to the [Handlebars.js][1] template precompiler. By precompi
 
 ## 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.
+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:
+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.
+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
 
+## Contributing
+
+You can check out the Steering source code from GitHub:
+
+    $ git clone http://github.com/pixeltrix/steering.git
+
+To run Steerings's test suite run `rake test`.
+
+Report bugs on the [GitHub issue tracker](http://github.com/pixeltrix/steering/issues).
+
+## Special thanks
+
+* Daniel Demmel <dain@danieldemmel.me>
+
+## Changelog
+
+### 1.1.0
+
+* Added 'compile_to_file' method. *Daniel Demmel*
+* Added precompile workflow example files. *Daniel Demmel*
+
+### 1.0.0
+
+Initial version.
+
+## License (MIT)
+
+Copyright (c) 2012 Andrew White <andyw@pixeltrix.co.uk>
+
+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.
+
 [1]: https://github.com/wycats/handlebars.js
 [2]: https://github.com/sstephenson/execjs
 [3]: https://github.com/sstephenson/execjs/blob/master/README.md

data/example/index.html

@@ -0,0 +1,16 @@
+<html lang="en-GB">
+	<head>
+		<script type="text/javascript" src="https://raw.github.com/pixeltrix/steering-source/master/lib/steering/handlebars.runtime.js"></script>
+		<script type="text/javascript" src="mytemplate.js"></script>
+	</head>
+
+	<body>
+		<div id="placeholder">This example will only work if you precompile mytemplate.handlebars. See README!</div>
+	</body>
+
+	<script type="text/javascript">
+		template = Handlebars.templates['mytemplate'];
+		var placeholderElement = document.getElementById('placeholder');
+		placeholderElement.innerHTML = template({title: 'My title', body: "My body"});
+	</script>
+</html>

data/example/mytemplate.handlebars

@@ -0,0 +1,6 @@
+<div class="entry">
+  <h1>{{title}}</h1>
+  <div class="body">
+    {{body}}
+  </div>
+</div>

data/lib/steering.rb

@@ -48,6 +48,15 @@ module Steering
       Source.context.call("Handlebars.precompile", template, { :knownHelpers => known_helpers })
     end
 
+    def compile_to_file(template, file, extension = ".handlebars")
+      File.open(file, 'w') do |f|
+        name = File.basename(template, extension)
+        template = File.read(template)
+        f.write("\nHandlebars.templates = Handlebars.templates || {};")
+        f.write("\nHandlebars.templates['#{name}'] = Handlebars.template(#{compile(template)});\n")
+      end
+    end
+
     def context_for(template, extra = "")
       ExecJS.compile("#{Source.runtime}; #{extra}; var template = Handlebars.template(#{compile(template)})")
     end

data/lib/steering/version.rb

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

data/test/steering_test.rb

@@ -4,6 +4,10 @@ require "test/unit"
 
 class SteeringTest < Test::Unit::TestCase
   JS_FUNCTION_PATTERN = /^function\s*\(.*?\)\s*\{.*\}$/m
+  HB_PREAMBLE         = /Handlebars\.templates\s*=\s*Handlebars.templates\s\|\|\s*\{\};/
+  HB_ASSIGNMENT       = /Handlebars\.templates\['\w+'\]\s*=/
+  HB_TEMPLATE         = /Handlebars\.template\(function\s*\(.*?\)\s*\{.*\}\);/m
+  HB_TEMPLATE_PATTERN = /^\n#{HB_PREAMBLE}\n#{HB_ASSIGNMENT}\s*#{HB_TEMPLATE}\s*$/m
 
   def test_version
     assert_equal Steering::Source::VERSION, Steering.version
@@ -24,6 +28,18 @@ class SteeringTest < Test::Unit::TestCase
     end
   end
 
+  def test_compile_file
+    file = "example/mytemplate.handlebars"
+    compiled_file = "example/mytemplate.js"
+
+    Steering.compile_to_file(file, compiled_file)
+    compiled_source = File.read(compiled_file)
+
+    assert_match HB_TEMPLATE_PATTERN, compiled_source
+  ensure
+    File.delete(compiled_file) if File.exists?(compiled_file)
+  end
+
   def test_context_for
     context = Steering.context_for("Hello {{ name }}")
     assert_equal "Hello Andrew", context.call("template", :name => "Andrew")

metadata

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