Compile and render Jade templates in Ruby with help from therubyracer embedded V8 JavaScript interpreter
Ruby
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
benchmarks
lib
spec
.gitignore
.rspec
Gemfile
LICENSE
README.md
Rakefile
extconf.rb
jadeite.gemspec
npm-shrinkwrap.json
package.json

README.md

________       _________    __________      
______(_)_____ ______  /_______(_)_  /_____ 
_____  /_  __ `/  __  /_  _ \_  /_  __/  _ \
____  / / /_/ // /_/ / /  __/  / / /_ /  __/
___  /  \__,_/ \__,_/  \___//_/  \__/ \___/ 
/___/ Compile and render Jade templates from Ruby

Build Status

Jadeite lets you compile and render Jade templates from your Ruby code. Under the hood it uses the Jade node module running in therubyracer's embedded V8 JavaScript engine.

It is pretty cool since it means you can easily share templates between the server side and front end. Render with json/javascript data on the client side and ruby objects on the server side.

Getting started

Add this line to your application's Gemfile:

gem 'jadeite'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jadeite

Usage

Render a template string with data

env = Jadeite::Environment.new
env.render('p Hello #{what}!', {:what =>"world"})
#=> "<p>Hello world!</p>"

Compile once, render twice (or more)

env = Jadeite::Environment.new
compiled = env.compile('p Hello #{what}!')
compiled.render :what => "world"
#=> "<p>Hello world!</p>"
compiled.render :what => "moon"
#=> "<p>Hello moon!</p>"

Compile / render a file

env = Jadeite::Environment.new

# compile first
compiled = env.compile_file("./hello.jade")
compiled.render :what => "world"
#=> "<p>Hello world!</p>"

# or simply
env.render_file("./hello.jade", :what => "moon")
#=> "<p>Hello moon!</p>"

Output compiled template function (i.e. for serving your front-end views)

env = Jadeite::Environment.new
env.compile 'p Hello #{what}!', :client => true, :compileDebug => false
#=> function anonymous(locals, attrs, escape, rethrow, merge) {
# var attrs = jade.attrs, escape = jade.escape, rethrow = jade.rethrow, merge = jade.merge;
# var buf = [];
# with (locals || {}) {
# var interp;
# buf.push('<p>Hello ' + escape((interp = what) == null ? '' : interp) + '!</p>');
# }
# return buf.join("");
# }

See https://github.com/visionmedia/jade#browser-support for more info.

API

Instances of Jadeite::Environment has two public methods:

compile(template_string, options) and render(template_string, data, options) in where the options argument for both of them corresponds to the options argument in Jade's public api.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request