tilt 0.6 → 1.0

data/test/contest.rb

@@ -0,0 +1,68 @@
+require "test/unit"
+
+# Test::Unit loads a default test if the suite is empty, whose purpose is to
+# fail. Since having empty contexts is a common practice, we decided to
+# overwrite TestSuite#empty? in order to allow them. Having a failure when no
+# tests have been defined seems counter-intuitive.
+class Test::Unit::TestSuite
+  def empty?
+    false
+  end
+end
+
+# Contest adds +teardown+, +test+ and +context+ as class methods, and the
+# instance methods +setup+ and +teardown+ now iterate on the corresponding
+# blocks. Note that all setup and teardown blocks must be defined with the
+# block syntax. Adding setup or teardown instance methods defeats the purpose
+# of this library.
+class Test::Unit::TestCase
+  def self.setup(&block)
+    define_method :setup do
+      super(&block)
+      instance_eval(&block)
+    end
+  end
+
+  def self.teardown(&block)
+    define_method :teardown do
+      instance_eval(&block)
+      super(&block)
+    end
+  end
+
+  def self.context(name, &block)
+    subclass = Class.new(self)
+    remove_tests(subclass)
+    subclass.class_eval(&block) if block_given?
+    const_set(context_name(name), subclass)
+  end
+
+  def self.test(name, &block)
+    define_method(test_name(name), &block)
+  end
+
+  class << self
+    alias_method :should, :test
+    alias_method :describe, :context
+  end
+
+private
+
+  def self.context_name(name)
+    "Test#{sanitize_name(name).gsub(/(^| )(\w)/) { $2.upcase }}".to_sym
+  end
+
+  def self.test_name(name)
+    "test_#{sanitize_name(name).gsub(/\s+/,'_')}".to_sym
+  end
+
+  def self.sanitize_name(name)
+    name.gsub(/\W+/, ' ').strip
+  end
+
+  def self.remove_tests(subclass)
+    subclass.public_instance_methods.grep(/^test_/).each do |meth|
+      subclass.send(:undef_method, meth.to_sym)
+    end
+  end
+end

data/test/tilt_buildertemplate_test.rb

@@ -9,7 +9,7 @@ begin
       assert_equal Tilt::BuilderTemplate, Tilt['test.xml.builder']
     end
 
-    test "compiling and evaluating the template on #render" do
+    test "preparing and evaluating the template on #render" do
       template = Tilt::BuilderTemplate.new { |t| "xml.em 'Hello World!'" }
       assert_equal "<em>Hello World!</em>\n", template.render
     end

data/test/tilt_compilesite_test.rb

@@ -0,0 +1,86 @@
+require 'contest'
+require 'tilt'
+require 'thread'
+
+class CompileSiteTest < Test::Unit::TestCase
+  def setup
+    GC.start
+  end
+
+  class CompilingTemplate < Tilt::Template
+    def prepare
+    end
+
+    def precompiled_template(locals)
+      @data.inspect
+    end
+  end
+
+  class Scope
+    include Tilt::CompileSite
+  end
+
+  test "compiling template source to a method" do
+    template = CompilingTemplate.new { |t| "Hello World!" }
+    template.render(Scope.new)
+    method_name = template.send(:compiled_method_name, [])
+    method_name = method_name.to_sym if Symbol === Kernel.methods.first
+    assert Tilt::CompileSite.instance_methods.include?(method_name),
+      "CompileSite.instance_methods.include?(#{method_name.inspect})"
+    assert Scope.new.respond_to?(method_name),
+      "scope.respond_to?(#{method_name.inspect})"
+  end
+
+  test 'garbage collecting compiled methods' do
+    template = CompilingTemplate.new { '' }
+    method_name = template.send(:compiled_method_name, [])
+    template.render(Scope.new)
+    assert Scope.new.respond_to?(method_name)
+    Tilt::Template.send(
+      :garbage_collect_compiled_template_method,
+      Tilt::CompileSite,
+      method_name
+    )
+    assert !Scope.new.respond_to?(method_name), "compiled method not removed"
+  end
+
+  def self.create_and_destroy_template
+    template = CompilingTemplate.new { 'Hello World' }
+    template.render(Scope.new)
+    method_name = template.send(:compiled_method_name, [])
+    method_name = method_name.to_sym if Symbol === Kernel.methods.first
+    [template.object_id, method_name]
+  end
+
+  finalized_object_id, finalized_method_name = create_and_destroy_template
+
+  test "triggering compiled method gc finalizer" do
+    assert !Tilt::CompileSite.instance_methods.include?(finalized_method_name),
+      "CompileSite.instance_methods.include?(#{finalized_method_name.inspect})"
+    assert !Scope.new.respond_to?(finalized_method_name),
+      "Scope.new.respond_to?(#{finalized_method_name.inspect})"
+  end
+
+  # This test attempts to surface issues with compiling templates from
+  # multiple threads.
+  test "using compiled templates from multiple threads" do
+    template = CompilingTemplate.new { 'template' }
+    main_thread = Thread.current
+    10.times do |i|
+      threads =
+        (1..50).map do |j|
+          Thread.new {
+            begin
+              locals = { "local#{i}" => 'value' }
+              res = template.render(self, locals)
+              thread_id = Thread.current.object_id
+              res = template.render(self, "local#{thread_id.to_s}" => 'value')
+            rescue => boom
+              main_thread.raise(boom)
+            end
+          }
+        end
+      threads.each { |t| t.join }
+    end
+  end
+end

