tilt 1.0.1 → 1.1

data/README.md

@@ -34,6 +34,9 @@ Support for these template engines is included with the package:
     RedCloth                   .textile          redcloth
     RDoc                       .rdoc             rdoc
     Radius                     .radius           radius
+    Markaby                    .mab              markaby
+    Nokogiri                   .nokogiri         nokogiri
+    CoffeeScript               .coffee           coffee-script (+node coffee)
 
 See [TEMPLATES.md][t] for detailed information on template engine
 options and supported features.

data/lib/tilt.rb

@@ -1,7 +1,7 @@
 require 'digest/md5'
 
 module Tilt
-  VERSION = '1.0.1'
+  VERSION = '1.1'
 
   @template_mappings = {}
 
@@ -59,7 +59,7 @@ module Tilt
   end
 
   # Base class for template implementations. Subclasses must implement
-  # the #prepare method and one of the #evaluate or #evaluate_source
+  # the #prepare method and one of the #evaluate or #precompiled_template
   # methods.
   class Template
     # Template source; loaded from a file or given directly.
@@ -282,13 +282,18 @@ module Tilt
 
     def compile_template_method(method_name, locals)
       source, offset = precompiled(locals)
-      offset += 1
-      CompileSite.module_eval <<-RUBY, eval_file, line - offset
+      offset += 5
+      CompileSite.class_eval <<-RUBY, eval_file, line - offset
         def #{method_name}(locals)
-          #{source}
+          Thread.current[:tilt_vars] = [self, locals]
+          class << self
+            this, locals = Thread.current[:tilt_vars]
+            this.instance_eval do
+              #{source}
+            end
+          end
         end
       RUBY
-
       ObjectSpace.define_finalizer self,
         Template.compiled_template_method_remover(CompileSite, method_name)
     end
@@ -306,6 +311,27 @@ module Tilt
         end
       end
     end
+
+    # Special case Ruby 1.9.1's broken yield.
+    #
+    # http://github.com/rtomayko/tilt/commit/20c01a5
+    # http://redmine.ruby-lang.org/issues/show/3601
+    #
+    # Remove when 1.9.2 dominates 1.9.1 installs in the wild.
+    if RUBY_VERSION =~ /^1.9.1/
+      undef compile_template_method
+      def compile_template_method(method_name, locals)
+        source, offset = precompiled(locals)
+        offset += 1
+        CompileSite.module_eval <<-RUBY, eval_file, line - offset
+          def #{method_name}(locals)
+            #{source}
+          end
+        RUBY
+        ObjectSpace.define_finalizer self,
+          Template.compiled_template_method_remover(CompileSite, method_name)
+      end
+    end
   end
 
   # Extremely simple template cache implementation. Calling applications
@@ -528,11 +554,19 @@ module Tilt
 
   private
     def sass_options
-      options.merge(:filename => eval_file, :line => line)
+      options.merge(:filename => eval_file, :line => line, :syntax => :sass)
     end
   end
   register 'sass', SassTemplate
 
+  # Sass's new .scss type template implementation.
+  class ScssTemplate < SassTemplate
+  private
+    def sass_options
+      options.merge(:filename => eval_file, :line => line, :syntax => :scss)
+    end
+  end
+  register 'scss', ScssTemplate
 
   # Lessscss template implementation. See:
   # http://lesscss.org/
@@ -555,6 +589,65 @@ module Tilt
   register 'less', LessTemplate
 
 
