mustache 0.2.2 → 0.3.0

data/HISTORY.md

@@ -1,3 +1,16 @@
+## 0.3.0 (2009-??-??)
+
+* Set Delimiter tags are now supported. See the README
+* Improved error message when an enumerable section did not return all
+  hashes.
+* Added a shortcut: if a section's value is a single hash, treat is as
+  a one element array whose value is the hash.
+* Bugfix: String templates set at the class level were not compiled
+* Added a class-level `compiled?` method for checking if a template
+  has been compiled.
+* Added an instance-level `compiled?` method.
+* Cache template compilation in Sinatra
+
 ## 0.2.2 (2009-10-11)
 
 * Improved documentation

data/README.md

@@ -144,6 +144,24 @@ And this view code:
 When rendered, our view will contain a list of all repository names in
 the database.
 
+As a convenience, if a section returns a hash (as opposed to an array
+or a boolean) it will be treated as a single item array.
+
+With the above template, we could use this Ruby code for a single
+iteration:
+
+    def repo
+      { :name => Repository.first.to_s }
+    end
+
+This would be treated by Mustache as functionally equivalent to the
+following:
+
+    def repo
+      [ { :name => Repository.first.to_s } ]
+    end
+
+
 ### Comments
 
 Comments begin with a bang and are ignored. The following template:
@@ -165,6 +183,31 @@ In this way partials can reference variables or sections the calling
 view defines.
 
 
+### Set Delimiter
+
+Set Delimiter tags start with an equal sign and change the tag
+delimiters from {{ and }} to custom strings.
+
+Consider the following contrived example:
+
+    * {{ default_tags }}
+    {{=<% %>=}}
+    * <% erb_style_tags %>
+    <%={{ }}=%>
+    * {{ default_tags_again }}
+
+Here we have a list with three items. The first item uses the default
+tag style, the second uses erb style as defined by the Set Delimiter
+tag, and the third returns to the default style after yet another Set
+Delimiter declaration.
+
+According to [ctemplates][3], this "is useful for languages like TeX, where
+double-braces may occur in the text and are awkward to use for
+markup."
+
+Custom delimiters may not contain whitespace or the equals sign.
+
+
 Dict-Style Views
 ----------------
 
@@ -206,11 +249,11 @@ follows the classic Ruby naming convention.
 
     TemplatePartial => ./template_partial.html
 
-You can set the search path using `Mustache.path`. It can be set on a
+You can set the search path using `Mustache.template_path`. It can be set on a
 class by class basis:
 
     class Simple < Mustache
-      self.path = File.dirname(__FILE__)
+      self.template_path = File.dirname(__FILE__)
       ... etc ...
     end
 
@@ -222,11 +265,18 @@ If you want to just change what template is used you can set
 
     Simple.template_file = './blah.html'
 
-You can also go ahead and set the template directly:
+Mustache also allows you to define the extension it'll use.
+
+    Simple.template_extension = 'xml'
+
+Given all other defaults, the above line will cause Mustache to look
+for './blah.xml'
+
+Feel free to set the template directly:
 
     Simple.template = 'Hi {{person}}!'
 
-You can also set a different template for only a single instance:
+Or set a different template for a single instance:
 
     Simple.new.template = 'Hi {{person}}!'
 
@@ -347,3 +397,4 @@ Meta
 
 [1]: http://code.google.com/p/google-ctemplate/
 [2]: http://www.ivan.fomichev.name/2008/05/erlang-template-engine-prototype.html
+[3]: http://google-ctemplate.googlecode.com/svn/trunk/doc/howto.html

data/Rakefile

@@ -47,3 +47,16 @@ task :publish => [ :gemspec, :build ] do
   system "git clean -fd"
   exec "rake pages"
 end
+
+desc "Install the edge gem"
+task :install_edge => [ :dev_version, :gemspec, :build ] do
+  exec "gem install pkg/mustache-#{Mustache::Version}.gem"
+end
+
+# Sets the current Mustache version to the current dev version
+task :dev_version do
+  $LOAD_PATH.unshift 'lib/mustache'
+  require 'mustache/version'
+  version = Mustache::Version + '.' + Time.now.to_i.to_s
+  Mustache.const_set(:Version, version)
+end

data/examples/delimiters.html

@@ -0,0 +1,6 @@
+{{=<% %>=}}
+* <% first %>
+<%=| |=%>
+* | second |
+|={{ }}=|
+* {{ third }}

