X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FView%2FTT.pm;h=11b16afc24f919e8949b9d7a48e30fd6c025de8c;hb=dccfa0ff18a9076652cc5128542e1ea2ffad2740;hp=461ab505c3ea6bef0f9e163761c220396e13aea2;hpb=23042c3c04e3f6b0b75a5be6b1f511985a362834;p=catagits%2FCatalyst-View-TT.git

diff --git a/lib/Catalyst/View/TT.pm b/lib/Catalyst/View/TT.pm
index 461ab50..11b16af 100644
--- a/lib/Catalyst/View/TT.pm
+++ b/lib/Catalyst/View/TT.pm
@@ -6,7 +6,7 @@ use Template;
 use Template::Timer;
 use NEXT;
 
-our $VERSION = '0.12';
+our $VERSION = '0.14';
 
 __PACKAGE__->mk_accessors('template');
 
@@ -16,45 +16,218 @@ Catalyst::View::TT - Template View Class
 
 =head1 SYNOPSIS
 
-    # use the helper
-    create.pl view TT TT
+# use the helper to create View
+    myapp_create.pl view TT TT
+
+# configure in lib/MyApp.pm
+
+    our $ROOT = '/home/dent/catalyst/MyApp';
+
+    MyApp->config({
+        name     => 'MyApp',
+        root     => $ROOT,
+        'MyApp::V::TT' => {
+            # any TT configurations items go here
+            INCLUDE_PATH => [
+              "$ROOT/templates/src", 
+              "$ROOT/templates/lib"
+            ],
+            PRE_PROCESS => 'config/main',
+            WRAPPER     => 'site/wrapper',
+
+            # two optional config items
+            CATALYST_VAR => 'Catalyst',
+            TIMER        => 1,
+        },
+    });
+         
+# render view from lib/MyApp.pm or lib/MyApp::C::SomeController.pm
+    
+    sub message : Global {
+        my ( $self, $c ) = @_;
+        $c->stash->{template} = 'message.tt2';
+        $c->stash->{message}  = 'Hello World!';
+        $c->forward('MyApp::V::TT');
+    }
 
-    # lib/MyApp/View/TT.pm
-    package MyApp::View::TT;
+# access variables from template
 
-    use base 'Catalyst::View::TT';
+    The message is: [% message %].
+    
+    # example when CATALYST_VAR is set to 'Catalyst'
+    Context is [% Catalyst %]          
+    The base is [% Catalyst.req.base %] 
+    The name is [% Catalyst.config.name %] 
+    
+    # example when CATALYST_VAR isn't set
+    Context is [% c %]
+    The base is [% base %]
+    The name is [% name %]
+
+=head1 DESCRIPTION
+
+This is the Catalyst view class for the L<Template Toolkit|Template>.
+Your application should defined a view class which is a subclass of
+this module.  The easiest way to achieve this is using the
+F<myapp_create.pl> script (where F<myapp> should be replaced with
+whatever your application is called).  This script is created as part
+of the Catalyst setup.
+
+    $ script/myapp_create.pl view TT TT
+
+This creates a MyApp::V::TT.pm module in the F<lib> directory (again,
+replacing C<MyApp> with the name of your application) which looks
+something like this:
+
+    package FooBar::V::TT;
+    
+    use strict;
+     use base 'Catalyst::View::TT';
 
     __PACKAGE__->config->{DEBUG} = 'all';
 
-    1;
+Now you can modify your action handlers in the main application and/or
+controllers to forward to your view class.  You might choose to do this
+in the end() method, for example, to automatically forward all actions
+to the TT view class.
+
+    # In MyApp or MyApp::Controller::SomeController
     
-    # Meanwhile, maybe in an '!end' action
-    $c->forward('MyApp::View::TT');
+    sub end : Private {
+        my( $self, $c ) = @_;
+        $c->forward('MyApp::V::TT');
+    }
 
+=head2 CONFIGURATION
 
