mustache 0.99.4 → 1.1.3

data/man/mustache.5.ron

@@ -38,6 +38,12 @@ clauses, or for loops. Instead there are only tags. Some tags are
 replaced with a value, some nothing, and others a series of
 values. This document explains the different types of Mustache tags.
 
+The Mustache language has a [formal specification][spec]. The current
+manpage reflects version 1.3.0 of the specification, including the
+official-but-optional extensions for lambdas and inheritance.
+
+[spec]: https://github.com/mustache/spec
+
 
 ## TAG TYPES
 
@@ -50,12 +56,14 @@ or tag key. Let's talk about the different types of tags.
 
 The most basic tag type is the variable. A `{{name}}` tag in a basic
 template will try to find the `name` key in the current context. If
-there is no `name` key, nothing will be rendered.
+there is no `name` key, the parent contexts will be checked recursively.
+If the top context is reached and the `name` key is still not found,
+nothing will be rendered.
 
-All variables are HTML escaped by default. If you want to return
-unescaped HTML, use the triple mustache: `{{{name}}}`.
+All variables are HTML escaped by default. If you want to return raw contents
+without escaping, use the triple mustache: `{{{name}}}`.
 
-You can also use `&` to unescape a variable: `{{& name}}`. This may be
+You can also use `&` to return its raw contents: `{{& name}}`. This may be
 useful when changing delimiters (see "Set Delimiter" below).
 
 By default a variable "miss" returns an empty string. This can usually
@@ -83,16 +91,113 @@ Output:
     * <b>GitHub</b>
     * <b>GitHub</b>
 
+**Dotted Names**
+
+If the `name` contains dots, it is split on the dots to obtain multiple
+keys. The first key is looked up in the context as described above. If it
+is found, the next key is looked up within the previous result. This is
+repeated until a key is not found or until the last key is found. The
+final result is interpolated as above.
+
+Template:
+
+    * {{client.name}}
+    * {{age}}
+    * {{client.company.name}}
+    * {{{company.name}}}
+
+Hash:
+
+    {
+      "client": {
+        "name": "Chris & Friends",
+        "age": 50
+      },
+      "company": {
+        "name": "<b>GitHub</b>"
+      }
+    }
+
+Output:
+
+    * Chris &amp; Friends
+    *
+    *
+    * <b>GitHub</b>
+
+**Implicit Iterator**
+
+As a special case, if the `name` consists of only a dot and nothing else,
+the value that is the current context is interpolated as a whole. This
+is especially useful if the parent context is a list; see **Sections**
+below.
+
+Template:
+
+    * {{.}}
+
+Current context:
+
+    "Hello!"
+
+Output:
+
+    * Hello!
+
+**Lambdas**
+
+If any value found during the lookup is a callable object, such as a
+function or lambda, this object will be invoked with zero arguments. The
+value that is returned is then used instead of the callable object itself.
+
+An **optional** part of the specification states that if the final key in
+the `name` is a lambda that returns a string, then that string should be
+rendered as a Mustache template before interpolation. It will be rendered
+using the default delimiters (see **Set Delimiter** below) against the
+current context.
+
+Template:
+
+    * {{time.hour}}
+    * {{today}}
+
+Hash:
+
+    {
+      "year": 1970,
+      "month": 1,
+      "day": 1,
+      "time": function() {
+        return {
+          "hour": 0,
+          "minute": 0,
+          "second": 0
+        }
+      },
+      "today": function() {
+        return "{{year}}-{{month}}-{{day}}"
+      }
+    }
+
+Output:
+
+    * 0
+    * 1970-1-1
+
 
 ### Sections
 
-Sections render blocks of text one or more times, depending on the
+Sections render blocks of text zero or more times, depending on the
 value of the key in the current context.
 
+Lookup of dotted names works in the same way as with variables, except for
+slightly different treatment of lambdas. More on this below.
+
 A section begins with a pound and ends with a slash. That is,
 `{{#person}}` begins a "person" section while `{{/person}}` ends it.
 
