barber 0.1.0 → 0.1.1

data/README.md

@@ -1,12 +1,14 @@
-# Handlebars::Precompiler
+# Barber
 
-TODO: Write a gem description
+Barber handles all your Handlebars precompilation needs. You can use
+Barber as part of your project build system or with someting like
+[rake-pipeline](https://github.com/living-social/rake-pipeline).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'handlebars-precompiler'
+    gem 'barber'
 
 And then execute:
 
@@ -14,11 +16,77 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install handlebars-precompiler
+    $ gem install barber
 
 ## Usage
 
-TODO: Write usage instructions here
+You will mainly interact with the utility classes. The utitlity classes
+delegate to the actual precompiler. They support two primary use cases:
+
+1. Precompiling individual handlebars files.
+2. Precompiling inline handlebars templates.
+
+Here are some code examples:
+
+```ruby
+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. 
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+match "**/*.handlebars" do
+  handlebars :wrapper_proc => Barber::Ember::FilePrecompiler
+end
+```
 
 ## Contributing
 

data/lib/barber/ember/precompiler.rb

@@ -1,16 +1,16 @@
 module Barber
   module Ember
     class Precompiler < Barber::Precompiler
-      def ember_path
-        @ember_path ||= File.new(File.expand_path("../../javascripts/ember.js", __FILE__))
+      def ember
+        @ember ||= File.new(File.expand_path("../../javascripts/ember.js", __FILE__))
       end
 
-      def precompiler_path
-        @precompiler_path = File.new(File.expand_path("../../javascripts/ember_precompiler.js", __FILE__))
+      def precompiler
+        @precompiler = File.new(File.expand_path("../../javascripts/ember_precompiler.js", __FILE__))
       end
 
       def sources
-        super + [File.new(ember_path), File.new(precompiler_path)]
+        super << ember
       end
     end
   end

data/lib/barber/precompiler.rb

@@ -28,16 +28,16 @@ module Barber
     end
 
     def sources
-      [precompiler_path, handlebars_path]
+      [precompiler, handlebars]
     end
 
-    def handlebars_path
-      @handlebears_path ||= File.new(File.expand_path("../javascripts/handlebars.js", __FILE__))
+    def handlebars
+      @handlebears ||= File.new(File.expand_path("../javascripts/handlebars.js", __FILE__))
     end
 
     private
-    def precompiler_path
-      @precompiler_path ||= File.new(File.expand_path("../javascripts/handlebars_precompiler.js", __FILE__))
+    def precompiler
+      @precompiler ||= File.new(File.expand_path("../javascripts/handlebars_precompiler.js", __FILE__))
     end
 
     def context

data/lib/barber/version.rb

@@ -1,3 +1,3 @@
 module Barber
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: barber
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -118,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2188144724700774625
+      hash: -180034689176521228
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2188144724700774625
+      hash: -180034689176521228
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23