-=head1 DESCRIPTION
+There are a three different ways to configure your view class.  The
+first way is to call the C<config()> method in the view subclass.  This
+happens when the module is first loaded.
+
+    package MyApp::V::TT;
+    
+    use strict;
+    use base 'Catalyst::View::TT';
+
+    our $ROOT = '/home/dent/catalyst/MyApp';
+    
+    MyApp::V::TT->config({
+        INCLUDE_PATH => ["$ROOT/templates/src", "$ROOT/templates/lib"],
+        PRE_PROCESS  => 'config/main',
+        WRAPPER      => 'site/wrapper',
+    });
+
+The second way is to define a C<new()> method in your view subclass.
+This performs the configuration when the view object is created,
+shortly after being loaded.  Remember to delegate to the base class
+C<new()> method (via C<$self-E<gt>NEXT::new()> in the example below) after
+performing any configuration.
+
+    sub new {
+        my $self = shift;
+        $self->config({
+            INCLUDE_PATH => ["$ROOT/templates/src", "$ROOT/templates/lib"],
+            PRE_PROCESS  => 'config/main',
+            WRAPPER      => 'site/wrapper',
+        });
+        return $self->NEXT::new(@_);
+    }
+ 
+The final, and perhaps most direct way, is to define a class
+item in your main application configuration, again by calling the
+uniquitous C<config()> method.  The items in the class hash are
+added to those already defined by the above two methods.  This happens
+in the base class new() method (which is one reason why you must
+remember to call it via C<NEXT> if you redefine the C<new()> method in a
+subclass).
+
+    package MyApp;
+    
+    use strict;
+    use Catalyst;
+    
+    our $ROOT = '/home/dent/catalyst/MyApp';
+    
+    MyApp->config({
+        name     => 'MyApp',
+        root     => $ROOT,
+        'MyApp::V::TT' => {
+            INCLUDE_PATH => ["$ROOT/templates/src", "$ROOT/templates/lib"],
+            PRE_PROCESS  => 'config/main',
+            WRAPPER      => 'site/wrapper',
+        },
+    });
+
+Note that any configuration items defined by one of the earlier
+methods will be overwritten by items of the same name provided by the
+latter methods.  
+
+=head2 RENDERING VIEWS
+
+The view plugin renders the template specified in the C<template>
+item in the stash.  
+
+    sub message : Global {
+        my ( $self, $c ) = @_;
+        $c->stash->{template} = 'message.tt2';
+        $c->forward('MyApp::V::TT');
+    }
+
+If a class item isn't defined, then it instead uses the
+current match, as returned by C<$c-E<gt>match>.  In the above 
+example, this would be C<message>.
+
+The items defined in the stash are passed to the Template Toolkit for
+use as template variables.
 
