tchak / barber Goto Github PK

handlebars precompilation toolkit

License: MIT License

Ruby 94.40% JavaScript 5.60%

barber's Introduction

Barber

Barber handles all your Handlebars precompilation needs. You can use Barber as part of your project build system or with someting like rake-pipeline.

Installation

Add this line to your application's Gemfile:

gem 'barber'

And then execute:

$ bundle

Or install it yourself as:

$ gem install barber

Usage

You will mainly interact with the utility classes. The utitlity classes delegate to the actual precompiler. They support two primary use cases:

Precompiling individual handlebars files.
Precompiling inline handlebars templates.

Here are some code examples:

require 'barber'

Barber::FilePrecompiler.call(File.read("template.handlebars"))
# "Handlebars.template(function(...));"

Barber::InlinePrecompiler.call(File.read("template.handlebars"))
# Note the missing semicolon. You can use this with gsub to replace
# calls to inline templates
# "Handlebars.template(function(...))"

Barber also packages Ember precompilers.

require 'barber'

Barber::Ember::FilePrecompiler.call(File.read("template.handlebars"))
# "Ember.Handlebars.template(function(...));"

Barber::Ember::InlinePrecompiler.call(File.read("template.handlebars"))
# "Ember.Handlebars.template(function(...))"

Building Custom Precompilers

All of Barber's utility classes (demoed above) delegate to Barber::Precompiler. Barber::Precompiler implements a simple public interface you can use to to build your own. A precompiler simply exposes a Barber.precompile JS property. Override Barber::Precompiler#sources to setup your own. Source must respond to #read. Here is an example:

require 'barber'
require 'stringio'

class CustomPrecompiler < Barber::Precompiler
  def sources
    [StringIO.new(custom_compiler)]
  end

  def custom_compiler
    %Q[var Barber = { precompile: function(template) { return "Hello World!" } };]
  end
end

Usage with rake-pipeline-web-filters

All the utility classes implement call. This means they can be subsituted for procs/lambda where needed. Here's how you can get precompilation of your ember templates with rake-pipeline-web-filters:

require 'barber'

match "**/*.handlebars" do
  handlebars :wrapper_proc => Barber::Ember::FilePrecompiler
end

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

barber's People

Contributors

Stargazers

Watchers

barber's Issues

Barber::PrecompilerError with handlebars 1.1.1

Hi, is emblem.js/barber currently supposed to work with handlebars 1.1.1/2?

I'm seeing this

Pre compilation failed for: = outlet

. Compiler said: TypeError: Cannot read property '3' of undefined
  (in ../assets/javascripts/templates/account.js.emblem)

but I'm unsure how to diagnose it further, as there's no "3" close to that context.
Maybe it's an emblem issue? I opened a similar question there.

Update Gem

I was wondering if it would be possible to release an update of the gem including Handlebars RC4? I believe I'm getting the same problem as emberjs/ember-rails#135, except for RC4.

I'm trying to use rails g ember:install --head with ember-rails and I end up getting this error:

Template was precompiled with an older version of Handlebars than the current runtime. Please update your precompiler to a newer version (>= 1.0.0-rc.4) or downgrade your runtime to an older version (== 1.0.0-rc.3).

Thanks

`ember-template-compiler.js` should be configurable

barber/ember/precompiler.rb should be able to use
an ember-template-compiler.js that exists other than ember-source.

This is related with emberjs/ember-rails#465.

Add support for HTMLBars

With HTMLBars' release imminent, it'll be helpful to add precompiler support so folks who use ember-rails can start testing their apps.

@tchak adding support doesn't look crazy, but I'm still trying to grok how this library works. I can probably put together a pull request with a nudge in the right direction...

Retaining directory name for compiled Ember templates

I have been using Barber to successfully pre-compile my Ember templates, but I am now trying to add resources to my Ember Routing. This means that the templates need to be named 'resource/route'. I have created the correct folders but the EmberPreCompiler ignores the folder and simply names the compiled Ember template according to the name.

Currently a file called /post/details.hbs will precompile to Ember.TEMPLATES['details'] but I need to precompile to Ember.TEMPLATES['post/details']

Is there any way to do this?

HTML comments shouldn't be parsed when pre-compiling templates

I'm using ember-rails to precompile Handlebars templates for our Ember.js app and noticed that HTML comments are being parsed in templates.

This causes Ember to throw the following error if Handlebars tags are present in a comment: "Cannot perform operations on a Metamorph that is not in the DOM."

Here's a snippet from a precompiled template:

data.buffer.push("<!-- ");
hashTypes = {};
stack1 = helpers['if'].call(depth0, "open", {hash:{},inverse:self.program(5, program5, data),fn:self.program(3, program3, data),contexts:[depth0],types:["ID"],hashTypes:hashTypes,data:data});
if(stack1 || stack1 === 0) { data.buffer.push(stack1); }
data.buffer.push(" -->\n");

The expected output would be to have the whole comment pushed verbatim to the buffer.

Thanks!

Patch release?

Can we get a patch release? v0.4.2 will bomb out when an empty string is passed for compilation. master branch is OK. I didn't investigate further to determine if the issue was resolved in Barber or upstream in Handlebars itself. in https://github.com/dockyard/ember-appkit-rails we are generating empty templates by default and the current version of Barber is causing the app to blow up. I'm considering this a blocking issue for the v0.2.0 release of our gem.

Now it is hardly what supporting both Ember.js and raw Handlebars

barber is awesome project for Handlebars precompilation in Ruby world.

Otherwise, Ember.js 1.10.0 uses HTMLBars instead of Handlebars.
So it makes hardly to maintain both supporting compilation for Ember.js and raw Handlebars. (such as #33 )

@tchak
If you don't mind, could you consider extracting Emebr specific code from barber?
(or make barber Ember specific compiler.)

If you would agree with me, I'll work for it .

How to compile against specific versions of Ember with Barber

Currently I'm using barber 0.3.0, my Gemfile looks like

gem 'barber', "~> 0.3.0"

I'd like to update my ember source to 1.0.0-rc.2,
I've seen that ember-source and handlebars-source are dependencies of barber,
But how should I compile against a specific version of Ember(1.0.0-rc.2) and Handlebars(1.0.0-rc.3) with Barber

Handlebars 1.1.2

Hi!

Is there anything preventing barber to use handlebars 1.1.2? I think I have a bug in my ember.js application that may be solved by updating handlebars, but I can't since I depend on ember-rails, which depends on barber.

If there's no compelling reason, may I send some PR's to those projects? (knowing that @tchak maintains both of them).