Merge branch 'feature/change-tt-base-class'

Author: cromedome

Changes

@@ -6,7 +6,8 @@
     * None
 
     [ ENHANCEMENTS ]
-    * None
+    * GH #1723: Enable use of a different Template Toolkit base class
+      (Andy Beverley)
 
     [ DOCUMENTATION ]
     * None

lib/Dancer2/Template/TemplateToolkit.pm

@@ -9,6 +9,9 @@ use Dancer2::FileUtils qw<path>;
 use Scalar::Util ();
 use Template;
 
+# Override to use a different Template::Toolkit base class
+has 'template_class' => ( is => 'ro', default => 'Template' );
+
 with 'Dancer2::Core::Role::Template';
 
 has '+engine' => ( isa => InstanceOf ['Template'], );
@@ -37,7 +40,7 @@ sub _build_engine {
         sub { [ $ttt->views ] },
     ];
 
-    my $tt = Template->new(%tt_config);
+    my $tt = $self->template_class->new(%tt_config);
     $Template::Stash::PRIVATE = undef if $self->config->{show_private_variables};
     return $tt;
 }
@@ -190,6 +193,22 @@ PARSER (L<Template::Parser>) and GRAMMAR (L<Template::Grammar>). If you intend t
 several of these components in your app, it is suggested to create an app-specific subclass
 that handles all of them at the same time.
 
+=head2 Custom Template::Toolkit class
+
+When subclassing this module it is possible to use a different
+Template::Toolkit class (for example if you have also subclassed that). To do
+that simply define a different C<template_class> property:
+
+    package Dancer2::Template::TemplateToolkit::FooBar;
+    
+    use Moo;
+    
+    extends 'Dancer2::Template::TemplateToolkit';
+    
+    has '+template_class' => ( default => 'TemplateFooBar' );
+    
+    1;
+
 =head2 Template Caching
 
 L<Template>::Tookit templates can be cached by adding the C<COMPILE_EXT> property to your

t/lib/Dancer2/Template/TemplateToolkitFoo.pm

@@ -0,0 +1,15 @@
+package Dancer2::Template::TemplateToolkitFoo;
+
+# Custom Template::Toolkit template engine that uses a custom Template class
+
+use strict;
+use warnings;
+
+use Moo;
+use TemplateFoo;
+
+extends 'Dancer2::Template::TemplateToolkit';
+
+has '+template_class' => ( default => 'TemplateFoo' );
+
+1;

t/lib/TemplateFoo.pm

@@ -0,0 +1,13 @@
+package TemplateFoo;
+
+# Custom Template::Toolkit class
+
+use base 'Template';
+
+sub process
+{   my ($self, $template, $vars, $outstream, @opts) = @_;
+    $$outstream = "Custom Render Template";
+    1;
+}
+
+1;

t/template.t

@@ -8,10 +8,13 @@ use HTTP::Request::Common;
 use File::Spec;
 use File::Basename 'dirname';
 
+use lib 't/lib';
+
 eval { require Template; Template->import(); 1 }
   or plan skip_all => 'Template::Toolkit probably missing.';
 
 use_ok('Dancer2::Template::TemplateToolkit');
+use_ok('Dancer2::Template::TemplateToolkitFoo');
 
 my $views =
   File::Spec->rel2abs( File::Spec->catfile( dirname(__FILE__), 'views' ) );
@@ -109,6 +112,28 @@ content added in after_layout_render";
     is $res->content, $result, '[GET /global] Correct content with template hooks';
 };
 
+# Test that a custom class can be used for Template::Toolkit
+my $tt_custom = Dancer2::Template::TemplateToolkitFoo->new;
+
+isa_ok $tt_custom, 'Dancer2::Template::TemplateToolkit';
+isa_ok $tt_custom, 'Dancer2::Template::TemplateToolkitFoo';
+
+{
+    package CustomFoo;
+    use Dancer2;
+
+    Dancer2->runner->apps->[1]->set_template_engine($tt_custom);
+
+    get '/' => sub { template 'index' };
+}
+
+subtest 'custom template render' => sub {
+
+    my $test = Plack::Test->create( CustomFoo->to_app );
+    my $res = $test->request( GET '/' );
+    is $res->content, 'Custom Render Template', 'Custom Render Template';
+};
+
 {
 
     package Foo;