Compare commits

...

73 Commits

Author SHA1 Message Date
Graham Ollis
6cd14f157a v1.48
- documentation
2013-08-08 09:13:32 -04:00
Graham Ollis
da9f15fa17 you know what? Don't really need that. 2013-08-08 09:13:07 -04:00
Graham Ollis
5267ab7538 more doco improvements 2013-08-08 09:11:04 -04:00
Graham Ollis
90e2562862 tweak example 2013-08-08 09:05:58 -04:00
Graham Ollis
e541ac92b7 include a full app example 2013-08-08 09:03:48 -04:00
Graham Ollis
6386e0620e doco 2013-08-08 08:51:56 -04:00
Graham Ollis
cfbf3e8ea3 use mojolicious' full name in abstract 2013-08-07 09:52:27 -04:00
Graham Ollis
8a367fc87d v1.47
- Template-Toolkit 2.25 compatability
2013-07-26 06:07:47 -04:00
Graham Ollis
ab7117d632 change regex to fix test 2013-07-26 05:58:36 -04:00
Graham Ollis
b2062785db Merge branch 'master' of github.com:plicease/mojox-renderer-tt 2013-07-10 07:35:13 -04:00
Graham Ollis
a30b13d6b0 doco 2013-07-10 07:35:01 -04:00
Graham Ollis
002efafefa test against perl 5.18 2013-07-06 09:28:45 -04:00
Graham Ollis
fc6b51b1c1 rm pre-dzil cruft 2013-06-25 12:00:03 -04:00
Graham Ollis
654ff61789 v1.46
- Mojolicious 4.0 compatability
2013-05-19 11:13:27 -04:00
Graham Ollis
d340a27585 travis update 2013-05-19 11:10:25 -04:00
Graham Ollis
5d3e3eaf3b mojo 4.0 compat 2013-05-19 11:07:01 -04:00
Graham Ollis
d63632735f test against 5.16 2013-05-07 20:26:06 -04:00
Graham Ollis
90f8df88a9 v1.45
- correctly support app->default->{layout} (GH#37, Fayland Lam)
2013-04-26 13:38:19 -04:00
Fayland Lam
fe963f6511 fix for defaults layout 2013-04-26 13:35:46 -04:00
Graham Ollis
9be62a9c2c v1.44
- promote development changes to production
2013-04-13 17:49:27 -04:00
Graham Ollis
7f072b88be v1.43_01
- _template_modified returns value from super class instead of 1 if true (GH#36, Fayland Lam)
2013-04-11 15:43:42 -04:00
Graham Ollis
0faf79001b fix for GH#36 2013-04-11 15:42:20 -04:00
Graham Ollis
f22529d42e v1.43
- promote development changes
2013-04-08 14:03:08 -04:00
Graham Ollis
abcd8c3293 v1.42_04
- Updated meta for new github repo location
2013-04-06 20:30:57 -04:00
Graham Ollis
7ba4f4bf5c v1.42_03
- Allow custom relative paths for cache_dir (GH#35, Jason Crowther)
2013-03-22 14:27:32 -04:00
Graham Ollis
593d9d1640 Merge pull request #35 from tophopstop/master
Bug with setting cache_dir to relative path
2013-03-22 11:23:04 -07:00
Jason Crowther
5e8ade81e4 bug fix, remove unintentional hard coded cache path. 2013-03-22 12:13:08 -04:00
Graham Ollis
70231b1bce v1.42_02
- only create COMPILE_DIR based on UID if the user doesn't specify COMPILE_DIR
2013-02-26 18:17:49 -05:00
Graham Ollis
77c6298a99 only create temp directory if it doesn't exist yet 2013-02-26 18:16:12 -05:00
Graham Ollis
01e6647cbf v1.42_01
- set COMPILE_DIR based on UID so that multiple users can use TtRenderer with default config
2013-02-24 23:13:00 -05:00
Graham Ollis
22eba8d3c5 include UID in default COMPILE_DIR 2013-02-24 23:12:05 -05:00
Graham Ollis
f68a82f774 v1.42
- fix for test on solaris
2013-02-24 22:59:45 -05:00
Graham Ollis
cb908430e5 fix it again. 2013-02-24 22:59:10 -05:00
Graham Ollis
7cd976ea79 v1.41
- Additional testing diagnostics
2013-02-23 03:06:21 -05:00
Graham Ollis
1708622c49 testing diagnostics 2013-02-23 03:05:25 -05:00
Graham Ollis
380cea8aa2 v1.40
- Added diagnostic for IO loop implementation in testing
2013-02-20 13:42:06 -05:00
Graham Ollis
9217818ad2 diagnostic for IO loop used during testing. 2013-02-20 13:41:16 -05:00
Graham Ollis
02fce2bfdd simplify 2013-01-28 11:51:38 -05:00
Graham Ollis
a7da6f3292 v1.39
- Documentation updates.
2013-01-28 09:28:26 -05:00
Graham Ollis
c736f2ed2d doco 2013-01-28 09:28:07 -05:00
Graham Ollis
7bccefd01b more descriptive test names 2013-01-28 09:20:17 -05:00
Graham Ollis
cccf6078c1 update changes 2013-01-28 09:15:13 -05:00
Graham Ollis
408cba6c35 fix but where DATA templates are not being rendered 2013-01-27 22:48:55 -05:00
Graham Ollis
c1afea55a9 add some tests for default templates.
the second one fails, this needs to be fixed soon.
2013-01-27 22:14:04 -05:00
Graham Ollis
88041ec8b0 fix cpantesters failures based on permissions 2013-01-12 09:05:35 -05:00
Graham Ollis
1fe6401667 update Changes 2013-01-09 14:19:22 -05:00
Graham Ollis
c00f8934de rm not_found, as it is no longer used. 2013-01-09 14:14:44 -05:00
Graham Ollis
d4902f8bf0 Merge pull request #34 from rkitover/master
fix reporting not found templates
2013-01-09 11:08:03 -08:00
Rafael Kitover
4225658dbc report not finding a template correctly
TtRenderer was dying with a 'not found' error when a template was not
found, instead of returning 0, which was interfering with things like
the error screen.

Use $provider->fetch to find templates and return 0 when a template is
not found.
2013-01-09 13:17:11 -05:00
Rafael Kitover
d45efa5405 failing test for not returning not found correctly 2013-01-09 13:13:53 -05:00
Graham Ollis
f3e65cedce v1.35 2012-12-30 10:33:14 -05:00
Graham Ollis
906c68db34 doco 2012-12-30 10:33:01 -05:00
Graham Ollis
c7012a1be0 doco typo 2012-12-29 10:27:32 -05:00
Graham Ollis
5e7728270f v1.34 2012-12-29 10:23:19 -05:00
Graham Ollis
7618cacaa4 fix hang in t/deep_recursion.t on *BSD 2012-12-27 14:51:34 -05:00
Graham Ollis
80340f9950 update changes 2012-12-27 13:37:31 -05:00
Graham Ollis
fb396704bf Merge branch 'master' of github.com:abh/mojox-renderer-tt 2012-12-27 13:22:20 -05:00
Graham Ollis
1d9ea654e9 use temp COMPILE_DIR to avoid test failures
where the default COMPILE_DIR already exists and is owned
by another user or not writable for some other reason by
the testing user.
2012-12-27 13:21:23 -05:00
Graham Ollis
3ec7366d6e better diagnostics
use filename and linenumber in eval for better diagnostic in test
2012-12-26 21:56:21 -05:00
Graham Ollis
a5e72c7526 rm commented code 2012-12-26 21:26:57 -05:00
Graham Ollis
6146b1f2f5 set locale "C" in tests
This ensures that the error string is what we expect it to be
2012-12-26 21:22:07 -05:00
Graham Ollis
5116c191f3 update Changes 2012-12-22 15:14:11 -05:00
Graham Ollis
5828f878d8 don't rely on English locale in test 2012-12-22 15:10:59 -05:00
Graham Ollis
f4beaf9864 use non-capturing for performance 2012-12-19 12:33:19 -05:00
Graham Ollis
ce9e1b955e load test to test loading of all .pm files 2012-12-18 11:02:18 -05:00
Graham Ollis
37ee2ee753 support multiple renderer paths 2012-12-18 11:00:47 -05:00
Graham Ollis
cdc31b07be update changes 2012-10-31 11:19:28 -04:00
Graham Ollis
57b9c39b15 specify a minumum perl version. 2012-10-11 11:18:37 -04:00
Graham Ollis
194a9219e9 fix cpanm warning. 2012-10-02 11:42:17 -04:00
Graham Ollis
5505c5d82a utf-8 for perldoc 2012-10-02 11:34:42 -04:00
Graham Ollis
daceb5876f documentation updates. 2012-10-02 11:33:07 -04:00
Graham Ollis
54d13555ef Merge branch 'master' of github.com:abh/mojox-renderer-tt 2012-08-31 08:18:19 -04:00
Graham Ollis
d6d98cc533 fix for win32 2012-08-31 08:18:01 -04:00
34 changed files with 944 additions and 245 deletions

16
.gitignore vendored
View File

@@ -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

View File

@@ -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"

89
Changes
View File

@@ -2,6 +2,95 @@ 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
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.42_04 April 6, 2013
- Updated meta for new github repo location
1.42_03 March 22, 2013
- Allow custom relative paths for cache_dir (GH#35, Jason Crowther)
1.42_02 February 26, 2013
- only create COMPILE_DIR based on UID if the user doesn't specify COMPILE_DIR
1.42_01 February 24, 2013
- set COMPILE_DIR based on UID so that multiple users can use TtRenderer with default config
1.42 February 24, 2013
- fix for test on solaris
1.41 February 23, 2013
- Additional testing diagnostics
1.40 February 20, 2013
- Added diagnostic for IO loop implementation in testing
1.39 January 28, 2013
- Documentation updates.
1.38 January 27, 2013
- fixed but where DATA templates were not being rendered with empty renderer path
1.37 January 12, 2013
- fix default_template2.t to use temp directory for COMPILE_DIR
1.36 January 9, 2013
- Use $provider->fetch to find templates (GH#34)
1.35 December 30, 2012
- Documentation fix
1.34 December 29, 2012
- Include META.json in distribution.
1.33 December 27, 2012
- Fix hang in t/deep_recursion.t on *BSD
1.32 December 27, 2012
- silenced a few annoying warnings during test
- use temp directory for COMPILE_DIR in tests to avoid failures if the
default compile directory already exists and is owned by someone else.
1.31 December 26, 2012
- Set locale "C" in tests that rely on it
1.30 December 22, 2012
- Don't rely on English locale in the test t/tt_plugin_lite_app.t
1.29 December 18, 2012
- support multiple renderer paths
1.28 October 11, 2012
- specify minimum perl version
1.27 October 2, 2012
- documentation fixes and updates.
1.26 August 31, 2012
- Windows compatability with Cwd::abs_path
1.25 August 25, 2012
- Return 0 on not found, die on error (GH#30)
1.24 August 23, 2012
- Compatibility with Mojolicious 3.33+

View File

@@ -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$

240
README.pod Normal file
View File

@@ -0,0 +1,240 @@
=pod
=head1 NAME
Mojolicious::Plugin::TtRenderer - Template Renderer Plugin for Mojolicious
=head1 VERSION
version 1.48
=head1 SYNOPSIS
L<Mojolicious::Lite>:
plugin 'tt_renderer';
L<Mojolicious>
$self->plugin('tt_renderer');
=head1 DESCRIPTION
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 OPTIONS
These are the options that can be passed in as arguments to this plugin.
=head2 template_options
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:
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->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>.
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
L<Mojolicious::Plugin::TtRenderer::Engine>,
L<Mojolicious>,
L<Mojolicious::Guides>,
L<http://mojolicious.org>.
=head1 AUTHOR
original author: Ask Bjørn Hansen
current maintainer: Graham Ollis <plicease@cpan.org>
contributors:
vti
Marcus Ramberg
Matthias Bethke
Htbaa
Magnus Holm
Maxim Vuets
Rafael Kitover
giftnuss
Cosimo Streppone
Fayland Lam
Jason Crowther
spleenjack
Árpád Szász
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by Ask Bjørn Hansen.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

View File

@@ -5,6 +5,10 @@ license = Perl_5
copyright_holder = Ask Bjørn Hansen
# copyright_year = 2009
version = 1.48
[@Author::Plicease]
[Prereqs]
Mojolicious = 3.33
Template = 2.18
@@ -12,35 +16,49 @@ Template = 2.18
[Prereqs / TestRequires ]
Test::More = 0
[@Git]
tag_format = release/%v
# push_to = all
[@Filter]
bundle = @Basic
remove = Readme
remove = Manifest
[MetaResources]
bugtracker.web = https://github.com/abh/mojox-renderer-tt/issues
repository.web = http://github.com/abh/mojox-renderer-tt
repository.url = git://github.com/abh/mojox-renderer-tt.git
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]
[MetaTests]
[ReadmeFromPod]
[Manifest]
[NextRelease]
format = %-7v %{MMMM d, yyyy}d
[ReadmeAnyFromPod]
type = text
filename = README
location = build
[ReadmeAnyFromPod / ReadMePodInRoot]
type = pod
filename = README.pod
location = root
[MinimumPerl]
[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
View 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
View 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>

View 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;

View 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;

View 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).

View 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
View 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
View 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();

View 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 %]

View File

@@ -0,0 +1,5 @@
<!DOCTYPE html>
<html>
<head><title>[% title %]</title></head>
<body>[% content %]</body>
</html>

View File

@@ -2,6 +2,10 @@ package Mojolicious::Plugin::TtRenderer;
use strict;
use warnings;
use v5.10;
# ABSTRACT: Template Renderer Plugin for Mojolicious
# VERSION
use base 'Mojolicious::Plugin';
@@ -18,48 +22,149 @@ sub register {
$app->renderer->add_handler(tt => $tt);
}
local ($Mojolicious::Plugin::TtRenderer::VERSION) = ('devel') unless defined $Mojolicious::Plugin::TtRenderer::VERSION;
$Mojolicious::Plugin::TtRenderer::VERSION //= ('devel');
1;
__END__
=head1 NAME
Mojolicious::Plugin::TtRenderer - Template Renderer Plugin
=encoding utf-8
=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 => [ ... ]}};
plugin 'tt_renderer';
L<Mojolicious>
$self->plugin('tt_renderer');
=head1 DESCRIPTION
L<Mojolicous::Plugin::TtRenderer> is a simple loader for L<MojoX::Renderer::TT>.
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
L<Mojolicious::Plugin::TtRenderer::Engine>, L<Mojolicious>, L<Mojolicious::Guides>, L<http://mojolicious.org>.
L<Mojolicious::Plugin::TtRenderer::Engine>,
L<Mojolicious>,
L<Mojolicious::Guides>,
L<http://mojolicious.org>.
=cut

View File

@@ -3,15 +3,17 @@ 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';
use Template ();
use Cwd qw/abs_path/;
use Scalar::Util 'weaken';
use POSIX ':errno_h';
# ABSTRACT: Template Toolkit renderer for Mojolicious
# VERSION
__PACKAGE__->attr('tt');
@@ -33,27 +35,32 @@ sub _init {
if($dir=$args{cache_dir}) {
if($app && substr($dir,0,1) ne '/') {
$dir=$app->home->rel_dir('tmp/ctpl');
$dir=$app->home->rel_dir($dir);
}
}
# TODO
# take and process options :-)
my @renderer_paths = $app ? map { abs_path($_) } grep { -d $_ } @{ $app->renderer->paths } : ();
push @renderer_paths, 'templates';
my %config = (
( $app
? (INCLUDE_PATH => (join ":", map { abs_path($_) } @{$app->renderer->paths}))
: ()
),
COMPILE_EXT => '.ttc',
COMPILE_DIR => ($dir || abs_path(File::Spec->tmpdir)),
UNICODE => 1,
ENCODING => 'utf-8',
CACHE_SIZE => 128,
RELATIVE => 1,
INCLUDE_PATH => \@renderer_paths,
COMPILE_EXT => '.ttc',
UNICODE => 1,
ENCODING => 'utf-8',
CACHE_SIZE => 128,
RELATIVE => 1,
%{$args{template_options} || {}},
);
$config{COMPILE_DIR} //= $dir || do {
my $tmpdir = File::Spec->catdir(File::Spec->tmpdir, "ttr$<");
mkdir $tmpdir unless -d $tmpdir;
$tmpdir;
};
$config{LOAD_TEMPLATES} =
[Mojolicious::Plugin::TtRenderer::Provider->new(%config, renderer => $app->renderer)]
unless $config{LOAD_TEMPLATES};
@@ -75,21 +82,40 @@ 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);
$provider->ctx($c);
$provider->not_found(0);
my $ok = $self->tt->process(defined $inline ? \$inline : $t, @params);
my $ok = do {
if (defined $inline) {
$self->tt->process(\$inline, @params);
}
else {
my @ret = $provider->fetch($t);
return 0 if $provider->not_found;
if (not defined $ret[1]) {
$self->tt->process($ret[0], @params);
}
elsif (not defined $ret[0]) { # not found
return 0;
}
else { # error
return 0 if $! == ENOENT && (not ref $ret[0]); # not found when not blessed exception
die $ret[0];
}
}
};
# Error
die $self->tt->error unless $ok;
@@ -153,9 +179,11 @@ sub new {
sub renderer { @_ > 1 ? $_[0]->{renderer} = $_[1] : $_[0]->{renderer} }
sub ctx { @_ > 1 ? $_[0]->{ctx} = $_[1] : $_[0]->{ctx} }
sub options { @_ > 1 ? $_[0]->{options} = $_[1] : $_[0]->{options} }
sub not_found { @_ > 1 ? $_[0]->{not_found} = $_[1] : $_[0]->{not_found} }
sub _template_modified {1}
sub _template_modified {
my($self, $template) = @_;
$self->SUPER::_template_modified($template) || $template =~ /^templates(?:\/|\\)/;
}
sub _template_content {
my $self = shift;
@@ -177,7 +205,6 @@ sub _template_content {
# Try DATA section
if(defined $options) {
$data = $self->renderer->get_data_template($options);
$self->not_found(1) unless defined $data;
} else {
my $loader = Mojo::Loader->new;
foreach my $class (@{ $self->renderer->classes }) {
@@ -199,35 +226,31 @@ __END__
=encoding utf-8
=head1 NAME
Mojolicious::Plugin::TtRenderer::Engine - Template Toolkit renderer for Mojo
=head1 SYNOPSIS
Add the handler:
sub startup {
...
sub startup {
...
# Via mojolicious plugin
$self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
# Or manually
use Mojolicious::Plugin::TtRenderer::Engine;
my $tt = Mojolicious::Plugin::TtRenderer::Engine->build(
mojo => $self,
template_options => {
PROCESS => 'tpl/wrapper',
FILTERS => [ ... ],
UNICODE => 1,
ENCODING => 'UTF-8',
}
);
# Via mojolicious plugin
$self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
# Or manually
use Mojolicious::Plugin::TtRenderer::Engine;
my $tt = Mojolicious::Plugin::TtRenderer::Engine->build(
mojo => $self,
template_options => {
PROCESS => 'tpl/wrapper',
FILTERS => [ ... ],
UNICODE => 1,
ENCODING => 'UTF-8',
}
);
$self->renderer->add_handler( tt => $tt );
}
$self->renderer->add_handler( tt => $tt );
}
Template parameter are taken from C< $c->stash >.
@@ -237,20 +260,20 @@ The template file for C<"example/welcome"> would be C<"templates/welcome.html.tt
When template file is not available rendering from C<__DATA__> is attempted.
__DATA__
__DATA__
@@ welcome.html.tt
Welcome, [% user.name %]!
@@ welcome.html.tt
Welcome, [% user.name %]!
Inline template is also supported:
$self->render(inline => '[% 1 + 1 %]', handler => 'tt');
$self->render(inline => '[% 1 + 1 %]', handler => 'tt');
=head1 HELPERS
Helpers are exported automatically under C<h> namespace.
[% h.url_for('index') %]
[% h.url_for('index') %]
=head1 METHODS
@@ -268,7 +291,11 @@ object. When used the INCLUDE_PATH will be set to
=item template_options
A hash reference of options that are passed to Template->new().
A hash reference of options that are passed to Template->new(). Note that if you
specify an C<INCLUDE_PATH> through this option it will remove the DATA section
templates from your path. A better way to specify an C<INCLUDE_PATH> if you also
want to use DATA section templates it by manipulting the L<Mojolicious::Renderer>
path.
=item cache_dir
@@ -277,63 +304,11 @@ templates. Will default to a temp-dir if not set.
=back
=head1 AUTHOR
=head1 SEE ALSO
Ask Bjørn Hansen, C<< <ask at develooper.com> >>
=head1 TODO
* Better support non-Mojolicious frameworks
* Better way to pass parameters to the templates? (stash)
* More sophisticated default search path?
=head1 BUGS
Please report any bugs or feature requests to C<bug-mojox-renderer-tt at rt.cpan.org>,
or through the web interface at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MojoX-Renderer-TT>. I will be
notified, and then you'll automatically be notified of progress on your bug as I
make changes.
=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 * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=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 ACKNOWLEDGEMENTS
=head1 COPYRIGHT & LICENSE
Copyright 2008-2010 Ask Bjørn Hansen, all rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
L<Mojolicious::Plugin::TtRenderer::Engine>,
L<Mojolicious>,
L<Mojolicious::Guides>,
L<http://mojolicious.org>.
=cut

View File

@@ -1,9 +1,9 @@
#!perl
use Test::More tests => 1;
use Test::More tests => 2;
BEGIN {
use_ok( 'Mojolicious::Plugin::TtRenderer' );
use_ok( 'Mojolicious::Plugin::TtRenderer::Engine' );
}
diag( "Testing Mojolicious::Plugin::TtRenderer::Engine $Mojolicious::Plugin::TtRenderer::Engine::VERSION, Perl $], $^X" );

11
t/01-ioloop.t Normal file
View File

@@ -0,0 +1,11 @@
use strict;
use warnings;
use Test::More tests => 1;
use Mojo::IOLoop;
my $loop = eval { Mojo::IOLoop->singleton };
diag $@ if $@;
ok $loop;
diag ref eval { $loop->reactor };
diag $@ if $@;

View File

@@ -7,15 +7,29 @@ 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;
# Silence
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 {
File::Spec->catfile(tempdir(CLEANUP => 1), 'mojo.log');
});
plugin 'tt_renderer';
plugin 'tt_renderer' => {template_options => { COMPILE_DIR => tempdir( CLEANUP => 1 ) }};
get '/exception' => sub { die };

View File

@@ -0,0 +1,52 @@
use strict;
use warnings;
use Test::More tests => 9;
use Test::Mojo;
use File::Temp qw( tempdir );
use FindBin '$Bin';
use Mojolicious::Lite;
use Mojolicious::Plugin::TtRenderer::Engine ();
my $tt = Mojolicious::Plugin::TtRenderer::Engine->build(
mojo => app,
template_options => {
UNICODE => 1,
ENCODING => 'UTF-8',
#INCLUDE_PATH => "$Bin/templates",
COMPILE_DIR => tempdir( CLEANUP => 1 ),
}
);
app->renderer->add_handler(tt => $tt);
app->renderer->default_handler('tt');
get '/' => sub {
die 'foo';
};
get '/bar' => 'bar';
get '/grimlock' => 'grimlock';
my $t = Test::Mojo->new;
$t->get_ok('/')
->status_is(500)
->content_like(qr{foo});
$t->get_ok('/bar')
->status_is(200)
->content_like(qr{bar});
$t->get_ok('/grimlock')
->status_is(200)
->content_like(qr{King});
__DATA__
@@ index.html.tt
anything
@@ bar.html.tt
sometimes, the bar, he eats you...

View File

@@ -1,7 +1,8 @@
use strict;
use warnings;
use Test::More tests => 3;
use Test::More tests => 9;
use Test::Mojo;
use File::Temp qw( tempdir );
use Mojolicious::Lite;
@@ -10,8 +11,8 @@ app->plugin(
tt_renderer => {
template_options => {
# These options are specific to TT
INCLUDE_PATH => 'templates',
COMPILE_DIR => 'templates_c',
#INCLUDE_PATH => 'templates',
COMPILE_DIR => tempdir( CLEANUP => 1 ),
COMPILE_EXT => '.ttc',
# ... anything else to be passed on to TT should go here
},
@@ -24,13 +25,29 @@ get '/' => sub {
die 'foo';
};
get '/bar' => 'bar';
get '/grimlock' => 'grimlock';
my $t = Test::Mojo->new;
$t->get_ok('/')
->status_is(500)
->content_like(qr{foo});
$t->get_ok('/bar')
->status_is(200)
->content_like(qr{bar});
$t->get_ok('/grimlock')
->status_is(200)
->content_like(qr{King});
__DATA__
@@ index.html.tt
anything
@@ bar.html.tt
sometimes, the bar, he eats you...

View File

@@ -0,0 +1,40 @@
use strict;
use warnings;
use File::Temp qw( tempdir );
BEGIN { $ENV{MOJO_HOME} = tempdir( CLEANUP => 1) }
use Test::More tests => 6;
use Test::Mojo;
use Mojolicious::Lite;
plugin 'tt_renderer' => { template_options => { COMPILE_DIR => tempdir( CLEANUP => 1 ) } };
app->renderer->default_handler('tt');
get '/' => sub {
die 'foo';
};
get '/bar' => 'bar';
my $t = Test::Mojo->new;
$t->get_ok('/')
->status_is(500)
->content_like(qr{foo});
$t->app->log->on(message => sub {
my($log, $level, @lines) = @_;
diag @lines if $level eq 'error';
});
$t->get_ok('/bar')
->status_is(200)
->content_like(qr{sometimes, the bar,});
__DATA__
@@ index.html.tt
anything
@@ bar.html.tt
sometimes, the bar, he eats you...

View File

@@ -12,13 +12,14 @@ use Test::More tests => 39;
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}};
plugin 'tt_renderer' => {template_options => {PRE_CHOMP => 1, POST_CHOMP => 1, TRIM => 1, COMPILE_DIR => tempdir( CLEANUP => 1 ) }};
get '/exception' => 'error';

View 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

31
t/multiple_paths.t Normal file
View File

@@ -0,0 +1,31 @@
#!/usr/bin/env perl
use strict;
use warnings;
BEGIN { $ENV{MOJO_MODE}='testing'; };
use utf8;
use Test::More tests => 6;
use Mojolicious::Lite;
use Test::Mojo;
use File::Temp qw( tempdir );
# Silence
app->log->level('fatal');
my @paths = map { app->home->rel_dir($_) } "templates/multiple_first", "templates/multiple_second";
app->renderer->paths([@paths]);
plugin 'TtRenderer' => {template_options => { COMPILE_DIR => tempdir( CLEANUP => 1 ) }};
get '/first' => 'first';
get '/second' => 'second';
my $t = Test::Mojo->new;
$t->get_ok('/first')->status_is(200)->content_like(qr/First/);
$t->get_ok('/second')->status_is(200)->content_like(qr/Second/);

View File

@@ -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$}] } );

View File

@@ -0,0 +1 @@
Me Grimlock King!

View File

@@ -0,0 +1 @@
First

View File

@@ -0,0 +1 @@
Second

View File

@@ -0,0 +1 @@
Second

View File

@@ -5,12 +5,22 @@
use strict;
use warnings;
use File::Temp;
BEGIN {
unless($^O eq 'MSWin32') {
eval '# line '. __LINE__ . ' "' . __FILE__ . qq("\n). q{
use POSIX qw( setlocale LC_ALL );
setlocale(LC_ALL, 'C');
};
warn $@ if $@;
}
}
use File::Temp qw( tempdir );
use Mojo::IOLoop;
use Test::More;
# Use a clean temporary directory
BEGIN { $ENV{MOJO_TMPDIR} ||= File::Temp::tempdir }
BEGIN { $ENV{MOJO_TMPDIR} ||= tempdir( CLEANUP => 1) }
# Make sure sockets are working
plan skip_all => 'working sockets required for this test!'
@@ -24,7 +34,7 @@ use Mojolicious::Lite;
use Test::Mojo;
# POD renderer plugin
plugin 'tt_renderer';
plugin 'tt_renderer' => {template_options => { COMPILE_DIR => tempdir( CLEANUP => 1 ) }};
# Silence
app->log->level('error');
@@ -41,10 +51,12 @@ 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 })
{
# ignore warnings coming from Devel::Cycle
local $SIG{__WARN__} = sub { };
Devel::Cycle::find_cycle(app, sub {
my $arg = shift;
# Template::Provider (from which M::P::T::Provider inherits) has some cycles which are freed manaully by
@@ -56,4 +68,4 @@ if(eval q{ use Devel::Cycle; 1 })
fail('Cycle found')
}
});
};
};

View File

@@ -20,7 +20,7 @@ use_ok 'Foo';
push @{app->renderer->classes}, 'Foo';
plugin 'tt_renderer' => {template_options => {PRE_CHOMP => 1, POST_CHOMP => 1, TRIM => 1}};
plugin 'tt_renderer' => {template_options => {PRE_CHOMP => 1, POST_CHOMP => 1, TRIM => 1, COMPILE_DIR => tempdir( CLEANUP => 1 )}};
app->log->level('fatal');