v1.39

- Documentation updates.

Changes

@@ -1,6 +1,34 @@
 Revision history for Mojolicious::Plugin::TtRenderer
 
 {{$NEXT}}
+
+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

README.pod

@@ -6,17 +6,17 @@ Mojolicious::Plugin::TtRenderer - Template Renderer Plugin
 
 =head1 SYNOPSIS
 
-    # Mojolicious
-    $self->plugin('tt_renderer');
-    $self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
+ # Mojolicious
+ $self->plugin('tt_renderer');
+ $self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
 
-    # Mojolicious::Lite
-    plugin 'tt_renderer';
-    plugin tt_renderer => {template_options => {FILTERS => [ ... ]}};
+ # Mojolicious::Lite
+ plugin 'tt_renderer';
+ plugin tt_renderer => {template_options => {FILTERS => [ ... ]}};
 
 =head1 DESCRIPTION
 
-L<Mojolicous::Plugin::TtRenderer> is a simple loader for 
+L<Mojolicious::Plugin::TtRenderer> is a simple loader for 
 L<Mojolicious::Plugin::TtRenderer::Engine>.
 
 =head1 METHODS
@@ -26,7 +26,7 @@ L<Mojolicious::Plugin> and implements the following new ones.
 
 =head2 C<register>
 
-    $plugin->register;
+ $plugin->register;
 
 Register renderer in L<Mojolicious> application.
 
@@ -34,11 +34,14 @@ Register renderer in L<Mojolicious> application.
 
 The current controller instance can be accessed as C<c>.
 
-   [% c.req.headers.host %]
+ [% c.req.headers.host %]
 
 =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>.
 
 =head1 AUTHOR
 
@@ -55,7 +58,7 @@ L<https://github.com/abh/mojox-renderer-tt/issues?state=open>.
 
 You can find documentation for this module with the perldoc command.
 
-    perldoc Mojolicious::Plugin::TtRenderer
+ perldoc Mojolicious::Plugin::TtRenderer
 
 You can also look for information at:
 

dist.ini

@@ -12,6 +12,9 @@ Template     = 2.18
 [Prereqs / TestRequires ]
 Test::More   = 0
 
+[NextRelease]
+format = %-7v %{MMMM d, yyyy}d
+
 [@Git]
 tag_format = release/%v
 # push_to    = all
@@ -51,7 +54,6 @@ location = root
 
 [Manifest]
 
-[NextRelease]
-format = %-7v %{MMMM d, yyyy}d
-
 [MinimumPerl]
+
+[MetaJSON]

lib/Mojolicious/Plugin/TtRenderer.pm

@@ -32,17 +32,17 @@ Mojolicious::Plugin::TtRenderer - Template Renderer Plugin
 
 =head1 SYNOPSIS
 
-    # Mojolicious
-    $self->plugin('tt_renderer');
-    $self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
+ # Mojolicious
+ $self->plugin('tt_renderer');
+ $self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
 
-    # Mojolicious::Lite
-    plugin 'tt_renderer';
-    plugin tt_renderer => {template_options => {FILTERS => [ ... ]}};
+ # Mojolicious::Lite
+ plugin 'tt_renderer';
+ plugin tt_renderer => {template_options => {FILTERS => [ ... ]}};
 
 =head1 DESCRIPTION
 
-L<Mojolicous::Plugin::TtRenderer> is a simple loader for 
+L<Mojolicious::Plugin::TtRenderer> is a simple loader for 
 L<Mojolicious::Plugin::TtRenderer::Engine>.
 
 =head1 METHODS
@@ -52,7 +52,7 @@ L<Mojolicious::Plugin> and implements the following new ones.
 
 =head2 C<register>
 
-    $plugin->register;
+ $plugin->register;
 
 Register renderer in L<Mojolicious> application.
 
@@ -60,11 +60,14 @@ Register renderer in L<Mojolicious> application.
 
 The current controller instance can be accessed as C<c>.
 
-   [% c.req.headers.host %]
+ [% c.req.headers.host %]
 
 =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>.
 
 =head1 AUTHOR
 
@@ -81,7 +84,7 @@ L<https://github.com/abh/mojox-renderer-tt/issues?state=open>.
 
 You can find documentation for this module with the perldoc command.
 
-    perldoc Mojolicious::Plugin::TtRenderer
+ perldoc Mojolicious::Plugin::TtRenderer
 
 You can also look for information at:
 

lib/Mojolicious/Plugin/TtRenderer/Engine.pm

@@ -12,6 +12,7 @@ use Mojo::ByteStream 'b';
 use Template ();
 use Cwd qw/abs_path/;
 use Scalar::Util 'weaken';
+use POSIX ':errno_h';
 
 __PACKAGE__->attr('tt');
 
@@ -45,7 +46,7 @@ sub _init {
     my %config = (
         (   @renderer_paths > 0
             ? (INCLUDE_PATH => [@renderer_paths, 'templates'])
-            : ()
+            : (INCLUDE_PATH => ['templates'])
         ),
         COMPILE_EXT => '.ttc',
         COMPILE_DIR => ($dir || abs_path(File::Spec->tmpdir)),
@@ -87,11 +88,26 @@ sub _render {
     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;
@@ -155,7 +171,6 @@ 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 {
     my($self, $template) = @_;
@@ -183,7 +198,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 }) {
@@ -213,27 +227,27 @@ Mojolicious::Plugin::TtRenderer::Engine - Template Toolkit renderer for Mojo
 
 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 >.
 
@@ -243,20 +257,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
 
@@ -274,7 +288,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
 
@@ -283,18 +301,19 @@ templates. Will default to a temp-dir if not set.
 
 =back
 
+=head1 SEE ALSO
+
+L<Mojolicious::Plugin::TtRenderer::Engine>, 
+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 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 the project's github issue tracker
@@ -304,7 +323,7 @@ L<https://github.com/abh/mojox-renderer-tt/issues?state=open>.
 
 You can find documentation for this module with the perldoc command.
 
-    perldoc Mojolicious::Plugin::TtRenderer::Engine
+ perldoc Mojolicious::Plugin::TtRenderer::Engine
 
 You can also look for information at:
 

t/00-load.t

@@ -7,4 +7,3 @@ BEGIN {
 	use_ok( 'Mojolicious::Plugin::TtRenderer::Engine' );
 }
 
-diag( "Testing Mojolicious::Plugin::TtRenderer::Engine $Mojolicious::Plugin::TtRenderer::Engine::VERSION, Perl $], $^X" );

t/deep_recursion.t

@@ -11,11 +11,16 @@ use Test::More tests => 3;
 
 use Mojolicious::Lite;
 use Test::Mojo;
+use File::Temp qw( tempdir );
+use File::Spec;
 
-# Silence
+# 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 };
 

t/default_handler_as_engine.t

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

t/default_handler_as_plugin.t

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

t/default_handler_no_templates_dir.t

@@ -0,0 +1,37 @@
+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';
+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->get_ok('/bar')
+    ->status_is(200)
+    ->content_like(qr{bar});
+
+#note $t->tx->res->to_string;
+
+__DATA__
+
+@@ index.html.tt
+anything
+
+@@ bar.html.tt
+sometimes, the bar, he eats you...
+

t/lite_app.t

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

t/multiple_paths.t

@@ -11,6 +11,7 @@ use Test::More tests => 6;
 
 use Mojolicious::Lite;
 use Test::Mojo;
+use File::Temp qw( tempdir );
 
 # Silence
 app->log->level('fatal');
@@ -18,7 +19,7 @@ app->log->level('fatal');
 my @paths = map { app->home->rel_dir($_) } "templates/multiple_first", "templates/multiple_second";
 app->renderer->paths([@paths]);
 
-plugin 'TtRenderer';
+plugin 'TtRenderer' => {template_options => { COMPILE_DIR => tempdir( CLEANUP => 1 ) }};
 
 get '/first' => 'first';
 get '/second' => 'second';

t/templates/grimlock.html.tt

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

t/tt_plugin_lite_app.t

@@ -6,10 +6,8 @@ use strict;
 use warnings;
 
 BEGIN {
-  #use if $^O ne 'MSWin32', POSIX => qw/setlocale LC_ALL/;
-  #setlocale(&LC_ALL, 'C') if $^O ne 'MSWin32';
   unless($^O eq 'MSWin32') {
-    eval q{
+    eval '# line '. __LINE__ . ' "' . __FILE__ . qq("\n). q{
       use POSIX qw( setlocale LC_ALL );
       setlocale(LC_ALL, 'C');
     };
@@ -17,12 +15,12 @@ BEGIN {
   }
 }
 
-use File::Temp;
+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!'
@@ -36,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');
@@ -57,6 +55,8 @@ $t->get_ok('/blow')->status_is(500)->content_like(qr/file error - doesnotexist\.
 
 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

t/two_data.t

@@ -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');