handlebars_assets 0.5.0 → 0.6.1

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.6.1 (2012-07-23)
+
+* #26 - Missing require
+
+## 0.6.0 (yanked)
+
+* #25 - Normalize partial names to begin with an underscore
+
 ## 0.5.0 (2012-07-10)
 
-* #24 - Remove "templates/" from template names - @cw-moshe
+* #24 - Remove "templates/" from template names and expand partial paths into names - @cw-moshe

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    handlebars_assets (0.5.0)
+    handlebars_assets (0.6.1)
       execjs (>= 1.2.9)
       sprockets (>= 2.0.3)
       tilt

data/README.md

@@ -87,14 +87,17 @@ If you begin the name of the template with an underscore, it will be recognized
 
     Invoke a {{> partial }}
 
-**Important!** Handlebars does not understand nested partials and neither does this engine. No matter how nested, the partial is named from the asset's basename. The following will lead to much frustration (so don't do it :)
+**Important!** Handlebars does not understand nested partials. To support them, partials are named based on their path using `_` instead `/` (skid => slash). So given:
 
     templates/
+      _form.hbs
       contacts/
         _form.hbs
       todos/
         _form.hbs
 
+You will get three partials named `_form`, `_contacts_form`, and `_todos_form`; note that the partials begin with `_`.
+
 # Thanks
 
 This gem is standing on the shoulders of giants.

data/lib/handlebars_assets/config.rb

@@ -0,0 +1,25 @@
+module HandlebarsAssets
+  # Change config options in an initializer:
+  #
+  # HandlebarsAssets::Config.path_prefix = 'app/templates'
+  #
+  # Or in a block:
+  #
+  # HandlebarsAssets::Config.configure do |config|
+  #   path_prefix = 'app/templates'
+  # end
+
+  module Config
+    extend self
+
+    def configure
+      yield self
+    end
+
+    attr_writer :path_prefix
+
+    def path_prefix
+      @path_prefix ||= 'templates'
+    end
+  end
+end

data/lib/handlebars_assets/tilt_handlebars.rb

@@ -1,3 +1,4 @@
+require 'handlebars_assets/config'
 require 'tilt'
 
 module HandlebarsAssets
@@ -7,24 +8,22 @@ module HandlebarsAssets
     end
 
     def evaluate(scope, locals, &block)
-      name = basename(scope.logical_path)
-      relative_path = scope.logical_path.gsub(/^templates\/(.*)$/i, "\\1")
+      template_path = TemplatePath.new(scope)
+
       compiled_hbs = Handlebars.precompile(data)
 