data/examples/delimiters.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'mustache'
+
+class Delimiters < Mustache
+  self.path = File.dirname(__FILE__)
+
+  def first
+    "It worked the first time."
+  end
+
+  def second
+    "And it worked the second time."
+  end
+
+  def third
+    "Then, surprisingly, it worked the third time."
+  end
+end
+
+if $0 == __FILE__
+  puts Delimiters.to_html
+end

data/lib/mustache.rb

@@ -123,7 +123,18 @@ class Mustache
   end
 
   def self.template=(template)
-    @template = template
+    @template = templateify(template)
+  end
+
+  # Has this template already been compiled? Compilation is somewhat
+  # expensive so it may be useful to check this before attempting it.
+  def self.compiled?
+    @template.is_a? Template
+  end
+
+  # Has this instance or its class already compiled a template?
+  def compiled?
+    (@template && @template.is_a?(Template)) || self.class.compiled?
   end
 
   # template_partial => TemplatePartial

data/lib/mustache/sinatra.rb

@@ -67,6 +67,9 @@ class Mustache
           require "#{file}".chomp('.rb')
           klass = namespace::Views.const_get(name)
 
+          # compile and cache the template
+          klass.template = data
+
         else
           # Still nothing. Use the stache.
           klass = Mustache
@@ -90,7 +93,7 @@ class Mustache
         # lets us use {{yield}} in layout.html to render the actual page.
         instance[:yield] = block.call if block
 
-        instance.template = data
+        instance.template = data unless instance.compiled?
         instance.to_html
       end
     end

data/lib/mustache/template.rb

@@ -47,15 +47,30 @@ class Mustache
     # If enumerable, the return value is iterated over (a `for` loop).
     def compile_sections(src)
       res = ""
