steering 1.1.1 → 1.2.0

data/README.md

@@ -73,6 +73,20 @@ Report bugs on the [GitHub issue tracker](http://github.com/pixeltrix/steering/i
 
 ## Changelog
 
+### 1.2.0
+
+* The `compile_to_file` method now takes an options hash which takes the following options:
+
+  `:extension` - the extension of the file to which the template is compiled
+  `:partial`   - register the template as a partial with Handlebars
+
+  *Daniel Demmel*
+
+* The `render` method now takes `extra` argument which is passed on to `context_for`.
+  This can be used to pass precompiled partials or helpers to the ExecJS context.
+
+  *Daniel Demmel*
+
 ### 1.1.1
 
 * Bumped steering-source version to 1.0.rc.1

data/lib/steering.rb

@@ -48,12 +48,21 @@ module Steering
       Source.context.call("Handlebars.precompile", template, { :knownHelpers => known_helpers })
     end
 
-    def compile_to_file(template, file, extension = ".handlebars")
+    def compile_to_file(template, file, options = {})
+      if options.is_a?(String)
+        extension = options
+        partial = false
+      else
+        extension = options[:extension] || ".handlebars"
+        partial = options[:partial] || false
+      end
+
       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")
+        f.write("Handlebars.registerPartial('#{name}', Handlebars.templates['#{name}']);\n") if partial
       end
     end
 
@@ -65,8 +74,10 @@ module Steering
       Source.known_helpers
     end
 
-    def render(template, locals = {})
-      context_for(template).call("template", locals)
+    def render(template, *args)
+      locals = args.last.is_a?(Hash) ? args.pop : {}
+      extra = args.first.to_s
+      context_for(template, extra).call("template", locals)
     end
   end
 end

data/lib/steering/version.rb

@@ -1,3 +1,3 @@
 module Steering
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/test/fixtures/bar.hb

@@ -0,0 +1 @@
+Hello {{ name }}

data/test/fixtures/foo.hb

@@ -0,0 +1 @@
+Hello {{ name }}

data/test/fixtures/hello.handlebars

@@ -0,0 +1 @@
+Hello {{ name }}

data/test/steering_test.rb

@@ -3,11 +3,14 @@ require "stringio"
 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
+  FIXTURE_PATH                = File.expand_path("../fixtures", __FILE__)
+  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_PARTIAL                  = /Handlebars\.registerPartial\('\w+',\sHandlebars\.templates\['\w+'\]\);/
+  HB_TEMPLATE_PATTERN         = /^\n#{HB_PREAMBLE}\n#{HB_ASSIGNMENT}\s*#{HB_TEMPLATE}\s*$/m
+  HB_TEMPLATE_PATTERN_PARTIAL = /^\n#{HB_PREAMBLE}\n#{HB_ASSIGNMENT}\s*#{HB_TEMPLATE}\n#{HB_PARTIAL}\n*$/m
 
   def test_version
     assert_equal Steering::Source::VERSION, Steering.version
@@ -29,8 +32,8 @@ class SteeringTest < Test::Unit::TestCase
   end
 
   def test_compile_file
-    file = "example/mytemplate.handlebars"
-    compiled_file = "example/mytemplate.js"
+    file = fixture_path("hello.handlebars")
+    compiled_file = fixture_path("hello.js")
 
     Steering.compile_to_file(file, compiled_file)
     compiled_source = File.read(compiled_file)
@@ -40,6 +43,42 @@ class SteeringTest < Test::Unit::TestCase
     File.delete(compiled_file) if File.exists?(compiled_file)
   end
 
+  def test_compile_file_extension
+    file = fixture_path("foo.hb")
+    compiled_file = fixture_path("foo.js")
+
+    Steering.compile_to_file(file, compiled_file, ".hb")
+    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_compile_file_extension_option
+    file = fixture_path("bar.hb")
+    compiled_file = fixture_path("bar.js")
+
+    Steering.compile_to_file(file, compiled_file, :extension => ".hb")
+    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_compile_file_partial
+    file = fixture_path("hello.handlebars")
+    compiled_file = fixture_path("hello.js")
+
+    Steering.compile_to_file(file, compiled_file, :partial => true)
+    compiled_source = File.read(compiled_file)
+
+    assert_match HB_TEMPLATE_PATTERN_PARTIAL, 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")
@@ -59,4 +98,10 @@ class SteeringTest < Test::Unit::TestCase
       assert_equal "bar", e.message
     end
   end
+
+  private
+
+  def fixture_path(path)
+    File.join(FIXTURE_PATH, path)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steering
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -61,6 +61,9 @@ files:
 - lib/steering.rb
 - lib/steering/version.rb
 - steering.gemspec
+- test/fixtures/bar.hb
+- test/fixtures/foo.hb
+- test/fixtures/hello.handlebars
 - test/steering_test.rb
 homepage: https://github.com/pixeltrix/steering
 licenses: []
@@ -76,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1384459607151128044
+      hash: 113054895620168692
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1384459607151128044
+      hash: 113054895620168692
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -93,4 +96,7 @@ signing_key:
 specification_version: 3
 summary: Ruby Handlebars.js Compiler
 test_files:
+- test/fixtures/bar.hb
+- test/fixtures/foo.hb
+- test/fixtures/hello.handlebars
 - test/steering_test.rb