tilt-handlebars 1.0

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tilt-handlebars.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jim Cushing
+
+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,51 @@
+# Tilt::Handlebars
+
+Adds support for [Handlebars.rb](https://github.com/cowboyd/handlebars.rb) template 
+engine to [Tilt](https://github.com/rtomayko/tilt).
+
+See the [Handlebars.js](http://handlebarsjs.com) site for syntax.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tilt-handlebars'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tilt-handlebars
+
+## Usage
+
+Create a Handlebars template file with either a `.hbs` or `.handlebars` extension. 
+
+Example, in `hello.hbs`:
+
+```
+Hello, {{name}}. I'm {{emotion}} to meet you.
+```
+
+Then, render the template with Ruby:
+
+```ruby
+require 'tilt/handlebars'
+
+template = Tilt.new('hello.hbs')
+puts template.render(nil, name: "Joe", emotion: "happy")
+```
+
+Output:
+
+	Hello, Joe. I'm happy to meet you.
+
+## 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,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc 'Run tests (default)'
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.ruby_opts = ['-Itest']
+  t.ruby_opts << '-rubygems' if defined? Gem
+end

data/lib/tilt/handlebars.rb

@@ -0,0 +1,67 @@
+require 'tilt' unless defined? Tilt
+require 'handlebars'
+
+module Tilt
+
+  # Handlebars.rb template implementation. See:
+  # https://github.com/cowboyd/handlebars.rb
+  # and http://handlebarsjs.com
+  #
+  # Handlebars is a logic-less template rendered with JavaScript.
+  # Handlebars.rb is a Ruby wrapper around Handlebars, that allows
+  # Handlebars templates to be rendered server side.
+  #
+  class HandlebarsTemplate < Template
+    def initialize_engine
+      @context = ::Handlebars::Context.new
+    end    
+
+    def self.engine_initialized?
+      true
+    end 
+
+    def prepare
+      @context = ::Handlebars::Context.new
+          @template = @context.compile(data)
+    end
+
+    def evaluate(scope, locals = {}, &block)
+      # Based on LiquidTemplate
+      locals = locals.inject({}){ |h,(k,v)| h[k.to_s] = v ; h }
+      if scope.respond_to?(:to_h)
+        scope  = scope.to_h.inject({}){ |h,(k,v)| h[k.to_s] = v ; h }
+        locals = scope.merge(locals)
+      else
+        scope.instance_variables.each do |var|
+          key = var.to_s.delete("@")
+          locals[key] = scope.instance_variable_get(var) unless locals.has_key? key
+        end
+      end
+
+      locals['yield'] = block.nil? ? '' : yield
+      locals['content'] = locals['yield']
+
+      @template.call(locals);
+    end
+
+    def register_helper(name, &fn)
+      @context.register_helper(name, &fn)
+    end
+
+    def register_partial(*args)
+      @context.register_partial(*args)
+    end
+
+    def partial_missing(&fn)
+      @context.partial_missing(&fn)
+    end
+
+    def allows_script?
+      false
+    end
+  end
+
+  register HandlebarsTemplate, 'handlebars', 'hbs'
+end
+
+

data/test/hello.hbs

@@ -0,0 +1 @@
+Hello, {{ name }}. I'm {{ emotion }} to meet you.

data/test/tilt_handlebarstemplate_test.rb

@@ -0,0 +1,222 @@
+require 'bundler'
+Bundler.setup
+
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require 'tilt'
+require 'tilt/handlebars'
+
+def make_template(text)
+  Tilt::HandlebarsTemplate.new { |t| text }
+end
+
+describe Tilt::HandlebarsTemplate do
+  it 'renders from file' do
+    template = Tilt.new('test/hello.hbs')
+    template.render(nil, name: 'Joe', emotion: 'happy').must_equal "Hello, Joe. I'm happy to meet you.\n"
+  end
+
+  it 'is registered for .hbs files' do
+    Tilt['test.hbs'].must_equal Tilt::HandlebarsTemplate
+  end
+
+  it 'is registered for .handlebars files' do
+    Tilt['test.handlebars'].must_equal Tilt::HandlebarsTemplate
+  end
+
+  it 'renders static template' do
+    template = make_template "Hello World!" 
+    template.render.must_equal "Hello World!"
+  end
+
+  it "can be rendered more than once" do
+    template = make_template "Hello World!" 
+    3.times { template.render.must_equal "Hello World!" }
+  end
+
+  it "substitutes locals in template" do
+    template = make_template "Hey {{ name }}!" 
+    template.render(nil, :name => 'Joe').must_equal "Hey Joe!"
+  end
+
+  it "displays nested properties" do
+    template = make_template "Hey {{ person.name }}!" 
+    template.render(nil, :person => { :name => 'Joe' }).must_equal "Hey Joe!"
+  end
+
+  it "displays text from block" do
+    template = make_template "Deck the halls. Fa {{ yield }}."
+    rendered = template.render(nil) { "la la la la"}
+    rendered.must_equal "Deck the halls. Fa la la la la."
+  end
+
+
+  describe "arrays" do
+   shopping_list = %w[milk eggs flour sugar]
+
+   it "displays element from array" do
+      template = make_template "Don't forget the {{ shopping_list.[1] }}!"
+      template.render(nil, :shopping_list => shopping_list).must_equal "Don't forget the eggs!"
+    end
+
+    it "displays elements in an array in a loop" do
+      template = make_template 'Items to buy:{{#each shopping_list}} {{ this }}{{/each}}' 
+      template.render(nil, :shopping_list => shopping_list).must_equal "Items to buy: milk eggs flour sugar"
+    end
+
+    it "displays alternate text when array is empty" do
+      template = make_template 'Items to buy:{{#each shopping_list}} {{ this }}{{else}} All done!{{/each}}' 
+      template.render(nil, :shopping_list => []).must_equal "Items to buy: All done!"
+    end  
+  end
+
+  describe "conditionals" do
+    template = make_template '{{#if morning}}Good morning{{else}}Hello{{/if}}, {{ name }}'
+
+    it "displays text if value is true" do
+      template.render(nil, :name => 'Joe', :morning => true).must_equal "Good morning, Joe"
+    end
+
+    it "displays alternate text if value is false" do
+      template.render(nil, :name => 'Joe', :morning => false).must_equal "Hello, Joe"
+    end
+
+    it "displays alternate text if value is missing" do
+      template.render(nil, :name => 'Joe').must_equal "Hello, Joe"
+    end
+  end
+
+  describe "unless expressions" do
+    template = make_template 'Hello, {{ name }}.{{#unless weekend}} Time to go to work.{{/unless}}'
+
+    it "displays text if value is false" do
+      template.render(nil, :name => 'Joe', :weekend => false).must_equal "Hello, Joe. Time to go to work."
+    end
+
+    it "does not display text if value is true" do
+      template.render(nil, :name => 'Joe', :weekend => true).must_equal "Hello, Joe."
+    end
+
+    it "displays text if value is missing" do
+      template.render(nil, :name => 'Joe').must_equal "Hello, Joe. Time to go to work."
+    end
+  end
+
+  describe "escape HTML" do
+    it "escapes HTML characters" do
+      template = make_template "Hey {{ name }}!" 
+      template.render(nil, :name => '<b>Joe</b>' ).must_equal "Hey &lt;b&gt;Joe&lt;/b&gt;!"
+    end
+
+    it "does not escape HTML characters in triple-stash" do
+      template = make_template "Hey {{{ name }}}!" 
+      template.render(nil, :name => '<b>Joe</b>' ).must_equal "Hey <b>Joe</b>!"
+    end
+  end
+
+  describe "helpers" do
+    it "applies helper to static text" do
+      template = make_template '{{#upper}}Hello, World.{{/upper}}'
+      template.register_helper(:upper) do |this, block|
+        block.fn(this).upcase
+      end
+
+      template.render.must_equal "HELLO, WORLD."
+    end      
+
+    it "applies helper to nested values" do
+      template = make_template '{{#upper}}Hey {{name}}{{/upper}}!'
+      template.register_helper(:upper) do |this, block|
+        block.fn(this).upcase
+      end
+
+      template.render(nil, :name => 'Joe').must_equal "HEY JOE!"
+    end      
+
+    it "displays properties from object using 'with' helper" do
+      template = make_template '{{#with person}}Hello, {{ first_name }} {{ last_name }}{{/with}}'
+      joe = Person.new "Joe", "Blow"
+      template.render(nil, :person => joe).must_equal "Hello, Joe Blow"    
+    end
+
+  end
+
+  describe "using scope object to render template" do
+    class Person
+      attr_reader :first_name, :last_name
+
+      def initialize(first_name, last_name)
+        @first_name = first_name
+        @last_name = last_name
+      end
+    end
+
+    class HashPerson
+      attr_reader :first_name, :last_name
+
+      def initialize(first_name, last_name)
+        @first_name = first_name
+        @last_name = last_name
+      end
+
+      def to_h
+        { first_name: @first_name, last_name: @last_name }
+      end
+    end
+
+    joe = Person.new "John", "Doe"
+
+    it "displays properties of object passed as scope" do
+      template = make_template "Hello, {{ first_name }} {{ last_name }}."
+      template.render(joe).must_equal "Hello, John Doe."
+    end
+
+    it "merges scope object properties with locals" do
+      template = make_template "{{ greeting }}, {{ first_name }} {{ last_name }}."
+      template.render(joe, :greeting => "Salut").must_equal "Salut, John Doe."
+    end
+
+    it "prefers locals over scope object properties with same name" do
+      template = make_template "Hello, {{ first_name }} {{ last_name }}."
+      template.render(joe, :first_name => "Jane").must_equal "Hello, Jane Doe."
+    end
+
+    it "prefers locals over scope object properties with same name when object defines to_h" do
+      joe_hash = HashPerson.new "John", "Doe"
+
+      template = make_template "Hello, {{ first_name }} {{ last_name }}."
+      template.render(joe_hash, :first_name => "Jane").must_equal "Hello, Jane Doe."
+    end
+  end
+
+  describe "comments" do
+    it "does not render comments" do
+      template = make_template "Hello world{{! what a wonderful world }}"
+      template.render.must_equal "Hello world"   
+    end
+
+    it "does not render comments, alternative syntax" do
+      template = make_template "Hello world{{!-- what a wonderful world --}}"
+      template.render.must_equal "Hello world"   
+    end
+  end
+
+  describe "partials" do
+    it "displays content of partial" do
+      template = make_template "{{> greeting}}. Nice to meet you."
+      template.register_partial :greeting, "Hey, {{name}}"
+      template.render(nil, :name => "Joe").must_equal "Hey, Joe. Nice to meet you."      
+    end
+
+    it "calls registeded method if partial is missing" do
+      template = make_template "{{> where}} I've been looking for you."
+      template.partial_missing do |partial_name|
+        "Where have you been, {{name}}?" if partial_name == 'where'
+      end
+      template.render(nil, :name => "Joe").must_equal "Where have you been, Joe? I've been looking for you."
+    end
+  end
+end
+
+

data/tilt-handlebars.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "tilt-handlebars"
+  spec.version       = "1.0"
+  spec.authors       = ["Jim Cushing"]
+  spec.email         = ["jimothy@mac.com"]
+  spec.description   = "Use Handlebars.rb with Tilt"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/jimothyGator/tilt-handlebars"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency "tilt", "~> 1.4"
+  spec.add_dependency "handlebars", "~> 0.4"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: tilt-handlebars
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Jim Cushing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: handlebars
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Use Handlebars.rb with Tilt
+email:
+- jimothy@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tilt/handlebars.rb
+- test/hello.hbs
+- test/tilt_handlebarstemplate_test.rb
+- tilt-handlebars.gemspec
+homepage: https://github.com/jimothyGator/tilt-handlebars
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -129076644092719377
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -129076644092719377
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Use Handlebars.rb with Tilt
+test_files:
+- test/hello.hbs
+- test/tilt_handlebarstemplate_test.rb