Template::Mustache - Drawing Mustaches on Perl for fun and profit
version 1.0.2
use Template::Mustache; # one-shot rendering print Template::Mustache->render( "Hello {{planet}}", ); # compile and re-use template my $mustache = Template::Mustache->new( template => "Hello {{planet}}", ); print $mustache->render( { planet => "World!" } );
Template::Mustache is an implementation of the fabulous Mustache templating language for Perl.
This version of Template::Mustache conforms to v1.1.3 of the Mustache specs.
Templates can be compiled and rendered on the spot via the use of render called as a class method.
render
print Template::Mustache->render( "Hello {{planet}}", );
If you are considering re-using the same template many times, it's recommended to create a Template::Mustache object instead, which will compile the template only once, and allow to render it with different contexts.
Template::Mustache
my $mustache = Template::Mustache->new( template => "Hello {{planet}}", ); print $mustache->render( { planet => "World!" } );
my $mustache = Template::Mustache->new( template => "Hello {{planet}}", delimiters => [ qw/ ! ! / ], );
Constructor.
A Mustache template.
Instead of template, a template_path can be provided to read the template and the partials from the fielsystem instead. See the method template_path to see how this works.
template
template_path
An optional filesystem path from which to gather partial templates.
An optional arrayref holding the pair of delimiters used by the template. Defaults to {{ }}.
{{ }}
Context to use when rendering if not provided as a parameter to render. Defaults to the object itself.
An optional hashref of partials to assign to the object. See the method partials for more details on its format.
partials
print $mustache->render( $context );
Returns the rendered template, given the optionally provided context. Uses the object's context attribute if not provided.
context attribute
Template::Mustache->render( 'Hello {{ thing }}', { thing => 'World!' } );
If the value is a coderef, it will be invoked to generate the value to be inserted in the template.
Template::Mustache->render( 'it is {{ time }}', { time => sub { scalar localtime } } );
If you want the value returned by the coderef to be interpolated as a Mustache template, a helper function is passed as the last argument to the coderef.
Template::Mustache->render( 'hello {{ place }}', { place => sub { pop->('{{ planet }}') }, planet => 'World', } );
The two previous interpolations work both for {{variable}} definitions, but also for {{#section}}s.
{{variable}}
{{#section}}
print Template::Mustache->render( 'I am {{#obfuscated}}resu{{/obfuscated}}', { obfuscated => sub { pop->('{{'.reverse(shift).'}}') }, user => '({{logged_in_as}})', logged_in_as => 'Sam', } ); # => 'I am (Sam)'
my $object = Something->new( ... ); Template::Mustache->render( 'Hello {{ thing }}', $object ); # thing resolves to $object->thing
Template::Mustache->render( 'Hello {{ . }}', 'World!' );
If no context is provided, it will default to the mustache object itself. Which allows for definining templates as subclasses of Template::Mustache.
package My::Template; use Moo; extends 'Template::Mustache'; sub template { 'Hello {{ planet }}!' } sub planet { 'World' } # later on My::Template->new->render; # => Hello World!
print Template::Mustache->render( $template, $context, $partials ); # equivalent to Template::Mustache->new->( template => $template, partials => $partials )->render( $context );
If invoked as a class method, render takes in the mustache template, and an optional context and set of partials.
To pass in partials without a context, set the context to undef.
undef
print Template::Mustache->render( $template, undef, $partials );
Accessor to the template attribute.
Accessor to the template_path attribute. If this attribute is set, the template will be set to the content of the provided file (if $path is a directory, the file is assumed to be the Mustache.mustache file local to that directory).
$path
Mustache.mustache
Accessor the partials_path attribute. If partials were not given as part of the object construction, when encountered partials will be attempted to be read from that directory. The filename for a partial is its name with .mustache appended to it.
partials_path
.mustache
If template_path is defined, partials_path defaults to it.
Accessor to the context attribute.
context
Accessor to the delimiters attribute.
delimiters
my $tree = $mustache->parsed;
Returns the Template::Mustache::Token::Template object representing the parsed template.
Returns the instance of Template::Mustache::Parser used by the object.
my $mustache = Template::Mustache->new( template => "{{> this }}", partials => { this => 'partials rock!' }, ); print $mustache->render; # => partials rock!
Add partial templates to the object.
Partial values can be strings holding Mustache templates;
A coderef can also be set instead of a hashref. In that case, partial templates will be generated by invoking that sub with the name of the partial as its argument.
my $mustache = Template::Mustache->new( template => "{{> this }} and {{> that }}", partials => sub { "a little bit of " . shift } );
print $Template::Mustache::GRAMMAR;
The Parse::ReqDescent grammar used to parse Mustache templates.
The main, pan-language site for Mustache.
Specs of the Mustache DSL.
Handlebars is another templating language heavily inspired and very similar to Mustache. Text::Handlebars is an implementation of it using Text::Xslate.
Pieter van de Bruggen <pvande@cpan.org>
Yanick Champoux <yanick@cpan.org>
Ricardo Signes <rjbs@cpan.org>
This software is copyright (c) 2011 by Pieter van de Bruggen.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Template::Mustache, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Template::Mustache
CPAN shell
perl -MCPAN -e shell install Template::Mustache
For more information on module installation, please visit the detailed CPAN module installation guide.