data/test/tilt_erbtemplate_test.rb

@@ -12,7 +12,7 @@ class ERBTemplateTest < Test::Unit::TestCase
     assert_equal Tilt::ERBTemplate, Tilt['test.rhtml']
   end
 
-  test "compiling and evaluating templates on #render" do
+  test "loading and evaluating templates on #render" do
     template = Tilt::ERBTemplate.new { |t| "Hello World!" }
     assert_equal "Hello World!", template.render
   end
@@ -29,6 +29,23 @@ class ERBTemplateTest < Test::Unit::TestCase
     assert_equal "Hey Joe!", template.render(scope)
   end
 
+  class MockOutputVariableScope
+    attr_accessor :exposed_buffer
+  end
+
+  test "exposing the buffer to the template by default" do
+    begin
+      Tilt::ERBTemplate.default_output_variable = '@_out_buf'
+      template = Tilt::ERBTemplate.new { '<% self.exposed_buffer = @_out_buf %>hey' }
+      scope = MockOutputVariableScope.new
+      template.render(scope)
+      assert_not_nil scope.exposed_buffer
+      assert_equal scope.exposed_buffer, 'hey'
+    ensure
+      Tilt::ERBTemplate.default_output_variable = '_erbout'
+    end
+  end
+
   test "passing a block for yield" do
     template = Tilt::ERBTemplate.new { 'Hey <%= yield %>!' }
     assert_equal "Hey Joe!", template.render { 'Joe' }
@@ -77,9 +94,111 @@ class ERBTemplateTest < Test::Unit::TestCase
   end
 
   test "shorthand whole line syntax trim mode" do
-    template = Tilt.new('test.erb', 1, :trim => '%') { "\n% if true\nhello\n%end\n" }
+    template = Tilt.new('test.erb', :trim => '%') { "\n% if true\nhello\n%end\n" }
     assert_equal "\nhello\n", template.render
   end
