tilt 0.8 → 0.9

data/Rakefile

@@ -16,6 +16,11 @@ end
 
 # PACKAGING =================================================================
 
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
 if defined?(Gem)
   SPEC = eval(File.read('tilt.gemspec'))
 
@@ -72,26 +77,3 @@ file 'tilt.gemspec' => FileList['{lib,test}/**','Rakefile'] do |f|
   File.open(f.name, 'w') { |io| io.write(spec) }
   puts "updated #{f.name}"
 end
-
-# DOC =======================================================================
-
-# requires the hanna gem:
-#   gem install mislav-hanna --source=http://gems.github.com
-desc 'Build API documentation (doc/api)'
-task 'rdoc' => 'rdoc/index.html' 
-file 'rdoc/index.html' => FileList['lib/**/*.rb'] do |f|
-  rm_rf 'rdoc'
-  sh((<<-SH).gsub(/[\s\n]+/, ' ').strip)
-  hanna
-    --op doc/api
-    --promiscuous
-    --charset utf8
-    --fmt html
-    --inline-source
-    --line-numbers
-    --accessor option_accessor=RW
-    --main Tilt
-    --title 'Tilt API Documentation'
-    #{f.prerequisites.join(' ')}
-  SH
-end

data/TEMPLATES.md

@@ -94,15 +94,16 @@ the extensions as follows:
 
 ### Options
 
-#### `:trim => true`
+#### `:engine_class => Erubis::Eruby`
 
-Delete spaces around '<% %>'. (But, spaces around '<%= %>' are preserved.)
+Allows you to specify a custom engine class to use instead of the
+default which is `Erubis::Eruby`.
 
-#### `:pattern => '<% %>'`
-
-Set pattern for embedded Ruby code.
+#### `:escape_html => false`
 
