mustache 0.99.5 → 0.99.6

data/lib/mustache/parser.rb

@@ -44,6 +44,34 @@ EOF
       end
     end
 
+    # The sigil types which are valid after an opening `{{`
+    VALID_TYPES = [ '#', '^', '/', '=', '!', '<', '>', '&', '{' ]
+
+    def self.valid_types
+      @valid_types ||= Regexp.new(VALID_TYPES.map { |t| Regexp.escape(t) }.join('|') )
+    end
+
+    # Add a supported sigil type (with optional aliases) to the Parser.
+    #
+    # Requires a block, which will be sent the following parameters:
+    #
+    # * content - The raw content of the tag
+    # * fetch- A mustache context fetch expression for the content
+    # * padding - Indentation whitespace from the currently-parsed line
+    # * pre_match_position - Location of the scanner before a match was made
+    #
+    # The provided block will be evaluated against the current instance of
+    # Parser, and may append to the Parser's @result as needed.
+    def self.add_type(*types, &block)
+      types = types.map(&:to_s)
+      type, *aliases = types
+      method_name = "scan_tag_#{type}".to_sym
+      define_method(method_name, &block)
+      aliases.each { |a| alias_method "scan_tag_#{a}", method_name }
+      types.each { |t| VALID_TYPES << t unless VALID_TYPES.include?(t) }
+      @valid_types = nil
+    end
+
     # After these types of tags, all whitespace until the end of the line will
     # be skipped if they are the first (and only) non-whitespace content on
     # the line.
@@ -124,7 +152,7 @@ EOF
       # Since {{= rewrites ctag, we store the ctag which should be used
       # when parsing this specific tag.
       current_ctag = self.ctag
