hbs 0.1.0

data/.gitignore

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

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "js"]
+	path = js
+	url = https://github.com/wycats/handlebars.js.git

data/.rspec

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

data/Gemfile

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

data/README.mdown

@@ -0,0 +1,20 @@
+
+## Handlebars.rb
+
+This uses [therubyracer](http://github.com/cowboyd/therubyracer) to bind to the _actual_ JavaScript implementation of
+[Handlebars.js](http://github.com/wycats/handlebars.js) so that you can use it from ruby.
+
+## Hack
+
+    git clone git@github.com:cowboyd/handlebars.rb.git #git it
+    cd handlebars.rb #go to it
+    git submodule update --init #pull down handlebars.js
+    rspec spec/ #test it
+
+## Use
+
+    require 'handlebars'
+    template = Handlebars.compile("{{say}}{{what}}")
+    template.call(:say => "Hey", :what => "Yuh!") #=> "Hey Yuh!"
+
+

data/Rakefile

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

data/hbs.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "handlebars/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hbs"
+  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 rubyracer bind in rails}
+
+  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"]
+  Dir.chdir("js") do
+    s.files += `git ls-files`.split("\n").map {|f| "js/#{f}"}
+    s.files += ['js/lib/handlebars/parser.js']
+  end
+
+  s.add_dependency "therubyracer", "~> 0.9.3beta1"
+  s.add_development_dependency "rspec", "~> 2.0.0"
+end

data/js/.gitignore

@@ -0,0 +1,5 @@
+dist
+lib/handlebars/parser.js
+vendor
+.rvmrc
+.DS_Store

data/js/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem "therubyracer", ">= 0.8.0"
+gem "rspec"

data/js/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by Yehuda Katz
+
+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/js/README.markdown

@@ -0,0 +1,224 @@
+Handlebars.js
+=============
+
+Handlebars.js is an extension to the [Mustache templating language](http://mustache.github.com/) created by Chris Wanstrath. Handlebars.js and Mustache are both logicless templating languages that keep the view and the code separated like we all know they should be.
+
+Checkout the official Handlebars docs site at [http://www.handlebarsjs.com](http://www.handlebarsjs.com).
+
+
+Installing
+----------
+Installing Handlebars is easy. Simply [download the package from GitHub](https://github.com/wycats/handlebars.js/archives/master) and add it to your web pages (you should usually use the most recent version).
+
+Usage
+-----
+In general, the syntax of Handlebars.js templates is a superset of Mustache templates. For basic syntax, check out the [Mustache manpage](http://mustache.github.com/mustache.5.html).
+
+Once you have a template, use the Handlebars.compile method to compile the template into a function. The generated function takes a context argument, which will be used to render the template.
+
+    var source = "<p>Hello, my name is {{name}}. I am from {{hometown}}. I have " + 
+        "{{kids/length}} kids:</p>" +
+        "<ul>{{#kids}}<li>{{name}} is {{age}}</li>{{/kids}}</ul>";
+    var template = Handlebars.compile(source);
+
+    var data = { "name": "Alan", "hometown": "Somewhere, TX",
+                  "kids": [{"name": "Jimmy", "age": "12"}, {"name": "Sally", "age": "4"}]};
+    var result = template(data);
+
+    // Would render:
+    // <p>Hello, my name is Alan. I am from Somewhere, TX. I have 2 kids:</p>
+    // <ul>
+    //   <li>Jimmy is 12</li>
+    //   <li>Sally is 4</li>
+    // </ul>
+
+
+Registering Helpers
+-------------------
+
+You can register helpers that Handlebars will use when evaluating your
+template. Here's an example, which assumes that your objects have a URL
+embedded in them, as well as the text for a link:
+
+    Handlebars.registerHelper('link_to', function(context) {
+      return "<a href='" + context.url + "'>" + context.body + "</a>";
+    });
+
+    var context = { posts: [{url: "/hello-world", body: "Hello World!"}] };
+    var source = "<ul>{{#posts}}<li>{{{link_to this}}}</li>{{/posts}}</ul>"
+
+    var template = Handlebars.compile(source);
+    template(context);
+
+    // Would render:
+    //
+    // <ul>
+    //   <li><a href='/hello-world'>Hello World!</a></li>
+    // </ul>
+
+
+Escaping
+--------
+
+By default, the `{{expression}}` syntax will escape its contents. This
+helps to protect you against accidental XSS problems caused by malicious
+data passed from the server as JSON.
+
+To explicitly *not* escape the contents, use the triple-mustache
+(`{{{}}}`). You have seen this used in the above example.
+
+
+Differences Between Handlebars.js and Mustache
+----------------------------------------------
+Handlebars.js adds a couple of additional features to make writing templates easier and also changes a tiny detail of how partials work.
+
+### Paths
+
+Handlebars.js supports an extended expression syntax that we call paths. Paths are made up of typical expressions and / characters. Expressions allow you to not only display data from the current context, but to display data from contexts that are descendents and ancestors of the current context.
+
+To display data from descendent contexts, use the `/` character. So, for example, if your data were structured like:
+
+    var data = {"person": { "name": "Alan" }, company: {"name": "Rad, Inc." } };
+
+you could display the person's name from the top-level context with the following expression:
+
+    {{person/name}}
+
+Similarly, if already traversed into the person object you could still display the company's name with an expression like `{{../company/name}}`, so:
+
+    {{#person}}{{name}} - {{../company/name}}{{/person}}
+
+would render:
+
+    Alan - Rad, Inc.
+
+### Strings
+
+When calling a helper, you can pass paths or Strings as parameters. For
+instance:
+
+    Handlebars.registerHelper('link_to', function(title, context) {
+      return "<a href='/posts" + context.id + "'>" + title + "</a>"
+    });
+
+    var context = { posts: [{url: "/hello-world", body: "Hello World!"}] };
+    var source = '<ul>{{#posts}}<li>{{{link_to "Post" this}}}</li>{{/posts}}</ul>'
+
+    var template = Handlebars.compile(source);
+    template(context);
+
+    // Would render:
+    //
+    // <ul>
+    //   <li><a href='/hello-world'>Post!</a></li>
+    // </ul>
+
+When you pass a String as a parameter to a helper, the literal String
+gets passed to the helper function.
+
+
+### Block Helpers
+
+Handlebars.js also adds the ability to define block helpers. Block helpers are functions that can be called from anywhere in the template. Here's an example:
+
+    var source = "<ul>{{#people}}<li>{{{#link}}}{{name}}{{/link}}</li>{{/people}}</ul>";
+    Handlebars.registerHelper('link', function(context, fn) {
+      return '<a href="/people/' + this.__get__("id") + '">' + fn(this) + '</a>';
+    });
+    var template = Handlebars.compile(source);
+
+    var data = { "people": [
+        { "name": "Alan", "id": 1 },
+        { "name": "Yehuda", "id": 2 }
+      ]};
+    template(data);
+
+    // Should render:
+    // <ul>
+    //   <li><a href="/people/1">Alan</a></li>
+    //   <li><a href="/people/2">Yehuda</a></li>
+    // </ul>
+
+Whenever the block helper is called it is given two parameters, the argument that is passed to the helper, or the current context if no argument is passed and the compiled contents of the block. Inside of the block helper the value of `this` is the current context, wrapped to include a method named `__get__` that helps translate paths into values within the helpers.
+
+### Partials
+
+You can register additional templates as partials, which will be used by
+Handlebars when it encounters a partial (`{{> partialName}}`). Partials
+can either be String templates or compiled template functions. Here's an
+example:
+
+    var source = "<ul>{{#people}}<li>{{> link}}</li>{{/people}}</ul>";
+
+    Handlebars.registerPartial('link', '<a href="/people/{{id}}">{{name}}</a>')
+    var template = Handlebars.compile(source);
+
+    var data = { "people": [
+        { "name": "Alan", "id": 1 },
+        { "name": "Yehuda", "id": 2 }
+      ]};
+
+    template(data);
+
+    // Should render:
+    // <ul>
+    //   <li><a href="/people/1">Alan</a></li>
+    //   <li><a href="/people/2">Yehuda</a></li>
+    // </ul>
+
+Precompiling Templates
+----------------------
+
+TODO in the rewrite. This will use RubyRacer and not node.
+
+Performance
+-----------
+
+In a rough performance test, precompiled Handlebars.js templates (in the original version of Handlebars.js) rendered in about half the time of Mustache templates. It would be a shame if it were any other way, since they were precompiled, but the difference in architecture does have some big performance advantages. Justin Marney, a.k.a. [gotascii](http://github.com/gotascii), confirmed that with an [independent test](http://sorescode.com/2010/09/12/benchmarks.html). The rewritten Handlebars (current version) is faster than the old version, and we will have some benchmarks in the near future.
+
+
+Building
+--------
+
+To build handlebars, just run `rake release`, and you will get two files
+in the `dist` directory. The debug version comes with stack trace
+annotations for webkit browsers, but will slightly increase startup
+time.
+
+
+Upgrading
+---------
+
+When upgrading from the Handlebars 0.9 series, be aware that the
+signature for passing custom helpers or partials to templates has
+changed.
+
+Instead of:
+
+    template(context, helpers, partials, [data])
+
+Use:
+
+    template(context, {helpers: helpers, partials: partials, data: data})
+
+Known Issues
+------------
+* Handlebars.js can be cryptic when there's an error while rendering.
+
+Handlebars Contrib
+------------------
+Alan Johnson, a.k.a. commondream, keeps a repository of useful helpers in the [handlebars-contrib](http://github.com/commondream/handlebars-contrib) repository. Feel free to copy those, or add some of your own.
+
+Handlebars in the Wild
+-----------------
+* Don Park wrote an Express.js view engine adapter for Handlebars.js called [hbs](http://github.com/donpark/hbs)
+* [sammy.js](http://github.com/quirkey/sammy) by Aaron Quint, a.k.a. quirkey, supports Handlebars.js as one of its template plugins.
+* [SproutCore](http://www.sproutcore.com) uses Handlebars.js as its main templating engine, extending it with automatic data binding support.
+
+Helping Out
+-----------
+If you notice any problems, please report them to the GitHub issue tracker at [http://github.com/wycats/handlebars.js/issues](http://github.com/wycats/handlebars.js/issues). Feel free to contact commondream or wycats through GitHub with any other questions or feature requests. To submit changes fork the project and send a pull request.
+
+License
+-------
+Handlebars.js is released under the MIT license.

data/js/Rakefile

@@ -0,0 +1,107 @@
+require "rubygems"
+require "bundler/setup"
+
+file "lib/handlebars/parser.js" => ["src/handlebars.yy","src/handlebars.l"] do
+  if ENV['PATH'].split(':').any? {|folder| File.exists?(folder+'/jison')}
+    system "jison src/handlebars.yy src/handlebars.l"
+    File.open("lib/handlebars/parser.js", "w") do |file|
+      file.puts File.read("handlebars.js") + ";"
+    end
+
+    sh "rm handlebars.js"
+  else
+    puts "Jison is not installed. Try running `npm install jison`."
+  end
+end
+
+task :compile => "lib/handlebars/parser.js"
+
+desc "run the spec suite"
+task :spec => [:release] do
+  system "rspec -cfs spec"
+end
+
+task :default => [:compile, :spec]
+
+def remove_exports(string)
+  match = string.match(%r{^// BEGIN\(BROWSER\)\n(.*)\n^// END\(BROWSER\)}m)
+  match ? match[1] : string
+end
+
+minimal_deps = %w(parser base ast visitor utils compiler).map do |file|
+  "lib/handlebars/#{file}.js"
+end
+
+debug_deps = %w(parser base ast visitor printer utils compiler debug).map do |file|
+  "lib/handlebars/#{file}.js"
+end
+
+directory "dist"
+
+minimal_deps.unshift "dist"
+debug_deps.unshift   "dist"
+
+def build_for_task(task)
+  FileUtils.rm_rf("dist/*") if File.directory?("dist")
+  FileUtils.mkdir_p("dist")
+
+  contents = []
+  task.prerequisites.each do |filename|
+    next if filename == "dist"
+
+    contents << "// #{filename}\n" + remove_exports(File.read(filename)) + ";"
+  end
+
+  File.open(task.name, "w") do |file|
+    file.puts contents.join("\n")
+  end
+end
+
+file "dist/handlebars.js" => minimal_deps do |task|
+  build_for_task(task)
+end
+
+file "dist/handlebars.debug.js" => debug_deps do |task|
+  build_for_task(task)
+end
+
+task :build => [:compile, "dist/handlebars.js"]
+task :debug => [:compile, "dist/handlebars.debug.js"]
+
+desc "build the build and debug versions of handlebars"
+task :release => [:build, :debug]
+
+directory "vendor"
+
+desc "benchmark against dust.js and mustache.js"
+task :bench => "vendor" do
+  require "open-uri"
+  File.open("vendor/mustache.js", "w") do |file|
+    file.puts open("https://github.com/janl/mustache.js/raw/master/mustache.js").read
+    file.puts "module.exports = Mustache;"
+  end
+
+  File.open("vendor/benchmark.js", "w") do |file|
+    file.puts open("https://github.com/mathiasbynens/benchmark.js/raw/master/benchmark.js").read
+  end
+
+  if File.directory?("vendor/dustjs")
+    system "cd vendor/dustjs && git pull"
+  else
+    system "git clone git://github.com/akdubya/dustjs.git vendor/dustjs"
+  end
+
+  if File.directory?("vendor/coffee")
+    system "cd vendor/coffee && git pull"
+  else
+    system "git clone git://github.com/jashkenas/coffee-script.git vendor/coffee"
+  end
+
+  if File.directory?("vendor/eco")
+    system "cd vendor/eco && git pull"
+  else
+    system "git clone git://github.com/sstephenson/eco.git vendor/eco"
+  end
+
+  system "node bench/handlebars.js"
+end

data/js/bench/benchwarmer.js

@@ -0,0 +1,147 @@
+
+var Benchmark = require("benchmark");
+
+var BenchWarmer = function(names) {
+  this.benchmarks = [];
+  this.currentBenches = [];
+  this.names = [];
+  this.errors = {};
+};
+
+var print = require("sys").print;
+
+BenchWarmer.prototype = {
+  winners: function(benches) {
+    var result = Benchmark.filter(benches, function(bench) { return bench.cycles; });
+
+    if (result.length > 1) {
+      result.sort(function(a, b) { return b.compare(a); });
+      first = result[0];
+      last  = result[result.length - 1];
+
+      var winners = [];
+
+      Benchmark.each(result, function(bench) {
+        if (bench.compare(first) === 0) {
+          winners.push(bench);
+        }
+      });
+
+      return winners;
+    } else {
+      return result;
+    }
+  },
+  suite: function(suite, fn) {
+    this.suiteName = suite;
+    this.first = true;
+
+    var self = this;
+
+    fn(function(name, benchFn) {
+      self.push(name, benchFn);
+    });
+  },
+  push: function(name, fn) {
+    if(this.names.indexOf(name) == -1) {
+      this.names.push(name);
+    }
+
+    var first = this.first, suiteName = this.suiteName, self = this;
+    this.first = false;
+
+    var bench = new Benchmark(function() {
+      fn();
+    }, {
+      name: this.suiteName + ": " + name,
+      onComplete: function() {
+        if(first) { self.startLine(suiteName); }
+        self.writeBench(bench);
+        self.currentBenches.push(bench);
+      }, onError: function() {
+        self.errors[this.name] = this;
+      }
+    });
+
+    this.benchmarks.push(bench);
+  },
+  bench: function() {
+    var benchSize = 0, names = this.names, self = this, i, l;
+
+    for(i=0, l=names.length; i<l; i++) {
+      var name = names[i];
+
+      if(benchSize < name.length) { benchSize = name.length; }
+    }
+
+    this.nameSize = benchSize + 2;
+    this.benchSize = 20;
+    var horSize = 0;
+
+    this.startLine("ops/msec");
+    horSize = horSize + "ops/msec    ".length;
+    for(i=0, l=names.length; i<l; i++) {
+      print(names[i] + new Array(this.benchSize - names[i].length + 1).join(" "));
+      horSize = horSize + this.benchSize;
+    }
+
+    print("WINNER(S)");
+    horSize = horSize + "WINNER(S)".length;
+
+    print("\n" + new Array(horSize + 1).join("-"));
+
+    Benchmark.invoke(this.benchmarks, {
+      name: "run",
+      onComplete: function() {
+        var errors = false, prop, bench;
+        for(prop in self.errors) { if(self.errors.hasOwnProperty(prop)) { errors = true; break; } }
+
+        if(errors) {
+          print("\n\nErrors:\n");
+          for(prop in self.errors) {
+            if(self.errors.hasOwnProperty(prop)) {
+              bench = self.errors[prop];
+              print("\n" + bench.name + ":\n");
+              print(bench.error.message);
+              if(bench.error.stack) {
+                print(bench.error.stack.join("\n"));
+              }
+              print("\n");
+            }
+          }
+        }
+      }
+    });
+  },
+  startLine: function(name) {
+    var winners = Benchmark.map(this.winners(this.currentBenches), function(bench) {
+      return bench.name.split(": ")[1];
+    });
+
+    this.currentBenches = [];
+
+    print(winners.join(", "));
+    print("\n");
+    var padding = this.nameSize - name.length + 1;
+    name = name + new Array(padding).join(" ");
+    print(name);
+  },
+  writeBench: function(bench) {
+    var out;
+
+    if(!bench.error) {
+      var count = bench.hz,
+          moe   = count * bench.stats.RME / 100;
+
+      out = Math.round(count / 1000) + " ±" + Math.round(moe / 1000) + " (" + bench.cycles + ")";
+    } else {
+      out = "E";
+    }
+
+    var padding = this.benchSize - out.length + 1;
+    out = out + new Array(padding).join(" ");
+    print(out);
+  }
+};
+
+module.exports = BenchWarmer;