+  # CoffeeScript template implementation. See:
+  # http://coffeescript.org/
+  #
+  # CoffeeScript templates do not support object scopes, locals, or yield.
+  class CoffeeScriptTemplate < Template
+    @@default_no_wrap = false
+
+    def self.default_no_wrap
+      @@default_no_wrap
+    end
+
+    def self.default_no_wrap=(value)
+      @@default_no_wrap = value
+    end
+
+    def initialize_engine
+      return if defined? ::CoffeeScript
+      require_template_library 'coffee_script'
+    end
+
+    def prepare
+      @no_wrap = options.key?(:no_wrap) ? options[:no_wrap] :
+        self.class.default_no_wrap
+    end
+
+    def evaluate(scope, locals, &block)
+      @output ||= CoffeeScript.compile(data, :no_wrap => @no_wrap)
+    end
+  end
+  register 'coffee', CoffeeScriptTemplate
+
+
+  # Nokogiri template implementation. See:
+  # http://nokogiri.org/
+  class NokogiriTemplate < Template
+    def initialize_engine
+      return if defined?(::Nokogiri)
+      require_template_library 'nokogiri'
+    end
+
+    def prepare; end
+
+    def evaluate(scope, locals, &block)
+      xml = ::Nokogiri::XML::Builder.new
+      if data.respond_to?(:to_str)
+        locals[:xml] = xml
+        super(scope, locals, &block)
+      elsif data.kind_of?(Proc)
+        data.call(xml)
+      end
+      xml.to_xml
+    end
+
+    def precompiled_template(locals)
+      data.to_str
+    end
+  end
+  register 'nokogiri', NokogiriTemplate
+
   # Builder template implementation. See:
   # http://builder.rubyforge.org/
   class BuilderTemplate < Template
@@ -729,4 +822,47 @@ module Tilt
     end
   end
   register 'radius', RadiusTemplate
+
+
+  # Markaby
+  # http://github.com/markaby/markaby
+  class MarkabyTemplate < Template
+    def self.builder_class
+      @builder_class ||= Class.new(Markaby::Builder) do
+        def __capture_markaby_tilt__(&block)
+          __run_markaby_tilt__ do
+            text capture(&block)
+          end
+        end
+      end
+    end
+
+    def initialize_engine
+      return if defined? ::Markaby
+      require_template_library 'markaby'
+    end
+
+    def prepare
+    end
+
+    def evaluate(scope, locals, &block)
+      builder = self.class.builder_class.new({}, scope)
+      builder.locals = locals
+
+      if block
+        builder.instance_eval <<-CODE, __FILE__, __LINE__
+          def __run_markaby_tilt__
+            #{data}
+          end
+        CODE
+
+        builder.__capture_markaby_tilt__(&block)
+      else
+        builder.instance_eval(data, __FILE__, __LINE__)
+      end
+
+      builder.to_s
+    end
+  end
+  register 'mab', MarkabyTemplate
 end

data/test/markaby/locals.mab

@@ -0,0 +1 @@
+li foo

data/test/markaby/markaby.mab

@@ -0,0 +1 @@
+text "hello from markaby!"

data/test/markaby/markaby_other_static.mab

@@ -0,0 +1 @@
+text "_why?"

data/test/markaby/render_twice.mab

@@ -0,0 +1 @@
+text "foo"

data/test/markaby/scope.mab

@@ -0,0 +1 @@
+li foo

data/test/markaby/yielding.mab

@@ -0,0 +1,2 @@
+text("Hey ")
+yield

data/test/tilt_cache_test.rb

@@ -14,10 +14,9 @@ class TiltCacheTest < Test::Unit::TestCase
 
   test "caching with multiple complex arguments to #fetch" do
     template = nil
-    args = ['hello', {:foo => 'bar', :baz => 'bizzle'}]
-    result = @cache.fetch(*args) { template = Tilt::StringTemplate.new {''} }
+    result = @cache.fetch('hello', {:foo => 'bar', :baz => 'bizzle'}) { template = Tilt::StringTemplate.new {''} }
     assert_same template, result
-    result = @cache.fetch(*args) { fail 'should be cached' }
+    result = @cache.fetch('hello', {:foo => 'bar', :baz => 'bizzle'}) { fail 'should be cached' }
     assert_same template, result
   end
 

data/test/tilt_coffeescripttemplate_test.rb

