Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
6cd14f157a | ||
|
|
da9f15fa17 | ||
|
|
5267ab7538 | ||
|
|
90e2562862 | ||
|
|
e541ac92b7 | ||
|
|
6386e0620e | ||
|
|
cfbf3e8ea3 |
3
Changes
3
Changes
@@ -2,6 +2,9 @@ Revision history for Mojolicious::Plugin::TtRenderer
|
||||
|
||||
{{$NEXT}}
|
||||
|
||||
1.48 2013-08-08 09:13:19 America/New_York
|
||||
- documentation
|
||||
|
||||
1.47 2013-07-26 06:07:35 America/New_York
|
||||
- Template-Toolkit 2.25 compatability
|
||||
|
||||
|
||||
182
README.pod
182
README.pod
@@ -2,45 +2,193 @@
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Mojolicious::Plugin::TtRenderer - Template Renderer Plugin
|
||||
Mojolicious::Plugin::TtRenderer - Template Renderer Plugin for Mojolicious
|
||||
|
||||
=head1 VERSION
|
||||
|
||||
version 1.47
|
||||
version 1.48
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
# Mojolicious
|
||||
$self->plugin('tt_renderer');
|
||||
$self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
|
||||
L<Mojolicious::Lite>:
|
||||
|
||||
# Mojolicious::Lite
|
||||
plugin 'tt_renderer';
|
||||
plugin tt_renderer => {template_options => {FILTERS => [ ... ]}};
|
||||
|
||||
L<Mojolicious>
|
||||
|
||||
$self->plugin('tt_renderer');
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
L<Mojolicious::Plugin::TtRenderer> is a simple loader for
|
||||
L<Mojolicious::Plugin::TtRenderer::Engine>.
|
||||
This plugin is a simple Template Toolkit renderer for L<Mojolicious>.
|
||||
Its defaults are usually reasonable, although for finer grain detail in
|
||||
configuration you may want to use
|
||||
L<Mojolicious::Plugin::TtRenderer::Engine> directly.
|
||||
|
||||
=encoding utf-8
|
||||
|
||||
=head1 METHODS
|
||||
=head1 OPTIONS
|
||||
|
||||
L<Mojolicious::Plugin::TtRenderer> inherits all methods from
|
||||
L<Mojolicious::Plugin> and implements the following new ones.
|
||||
These are the options that can be passed in as arguments to this plugin.
|
||||
|
||||
=head2 C<register>
|
||||
=head2 template_options
|
||||
|
||||
$plugin->register;
|
||||
Configuration hash passed into L<Template>'s constructor, see
|
||||
L<Template Toolkit's configuration summary|Template#CONFIGURATION-SUMMARY>
|
||||
for details. Here is an example using the L<Mojolicious::Lite> form:
|
||||
|
||||
Register renderer in L<Mojolicious> application.
|
||||
plugin 'tt_renderer' => {
|
||||
template_options => {
|
||||
PRE_CHOMP => 1,
|
||||
POST_CHOMP => 1,
|
||||
TRIM => 1,
|
||||
},
|
||||
};
|
||||
|
||||
=head1 EXTRA STASH VARIABLES
|
||||
Here is the same example using the full L<Mojolicious> app form:
|
||||
|
||||
package MyApp;
|
||||
|
||||
use Mojo::Base qw( Mojolicious );
|
||||
|
||||
sub startup {
|
||||
my($self) = @_;
|
||||
|
||||
$self->plugin('tt_renderer' => {
|
||||
template_options => {
|
||||
PRE_CHOMP => 1,
|
||||
POST_CHOMP => 1,
|
||||
TRIM => 1,
|
||||
},
|
||||
}
|
||||
|
||||
...
|
||||
}
|
||||
|
||||
These options will be used if you do not override them:
|
||||
|
||||
=over 4
|
||||
|
||||
=item INCLUDE_PATH
|
||||
|
||||
Generated based on your application's renderer's configuration. It
|
||||
will include all renderer paths, in addition to search files located
|
||||
in the C<__DATA__> section by the usual logic used by L<Mojolicious>.
|
||||
|
||||
=item COMPILE_EXT
|
||||
|
||||
C<.ttc>
|
||||
|
||||
=item UNICODE
|
||||
|
||||
C<1> (true)
|
||||
|
||||
=item ENCODING
|
||||
|
||||
C<utf-87>
|
||||
|
||||
=item CACHE_SIZE
|
||||
|
||||
C<128>
|
||||
|
||||
=item RELATIZE
|
||||
|
||||
C<1> (true)
|
||||
|
||||
=back
|
||||
|
||||
=head2 cache_dir
|
||||
|
||||
Specifies the directory in which compiled template files are
|
||||
written. This:
|
||||
|
||||
plugin 'tt_renderer', { cache_dir => 'some/path' };
|
||||
|
||||
is equivalent to
|
||||
|
||||
plugin 'tt_renderer', { template_options { COMPILE_DIR => 'some/path' } };
|
||||
|
||||
except in the first example relative paths are relative to the L<Mojolicious>
|
||||
app's home directory (C<$app->home>).
|
||||
|
||||
=head1 STASH
|
||||
|
||||
=head2 h
|
||||
|
||||
Helpers are available via the C<h> entry in the stash.
|
||||
|
||||
<a href="[% h.url_for('index') %]">go back to index</a>
|
||||
|
||||
=head2 c
|
||||
|
||||
The current controller instance can be accessed as C<c>.
|
||||
|
||||
[% c.req.headers.host %]
|
||||
I see you are requesting a document from [% c.req.headers.host %].
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
L<Mojolicious::Lite> example:
|
||||
|
||||
use Mojolicious::Lite;
|
||||
|
||||
plugin 'tt_renderer';
|
||||
|
||||
get '/' => sub {
|
||||
my $self = shift;
|
||||
$self->render('index');
|
||||
};
|
||||
|
||||
app->start;
|
||||
|
||||
__DATA__
|
||||
|
||||
@@ index.html.tt
|
||||
[%
|
||||
WRAPPER 'layouts/default.html.tt'
|
||||
title = 'Welcome'
|
||||
%]
|
||||
<p>Welcome to the Mojolicious real-time web framework!</p>
|
||||
<p>Welcome to the TtRenderer plugin!</p>
|
||||
[% END %]
|
||||
|
||||
@@ layouts/default.html.tt
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head><title>[% title %]</title></head>
|
||||
<body>[% content %]</body>
|
||||
</html>
|
||||
|
||||
L<Mojolicious> example:
|
||||
|
||||
package MyApp;
|
||||
use Mojo::Base 'Mojolicious';
|
||||
|
||||
sub startup {
|
||||
my $self = shift;
|
||||
$self->plugin('tt_renderer');
|
||||
my $r = $self->routes;
|
||||
$r->get('/')->to('example#welcome');
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
package MyApp::Example;
|
||||
use Mojo::Base 'Mojolicious::Controller';
|
||||
|
||||
# This action will render a template
|
||||
sub welcome {
|
||||
my $self = shift;
|
||||
|
||||
# Render template "example/welcome.html.tt" with message
|
||||
$self->render(
|
||||
message => 'Looks like your TtRenderer is working!');
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
These are also included with the C<Mojolicious::Plugin::TtRenderer>
|
||||
distribution, including the support files required for the full
|
||||
L<Mojolicious> app example.
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
|
||||
7
dist.ini
7
dist.ini
@@ -5,7 +5,7 @@ license = Perl_5
|
||||
copyright_holder = Ask Bjørn Hansen
|
||||
# copyright_year = 2009
|
||||
|
||||
version = 1.47
|
||||
version = 1.48
|
||||
|
||||
[@Author::Plicease]
|
||||
|
||||
@@ -57,3 +57,8 @@ contributor = spleenjack
|
||||
contributor = Árpád Szász
|
||||
|
||||
[Author::Plicease::Upload]
|
||||
|
||||
[InsertExample]
|
||||
|
||||
[MetaNoIndex]
|
||||
directory = example
|
||||
|
||||
8
example/README
Normal file
8
example/README
Normal file
@@ -0,0 +1,8 @@
|
||||
Included in this directory are two examples of how to use the Template Toolkit
|
||||
Renderer.
|
||||
|
||||
myapp.pl - Mojolicious::Lite example
|
||||
myapp/ - full Mojolicious application example
|
||||
|
||||
They were created as minor modifications of the applications generated
|
||||
using the 'mojo generate' command.
|
||||
28
example/myapp.pl
Normal file
28
example/myapp.pl
Normal file
@@ -0,0 +1,28 @@
|
||||
use Mojolicious::Lite;
|
||||
|
||||
plugin 'tt_renderer';
|
||||
|
||||
get '/' => sub {
|
||||
my $self = shift;
|
||||
$self->render('index');
|
||||
};
|
||||
|
||||
app->start;
|
||||
|
||||
__DATA__
|
||||
|
||||
@@ index.html.tt
|
||||
[%
|
||||
WRAPPER 'layouts/default.html.tt'
|
||||
title = 'Welcome'
|
||||
%]
|
||||
<p>Welcome to the Mojolicious real-time web framework!</p>
|
||||
<p>Welcome to the TtRenderer plugin!</p>
|
||||
[% END %]
|
||||
|
||||
@@ layouts/default.html.tt
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head><title>[% title %]</title></head>
|
||||
<body>[% content %]</body>
|
||||
</html>
|
||||
11
example/myapp/lib/MyApp.pm
Normal file
11
example/myapp/lib/MyApp.pm
Normal file
@@ -0,0 +1,11 @@
|
||||
package MyApp;
|
||||
use Mojo::Base 'Mojolicious';
|
||||
|
||||
sub startup {
|
||||
my $self = shift;
|
||||
$self->plugin('tt_renderer');
|
||||
my $r = $self->routes;
|
||||
$r->get('/')->to('example#welcome');
|
||||
}
|
||||
|
||||
1;
|
||||
13
example/myapp/lib/MyApp/Example.pm
Normal file
13
example/myapp/lib/MyApp/Example.pm
Normal file
@@ -0,0 +1,13 @@
|
||||
package MyApp::Example;
|
||||
use Mojo::Base 'Mojolicious::Controller';
|
||||
|
||||
# This action will render a template
|
||||
sub welcome {
|
||||
my $self = shift;
|
||||
|
||||
# Render template "example/welcome.html.tt" with message
|
||||
$self->render(
|
||||
message => 'Looks like your TtRenderer is working!');
|
||||
}
|
||||
|
||||
1;
|
||||
21
example/myapp/log/development.log
Normal file
21
example/myapp/log/development.log
Normal file
@@ -0,0 +1,21 @@
|
||||
[Thu Aug 8 09:00:16 2013] [info] Listening at "http://*:3000".
|
||||
[Thu Aug 8 09:00:20 2013] [debug] Your secret passphrase needs to be changed!!!
|
||||
[Thu Aug 8 09:00:20 2013] [debug] GET "/".
|
||||
[Thu Aug 8 09:00:20 2013] [debug] Routing to controller "MyApp::Example" and action "welcome".
|
||||
[Thu Aug 8 09:00:20 2013] [error] parse error - example/welcome.html.tt line 8: unexpected end of input
|
||||
[Thu Aug 8 09:00:20 2013] [debug] Template "exception.development.html.ep" not found.
|
||||
[Thu Aug 8 09:00:20 2013] [debug] Template "exception.html.ep" not found.
|
||||
[Thu Aug 8 09:00:20 2013] [debug] Rendering inline template.
|
||||
[Thu Aug 8 09:00:20 2013] [debug] Rendering inline template.
|
||||
[Thu Aug 8 09:00:20 2013] [debug] 500 Internal Server Error (0.061556s, 16.245/s).
|
||||
[Thu Aug 8 09:00:41 2013] [info] Listening at "http://*:3000".
|
||||
[Thu Aug 8 09:00:44 2013] [debug] Your secret passphrase needs to be changed!!!
|
||||
[Thu Aug 8 09:00:44 2013] [debug] GET "/".
|
||||
[Thu Aug 8 09:00:44 2013] [debug] Routing to controller "MyApp::Example" and action "welcome".
|
||||
[Thu Aug 8 09:00:44 2013] [debug] 200 OK (0.032461s, 30.806/s).
|
||||
[Thu Aug 8 09:00:47 2013] [debug] GET "/".
|
||||
[Thu Aug 8 09:00:47 2013] [debug] Routing to controller "MyApp::Example" and action "welcome".
|
||||
[Thu Aug 8 09:00:47 2013] [debug] 200 OK (0.001260s, 793.651/s).
|
||||
[Thu Aug 8 09:00:52 2013] [debug] GET "/".
|
||||
[Thu Aug 8 09:00:52 2013] [debug] Routing to controller "MyApp::Example" and action "welcome".
|
||||
[Thu Aug 8 09:00:52 2013] [debug] 200 OK (0.001683s, 594.177/s).
|
||||
11
example/myapp/public/index.html
Normal file
11
example/myapp/public/index.html
Normal file
@@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Welcome to the Mojolicious real-time web framework!</title>
|
||||
</head>
|
||||
<body>
|
||||
<h2>Welcome to the Mojolicious real-time web framework!</h2>
|
||||
This is the static document "public/index.html",
|
||||
<a href="/">click here</a> to get back to the start.
|
||||
</body>
|
||||
</html>
|
||||
11
example/myapp/script/my_app
Executable file
11
example/myapp/script/my_app
Executable file
@@ -0,0 +1,11 @@
|
||||
#!/usr/bin/env perl
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use FindBin;
|
||||
BEGIN { unshift @INC, "$FindBin::Bin/../lib" }
|
||||
|
||||
# Start command line interface for application
|
||||
require Mojolicious::Commands;
|
||||
Mojolicious::Commands->start_app('MyApp');
|
||||
9
example/myapp/t/basic.t
Normal file
9
example/myapp/t/basic.t
Normal file
@@ -0,0 +1,9 @@
|
||||
use Mojo::Base -strict;
|
||||
|
||||
use Test::More;
|
||||
use Test::Mojo;
|
||||
|
||||
my $t = Test::Mojo->new('MyApp');
|
||||
$t->get_ok('/')->status_is(200)->content_like(qr/Mojolicious/i);
|
||||
|
||||
done_testing();
|
||||
10
example/myapp/templates/example/welcome.html.tt
Normal file
10
example/myapp/templates/example/welcome.html.tt
Normal file
@@ -0,0 +1,10 @@
|
||||
[%
|
||||
WRAPPER 'layouts/default.html.tt'
|
||||
title = 'Welcome'
|
||||
%]
|
||||
<h2>[% $message %]</h2>
|
||||
This page was generated from the template "templates/example/welcome.html.ep"
|
||||
and the layout "templates/layouts/default.html.ep",
|
||||
<a href="[% url_for %]">click here</a> to reload the page or
|
||||
<a href="/index.html">here</a> to move forward to a static page.
|
||||
[% END %]
|
||||
5
example/myapp/templates/layouts/default.html.tt
Normal file
5
example/myapp/templates/layouts/default.html.tt
Normal file
@@ -0,0 +1,5 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head><title>[% title %]</title></head>
|
||||
<body>[% content %]</body>
|
||||
</html>
|
||||
@@ -4,7 +4,7 @@ use strict;
|
||||
use warnings;
|
||||
use v5.10;
|
||||
|
||||
# ABSTRACT: Template Renderer Plugin
|
||||
# ABSTRACT: Template Renderer Plugin for Mojolicious
|
||||
# VERSION
|
||||
|
||||
use base 'Mojolicious::Plugin';
|
||||
@@ -31,35 +31,134 @@ __END__
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
# Mojolicious
|
||||
$self->plugin('tt_renderer');
|
||||
$self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
|
||||
L<Mojolicious::Lite>:
|
||||
|
||||
# Mojolicious::Lite
|
||||
plugin 'tt_renderer';
|
||||
plugin tt_renderer => {template_options => {FILTERS => [ ... ]}};
|
||||
|
||||
L<Mojolicious>
|
||||
|
||||
$self->plugin('tt_renderer');
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
L<Mojolicious::Plugin::TtRenderer> is a simple loader for
|
||||
L<Mojolicious::Plugin::TtRenderer::Engine>.
|
||||
This plugin is a simple Template Toolkit renderer for L<Mojolicious>.
|
||||
Its defaults are usually reasonable, although for finer grain detail in
|
||||
configuration you may want to use
|
||||
L<Mojolicious::Plugin::TtRenderer::Engine> directly.
|
||||
|
||||
=head1 METHODS
|
||||
=head1 OPTIONS
|
||||
|
||||
L<Mojolicious::Plugin::TtRenderer> inherits all methods from
|
||||
L<Mojolicious::Plugin> and implements the following new ones.
|
||||
These are the options that can be passed in as arguments to this plugin.
|
||||
|
||||
=head2 C<register>
|
||||
=head2 template_options
|
||||
|
||||
$plugin->register;
|
||||
Configuration hash passed into L<Template>'s constructor, see
|
||||
L<Template Toolkit's configuration summary|Template#CONFIGURATION-SUMMARY>
|
||||
for details. Here is an example using the L<Mojolicious::Lite> form:
|
||||
|
||||
Register renderer in L<Mojolicious> application.
|
||||
plugin 'tt_renderer' => {
|
||||
template_options => {
|
||||
PRE_CHOMP => 1,
|
||||
POST_CHOMP => 1,
|
||||
TRIM => 1,
|
||||
},
|
||||
};
|
||||
|
||||
=head1 EXTRA STASH VARIABLES
|
||||
Here is the same example using the full L<Mojolicious> app form:
|
||||
|
||||
package MyApp;
|
||||
|
||||
use Mojo::Base qw( Mojolicious );
|
||||
|
||||
sub startup {
|
||||
my($self) = @_;
|
||||
|
||||
$self->plugin('tt_renderer' => {
|
||||
template_options => {
|
||||
PRE_CHOMP => 1,
|
||||
POST_CHOMP => 1,
|
||||
TRIM => 1,
|
||||
},
|
||||
}
|
||||
|
||||
...
|
||||
}
|
||||
|
||||
These options will be used if you do not override them:
|
||||
|
||||
=over 4
|
||||
|
||||
=item INCLUDE_PATH
|
||||
|
||||
Generated based on your application's renderer's configuration. It
|
||||
will include all renderer paths, in addition to search files located
|
||||
in the C<__DATA__> section by the usual logic used by L<Mojolicious>.
|
||||
|
||||
=item COMPILE_EXT
|
||||
|
||||
C<.ttc>
|
||||
|
||||
=item UNICODE
|
||||
|
||||
C<1> (true)
|
||||
|
||||
=item ENCODING
|
||||
|
||||
C<utf-87>
|
||||
|
||||
=item CACHE_SIZE
|
||||
|
||||
C<128>
|
||||
|
||||
=item RELATIZE
|
||||
|
||||
C<1> (true)
|
||||
|
||||
=back
|
||||
|
||||
=head2 cache_dir
|
||||
|
||||
Specifies the directory in which compiled template files are
|
||||
written. This:
|
||||
|
||||
plugin 'tt_renderer', { cache_dir => 'some/path' };
|
||||
|
||||
is equivalent to
|
||||
|
||||
plugin 'tt_renderer', { template_options { COMPILE_DIR => 'some/path' } };
|
||||
|
||||
except in the first example relative paths are relative to the L<Mojolicious>
|
||||
app's home directory (C<$app->home>).
|
||||
|
||||
=head1 STASH
|
||||
|
||||
=head2 h
|
||||
|
||||
Helpers are available via the C<h> entry in the stash.
|
||||
|
||||
<a href="[% h.url_for('index') %]">go back to index</a>
|
||||
|
||||
=head2 c
|
||||
|
||||
The current controller instance can be accessed as C<c>.
|
||||
|
||||
[% c.req.headers.host %]
|
||||
I see you are requesting a document from [% c.req.headers.host %].
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
L<Mojolicious::Lite> example:
|
||||
|
||||
# EXAMPLE: example/myapp.pl
|
||||
|
||||
L<Mojolicious> example:
|
||||
|
||||
# EXAMPLE: example/myapp/lib/MyApp.pm
|
||||
|
||||
# EXAMPLE: example/myapp/lib/MyApp/Example.pm
|
||||
|
||||
These are also included with the C<Mojolicious::Plugin::TtRenderer>
|
||||
distribution, including the support files required for the full
|
||||
L<Mojolicious> app example.
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ use Cwd qw/abs_path/;
|
||||
use Scalar::Util 'weaken';
|
||||
use POSIX ':errno_h';
|
||||
|
||||
# ABSTRACT: Template Toolkit renderer for Mojo
|
||||
# ABSTRACT: Template Toolkit renderer for Mojolicious
|
||||
# VERSION
|
||||
|
||||
__PACKAGE__->attr('tt');
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
use strict;
|
||||
use warnings;
|
||||
use Test::More;
|
||||
|
||||
# Ensure a recent version of Test::Pod::Coverage
|
||||
my $min_tpc = 1.08;
|
||||
eval "use Test::Pod::Coverage $min_tpc";
|
||||
plan skip_all => "Test::Pod::Coverage $min_tpc required for testing POD coverage"
|
||||
if $@;
|
||||
|
||||
# Test::Pod::Coverage doesn't require a minimum Pod::Coverage version,
|
||||
# but older versions don't recognize some common documentation styles
|
||||
my $min_pc = 0.18;
|
||||
eval "use Pod::Coverage $min_pc";
|
||||
plan skip_all => "Pod::Coverage $min_pc required for testing POD coverage"
|
||||
if $@;
|
||||
|
||||
plan tests => 2;
|
||||
|
||||
pod_coverage_ok('Mojolicious::Plugin::TtRenderer');
|
||||
pod_coverage_ok('Mojolicious::Plugin::TtRenderer::Engine', { also_private => [qr{^tt$}] } );
|
||||
Reference in New Issue
Block a user