tilt 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fceb7a7101d7fee0f5a3d64a4b554c0a0526b028
-  data.tar.gz: 4cfc354aebbcf7d22a7fc85d34cfdc74e17245e3
+  metadata.gz: 647ea82bd6b21c9160337188c95afa692d468048
+  data.tar.gz: fe4a38e1124fc88439048033b73ac69c9e26dabc
 SHA512:
-  metadata.gz: 1ca1be3a71d372a712708730fc265b293da204309fcfc577229b96190f84bbea4f5dfb12d2ce3dbdb93f0adf2330da2ee8f97b07676fb826b61e42560e5c09c6
-  data.tar.gz: ce739c19f41b2dcff91ed9d6827839123407a471d644743ec7c292de4c24185b6b66adeacd968fd065a84d18277ee2b49308bf993af5a98d8f1121218dd1e50f
+  metadata.gz: 7eeb600f8917fef64a15ae0e595afc9e6a99558be4118ca7b96ce81701159061835fe0103d0320a0f82419b553d215fc1961543abb59789273be9514e43b5ae6
+  data.tar.gz: a75cb1d660582518e2512a01da3b9c3ed917b48cea59680752570be482f6db17e79d1d6e2b2225e25c0f96977c5c37acab2e11eda8941883bebd5d20192c67f2

data/CHANGELOG.md