-      type = @scanner.scan(/#|\^|\/|=|!|<|>|&|\{/)
+      type = @scanner.scan(self.class.valid_types)
       @scanner.skip(/\s*/)
 
       # ANY_CONTENT tags allow any character inside of them, while
@@ -143,41 +171,16 @@ EOF
       prev = @result
 
       # Based on the sigil, do what needs to be done.
-      case type
-      when '#'
-        block = [:multi]
-        @result << [:mustache, :section, fetch, offset, block]
-        @sections << [content, position, @result]
-        @result = block
-      when '^'
-        block = [:multi]
-        @result << [:mustache, :inverted_section, fetch, offset, block]
-        @sections << [content, position, @result]
-        @result = block
-      when '/'
-        section, pos, result = @sections.pop
-        raw = @scanner.pre_match[pos[3]...pre_match_position] + padding
-        (@result = result).last << raw << [self.otag, self.ctag]
-
-        if section.nil?
-          error "Closing unopened #{content.inspect}"
-        elsif section != content
-          error "Unclosed section #{section.inspect}", pos
-        end
-      when '!'
-        # ignore comments
-      when '='
-        self.otag, self.ctag = content.split(' ', 2)
-      when '>', '<'
-        @result << [:mustache, :partial, content, offset, padding]
-      when '{', '&'
-        # The closing } in unescaped tags is just a hack for
-        # aesthetics.
-        type = "}" if type == "{"
-        @result << [:mustache, :utag, fetch, offset]
+      if type
+        # Method#call proves much faster than using send
+        method("scan_tag_#{type}").
+          call(content, fetch, padding, pre_match_position)
       else
         @result << [:mustache, :etag, fetch, offset]
       end
+      # The closing } in unescaped tags is just a hack for
+      # aesthetics.
+      type = "}" if type == "{"
 
       # Skip whitespace and any balancing sigils after the content
       # inside this tag.
@@ -263,5 +266,52 @@ EOF
     def error(message, pos = position)
       raise SyntaxError.new(message, pos)
     end
+
+    # These methods are called in `scan_tags`. Because they contain nonstandard
+    # characters in their method names, they are defined using define_method.
+
+    define_method 'scan_tag_#' do |content, fetch, padding, pre_match_position|
+      block = [:multi]
+      @result << [:mustache, :section, fetch, offset, block]
+      @sections << [content, position, @result]
+      @result = block
+    end
+
+    define_method 'scan_tag_^' do |content, fetch, padding, pre_match_position|
+      block = [:multi]
+      @result << [:mustache, :inverted_section, fetch, offset, block]
+      @sections << [content, position, @result]
+      @result = block
+    end
+
+    define_method 'scan_tag_/' do |content, fetch, padding, pre_match_position|
+      section, pos, result = @sections.pop
+      raw = @scanner.pre_match[pos[3]...pre_match_position] + padding
+      (@result = result).last << raw << [self.otag, self.ctag]
+
+      if section.nil?
+        error "Closing unopened #{content.inspect}"
+      elsif section != content
+        error "Unclosed section #{section.inspect}", pos
+      end
+    end
+
+    define_method 'scan_tag_!' do |content, fetch, padding, pre_match_position|
+    end
+
+    define_method 'scan_tag_=' do |content, fetch, padding, pre_match_position|
+      self.otag, self.ctag = content.split(' ', 2)
+    end
+
+    define_method 'scan_tag_>' do |content, fetch, padding, pre_match_position|
+      @result << [:mustache, :partial, content, offset, padding]
+    end
+    alias_method :'scan_tag_<', :'scan_tag_>'
+
+    define_method 'scan_tag_{' do |content, fetch, padding, pre_match_position|
+      @result << [:mustache, :utag, fetch, offset]
+    end
+    alias_method :'scan_tag_&', :'scan_tag_{'
+
   end
 end

data/lib/mustache/sinatra.rb

@@ -138,7 +138,7 @@ class Mustache
         options[:namespace] ||= self.class
 
         unless options[:namespace].to_s.include? 'Views'
-          options[:namespace] = options[:namespace].const_get(:Views)
+          options[:namespace] = options[:namespace].const_get(:Views) rescue Object
         end
 
         factory = Class.new(Mustache) do

data/lib/mustache/template.rb

@@ -54,5 +54,57 @@ class Mustache
     def tokens(src = @source)
       Parser.new.compile(src)
     end
+
+    # Simple recursive iterator for tokens
+    def self.recursor(toks, section, &block)
+      toks.map do |token|
+        next unless token.is_a? Array
+        if token[0] == :mustache
+          new_token, new_section, result, stop = yield(token, section)
+          [ result ] + ( stop ? [] : recursor(new_token, new_section, &block))
+        else
+          recursor(token, section, &block)
+        end
+      end
+    end
+
+    # Returns an array of tags
+    # Tags that belong to sections will be of the form `section1.tag`
+    def tags
+      Template.recursor(tokens, []) do |token, section|
+        if [:etag, :utag].include?(token[1])
+          [ new_token=nil, new_section=nil, result=((section + [token[2][2][0]]).join('.')), stop=true ]
+        elsif [:section, :inverted_section].include?(token[1]) 
+          [ new_token=token[4], new_section=(section + [token[2][2][0]]), result=nil, stop=false ]
+        else
+          [ new_token=token, new_section=section, result=nil, stop=false ]
+        end
+      end.flatten.reject(&:nil?).uniq
+    end
+
+    # Returns an array of sections
+    # Sections that belong to other sections will be of the form `section1.childsection`
+    def sections
+      Template.recursor(tokens, []) do |token, section|
+        if [:section, :inverted_section].include?(token[1])
+          new_section=(section + [token[2][2][0]])
+          [ new_token=token[4], new_section, result=new_section.join('.'), stop=false ]
+        else
+          [ new_token=token, new_section=section, result=nil, stop=false ]
+        end
+      end.flatten.reject(&:nil?).uniq
+    end
+
+    # Returns an array of partials
+    # Partials that belong to sections are included, but the section name is not preserved
+    def partials
+      Template.recursor(tokens, []) do |token, section|
+        if token[1] == :partial
+          [ new_token=token, new_section=section, result=token[2], stop=true ]
+        else
+          [ new_token=token, new_section=section, result=nil, stop=false ]
+        end
+      end.flatten.reject(&:nil?).uniq
+    end
   end
 end

data/lib/mustache/version.rb

@@ -1,3 +1,3 @@
 class Mustache
-  Version = VERSION = '0.99.5'
+  Version = VERSION = '0.99.6'
 end

data/man/mustache.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "MUSTACHE" "1" "August 2011" "DEFUNKT" "Mustache Manual"
+.TH "MUSTACHE" "1" "February 2014" "DEFUNKT" "Mustache Manual"
 .
 .SH "NAME"
 \fBmustache\fR \- Mustache processor
@@ -23,7 +23,7 @@ Mustache is a logic\-less templating system for HTML, config files, anything\.
 The \fBmustache\fR command processes a Mustache template preceded by YAML frontmatter from standard input and prints one or more documents to standard output\.
 .
 .P
-YAML frontmatter beings with \fB\-\-\-\fR on a single line, followed by YAML, ending with another \fB\-\-\-\fR on a single line, e\.g\.
+YAML frontmatter begins with \fB\-\-\-\fR on a single line, followed by YAML, ending with another \fB\-\-\-\fR on a single line, e\.g\.
 .
 .IP "" 4
 .
@@ -124,7 +124,7 @@ Print the compiled Ruby version of a given template\. This is the code that is a
 .
 .TP
 \fB\-t\fR, \fB\-\-tokens\fR
-Print the tokenized form of a given Mustache template\. This can be used to understand how Mustache parses a template\. The tokens are handed to a generator which compiles them into a Ruby string\. Syntax errors and confused tags, therefor, can probably be identified by examining the tokens produced\.
+Print the tokenized form of a given Mustache template\. This can be used to understand how Mustache parses a template\. The tokens are handed to a generator which compiles them into a Ruby string\. Syntax errors and confused tags, therefore, can probably be identified by examining the tokens produced\.
 .
 .SH "INSTALLATION"
 If you have RubyGems installed:
@@ -162,4 +162,4 @@ Mustache is Copyright (C) 2009 Chris Wanstrath
 Original CTemplate by Google
 .
 .SH "SEE ALSO"
-mustache(5), gem(1), \fIhttp://mustache\.github\.com/\fR
+mustache(5), gem(1), \fIhttp://mustache\.github\.io/\fR

data/man/mustache.1.html

@@ -90,7 +90,7 @@ anything.</p>
 frontmatter from standard input and prints one or more documents to
 standard output.</p>
 
-<p>YAML frontmatter beings with <code>---</code> on a single line, followed by YAML,
+<p>YAML frontmatter begins with <code>---</code> on a single line, followed by YAML,
 ending with another <code>---</code> on a single line, e.g.</p>
 
 <pre><code>---
@@ -102,7 +102,7 @@ names: [ {name: chris}, {name: mark}, {name: scott} ]
 should work fine.</p>
 
 <p>After the frontmatter should come any valid Mustache template. See
-<a href="mustache.5.ron.html" class="man-ref">mustache<span class="s">(5)</span></a> for an overview of Mustache templates.</p>
+<a class="man-ref" href="mustache.5.ron.html">mustache<span class="s">(5)</span></a> for an overview of Mustache templates.</p>
 
 <p>For example:</p>
 
@@ -165,7 +165,7 @@ Mustache's internals.</p></dd>
 <dt><code>-t</code>, <code>--tokens</code></dt><dd><p>Print the tokenized form of a given Mustache template. This can be
 used to understand how Mustache parses a template. The tokens are
 handed to a generator which compiles them into a Ruby
-string. Syntax errors and confused tags, therefor, can probably be
+string. Syntax errors and confused tags, therefore, can probably be
 identified by examining the tokens produced.</p></dd>
 </dl>
 
@@ -198,13 +198,13 @@ data
 
 <h2 id="SEE-ALSO">SEE ALSO</h2>
 
-<p><a href="mustache.5.ron.html" class="man-ref">mustache<span class="s">(5)</span></a>, <span class="man-ref">gem<span class="s">(1)</span></span>,
-<a href="http://mustache.github.com/" data-bare-link="true">http://mustache.github.com/</a></p>
+<p><a class="man-ref" href="mustache.5.ron.html">mustache<span class="s">(5)</span></a>, <span class="man-ref">gem<span class="s">(1)</span></span>,
+<a href="http://mustache.github.io/" data-bare-link="true">http://mustache.github.io/</a></p>
 
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'>DEFUNKT</li>
-    <li class='tc'>August 2011</li>
+    <li class='tc'>February 2014</li>
     <li class='tr'>mustache(1)</li>
   </ol>
 

data/man/mustache.1.ron

@@ -17,7 +17,7 @@ The `mustache` command processes a Mustache template preceded by YAML
 frontmatter from standard input and prints one or more documents to
 standard output.
 
-YAML frontmatter beings with `---` on a single line, followed by YAML,
+YAML frontmatter begins with `---` on a single line, followed by YAML,
 ending with another `---` on a single line, e.g.
 
     ---
@@ -90,7 +90,7 @@ YAML frontmatter you provide. It can do a few other things, however.
     Print the tokenized form of a given Mustache template. This can be
     used to understand how Mustache parses a template. The tokens are
     handed to a generator which compiles them into a Ruby
-    string. Syntax errors and confused tags, therefor, can probably be
+    string. Syntax errors and confused tags, therefore, can probably be
     identified by examining the tokens produced.
 
 
@@ -124,4 +124,4 @@ Original CTemplate by Google
 ## SEE ALSO
 
 mustache(5), gem(1),
-<http://mustache.github.com/>
+<http://mustache.github.io/>

data/man/mustache.5

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "MUSTACHE" "5" "August 2011" "DEFUNKT" "Mustache Manual"
+.TH "MUSTACHE" "5" "April 2014" "DEFUNKT" "Mustache Manual"
 .
 .SH "NAME"
 \fBmustache\fR \- Logic\-less templates\.
@@ -66,7 +66,7 @@ We call it "logic\-less" because there are no if statements, else clauses, or fo
 Tags are indicated by the double mustaches\. \fB{{person}}\fR is a tag, as is \fB{{#person}}\fR\. In both examples, we\'d refer to \fBperson\fR as the key or tag key\. Let\'s talk about the different types of tags\.
 .
 .SS "Variables"
-The most basic tag type is the variable\. A \fB{{name}}\fR tag in a basic template will try to find the \fBname\fR key in the current context\. If there is no \fBname\fR key, nothing will be rendered\.
+The most basic tag type is the variable\. A \fB{{name}}\fR tag in a basic template will try to find the \fBname\fR key in the current context\. If there is no \fBname\fR key, the parent contexts will be checked recursively\. If the top context is reached and the \fBname\fR key is still not found, nothing will be rendered\.
 .
 .P
 All variables are HTML escaped by default\. If you want to return unescaped HTML, use the triple mustache: \fB{{{name}}}\fR\.
@@ -148,9 +148,9 @@ Template:
 .nf
 
 Shown\.
-{{#nothin}}
+{{#person}}
   Never shown!
-{{/nothin}}
+{{/person}}
 .
 .fi
 .
@@ -164,7 +164,7 @@ Hash:
 .nf
 
 {
-  "person": true,
+  "person": false
 }
 .
 .fi
@@ -219,7 +219,7 @@ Hash:
   "repo": [
     { "name": "resque" },
     { "name": "hub" },
-    { "name": "rip" },
+    { "name": "rip" }
   ]
 }
 .
@@ -273,7 +273,7 @@ Hash:
 {
   "name": "Willy",
   "wrapped": function() {
-    return function(text) {
+    return function(text, render) {
       return "<b>" + render(text) + "</b>"
     }
   }
@@ -536,4 +536,4 @@ Mustache is Copyright (C) 2009 Chris Wanstrath
 Original CTemplate by Google
 .
 .SH "SEE ALSO"
-mustache(1), \fIhttp://mustache\.github\.com/\fR
+mustache(1), \fIhttp://mustache\.github\.io/\fR

data/man/mustache.5.html

@@ -121,7 +121,9 @@ or tag key. Let's talk about the different types of tags.</p>
 
 <p>The most basic tag type is the variable. A <code>{{name}}</code> tag in a basic
 template will try to find the <code>name</code> key in the current context. If
-there is no <code>name</code> key, nothing will be rendered.</p>
+there is no <code>name</code> key, the parent contexts will be checked recursively.
+If the top context is reached and the <code>name</code> key is still not found,
+nothing will be rendered.</p>
 
 <p>All variables are HTML escaped by default. If you want to return
 unescaped HTML, use the triple mustache: <code>{{{name}}}</code>.</p>
@@ -175,15 +177,15 @@ list, the HTML between the pound and slash will not be displayed.</p>
 <p>Template:</p>
 
 <pre><code>Shown.
-{{#nothin}}
+{{#person}}
   Never shown!
-{{/nothin}}
+{{/person}}
 </code></pre>
 
 <p>Hash:</p>
 
 <pre><code>{
-  "person": true,
+  "person": false
 }
 </code></pre>
 
@@ -215,7 +217,7 @@ loop over collections.</p>
   "repo": [
     { "name": "resque" },
     { "name": "hub" },
-    { "name": "rip" },
+    { "name": "rip" }
   ]
 }
 </code></pre>
@@ -247,7 +249,7 @@ filters or caching.</p>
 <pre><code>{
   "name": "Willy",
   "wrapped": function() {
-    return function(text) {
+    return function(text, render) {
       return "&lt;b&gt;" + render(text) + "&lt;/b&gt;"
     }
   }
@@ -407,13 +409,13 @@ markup."</p>
 
 <h2 id="SEE-ALSO">SEE ALSO</h2>
 
-<p><a href="mustache.1.ron.html" class="man-ref">mustache<span class="s">(1)</span></a>,
-<a href="http://mustache.github.com/" data-bare-link="true">http://mustache.github.com/</a></p>
+<p><a class="man-ref" href="mustache.1.ron.html">mustache<span class="s">(1)</span></a>,
+<a href="http://mustache.github.io/" data-bare-link="true">http://mustache.github.io/</a></p>
 
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'>DEFUNKT</li>
-    <li class='tc'>August 2011</li>
+    <li class='tc'>April 2014</li>
     <li class='tr'>mustache(5)</li>
   </ol>
 

data/man/mustache.5.ron

@@ -50,7 +50,9 @@ 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}}}`.
@@ -102,14 +104,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:
@@ -138,7 +140,7 @@ Hash:
       "repo": [
         { "name": "resque" },
         { "name": "hub" },
-        { "name": "rip" },
+        { "name": "rip" }
       ]
     }
 
@@ -167,7 +169,7 @@ Hash:
     {
       "name": "Willy",
       "wrapped": function() {
-        return function(text) {
+        return function(text, render) {
           return "<b>" + render(text) + "</b>"
         }
       }
@@ -321,4 +323,4 @@ Original CTemplate by Google
 ## SEE ALSO
 
 mustache(1),
-<http://mustache.github.com/>
+<http://mustache.github.io/>