v1.51

- extended diagnostics
        - documentation tweaks
        - fix non-lite app example (GH#41, uwisser)

.gitignore

@@ -1,2 +1,3 @@
 /Mojolicious-Plugin-TtRenderer-*
 /.build
+/example/myapp/log/development.log

Changes

@@ -2,6 +2,11 @@ Revision history for Mojolicious::Plugin::TtRenderer
 
 {{$NEXT}}
 
+1.51      2014-03-21 14:59:39 -0400
+        - extended diagnostics
+        - documentation tweaks
+        - fix non-lite app example (GH#41, uwisser)
+
 1.50      2013-08-08T16:51:21-0400
         - update Changes to follow spec (GH#39, Сергей Романов)
         - minor documentation fixes

README.md

@@ -0,0 +1,231 @@
+# Mojolicious::Plugin::TtRenderer [![Build Status](https://secure.travis-ci.org/plicease/Mojolicious-Plugin-TtRenderer.png)](http://travis-ci.org/plicease/Mojolicious-Plugin-TtRenderer)
+
+Template Renderer Plugin for Mojolicious
+
+# SYNOPSIS
+
+[Mojolicious::Lite](https://metacpan.org/pod/Mojolicious::Lite):
+
+    plugin 'tt_renderer';
+
+[Mojolicious](https://metacpan.org/pod/Mojolicious)
+
+    $self->plugin('tt_renderer');
+
+# DESCRIPTION
+
+This plugin is a simple Template Toolkit renderer for [Mojolicious](https://metacpan.org/pod/Mojolicious). 
+Its defaults are usually reasonable, although for finer grain detail in 
+configuration you may want to use 
+[Mojolicious::Plugin::TtRenderer::Engine](https://metacpan.org/pod/Mojolicious::Plugin::TtRenderer::Engine) directly.
+
+# OPTIONS
+
+These are the options that can be passed in as arguments to this plugin.
+
+## template\_options
+
+Configuration hash passed into [Template](https://metacpan.org/pod/Template)'s constructor, see 
+[Template Toolkit's configuration summary](https://metacpan.org/pod/Template#CONFIGURATION-SUMMARY)
+for details.  Here is an example using the [Mojolicious::Lite](https://metacpan.org/pod/Mojolicious::Lite) form:
+
+    plugin 'tt_renderer' => {
+      template_options => {
+        PRE_CHOMP => 1,
+        POST_CHOMP => 1,
+        TRIM => 1,
+      },
+    };
+
+Here is the same example using the full [Mojolicious](https://metacpan.org/pod/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:
+
+- 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 `__DATA__` section by the usual logic used by [Mojolicious](https://metacpan.org/pod/Mojolicious).
+
+- COMPILE\_EXT
+
+    `.ttc`
+
+- UNICODE
+
+    `1` (true)
+
+- ENCODING
+
+    `utf-87`
+
+- CACHE\_SIZE
+
+    `128`
+
+- RELATIVE
+
+    `1` (true)
+
+## 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 [Mojolicious](https://metacpan.org/pod/Mojolicious)
+app's home directory (`$app->home`).
+
+# STASH
+
+## h
+
+Helpers are available via the `h` entry in the stash.
+
+    <a href="[% h.url_for('index') %]">go back to index</a>
+
+## c
+
+The current controller instance can be accessed as `c`.
+
+    I see you are requesting a document from [% c.req.headers.host %].
+
+# EXAMPLES
+
+[Mojolicious::Lite](https://metacpan.org/pod/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>
+
+[Mojolicious](https://metacpan.org/pod/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 `Mojolicious::Plugin::TtRenderer`
+distribution, including the support files required for the full 
+[Mojolicious](https://metacpan.org/pod/Mojolicious) app example.
+
+# SEE ALSO
+
+[Mojolicious::Plugin::TtRenderer::Engine](https://metacpan.org/pod/Mojolicious::Plugin::TtRenderer::Engine), 
+[Mojolicious](https://metacpan.org/pod/Mojolicious), 
+[Mojolicious::Guides](https://metacpan.org/pod/Mojolicious::Guides), 
+[http://mojolicious.org](http://mojolicious.org).
+
+# 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
+
+Сергей Романов
+
+uwisser
+
+# COPYRIGHT AND LICENSE
+
+This software is copyright (c) 2014 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.

README.pod

@@ -1,246 +0,0 @@
-=pod
-
-=head1 NAME
-
-Mojolicious::Plugin::TtRenderer - Template Renderer Plugin for Mojolicious
-
-=head1 VERSION
-
-version 1.50
-
-=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
-
-=for stopwords Bjørn
-Szász
-Árpád
-
-=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 RELATIVE
-
-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>.
-
- 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.
-

dist.ini

@@ -5,10 +5,11 @@ license = Perl_5
 copyright_holder = Ask Bjørn Hansen
 # copyright_year   = 2009
 
-version = 1.50
+version = 1.51
 
 [@Author::Plicease]
 release_tests = 1
+travis_status = 1
 
 [Prereqs]
 Mojolicious  = 3.33
@@ -28,18 +29,6 @@ repository.type = git
 [HasVersionTests]
 [MetaTests]
 
-[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
@@ -57,6 +46,7 @@ contributor = Jason Crowther
 contributor = spleenjack
 contributor = Árpád Szász
 contributor = Сергей Романов
+contributor = uwisser
 
 [Author::Plicease::Upload]
 

example/myapp/log/development.log

@@ -1,21 +0,0 @@
-[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).

example/myapp/templates/example/welcome.html.tt

@@ -2,9 +2,9 @@
   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",
+<h2>[% message %]</h2>
+This page was generated from the template "templates/example/welcome.html.tt"
+and the layout "templates/layouts/default.html.tt",
 <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 %]

lib/Mojolicious/Plugin/TtRenderer/Engine.pm

@@ -226,6 +226,14 @@ __END__
 
 =encoding utf-8
 
+=begin stopwords
+
+Bjørn
+Szász
+Árpád
+
+=end stopwords
+
 =head1 SYNOPSIS
 
 Add the handler:
@@ -254,6 +262,16 @@ Add the handler:
 
 Template parameter are taken from C<$c-E<gt>stash>.
 
+=head1 DESCRIPTION
+
+See L<Mojolicious::Plugin::TtRenderer> for details on the plugin interface to this module.
+
+This module provides an engine for the rendering of L<Template Toolkit|Template> templates
+within a Mojolicious context.  Templates may be, stored on the local file system, provided
+inline by the controller or included in the C<__DATA__> section.  Where possible this modules
+attempts to provide a TT analogue interface to the L<Perlish templates|Mojo::Template> which 
+come with Mojolicious.
+
 =head1 RENDERING
 
 The template file for C<"example/welcome"> would be C<"templates/welcome.html.tt">.
@@ -306,7 +324,7 @@ templates. Will default to a temp-dir if not set.
 
 =head1 SEE ALSO
 
-L<Mojolicious::Plugin::TtRenderer::Engine>, 
+L<Mojolicious::Plugin::TtRenderer>, 
 L<Mojolicious>, 
 L<Mojolicious::Guides>, 
 L<http://mojolicious.org>.

t/00_diag.pl

@@ -1,11 +1,13 @@
 use strict;
 use warnings;
-use Test::More tests => 1;
+use Test::More;
 use Mojo::IOLoop;
 
+our $format;
+
 my $loop = eval { Mojo::IOLoop->singleton };
 diag $@ if $@;
-ok $loop;
-diag ref eval { $loop->reactor };
+diag sprintf $format, 'mojo io loop', ref eval { $loop->reactor };
 diag $@ if $@;
 
+1;

t/00_diag.pre.txt

@@ -0,0 +1 @@
+EV

t/00_diag.t

@@ -0,0 +1,61 @@
+use strict;
+use warnings;
+use Test::More tests => 1;
+BEGIN {
+  my @modules;
+  eval q{
+    require FindBin;
+    require File::Spec;
+    1;
+  } || die $@;
+  do {
+    my $fh;
+    open($fh, '<', File::Spec->catfile($FindBin::Bin, '00_diag.pre.txt'));
+    @modules = <$fh>;
+    close $fh;
+    chomp @modules;
+  };
+  eval qq{ require $_ } for @modules;
+};
+
+pass 'okay';
+
+my @modules;
+do {
+  my $fh;
+  open($fh, '<', File::Spec->catfile($FindBin::Bin, '00_diag.txt'));
+  @modules = <$fh>;
+  close $fh;
+  chomp @modules;
+};
+
+my $max = 1;
+$max = $_ > $max ? $_ : $max for map { length $_ } @modules;
+our $format = "%-${max}s %s"; 
+
+diag '';
+diag '';
+diag '';
+
+diag sprintf $format, 'perl ', $^V;
+
+require(File::Spec->catfile($FindBin::Bin, '00_diag.pl'))
+  if -e File::Spec->catfile($FindBin::Bin, '00_diag.pl');
+
+foreach my $module (@modules)
+{
+  if(eval qq{ require $module; 1 })
+  {
+    my $ver = eval qq{ \$$module\::VERSION };
+    $ver = 'undef' unless defined $ver;
+    diag sprintf $format, $module, $ver;
+  }
+  else
+  {
+    diag sprintf $format, $module, '-';
+  }
+}
+
+diag '';
+diag '';
+diag '';

t/00_diag.txt

@@ -0,0 +1,24 @@
+Carp
+Cwd
+EV
+ExtUtils::MakeMaker
+File::Spec
+File::Temp
+FindBin
+IO::Handle
+IPC::Open3
+Mojo::Base
+Mojo::ByteStream
+Mojo::IOLoop
+Mojolicious
+Mojolicious::Lite
+Mojolicious::Plugin
+POSIX
+Scalar::Util
+Template
+Template::Provider
+Test::CPAN::Meta
+Test::Mojo
+Test::More
+lib
+utf8

xt/release/release.yml

@@ -25,6 +25,8 @@ pod_spelling_system:
     - renderer's
     - Toolkit's
     - Fayland
+    - TT
+    - uwisser
 
 pod_coverage:
   # format is "Class#method" or "Class", regex allowed

xt/release/version.t

@@ -0,0 +1,36 @@
+use strict;
+use warnings;
+use Test::More;
+use FindBin ();
+BEGIN {
+  plan skip_all => "test requires Test::Version 1.001001"
+    unless eval q{ use Test::Version 1.001001 qw( version_all_ok ), { has_version => 1 }; 1 };
+  plan skip_all => "test requires Path::Class" 
+    unless eval q{ use Path::Class qw( file dir ); 1 };
+  plan skip_all => 'test requires YAML'
+    unless eval q{ use YAML; 1; };
+}
+
+use YAML qw( LoadFile );
+use FindBin;
+use File::Spec;
+
+plan skip_all => "test not built yet (run dzil test)"
+  unless -e dir( $FindBin::Bin)->parent->parent->file('Makefile.PL')
+  ||     -e dir( $FindBin::Bin)->parent->parent->file('Build.PL');
+
+my $config_filename = File::Spec->catfile(
+  $FindBin::Bin, 'release.yml'
+);
+
+my $config;
+$config = LoadFile($config_filename)
+  if -r $config_filename;
+
+if($config->{version}->{dir})
+{
+  note "using dir " . $config->{version}->{dir}
+}
+
+version_all_ok($config->{version}->{dir} ? ($config->{version}->{dir}) : ());
+done_testing;