+
+  test "using an instance variable as the outvar" do
+    template = Tilt::ERBTemplate.new(nil, :outvar => '@buf') { "<%= 1 + 1 %>" }
+    scope = Object.new
+    scope.instance_variable_set(:@buf, 'original value')
+    assert_equal '2', template.render(scope)
+    assert_equal 'original value', scope.instance_variable_get(:@buf)
+  end
+end
+
+class CompiledERBTemplateTest < Test::Unit::TestCase
+  def teardown
+    GC.start
+  end
+
+  class Scope
+    include Tilt::CompileSite
+  end
+
+  test "compiling template source to a method" do
+    template = Tilt::ERBTemplate.new { |t| "Hello World!" }
+    template.render(Scope.new)
+    method_name = template.send(:compiled_method_name, [])
+    method_name = method_name.to_sym if Symbol === Kernel.methods.first
+    assert Tilt::CompileSite.instance_methods.include?(method_name),
+      "CompileSite.instance_methods.include?(#{method_name.inspect})"
+    assert Scope.new.respond_to?(method_name),
+      "scope.respond_to?(#{method_name.inspect})"
+  end
+
+  test "loading and evaluating templates on #render" do
+    template = Tilt::ERBTemplate.new { |t| "Hello World!" }
+    assert_equal "Hello World!", template.render(Scope.new)
+    assert_equal "Hello World!", template.render(Scope.new)
+  end
+
+  test "passing locals" do
+    template = Tilt::ERBTemplate.new { 'Hey <%= name %>!' }
+    assert_equal "Hey Joe!", template.render(Scope.new, :name => 'Joe')
+  end
+
+  test "evaluating in an object scope" do
+    template = Tilt::ERBTemplate.new { 'Hey <%= @name %>!' }
+    scope = Scope.new
+    scope.instance_variable_set :@name, 'Joe'
+    assert_equal "Hey Joe!", template.render(scope)
+    scope.instance_variable_set :@name, 'Jane'
+    assert_equal "Hey Jane!", template.render(scope)
+  end
+
+  test "passing a block for yield" do
+    template = Tilt::ERBTemplate.new { 'Hey <%= yield %>!' }
+    assert_equal "Hey Joe!", template.render(Scope.new) { 'Joe' }
+    assert_equal "Hey Jane!", template.render(Scope.new) { 'Jane' }
+  end
+
+  test "backtrace file and line reporting without locals" do
+    data = File.read(__FILE__).split("\n__END__\n").last
+    fail unless data[0] == ?<
+    template = Tilt::ERBTemplate.new('test.erb', 11) { data }
+    begin
+      template.render(Scope.new)
+      fail 'should have raised an exception'
+    rescue => boom
+      assert_kind_of NameError, boom
+      line = boom.backtrace.first
+      file, line, meth = line.split(":")
+      assert_equal 'test.erb', file
+      assert_equal '13', line
+    end
+  end
+
+  test "backtrace file and line reporting with locals" do
+    data = File.read(__FILE__).split("\n__END__\n").last
+    fail unless data[0] == ?<
+    template = Tilt::ERBTemplate.new('test.erb') { data }
+    begin
+      template.render(Scope.new, :name => 'Joe', :foo => 'bar')
+      fail 'should have raised an exception'
+    rescue => boom
+      assert_kind_of RuntimeError, boom
+      line = boom.backtrace.first
+      file, line, meth = line.split(":")
+      assert_equal 'test.erb', file
+      assert_equal '6', line
+    end
+  end
+
+  test "default non-stripping trim mode" do
+    template = Tilt.new('test.erb') { "\n<%= 1 + 1 %>\n" }
+    assert_equal "\n2\n", template.render(Scope.new)
+  end
+
+  test "stripping trim mode" do
+    template = Tilt.new('test.erb', :trim => '-') { "\n<%= 1 + 1 -%>\n" }
+    assert_equal "\n2", template.render(Scope.new)
+  end
+
+  test "shorthand whole line syntax trim mode" do
+    template = Tilt.new('test.erb', :trim => '%') { "\n% if true\nhello\n%end\n" }
+    assert_equal "\nhello\n", template.render(Scope.new)
+  end
 end
 
 __END__

data/test/tilt_erubistemplate_test.rb

@@ -9,7 +9,7 @@ begin
       assert_equal Tilt::ErubisTemplate, Tilt['test.html.erubis']
     end
 
-    test "compiling and evaluating templates on #render" do
+    test "preparing and evaluating templates on #render" do
       template = Tilt::ErubisTemplate.new { |t| "Hello World!" }
       assert_equal "Hello World!", template.render
     end
@@ -26,6 +26,23 @@ begin
       assert_equal "Hey Joe!", template.render(scope)
     end
 
+    class MockOutputVariableScope
+      attr_accessor :exposed_buffer
+    end
+
+    test "exposing the buffer to the template by default" do
+      begin
+        Tilt::ErubisTemplate.default_output_variable = '@_out_buf'
+        template = Tilt::ErubisTemplate.new { '<% self.exposed_buffer = @_out_buf %>hey' }
+        scope = MockOutputVariableScope.new
+        template.render(scope)
+        assert_not_nil scope.exposed_buffer
+        assert_equal scope.exposed_buffer, 'hey'
+      ensure
+        Tilt::ErubisTemplate.default_output_variable = '_erbout'
+      end
+    end
+
     test "passing a block for yield" do
       template = Tilt::ErubisTemplate.new { 'Hey <%= yield %>!' }
       assert_equal "Hey Joe!", template.render { 'Joe' }
