handlebars 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e02cf1f5fb51ccaa464dc52fa3430bbcf0eebff0
-  data.tar.gz: ff84310db2c0686cf8005eb1bf2ae14ab8d7cc7b
+  metadata.gz: 9d2bdab1c580180f109b07e8741f5d3b0633f2d7
+  data.tar.gz: 3a7ff190e74b96058cf1ef5652e9ca5faa3b89f1
 SHA512:
-  metadata.gz: 8eaa9163c0700702d1ef3cd14600b45301ea198671d85d4f84dde3f71d4ac0b74c33cfd370d975b55e890580215dccb3dbdc2ec6011366e7915351d8457b138f
-  data.tar.gz: 66295c89522a5d2047a1317901b7cb72a2bd2ea6db72238530e5d10234f9b0dcae51bbf6d07bce3af91e7ae8c42e7944803f54a34e1f9e3641e080f1a777b516
+  metadata.gz: 4a7d614c49902c8a7e8bed1387da9befc7a66fcf977e22c9f67265ea8919dd457af5d513325b47ffdb574b52f98fa0122233f1362ced53a510d47c3f0d3267b8
+  data.tar.gz: 3deb5c4809f45b071538130252714bd72f37bcff93b9708066df89596e9ec8f5db2daba4156ead66039966cf8d06e8346c294c1598d4a86d6b03e6a588cc5413

data/README.mdown

@@ -26,6 +26,8 @@ This uses [therubyracer][1] to bind to the _actual_ JavaScript implementation of
 Just like JavaScript, you can write block helpers with an `{{else}}` section. To print
 out a section twice if a condition is met:
 
+    # V8 maps the first argument sent to a block to "this". All subsequent arguments are as
+    # described in the Handlebars documentation.
     handlebars.register_helper(:twice) do |context, condition, block|
       if condition
         "#{block.fn(context)}#{block.fn(context)}"
@@ -37,6 +39,38 @@ out a section twice if a condition is met:
     template.call(foo: true) #=> Hurray!Hurray!
     template.call(foo: false) #=> Boo!
 
