Day 21: A Little Christmas Template Cooking
The Advent Calendar has shown you many great ways to use Mojolicious, and since you already have Mojo installed you can use it for things besides web processing. Today's recipe uses The templating rendering engine for something other than web responses.
First, process some string templates. Here's an example lifted from the Mojo::Template, using the squiggly heredoc syntax released in v5.26:
use Mojo::Template;
my $mt = Mojo::Template->new;
say $mt->render(<<~'EOF');
% use Time::Piece;
<div>
% my $now = localtime;
Time: <%= $now->hms %>
</div>
EOF
The lines with leading percent sings are Perl code. One of those lines loads a module, Time::Piece, and the other creates the variable $now
. The <%= %>
insert values inline. You can figure out the other template syntax on your own; it's all in the module documentation.
You can invert that so that the source of the values comes from outside of the template. Sometimes this is preferable to having too much logic in the presentation layer:
use v5.26;
use Mojo::Template;
my $mt = Mojo::Template->new;
use Time::Piece;
my $now = localtime;
say $mt->render(<<~'EOF', $now->hms );
% my $time = shift;
<div>
Time: <%= $time %>
</div>
EOF
As seen above, by default, arguments are passed in to the template positionally, which is why the shift
is there. I like to describe variables by name rather than their position. The vars
attribute allows you to pass a hash to the template; the hash keys become variable names in the template itself:
use v5.26;
use Mojo::Template;
my $mt = Mojo::Template->new->vars(1);
use Time::Piece;
my $now = localtime;
say $mt->render(<<~'EOF', { time => $now->hms } );
<div>
Time: <%= $time %>
</div>
EOF
It's just as easy to take that template from a file (or many files). This is the sort of thing I used to do this with Template Toolkit, a very fine and capable module that's as good as it ever was. But, I'm already using Mojo for quite a few things and it already has a templating engine. I can reduce my dependency count and focus on one templating language.
Typically, Mojo templates use the extension .ep. Loop through all of the files that you specify on the command line and cook the ones that have that extension:
use v5.14;
use Mojo::Template;
use Mojo::File;
my $mt = Mojo::Template->new->vars(1);
use Time::Piece;
my $now = localtime;
foreach my $file ( @ARGV ) {
Mojo::File
->new( $file =~ s/\.ep\z//r )
->spurt(
$mt->render_file( $file, { time => $now->hms } )
);
}
Now that you know everything about Mojo templates, you can process a directory full of them to start a new project:
use v5.14;
use File::Find qw(find);
use Time::Piece;
use Mojo::File;
use Mojo::Template;
my $mt = Mojo::Template->new->vars(1);
my $wanted = sub {
my $file = Mojo::File->new( $File::Find::name )->to_abs;
return unless /\.ep\z/;
Mojo::File
->new( $file =~ s/\.ep\z//r )
->spurt(
$mt->render_file(
$file,
{ time => localtime->hms }
)
);
};
find( { no_chdir => 1, wanted => $wanted }, @ARGV );
That's about it. Your $wanted
subroutine can be more sophisticated to put the cooked files in a different directories, skip directories, and many other things. You don't even need to use File::Find; I like it because it comes with Perl, I'm used to it, and I don't need to construct the entire list of files at once. Some clever use of Mojo::File and Mojo::Collection could surely do the trick too. The rest of the complexity comes from the particular situation where you want to apply this.
Banner image: Peanut Butter Kisses cookies by m01229, CC BY 2.0.
brian d foy
brian d foy is the author of Mastering Perl and Learning Perl 6, and the co-author of Learning Perl, Intermediate Perl, Programming Perl, and Effective Perl Programming.