tilt 1.3.3 → 1.4.0

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+## master
+
+## 1.4.0 (2013-05-01)
+
+* Better encoding support
+
+## 1.3.7 (2013-04-09)
+
+* Erubis: Check for the correct constant (#183, mattwildig)
+* Don't fail when BasicObject is defined in 1.8 (#182, technobrat, judofyr)
+
+## 1.3.6 (2013-03-17)
+
+* Accept Hash that implements #path as options (#180, lawso017)
+* Changed extension for CsvTemplate from '.csv' to '.rcsv' (#177, alexgb)
+
+## 1.3.5 (2013-03-06)
+
+* Fixed extension for PlainTemplate (judofyr)
+* Improved local variables regexp (#174, razorinc)
+* Added CHANGELOG.md
+
+## 1.3.4 (2013-02-28)
+
+* Support RDoc 4.0 (#168, judofyr)
+* Add mention of Org-Mode support (#165, aslakknutsen)
+* Add AsciiDoctorTemplate (#163, #164, aslakknutsen)
+* Add PlainTextTemplate (nathanaeljones)
+* Restrict locals to valid variable names (#158, thinkerbot)
+* ERB: Improve trim mode support (#156, ssimeonov)
+* Add CSVTemplate (#153, alexgb)
+* Remove special case for 1.9.1 (#147, guilleiguaran)
+* Add allows\_script? method to Template (#143, bhollis)
+* Default to using Redcarpet2 (#139, DAddYE)
+* Allow File/Tempfile as filenames (#134, jamesotron)
+* Add EtanniTemplate (#131, manveru)
+* Support RDoc 3.10 (#112, timfel)
+* Always compile templates; remove old source evaluator (rtomayko)
+* Less: Options are now being passed to the parser (#106, cowboyd)
+

data/COPYING

@@ -13,6 +13,6 @@ 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 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+THE AUTHORS 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/Gemfile

@@ -1,2 +1,32 @@
 source "http://rubygems.org"
-gemspec
+
+gem 'rake'
+gem 'asciidoctor', '>= 0.1.0'
+gem 'builder'
+gem 'coffee-script'
+gem 'contest'
+gem 'creole'
+gem 'erubis'
+gem 'haml', '>= 2.2.11', '< 4'
+gem 'kramdown'
+gem 'less'
+gem 'liquid'
+gem 'markaby'
+gem 'maruku'
+gem 'nokogiri'
+gem 'radius'
+gem 'sass'
+gem 'wikicloth'
+gem 'rdoc', (ENV['RDOC_VERSION'] || '> 0')
+
+platform :ruby do
+  gem 'yajl-ruby'
+  gem 'redcarpet'
+  gem 'rdiscount' if RUBY_VERSION != '1.9.2'
+  gem 'RedCloth'
+end
+
+platform :mri do
+  gem 'therubyracer'
+  gem 'bluecloth'
+end

data/HACKING

@@ -0,0 +1,16 @@
+Clone:
+
+    git clone git://github.com/rtomayko/tilt.git
+    cd tilt
+
+Install needed packages under ./vendor and run tests (requires bundler):
+
+    rake
+
+Run tests under your current gem environment. Do not install anything:
+
+    rake test
+
+Only install needed packages under ./vendor:
+
+    rake setup

data/README.md

@@ -1,4 +1,4 @@
-Tilt
+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 is a thin interface over a bunch of different Ruby template engines in
@@ -23,6 +23,7 @@ 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
@@ -46,6 +47,7 @@ Support for these template engines is included with the package:
     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)
 
 These template engines ship with their own Tilt integration:
 
@@ -55,6 +57,7 @@ These template engines ship with their own Tilt integration:
     Embedded JavaScript                          sprockets
     Embedded CoffeeScript                        sprockets
     JST                                          sprockets
+    Org-mode                   .org              org-ruby (>= 0.6.2)
 
 See [TEMPLATES.md][t] for detailed information on template engine
 options and supported features.
@@ -184,13 +187,34 @@ template, but if you depend on a specific implementation, you should use #prefer
 
     # Prefer BlueCloth for all its registered extensions (markdown, mkd, md)
     Tilt.prefer Tilt::BlueClothTemplate
-    
+
     # Prefer Erubis for .erb only:
     Tilt.prefer Tilt::ErubisTemplate, 'erb'
 
 When a file extension has a preferred template class, Tilt will *always* use
 that class, even if it raises an exception.
 
+Encodings
+---------
+
+Tilt needs to know the encoding of the template in order to work properly:
+
+Tilt will use `Encoding.default_external` as the encoding when reading external
+files. If you're mostly working with one encoding (e.g. UTF-8) we *highly*
+recommend setting this option. When providing a custom reader block (`Tilt.new
+{ custom_string }`) you'll have ensure the string is properly encoded yourself.
+
+Most of the template engines in Tilt also allows you to override the encoding
+using the `:default_encoding`-option:
+
+```ruby
+tmpl = Tilt.new('hello.erb', :default_encoding => 'Big5')
+```
+
+Ultimately it's up to the template engine how to handle the encoding: It might
+respect `:default_encoding`, it might always assume it's UTF-8 (like
+CoffeScript), or it can do its own encoding detection.
+
 Template Compilation
 --------------------
 

data/Rakefile

@@ -1,5 +1,28 @@
+require 'rbconfig'
 require 'rake/testtask'
-task :default => :test
+task :default => [:setup, :test]
+
+# set GEM_HOME to use local ./vendor dir for tests
+vendor_dir = './vendor'
+ruby_version = RbConfig::CONFIG['ruby_version']
+ruby_engine = (defined?(RUBY_ENGINE) && RUBY_ENGINE) || 'ruby'
+gem_home = ENV['GEM_HOME'] = "#{vendor_dir}/#{ruby_engine}/#{ruby_version}"
+
+# Write the current version.
+task :version do
+  puts "#{ruby_engine} #{RUBY_VERSION} (#{gem_home})"
+end
+
+desc "Install gems to #{ENV['GEM_HOME']}"
+task :setup do
+  verbose false do
+    sh "
+      bundle check >/dev/null || {
+        echo 'Updating #{gem_home}' &&
+        bundle install --path='#{vendor_dir}'; }
+    "
+  end
+end
 
 # SPECS =====================================================================
 
@@ -14,6 +37,7 @@ Rake::TestTask.new(:test) do |t|
   t.ruby_opts = ['-Itest']
   t.ruby_opts << '-rubygems' if defined? Gem
 end
+task :test => :version
 
 # PACKAGING =================================================================
 

data/TEMPLATES.md

@@ -57,7 +57,7 @@ implementations.
 ### Example
 
     Hello <%= world %>!
-    
+
 ### Usage
 
 ERB templates support custom evaluation scopes and locals:
@@ -197,7 +197,7 @@ a replacement for inline page templating systems such as PHP, ASP, and ERB, the
 templating language used in most Ruby on Rails applications. However, Haml
 avoids the need for explicitly coding HTML into the template, because it itself
 is a description of the HTML, with some code to generate dynamic content.
-([more](http://haml-lang.com/about.html))
+([more](http://haml.info/about.html))
 
 
 ### Example
@@ -243,13 +243,13 @@ using this template engine within a threaded environment.
 
 ### Options
 
-Please see the [Haml Reference](http://haml-lang.com/docs/yardoc/file.HAML_REFERENCE.html#options) for all available options.
+Please see the [Haml Reference](http://haml.info/docs/yardoc/file.HAML_REFERENCE.html#options) for all available options.
 
 ### See also
 
-  * [#haml.docs](http://haml-lang.com/docs.html)
-  * [Haml Tutorial](http://haml-lang.com/tutorial.html)
-  * [Haml Reference](http://haml-lang.com/docs/yardoc/HAML_REFERENCE.md.html)
+  * [#haml.docs](http://haml.info/docs.html)
+  * [Haml Tutorial](http://haml.info/tutorial.html)
+  * [Haml Reference](http://haml.info/docs/yardoc/file.HAML_REFERENCE.html)
 
 
 <a name='liquid'></a>
@@ -294,7 +294,7 @@ default. Liquid templates support locals and objects that respond to
 
 Or, use `Tilt::LiquidTemplate` directly to process strings:
 
-    >> require 'haml'
+    >> require 'liquid'
     >> template = Tilt::LiquidTemplate.new { "<h1>Hello Liquid!</h1>" }
     => #<Tilt::LiquidTemplate @file=nil ...>
     >> template.render
@@ -379,7 +379,7 @@ engine, which is a Ruby extension written in C.
 ### Example
 
     h1. Hello Textile Templates
-    
+
     Hello World. This is a paragraph.
 
 ### Usage
@@ -407,9 +407,9 @@ library.
 
 ### Usage
 
-__NOTE:__ It's suggested that your program `require 'rdoc/markup'` and
-`require 'rdoc/markup/to_html'` at load time when using this template
-engine in a threaded environment.
+__NOTE:__ It's suggested that your program `require 'rdoc'`,
+`require 'rdoc/markup'`, and `require 'rdoc/markup/to_html'` at load time
+when using this template engine in a threaded environment.
 
 ### See also
 
@@ -434,7 +434,7 @@ Markdown formatted texts are converted to HTML with one of these libraries:
   * Maruku - `Tilt::MarukuTemplate`
 
 Tilt will use fallback mode (as documented in the README) for determining which
-library to use. RDiscount has highest priority - Maruku has lowest. 
+library to use. RDiscount has highest priority - Maruku has lowest.
 
 ### Example
 
@@ -504,7 +504,7 @@ using this template engine within a threaded environment.
 [sass]: http://sass-lang.com/ "Sass"
 [coffee-script]: http://jashkenas.github.com/coffee-script/ "Coffee Script"
 [erubis]: http://www.kuwata-lab.com/erubis/ "Erubis"
-[haml]: http://haml-lang.org/ "Haml"
+[haml]: http://haml.info/ "Haml"
 [liquid]: http://www.liquidmarkup.org/ "Liquid"
 [radius]: http://radius.rubyforge.org/ "Radius"
 [radiant]: http://radiantcms.org/ "Radiant CMS"

data/bin/tilt

@@ -15,7 +15,7 @@ Options
   -y, --layout=<file>  Use <file> as a layout template
 
   -D<name>=<value>     Define variable <name> as <value>
-  -o, --vars=<ruby>    Evaluate <ruby> to Hash and use for variables
+  --vars=<ruby>        Evaluate <ruby> to Hash and use for variables
 
   -h, --help           Show this help message
 
@@ -27,9 +27,9 @@ Process ERB template:
   Answer: 4
 
 Define variables:
-  $ echo "Answer: <%= 2 + n %>" | tilt --locals="{:n=>40, :x=>0}"
+  $ echo "Answer: <%= 2 + n %>" | tilt -t erb --vars="{:n=>40}"
   Answer: 42
-  $ echo "Answer: <%= 2 + n %>" | tilt -Dn=40 -Dx=0
+  $ echo "Answer: <%= 2 + n.to_i %>" | tilt -t erb -Dn=40
   Answer: 42
 USAGE
 
@@ -44,9 +44,11 @@ ARGV.options do |o|
   # list all available template engines
   o.on("-l", "--list") do
     groups = {}
-    Tilt.mappings.each do |pattern,engine|
-      key = engine.name.split('::').last.sub(/Template$/, '')
-      (groups[key] ||= []) << pattern
+    Tilt.mappings.each do |pattern,engines|
+      engines.each do |engine|
+        key = engine.name.split('::').last.sub(/Template$/, '')
+        (groups[key] ||= []) << pattern
+      end
     end
     groups.sort { |(k1,v1),(k2,v2)| k1 <=> k2 }.each do |engine,files|
       printf "%-15s %s\n", engine, files.sort.join(', ')

data/lib/tilt/asciidoc.rb

@@ -0,0 +1,34 @@
+require 'tilt/template'
+
+# AsciiDoc see: http://asciidoc.org/
+module Tilt
+  # Asciidoctor implementation for AsciiDoc see:
+  # http://asciidoctor.github.com/
+  #
+  # Asciidoctor is an open source, pure-Ruby processor for
+  # converting AsciiDoc documents or strings into HTML 5,
+  # DocBook 4.5 and other formats.
+  class AsciidoctorTemplate < Template
+    self.default_mime_type = 'text/html'
+
+    def self.engine_initialized?
+      defined? ::Asciidoctor::Document
+    end
+
+    def initialize_engine
+      require_template_library 'asciidoctor'
+    end
+
+    def prepare
+      options[:header_footer] = false if options[:header_footer].nil?
+    end
+
+    def evaluate(scope, locals, &block)
+      @output ||= Asciidoctor.render(data, options, &block)
+    end
+
+    def allows_script?
+      false
+    end
+  end
+end

data/lib/tilt/coffee.rb

@@ -45,6 +45,10 @@ module Tilt
     def evaluate(scope, locals, &block)
       @output ||= CoffeeScript.compile(data, options)
     end
+
+    def allows_script?
+      false
+    end
   end
 end
 

data/lib/tilt/css.rb

@@ -24,6 +24,10 @@ module Tilt
       @output ||= @engine.render
     end
 
+    def allows_script?
+      false
+    end
+
   private
     def sass_options
       options.merge(:filename => eval_file, :line => line, :syntax => :sass)
@@ -59,13 +63,17 @@ module Tilt
       if ::Less.const_defined? :Engine
         @engine = ::Less::Engine.new(data)
       else
-        parser  = ::Less::Parser.new(:filename => eval_file, :line => line)
+        parser  = ::Less::Parser.new(options.merge :filename => eval_file, :line => line)
         @engine = parser.parse(data)
       end
     end
 
     def evaluate(scope, locals, &block)
-      @output ||= @engine.to_css
+      @output ||= @engine.to_css(options)
+    end
+
+    def allows_script?
+      false
     end
   end
 end

data/lib/tilt/csv.rb

@@ -0,0 +1,71 @@
+require 'tilt/template'
+
+module Tilt
+
+  # CSV Template implementation. See:
+  # http://ruby-doc.org/stdlib/libdoc/csv/rdoc/CSV.html
+  #
+  # == Example
+  #
+  #    # Example of csv template
+  #    tpl = <<-EOS
+  #      # header
+  #      csv << ['NAME', 'ID']
+  #
+  #      # data rows
+  #      @people.each do |person|
+  #        csv << [person[:name], person[:id]]
+  #      end
+  #    EOS
+  #
+  #    @people = [
+  #      {:name => "Joshua Peek", :id => 1},
+  #      {:name => "Ryan Tomayko", :id => 2},
+  #      {:name => "Simone Carletti", :id => 3}
+  #    ]
+  #
+  #    template = Tilt::CSVTemplate.new { tpl }
+  #    template.render(self)
+  #
+  class CSVTemplate < Template
+    self.default_mime_type = 'text/csv'
+
+    def self.engine_initialized?
+      engine
+    end
+
+    def self.engine
+      if RUBY_VERSION >= '1.9.0' && defined? ::CSV
+        ::CSV
+      elsif defined? ::FasterCSV
+        ::FasterCSV 
+      end
+    end
+
+    def initialize_engine
+      if RUBY_VERSION >= '1.9.0'
+        require_template_library 'csv'
+      else
+        require_template_library 'fastercsv'
+      end
+    end
+
+    def prepare
+      @code =<<-RUBY
+        #{self.class.engine}.generate do |csv|
+          #{data}
+        end
+      RUBY
+    end
+
+    def precompiled_template(locals)
+      @code
+    end
+
+    def precompiled(locals)
+      source, offset = super
+      [source, offset + 1]
+    end
+
+  end
+end

data/lib/tilt/erb.rb

@@ -24,7 +24,7 @@ module Tilt
 
     def prepare
       @outvar = options[:outvar] || self.class.default_output_variable
-      options[:trim] = '<>' if options[:trim].nil? || options[:trim] == true
+      options[:trim] = '<>' if !(options[:trim] == false) && (options[:trim].nil? || options[:trim] == true)
       @engine = ::ERB.new(data, options[:safe], options[:trim], @outvar)
     end
 
@@ -74,7 +74,7 @@ module Tilt
   #                   within <%= %> blocks will be automatically html escaped.
   class ErubisTemplate < ERBTemplate
     def self.engine_initialized?
-      defined? ::Erubis
+      defined? ::Erubis::Eruby
     end
 
     def initialize_engine

data/lib/tilt/etanni.rb

@@ -0,0 +1,27 @@
+require 'tilt/template'
+
+module Tilt
+  class EtanniTemplate < Template
+    def prepare
+      separator = data.hash.abs
+      chomp = "<<#{separator}.chomp!"
+      start = "\n_out_ << #{chomp}\n"
+      stop = "\n#{separator}\n"
+      replacement = "#{stop}\\1#{start}"
+
+      temp = data.strip
+      temp.gsub!(/<\?r\s+(.*?)\s+\?>/m, replacement)
+
+      @code = "_out_ = [<<#{separator}.chomp!]\n#{temp}#{stop}_out_.join"
+    end
+
+    def precompiled_template(locals)
+      @code
+    end
+
+    def precompiled(locals)
+      source, offset = super
+      [source, offset + 1]
+    end
+  end
+end

data/lib/tilt/liquid.rb

@@ -37,5 +37,9 @@ module Tilt
       locals['content'] = locals['yield']
       @engine.render(locals)
     end
+
+    def allows_script?
+      false
+    end
   end
 end

data/lib/tilt/markdown.rb

@@ -37,6 +37,10 @@ module Tilt
     def evaluate(scope, locals, &block)
       @output ||= @engine.to_html
     end
+
+    def allows_script?
+      false
+    end
   end
 
   # Upskirt Markdown implementation. See:
@@ -53,7 +57,7 @@ module Tilt
     end
 
     def prepare
-      klass = [Redcarpet1, Redcarpet2].detect { |e| e.engine_initialized? }
+      klass = [Redcarpet2, Redcarpet1].detect { |e| e.engine_initialized? }
       @engine = klass.new(file, line, options) { data }
     end
 
@@ -61,6 +65,10 @@ module Tilt
       @engine.evaluate(scope, locals, &block)
     end
 
+    def allows_script?
+      false
+    end
+
     # Compatibility mode for Redcarpet 1.x
     class Redcarpet1 < RDiscountTemplate
       self.default_mime_type = 'text/html'
@@ -80,22 +88,22 @@ module Tilt
       self.default_mime_type = 'text/html'
 
       def self.engine_initialized?
-        defined? ::Redcarpet::Render
+        defined? ::Redcarpet::Render and defined? ::Redcarpet::Markdown
       end
 
       def generate_renderer
-        renderer = options.delete(:renderer) || Redcarpet::Render::HTML
+        renderer = options.delete(:renderer) || ::Redcarpet::Render::HTML
         return renderer unless options.delete(:smartypants)
-        return renderer if renderer <= Redcarpet::Render::SmartyPants
+        return renderer if renderer.is_a?(Class) && renderer <= ::Redcarpet::Render::SmartyPants
 
-        if renderer == Redcarpet::Render::XHTML
-          Redcarpet::Render::SmartyHTML.new(:xhtml => true)
-        elsif renderer == Redcarpet::Render::HTML
-          Redcarpet::Render::SmartyHTML
+        if renderer == ::Redcarpet::Render::XHTML
+          ::Redcarpet::Render::SmartyHTML.new(:xhtml => true)
+        elsif renderer == ::Redcarpet::Render::HTML
+          ::Redcarpet::Render::SmartyHTML
         elsif renderer.is_a? Class
-          Class.new(renderer) { include Redcarpet::Render::SmartyPants }
+          Class.new(renderer) { include ::Redcarpet::Render::SmartyPants }
         else
-          renderer.extend Redcarpet::Render::SmartyPants
+          renderer.extend ::Redcarpet::Render::SmartyPants
         end
       end
 
@@ -109,13 +117,17 @@ module Tilt
         # only raise an exception if someone is trying to enable :escape_html
         options.delete(:escape_html) unless options[:escape_html]
 
-        @engine = Redcarpet::Markdown.new(generate_renderer, options)
+        @engine = ::Redcarpet::Markdown.new(generate_renderer, options)
         @output = nil
       end
 
       def evaluate(scope, locals, &block)
         @output ||= @engine.render(data)
       end
+
+      def allows_script?
+        false
+      end
     end
   end
 
@@ -140,6 +152,10 @@ module Tilt
     def evaluate(scope, locals, &block)
       @output ||= @engine.to_html
     end
+
+    def allows_script?
+      false
+    end
   end
 
   # Maruku markdown implementation. See:
@@ -161,6 +177,10 @@ module Tilt
     def evaluate(scope, locals, &block)
       @output ||= @engine.to_html
     end
+
+    def allows_script?
+      false
+    end
   end
 
   # Kramdown Markdown implementation. See:
@@ -185,6 +205,10 @@ module Tilt
     def evaluate(scope, locals, &block)
       @output ||= @engine.to_html
     end
+
+    def allows_script?
+      false
+    end
   end
 end
 

data/lib/tilt/nokogiri.rb

@@ -4,6 +4,7 @@ module Tilt
   # Nokogiri template implementation. See:
   # http://nokogiri.org/
   class NokogiriTemplate < Template
+    DOCUMENT_HEADER = /^<\?xml version=\"1\.0\"\?>\n?/
     self.default_mime_type = 'text/xml'
 
     def self.engine_initialized?
@@ -16,11 +17,10 @@ module Tilt
 
     def prepare; end
 
-    def evaluate(scope, locals, &block)
-      block &&= proc { yield.gsub(/^<\?xml version=\"1\.0\"\?>\n?/, "") }
-
+    def evaluate(scope, locals)
       if data.respond_to?(:to_str)
-        super(scope, locals, &block)
+        wrapper = proc { yield.sub(DOCUMENT_HEADER, "") } if block_given?
+        super(scope, locals, &wrapper)
       else
         ::Nokogiri::XML::Builder.new.tap(&data).to_xml
       end