+### Private variables:
+
+Just like JavaScript, block helpers can inject private variables into their child templates.
+These can be accessed in a template using the `@` prefix:
+
+    handlebars.register_helper(:list) do |this, context, block|
+      "<ul>" + context.each_with_index.map do |x, i|
+        if block.keys.include? "data"
+          data = handlebars.create_frame(block.data)
+          data.index = i
+        end
+        "<li>" + block.fn(x, data: data) + "</li>"
+      end.join + "</ul>"
+    end
+    template = handlebars.compile("{{#list array}}{{@index}}. {{title}}{{/list}}")
+    template.call(array: [{title: "Memento"}, {title: "Inception"}])
+    #=> "<ul><li>0. Memento</li><li>1. Inception</li></ul>"
+
+### Hash arguments:
+
+When using hash arguments, beware of one gotcha - V8 defines the #hash method for every
+object. Therefore, to access the hash object of the options argument Handlebars sends to your
+block, you must use the `[]` method:
+
+    handlebars.register_helper :list do |this, context, options|
+      attrs = options[:hash].map{|k,v| "#{k}=\"#{v}\""}.join(' ')
+      "<ul #{attrs}>" + context.map{|item| "<li>" + options.fn(item) + "</li>"}.join + "</ul>"
+    end
+    template = handlebars.compile(%({{#list nav id="nav-bar" class="top"}}<a href="{{url}}">{{title}}</a>{{/list}}))
+    template.call({nav: [{url: 'www.google.com', title: 'Google'}]})
+    #=> <ul class="top" id="nav-bar"><li><a href="www.google.com">Google</a></li></ul>
+
 ### Safe Strings
 
 By default, handlebars will escape strings that are returned by your block helpers. To
@@ -72,6 +106,14 @@ Missing partials can also be returned as a function:
     t.call #=> 1 miss(es) when trying to look up a partial
     t.call #=> 2 miss(es) when tyring to look up a partial
 
+### Security
+
+In general, you should not trust user-provided templates: a template can call any method
+(with no arguments) or access any property on any object in the `Handlebars::Context`.
+
+If you'd like to render user-provided templates, you'd want to make sure you do so in a
+sanitized Context, e.g. no filesystem access, read-only or no database access, etc.
+
 ## Test
 
     rspec spec/

data/lib/handlebars/context.rb

@@ -5,6 +5,7 @@ module Handlebars
   class Context
     def initialize
       @js = V8::Context.new
+      @js['global'] = {} # there may be a more appropriate object to be used here @MHW
       @js.load(Handlebars::Source.bundled_path)
 
       @partials = handlebars.partials = Handlebars::Partials.new
@@ -14,6 +15,14 @@ module Handlebars
       ::Handlebars::Template.new(self, handlebars.compile(*args))
     end
 
+    def load_helpers(helpers_pattern)
+      Dir[helpers_pattern].each{ |path| load_helper(path) }
+    end
+
+    def load_helper(path)
+      @js.load(path)
+    end
+
     def precompile(*args)
       handlebars.precompile(*args)
     end
@@ -26,6 +35,10 @@ module Handlebars
       handlebars.registerPartial(name, content)
     end
 
+    def create_frame(data)
+      handlebars.createFrame(data)
+    end
+
     def partial_missing(&fn)
       @partials.partial_missing = fn
     end

data/lib/handlebars/version.rb

@@ -1,3 +1,3 @@
 module Handlebars
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: handlebars
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Charles Lowell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-24 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: therubyracer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.12.1
 - !ruby/object:Gem::Dependency
   name: handlebars-source
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 description: Uses the actual JavaScript implementation of Handlebars, but supports
@@ -75,24 +75,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
-- Changelog.md
-- Gemfile
 - README.mdown
-- Rakefile
-- handlebars.gemspec
 - lib/handlebars.rb
 - lib/handlebars/context.rb
 - lib/handlebars/partials.rb
 - lib/handlebars/safe_string.rb
 - lib/handlebars/template.rb
 - lib/handlebars/version.rb
-- spec/handlebars_spec.rb
-- spike.rb
-homepage: http://github.com/cowboyd/handlebars.rb
-licenses: []
+homepage: https://github.com/cowboyd/handlebars.rb
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -100,19 +92,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: handlebars
-rubygems_version: 2.0.3
+rubyforge_project: 
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the handlebars.js templating library
-test_files:
-- spec/handlebars_spec.rb
+test_files: []

data/.gitignore

@@ -1,4 +0,0 @@
-pkg/*
-*.gem
-.bundle
-Gemfile.lock

data/.rspec

@@ -1 +0,0 @@
---colour

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-

data/Changelog.md

@@ -1,3 +0,0 @@
-# 0.2.3
-
-* expose precompilation method

data/Gemfile

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

data/Rakefile

@@ -1,7 +0,0 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/handlebars.gemspec

@@ -1,26 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "handlebars/version"
-
-Gem::Specification.new do |s|
-  s.name        = "handlebars"
-  s.version     = Handlebars::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Charles Lowell"]
-  s.email       = ["cowboyd@thefrontside.net"]
-  s.homepage    = "http://github.com/cowboyd/handlebars.rb"
-  s.summary     = %q{Ruby bindings for the handlebars.js templating library}
-  s.description = %q{Uses the actual JavaScript implementation of Handlebars, but supports using Ruby objects as template contexts and Ruby procs as view functions and named helpers}
-
-  s.rubyforge_project = "handlebars"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_dependency "therubyracer", "~> 0.12.0"
-  s.add_dependency "handlebars-source", "~> 1.3.0"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", "~> 2.0"
-end

data/spec/handlebars_spec.rb

@@ -1,103 +0,0 @@
-
-require 'handlebars'
-describe(Handlebars::Context) do
-
-  describe "a simple template" do
-    let(:t) {compile("Hello {{name}}")}
-    it "allows simple subsitution" do
-      t.call(:name => 'World').should eql "Hello World"
-    end
-
-    it "allows Ruby blocks as a property" do
-      t.call(:name => lambda {|context| ;"Mate"}).should eql "Hello Mate"
-    end
-
-    it "can use any Ruby object as a context" do
-      t.call(double(:Object, :name => "Flipper")).should eql "Hello Flipper"
-    end
-  end
-
-  describe "allows Handlebars whitespace operator" do
-    let(:t) {compile("whitespace    {{~word~}}   be replaced.")}
-    it "consumes all whitespace characters before/after the tag with the whitespace operator" do
-      t.call(:word => "should").should eql "whitespaceshouldbe replaced."
-    end
-  end
-
-  describe "registering Helpers" do
-    before do
-      subject.register_helper('alsowith') do |this, context, block|
-        block.fn(context)
-      end
-      subject.register_helper(:twice) do |this, block|
-        "#{block.fn}#{block.fn}"
-      end
-    end
-
-    it "correctly passes context and implementation" do
-      t = compile("it's so {{#alsowith weather}}*{{summary}}*{{/alsowith}}!")
-      t.call(:weather => {:summary => "sunny"}).should eql "it's so *sunny*!"
-    end
-
-    it "doesn't nee a context or arguments to the call" do
-      t = compile("{{#twice}}Hurray!{{/twice}}")
-      t.call.should eql "Hurray!Hurray!"
-    end
-  end
-
-  describe "registering Partials" do
-    before do
-      subject.register_partial('legend', 'I am {{who}}')
-    end
-    it "renders partials" do
-      compile("{{> legend}}").call(:who => 'Legend!').should eql "I am Legend!"
-    end
-  end
-
-  describe "dynamically loading partial" do
-    it "can be done with a string" do
-      subject.partial_missing do |name|
-        "unable to find >#{name}"
-      end
-      compile("I am {{>missing}}").call().should eql "I am unable to find >missing"
-    end
-
-    it "can be done with a function" do
-      subject.partial_missing do |name|
-        lambda do |this, context, options|
-          "unable to find my #{name} #{context.what}"
-        end
-      end
-      compile("I am {{>missing}}").call(:what => 'shoes').should eql "I am unable to find my missing shoes"
-    end
-  end
-
-  describe "creating safe strings from ruby" do
-    let(:t) {subject.compile("{{safe}}")}
-    it "respects safe strings returned from ruby blocks" do
-      t.call(:safe => lambda {|this, *args| Handlebars::SafeString.new("<pre>totally safe</pre>")}).should eql "<pre>totally safe</pre>"
-    end
-  end
-
-  describe "context specific data" do
-    before {subject['foo'] = 'bar'}
-    it 'can be get and set' do
-      subject['foo'].should eql 'bar'
-    end
-  end
-
-  describe "precompiling templates" do
-    let(:t) {precompile("foo {{bar}}")}
-    it "should compile down to javascript" do
-      t.should be_start_with 'function'
-    end
-  end
-
-  def compile(*args)
-    subject.compile(*args)
-  end
-
-  def precompile(*args)
-    subject.precompile(*args)
-  end
-end

data/spike.rb

@@ -1,17 +0,0 @@
-require 'handlebars'
-
-Handlebars.register_helper "table" do |block|
- "<table>#{block.call}</table>"
-end
-
-Handlebars.register_helper "row" do |block|
-  "<tr class='awesome-row'>#{block.call}</tr>"
-end
-
-t = Handlebars.compile <<-HBS
-{{#table width}}
-  {{#row}}<td>Hi</td>{{/row}}
-{{/table}}
-HBS
-
-puts t.call