jadeite 0.0.1

data/.gitignore

@@ -0,0 +1,27 @@
+*.gem
+*.rbc
+.bundle
+/tmp
+.DS_Store
+.rvmrc
+*~
+coverage/
+.idea
+node_modules
+npm-debug.log
+/.sass-cache
+/log/*
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Bengler AS
+
+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,100 @@
+```
+________       _________    __________      
+______(_)_____ ______  /_______(_)_  /_____ 
+_____  /_  __ `/  __  /_  _ \_  /_  __/  _ \
+____  / / /_/ // /_/ / /  __/  / / /_ /  __/
+___  /  \__,_/ \__,_/  \___//_/  \__/ \___/ 
+/___/ Compile and render Jade templates from Ruby
+
+```
+
+Jadeite lets you compile and render [Jade](http://jade-lang.com) templates from your Ruby code.
+Under the hood it uses the Jade node module running in
+[therubyracer's](https://github.com/cowboyd/therubyracer) 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
+
+```ruby
+env = Jadeite::Environment.new
+env.render('p Hello #{what}!', {:what =>"world"})
+#=> "<p>Hello world!</p>"
+```
+
+### Compile once, render twice (or more)
+
+```ruby
+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
+
+```ruby
+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)
+
+```ruby
+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](https://github.com/visionmedia/jade#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

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => :prepare
+task :prepare do
+  puts "Running npm install"
+  system("npm install")
+  system("npm shrinkwrap")
+end

data/jadeite.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jadeite/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors           = ["Bjørge Næss"]
+  gem.email             = ["bjoerge@bengler.no"]
+  gem.description       = %q{Compile and render Jade templates from Ruby}
+  gem.summary           = %q{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.}
+  gem.homepage          = ""
+  
+  gem.files             = `git ls-files`.split($\)
+  gem.executables       = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files        = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name              = "jadeite"
+  gem.rubyforge_project = "jadeite"  
+  gem.require_paths     = ["lib"]
+  gem.version           = Jadeite::VERSION
+
+  gem.extensions = "Rakefile"
+
+  gem.add_dependency "therubyracer"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "simplecov"
+end

data/lib/jadeite.rb

@@ -0,0 +1,6 @@
+require "jadeite/version"
+require "jadeite/environment"
+
+module Jadeite
+  
+end

data/lib/jadeite/environment.rb

@@ -0,0 +1,45 @@
+require 'v8'
+require "nodejs"
+
+module Jadeite
+  class Environment
+    def initialize
+      context = V8::Context.new
+      context.eval("var process = {env: {}}")
+      context.load(File.expand_path(File.join('../../../', 'node_modules/jade/runtime.js'), __FILE__))
+
+      node_env = NodeJS::Environment.new(context, File.expand_path('../../', __FILE__))
+      @jade = node_env.require('jade')
+    end
+
+    def compile(template_str, opts={})
+      Template.new(@jade.compile(template_str.strip, opts))
+    end
+
+    def render(template_str, data={}, opts={})
+      compile(template_str, opts).render(data)
+    end
+  
+    def compile_file(file, opts = {})
+      opts.merge!(:filename => File.expand_path(file))
+      compile(File.read(file), opts)
+    end
+
+    def render_file(file, data={}, opts = {})
+      compile_file(file, opts).render(data)
+    end
+  end
+
+  private
+  class Template
+    def initialize(compiled)
+      @compiled = compiled
+    end
+    def render(data={})
+      @compiled.call data
+    end
+    def to_s
+      @compiled.to_s
+    end
+  end
+end

data/lib/jadeite/version.rb

@@ -0,0 +1,3 @@
+module Jadeite
+  VERSION = "0.0.1"
+end

data/lib/nodejs.rb

@@ -0,0 +1,13 @@
+require "nodejs/environment"
+require "nodejs/module"
+module NodeJS
+  @builtins = {}
+  def self.register_builtin(sym, klass)
+    @builtins[sym.to_s] = klass
+  end
+  def self.builtins
+    @builtins
+  end
+
+  require "nodejs/builtins"
+end

data/lib/nodejs/README.md

@@ -0,0 +1,29 @@
+A Naïve implementation of Node.js require() in [therubyracer](https://github.com/cowboyd/therubyracer).
+
+Based on [commonjs.rb](https://github.com/cowboyd/commonjs.rb) by Charles Lowell (cowboyd) but has a few notable extra features:
+
+- If a directory is passed to require(), it will look for dirname/index.js
+- If a module id is passed to require(), it will look in the node_modules subdirectory for a directory matching the module name,
+  read package.json from that directory and require the main entry javascript file.
+
+# Disclaimer
+
+This is by no means a solid implementation of the module loader in NPM. It is written to solve a very
+specific task: to be able to require the jade npm module in therubyracer. If it works with other libraries, 
+it is most likely out of pure luck.
+
+# Usage:
+
+```ruby
+
+env = NodeJS::Environment.new(V8::Context.new, File.expand_path(__FILE__))
+
+# Will look for ./node_modules/lalala/package.json and require() the specified main entry file
+lalala = env.require("lalala")
+puts lalala.saySomething("arg1", "arg2")
+
+somejs = env.require("./path/to/some.js")
+
+puts somejs.doSomething(:test => "hello")
+
+```

data/lib/nodejs/builtins.rb

@@ -0,0 +1,21 @@
+# Quick and dirty implementations of the node.js standard modules as required by Jade
+module NodeJS
+
+  NodeJS.register_builtin('fs', {
+    :readFileSync => lambda {|this, file, encoding|
+      File.read(file).force_encoding("utf-8")
+    }
+  })
+
+  NodeJS.register_builtin('path', {
+    :dirname => lambda { |this, file|
+      File.dirname(file)
+    },
+    :basename => lambda { |this, *args|
+      File.basename(*args)
+    },
+    :join => lambda { |this, *args|
+      File.join(*args)
+    }
+    })
+end

data/lib/nodejs/environment.rb

@@ -0,0 +1,52 @@
+require 'json'
+require 'pathname'
+module NodeJS
+  class Environment
+    def initialize(runtime, base_path)
+      @runtime = runtime
+      @base_path = Pathname(base_path)
+      @cache = {}
+    end
+
+    def new_object
+      @runtime['Object'].new
+    end
+
+    def require(module_or_path)
+      # module main or single js file to require
+
+      return NodeJS.builtins[module_or_path] if NodeJS.builtins[module_or_path]
+      
+      file = NodeJS.resolve(@base_path.dirname, module_or_path)
+      return @cache[file].exports if @cache[file]
+
+      mod = @cache[file] = Module.new(self, file)
+
+      loader = @runtime.eval("(function(module, require, exports) {#{File.read(file)}});", file.to_s)
+      loader.call(mod, mod.require_function, mod.exports)
+      mod.exports
+    end
+  end
+
+  def self.resolve(base_path, module_or_path)
+    NodeJS.send(module_or_path =~ /^(\.|\/)/ ? :resolve_file : :resolve_module, base_path, module_or_path)
+  end
+
+  def self.resolve_file(base_path, path)
+    full_path = base_path.join(path)
+    return NodeJS.resolve_file(base_path, full_path.join("index.js")) if full_path.directory?
+    unless File.exists?(full_path) && full_path.extname =~ /\.js$/
+      full_path = Pathname("#{full_path.to_s}.js")
+    end
+    fail LoadError, "Module '#{full_path}' not found" unless full_path.file?
+    full_path
+  end
+
+  def self.resolve_module(base_path, module_name)
+    module_dir = base_path.join("node_modules", module_name)
+    package_json = module_dir.join("package.json")
+    fail LoadError, "Module '#{module_name}' not found" unless package_json.file?
+    module_def = JSON.parse(File.read(package_json))
+    module_dir.join(module_def['main'])
+  end
+end

data/lib/nodejs/module.rb

@@ -0,0 +1,28 @@
+module NodeJS
+  class Module
+    attr_accessor :exports
+    def initialize(environmnent, file)
+      @environment = environmnent
+      @file = file
+      @exports = @environment.new_object
+    end
+
+    # Used to require both script files and modules
+    # Script path is relative from base path and defines where the require function will begin looking for 
+    # require()'d js-files
+    # script_path is ignored when requiring modules, i.e. require("jade")
+    def require_function
+      lambda do |*args|
+        this, module_id = *args
+
+        module_id ||= this #backwards compatibility with TRR < 0.10
+
+        return @environment.require(module_id) if NodeJS.builtins.keys.include?(module_id)
+
+        #puts "requiring #{module_id} from #{CommonJS.resolve(@file.dirname, module_id).to_s}"
+        @environment.require(NodeJS.resolve(@file.dirname, module_id).to_s)
+      end
+    end
+
+  end
+end

data/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "jadeite",
+  "version": "0.0.0",
+  "dependencies": {
+    "jade": "latest"
+  },
+  "engines": {
+    "node": "*"
+  }
+}

data/spec/fixtures/auxiliary/escapes.html

@@ -0,0 +1,3 @@
+<script>
+  console.log("foo\nbar")
+</script>

data/spec/fixtures/auxiliary/layout.jade

@@ -0,0 +1,6 @@
+html
+  head
+    title My Application
+    block head
+  body
+    block content

data/spec/fixtures/auxiliary/mixins.jade

@@ -0,0 +1,3 @@
+
+mixin foo()
+  p bar

data/spec/fixtures/auxiliary/smile.html

@@ -0,0 +1 @@
+<p>:)</p>

data/spec/fixtures/form.jade

@@ -0,0 +1,29 @@
+form(method="post")
+  fieldset
+    legend General
+    p
+      label(for="user[name]") Username:
+        input(type="text", name="user[name]", value=user.name)
+    p
+      label(for="user[email]") Email:
+        input(type="text", name="user[email]", value=user.email)
+        .tip.
+          Enter a valid 
+          email address 
+          such as <em>tj@vision-media.ca</em>.
+  fieldset
+    legend Location
+    p
+      label(for="user[city]") City:
+        input(type="text", name="user[city]", value=user.city)
+    p
+      select(name="user[province]")
+        option(value="") -- Select Province --
+        option(value="AB") Alberta
+        option(value="BC") British Columbia
+        option(value="SK") Saskatchewan
+        option(value="MB") Manitoba
+        option(value="ON") Ontario
+        option(value="QC") Quebec
+  p.buttons
+    input(type="submit", value="Save")

data/spec/fixtures/include-mixin.jade

@@ -0,0 +1,11 @@
+
+extend auxiliary/layout
+
+mixin article(title)
+  if title
+    h1= title
+  block
+
+block content
+  +article("The meaning of life")
+    p Foo bar baz!

data/spec/fixtures/includes.jade

@@ -0,0 +1,7 @@
+include auxiliary/mixins
+
++foo
+
+body
+  include auxiliary/smile.html
+  include auxiliary/escapes.html

data/spec/jade_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'jadeite'
+
+describe "Jadeite" do
+  let(:template_str) {
+    <<-jade
+      p Hello \#{who}
+      - if (awesome)
+        em Pretty awesome
+      p=a.nested.title
+      p.
+        plain text can have a
+        body inside an element
+    jade
+  }
+  let(:template_data) {
+    {:who => "world", :awesome => true, :a => {:nested => {:title => "This is the nested title"}}}
+  }
+
+  let(:env) {
+    Jadeite::Environment.new
+  }
+  let(:fixtures_path) {"./spec/fixtures"}
+
+  it "renders a jade template with data" do
+    env.render(template_str, template_data).should eql "<p>Hello world<em>Pretty awesome</em><p>This is the nested title</p><p>plain text can have a\nbody inside an element</p></p>"
+  end
+
+  it "can reference a compiled template and render it several times with various data" do
+
+    compiled = env.compile(template_str, template_data)
+
+    compiled.render(template_data).should eql "<p>Hello world<em>Pretty awesome</em><p>This is the nested title</p><p>plain text can have a\nbody inside an element</p></p>"
+
+    other_data = {:who => "moon!", :awesome => false, :a => {:nested => {:title => "Have you seen my dark side?"}}}
+    compiled.render(other_data).should eql "<p>Hello moon!<p>Have you seen my dark side?</p><p>plain text can have a\nbody inside an element</p></p>"
+
+  end
+
+  it "Will fail if reference data is missing" do
+
+    compiled = env.compile(template_str, template_data)
+
+    other_data = {:who => "moon!", :awesome => false, :a => {}}
+    ->{ compiled.render(other_data) }.should raise_error(V8::JSError, "Cannot read property 'title' of undefined")
+  end
+
+  it "Can handle a more complex example" do
+
+    compiled = env.compile(File.read("#{fixtures_path}/form.jade"))
+    
+    compiled.render(:user => {:name => "Bengel"}).should eq "<form method=\"post\"><fieldset><legend>General</legend><p><label for=\"user[name]\">Username:<input type=\"text\" name=\"user[name]\" value=\"Bengel\"/></label></p><p><label for=\"user[email]\">Email:<input type=\"text\" name=\"user[email]\"/><div class=\"tip\">Enter a valid \nemail address \nsuch as <em>tj@vision-media.ca</em>.</div></label></p></fieldset><fieldset><legend>Location</legend><p><label for=\"user[city]\">City:<input type=\"text\" name=\"user[city]\"/></label></p><p><select name=\"user[province]\"><option value=\"\">-- Select Province --</option><option value=\"AB\">Alberta</option><option value=\"BC\">British Columbia</option><option value=\"SK\">Saskatchewan</option><option value=\"MB\">Manitoba</option><option value=\"ON\">Ontario</option><option value=\"QC\">Quebec</option></select></p></fieldset><p class=\"buttons\"><input type=\"submit\" value=\"Save\"/></p></form>"
+
+  end
+
+  it "Handles includes" do
+    
+    compiled = env.compile_file("#{fixtures_path}/includes.jade")
+
+    compiled.render.should eq "<p>bar</p><body><p>:)</p><script>\n  console.log(\"foo\\nbar\")\n</script></body>"
+
+  end
+
+  it "Handles includes and mixins" do
+    
+    compiled = env.compile_file("#{fixtures_path}/include-mixin.jade")
+
+    compiled.render.should eq "<html><head><title>My Application</title></head><body><h1>The meaning of life</h1><p>Foo bar baz!</p></body></html>"
+
+  end
+
+  it "Can render a file" do
+    env.render_file("#{fixtures_path}/include-mixin.jade").should eq "<html><head><title>My Application</title></head><body><h1>The meaning of life</h1><p>Foo bar baz!</p></body></html>"
+  end
+
+  it "Returns a string of the compiled template" do
+    env.compile("p", :client => true, :compileDebug => false).to_s.should eq "function anonymous(locals, attrs, escape, rethrow, merge) {\nattrs = attrs || jade.attrs; escape = escape || jade.escape; rethrow = rethrow || jade.rethrow; merge = merge || jade.merge;\nvar buf = [];\nwith (locals || {}) {\nvar interp;\nbuf.push('<p></p>');\n}\nreturn buf.join(\"\");\n}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler'
+require 'simplecov'
+SimpleCov.add_filter "spec"
+SimpleCov.start
+
+Bundler.require

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: jadeite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bjørge Næss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: therubyracer
+  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: rspec
+  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: simplecov
+  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'
+description: Compile and render Jade templates from Ruby
+email:
+- bjoerge@bengler.no
+executables: []
+extensions:
+- Rakefile
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jadeite.gemspec
+- lib/jadeite.rb
+- lib/jadeite/environment.rb
+- lib/jadeite/version.rb
+- lib/nodejs.rb
+- lib/nodejs/README.md
+- lib/nodejs/builtins.rb
+- lib/nodejs/environment.rb
+- lib/nodejs/module.rb
+- package.json
+- spec/fixtures/auxiliary/escapes.html
+- spec/fixtures/auxiliary/layout.jade
+- spec/fixtures/auxiliary/mixins.jade
+- spec/fixtures/auxiliary/smile.html
+- spec/fixtures/form.jade
+- spec/fixtures/include-mixin.jade
+- spec/fixtures/includes.jade
+- spec/jade_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: jadeite
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: 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.
+test_files:
+- spec/fixtures/auxiliary/escapes.html
+- spec/fixtures/auxiliary/layout.jade
+- spec/fixtures/auxiliary/mixins.jade
+- spec/fixtures/auxiliary/smile.html
+- spec/fixtures/form.jade
+- spec/fixtures/include-mixin.jade
+- spec/fixtures/includes.jade
+- spec/jade_spec.rb
+- spec/spec_helper.rb
+has_rdoc: