Class: Mustache::Template

Inherits:
Object
  • Object
show all
Defined in:
lib/mustache/template.rb

Overview

A Template represents a Mustache template. It compiles and caches a raw string template into something usable.

The idea is this: when handed a Mustache template, convert it into a Ruby string by transforming Mustache tags into interpolated Ruby.

You shouldn't use this class directly, instead:

>> Mustache.render(template, hash)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source) ⇒ Template

Expects a Mustache template as a string along with a template path, which it uses to find partials.



22
23
24
# File 'lib/mustache/template.rb', line 22

def initialize(source)
  @source = source
end

Instance Attribute Details

#sourceObject (readonly)

Returns the value of attribute source



18
19
20
# File 'lib/mustache/template.rb', line 18

def source
  @source
end

Class Method Details

.recursor(toks, section, &block) ⇒ Object

Simple recursive iterator for tokens



59
60
61
62
63
64
65
66
67
68
69
# File 'lib/mustache/template.rb', line 59

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

Instance Method Details

#compile(src = @source) ⇒ Object Also known as: to_s

Does the dirty work of transforming a Mustache template into an interpolation-friendly Ruby string.



48
49
50
# File 'lib/mustache/template.rb', line 48

def compile(src = @source)
  Generator.new.compile(tokens(src))
end

#partialsObject

Returns an array of partials Partials that belong to sections are included, but the section name is not preserved



100
101
102
103
104
105
106
107
108
# File 'lib/mustache/template.rb', line 100

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

#render(context) ⇒ Object

Renders the `@source` Mustache template using the given `context`, which should be a simple hash keyed with symbols.

The first time a template is rendered, this method is overriden and from then on it is “compiled”. Subsequent calls will skip the compilation step and run the Ruby version of the template directly.



33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/mustache/template.rb', line 33

def render(context)
  # Compile our Mustache template into a Ruby string
  compiled = "def render(ctx) #{compile} end"

  # Here we rewrite ourself with the interpolated Ruby version of
  # our Mustache template so subsequent calls are very fast and
  # can skip the compilation stage.
  instance_eval(compiled, __FILE__, __LINE__ - 1)

  # Call the newly rewritten version of #render
  render(context)
end

#sectionsObject

Returns an array of sections Sections that belong to other sections will be of the form `section1.childsection`



87
88
89
90
91
92
93
94
95
96
# File 'lib/mustache/template.rb', line 87

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

#tagsObject

Returns an array of tags Tags that belong to sections will be of the form `section1.tag`



73
74
75
76
77
78
79
80
81
82
83
# File 'lib/mustache/template.rb', line 73

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

#tokens(src = @source) ⇒ Object

Returns an array of tokens for a given template.



54
55
56
# File 'lib/mustache/template.rb', line 54

def tokens(src = @source)
  Parser.new.compile(src)
end