@@ -0,0 +1,25 @@
+require 'contest'
+require 'tilt'
+
+begin
+  require 'coffee_script'
+
+  class CoffeeScriptTemplateTest < Test::Unit::TestCase
+    test "is registered for '.coffee' files" do
+      assert_equal Tilt::CoffeeScriptTemplate, Tilt['test.coffee']
+    end
+
+    test "compiles and evaluates the template on #render" do
+      template = Tilt::CoffeeScriptTemplate.new { |t| "puts 'Hello, World!'\n" }
+      assert_equal "(function() {\n  puts('Hello, World!');\n})();\n", template.render
+    end
+
+    test "disabling coffee-script wrapper" do
+      template = Tilt::CoffeeScriptTemplate.new(:no_wrap => true) { |t| "puts 'Hello, World!'\n" }
+      assert_equal "puts('Hello, World!');", template.render
+    end
+  end
+
+rescue LoadError => boom
+  warn "Tilt::CoffeeScriptTemplate (disabled)\n"
+end

data/test/tilt_markaby_test.rb

@@ -0,0 +1,73 @@
+require 'contest'
+require 'tilt'
+
+begin
+  require 'markaby'
+
+  class MarkabyTiltTest <  Test::Unit::TestCase
+    def setup
+      @block = lambda do |t|
+        File.read(File.dirname(__FILE__) + "/#{t.file}")
+      end
+    end
+
+    test "should be able to render a markaby template with static html" do
+      tilt = Tilt::MarkabyTemplate.new("markaby/markaby.mab", &@block)
+      assert_equal "hello from markaby!", tilt.render
+    end
+
+    test "should use the contents of the template" do
+      tilt = ::Tilt::MarkabyTemplate.new("markaby/markaby_other_static.mab", &@block)
+      assert_equal "_why?", tilt.render
+    end
+
+    test "should render from a string (given as data)" do
+      tilt = ::Tilt::MarkabyTemplate.new { "html do; end" }
+      assert_equal "<html></html>", tilt.render
+    end
+
+    test "should evaluate a template file in the scope given" do
+      scope = Object.new
+      def scope.foo
+        "bar"
+      end
+
+      tilt = ::Tilt::MarkabyTemplate.new("markaby/scope.mab", &@block)
+      assert_equal "<li>bar</li>", tilt.render(scope)
+    end
+
+    test "should pass locals to the template" do
+      tilt = ::Tilt::MarkabyTemplate.new("markaby/locals.mab", &@block)
+      assert_equal "<li>bar</li>", tilt.render(Object.new, { :foo => "bar" })
+    end
+
+    test "should yield to the block given" do
+      tilt = ::Tilt::MarkabyTemplate.new("markaby/yielding.mab", &@block)
+      eval_scope = Markaby::Builder.new
+
+      output = tilt.render(Object.new, {}) do
+        text("Joe")
+      end
+
+      assert_equal "Hey Joe", output
+    end
+
+    test "should be able to render two templates in a row" do
+      tilt = ::Tilt::MarkabyTemplate.new("markaby/render_twice.mab", &@block)
+
+      assert_equal "foo", tilt.render
+      assert_equal "foo", tilt.render
+    end
+
+    test "should retrieve a Tilt::MarkabyTemplate when calling Tilt['hello.mab']" do
+      assert_equal Tilt::MarkabyTemplate, ::Tilt['./markaby/markaby.mab']
+    end
+
+    test "should return a new instance of the implementation class (when calling Tilt.new)" do
+      assert ::Tilt.new(File.dirname(__FILE__) + "/markaby/markaby.mab").kind_of?(Tilt::MarkabyTemplate)
+    end
+  end
+
+rescue LoadError => boom
+  warn "Tilt::MarkabyTemplate (disabled)\n"
+end

data/test/tilt_nokogiritemplate_test.rb

