mustache 1.1.1 → 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
 
@@ -85,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 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**
 
@@ -120,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
@@ -146,32 +249,54 @@ Hash:
 
 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, render) {
-          return "<b>" + render(text) + "</b>"
-        }
+      "wrapped": function(text) {
+        return "<b>" + text + "</b>"
       }
     }
 
@@ -198,7 +323,7 @@ Hash:
 
 Output:
 
-    Hi Jon!
+      Hi Jon!
 
 
 ### Inverted Sections
@@ -229,7 +354,7 @@ Hash:
 
 Output:
 
-    No repos :(
+      No repos :(
 
 
 ### Comments
@@ -286,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

data/test/autoloading_test.rb

@@ -7,6 +7,11 @@ class AutoloadingTest < Minitest::Test
     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/override/passenger.conf

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

data/test/mustache_test.rb

@@ -66,6 +66,14 @@ end_complex
                  instance.render
   end
 
+  def test_empty_string_as_section_does_not_render_inverted
+    instance = Mustache.new
+    instance[:value] = ""
+    instance.template = "{{#value}}Value Found{{/value}}{{^value}}Value Not Found{{/value}}"
+
+    assert_equal "Value Found", instance.render
+  end
+
   def test_sassy_single_line_sections
     instance = Mustache.new
     instance[:full_time] = true
@@ -726,14 +734,17 @@ text
     base = Class.new(Mustache)
     tmpl = Class.new(base)
 
-    {:template_path      => File.expand_path('./foo'),
-     :template_extension => 'stache',
+    {:template_extension => 'stache',
      :view_namespace     => TestNamespace,
      :view_path          => './foo'
      }.each do |attr, value|
       base.send("#{attr}=", value)
       assert_equal value, tmpl.send(attr)
     end
+    attr = :template_path
+    value = File.expand_path('./foo')
+    base.send("#{attr}=", value)
+    assert_equal value, tmpl.send(attr).first
   end
 
   def test_hash_default_proc
@@ -841,4 +852,11 @@ template
     klass.template = "Hi {{name}}!"
     assert_equal "Hi Dougal!", klass.new("Dougal").render
   end
+
+  def test_variable_with_at_name
+    instance = Mustache.new
+    instance.template = "\t{{#list@home}}a{{/list@home}}"
+
+    assert_equal "\taa", instance.render(:"list@home" => [1, 2])
+  end
 end

data/test/path_test.rb

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+require_relative 'helper'
+
+class MustacheTest < Minitest::Test
+
+  def test_default_path
+    assert_instance_of Array, Mustache.template_path
+    assert_equal 1, Mustache.template_path.size
+    assert_includes Mustache.template_path, Dir.pwd
+  end
+
+  def test_set_multiple_paths
+    old_path = Mustache.template_path
+    Mustache.template_path = "this#{File::PATH_SEPARATOR}that"
+    assert_instance_of Array, Mustache.template_path
+    assert_equal 2, Mustache.template_path.size
+    Mustache.template_path = old_path
+  end
+
+  def test_override_found
+
+    expected = <<-data
+<VirtualHost *>
+  ServerAdmin override@mustache.com
+  ServerName example.com
+  DocumentRoot /var/www/example.com
+  RailsEnv production
+</VirtualHost>
+data
+    old_path = Mustache.template_path
+    old_extension = Mustache.template_extension
+
+    begin
+      base = File.dirname(__FILE__)
+      Mustache.template_extension = "conf"
+      Mustache.template_path = "#{base}/fixtures/override:#{base}/fixtures"
+      assert_equal expected, Mustache.render(:passenger, :stage => 'production',
+                                                         :server => 'example.com',
+                                                         :deploy_to => '/var/www/example.com')
+      Mustache.template_path = "#{base}/fixtures:#{base}/fixtures/override"
+      refute_equal expected, Mustache.render(:passenger, :stage => 'production',
+                                                         :server => 'example.com',
+                                                         :deploy_to => '/var/www/example.com')
+    ensure
+      Mustache.template_path, Mustache.template_extension = old_path, old_extension
+    end
+  end
+
+end

metadata

@@ -1,116 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: mustache
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.3
 platform: ruby
 authors:
 - Chris Wanstrath
 - Magnus Holm
 - Pieter van de Bruggen
 - Ricardo Mendes
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.3'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.4'
-- !ruby/object:Gem::Dependency
-  name: benchmark-ips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-prof
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: ronn
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
+date: 2026-08-20 00:00:00.000000000 Z
+dependencies: []
 description: |
   Inspired by ctemplate, Mustache is a framework-agnostic way to render
   logic-free views.
@@ -178,6 +79,7 @@ files:
 - test/fixtures/nested_objects.mustache
 - test/fixtures/nested_objects.rb
 - test/fixtures/node.mustache
+- test/fixtures/override/passenger.conf
 - test/fixtures/partial_with_module.mustache
 - test/fixtures/partial_with_module.rb
 - test/fixtures/passenger.conf
@@ -198,13 +100,13 @@ files:
 - test/mustache_test.rb
 - test/parser_test.rb
 - test/partial_test.rb
+- test/path_test.rb
 - test/spec_test.rb
 - test/template_test.rb
 homepage: https://github.com/mustache/mustache
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -219,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Mustache is a framework-agnostic way to render logic-free views.
 test_files: []