-      if name.start_with?('_')
-        partial_name = relative_path.gsub(/\//, '_').gsub(/__/, '_').dump
+      if template_path.is_partial?
         <<-PARTIAL
           (function() {
-            Handlebars.registerPartial(#{partial_name}, Handlebars.template(#{compiled_hbs}));
+            Handlebars.registerPartial(#{template_path.name}, Handlebars.template(#{compiled_hbs}));
           }).call(this);
         PARTIAL
       else
-        template_name = relative_path.dump
         <<-TEMPLATE
           (function() {
             this.HandlebarsTemplates || (this.HandlebarsTemplates = {});
-            this.HandlebarsTemplates[#{template_name}] = Handlebars.template(#{compiled_hbs});
-            return HandlebarsTemplates[#{template_name}];
+            this.HandlebarsTemplates[#{template_path.name}] = Handlebars.template(#{compiled_hbs});
+            return HandlebarsTemplates[#{template_path.name}];
           }).call(this);
         TEMPLATE
       end
@@ -32,10 +31,41 @@ module HandlebarsAssets
 
     protected
 
-    def basename(path)
-      path.gsub(%r{.*/}, '')
-    end
-
     def prepare; end
+
+
+    class TemplatePath
+      def initialize(scope)
+        self.template_path = scope.logical_path
+      end
+
+      def is_partial?
+        template_path.gsub(%r{.*/}, '').start_with?('_')
+      end
+
+      def name
+        is_partial? ? partial_name : template_name
+      end
+
+      private
+
+      attr_accessor :template_path
+
+      def forced_underscore_name
+        '_' + relative_path
+      end
+
+      def relative_path
+        template_path.gsub(/^#{HandlebarsAssets::Config.path_prefix}\/(.*)$/i, "\\1")
+      end
+
+      def partial_name
+        forced_underscore_name.gsub(/\//, '_').gsub(/__/, '_').dump
+      end
+
+      def template_name
+        relative_path.dump
+      end
+    end
   end
 end

data/lib/handlebars_assets/version.rb

@@ -1,3 +1,3 @@
 module HandlebarsAssets
-  VERSION = "0.5.0"
+  VERSION = "0.6.1"
 end

data/test/handlebars_assets/tilt_handlebars_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'handlebars_assets/config'
 
 module HandlebarsAssets
   class TiltHandlebarsTest < Test::Unit::TestCase
@@ -13,11 +14,11 @@ module HandlebarsAssets
       end.new
     end
 
-    def hbs_compiled
+    def hbs_compiled(template_name)
       <<END_EXPECTED
           (function() {
             this.HandlebarsTemplates || (this.HandlebarsTemplates = {});
-            this.HandlebarsTemplates["x11"] = Handlebars.template(function (Handlebars,depth0,helpers,partials,data) {
+            this.HandlebarsTemplates["#{template_name}"] = Handlebars.template(function (Handlebars,depth0,helpers,partials,data) {
   helpers = helpers || Handlebars.helpers;
   var buffer = "", stack1, foundHelper, self=this, functionType="function", helperMissing=helpers.helperMissing, undef=void 0, escapeExpression=this.escapeExpression;
 
@@ -29,31 +30,84 @@ module HandlebarsAssets
   else if(stack1=== undef) { stack1 = helperMissing.call(depth0, "handlebars", { hash: {} }); }
   buffer += escapeExpression(stack1);
   return buffer;});
-            return HandlebarsTemplates["x11"];
+            return HandlebarsTemplates["#{template_name}"];
+          }).call(this);
+END_EXPECTED
+    end
+
+    def hbs_compiled_partial(partial_name)
+      <<END_EXPECTED
+          (function() {
+            Handlebars.registerPartial(\"#{partial_name}\", Handlebars.template(function (Handlebars,depth0,helpers,partials,data) {
+  helpers = helpers || Handlebars.helpers;
+  var buffer = \"\", stack1, foundHelper, self=this, functionType=\"function\", helperMissing=helpers.helperMissing, undef=void 0, escapeExpression=this.escapeExpression;
+
+
+  buffer += \"This is \";
+  foundHelper = helpers.handlebars;
+  stack1 = foundHelper || depth0.handlebars;
+  if(typeof stack1 === functionType) { stack1 = stack1.call(depth0, { hash: {} }); }
+  else if(stack1=== undef) { stack1 = helperMissing.call(depth0, \"handlebars\", { hash: {} }); }
+  buffer += escapeExpression(stack1);
+  return buffer;}));
           }).call(this);
 END_EXPECTED
     end
 
     def test_render
       root = '/myapp/app/assets/templates'
-      file = 'x11.hbs'
+      file = 'test_render.hbs'
       scope = make_scope root, file
 
       template = HandlebarsAssets::TiltHandlebars.new(scope.pathname.to_s) { "This is {{handlebars}}" }
 
-      assert_equal hbs_compiled, template.render(scope, {})
+      assert_equal hbs_compiled('test_render'), template.render(scope, {})
     end
 
     # Sprockets does not add nested root paths (i.e.
     # app/assets/javascripts/templates is rooted at app/assets/javascripts)
     def test_template_misnaming
       root = '/myapp/app/assets/javascripts'
-      file = 'templates/x11.hbs'
+      file = 'templates/test_template_misnaming.hbs'
       scope = make_scope root, file
 
       template = HandlebarsAssets::TiltHandlebars.new(scope.pathname.to_s) { "This is {{handlebars}}" }
 
-      assert_equal hbs_compiled, template.render(scope, {})
+      assert_equal hbs_compiled('test_template_misnaming'), template.render(scope, {})
+    end
+
+    def test_path_prefix
+      root = '/myapp/app/assets/javascripts'
+      file = 'app/templates/test_path_prefix.hbs'
+      scope = make_scope root, file
+
+      HandlebarsAssets::Config.path_prefix = 'app/templates'
+
+      template = HandlebarsAssets::TiltHandlebars.new(scope.pathname.to_s) { "This is {{handlebars}}" }
+
+      assert_equal hbs_compiled('test_path_prefix'), template.render(scope, {})
+
+      HandlebarsAssets::Config.path_prefix = nil
+    end
+
+    def test_underscore_partials
+      root = '/myapp/app/assets/javascripts'
+      file1 = 'app/templates/_test_underscore.hbs'
+      scope1 = make_scope root, file1
+      file2 = 'app/templates/some/thing/_test_underscore.hbs'
+      scope2 = make_scope root, file2
+
+      HandlebarsAssets::Config.path_prefix = 'app/templates'
+
+      template1 = HandlebarsAssets::TiltHandlebars.new(scope1.pathname.to_s) { "This is {{handlebars}}" }
+
+      assert_equal hbs_compiled_partial('_test_underscore'), template1.render(scope1, {})
+
+      template2 = HandlebarsAssets::TiltHandlebars.new(scope2.pathname.to_s) { "This is {{handlebars}}" }
+
+      assert_equal hbs_compiled_partial('_some_thing_test_underscore'), template2.render(scope2, {})
+
+      HandlebarsAssets::Config.path_prefix = nil
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: handlebars_assets
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-10 00:00:00.000000000 Z
+date: 2012-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -93,6 +93,7 @@ files:
 - Rakefile
 - handlebars_assets.gemspec
 - lib/handlebars_assets.rb
+- lib/handlebars_assets/config.rb
 - lib/handlebars_assets/engine.rb
 - lib/handlebars_assets/handlebars.rb
 - lib/handlebars_assets/tilt_handlebars.rb