haml-underscore-template 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Christopher Rueber
+
+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,61 @@
+# Haml Underscore Template Compiler
+
+This project is an addendum to the Underscore Template Compiler built by Jean-Sebastien Ney. You can follow my fork
+link back to his project if you are interested in the original code. This code will no longer be following that repository.
+
+# Purpose
+
+Say that you're using **BackboneJS**, **UnderscoreJS**, and **jQuery**. A lot of the time you end up putting templates
+directly in to the HTML, and then go after them utilizing the jQuery `$('#template-for-things').html()` functionality,
+rather than having them directly included within your asset pipeline. That is not an insignificant operation for the browser
+to have to go running after, every time a page boots up. This functionality already exists in sprockets implemented as
+EJS and the JST function from the browser side. Additionally, if you're using haml and have already built a lot
+of your templates in that matter, it is a non-trivial task to convert those all over to HTML. And really, why would you want to?
+HAML is a lot easier to write than HTML, and it's a lot easier to reason about. Thus, this project.
+
+[Backbone.js](http://documentcloud.github.com/backbone) | 
+[Underscore.js](http://documentcloud.github.com/underscore/) | 
+[ejs](http://github.com/sstephenson/ruby-ejs) | 
+[sprockets](http://github.com/sstephenson/sprockets) | 
+[JST](https://github.com/sstephenson/sprockets#javascript-templating-with-ejs-and-eco) | 
+
+Just add this to your `Gemfile` :
+
+    gem 'underscore-template'
+    
+Example :
+
+    <!-- templates/hello.jst._ -->
+    .hello 
+      Hello
+      %span <%= name %>!
+
+    // application.js
+    //= require templates/hello
+    $("#hello").html(JST["templates/hello"]({ name: "Sam" }));
+
+Invoke the function in a JavaScript environment to produce a string
+value. You can pass an optional object specifying local variables for
+template evaluation.
+
+The underscore template tag syntax is as follows:
+
+* `<% ... %>` silently evaluates the statement inside the tags.
+* `<%= ... %>` evaluates the expression inside the tags and inserts
+  its string value into the template output.
+* `<%- ... %>` behaves like `<%= ... %>` but HTML-escapes its output.
+
+If you have the [ExecJS](https://github.com/sstephenson/execjs/)
+library and a suitable JavaScript runtime installed, you can pass a
+template and an optional hash of local variables to `UnderscoreTemplate.evaluate`:
+
+    Underscore::Template.evaluate("Hello <%= name %>", :name => "world")
+    # => "Hello world"
+
+-----
+
+&copy; 2012 Christopher Rueber
+
+(most code originally written by [Jean-Sebastien Ney](http://github.com/jney/ruby-underscore-template), and a lot of framework code by [@sstephenson](http://github.com/sstephenson))
+
+The MIT License

data/lib/underscore-template.rb

@@ -0,0 +1,4 @@
+module Underscore; end
+
+require 'underscore-template/engine'
+require 'underscore-template/sprockets'

data/lib/underscore-template/engine.rb

@@ -0,0 +1,75 @@
+require 'haml'
+require 'execjs'
+
+# UnderscoreTemplate (Embedded JavaScript) template compiler for Ruby
+# This is a port of Underscore.js' `_.template` function:
+# http://documentcloud.github.com/underscore/
+
+module Underscore::Engine
+  JS_UNESCAPES = {
+    '\\' => '\\',
+    "'" => "'",
+    "\"" => "\"",
+    'r' => "\r",
+    'n' => "\n",
+    't' => "\t",
+    'u2028' => "\u2028",
+    'u2029' => "\u2029"
+  }
+  JS_ESCAPES = JS_UNESCAPES.invert
+  JS_UNESCAPE_PATTERN = /\\(#{Regexp.union(JS_UNESCAPES.keys)})/
+  JS_ESCAPE_PATTERN = Regexp.union(JS_ESCAPES.keys)
+  EVALUATION_PATTERN = /<%([\s\S]+?)%>/
+  INTERPOLATION_PATTERN = /<%=([\s\S]+?)%>/
+  ESCAPE_PATTERN = /<%-([\s\S]+?)%>/
+
+  class << self
+    attr_accessor :underscore_available
+
+    # Compiles an UnderscoreTemplate template to a JavaScript function. The compiled
+    # function takes an optional argument, an object specifying local
+    # variables in the template.
+    #
+    #     UnderscoreTemplate.compile("Hello <%= name %>")
+    #     # => "_.template('Hello <%= name %>')"
+    #
+    def compile(source, options = {})
+      source = ::Haml::Engine.new(source.dup).render
+      js_escape!(source)
+      "_.template(\"#{source}\")"
+    end
+
+    # Evaluates an UnderscoreTemplate template with the given local variables and
+    # compiler options. You will need the ExecJS
+    # (https://github.com/sstephenson/execjs/) library and a
+    # JavaScript runtime available.
+    #
+    #     UnderscoreTemplate.evaluate("Hello <%= name %>", :name => "world")
+    #     # => "Hello world"
+    #
+    def evaluate(template, locals = {}, options = {})
+      template_to_compile = compile(template, options)
+
+      underscore_context.call(template_to_compile, locals)
+    end
+
+    protected
+      def js_escape!(source)
+        source.gsub!(JS_ESCAPE_PATTERN) { |match| '\\' + JS_ESCAPES[match] }
+        source
+      end
+
+      def js_unescape!(source)
+        source.gsub!(JS_UNESCAPE_PATTERN) { |match| JS_UNESCAPES[match[1..-1]] }
+        source
+      end
+
+      def underscore_context
+        @@underscore_context ||= begin
+          underscore = File.read(File.join(File.dirname(__FILE__), '..', '..', 'ext', 'underscore.js'))
+          ExecJS.compile(underscore)
+        end
+      end
+  end
+
+end

data/lib/underscore-template/sprockets.rb

@@ -0,0 +1,9 @@
+require 'sprockets'
+
+module Underscore
+  # Processing
+  autoload :Template, "underscore-template/template"
+
+  # JST engines
+  ::Sprockets.register_engine '._', Template
+end

data/lib/underscore-template/template.rb

@@ -0,0 +1,33 @@
+require 'sprockets'
+require 'tilt'
+
+module Underscore
+  # Tilt engine class for the Underscore compiler.
+  class Template < Tilt::Template
+    # Check to see if Underscore is loaded
+    def self.engine_initialized?
+      defined? ::Underscore::Engine
+    end
+
+    # Autoload underscore-template library. If the library isn't loaded, Tilt will produce
+    # a thread safetly warning. If you intend to use `._` files, you
+    # should explicitly require it.
+    def initialize_engine
+      require_template_library 'underscore-template'
+    end
+
+    def prepare
+    end
+
+    # Compile template data with Underscore compiler.
+    #
+    # Returns a JS function definition String. The result should be
+    # assigned to a JS variable.
+    #
+    #     # => "_.template(...)"
+    #
+    def evaluate(scope, locals, &block)
+      Underscore::Engine.compile(data)
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: haml-underscore-template
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Christopher Rueber
+- Jean-Sébastien Ney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+description: Compile and evaluate underscore templates from Ruby.
+email:
+- crueber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/underscore-template/engine.rb
+- lib/underscore-template/sprockets.rb
+- lib/underscore-template/template.rb
+- lib/underscore-template.rb
+homepage: https://github.com/crueber/haml-underscore-template/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Haml+Underscore Template compiler
+test_files: []