Fix all the version numbers

[catagits/Catalyst-View-Component-SubInclude.git] / lib / Catalyst / View / Component / SubInclude / ESI.pm

diff --git a/lib/Catalyst/View/Component/SubInclude/ESI.pm b/lib/Catalyst/View/Component/SubInclude/ESI.pm
index f2e02b9..85acbdd 100644 (file)
--- a/lib/Catalyst/View/Component/SubInclude/ESI.pm
+++ b/lib/Catalyst/View/Component/SubInclude/ESI.pm
@@ -1,12 +1,92 @@
 package Catalyst::View::Component::SubInclude::ESI;
-use warnings;
-use strict;
+use Moose;
+use namespace::clean -except => 'meta';
+
+=head1 NAME
+
+Catalyst::View::Component::SubInclude::ESI - Edge Side Includes (ESI) plugin for C::V::Component::SubInclude
+
+=head1 VERSION
+
+Version 0.07_03
+
+=cut
+
+our $VERSION = '0.07_03';
+$VERSION = eval $VERSION;
+
+=head1 SYNOPSIS
+
+In your view class:
+
+  package MyApp::View::TT;
+  use Moose;
+
+  extends 'Catalyst::View::TT';
+  with 'Catalyst::View::Component::SubInclude';
+
+  __PACKAGE__->config( subinclude_plugin => 'ESI' );
+
+Then, somewhere in your templates:
+
+  [% subinclude('/my/widget') %]
+
+=head1 DESCRIPTION
+
+C<Catalyst::View::Component::SubInclude::ESI> renders C<subinclude> calls as 
+Edge Side Includes (ESI) include directives. This is a feature implemented by 
+Varnish (L<http://varnish.projects.linpro.no/>) which allows cache-efficient 
+uses of includes.
+
+=head1 CLASS METHODS
+
+=head2 C<generate_subinclude( $c, $path, @args )>
+
+Note that C<$path> should be the private action path - translation to the public
+path is handled internally. After translation, this will roughly translate to 
+the following code:
+
+  my $url = $c->uri_for( $translated_path, @args )->path_query;
+  return '<!--esi <esi:include src="$url" /> -->';
+
+Notice that the stash will always be empty. This behavior could be configurable
+in the future through an additional switch - for now, this behavior guarantees a
+common interface for plugins.
+
+=cut
 
 sub generate_subinclude {
-    my $class = shift;
-    my $c     = shift;
-    my $url = $c->uri_for( @_ );
-    return '<!--esi <esi:include src="' . $url->path . '" /> -->';
+    my ($self, $c, $path, @params) = @_;
+
+    my $uri = $c->uri_for_action( $path, @params );
+
+    return '<!--esi <esi:include src="' . $uri->path_query . '" /> -->';
 }
 
+=head1 SEE ALSO
+
+L<Catalyst::View::Component::SubInclude|Catalyst::View::Component::SubInclude>, 
+L<http://www.catalystframework.org/calendar/2008/17>,
+L<http://varnish.projects.linpro.no/>
+
+=head1 AUTHOR
+
+Nilson Santos Figueiredo Junior, C<< <nilsonsfj at cpan.org> >>
+
+=head1 SPONSORSHIP
+
+Development sponsored by Ionzero LLC L<http://www.ionzero.com/>.
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright (C) 2009 Nilson Santos Figueiredo Junior.
+
+Copyright (C) 2009 Ionzero LLC.
+
+This program is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+
+=cut
+
+__PACKAGE__->meta->make_immutable;
 1;