barber 0.1.1 → 0.1.2

data/barber.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/barber/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["tchak", "twinturbo"]
-  gem.email         = ["paul@chavard.net"]
+  gem.email         = ["paul@chavard.net", "me@boardcastingadam.com"]
   gem.description   = %q{Handlebars precompilation}
   gem.summary       = %q{Handlebars precompilation toolkit}
   gem.homepage      = "https://github.com/tchak/barber"

data/lib/barber.rb

@@ -9,7 +9,7 @@ require "barber/ember/precompilers"
 module Barber
   class PrecompilerError < StandardError
     def initialize(template, error)
-      @template, @error = @template, error
+      @template, @error = template, error
     end
 
     def to_s

data/lib/barber/precompiler.rb

@@ -1,5 +1,5 @@
-require 'json'
 require 'execjs'
+require 'json'
 
 module Barber
   class Precompiler
@@ -9,18 +9,10 @@ module Barber
       end
     end
 
-    def compile(source)
-      # if the source is a prescaped JSON string then 
-      # it should be parse, else just use it as is
-      content = begin
-                  JSON.load source
-                rescue JSON::ParserError
-                  source
-                end
-
-      context.call precompile_function, content
+    def compile(template)
+      context.call precompile_function, sanitize(template)
     rescue ExecJS::ProgramError => ex
-      raise Barber::PrecompilerError.new(source, ex)
+      raise Barber::PrecompilerError.new(template, ex)
     end
 
     def precompile_function
@@ -36,6 +28,37 @@ module Barber
     end
 
     private
+    # This method handles different types of user input. The precompiler
+    # can be called from many different places which create interesting 
+    # conditions.
+    # Case 1: Rake-Pipeline-Web-Filters: calls with a JSON encoded string.
+    # Case 2: Matched a string in a Javascript source file that does not 
+    #   behave the same way in ruby. IE: template: Handlebars.compile('{{foo}}\n').
+    #   Matching that string with a regex in Ruby generates a string with a literal \n.
+    #   That same string in JavaScript does not contain a literal \n. These semantics
+    #   break the compiler when \n are present in view helpers. Coffeescript block strings
+    #   usually cause this problem.
+    # Case 3: "Normal" input. Reading from a file or something like that.
+    #
+    # Each one of these cases is covered by a test case. If you find another breaking
+    # use case please address it here with a regression test.
+    def sanitize(template)
+      begin
+        if template =~ /\A".+"\Z/m
+          # Case 1
+          JSON.load(%Q|{"template":#{template}}|)['template']
+        else
+          # Case 2: evaluate a literal JS string in Ruby in the JS context
+          # to get an equivalent Ruby string back. This will convert liternal \n's
+          # to new lines. This is safer than trying to modify the string using regex.
+          context.eval("'#{template}'")
+        end
+      rescue JSON::ParserError, ExecJS::RuntimeError
+        # Case 3
+        template
+      end
+    end
+
     def precompiler
       @precompiler ||= File.new(File.expand_path("../javascripts/handlebars_precompiler.js", __FILE__))
     end

data/lib/barber/version.rb

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

data/test/precompiler_test.rb

@@ -16,7 +16,21 @@ class PrecompilerTest < MiniTest::Unit::TestCase
     {{view Radium.RangeChangerView}}
     hbs
 
-    result = compile JSON.dump({:template => template})['template']
+    result = compile template
+    assert result
+  end
+
+  def test_handles_multiline_coffeescript_strings
+    template = '<h2>{{unbound view.title}}</h2>\n<ul>\n  {{#each view.content}}\n    {{view view.resultItemView\n      contentBinding="this"\n      selectedItemBinding="view.selectedItem"}}\n  {{/each}}\n</ul>'
+
+    result = compile template
+    assert result
+  end
+
+  def test_handles_prescaped_JSON_strings
+    template = '"<div class=\"comments\">\n  <div class=\"span5 offset1\">\n    {{#if view.comments.length}}\n    <ul class=\"comments-list unstyled\">\n      {{#each view.comments}}\n        {{view Radium.CommentView commentBinding=\"this\"}}\n      {{/each}}\n    </ul>\n    {{/if}}\n    {{#if view.isError}}\n      <p class=\"error\">Hmm, something wasn\'t done correctly. Try again?</p>\n    {{/if}}\n    <div style=\"clear: both\"></div>\n    {{view view.commentTextArea}}\n  </div>\n</div>\n"'
+
+    result = compile template
     assert result
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: barber
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-01 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -79,6 +79,7 @@ dependencies:
 description: Handlebars precompilation
 email:
 - paul@chavard.net
+- me@boardcastingadam.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -118,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -180034689176521228
+      hash: -2194861738178296462
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,10 +128,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -180034689176521228
+      hash: -2194861738178296462
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Handlebars precompilation toolkit