@@ -1,4 +1,16 @@
-## master
+## 2.0.2 (2016-01-06)
+
+* Pass options to Redcarpet (#250, hughbien)
+* Haml: Improve error message on frozen self (judofyr)
+* Add basic support for Babel (judofyr)
+* Add support for .litcoffee (#243, judofyr, mr-vinn)
+* Document Tilt::Cache (#266, tommay)
+* Sort local keys for better caching (#257, jeremyevans)
+* Add more CSV options (#256, Juanmcuello)
+* Add Prawn template (kematzy)
+* Improve cache-miss performance in Tilt::Cache (#251, tommay)
+* Add man page (#241, josephholsten)
+* Support YAML/JSON data in bin/tilt (#241, josephholsten)
 
 ## 2.0.1 (2014-03-21)
 

data/Gemfile

@@ -1,27 +1,48 @@
 source 'https://rubygems.org'
 
-gem 'yard', '~> 0.8.6'
+gem 'rake'
 gem 'minitest', '~> 5.0'
 
-gem 'rake'
+group :development do
+  gem 'yard', '~> 0.8.6'
+  gem 'ronn', '~> 0.7.3'
+end
 
-group :engines do
-  gem 'asciidoctor', '>= 0.1.0'
+can_execjs = (RUBY_VERSION >= '1.9.3')
+
+group :primary do
   gem 'builder'
-  gem 'coffee-script'
-  gem 'contest'
-  gem 'creole'
-  gem 'erubis'
   gem 'haml', '>= 2.2.11', '< 4'
+  gem 'erubis'
+  gem 'markaby'
+  gem 'sass'
+
+  if can_execjs
+    gem 'less'
+    gem 'coffee-script'
+    gem 'babel-transpiler'
+  end
+end
+
+platform :mri do
+  gem 'duktape', '~> 1.2.1.0' if can_execjs
+end
+
+group :secondary do
+  gem 'creole'
   gem 'kramdown'
-  gem 'less'
+  gem 'rdoc'
+  gem 'radius'
+  gem 'asciidoctor', '>= 0.1.0'
   gem 'liquid'
-  gem 'markaby'
   gem 'maruku'
+
+  if RUBY_VERSION > '1.9.3'
+    gem 'prawn', '>= 2.0.0'
+    gem 'pdf-reader', '~> 1.3.3'
+  end
+
   gem 'nokogiri' if RUBY_VERSION > '1.9.2'
-  gem 'radius'
-  gem 'sass'
-  gem 'rdoc', (ENV['RDOC_VERSION'] || '> 0')
 
   platform :ruby do
     gem 'wikicloth'
@@ -32,8 +53,7 @@ group :engines do
   end
 
   platform :mri do
-    gem 'therubyracer'
-    gem 'bluecloth' if ENV['BLUECLOTH']
+    gem 'bluecloth'
   end
 end
 

data/README.md

@@ -1,4 +1,4 @@
-Tilt [![Build Status](https://secure.travis-ci.org/rtomayko/tilt.png)](http://travis-ci.org/rtomayko/tilt) [![Dependency Status](https://gemnasium.com/rtomayko/tilt.png)](https://gemnasium.com/rtomayko/tilt)
+Tilt [![Build Status](https://secure.travis-ci.org/rtomayko/tilt.svg)](http://travis-ci.org/rtomayko/tilt) [![Dependency Status](https://gemnasium.com/rtomayko/tilt.png)](https://gemnasium.com/rtomayko/tilt) [![Inline docs](http://inch-ci.org/github/rtomayko/tilt.png)](http://inch-ci.org/github/rtomayko/tilt)
 ====
 
 **NOTE** The following file documents the current release of Tilt (2.0). See
@@ -24,44 +24,64 @@ template engines included in the distribution.
 
 Support for these template engines is included with the package:
 
-    ENGINE                     FILE EXTENSIONS         REQUIRED LIBRARIES
-    -------------------------- ----------------------- ----------------------------
-    Asciidoctor                .ad, .adoc, .asciidoc   asciidoctor (>= 0.1.0)
-    ERB                        .erb, .rhtml            none (included ruby stdlib)
-    Interpolated String        .str                    none (included ruby core)
-    Erubis                     .erb, .rhtml, .erubis   erubis
-    Haml                       .haml                   haml
-    Sass                       .sass                   haml (< 3.1) or sass (>= 3.1)
-    Scss                       .scss                   haml (< 3.1) or sass (>= 3.1)
-    Less CSS                   .less                   less
-    Builder                    .builder                builder
-    Liquid                     .liquid                 liquid
-    RDiscount                  .markdown, .mkd, .md    rdiscount
-    Redcarpet                  .markdown, .mkd, .md    redcarpet
-    BlueCloth                  .markdown, .mkd, .md    bluecloth
-    Kramdown                   .markdown, .mkd, .md    kramdown
-    Maruku                     .markdown, .mkd, .md    maruku
-    RedCloth                   .textile                redcloth
-    RDoc                       .rdoc                   rdoc
-    Radius                     .radius                 radius
-    Markaby                    .mab                    markaby
-    Nokogiri                   .nokogiri               nokogiri
-    CoffeeScript               .coffee                 coffee-script (+ javascript)
-    Creole (Wiki markup)       .wiki, .creole          creole
-    WikiCloth (Wiki markup)    .wiki, .mediawiki, .mw  wikicloth
-    Yajl                       .yajl                   yajl-ruby
-    CSV                        .rcsv                   none (Ruby >= 1.9), fastercsv (Ruby < 1.9)
+| Engine                  | File Extensions        | Required Libraries                         | Maintainer  |
+| ----------------------- | ---------------------- | ------------------------------------------ | ----------- |
+| Asciidoctor             | .ad, .adoc, .asciidoc  | asciidoctor (>= 0.1.0)                     | Community   |
+| ERB                     | .erb, .rhtml           | none (included ruby stdlib)                | Tilt team   |
+| InterpolatedString      | .str                   | none (included ruby core)                  | Tilt team   |
+| Erubis                  | .erb, .rhtml, .erubis  | erubis                                     | Tilt team   |
+| Haml                    | .haml                  | haml                                       | Tilt team   |
+| Sass                    | .sass                  | haml (< 3.1) or sass (>= 3.1)              | Tilt team   |
+| Scss                    | .scss                  | haml (< 3.1) or sass (>= 3.1)              | Tilt team   |
+| Less CSS                | .less                  | less                                       | Tilt team   |
+| Builder                 | .builder               | builder                                    | Tilt team   |
+| Liquid                  | .liquid                | liquid                                     | Community   |
+| RDiscount               | .markdown, .mkd, .md   | rdiscount                                  | Community   |
+| Redcarpet               | .markdown, .mkd, .md   | redcarpet                                  | Community   |
+| BlueCloth               | .markdown, .mkd, .md   | bluecloth                                  | Community   |
+| Kramdown                | .markdown, .mkd, .md   | kramdown                                   | Community   |
+| Maruku                  | .markdown, .mkd, .md   | maruku                                     | Community   |
+| RedCloth                | .textile               | redcloth                                   | Community   |
+| RDoc                    | .rdoc                  | rdoc                                       | Tilt team   |
+| Radius                  | .radius                | radius                                     | Community   |
+| Markaby                 | .mab                   | markaby                                    | Tilt team   |
+| Nokogiri                | .nokogiri              | nokogiri                                   | Community   |
+| CoffeeScript            | .coffee                | coffee-script (+ javascript)               | Tilt team   |
+| CoffeeScript (literate) | .litcoffee             | coffee-script (>= 1.5.0) (+ javascript)    | Tilt team   |
+| Creole (Wiki markup)    | .wiki, .creole         | creole                                     | Community   |
+| WikiCloth (Wiki markup) | .wiki, .mediawiki, .mw | wikicloth                                  | Community   |
+| Yajl                    | .yajl                  | yajl-ruby                                  | Community   |
+| CSV                     | .rcsv                  | none (Ruby >= 1.9), fastercsv (Ruby < 1.9) | Tilt team   |
+| Prawn                   | .prawn                 | prawn (>= 2.0.0)                           | Community   |
+| Babel                   | .es6, .babel, .jsx     | babel-transpiler                           | Tilt team   |
+| Opal                    | .rb                    | opal                                       | Community   |
+
+Every supported template engine has a *maintainer*. Note that this is the
+maintainer of the Tilt integration, not the maintainer of the template engine
+itself. The maintainer is responsible for providing an adequate integration and
+keeping backwards compatibility across Tilt version. Some integrations are
+maintained by the *community*, which is handled in the following way:
+
+- The Tilt team will liberally accept pull requests against the template
+  integration. It's up the community as a whole to make sure the integration
+  stays consistent and backwards compatible over time.
+- Test failures in community-maintained integrations will not be prioritized by
+  the Tilt team and a new version of Tilt might be released even though these
+  tests are failing.
+- Anyone can become a maintainer for a template engine integration they care
+  about. Just open an issue and we'll figure it out.
 
 These template engines ship with their own Tilt integration:
 
-    ENGINE                     FILE EXTENSIONS   REQUIRED LIBRARIES
-    -------------------------- ----------------- ----------------------------
-    Slim                       .slim             slim (>= 0.7)
-    Embedded JavaScript                          sprockets
-    Embedded CoffeeScript                        sprockets
-    JST                                          sprockets
-    Org-mode                   .org              org-ruby (>= 0.6.2)
-    Handlebars                 .hbs, .handlebars tilt-handlebars
+| Engine                | File Extensions  | Required Libraries  |
+| -------------------   | ---------------- | ------------------- |
+| Slim                  | .slim            | slim (>= 0.7)       |
+| Embedded JavaScript   |                  | sprockets           |
+| Embedded CoffeeScript |                  | sprockets           |
+| JST                   |                  | sprockets           |
+| Org-mode              | .org             | org-ruby (>= 0.6.2) |
+| Handlebars            | .hbs, handlebars | tilt-handlebars     |
+| Jbuilder              | .jbuilder        | tilt-jbuilder       |
 
 See [TEMPLATES.md][t] for detailed information on template engine
 options and supported features.
@@ -77,7 +97,7 @@ Instant gratification:
     require 'erb'
     require 'tilt'
     template = Tilt.new('templates/foo.erb')
-    => #<Tilt::ERBTemplate @file="templates/foo.rb" ...>
+    => #<Tilt::ERBTemplate @file="templates/foo.erb" ...>
     output = template.render
     => "Hello world!"
 

data/Rakefile

@@ -15,19 +15,29 @@ end
 
 # DOCUMENTATION =============================================================
 
-require 'yard'
-YARD::Rake::YardocTask.new do |t|
-  t.files = [
-    'lib/tilt.rb', 'lib/tilt/mapping.rb', 'lib/tilt/template.rb',
-    '-',
-    '*.md', 'docs/*.md',
-  ]
-
-  t.options <<
-    '--no-private' <<
-    '--protected' <<
-    '-m' << 'markdown' <<
-    '--asset' << 'docs/common.css:css/common.css'
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = [
+      'lib/tilt.rb', 'lib/tilt/mapping.rb', 'lib/tilt/template.rb',
+      '-',
+      '*.md', 'docs/*.md',
+    ]
+
+    t.options <<
+      '--no-private' <<
+      '--protected' <<
+      '-m' << 'markdown' <<
+      '--asset' << 'docs/common.css:css/common.css'
+  end
+rescue LoadError
+end
+
+task :man do
+  require 'ronn'
+  ENV['RONN_MANUAL'] = "Tilt Manual"
+  ENV['RONN_ORGANIZATION'] = "Tilt #{SPEC.version}"
+  sh "ronn -w -s toc -r5 --markdown man/*.ronn"
 end
 
 # PACKAGING =================================================================

data/bin/tilt

@@ -10,14 +10,15 @@ when <file> is '-', read template from stdin and use the --type option
 to determine the template's type.
 
 Options
-  -l, --list           List template engines + file patterns and exit
-  -t, --type=<pattern> Use this template engine; required if no <file>
-  -y, --layout=<file>  Use <file> as a layout template
+  -l, --list                List template engines + file patterns and exit
+  -t, --type=<pattern>      Use this template engine; required if no <file>
+  -y, --layout=<file>       Use <file> as a layout template
 
-  -D<name>=<value>     Define variable <name> as <value>
-  --vars=<ruby>        Evaluate <ruby> to Hash and use for variables
+  -D<name>=<value>          Define variable <name> as <value>
+  -d, --define-file=<file>  Load YAML from <file> and use for variables
+  --vars=<ruby>             Evaluate <ruby> to Hash and use for variables
 
-  -h, --help           Show this help message
+  -h, --help                Show this help message
 
 Convert markdown to HTML:
   $ tilt foo.markdown > foo.html
@@ -77,6 +78,15 @@ ARGV.options do |o|
     locals[key.to_sym] = value
   end
 
+  # define local variables from YAML or JSON
+  o.on("-d", "--define-file=FILE", String) do |file|
+    require 'yaml'
+    abort "no such define file: #{file}" unless File.exist? file
+    hash = File.open(file, 'r:bom|utf-8') { |f| YAML.load f, file }
+    abort "vars must be a Hash, not #{hash.inspect}" if !hash.is_a?(Hash)
+    hash.each { |key, value| locals[key.to_sym] = value }
+  end
+
   # define local variables using a Ruby hash
   o.on("--vars=RUBY") do |ruby|
     hash = eval(ruby)

data/docs/TEMPLATES.md

@@ -31,6 +31,7 @@ Tilt also includes support for CSS processors like [LessCSS][lesscss] and
  * Sass - `Tilt::SassTemplate`
  * Scss - `Tilt::ScssTemplate`
  * CoffeeScript - `Tilt::CoffeeScriptTemplate`
+ * Literate CoffeeScript - `Tilt::CoffeeScriptLiterateTemplate`
  * [Textile](#redcloth) - `Tilt::RedClothTemplate`
  * Creole - `Tilt::CreoleTemplate`
  * [RDoc](#rdoc) - `Tilt::RDocTemplate`

data/lib/tilt.rb

@@ -4,7 +4,7 @@ require 'tilt/template'
 # Namespace for Tilt. This module is not intended to be included anywhere.
 module Tilt
   # Current version.
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 
   @default_mapping = Mapping.new
 
@@ -78,14 +78,31 @@ module Tilt
   #     cache.fetch(path, line, options) { Tilt.new(path, line, options) }
   #
   # Subsequent invocations return the already loaded template object.
+  #
+  # @note
+  #   Tilt::Cache is a thin wrapper around Hash.  It has the following
+  #   limitations:
+  #   * Not thread-safe.
+  #   * Size is unbounded.
+  #   * Keys are not copied defensively, and should not be modified after
+  #     being passed to #fetch.  More specifically, the values returned by
+  #     key#hash and key#eql? should not change.
+  #   If this is too limiting for you, use a different cache implementation.
   class Cache
     def initialize
       @cache = {}
     end
 
-    # @see Cache
+    # Caches a value for key, or returns the previously cached value.
+    # If a value has been previously cached for key then it is
+    # returned. Otherwise, block is yielded to and its return value
+    # which may be nil, is cached under key and returned.
+    # @yield
+    # @yieldreturn the value to cache for key
     def fetch(*key)
-      @cache[key] ||= yield
+      @cache.fetch(key) do
+        @cache[key] = yield
+      end
     end
 
     # Clears the cache.
@@ -110,9 +127,11 @@ module Tilt
 
   # Rest (sorted by name)
   register_lazy :AsciidoctorTemplate,  'tilt/asciidoc',  'ad', 'adoc', 'asciidoc'
+  register_lazy :BabelTemplate,        'tilt/babel',     'es6', 'babel', 'jsx'
   register_lazy :BuilderTemplate,      'tilt/builder',   'builder'
   register_lazy :CSVTemplate,          'tilt/csv',       'rcsv'
   register_lazy :CoffeeScriptTemplate, 'tilt/coffee',    'coffee'
+  register_lazy :CoffeeScriptLiterateTemplate, 'tilt/coffee', 'litcoffee'
   register_lazy :CreoleTemplate,       'tilt/creole',    'wiki', 'creole'
   register_lazy :EtanniTemplate,       'tilt/etanni',    'etn', 'etanni'
   register_lazy :HamlTemplate,         'tilt/haml',      'haml'
@@ -121,6 +140,7 @@ module Tilt
   register_lazy :MarkabyTemplate,      'tilt/markaby',   'mab'
   register_lazy :NokogiriTemplate,     'tilt/nokogiri',  'nokogiri'
   register_lazy :PlainTemplate,        'tilt/plain',     'html'
+  register_lazy :PrawnTemplate,        'tilt/prawn',     'prawn'
   register_lazy :RDocTemplate,         'tilt/rdoc',      'rdoc'
   register_lazy :RadiusTemplate,       'tilt/radius',    'radius'
   register_lazy :RedClothTemplate,     'tilt/redcloth',  'textile'
@@ -134,4 +154,6 @@ module Tilt
   register_lazy 'Slim::Template',            'slim',            'slim'
   register_lazy 'Tilt::HandlebarsTemplate',  'tilt/handlebars', 'handlebars', 'hbs'
   register_lazy 'Tilt::OrgTemplate',         'org-ruby',        'org'
+  register_lazy 'Opal::Processor',           'opal',            'opal', 'rb'
+  register_lazy 'Tilt::JbuilderTemplate',    'tilt/jbuilder',   'jbuilder'
 end

data/lib/tilt/babel.rb

@@ -0,0 +1,15 @@
+require 'tilt/template'
+require 'babel/transpiler'
+
+module Tilt
+  class BabelTemplate < Template
+    def prepare
+      options[:filename] ||= file
+    end
+
+    def evaluate(scope, locals, &block)
+      @output ||= Babel::Transpiler.transform(data)["code"]
+    end
+  end
+end
+

data/lib/tilt/coffee.rb

@@ -29,10 +29,15 @@ module Tilt
       @@default_bare = value
     end
 
+    def self.literate?
+      false
+    end
+
     def prepare
       if !options.key?(:bare) and !options.key?(:no_wrap)
         options[:bare] = self.class.default_bare
       end
+      options[:literate] ||= self.class.literate?
     end
 
     def evaluate(scope, locals, &block)
@@ -43,5 +48,11 @@ module Tilt
       false
     end
   end
+
+  class CoffeeScriptLiterateTemplate < CoffeeScriptTemplate
+    def self.literate?
+      true
+    end
+  end
 end
 

data/lib/tilt/csv.rb

@@ -45,15 +45,15 @@ module Tilt
     end
 
     def prepare
-      @code =<<-RUBY
-        #{self.class.engine}.generate do |csv|
-          #{data}
-        end
-      RUBY
+      @outvar = options.delete(:outvar) || '_csvout'
     end
 
     def precompiled_template(locals)
-      @code
+      <<-RUBY
+        #{@outvar} = #{self.class.engine}.generate(#{options}) do |csv|
+          #{data}
+        end
+      RUBY
     end
 
     def precompiled(locals)

data/lib/tilt/haml.rb

@@ -13,6 +13,8 @@ module Tilt
     end
 
     def evaluate(scope, locals, &block)
+      raise ArgumentError, 'invalid scope: must not be frozen' if scope.frozen?
+
       if @engine.respond_to?(:precompiled_method_return_value, true)
         super
       else
@@ -47,11 +49,10 @@ module Tilt
         <<-RUBY
             #{precompiled_method_return_value}
           ensure
-            @haml_buffer = @haml_buffer.upper
+            @haml_buffer = @haml_buffer.upper if @haml_buffer
           end
         RUBY
       end
     end
   end
 end
-