handlebars_assets 0.6.7 → 0.7.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.7.0 (2012-11-16)
+
+* Support `.hamlbars` extension and Haml
+
 ## 0.6.7 (2012-11-11)
 
 * Support `.handlebars` extension - @BlakeWilliams

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    handlebars_assets (0.6.7)
+    handlebars_assets (0.7.0)
       execjs (>= 1.2.9)
       sprockets (>= 2.0.3)
       tilt
@@ -11,6 +11,7 @@ GEM
   specs:
     execjs (1.4.0)
       multi_json (~> 1.0)
+    haml (3.1.7)
     hike (1.2.1)
     multi_json (1.3.6)
     rack (1.4.1)
@@ -26,5 +27,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  haml
   handlebars_assets!
   rake

data/README.md

@@ -1,6 +1,6 @@
 # Use handlebars.js templates with the asset pipeline and sprockets
 
-Are your `handlebars.js` templates littering your Rails views with `script` tags? Wondering why the nifty Rails 3.1 asset pipeline streamlines all your Javascript except for your Handlebars templates? Wouldn't it be nice to have your Handlebars templates compiled, compressed, and cached like your other Javascript?
+Are your `handlebars.js` templates littering your Rails views with `script` tags? Wondering why the nifty Rails 3.1 asset pipeline streamlines all your JavaScript except for your Handlebars templates? Wouldn't it be nice to have your Handlebars templates compiled, compressed, and cached like your other JavaScript?
 
 Yea, I think so too. That is why I wrote **handlebars_assets**. Give your Handlebars templates their own files (including partials) and have them compiled, compressed, and cached as part of the Rails 3.1 asset pipeline!
 
@@ -36,13 +36,13 @@ for the next steps to work.
     env.append_path HandlebarsAssets.path
 
 
-# Compiling your Javascript templates in the Rails asset pipeline
+# Compiling your JavaScript templates in the Rails asset pipeline
 
-Require `handlebars.runtime.js` in your Javascript manifest (i.e. `application.js`)
+Require `handlebars.runtime.js` in your JavaScript manifest (i.e. `application.js`)
 
     //= require handlebars.runtime
 
-If you need to compile your Javascript templates in the browser as well, you should instead require `handlebars.js` (which is significantly larger)
+If you need to compile your JavaScript templates in the browser as well, you should instead require `handlebars.js` (which is significantly larger)
 
     //= require handlebars
 
@@ -54,7 +54,7 @@ If you need to compile your Javascript templates in the browser as well, you sho
 
 ## Templates directory
 
-You should locate your templates with your other assets, for example `app/assets/javascripts/templates`. In your Javascript manifest file, use `require_tree` to pull in the templates
+You should locate your templates with your other assets, for example `app/assets/javascripts/templates`. In your JavaScript manifest file, use `require_tree` to pull in the templates
 
     //= require_tree ./templates
 
@@ -72,23 +72,39 @@ For example, if you have new, edit, and show templates for a Contact model
 
 Your file extensions tell the asset pipeline how to process the file. Use `.hbs` to compile the template with Handlebars.
 
-If your file is `templates/contacts/new.hbs`, the asset pipeline will generate Javascript code
+If your file is `templates/contacts/new.hbs`, the asset pipeline will generate JavaScript code
 
-1. Compile the Handlebars template to Javascript code
+1. Compile the Handlebars template to JavaScript code
 1. Add the template code to the `HandlebarsTemplates` global under the name `contacts/new`
 
-You can then invoke the resulting template in your application's Javascript
+You can then invoke the resulting template in your application's JavaScript
 
     HandlebarsTemplates['contacts/new'](context);
 
 ## The template namespace
 
-By default, the global Javascript object that holds the compiled templates is `HandlebarsTemplates`, but it can
+By default, the global JavaScript object that holds the compiled templates is `HandlebarsTemplates`, but it can
 be easily renamed. Another common template namespace is `JST`.  Just change the `template_namespace` configuration option
 when you initialize your application.
 
     HandlebarsAssets::Config.template_namespace = 'JST'
 
+## `.hamlbars`
+
+If you name your templates with the extension `.hamlbars`, you can use Haml syntax for your markup! Use `HandlebarsAssets::Config.haml_options` to pass custom options to the Haml rendering engine.
+
+For example, if you have a file `widget.hamlbars` that looks like this:
+
+    %h1 {{title}}
+    %p {{body}}
+
+Haml will first convert it to:
+
+    <h1> {{title}} </h1>
+    <p> {{body}} </p>
+
+And the Handlebars will turn it into a JavaScript template.
+
 ## Partials
 
 If you begin the name of the template with an underscore, it will be recognized as a partial. You can invoke partials inside a template using the Handlebars partial syntax:

data/handlebars_assets.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "tilt"
   s.add_runtime_dependency "sprockets", ">= 2.0.3"
   s.add_development_dependency "rake"
+  s.add_development_dependency "haml"
 end

data/lib/handlebars_assets/config.rb

@@ -5,7 +5,7 @@ module HandlebarsAssets
   module Config
     extend self
 
-    attr_writer :compiler, :compiler_path, :known_helpers, :known_helpers_only, :options, :path_prefix, :template_namespace
+    attr_writer :compiler, :compiler_path, :haml_options, :known_helpers, :known_helpers_only, :options, :path_prefix, :template_namespace
 
     def compiler
       @compiler || 'handlebars.js'
@@ -15,6 +15,14 @@ module HandlebarsAssets
       @compiler_path || HandlebarsAssets.path
     end
 