@@ -0,0 +1,54 @@
+require 'contest'
+require 'tilt'
+
+begin
+  require 'nokogiri'
+  class NokogiriTemplateTest < Test::Unit::TestCase
+    test "registered for '.nokogiri' files" do
+      assert_equal Tilt::NokogiriTemplate, Tilt['test.nokogiri']
+      assert_equal Tilt::NokogiriTemplate, Tilt['test.xml.nokogiri']
+    end
+
+    test "preparing and evaluating the template on #render" do
+      template = Tilt::NokogiriTemplate.new { |t| "xml.em 'Hello World!'" }
+      doc = Nokogiri.XML template.render
+      assert_equal 'Hello World!', doc.root.text
+      assert_equal 'em', doc.root.name
+    end
+
+    test "passing locals" do
+      template = Tilt::NokogiriTemplate.new { "xml.em('Hey ' + name + '!')" }
+      doc = Nokogiri.XML template.render(Object.new, :name => 'Joe')
+      assert_equal 'Hey Joe!', doc.root.text
+      assert_equal 'em', doc.root.name
+    end
+
+    test "evaluating in an object scope" do
+      template = Tilt::NokogiriTemplate.new { "xml.em('Hey ' + @name + '!')" }
+      scope = Object.new
+      scope.instance_variable_set :@name, 'Joe'
+      doc = Nokogiri.XML template.render(scope)
+      assert_equal 'Hey Joe!', doc.root.text
+      assert_equal 'em', doc.root.name
+    end
+
+    test "passing a block for yield" do
+      template = Tilt::NokogiriTemplate.new { "xml.em('Hey ' + yield + '!')" }
+      doc = Nokogiri.XML template.render { 'Joe' }
+      assert_equal 'Hey Joe!', doc.root.text
+      assert_equal 'em', doc.root.name
+    end
+
+    test "block style templates" do
+      template =
+        Tilt::NokogiriTemplate.new do |t|
+          lambda { |xml| xml.em('Hey Joe!') }
+        end
+      doc = Nokogiri.XML template.render template.render
+      assert_equal 'Hey Joe!', doc.root.text
+      assert_equal 'em', doc.root.name
+    end
+  end
+rescue LoadError
+  warn "Tilt::NokogiriTemplate (disabled)"
+end

data/test/tilt_radiustemplate_test.rb

@@ -2,6 +2,10 @@ require 'contest'
 require 'tilt'
 
 begin
+  # Disable radius tests under Ruby versions >= 1.9.1 since it's still buggy.
+  # Remove when fixed upstream.
+  raise LoadError if RUBY_VERSION >= "1.9.1"
+
   require 'radius'
 
   class RadiusTemplateTest < Test::Unit::TestCase

data/test/tilt_sasstemplate_test.rb

@@ -16,6 +16,17 @@ begin
     end
   end
 
+  class ScssTemplateTest < Test::Unit::TestCase
+    test "is registered for '.scss' files" do
+      assert_equal Tilt::ScssTemplate, Tilt['test.scss']
+    end
+
+    test "compiles and evaluates the template on #render" do
+      template = Tilt::ScssTemplate.new { |t| "#main {\n  background-color: #0000f1;\n}" }
+      assert_equal "#main {\n  background-color: #0000f1; }\n", template.render
+    end
+  end
+
 rescue LoadError => boom
   warn "Tilt::SassTemplate (disabled)\n"
 end

data/test/tilt_template_test.rb

@@ -150,10 +150,9 @@ class TiltTemplateTest < Test::Unit::TestCase
     include Tilt::CompileSite
   end
 
-  # FAILING CONSTANT TEST. DISABLED FOR 1.0.
-
-  # test "template which accesses a constant with Tilt::CompileSite" do
-  #   inst = SourceGeneratingMockTemplate.new { |t| 'Hey #{CONSTANT}!' }
-  #   assert_equal "Hey Bob!", inst.render(FastPerson.new("Joe"))
-  # end
+  test "template which accesses a constant with Tilt::CompileSite" do
+    flunk "known broken under 1.9.1" if RUBY_VERSION =~ /^1.9.1/
+    inst = SourceGeneratingMockTemplate.new { |t| 'Hey #{CONSTANT}!' }
+    assert_equal "Hey Bob!", inst.render(FastPerson.new("Joe"))
+  end
 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 = '1.0.1'