-      while src =~ /\{\{\#(.+)\}\}\s*(.+)\{\{\/\1\}\}\s*/m
+      while src =~ /#{otag}\#(.+)#{ctag}\s*(.+)#{otag}\/\1#{ctag}\s*/m
         # $` = The string to the left of the last successful match
         res << compile_tags($`)
         name = $1.strip.to_sym.inspect
         code = compile($2)
         ctxtmp = "ctx#{tmpid}"
-        res << ev("(v = ctx[#{name}]) ? v.respond_to?(:each) ? "\
-          "(#{ctxtmp}=ctx.dup; r=v.map{|h|ctx.update(h);#{code}}.join; "\
-          "ctx.replace(#{ctxtmp});r) : #{code} : ''")
+        res << ev(<<-compiled)
+        if v = ctx[#{name}]
+          v = [v] if v.is_a?(Hash) # shortcut when passed a single hash
+          if v.respond_to?(:each)
+            #{ctxtmp} = ctx.dup
+            begin
+              r = v.map { |h| ctx.update(h); #{code} }.join
+            rescue TypeError => e
+              raise TypeError,
+                "All elements in {{#{name.to_s[1..-1]}}} are not hashes!"
+            end
+            ctx.replace(#{ctxtmp})
+            r
+          else
+            #{code}
+          end
+        end
+        compiled
         # $' = The string to the right of the last successful match
         src = $'
       end
@@ -70,11 +85,13 @@ class Mustache
     # 4. Partial tags - {{< partial_name }}
     def compile_tags(src)
       res = ""
-      while src =~ /\{\{(!|<|\{)?([^\/#]+?)\1?\}\}+/
+      while src =~ /#{otag}(=|!|<|\{)?([^\/#]+?)\1?#{ctag}+/
         res << str($`)
         case $1
         when '!'
           # ignore comments
+        when '='
+          self.otag, self.ctag = $2.strip.split(' ', 2)
         when '<'
           res << compile_partial($2.strip)
         when '{'
@@ -108,6 +125,24 @@ class Mustache
       s.inspect[1..-2]
     end
 
+    # {{ - opening tag delimiter
+    def otag
+      @otag ||= Regexp.escape('{{')
+    end
+
+    def otag=(tag)
+      @otag = Regexp.escape(tag)
+    end
+
+    # }} - closing tag delimiter
+    def ctag
+      @ctag ||= Regexp.escape('}}')
+    end
+
+    def ctag=(tag)
+      @ctag = Regexp.escape(tag)
+    end
+
     # {{}} - an escaped tag
     def etag(s)
       ev("CGI.escapeHTML(ctx[#{s.strip.to_sym.inspect}].to_s)")

data/lib/mustache/version.rb

@@ -1,3 +1,3 @@
 class Mustache
-  Version = '0.2.2'
+  Version = '0.3.0'
 end

data/test/mustache_test.rb

@@ -9,6 +9,7 @@ require 'escaped'
 require 'unescaped'
 require 'comments'
 require 'passenger'
+require 'delimiters'
 
 class MustacheTest < Test::Unit::TestCase
   def test_passenger
@@ -24,12 +25,23 @@ end_passenger
   def test_complex_view
     assert_equal <<-end_complex, ComplexView.render
 <h1>Colors</h1>
-  <ul>
-      <li><strong>red</strong></li>
-      <li><a href="#Green">green</a></li>
-      <li><a href="#Blue">blue</a></li>
-  </ul>
+<ul>
+  <li><strong>red</strong></li>
+    <li><a href="#Green">green</a></li>
+    <li><a href="#Blue">blue</a></li>
+    </ul>
 end_complex
+
+# TODO: Preserve indentation
+# http://github.com/defunkt/mustache/issues#issue/2
+#     assert_equal <<-end_complex, ComplexView.render
+# <h1>Colors</h1>
+#   <ul>
+#       <li><strong>red</strong></li>
+#       <li><a href="#Green">green</a></li>
+#       <li><a href="#Blue">blue</a></li>
+#   </ul>
+# end_complex
   end
 
   def test_single_line_sections
@@ -131,6 +143,18 @@ Welcome
 end_partial
   end
 
+
+  def test_delimiters
+    assert_equal <<-end_partial, Delimiters.render
+
+* It worked the first time.
+
+* And it worked the second time.
+
+* Then, surprisingly, it worked the third time.
+end_partial
+  end
+
   def test_comments
     assert_equal "<h1>A Comedy of Errors</h1>\n", Comments.render
   end
@@ -182,4 +206,59 @@ data
                                                      :deploy_to => '/var/www/example.com' )
   end
 
+  def test_reports_type_errors_in_sections
+    instance = Mustache.new
+    instance[:list] = [ :item, 1234 ]
+    instance.template = '{{#list}} <li>{{item}}</li> {{/list}}'
+
+    assert_raise TypeError do
+      instance.render
+    end
+  end
+
+  def test_enumerable_sections_accept_a_hash_as_a_context
+    instance = Mustache.new
+    instance[:list] = { :item => 1234 }
+    instance.template = '{{#list}} <li>{{item}}</li> {{/list}}'
+
+    assert_equal '<li>1234</li>', instance.render.strip
+  end
+
+  def test_knows_when_its_been_compiled_when_set_with_string
+    klass = Class.new(Mustache)
+
+    assert ! klass.compiled?
+    klass.template = 'Hi, {{person}}!'
+    assert klass.compiled?
+  end
+
+  def test_knows_when_its_been_compiled_when_using_a_file_template
+    klass = Class.new(Simple)
+    klass.template_file = File.dirname(__FILE__) + '/../examples/simple.html'
+
+    assert ! klass.compiled?
+    klass.render
+    assert klass.compiled?
+  end
+
+  def test_an_instance_knows_when_its_class_is_compiled
+    instance = Simple.new
+
+    assert ! Simple.compiled?
+    assert ! instance.compiled?
+
+    Simple.render
+
+    assert Simple.compiled?
+    assert instance.compiled?
+  end
+
+  def test_knows_when_its_been_compiled_at_the_instance_level
+    klass = Class.new(Mustache)
+    instance = klass.new
+
+    assert ! instance.compiled?
+    instance.template = 'Hi, {{person}}!'
+    assert instance.compiled?
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mustache
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-11 00:00:00 -07:00
+date: 2009-10-14 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -38,6 +38,8 @@ files:
 - examples/comments.rb
 - examples/complex_view.html
 - examples/complex_view.rb
+- examples/delimiters.html
+- examples/delimiters.rb
 - examples/escaped.html
 - examples/escaped.rb
 - examples/inner_partial.html
@@ -91,6 +93,7 @@ test_files:
 - test/mustache_test.rb
 - examples/comments.rb
 - examples/complex_view.rb
+- examples/delimiters.rb
 - examples/escaped.rb
 - examples/passenger.rb
 - examples/simple.rb