package Catalyst::View::TT;
-
-use strict;
-use warnings;
-
-use base qw/Catalyst::View/;
+use Moose;
use Data::Dump 'dump';
use Template;
use Template::Timer;
use MRO::Compat;
+use Scalar::Util qw/blessed/;
+use namespace::autoclean;
-our $VERSION = '0.31';
+extends 'Catalyst::View';
-__PACKAGE__->mk_accessors('template');
-__PACKAGE__->mk_accessors('include_path');
+our $VERSION = '0.33';
-*paths = \&include_path;
+has template => ( is => 'ro' );
+has include_path => ( is => 'rw' );
+
+__PACKAGE__->meta->add_method('paths' => __PACKAGE__->meta->find_method_by_name('include_path'));
=head1 NAME
# use the helper to create your View
- myapp_create.pl view TT TT
+ myapp_create.pl view HTML TT
# configure in lib/MyApp.pm (Could be set from configfile instead)
- MyApp->config(
- name => 'MyApp',
- root => MyApp->path_to('root'),
- 'View::TT' => {
+ __PACKAGE__->config(
+ name => 'MyApp',
+ root => MyApp->path_to('root'),
+ default_view => 'TT',
+ 'View::HTML' => {
# any TT configurations items go here
INCLUDE_PATH => [
MyApp->path_to( 'root', 'src' ),
# Not set by default
PRE_PROCESS => 'config/main',
WRAPPER => 'site/wrapper',
+ render_die => 1, # Default for new apps, see render method docs
},
);
return split( /$dlim/, $paths );
}
-sub new {
- my ( $class, $c, $arguments ) = @_;
- my $config = {
- EVAL_PERL => 0,
- TEMPLATE_EXTENSION => '',
- %{ $class->config },
- %{$arguments},
- };
+#$class->merge_config_hashes( $class->config, $args );
+
+around BUILDARGS => sub {
+ my ( $orig, $class, $c, $arguments ) = @_;
+ my $config = $class->merge_config_hashes(
+ {
+ EVAL_PERL => 0,
+ TEMPLATE_EXTENSION => '',
+ },
+ $class->$orig($c, $arguments)
+ );
if ( ! (ref $config->{INCLUDE_PATH} eq 'ARRAY') ) {
my $delim = $config->{DELIMITER};
my @include_path
$c->log->debug( "TT Config: ", dump($config) );
}
- my $self = $class->next::method(
- $c, { %$config },
- );
-
- # Set base include paths. Local'd in render if needed
- $self->include_path($config->{INCLUDE_PATH});
-
- $self->config($config);
-
- # Creation of template outside of call to new so that we can pass [ $self ]
- # as INCLUDE_PATH config item, which then gets ->paths() called to get list
- # of include paths to search for templates.
-
- # Use a weakend copy of self so we dont have loops preventing GC from working
- my $copy = $self;
- Scalar::Util::weaken($copy);
- $config->{INCLUDE_PATH} = [ sub { $copy->paths } ];
-
if ( $config->{PROVIDERS} ) {
my @providers = ();
if ( ref($config->{PROVIDERS}) eq 'ARRAY') {
@{ $p->{copy_config} };
}
}
+ local $@;
eval "require $prov";
if(!$@) {
push @providers, "$prov"->new($p->{args});
}
}
- $self->{template} =
+ $config->{template} =
Template->new($config) || do {
my $error = Template->error();
$c->log->error($error);
return undef;
};
+ return $config;
+};
+
+sub BUILD {
+ my ($self, $config) = @_;
+ # Set base include paths. Local'd in render if needed
+ $self->include_path($config->{INCLUDE_PATH});
+
+ $self->config($config);
- return $self;
+ # Creation of template outside of call to new so that we can pass [ $self ]
+ # as INCLUDE_PATH config item, which then gets ->paths() called to get list
+ # of include paths to search for templates.
+
+ # Use a weakend copy of self so we dont have loops preventing GC from working
+ my $copy = $self;
+ Scalar::Util::weaken($copy);
+ $config->{INCLUDE_PATH} = [ sub { $copy->paths } ];
}
sub process {
return 0;
}
- my $output = $self->render($c, $template);
-
- if (UNIVERSAL::isa($output, 'Template::Exception')) {
- my $error = qq/Couldn't render template "$output"/;
- $c->log->error($error);
- $c->error($error);
- return 0;
+ local $@;
+ my $output = eval { $self->render($c, $template) };
+ if (my $err = $@) {
+ return $self->_rendering_error($c, $err);
+ }
+ if (blessed($output) && $output->isa('Template::Exception')) {
+ $self->_rendering_error($c, $output);
}
unless ( $c->response->content_type ) {
return 1;
}
+sub _rendering_error {
+ my ($self, $c, $err) = @_;
+ my $error = qq/Couldn't render template "$err"/;
+ $c->log->error($error);
+ $c->error($error);
+ return 0;
+}
+
sub render {
my ($self, $c, $template, $args) = @_;
[ @{ $vars->{additional_template_paths} }, @{ $self->{include_path} } ]
if ref $vars->{additional_template_paths};
- unless ($self->template->process( $template, $vars, \$output ) ) {
+ unless ( $self->template->process( $template, $vars, \$output ) ) {
+ if (exists $self->{render_die}) {
+ die $self->template->error if $self->{render_die};
+ return $self->template->error;
+ }
+ $c->log->debug('The Catalyst::View::TT render() method of will die on error in a future release. Unless you are calling the render() method manually, you probably want the new behaviour, so set render_die => 1 in config for ' . blessed($self) . '. If you are calling the render() method manually and you wish it to continue to return the exception rather than throwing it, add render_die => 0 to your config.') if $c->debug;
return $self->template->error;
- } else {
- return $output;
}
+ return $output;
}
sub template_vars {
=head2 render($c, $template, \%args)
-Renders the given template and returns output, or a L<Template::Exception>
+Renders the given template and returns output. Throws a L<Template::Exception>
object upon error.
The template variables are set to C<%$args> if $args is a hashref, or
my $fragment = $c->forward("View::TT", "render", $template_name, $c->stash->{fragment_data});
+=head3 Backwards compatibility note
+
+The render method used to just return the Template::Exception object, rather
+than just throwing it. This is now deprecated and instead the render method
+will throw an exception for new applications.
+
+This behaviour can be activated (and is activated in the default skeleton
+configuration) by using C<< render_die => 1 >>. If you rely on the legacy
+behaviour then a warning will be issued.
+
+To silence this warning, set C<< render_die => 0 >>, but it is recommended
+you adjust your code so that it works with C<< render_die => 1 >>.
+
+In a future release, C<< render_die => 1 >> will become the default if
+unspecified.
+
=head2 template_vars
Returns a list of keys/values to be used as the catalyst variables in the
projects / catagits/Catalyst-View-TT.git / blobdiff