-  s.date = '2010-06-15'
+  s.version = '1.1'
+  s.date = '2010-09-10'
 
   s.description = "Generic interface to multiple Ruby template engines"
   s.summary     = s.description
@@ -21,14 +21,23 @@ Gem::Specification.new do |s|
     bin/tilt
     lib/tilt.rb
     test/contest.rb
+    test/markaby/locals.mab
+    test/markaby/markaby.mab
+    test/markaby/markaby_other_static.mab
+    test/markaby/render_twice.mab
+    test/markaby/scope.mab
+    test/markaby/yielding.mab
     test/tilt_buildertemplate_test.rb
     test/tilt_cache_test.rb
+    test/tilt_coffeescripttemplate_test.rb
     test/tilt_compilesite_test.rb
     test/tilt_erbtemplate_test.rb
     test/tilt_erubistemplate_test.rb
     test/tilt_hamltemplate_test.rb
     test/tilt_lesstemplate_test.rb
     test/tilt_liquidtemplate_test.rb
+    test/tilt_markaby_test.rb
+    test/tilt_nokogiritemplate_test.rb
     test/tilt_radiustemplate_test.rb
     test/tilt_rdiscounttemplate_test.rb
     test/tilt_rdoctemplate_test.rb
@@ -53,6 +62,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'liquid'
   s.add_development_dependency 'less'
   s.add_development_dependency 'radius'
+  s.add_development_dependency 'nokogiri'
+  s.add_development_dependency 'markaby'
+  s.add_development_dependency 'coffee-script'
 
   s.extra_rdoc_files = %w[COPYING]
 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: tilt
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 13
   prerelease: false
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  version: "1.1"
 platform: ruby
 authors: 
 - Ryan Tomayko
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-15 00:00:00 -07:00
+date: 2010-09-10 00:00:00 -07:00
 default_executable: tilt
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -132,6 +131,48 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: markaby
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: coffee-script
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id011
 description: Generic interface to multiple Ruby template engines
 email: r@tomayko.com
 executables: 
@@ -148,14 +189,23 @@ files:
 - bin/tilt
 - lib/tilt.rb
 - test/contest.rb
+- test/markaby/locals.mab
+- test/markaby/markaby.mab
+- test/markaby/markaby_other_static.mab
+- test/markaby/render_twice.mab
+- test/markaby/scope.mab
+- test/markaby/yielding.mab
 - test/tilt_buildertemplate_test.rb
 - test/tilt_cache_test.rb
+- test/tilt_coffeescripttemplate_test.rb
 - test/tilt_compilesite_test.rb
 - test/tilt_erbtemplate_test.rb
 - test/tilt_erubistemplate_test.rb
 - test/tilt_hamltemplate_test.rb
 - test/tilt_lesstemplate_test.rb
 - test/tilt_liquidtemplate_test.rb
+- test/tilt_markaby_test.rb
+- test/tilt_nokogiritemplate_test.rb
 - test/tilt_radiustemplate_test.rb
 - test/tilt_rdiscounttemplate_test.rb
 - test/tilt_rdoctemplate_test.rb
@@ -207,12 +257,15 @@ summary: Generic interface to multiple Ruby template engines
 test_files: 
 - test/tilt_buildertemplate_test.rb
 - test/tilt_cache_test.rb
+- test/tilt_coffeescripttemplate_test.rb
 - test/tilt_compilesite_test.rb
 - test/tilt_erbtemplate_test.rb
 - test/tilt_erubistemplate_test.rb
 - test/tilt_hamltemplate_test.rb
 - test/tilt_lesstemplate_test.rb
 - test/tilt_liquidtemplate_test.rb
+- test/tilt_markaby_test.rb
+- test/tilt_nokogiritemplate_test.rb
 - test/tilt_radiustemplate_test.rb
 - test/tilt_rdiscounttemplate_test.rb
 - test/tilt_rdoctemplate_test.rb