jade 0.1.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in jade.gemspec
+gemspec
+
+group :test do
+  gem 'johnson',      :platform => :mri_18
+  gem 'therubyracer', :platform => :ruby
+  gem 'therubyrhino', :platform => :jruby
+end

data/README.md

@@ -0,0 +1,71 @@
+Jade
+====
+
+Jade.JS is most popular Node.JS templating framework. This gem gives
+you ability to easily compile Jade templates at server-side (similar 
+to how the Sprockets .eco engine works).
+
+Gem supposed to be used with JST engine.
+
+Example
+-------
+
+sample.jst.jade:
+
+    !!!5
+    head
+      title Hello, #{name} :)
+    body
+      | Yap, it works
+
+application.js (require runtime.js before templates):
+  
+    //= require jade/runtime
+    //= require sample
+    $('body').html(JST['sample']({name: 'Billy Bonga'}))
+
+
+Limitations
+-----------
+
+Includes don't work with this implementation. A workaround is to use something like 
+
+    = JST['include/foo']()
+
+Credits
+-------
+
+This implementation was greatly inspired by two similar gems:
+
+  - [ruby-haml-js](https://github.com/dnagir/ruby-haml-js)
+  - [tilt-jade](https://github.com/therabidbanana/tilt-jade)
+  
+It was developed as a successor to tilt-jade to improve following:
+
+  * Add debugging capabilities (slightly different build technique)
+  * Support exact Jade.JS lib without modifications
+  * Do not hold 3 copies of Jade.JS internally
+  * Be well-covered with RSpec
+
+License
+-------
+
+    Copyright (C) 2011 by Boris Staal <boris@roundlake.ru>
+
+    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/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')

data/jade.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jade/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jade"
+  s.version     = Jade::VERSION
+  s.authors     = ["Boris Staal"]
+  s.email       = ["boris@roundlake.ru"]
+  s.homepage    = ""
+  s.summary     = %q{Server-side Jade compiler based on Tilt}
+  s.description = %q{Jade is a high performance template engine heavily influenced by Haml and implemented with JavaScript for node.}
+
+  s.rubyforge_project = "jade"
+
+  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 'execjs'
+  s.add_dependency 'tilt'
+  s.add_dependency 'sprockets'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rails', '>= 3.1'
+  s.add_development_dependency 'pry'
+end

data/lib/jade.rb

@@ -0,0 +1,4 @@
+require 'jade/source'
+require 'jade/compiler'
+require 'jade/template'
+require 'jade/engine' if defined?(::Rails)

data/lib/jade/compiler.rb

@@ -0,0 +1,41 @@
+require 'execjs'
+
+module Jade
+  class Compiler
+    attr_accessor :options
+
+    def initialize(options={})
+      @options = {
+        :client => true,
+        :compileDebug => false
+      }.merge options
+    end
+
+    def source
+      @source ||= %{
+        var window = {};
+        #{Jade::Source::jade}
+        var jade = window.jade;
+      }
+    end
+
+    def context
+      @context ||= ExecJS.compile source
+    end
+
+    def jade_version
+      context.eval("jade.version")
+    end
+
+    def compile(template)
+      template = template.read if template.respond_to?(:read)
+      template = context.eval("jade.precompile(#{template.to_json}, #{@options.to_json})")
+
+      %{
+        function(locals){
+          #{template}
+        }
+      }
+    end
+  end
+end

data/lib/jade/engine.rb

@@ -0,0 +1,10 @@
+require 'sprockets'
+
+module Jade
+  class Engine < Rails::Engine
+    initializer "jade.configure_rails_initialization", :before => 'sprockets.environment', :group => :all do |app|
+      next unless app.config.assets.enabled
+      Sprockets.register_engine '.jade', ::Jade::Template
+    end
+  end
+end

data/lib/jade/source.rb

@@ -0,0 +1,19 @@
+module Jade
+  module Source
+    def self.jade
+      IO.read jade_path
+    end
+
+    def self.runtime
+      IO.read runtime_path
+    end
+
+    def self.jade_path
+      File.expand_path("../../../vendor/assets/javascripts/jade/jade.js", __FILE__)
+    end
+
+    def self.runtime_path
+      File.expand_path("../../../vendor/assets/javascripts/jade/runtime.js", __FILE__)
+    end
+  end
+end

data/lib/jade/template.rb

@@ -0,0 +1,29 @@
+require 'tilt/template'
+
+module Jade
+  class Template < Tilt::Template
+    self.default_mime_type = 'application/javascript'
+
+    def self.engine_initialized?
+      defined? ::ExecJS
+    end
+
+    def initialize_engine
+      require_template_library 'execjs'
+    end
+
+    def prepare
+    end
+
+    def evaluate(scope, locals, &block)
+      compile_function
+    end
+
+  private
+
+    def compile_function
+      Jade::Compiler.new(:filename => file).compile data
+    end
+
+  end
+end

data/lib/jade/version.rb

@@ -0,0 +1,3 @@
+module Jade
+  VERSION = "0.1.0"
+end

data/spec/compiler_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Jade::Compiler do
+  before :each do
+    @compiler = Jade::Compiler.new
+  end
+
+  it "should respect default options" do
+    @compiler.options.should == {
+      :client => true,
+      :compileDebug => false
+    }
+  end
+
+  it "should contain ExecJS context" do
+    @compiler.context.eval("window.jade").should_not be_empty
+  end
+
+  it "should define Jade.JS compiler version" do
+    @compiler.jade_version.should == "0.20.0"
+  end
+
+  it "should compile small thing" do
+    @compiler.compile('test').should include "<test>"
+  end
+
+  it "should depend on options" do
+    @compiler.compile('test').should_not include "lineno: 1"
+    @compiler.options[:compileDebug] = true
+    @compiler.compile('test').should include "lineno: 1"
+  end
+end

data/spec/dummy/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy/Gemfile

@@ -0,0 +1,18 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.1.3'
+
+platform :ruby do
+  gem 'sqlite3'
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'jruby-openssl'
+end
+
+group :assets do
+  gem 'sass-rails',   '~> 3.1.5'
+  gem 'coffee-rails', '~> 3.1.1'
+  gem 'uglifier', '>= 1.0.3'
+end

data/spec/dummy/README

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.