+    def haml_available?
+      defined? ::Haml::Engine
+    end
+
+    def haml_options
+      @haml_options || {}
+    end
+
     def known_helpers
       @known_helpers || []
     end

data/lib/handlebars_assets/engine.rb

@@ -4,6 +4,7 @@ module HandlebarsAssets
       next unless app.assets
       app.assets.register_engine('.hbs', TiltHandlebars)
       app.assets.register_engine('.handlebars', TiltHandlebars)
+      app.assets.register_engine('.hamlbars', TiltHandlebars) if HandlebarsAssets::Config.haml_available?
     end
   end
 end

data/lib/handlebars_assets/tilt_handlebars.rb

@@ -2,6 +2,7 @@ require 'tilt'
 
 module HandlebarsAssets
   class TiltHandlebars < Tilt::Template
+
     def self.default_mime_type
       'application/javascript'
     end
@@ -9,7 +10,13 @@ module HandlebarsAssets
     def evaluate(scope, locals, &block)
       template_path = TemplatePath.new(scope)
 
-      compiled_hbs = Handlebars.precompile(data, HandlebarsAssets::Config.options)
+      source = if template_path.is_haml?
+                Haml::Engine.new(data, HandlebarsAssets::Config.haml_options).render
+               else
+                 data
+               end
+
+      compiled_hbs = Handlebars.precompile(source, HandlebarsAssets::Config.options)
 
       template_namespace = HandlebarsAssets::Config.template_namespace
 
@@ -30,15 +37,26 @@ module HandlebarsAssets
       end
     end
 
+    def initialize_engine
+      require_template_library 'haml'
+    rescue LoadError
+      # haml not available
+    end
+
     protected
 
     def prepare; end
 
     class TemplatePath
       def initialize(scope)
+        self.full_path = scope.pathname
         self.template_path = scope.logical_path
       end
 
+      def is_haml?
+        full_path.to_s.end_with?('.hamlbars')
+      end
+
       def is_partial?
         template_path.gsub(%r{.*/}, '').start_with?('_')
       end
@@ -49,7 +67,7 @@ module HandlebarsAssets
 
       private
 
-      attr_accessor :template_path
+      attr_accessor :full_path, :template_path
 
       def forced_underscore_name
         '_' + relative_path

data/lib/handlebars_assets/version.rb

@@ -1,3 +1,3 @@
 module HandlebarsAssets
-  VERSION = "0.6.7"
+  VERSION = "0.7.0"
 end

data/test/handlebars_assets/hamlbars_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+module HandlebarsAssets
+  class TiltHandlebarsTest < Test::Unit::TestCase
+    include SprocketsScope
+
+    def expected_haml_compiled(source)
+      Haml::Engine.new(source, HandlebarsAssets::Config.haml_options).render
+    end
+
+    def expected_hbs_compiled(source)
+      compiler_src = Pathname(HandlebarsAssets::Config.compiler_path).join(HandlebarsAssets::Config.compiler).read
+      ExecJS.compile(compiler_src).call('Handlebars.precompile', source, HandlebarsAssets::Config.options)
+    end
+
+    def haml_compiled(template_name, source)
+      compiled_haml = expected_haml_compiled(source)
+      compiled_hbs = expected_hbs_compiled(compiled_haml)
+      template_namespace = HandlebarsAssets::Config.template_namespace
+
+      <<END_EXPECTED
+          (function() {
+            this.#{template_namespace} || (this.#{template_namespace} = {});
+            this.#{template_namespace}[#{template_name.dump}] = Handlebars.template(#{compiled_hbs});
+            return this.#{template_namespace}[#{template_name.dump}];
+          }).call(this);
+END_EXPECTED
+    end
+
+    def teardown
+      HandlebarsAssets::Config.reset!
+      HandlebarsAssets::Handlebars.reset!
+    end
+
+    def test_render_haml
+      root = '/myapp/app/assets/templates'
+      file = 'test_render.hamlbars'
+      scope = make_scope root, file
+      source = "%p This is {{handlebars}}"
+
+      template = HandlebarsAssets::TiltHandlebars.new(scope.pathname.to_s) { source }
+
+      assert_equal haml_compiled('test_render', source), template.render(scope, {})
+    end
+  end
+end

data/test/test_helper.rb

@@ -25,6 +25,7 @@ module HandlebarsAssets
     def reset!
       @compiler = nil
       @compiler_path = nil
+      @haml_options = nil
       @known_helpers = nil
       @known_helpers_only = nil
       @options = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: handlebars_assets
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Compile Handlebars templates in the Rails asset pipeline.
 email:
 - leshill@gmail.com
@@ -98,6 +114,7 @@ files:
 - lib/handlebars_assets/tilt_handlebars.rb
 - lib/handlebars_assets/version.rb
 - test/edge/handlebars.js
+- test/handlebars_assets/hamlbars_test.rb
 - test/handlebars_assets/tilt_edge_test.rb
 - test/handlebars_assets/tilt_handlebars_test.rb
 - test/test_helper.rb
@@ -129,6 +146,7 @@ specification_version: 3
 summary: Compile Handlebars templates in the Rails asset pipeline.
 test_files:
 - test/edge/handlebars.js
+- test/handlebars_assets/hamlbars_test.rb
 - test/handlebars_assets/tilt_edge_test.rb
 - test/handlebars_assets/tilt_handlebars_test.rb
 - test/test_helper.rb