@@ -69,6 +86,40 @@ begin
       scope.instance_variable_set :@name, 'Joe'
       assert_equal "Hey Joe!", template.render(scope)
     end
+
+    test "using an instance variable as the outvar" do
+      template = Tilt::ErubisTemplate.new(nil, :outvar => '@buf') { "<%= 1 + 1 %>" }
+      scope = Object.new
+      scope.instance_variable_set(:@buf, 'original value')
+      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_hamltemplate_test.rb

@@ -12,7 +12,7 @@ begin
       assert_equal Tilt::HamlTemplate, Tilt['test.haml']
     end
 
-    test "compiling and evaluating templates on #render" do
+    test "preparing and evaluating templates on #render" do
       template = Tilt::HamlTemplate.new { |t| "%p Hello World!" }
       assert_equal "<p>Hello World!</p>\n", template.render
     end
@@ -66,6 +66,70 @@ begin
     end
   end
 
+  class CompiledHamlTemplateTest < Test::Unit::TestCase
+    class Scope
+      include Tilt::CompileSite
+    end
+
+    test "compiling template source to a method" do
+      template = Tilt::HamlTemplate.new { |t| "Hello World!" }
+      template.render(Scope.new)
+      method_name = template.send(:compiled_method_name, [])
+      method_name = method_name.to_sym if Symbol === Kernel.methods.first
+      assert Tilt::CompileSite.instance_methods.include?(method_name),
+        "CompileSite.instance_methods.include?(#{method_name.inspect})"
+      assert Scope.new.respond_to?(method_name),
+        "scope.respond_to?(#{method_name.inspect})"
+    end
+
+    test "passing locals" do
+      template = Tilt::HamlTemplate.new { "%p= 'Hey ' + name + '!'" }
+      assert_equal "<p>Hey Joe!</p>\n", template.render(Scope.new, :name => 'Joe')
+    end
+
+    test "evaluating in an object scope" do
+      template = Tilt::HamlTemplate.new { "%p= 'Hey ' + @name + '!'" }
+      scope = Scope.new
+      scope.instance_variable_set :@name, 'Joe'
+      assert_equal "<p>Hey Joe!</p>\n", template.render(scope)
+    end
+
+    test "passing a block for yield" do
+      template = Tilt::HamlTemplate.new { "%p= 'Hey ' + yield + '!'" }
+      assert_equal "<p>Hey Joe!</p>\n", template.render(Scope.new) { 'Joe' }
+    end
+
+    test "backtrace file and line reporting without locals" do
+      data = File.read(__FILE__).split("\n__END__\n").last
+      fail unless data[0] == ?%
+      template = Tilt::HamlTemplate.new('test.haml', 10) { data }
+      begin
+        template.render(Scope.new)
+        fail 'should have raised an exception'
+      rescue => boom
+        assert_kind_of NameError, boom
+        line = boom.backtrace.first
+        file, line, meth = line.split(":")
+        assert_equal 'test.haml', file
+        assert_equal '12', line
+      end
+    end
+
+    test "backtrace file and line reporting with locals" do
+      data = File.read(__FILE__).split("\n__END__\n").last
+      fail unless data[0] == ?%
+      template = Tilt::HamlTemplate.new('test.haml') { data }
+      begin
+        res = template.render(Scope.new, :name => 'Joe', :foo => 'bar')
+      rescue => boom
+        assert_kind_of MockError, boom
+        line = boom.backtrace.first
+        file, line, meth = line.split(":")
+        assert_equal 'test.haml', file
+        assert_equal '5', line
+      end
+    end
+  end
 rescue LoadError => boom
   warn "Tilt::HamlTemplate (disabled)\n"
 end

data/test/tilt_liquidtemplate_test.rb

@@ -9,7 +9,7 @@ begin
       assert_equal Tilt::LiquidTemplate, Tilt['test.liquid']
     end
 
-    test "compiling and evaluating templates on #render" do
+    test "preparing and evaluating templates on #render" do
       template = Tilt::LiquidTemplate.new { |t| "Hello World!" }
       assert_equal "Hello World!", template.render
     end

data/test/tilt_radiustemplate_test.rb

