handlebars-amd-rails 1.0.0.rc.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.jshintrc

@@ -0,0 +1,27 @@
+{
+    // default settings
+    "forin"             : true,
+    "noarg"             : true,
+    "noempty"           : true,
+    "eqeqeq"            : true,
+    "bitwise"           : true,
+    "strict"            : true,
+    "undef"             : true,
+    "curly"             : true,
+    "browser"           : true,
+    "indent"            : 4,
+    "maxerr"            : 50,
+    "white"             : true,
+    "newcap"            : true,
+    "expr"              : true,
+
+    // project specific
+    "browser"           : true,
+
+    // globals
+    "predef": {
+        // vendor
+        "require"       : true,
+        "define"        : true,
+    }
+}

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--order random

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in handlebars-amd-rails.gemspec
+gemspec
+
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steffen Leistner
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,169 @@
+# Handlebars Amd Rails
+
+Use Handlebars templates wrapped in a AMD define block, with the asset pipeline in Rails 3.1+ applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :assets do
+  gem 'handlebars-amd-rails'
+end
+```
+
+Update your bundle:
+
+```
+$ bundle install
+```
+
+Require handlebars.js in your AMD config file
+
+```javascript
+{
+    paths: {
+        "handlebars": "handlebars-runtime"
+    }
+}
+```
+
+## Usage
+
+Place individual Handlebars template file in their own file with template_name.{hbs, handlebars} extension.
+
+```
+/* app/assets/javascripts/templates/demo.hbs */
+
+Hello {{name}}! You have {{count}} new messages.
+```
+
+Which will be compiled and rendered as:
+
+```javascript
+define(['handlebars'], function(Handlebars) {
+    var templates = Handlebars.templates || (Handlebars.templates = {});
+    return templates['demo'] = Handlebars.template(function (Handlebars,depth0,helpers,partials,data) {
+        helpers = helpers || Handlebars.helpers; data = data || {};
+        return "Hello {{name}}! You have {{count}} new messages.";
+    });
+});
+```
+
+You can take advantage of the asset pipeline by chaining your template through other processors like haml:
+
+```
+/* app/assets/javascripts/templates/demo.hbs.haml */
+
+%p.welcome
+  Hello {{name}}! You have {{count}} new messages.
+```
+
+Which will be compiled and rendered as:
+
+```javascript
+define(['handlebars'], function(Handlebars) {
+    var templates = Handlebars.templates || (Handlebars.templates = {});
+    return templates['demo'] = Handlebars.template(function (Handlebars,depth0,helpers,partials,data) {
+        helpers = helpers || Handlebars.helpers; data = data || {};
+        return "<p class='welcome'>Hello {{name}}! You have {{count}} new messages.</p>";
+    });
+});
+```
+
+You may need to require the haml_assets gem:
+
+```ruby
+group :assets do
+  gem 'haml_assets'
+end
+```
+
+Using templates:
+
+```javascript
+require([
+    'jquery',
+    'template!demo'
+], function ($, template) {
+    $('body').html(template({
+        name: 'Joe', count: 10
+    }))
+});
+```
+
+If the template renders partials, partial files need to be required:
+
+```
+/* app/assets/javascripts/templates/demo.hbs */
+
+{{>_header}}
+
+Hello {{name}}! You have {{count}} new messages.
+```
+
+```
+/* app/assets/javascripts/templates/_header.hbs */
+
+%header
+  Hola!
+```
+
+```javascript
+require([
+    'jquery',
+    'template!demo',
+    'partial!_header',
+], function ($, template) {
+    $('body').html(template({
+        name: 'Joe', count: 10
+    }))
+});
+```
+
+## Sample Code
+
+Find a demo application at [https://github.com/sleistner/handlebars-amd-rails-example](https://github.com/sleistner/handlebars-amd-rails-example)
+
+## Config
+
+Handlebars-amd-rails resolves the name of the template out of relative path of each template file. Relative path starts from app/assets/javascripts/templates/ by default.
+
+If you want to change the default root path of template files, add following configuration into application.rb:
+
+```ruby
+# config/application.rb
+module YourApp
+  class Application < Rails::Application
+    config.handlebars.template_root = 'app/assets/your_path_to_templates/'
+  end
+end
+```
+
+You can pass arbitrary option parameters to the handlebars compiler:
+
+```ruby
+# config/application.rb
+module YourApp
+  class Application < Rails::Application
+    config.handlebars.data = false
+  end
+end
+```
+
+## Credits
+
+I shamelessly borrowed code from the following sources:
+
+* [https://github.com/thefron/dust-rails](https://github.com/thefron/dust-rails)
+* [https://github.com/leshill/handlebars_assets](https://github.com/leshill/handlebars_assets)
+
+Thanks guys!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/handlebars-amd-rails.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'handlebars-amd-rails/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "handlebars-amd-rails"
+  gem.version       = Handlebars::Amd::Rails::VERSION
+  gem.authors       = ["Steffen Leistner"]
+  gem.email         = ["sleistner@gmail.com"]
+  gem.summary       = %q{Use Handlebars templates wrapped in a AMD define block with rails.}
+  gem.description   = %q{Use Handlebars templates wrapped in a AMD define block, with the asset pipeline in Rails 3.1+ applications.}
+  gem.homepage      = "https://github.com/sleistner/handlebars-amd-rails"
+
+  gem.rubyforge_project = "handlebars-amd-rails"
+
+  gem.add_dependency('rails', '> 3.1.0')
+  gem.add_dependency('tilt')
+  gem.add_dependency('execjs')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/handlebars-amd-rails/rails/engine.rb

@@ -0,0 +1,14 @@
+require "rails/engine"
+
+module Handlebars
+  module Amd
+    module Rails
+      class Engine < ::Rails::Engine
+        initializer :register_handlebars do |app|
+          app.assets.register_engine '.hbs', Template
+          app.assets.register_engine '.handlebars', Template
+        end
+      end
+    end
+  end
+end

data/lib/handlebars-amd-rails/rails/railtie.rb

@@ -0,0 +1,20 @@
+require 'rails'
+
+module Handlebars
+  module Amd
+    module Rails
+      class Railtie < ::Rails::Railtie
+
+        DEFAULT_TEMPLATE_ROOT = 'app/assets/javascripts/templates/'
+
+        config.handlebars = ActiveSupport::OrderedOptions.new
+
+        initializer "handlebars.configure" do |app|
+          Handlebars.configure do |config|
+            config.template_root = app.config.handlebars[:template_root] || DEFAULT_TEMPLATE_ROOT
+          end
+        end
+      end
+    end
+  end
+end

data/lib/handlebars-amd-rails/rails/template.rb

@@ -0,0 +1,68 @@
+require 'tilt'
+require 'execjs'
+
+module Handlebars
+
+  module Unindent
+    def unindent(heredoc)
+      heredoc.gsub(/^#{heredoc[/\A\s*/]}/, '')
+    end
+  end
+
+  module Amd
+    module Rails
+
+      module Source
+
+        def self.path
+          @path ||= File.expand_path("../../../../vendor/assets/javascripts/handlebars.js", __FILE__)
+        end
+
+        def self.contents
+          @contents ||= File.read(path)
+        end
+
+        def self.context
+          @context ||= ExecJS.compile(contents)
+        end
+
+      end
+
+      class Template < ::Tilt::Template
+
+        include Unindent
+
+        def self.default_mime_type
+          'application/javascript'
+        end
+
+        def prepare
+        end
+
+        def evaluate(scope, locals, &block)
+          template = Source.context.call("Handlebars.precompile", data, Handlebars.config.to_camelcase)
+          interpolate(template)
+        end
+
+        private
+
+        def interpolate(template)
+          unindent <<-JS
+            define(['handlebars'], function(Handlebars) {
+              var templates = Handlebars.templates || (Handlebars.templates = {});
+              return templates['#{template_name}'] = Handlebars.template(#{template});
+            });
+          JS
+        end
+
+        def template_name
+          @template_name ||= begin
+            template_root = Handlebars.config.template_root
+            file.split(template_root).last.split('.', 2).first
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/handlebars-amd-rails/version.rb

@@ -0,0 +1,7 @@
+module Handlebars
+  module Amd
+    module Rails
+      VERSION = "1.0.0.rc.3"
+    end
+  end
+end

data/lib/handlebars-amd-rails.rb

@@ -0,0 +1,27 @@
+require 'handlebars-amd-rails/version'
+require 'handlebars-amd-rails/rails/template'
+require 'handlebars-amd-rails/rails/engine'
+require 'handlebars-amd-rails/rails/railtie'
+require 'ostruct'
+
+module Handlebars
+
+  class Config < OpenStruct
+
+    def to_camelcase
+      instance_variable_get(:@table).inject({}) do |memo, (key, value)|
+        memo[key.to_s.camelcase(:lower)] = value
+        memo
+      end
+    end
+
+  end
+
+  def self.config
+    @@config ||= Config.new
+  end
+
+  def self.configure
+    yield self.config
+  end
+end

data/spec/fixtures/demo.hbs

@@ -0,0 +1 @@
+hello {name}!

data/spec/handlebars_spec.rb

@@ -0,0 +1,19 @@
+require_relative './spec_helper'
+
+describe Handlebars::Config do
+
+  it 'can receive arbitrary options' do
+    subject.foo = :bar
+    subject.foo.should == :bar
+  end
+
+  describe '#to_camelcase' do
+
+    it 'transforms keys to camelcase' do
+      subject.foo_bar = :baz
+      subject.to_camelcase.should == { 'fooBar' => :baz }
+    end
+
+  end
+
+end

data/spec/helper/handlebars.js

@@ -0,0 +1,5 @@
+Handlebars = {
+    precompile: function () {
+        return '"Precompiled!"';
+    }
+};

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'handlebars-amd-rails'
+
+include Handlebars::Unindent
+
+def fixtures_path
+  @fixtures_path ||= File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture_path(name)
+  "#{fixtures_path}/#{name}"
+end
+
+def helper_path
+  @helper_path ||= File.expand_path('../helper', __FILE__)
+end
+
+def helper(name)
+  File.new("#{helper_path}/#{name}")
+end

data/spec/template_spec.rb

@@ -0,0 +1,28 @@
+require_relative './spec_helper'
+
+describe Handlebars::Amd::Rails::Template do
+
+  subject do
+    Handlebars::Amd::Rails::Template.new(fixture_path('demo.hbs'))
+  end
+
+  describe '#evaluate' do
+
+    before do
+      Handlebars.config.template_root = fixtures_path + '/'
+      Handlebars::Amd::Rails::Source.stub(:path).and_return(helper('handlebars.js'))
+    end
+
+    it 'compiles a template wrapped in a define block' do
+      expected = unindent <<-JS
+        define(['handlebars'], function(Handlebars) {
+          var templates = Handlebars.templates || (Handlebars.templates = {});
+          return templates['demo'] = Handlebars.template("Precompiled!");
+        });
+      JS
+      subject.evaluate(nil, nil).should == expected
+    end
+
+  end
+
+end