-See the [ERB](#erb) template documentation for examples, usage, and options.
+When `true`, `Erubis::EscapedEruby` will be used as the engine class
+instead of the default. All content within `<%= %>` blocks will be
+automatically html escaped.
 
 #### `:outvar => '_erbout'`
 
@@ -110,6 +111,16 @@ The name of the variable used to accumulate template output. This can be
 any valid Ruby expression but must be assignable. By default a local
 variable named `_erbout` is used.
 
+#### `:pattern => '<% %>'`
+
+Set pattern for embedded Ruby code.
+
+See the [ERB](#erb) template documentation for examples, usage, and options.
+
+#### `:trim => true`
+
+Delete spaces around '<% %>'. (But, spaces around '<%= %>' are preserved.)
+
 ### See also
 
   * [Erubis Home](http://www.kuwata-lab.com/erubis/)

data/lib/tilt.rb

@@ -1,7 +1,7 @@
 require 'digest/md5'
 
 module Tilt
-  VERSION = '0.8'
+  VERSION = '0.9'
 
   @template_mappings = {}
 
@@ -16,6 +16,11 @@ module Tilt
     mappings[ext.downcase] = template_class
   end
 
+  # Returns true when a template exists on an exact match of the provided file extension
+  def self.registered?(ext)
+    mappings.key?(ext.downcase)
+  end
+
   # Create a new template for the given file using the file's extension
   # to determine the the template mapping.
   def self.new(file, line=nil, options={}, &block)
@@ -29,20 +34,12 @@ module Tilt
   # Lookup a template class for the given filename or file
   # extension. Return nil when no implementation is found.
   def self.[](file)
-    if @template_mappings.key?(pattern = file.to_s.downcase)
-      @template_mappings[pattern]
-    elsif @template_mappings.key?(pattern = File.basename(pattern))
-      @template_mappings[pattern]
-    else
-      while !pattern.empty?
-        if @template_mappings.key?(pattern)
-          return @template_mappings[pattern]
-        else
-          pattern = pattern.sub(/^[^.]*\.?/, '')
-        end
-      end
-      nil
+    pattern = file.to_s.downcase
+    unless registered?(pattern)
+      pattern = File.basename(pattern)
+      pattern.sub!(/^[^.]*\.?/, '') until (pattern.empty? || registered?(pattern))
     end
+    @template_mappings[pattern]
   end
 
   # Mixin allowing template compilation on scope objects.
@@ -100,7 +97,7 @@ module Tilt
         case
         when arg.respond_to?(:to_str)  ; @file = arg.to_str
         when arg.respond_to?(:to_int)  ; @line = arg.to_int
-        when arg.respond_to?(:to_hash) ; @options = arg.to_hash
+        when arg.respond_to?(:to_hash) ; @options = arg.to_hash.dup
         else raise TypeError
         end
       end
@@ -399,6 +396,16 @@ module Tilt
 
   # Erubis template implementation. See:
   # http://www.kuwata-lab.com/erubis/
+  #
+  # ErubisTemplate supports the following additional options, which are not
+  # passed down to the Erubis engine:
+  #
+  #   :engine_class   allows you to specify a custom engine class to use
+  #                   instead of the default (which is ::Erubis::Eruby).
+  #
+  #   :escape_html    when true, ::Erubis::EscapedEruby will be used as
+  #                   the engine class instead of the default. All content
+  #                   within <%= %> blocks will be automatically html escaped.
   class ErubisTemplate < ERBTemplate
     def initialize_engine
       return if defined? ::Erubis
@@ -408,7 +415,9 @@ module Tilt
     def prepare
       @options.merge!(:preamble => false, :postamble => false)
       @outvar = (options.delete(:outvar) || '_erbout').to_s
-      @engine = ::Erubis::Eruby.new(data, options)
+      engine_class = options.delete(:engine_class)
+      engine_class = ::Erubis::EscapedEruby if options.delete(:escape_html)
+      @engine = (engine_class || ::Erubis::Eruby).new(data, options)
     end
 
     def precompiled_preamble(locals)

data/test/tilt_erubistemplate_test.rb

@@ -77,6 +77,32 @@ begin
       assert_equal '2', template.render(scope)
       assert_equal 'original value', scope.instance_variable_get(:@buf)
     end
+
+    test "using Erubis::EscapedEruby subclass via :engine_class option" do
+      template = Tilt::ErubisTemplate.new(nil, :engine_class => ::Erubis::EscapedEruby) { |t| %(<%= "<p>Hello World!</p>" %>) }
+      assert_equal "&lt;p&gt;Hello World!&lt;/p&gt;", template.render
+    end
+
+    test "using :escape_html => true option" do
+      template = Tilt::ErubisTemplate.new(nil, :escape_html => true) { |t| %(<%= "<p>Hello World!</p>" %>) }
+      assert_equal "&lt;p&gt;Hello World!&lt;/p&gt;", template.render
+    end
+
+    test "using :escape_html => false option" do
+      template = Tilt::ErubisTemplate.new(nil, :escape_html => false) { |t| %(<%= "<p>Hello World!</p>" %>) }
+      assert_equal "<p>Hello World!</p>", template.render
+    end
+
+    test "erubis default does not escape html" do
+      template = Tilt::ErubisTemplate.new { |t| %(<%= "<p>Hello World!</p>" %>) }
+      assert_equal "<p>Hello World!</p>", template.render
+    end
+
+    test "does not modify options argument" do
+      options_hash = {:escape_html => true}
+      template = Tilt::ErubisTemplate.new(nil, options_hash) { |t| "Hello World!" }
+      assert_equal({:escape_html => true}, options_hash)
+    end
   end
 rescue LoadError => boom
   warn "Tilt::ErubisTemplate (disabled)\n"

data/test/tilt_test.rb

@@ -14,15 +14,23 @@ class TiltTest < Test::Unit::TestCase
     Tilt.register('mock', MockTemplate)
   end
 
+  test "an extension is registered if explicit handle is found" do
+    Tilt.register('mock', MockTemplate)
+    assert Tilt.registered?('mock')
+  end
+
   test "registering template classes by symbol file extension" do
     Tilt.register(:mock, MockTemplate)
   end
 
-  test "looking up template classes by file extension" do
+  test "looking up template classes by exact file extension" do
     Tilt.register('mock', MockTemplate)
     impl = Tilt['mock']
     assert_equal MockTemplate, impl
+  end
 
+  test "looking up template classes by implicit file extension" do
+    Tilt.register('mock', MockTemplate)
     impl = Tilt['.mock']
     assert_equal MockTemplate, impl
   end

data/tilt.gemspec

@@ -3,8 +3,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.name = 'tilt'
-  s.version = '0.8'
-  s.date = '2010-03-07'
+  s.version = '0.9'
+  s.date = '2010-04-11'
 
   s.description = "Generic interface to multiple Ruby template engines"
   s.summary     = s.description

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 8
-  version: "0.8"
+  - 9
+  version: "0.9"
 platform: ruby
 authors: 
 - Ryan Tomayko
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-07 00:00:00 -08:00
+date: 2010-04-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency