v1.44

- promote development changes to production

Changes

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

README.pod

@@ -6,13 +6,13 @@ Mojolicious::Plugin::TtRenderer - Template Renderer Plugin
 
 =head1 SYNOPSIS
 
-    # Mojolicious
+ # Mojolicious
-    $self->plugin('tt_renderer');
+ $self->plugin('tt_renderer');
-    $self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
+ $self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
 
-    # Mojolicious::Lite
+ # Mojolicious::Lite
-    plugin 'tt_renderer';
+ plugin 'tt_renderer';
-    plugin tt_renderer => {template_options => {FILTERS => [ ... ]}};
+ plugin tt_renderer => {template_options => {FILTERS => [ ... ]}};
 
 =head1 DESCRIPTION
 
@@ -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

@@ -5,6 +5,8 @@ license = Perl_5
 copyright_holder = Ask Bjørn Hansen
 # copyright_year   = 2009
 
+version = 1.44
+
 [Prereqs]
 Mojolicious  = 3.33
 Template     = 2.18
@@ -12,6 +14,9 @@ Template     = 2.18
 [Prereqs / TestRequires ]
 Test::More   = 0
 
+[NextRelease]
+format = %-7v %{MMMM d, yyyy}d
+
 [@Git]
 tag_format = release/%v
 # push_to    = all
@@ -22,15 +27,15 @@ remove = Readme
 remove = Manifest
 
 [MetaResources]
-bugtracker.web = https://github.com/abh/mojox-renderer-tt/issues
+bugtracker.web = https://github.com/plicease/mojox-renderer-tt/issues
-repository.web  = http://github.com/abh/mojox-renderer-tt
+repository.web  = http://github.com/plicease/mojox-renderer-tt
-repository.url  = git://github.com/abh/mojox-renderer-tt.git
+repository.url  = git://github.com/plicease/mojox-renderer-tt.git
 repository.type = git
 
 [Homepage]
 
-[BumpVersionFromGit]
+;[BumpVersionFromGit]
-version_regexp = ^release/(.*)
+;version_regexp = ^release/(.*)
 
 [PkgVersion]
 
@@ -51,9 +56,6 @@ location = root
 
 [Manifest]
 
-[NextRelease]
-format = %-7v %{MMMM d, yyyy}d
-
 [MinimumPerl]
 
 [MetaJSON]

lib/Mojolicious/Plugin/TtRenderer.pm

@@ -32,13 +32,13 @@ Mojolicious::Plugin::TtRenderer - Template Renderer Plugin
 
 =head1 SYNOPSIS
 
-    # Mojolicious
+ # Mojolicious
-    $self->plugin('tt_renderer');
+ $self->plugin('tt_renderer');
-    $self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
+ $self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}});
 
-    # Mojolicious::Lite
+ # Mojolicious::Lite
-    plugin 'tt_renderer';
+ plugin 'tt_renderer';
-    plugin tt_renderer => {template_options => {FILTERS => [ ... ]}};
+ plugin tt_renderer => {template_options => {FILTERS => [ ... ]}};
 
 =head1 DESCRIPTION
 
@@ -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

@@ -34,7 +34,7 @@ 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);
       }
     }
 
@@ -42,21 +42,24 @@ sub _init {
     #   take and process options :-)
 
     my @renderer_paths = $app ? map { abs_path($_) } grep { -d $_ } @{ $app->renderer->paths } : ();
+    push @renderer_paths, 'templates';
 
     my %config = (
-        (   @renderer_paths > 0
+        INCLUDE_PATH => \@renderer_paths,
-            ? (INCLUDE_PATH => [@renderer_paths, 'templates'])
+        COMPILE_EXT  => '.ttc',
-            : ()
+        UNICODE      => 1,
-        ),
+        ENCODING     => 'utf-8',
-        COMPILE_EXT => '.ttc',
+        CACHE_SIZE   => 128,
-        COMPILE_DIR => ($dir || abs_path(File::Spec->tmpdir)),
+        RELATIVE     => 1,
-        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};
@@ -174,8 +177,7 @@ sub options       { @_ > 1 ? $_[0]->{options}       = $_[1] : $_[0]->{options} }
 
 sub _template_modified {
     my($self, $template) = @_;
-    return 1 if $self->SUPER::_template_modified($template);
+    $self->SUPER::_template_modified($template) || $template =~ /^templates(?:\/|\\)/;
-    return $template =~ /^templates(?:\/|\\)/;
 }
 
 sub _template_content {
@@ -227,27 +229,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->renderer->add_handler( tt => $tt );
-        $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 );
-    }
 
 Template parameter are taken from C< $c->stash >.
 
@@ -257,20 +259,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.html.tt
-    Welcome, [% user.name %]!
+ 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
 
@@ -288,7 +290,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
 
@@ -297,18 +303,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
@@ -318,7 +325,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/01-ioloop.t

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

t/default_handler_as_engine.t

@@ -1,6 +1,6 @@
 use strict;
 use warnings;
-use Test::More tests => 3;
+use Test::More tests => 9;
 use Test::Mojo;
 use File::Temp qw( tempdir );
 use FindBin '$Bin';
@@ -13,7 +13,8 @@ my $tt = Mojolicious::Plugin::TtRenderer::Engine->build(
     template_options => {
         UNICODE  => 1,
         ENCODING => 'UTF-8',
-        INCLUDE_PATH => "$Bin/templates",
+        #INCLUDE_PATH => "$Bin/templates",
+        COMPILE_DIR  => tempdir( CLEANUP => 1 ),
     }
 );
 
@@ -24,13 +25,28 @@ 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,6 +1,6 @@
 use strict;
 use warnings;
-use Test::More tests => 3;
+use Test::More tests => 9;
 use Test::Mojo;
 use File::Temp qw( tempdir );
 
@@ -11,7 +11,7 @@ app->plugin(
     tt_renderer => {
         template_options => {
             # These options are specific to TT
-            INCLUDE_PATH => 'templates',
+            #INCLUDE_PATH => 'templates',
             COMPILE_DIR  => tempdir( CLEANUP => 1 ),
             COMPILE_EXT  => '.ttc',
             # ... anything else to be passed on to TT should go here
@@ -25,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,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...
+

t/templates/grimlock.html.tt

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