hogan_assets 1.3.1 → 1.3.2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.3.2 (2012-08-04)
+
+* Use `HoganAssets::Config.path\_prefix` to strip a common path prefix from your template names
+
 ## 1.3.1 (2012-06-21)
 
 * #11 - Fix **hamstache** support, broken in 1.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hogan_assets (1.3.1)
+    hogan_assets (1.3.2)
       execjs (>= 1.2.9)
       sprockets (>= 2.0.3)
       tilt (>= 1.3.3)

data/README.md

@@ -29,7 +29,7 @@ Require your templates with `require_tree`:
 
     //= require_tree ./templates
 
-Templates are named for the sub-path from your manifest with `require_tree`. For example, the file `app/assets/javascripts/templates/pages/person.mustache` will be named `templates/pages/person`. _(TODO: make this nicer)_
+Templates are named for the sub-path from your manifest with `require_tree`. For example, the file `app/assets/javascripts/templates/pages/person.mustache` will be named `templates/pages/person`. See `path_prefix` below!
 
 ### Installation with sprockets
 
@@ -43,8 +43,6 @@ And then execute:
 
 Require `hogan.js` somewhere in your JavaScript.
 
-*TODO* Templates?
-
 ## Hamstache!
 
 _hamstache_ is the quite popular combination of `haml` and `mustache`, a more robust solution exists using [haml_assets](https://github.com/infbio/haml_assets), but if all you want is nicer markup, you need to take these two additional steps:
@@ -61,22 +59,38 @@ And then execute:
 
 ## Configuration
 
-### Template Extensions
+### Lambda Support
 
-**HoganAssets** recognizes templates ending in `.mustache` and if you have haml available, `.hamstache`. You can change the template extensions by setting the `template_extensions` configuration option in an initializer:
+**mustache** lambdas are off by default. (Not sure what that is? Read the [mustache](http://mustache.github.com/mustache.5.html) man page!) If you want them on, set the `lambda_support` option to true. This will include the raw template text as part of the compiled template; each template will be correspondingly larger. *TODO* Should this be on by default?
 
     HoganAssets::Config.configure do |config|
-      config.template_extensions = %w(mustache hamstache stache)
+      config.lambda_support = true
     end
 
-### Lambda Support
+### Path Prefix
+
+You can strip a prefix from your template names. For example, when using Rails, if you place your templates in `app/assets/javascripts/app/templates` and organize them like Rails views (i.e. `posts/index.mustache`); then the `index.mustache` template gets compiled into:
 
-**HoganAssets** supports **mustache** lambdas. Set the `lambda_support` option to true to enable lambdas for your templates. This will include the raw template text as part of the compiled template; each template will be correspondingly larger.
+    HoganTemplates['app/templates/posts/index']
 
-*TODO* Should this be on by default?
+You can strip the common part of the template name by setting the `path_prefix` option.  For example:
 
     HoganAssets::Config.configure do |config|
-      config.lambda_support = true
+      config.path_prefix = 'app/templates'
+    end
+
+will give you a compiled template:
+
+    HoganTemplates['posts/index']
+
+*TODO* Can this be done in a nicer way?
+
+### Template Extensions
+
+By default, templates are recognized if they have an extension of `.mustache` (and if you have haml available, `.hamstache`.) You can change the template extensions by setting the `template_extensions` configuration option in an initializer:
+
+    HoganAssets::Config.configure do |config|
+      config.template_extensions = %w(mustache hamstache stache)
     end
 
 ## Usage

data/lib/hogan_assets/config.rb

@@ -6,23 +6,32 @@ module HoganAssets
   # Or in a block:
   #
   # HoganAssets::Config.configure do |config|
-  #   config.template_extensions = ['mustache']
-  #   config.lambda_support = true
+  #   config.lambda_support = false
+  #   config.path_prefix = 'templates'
+  #   config.template_extensions = ['mustache', 'hamstache']
   # end
-
+  #
   module Config
     extend self
 
+    attr_writer :lambda_support, :path_prefix, :template_extensions
+
     def configure
       yield self
     end
 
-    attr_writer :lambda_support, :template_extensions
+    def haml_available?
+      defined? ::Haml::Engine
+    end
 
     def lambda_support?
       @lambda_support
     end
 
+    def path_prefix
+      @path_prefix ||= 'templates'
+    end
+
     def template_extensions
       @template_extensions ||= if haml_available?
                                  ['mustache', 'hamstache']
@@ -30,9 +39,5 @@ module HoganAssets
                                  ['mustache']
                                end
     end
-
-    def haml_available?
-      defined? ::Haml::Engine
-    end
   end
 end

data/lib/hogan_assets/tilt.rb

@@ -11,8 +11,10 @@ module HoganAssets
     end
 
     def evaluate(scope, locals, &block)
-      text = if scope.pathname.extname == '.hamstache'
-        raise "Unable to complile #{scope.pathname} because haml is not available. Did you add the haml gem?" unless HoganAssets::Config.haml_available?
+      template_path = TemplatePath.new scope
+
+      text = if template_path.is_hamstache?
+        raise "Unable to complile #{template_path.full_path} because haml is not available. Did you add the haml gem?" unless HoganAssets::Config.haml_available?
         Haml::Engine.new(data, @options).render
       else
         data
@@ -25,12 +27,37 @@ module HoganAssets
       text = '' unless HoganAssets::Config.lambda_support?
       <<-TEMPLATE
         this.HoganTemplates || (this.HoganTemplates = {});
-        this.HoganTemplates[#{template_name}] = new Hogan.Template(#{compiled_template}, #{text.inspect}, Hogan, {});
+        this.HoganTemplates[#{template_path.name}] = new Hogan.Template(#{compiled_template}, #{text.inspect}, Hogan, {});
       TEMPLATE
     end
 
     protected
 
     def prepare; end
+
+    class TemplatePath
+      attr_accessor :full_path
+
+      def initialize(scope)
+        self.template_path = scope.logical_path
+        self.full_path = scope.pathname
+      end
+
+      def is_hamstache?
+        full_path.to_s.end_with? '.hamstache'
+      end
+
+      def name
+        @name ||= relative_path.dump
+      end
+
+      private
+
+      attr_accessor :template_path
+
+      def relative_path
+        @relative_path ||= template_path.gsub(/^#{HoganAssets::Config.path_prefix}\/(.*)$/i, "\\1")
+      end
+    end
   end
 end

data/lib/hogan_assets/version.rb

@@ -1,3 +1,3 @@
 module HoganAssets
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/test/hogan_assets/tilt_test.rb

@@ -2,16 +2,22 @@ require 'test_helper'
 
 module HoganAssets
   class TiltTest < Test::Unit::TestCase
-    def scope(path)
-      instance = Class.new do
-        attr_accessor :_path
+   # Try to act like sprockets.
+    def make_scope(root, file)
+      Class.new do
+        define_method(:logical_path) { pathname.to_s.gsub(root + '/', '').gsub(/\..*/, '') }
 
-        def logical_path ; _path.gsub /\..*/, '' ; end
+        define_method(:pathname) { Pathname.new(root) + file }
 
-        def pathname ; Pathname.new _path ; end
+        define_method(:root_path) { root }
+
+        define_method(:s_path) { pathname.to_s }
       end.new
-      instance._path = path
-      instance
+    end
+
+    def teardown
+      HoganAssets::Config.lambda_support = false
+      HoganAssets::Config.path_prefix = 'templates'
     end
 
     def test_mime_type
@@ -19,31 +25,55 @@ module HoganAssets
     end
 
     def test_render
-      path = 'path/to/template.mustache'
-      template = HoganAssets::Tilt.new(path) { "This is {{mustache}}" }
-      assert_equal <<-END_EXPECTED, template.render(scope(path), {})
+      scope = make_scope '/myapp/app/assets/javascripts', 'path/to/template.mustache'
+
+      template = HoganAssets::Tilt.new(scope.s_path) { "This is {{mustache}}" }
+
+      assert_equal <<-END_EXPECTED, template.render(scope, {})
         this.HoganTemplates || (this.HoganTemplates = {});
         this.HoganTemplates[\"path/to/template\"] = new Hogan.Template({code: function (c,p,i) { var t=this;t.b(i=i||\"\");t.b(\"This is \");t.b(t.v(t.f(\"mustache\",c,p,0)));return t.fl(); },partials: {}, subs: {  }}, "", Hogan, {});
       END_EXPECTED
     end
 
     def test_hamstache_render
-      path = 'path/to/template.hamstache'
-      template = HoganAssets::Tilt.new(path) { "%p This is {{hamstache}}" }
-      assert_equal <<-END_EXPECTED, template.render(scope(path), {})
+      scope = make_scope '/myapp/app/assets/javascripts', 'path/to/template.hamstache'
+
+      template = HoganAssets::Tilt.new(scope.s_path) { "%p This is {{hamstache}}" }
+
+      assert_equal <<-END_EXPECTED, template.render(scope, {})
         this.HoganTemplates || (this.HoganTemplates = {});
         this.HoganTemplates[\"path/to/template\"] = new Hogan.Template({code: function (c,p,i) { var t=this;t.b(i=i||\"\");t.b(\"<p>This is \");t.b(t.v(t.f(\"hamstache\",c,p,0)));t.b(\"</p>\");t.b(\"\\n\");return t.fl(); },partials: {}, subs: {  }}, \"\", Hogan, {});
       END_EXPECTED
     end
 
     def test_render_with_lambdas
-      path = 'path/to/template.mustache'
-      HoganAssets::Config.lambda_support = true
-      template = HoganAssets::Tilt.new(path) { "This is {{mustache}}" }
-      assert_equal <<-END_EXPECTED, template.render(scope(path), {})
+      HoganAssets::Config.configure do |config|
+        config.lambda_support = true
+      end
+
+      scope = make_scope '/myapp/app/assets/javascripts', 'path/to/template.mustache'
+
+      template = HoganAssets::Tilt.new(scope.s_path) { "This is {{mustache}}" }
+
+      assert_equal <<-END_EXPECTED, template.render(scope, {})
         this.HoganTemplates || (this.HoganTemplates = {});
         this.HoganTemplates[\"path/to/template\"] = new Hogan.Template({code: function (c,p,i) { var t=this;t.b(i=i||\"\");t.b(\"This is \");t.b(t.v(t.f(\"mustache\",c,p,0)));return t.fl(); },partials: {}, subs: {  }}, "This is {{mustache}}", Hogan, {});
       END_EXPECTED
     end
+
+    def test_path_prefix
+      HoganAssets::Config.configure do |config|
+        config.path_prefix = 'app/templates'
+      end
+
+      scope = make_scope '/myapp/app/assets/javascripts', 'app/templates/template.mustache'
+
+      template = HoganAssets::Tilt.new(scope.s_path) { "This is {{mustache}}" }
+
+      assert_equal <<-END_EXPECTED, template.render(scope, {})
+        this.HoganTemplates || (this.HoganTemplates = {});
+        this.HoganTemplates[\"template\"] = new Hogan.Template({code: function (c,p,i) { var t=this;t.b(i=i||\"\");t.b(\"This is \");t.b(t.v(t.f(\"mustache\",c,p,0)));return t.fl(); },partials: {}, subs: {  }}, "", Hogan, {});
+      END_EXPECTED
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hogan_assets
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-21 00:00:00.000000000 Z
+date: 2012-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs