Compare commits
24 Commits
release/1.
...
v1.49
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9c4e322dec | ||
|
|
48b19a5ab9 | ||
|
|
6cd14f157a | ||
|
|
da9f15fa17 | ||
|
|
5267ab7538 | ||
|
|
90e2562862 | ||
|
|
e541ac92b7 | ||
|
|
6386e0620e | ||
|
|
cfbf3e8ea3 | ||
|
|
8a367fc87d | ||
|
|
ab7117d632 | ||
|
|
b2062785db | ||
|
|
a30b13d6b0 | ||
|
|
002efafefa | ||
|
|
fc6b51b1c1 | ||
|
|
654ff61789 | ||
|
|
d340a27585 | ||
|
|
5d3e3eaf3b | ||
|
|
d63632735f | ||
|
|
90f8df88a9 | ||
|
|
fe963f6511 | ||
|
|
9be62a9c2c | ||
|
|
7f072b88be | ||
|
|
0faf79001b |
16
.gitignore
vendored
16
.gitignore
vendored
@@ -1,14 +1,2 @@
|
||||
blib*
|
||||
Makefile
|
||||
Makefile.old
|
||||
Build
|
||||
_build*
|
||||
pm_to_blib*
|
||||
*.tar.gz
|
||||
.lwpcookies
|
||||
Mojolicious-Plugin-TtRenderer-*
|
||||
MojoX-Renderer-TT-*
|
||||
cover_db
|
||||
*~
|
||||
*.bak
|
||||
.build
|
||||
/Mojolicious-Plugin-TtRenderer-*
|
||||
/.build
|
||||
|
||||
@@ -1,8 +1,11 @@
|
||||
language: perl
|
||||
install:
|
||||
- cpanm Mojolicious Template
|
||||
- cpanm -n Mojolicious
|
||||
- cpanm -n Template
|
||||
script: HARNESS_IS_VERBOSE=1 prove -v -Ilib t
|
||||
perl:
|
||||
- "5.18"
|
||||
- "5.16"
|
||||
- "5.14"
|
||||
- "5.12"
|
||||
- "5.10"
|
||||
|
||||
21
Changes
21
Changes
@@ -2,6 +2,27 @@ Revision history for Mojolicious::Plugin::TtRenderer
|
||||
|
||||
{{$NEXT}}
|
||||
|
||||
1.49 2013-08-08 09:18:54 America/New_York
|
||||
- documentation
|
||||
|
||||
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
|
||||
|
||||
1.46 May 19, 2013
|
||||
- Mojolicious 4.0 compatability
|
||||
|
||||
1.45 April 26, 2013
|
||||
- correctly support app->default->{layout} (GH#37, Fayland Lam)
|
||||
|
||||
1.44 April 13, 2013
|
||||
- promote development changes to production
|
||||
|
||||
1.43_01 April 11, 2013
|
||||
- _template_modified returns value from super class instead of 1 if true (GH#36, Fayland Lam)
|
||||
|
||||
1.43 April 8, 2013
|
||||
- promote development changes
|
||||
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
# Avoid version control files.
|
||||
\bRCS\b
|
||||
\bCVS\b
|
||||
\bSCCS\b
|
||||
,v$
|
||||
\B\.svn\b
|
||||
\B\.git\b
|
||||
\b_darcs\b
|
||||
|
||||
# Avoid Makemaker generated and utility files.
|
||||
\bMANIFEST\.bak
|
||||
\bMYMETA.*
|
||||
\bMakefile$
|
||||
\bblib/
|
||||
\bMakeMaker-\d
|
||||
\bpm_to_blib\.ts$
|
||||
\bpm_to_blib$
|
||||
\bblibdirs\.ts$ # 6.18 through 6.25 generated this
|
||||
|
||||
# Avoid Module::Build generated and utility files.
|
||||
\bBuild$
|
||||
\b_build/
|
||||
|
||||
# Avoid temp and backup files.
|
||||
~$
|
||||
\.old$
|
||||
\#$
|
||||
\b\.#
|
||||
\.bak$
|
||||
|
||||
# Avoid Devel::Cover files.
|
||||
\bcover_db\b
|
||||
|
||||
### DEFAULT MANIFEST.SKIP ENDS HERE ####
|
||||
|
||||
t/tmp/ctpl
|
||||
|
||||
\.DS_Store$
|
||||
\.sw.$
|
||||
(\w+-)*(\w+)-\d\.\d+(?:\.tar\.gz)?$
|
||||
|
||||
\.t\.log$
|
||||
|
||||
\.prove$
|
||||
234
README.pod
234
README.pod
@@ -1,40 +1,194 @@
|
||||
=encoding utf-8
|
||||
=pod
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Mojolicious::Plugin::TtRenderer - Template Renderer Plugin
|
||||
Mojolicious::Plugin::TtRenderer - Template Renderer Plugin for Mojolicious
|
||||
|
||||
=head1 VERSION
|
||||
|
||||
version 1.49
|
||||
|
||||
=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
|
||||
=encoding utf-8
|
||||
|
||||
L<Mojolicious::Plugin::TtRenderer> inherits all methods from
|
||||
L<Mojolicious::Plugin> and implements the following new ones.
|
||||
=head1 OPTIONS
|
||||
|
||||
=head2 C<register>
|
||||
These are the options that can be passed in as arguments to this plugin.
|
||||
|
||||
$plugin->register;
|
||||
=head2 template_options
|
||||
|
||||
Register renderer in L<Mojolicious> application.
|
||||
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:
|
||||
|
||||
=head1 EXTRA STASH VARIABLES
|
||||
plugin 'tt_renderer' => {
|
||||
template_options => {
|
||||
PRE_CHOMP => 1,
|
||||
POST_CHOMP => 1,
|
||||
TRIM => 1,
|
||||
},
|
||||
};
|
||||
|
||||
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-E<gt>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
|
||||
|
||||
@@ -45,48 +199,42 @@ L<http://mojolicious.org>.
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Current maintainer: Graham Ollis C<< <plicease@cpan.org> >>
|
||||
original author: Ask Bjørn Hansen
|
||||
|
||||
Original author: Ask Bjørn Hansen, C<< <ask at develooper.com> >>
|
||||
current maintainer: Graham Ollis <plicease@cpan.org>
|
||||
|
||||
=head1 BUGS
|
||||
contributors:
|
||||
|
||||
Please report any bugs or feature requests to the project's github issue tracker
|
||||
L<https://github.com/abh/mojox-renderer-tt/issues?state=open>.
|
||||
vti
|
||||
|
||||
=head1 SUPPORT
|
||||
Marcus Ramberg
|
||||
|
||||
You can find documentation for this module with the perldoc command.
|
||||
Matthias Bethke
|
||||
|
||||
perldoc Mojolicious::Plugin::TtRenderer
|
||||
Htbaa
|
||||
|
||||
You can also look for information at:
|
||||
Magnus Holm
|
||||
|
||||
=over 4
|
||||
Maxim Vuets
|
||||
|
||||
=item * git repository
|
||||
Rafael Kitover
|
||||
|
||||
L<http://git.develooper.com/?p=MojoX-Renderer-TT.git;a=summary>,
|
||||
L<git://git.develooper.com/MojoX-Renderer-TT.git>
|
||||
giftnuss
|
||||
|
||||
L<http://github.com/abh/mojox-renderer-tt/>
|
||||
Cosimo Streppone
|
||||
|
||||
=item * CPAN Ratings
|
||||
Fayland Lam
|
||||
|
||||
L<http://cpanratings.perl.org/d/MojoX-Renderer-TT>
|
||||
Jason Crowther
|
||||
|
||||
=item * Search CPAN
|
||||
spleenjack
|
||||
|
||||
L<http://search.cpan.org/dist/MojoX-Renderer-TT/>
|
||||
Árpád Szász
|
||||
|
||||
=back
|
||||
=head1 COPYRIGHT AND LICENSE
|
||||
|
||||
=head1 COPYRIGHT & LICENSE
|
||||
This software is copyright (c) 2013 by Ask Bjørn Hansen.
|
||||
|
||||
Copyright 2008-2010 Ask Bjørn Hansen, all rights reserved.
|
||||
|
||||
Copyright 2012 Graham Ollis.
|
||||
|
||||
This program is free software; you can redistribute it and/or modify it
|
||||
under the same terms as Perl itself.
|
||||
This is free software; you can redistribute it and/or modify it under
|
||||
the same terms as the Perl 5 programming language system itself.
|
||||
|
||||
|
||||
49
dist.ini
49
dist.ini
@@ -5,7 +5,9 @@ license = Perl_5
|
||||
copyright_holder = Ask Bjørn Hansen
|
||||
# copyright_year = 2009
|
||||
|
||||
version = 1.43
|
||||
version = 1.49
|
||||
|
||||
[@Author::Plicease]
|
||||
|
||||
[Prereqs]
|
||||
Mojolicious = 3.33
|
||||
@@ -14,31 +16,12 @@ Template = 2.18
|
||||
[Prereqs / TestRequires ]
|
||||
Test::More = 0
|
||||
|
||||
[NextRelease]
|
||||
format = %-7v %{MMMM d, yyyy}d
|
||||
|
||||
[@Git]
|
||||
tag_format = release/%v
|
||||
# push_to = all
|
||||
|
||||
[@Filter]
|
||||
bundle = @Basic
|
||||
remove = Readme
|
||||
remove = Manifest
|
||||
|
||||
[MetaResources]
|
||||
bugtracker.web = https://github.com/plicease/mojox-renderer-tt/issues
|
||||
repository.web = http://github.com/plicease/mojox-renderer-tt
|
||||
repository.url = git://github.com/plicease/mojox-renderer-tt.git
|
||||
repository.type = git
|
||||
|
||||
[Homepage]
|
||||
|
||||
;[BumpVersionFromGit]
|
||||
;version_regexp = ^release/(.*)
|
||||
|
||||
[PkgVersion]
|
||||
|
||||
[CheckChangeLog]
|
||||
[Test::Compile]
|
||||
[HasVersionTests]
|
||||
@@ -54,8 +37,28 @@ type = pod
|
||||
filename = README.pod
|
||||
location = root
|
||||
|
||||
[Manifest]
|
||||
|
||||
[MinimumPerl]
|
||||
|
||||
[MetaJSON]
|
||||
[Author::Plicease::Thanks]
|
||||
current = Graham Ollis <plicease@cpan.org>
|
||||
original = Ask Bjørn Hansen
|
||||
contributor = vti
|
||||
contributor = Marcus Ramberg
|
||||
contributor = Matthias Bethke
|
||||
contributor = Htbaa
|
||||
contributor = Magnus Holm
|
||||
contributor = Maxim Vuets
|
||||
contributor = Rafael Kitover
|
||||
contributor = giftnuss
|
||||
contributor = Cosimo Streppone
|
||||
contributor = Fayland Lam
|
||||
contributor = Jason Crowther
|
||||
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,6 +4,9 @@ use strict;
|
||||
use warnings;
|
||||
use v5.10;
|
||||
|
||||
# ABSTRACT: Template Renderer Plugin for Mojolicious
|
||||
# VERSION
|
||||
|
||||
use base 'Mojolicious::Plugin';
|
||||
|
||||
use Mojolicious::Plugin::TtRenderer::Engine;
|
||||
@@ -26,41 +29,136 @@ __END__
|
||||
|
||||
=encoding utf-8
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Mojolicious::Plugin::TtRenderer - Template Renderer Plugin
|
||||
|
||||
=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-E<gt>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
|
||||
|
||||
@@ -69,51 +167,4 @@ L<Mojolicious>,
|
||||
L<Mojolicious::Guides>,
|
||||
L<http://mojolicious.org>.
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Current maintainer: Graham Ollis C<< <plicease@cpan.org> >>
|
||||
|
||||
Original author: Ask Bjørn Hansen, C<< <ask at develooper.com> >>
|
||||
|
||||
=head1 BUGS
|
||||
|
||||
Please report any bugs or feature requests to the project's github issue tracker
|
||||
L<https://github.com/abh/mojox-renderer-tt/issues?state=open>.
|
||||
|
||||
=head1 SUPPORT
|
||||
|
||||
You can find documentation for this module with the perldoc command.
|
||||
|
||||
perldoc Mojolicious::Plugin::TtRenderer
|
||||
|
||||
You can also look for information at:
|
||||
|
||||
=over 4
|
||||
|
||||
=item * git repository
|
||||
|
||||
L<http://git.develooper.com/?p=MojoX-Renderer-TT.git;a=summary>,
|
||||
L<git://git.develooper.com/MojoX-Renderer-TT.git>
|
||||
|
||||
L<http://github.com/abh/mojox-renderer-tt/>
|
||||
|
||||
=item * CPAN Ratings
|
||||
|
||||
L<http://cpanratings.perl.org/d/MojoX-Renderer-TT>
|
||||
|
||||
=item * Search CPAN
|
||||
|
||||
L<http://search.cpan.org/dist/MojoX-Renderer-TT/>
|
||||
|
||||
=back
|
||||
|
||||
=head1 COPYRIGHT & LICENSE
|
||||
|
||||
Copyright 2008-2010 Ask Bjørn Hansen, all rights reserved.
|
||||
|
||||
Copyright 2012 Graham Ollis.
|
||||
|
||||
This program is free software; you can redistribute it and/or modify it
|
||||
under the same terms as Perl itself.
|
||||
|
||||
=cut
|
||||
|
||||
@@ -3,9 +3,7 @@ package Mojolicious::Plugin::TtRenderer::Engine;
|
||||
use warnings;
|
||||
use strict;
|
||||
use v5.10;
|
||||
|
||||
use base 'Mojo::Base';
|
||||
|
||||
use Carp ();
|
||||
use File::Spec ();
|
||||
use Mojo::ByteStream 'b';
|
||||
@@ -14,6 +12,9 @@ use Cwd qw/abs_path/;
|
||||
use Scalar::Util 'weaken';
|
||||
use POSIX ':errno_h';
|
||||
|
||||
# ABSTRACT: Template Toolkit renderer for Mojolicious
|
||||
# VERSION
|
||||
|
||||
__PACKAGE__->attr('tt');
|
||||
|
||||
sub build {
|
||||
@@ -81,12 +82,16 @@ sub _render {
|
||||
$t = 'inline' if defined $inline;
|
||||
return unless $t;
|
||||
|
||||
|
||||
my $helper = Mojolicious::Plugin::TtRenderer::Helper->new(ctx => $c);
|
||||
|
||||
# Purge previous result
|
||||
$$output = '';
|
||||
|
||||
# fixes for t/lite_app_with_default_layouts.t
|
||||
unless ($c->stash->{layout}) {
|
||||
$c->stash->{content} ||= $c->stash->{'mojo.content'}->{content};
|
||||
}
|
||||
|
||||
my @params = ({%{$c->stash}, c => $c, h => $helper}, $output, {binmode => ':utf8'});
|
||||
my $provider = $self->tt->{SERVICE}->{CONTEXT}->{LOAD_TEMPLATES}->[0];
|
||||
$provider->options($options);
|
||||
@@ -177,8 +182,7 @@ sub options { @_ > 1 ? $_[0]->{options} = $_[1] : $_[0]->{options} }
|
||||
|
||||
sub _template_modified {
|
||||
my($self, $template) = @_;
|
||||
return 1 if $self->SUPER::_template_modified($template);
|
||||
return $template =~ /^templates(?:\/|\\)/;
|
||||
$self->SUPER::_template_modified($template) || $template =~ /^templates(?:\/|\\)/;
|
||||
}
|
||||
|
||||
sub _template_content {
|
||||
@@ -222,10 +226,6 @@ __END__
|
||||
|
||||
=encoding utf-8
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Mojolicious::Plugin::TtRenderer::Engine - Template Toolkit renderer for Mojo
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
Add the handler:
|
||||
@@ -252,7 +252,7 @@ Add the handler:
|
||||
$self->renderer->add_handler( tt => $tt );
|
||||
}
|
||||
|
||||
Template parameter are taken from C< $c->stash >.
|
||||
Template parameter are taken from C<$c-E<gt>stash>.
|
||||
|
||||
=head1 RENDERING
|
||||
|
||||
@@ -311,51 +311,4 @@ L<Mojolicious>,
|
||||
L<Mojolicious::Guides>,
|
||||
L<http://mojolicious.org>.
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Current maintainer: Graham Ollis C<< <plicease@cpan.org> >>
|
||||
|
||||
Original author: Ask Bjørn Hansen, C<< <ask at develooper.com> >>
|
||||
|
||||
=head1 BUGS
|
||||
|
||||
Please report any bugs or feature requests to the project's github issue tracker
|
||||
L<https://github.com/abh/mojox-renderer-tt/issues?state=open>.
|
||||
|
||||
=head1 SUPPORT
|
||||
|
||||
You can find documentation for this module with the perldoc command.
|
||||
|
||||
perldoc Mojolicious::Plugin::TtRenderer::Engine
|
||||
|
||||
You can also look for information at:
|
||||
|
||||
=over 4
|
||||
|
||||
=item * git repository
|
||||
|
||||
L<http://git.develooper.com/?p=MojoX-Renderer-TT.git;a=summary>,
|
||||
L<git://git.develooper.com/MojoX-Renderer-TT.git>
|
||||
|
||||
L<http://github.com/abh/mojox-renderer-tt/>
|
||||
|
||||
=item * CPAN Ratings
|
||||
|
||||
L<http://cpanratings.perl.org/d/MojoX-Renderer-TT>
|
||||
|
||||
=item * Search CPAN
|
||||
|
||||
L<http://search.cpan.org/dist/MojoX-Renderer-TT/>
|
||||
|
||||
=back
|
||||
|
||||
=head1 COPYRIGHT & LICENSE
|
||||
|
||||
Copyright 2008-2010 Ask Bjørn Hansen, all rights reserved.
|
||||
|
||||
Copyright 2012 Graham Ollis.
|
||||
|
||||
This program is free software; you can redistribute it and/or modify it
|
||||
under the same terms as Perl itself.
|
||||
|
||||
=cut
|
||||
|
||||
@@ -7,13 +7,22 @@ use warnings;
|
||||
|
||||
use utf8;
|
||||
|
||||
use Test::More tests => 3;
|
||||
use Test::More;
|
||||
|
||||
use Mojolicious::Lite;
|
||||
use Test::Mojo;
|
||||
use File::Temp qw( tempdir );
|
||||
use File::Spec;
|
||||
|
||||
if($Mojolicious::VERSION >= 4.0)
|
||||
{
|
||||
plan skip_all => 'test broken in mojo 4.0';
|
||||
}
|
||||
else
|
||||
{
|
||||
plan tests => 3;
|
||||
}
|
||||
|
||||
# Send log to tmp file so that it doesn't clutter up the screen.
|
||||
app->log->level('fatal');
|
||||
app->log->path(do {
|
||||
|
||||
37
t/lite_app_with_default_layouts.t
Normal file
37
t/lite_app_with_default_layouts.t
Normal file
@@ -0,0 +1,37 @@
|
||||
#!/usr/bin/env perl
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
BEGIN { $ENV{MOJO_MODE}='testing'; };
|
||||
|
||||
use utf8;
|
||||
|
||||
use Test::More tests => 3;
|
||||
|
||||
use Mojolicious::Lite;
|
||||
use Mojo::ByteStream 'b';
|
||||
use Test::Mojo;
|
||||
use File::Temp qw( tempdir );
|
||||
|
||||
# Silence
|
||||
app->log->level('fatal');
|
||||
|
||||
use_ok('Mojolicious::Plugin::TtRenderer::Engine');
|
||||
|
||||
plugin 'tt_renderer' => {template_options => {PRE_CHOMP => 1, POST_CHOMP => 1, TRIM => 1, COMPILE_DIR => tempdir( CLEANUP => 1 ) }};
|
||||
app->defaults(layout => 'wrapper');
|
||||
|
||||
get '/test' => 'test';
|
||||
|
||||
my $t = Test::Mojo->new;
|
||||
|
||||
$t->get_ok('/test')->content_is("WS-hello-EW");
|
||||
|
||||
__DATA__
|
||||
|
||||
@@ test.html.tt
|
||||
hello
|
||||
|
||||
@@ layouts/wrapper.html.tt
|
||||
WS-[%- content -%]-EW
|
||||
@@ -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$}] } );
|
||||
@@ -51,7 +51,7 @@ my $t = Test::Mojo->new;
|
||||
# Simple TT template
|
||||
$t->get_ok('/')->status_is(200)
|
||||
->content_like(qr/test123456/);
|
||||
$t->get_ok('/blow')->status_is(500)->content_like(qr/file error - doesnotexist\.tt: No such file or directory/);
|
||||
$t->get_ok('/blow')->status_is(500)->content_like(qr/file error - (templates\/)?doesnotexist\.tt: (No such file or directory|not found)/);
|
||||
|
||||
if(eval q{ use Devel::Cycle; 1 })
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user