-This is the C<Template> view class. Your subclass should inherit from this
-class.  The plugin renders the template specified in C<< $c->stash->{template} >>
-or C<< $c->request->match >>.  The template variables are set up from the
-contents of C<< $c->stash >>, augmented with C<base> set to C<< $c->req->base >>,
-C<c> to C<$c> and C<name> to C<< $c->config->{name} >>.  The output is
-stored in C<< $c->response->output >>.
+sub message : Global {
+    sub default : Private {
+        my ( $self, $c ) = @_;
+        $c->stash->{template} = 'message.tt2';
+        $c->stash->{message}  = 'Hello World!';
+        $c->forward('MyApp::V::TT');
+    }
+
+A number of other template variables are also added:
+
+    c      A reference to the context object, $c
+    base   The URL base, from $c->req->base()
+    name   The application name, from $c->config->{ name }
+
+These can be accessed from the template in the usual way:
+
+<message.tt2>:
+
+    The message is: [% message %]
+    The base is [% base %]
+    The name is [% name %]
+
+If you prefer, you can set the C<CATALYST_VAR> configuration item to
+define the name of a template variable through which the context can
+be referenced.
 
+    MyApp->config({
+        name     => 'MyApp',
+        root     => $ROOT,
+        'MyApp::V::TT' => {
+            CATALYST_VAR => 'Catalyst',
+        },
+    });
 
-If you want to override TT config settings, you can do it there by setting
-C<< __PACKAGE__->config->{OPTION} >> as shown in the synopsis. Of interest might be
-C<EVAL_PERL>, which is disabled by default, and C<LOAD_TEMPLATES>, which is set to
-use the provider.
+F<message.tt2>:
 
-If you want to use EVAL perl, add something like this:
+    The base is [% Catalyst.req.base %]
+    The name is [% Catalyst.config.name %]
 
-    __PACKAGE__->config->{EVAL_PERL} = 1;
-    __PACKAGE__->config->{LOAD_TEMPLATES} = undef;
+The output generated by the template is stored in
+C<$c-E<gt>response-E<gt>output>.
 
-If you have configured Catalyst for debug output C<Catalyst::View::TT> will
-enable profiling of template processing (using C<Template::Timer>.  This will cause
-HTML comments will get embedded in the output from your templates, such as:
+=head2 TEMPLATE PROFILING
+
+If you have configured Catalyst for debug output,
+C<Catalyst::View::TT> will enable profiling of template processing
+(using L<Template::Timer>). This will embed HTML comments in the
+output from your templates, such as:
 
     <!-- TIMER START: process mainmenu/mainmenu.ttml -->
     <!-- TIMER START: include mainmenu/cssindex.tt -->
@@ -66,10 +239,14 @@ HTML comments will get embedded in the output from your templates, such as:
 
     <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) -->
 
-You can supress template profiling when debug is enabled by setting:
-
-    __PACKAGE__->config->{CONTEXT} = undef;
+You can suppress template profiling by setting the C<TIMER> configuration
+item to a false value.
 
+    MyApp->config({
+        'MyApp::V::TT' => {
+            TIMER => 0,
+        },
+    });
 
 =head2 METHODS
 
@@ -83,32 +260,60 @@ and reads the application config.
 =cut
 
 sub new {
-    my $self = shift;
-    my $c    = shift;
-    $self = $self->NEXT::new(@_);
-    my $root   = $c->config->{root};
-    my %config = (
+    my ( $class, $c, $arguments ) = @_;
+
+    my $root = $c->config->{root};
+
+    my $config = {
         EVAL_PERL    => 0,
         INCLUDE_PATH => [ $root, "$root/base" ],
-        %{ $self->config() }
-    );
+        %{ $class->config },
+        %{$arguments}
+    };
+
+    # if we're debugging and/or the TIMER option is set, then we install
+    # Template::Timer as a custom CONTEXT object, but only if we haven't
+    # already got a custom CONTEXT defined
+
+    if ( $config->{TIMER} ) {
+        if ( $config->{CONTEXT} ) {
+            $c->log->error(
+                'Cannot use Template::Timer - a TT CONFIG is already defined');
+        }
+        else {
+            $config->{CONTEXT} = Template::Timer->new(%$config);
+        }
+    }
 
-    if ( $c->debug && not exists $config{CONTEXT} ) {
-       $config{CONTEXT} = Template::Timer->new(%config);
+    if ( $c->debug && $config->{DUMP_CONFIG} ) {
+        use Data::Dumper;
+        $c->log->debug( "TT Config: ", Dumper($config) );
     }
 
-    $self->template( Template->new( \%config ) );
-    return $self;
+    return $class->NEXT::new(
+        $c,
+        {
+            template => Template->new($config) || do {
+                my $error = Template->error();
+                $c->log->error($error);
+                $c->error($error);
+                return undef;
+              }
+        }
+    );
 }
 
 =item process
 
-Renders the template specified in C<< $c->stash->{template} >> or C<< 
-$c->request->match >>.
-Template variables are set up from the contents of C<< $c->stash >>, 
-Jaugmented with C<base> set to C<< $c->req->base >>, C<c> to C<$c> and 
-C<name> to C<< $c->config->{name} >>.  Output is stored in 
-C<< $c->response->output >>.
+Renders the template specified in C<$c-E<gt>stash-E<gt>{template}> or
+C<$c-E<gt>request-E<gt>match>. Template variables are set up from the
+contents of C<$c-E<gt>stash>, augmented with C<base> set to
+C<$c-E<gt>req-E<gt>base>, C<c> to C<$c> and C<name> to
+C<$c-E<gt>config-E<gt>{name}>. Alternately, the C<CATALYST_VAR>
+configuration item can be defined to specify the name of a template
+variable through which the context reference (C<$c>) can be accessed.
+In this case, the C<c>, C<base> and C<name> variables are omitted.
+Output is stored in C<$c-E<gt>response-E<gt>output>.
 
 =cut
 
@@ -123,29 +328,28 @@ sub process {
     }
 
     $c->log->debug(qq/Rendering template "$template"/) if $c->debug;
-    
-    my $output;
 
-    unless (
-        $self->template->process(
-            $template,
-            {
-                base => $c->req->base,
-                c    => $c,
-                name => $c->config->{name},
-                %{ $c->stash }
-            },
-            \$output
-        )
-      )
-    {
+    my $output;
+    my $cvar = $self->config->{CATALYST_VAR};
+    my $vars = {
+        defined $cvar
+        ? ( $cvar => $c )
+        : (
+            c    => $c,
+            base => $c->req->base,
+            name => $c->config->{name}
+        ),
+        %{ $c->stash() }
+    };
+
+    unless ( $self->template->process( $template, $vars, \$output ) ) {
         my $error = $self->template->error;
         $error = qq/Couldn't render template "$error"/;
         $c->log->error($error);
         $c->error($error);
         return 0;
     }
-    
+
     unless ( $c->response->content_type ) {
         $c->response->content_type('text/html; charset=utf-8');
     }
@@ -157,20 +361,43 @@ sub process {
 
 =item config
 
-This allows your view subclass to pass additional settings to the
-TT config hash.
+This method allows your view subclass to pass additional settings to
+the TT configuration hash, or to set the C<CATALYST_VAR> and C<TIMER>
+options.
 
 =back
 
+=head2 HELPERS
+
+The L<Catalyst::Helper::View::TT> and
+L<Catalyst::Helper::View::TTSite> helper modules are provided to create
+your view module.  There are invoked by the F<myapp_create.pl> script:
+
+    $ script/myapp_create.pl view TT TT
+
+    $ script/myapp_create.pl view TT TTSite
+
+The L<Catalyst::Helper::View::TT> module creates a basic TT view
+module.  The L<Catalyst::Helper::View::TTSite> module goes a little
+further.  It also creates a default set of templates to get you
+started.  It also configures the view module to locate the templates
+automatically.
+
 =head1 SEE ALSO
 
-L<Catalyst>. L<Template::Manual>
+L<Catalyst>, L<Catalyst::Helper::View::TT>,
+L<Catalyst::Helper::View::TTSite>, L<Template::Manual>
 
-=head1 AUTHOR
+=head1 AUTHORS
 
 Sebastian Riedel, C<sri@cpan.org>
+
 Marcus Ramberg, C<mramberg@cpan.org>
 
+Jesse Sheidlower, C<jester@panix.com>
+
+Andy Wardley, C<abw@cpan.org>
+
 =head1 COPYRIGHT
 
 This program is free software, you can redistribute it and/or modify it