@@ -0,0 +1,66 @@
+require 'contest'
+require 'tilt'
+
+begin
+  require 'radius'
+
+  class RadiusTemplateTest < Test::Unit::TestCase
+    test "registered for '.radius' files" do
+      assert_equal Tilt::RadiusTemplate, Tilt['test.radius']
+    end
+
+    test "preparing and evaluating templates on #render" do
+      template = Tilt::RadiusTemplate.new { |t| "Hello World!" }
+      assert_equal "Hello World!", template.render
+    end
+
+    test "passing locals" do
+      template = Tilt::RadiusTemplate.new { "Hey <r:name />!" }
+      assert_equal "Hey Joe!", template.render(nil, :name => 'Joe')
+    end
+
+    class ExampleRadiusScope
+      def beer; 'wet'; end
+      def whisky; 'wetter'; end
+    end
+
+    test "combining scope and locals when scope responds" do
+      template = Tilt::RadiusTemplate.new {
+        'Beer is <r:beer /> but Whisky is <r:whisky />.'
+      }
+      scope = ExampleRadiusScope.new
+      assert_equal "Beer is wet but Whisky is wetter.", template.render(scope)
+    end
+
+    test "precedence when locals and scope define same variables" do
+      template = Tilt::RadiusTemplate.new {
+        'Beer is <r:beer /> but Whisky is <r:whisky />.'
+      }
+      scope = ExampleRadiusScope.new
+      assert_equal "Beer is great but Whisky is greater.",
+        template.render(scope, :beer => 'great', :whisky => 'greater')
+    end
+
+    #test "handles local scope" do
+    #  beer   = 'wet'
+    #  whisky = 'wetter'
+    #
+    #  template = Tilt::RadiusTemplate.new {
+    #    'Beer is <r:beer /> but Whisky is <r:whisky />.'
+    #  }
+    #  assert_equal "Beer is wet but Whisky is wetter.", template.render(self)
+    #end
+
+    test "passing a block for yield" do
+      template = Tilt::RadiusTemplate.new {
+        'Beer is <r:yield /> but Whisky is <r:yield />ter.'
+      }
+      assert_equal "Beer is wet but Whisky is wetter.",
+        template.render({}) { 'wet' }
+    end
+  end
+
+rescue LoadError => boom
+  warn "Tilt::RadiusTemplate (disabled)\n"
+end
+

data/test/tilt_rdiscounttemplate_test.rb

@@ -17,20 +17,20 @@ begin
       assert_equal Tilt::RDiscountTemplate, Tilt['test.mkd']
     end
 
-    test "compiling and evaluating templates on #render" do
+    test "preparing and evaluating templates on #render" do
       template = Tilt::RDiscountTemplate.new { |t| "# Hello World!" }
       assert_equal "<h1>Hello World!</h1>\n", template.render
     end
 
     test "smartypants when :smart is set" do
-      template = Tilt::RDiscountTemplate.new(nil, :smart => true) { |t|
+      template = Tilt::RDiscountTemplate.new(:smart => true) { |t|
         "OKAY -- 'Smarty Pants'" }
       assert_equal "<p>OKAY &mdash; &lsquo;Smarty Pants&rsquo;</p>\n",
         template.render
     end
 
     test "stripping HTML when :filter_html is set" do
-      template = Tilt::RDiscountTemplate.new(nil, :filter_html => true) { |t|
+      template = Tilt::RDiscountTemplate.new(:filter_html => true) { |t|
         "HELLO <blink>WORLD</blink>" }
       assert_equal "<p>HELLO &lt;blink>WORLD&lt;/blink></p>\n", template.render
     end

data/test/tilt_rdoctemplate_test.rb

@@ -9,7 +9,7 @@ begin
       assert_equal Tilt::RDocTemplate, Tilt['test.rdoc']
     end
 
-    test "compiling and evaluating the template with #render" do
+    test "preparing and evaluating the template with #render" do
       template = Tilt::RDocTemplate.new { |t| "= Hello World!" }
       assert_equal "<h1>Hello World!</h1>\n", template.render
     end

data/test/tilt_sasstemplate_test.rb

@@ -11,8 +11,8 @@ begin
     end
 
     test "compiles and evaluates the template on #render" do
-      template = Tilt::SassTemplate.new { |t| "#main\n  :background-color #0000ff" }
-      assert_equal "#main {\n  background-color: #0000ff; }\n", template.render
+      template = Tilt::SassTemplate.new { |t| "#main\n  :background-color #0000f1" }
+      assert_equal "#main {\n  background-color: #0000f1; }\n", template.render
     end
   end