-The behavior of the section is determined by the value of the key.
+The behavior of the section is determined by the final value of the key
+lookup.
 
 **False Values or Empty Lists**
 
@@ -102,14 +207,14 @@ list, the HTML between the pound and slash will not be displayed.
 Template:
 
     Shown.
-    {{#nothin}}
+    {{#person}}
       Never shown!
-    {{/nothin}}
+    {{/person}}
 
 Hash:
 
     {
-      "person": true,
+      "person": false
     }
 
 Output:
@@ -118,7 +223,7 @@ Output:
 
 **Non-Empty Lists**
 
-If the `person` key exists and has a non-false value, the HTML between
+If the `repo` key exists and has a non-false value, the HTML between
 the pound and slash will be rendered and displayed one or more times.
 
 When the value is a non-empty list, the text in the block will be
@@ -138,38 +243,60 @@ Hash:
       "repo": [
         { "name": "resque" },
         { "name": "hub" },
-        { "name": "rip" },
+        { "name": "rip" }
       ]
     }
 
 Output:
 
-    <b>resque</b>
-    <b>hub</b>
-    <b>rip</b>
+      <b>resque</b>
+      <b>hub</b>
+      <b>rip</b>
+
+The same effect as above can be obtained without nested objects, by using
+the implicit iterator (see **Variables** above).
+
+Template:
+
+    {{#repo}}
+      <b>{{.}}</b>
+    {{/repo}}
+
+Hash:
+
+    {
+      "repo": ["resque", "hub", "rip"]
+    }
+
+Output:
+
+      <b>resque</b>
+      <b>hub</b>
+      <b>rip</b>
 
 **Lambdas**
 
-When the value is a callable object, such as a function or lambda, the
-object will be invoked and passed the block of text. The text passed
-is the literal block, unrendered. `{{tags}}` will not have been expanded
-- the lambda should do that on its own. In this way you can implement
-filters or caching.
+When any value found during the lookup is a callable object, such as a
+function or lambda, the object will be invoked and passed the block of
+text. The text passed is the literal block, unrendered. `{{tags}}` will
+not have been expanded.
+
+An **optional** part of the specification states that if the final key in
+the `name` is a lambda that returns a string, then that string replaces
+the content of the section. It will be rendered using the same delimiters
+(see **Set Delimiter** below) as the original section content. In this way
+you can implement filters or caching.
 
 Template:
 
-    {{#wrapped}}
-      {{name}} is awesome.
-    {{/wrapped}}
+    {{#wrapped}}{{name}} is awesome.{{/wrapped}}
 
 Hash:
 
     {
       "name": "Willy",
-      "wrapped": function() {
-        return function(text) {
-          return "<b>" + render(text) + "</b>"
-        }
+      "wrapped": function(text) {
+        return "<b>" + text + "</b>"
       }
     }
 
@@ -196,7 +323,7 @@ Hash:
 
 Output:
 
-    Hi Jon!
+      Hi Jon!
 
 
 ### Inverted Sections
@@ -205,7 +332,7 @@ An inverted section begins with a caret (hat) and ends with a
 slash. That is `{{^person}}` begins a "person" inverted section while
 `{{/person}}` ends it.
 
-While sections can be used to render text one or more times based on the
+While sections can be used to render text zero or more times based on the
 value of the key, inverted sections may render text once based
 on the inverse value of the key. That is, they will be rendered
 if the key doesn't exist, is false, or is an empty list.
@@ -227,7 +354,7 @@ Hash:
 
 Output:
 
-    No repos :(
+      No repos :(
 
 
 ### Comments
@@ -284,6 +411,139 @@ Can be thought of as a single, expanded template:
     {{/names}}
 
 
+**Dynamic Names**
+
+Partials can be loaded dynamically at runtime using Dynamic Names; an
+**optional** part of the Mustache specification which allows to dynamically
+determine a tag's content at runtime.
+
+Dynamic Names consists of an asterisk, followed by a dotted name which follows
+the same notation and the same resolution as in an variable tag. That is
+`{{>*dynamic}}`. It can be thought as the following **hypothetical** tag
+(which is **not allowed**!): `{{>{{dynamic}}}}`.
+
+Templates:
+
+    main.mustache:
+    Hello {{>*dynamic}}
+    
+    world.template:
+    everyone!
+
+Hash:
+
+    {
+      "dynamic": "world"
+    }
+
+Output:
+
+    Hello everyone!
+
+
+### Blocks
+
+A block begins with a dollar and ends with a slash. That is, `{{$title}}`
+begins a "title" block and `{{/title}}` ends it.
+
+Blocks mark parts of the template that may be overridden. This can be done
+with a block of the same name within a parent section in the calling
+template (see **Parents** below). If not overridden, the contents of a
+block render just as if the `{{$title}}` and `{{/title}}` tags weren't
+there.
+
+Blocks could be thought of as template parameters or as inline partials
+that may be passed to another template. They are part of the optional
+inheritance extension.
+
+Template `article.mustache`:
+
+    <h1>{{$title}}The News of Today{{/title}}</h1>
+    {{$body}}
+    <p>Nothing special happened.</p>
+    {{/body}}
+
+Output:
+
+    <h1>The News of Today</h1>
+    <p>Nothing special happened.</p>
+
+
+### Parents
+
+A parent begins with a less than sign and ends with a slash. That is,
+`{{<article}}` begins an "article" parent and `{{/article}}` ends it.
+
+Like an `{{>article}}` partial, a parent lets you expand another template
+inside the current one. Unlike a partial, a parent also lets you override
+blocks of the other template.
+
+Blocks within a parent can again be overridden by another including
+template. Other content within a parent is ignored, like comments.
+
+Template:
+
+    {{<article}}
+      Never shown
+      {{$body}}
+        {{#headlines}}
+        <p>{{.}}</p>
+        {{/headlines}}
+      {{/body}}
+    {{/article}}
+
+    {{<article}}
+      {{$title}}Yesterday{{/title}}
+    {{/article}}
+
+Hash:
+
+    {
+      "headlines": [
+        "A pug's handler grew mustaches.",
+        "What an exciting day!"
+      ]
+    }
+
+Output, assuming the `article.mustache` from before:
+
+    <h1>The News of Today</h1>
+    <p>A pug's handler grew mustaches.</p>
+    <p>What an exciting day!</p>
+
+    <h1>Yesterday</h1>
+    <p>Nothing special happened.</p>
+
+**Dynamic Names**
+
+Some mustache implementations may allow the use of Dynamic Names in
+parent tags, similar to dynamic names in partials. Here's an example of
+how Dynamic Names in parent tags work.
+
+Templates:
+
+    {{!normal.mustache}}
+    {{$text}}Here goes nothing.{{/text}}
+
+    {{!bold.mustache}}
+    <b>{{$text}}Here also goes nothing but it's bold.{{/text}}</b>
+
+    {{!dynamic.mustache}}
+    {{<*dynamic}}
+      {{$text}}Hello World!{{/text}}
+    {{/*dynamic}}
+
+Hash:
+
+    {
+      "dynamic": "bold"
+    }
+
+Output:
+
+    <b>Hello World!</b>
+
+
 ### Set Delimiter
 
 Set Delimiter tags start with an equal sign and change the tag
@@ -308,7 +568,7 @@ markup."
 
 Custom delimiters may not contain whitespace or the equals sign.
 
-[ct]: http://google-ctemplate.googlecode.com/svn/trunk/doc/howto.html
+[ct]: http://goog-ctemplate.sourceforge.net/doc/howto.html
 
 
 ## COPYRIGHT
@@ -320,5 +580,5 @@ Original CTemplate by Google
 
 ## SEE ALSO
 
-mustache(1), mustache(7),
-<http://mustache.github.com/>
+mustache(1),
+<http://mustache.github.io/>

data/test/autoloading_test.rb

@@ -1,13 +1,17 @@
-$LOAD_PATH.unshift File.dirname(__FILE__)
-require 'helper'
+require_relative 'helper'
 
 module TestViews; end
 
-class AutoloadingTest < Test::Unit::TestCase
+class AutoloadingTest < Minitest::Test
   def setup
     Mustache.view_path = File.dirname(__FILE__) + '/fixtures'
   end
 
+  # Restore `view_namespace` to the default value
+  def teardown
+    Mustache.view_namespace = Object
+  end
+
   def test_autoload
     klass = Mustache.view_class(:Comments)
     assert_equal Comments, klass

data/test/fixtures/comments.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class Comments < Mustache

data/test/fixtures/complex_view.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class ComplexView < Mustache

data/test/fixtures/crazy_recursive.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class CrazyRecursive < Mustache

data/test/fixtures/delimiters.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class Delimiters < Mustache

data/test/fixtures/dot_notation.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class DotNotation < Mustache

data/test/fixtures/double_section.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class DoubleSection < Mustache

data/test/fixtures/inverted_section.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class InvertedSection < Mustache

data/test/fixtures/lambda.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class Lambda < Mustache

data/test/fixtures/liberal.mustache

@@ -0,0 +1 @@
+{{first-name}} {{middle_name!}} {{lastName?}} {{street-address}}

data/test/fixtures/liberal.rb

@@ -0,0 +1,25 @@
+require 'mustache'
+
+class Liberal < Mustache
+  self.path = File.dirname(__FILE__)
+
+  def first_name
+    "kevin"
+  end
+
+  def middle_name!
+    'j'
+  end
+
+  def lastName?
+    'sheurs'
+  end
+
+  define_method :'street-address' do
+    '123 Somewhere St'
+  end
+end
+
+if $0 == __FILE__
+  puts Liberal.to_html
+end

data/test/fixtures/method_missing.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class MethodMissing < Mustache

data/test/fixtures/namespaced.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 module TestViews

data/test/fixtures/nested_objects.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 require 'ostruct'
 

data/test/fixtures/override/passenger.conf

@@ -0,0 +1,6 @@
+<VirtualHost *>
+  ServerAdmin override@mustache.com
+  ServerName {{server}}
+  DocumentRoot {{deploy_to}}
+  RailsEnv {{stage}}
+</VirtualHost>

data/test/fixtures/partial_with_module.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 module SimpleView

data/test/fixtures/passenger.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class Passenger < Mustache

data/test/fixtures/recursive.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class Recursive < Mustache

data/test/fixtures/simple.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class Simple < Mustache

data/test/fixtures/simply_complicated.mustache

@@ -0,0 +1,25 @@
+Hi there {{yourname}}.  Your home directory is {{HOME}}.
+
+{{#friend}}
+Your friend is named {{name}}
+  {{#morr}}
+   Hey {{word}} {{up}} {{{awesomesauce}}}.
+   {{/morr}}
+   {{^morr}}
+   Booooo.  {{hiss}}
+   {{/morr}}
+   {{notinmorr}}
+   {{> partial1}}
+{{/friend}}
+{{^friend}}
+You have no friends, {{person}}.  You suck.
+{{/friend}}
+
+{{> partial2}}
+{{! comments are awesome }}
+
+{{={% %}=}}
+
+{%love%}
+{%={{ }}=%}
+{{{triplestash}}}

data/test/fixtures/template_partial.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class TemplatePartial < Mustache

data/test/fixtures/unescaped.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'mustache'
 
 class Unescaped < Mustache

data/test/helper.rb

@@ -1,6 +1,9 @@
-require 'test/unit'
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/test/'
+end
 
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/fixtures'
+require 'minitest/autorun'
 
 Dir[File.dirname(__FILE__) + '/fixtures/*.rb'].each do |f|
   require f