From: Nilson Santos Figueiredo Júnior <nilsonsfj@cpan.org>
Date: Fri, 30 Jan 2009 19:59:42 +0000 (+0000)
Subject: All docs updated.
X-Git-Tag: 0.07_01~40
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-View-Component-SubInclude.git;a=commitdiff_plain;h=4e3277560cc20740e2cdb58f4f9cf8eda74c9d73

All docs updated.
---

diff --git a/lib/Catalyst/View/Component/SubInclude.pm b/lib/Catalyst/View/Component/SubInclude.pm
index db04ebb..97023c6 100644
--- a/lib/Catalyst/View/Component/SubInclude.pm
+++ b/lib/Catalyst/View/Component/SubInclude.pm
@@ -35,7 +35,7 @@ Then, somewhere in your templates:
 C<Catalyst::View::Component::SubInclude> allows you to include content in your
 templates (or, more generally, somewhere in your view's C<render> processing)
 which comes from another action in your application. It's implemented as a 
-L<Moose::Role>, so using L<Moose> in your view is required.
+L<Moose::Role|Moose::Role>, so using L<Moose|Moose> in your view is required.
 
 Simply put, it's a way to include the output of a Catalyst sub-request somewhere
 in your page. 
@@ -53,7 +53,8 @@ common use-case).
 
 =head2 C<subinclude( $path, @args )>
 
-This will return the body of the requested resource (as specified by C<$path>).
+This will render and return the body of the included resource (as specified by 
+C<$path>).
 
 =head1 SUBINCLUDE PLUGINS
 
@@ -108,7 +109,8 @@ around 'render' => sub {
 
 =head1 SEE ALSO
 
-L<Catalyst::Plugin::SubRequest>, L<Moose::Role>, L<Moose>,
+L<Catalyst::Plugin::SubRequest|Catalyst::Plugin::SubRequest>, 
+L<Moose::Role|Moose::Role>, L<Moose|Moose>,
 L<http://www.catalystframework.org/calendar/2008/17>
 
 =head1 BUGS
diff --git a/lib/Catalyst/View/Component/SubInclude/ESI.pm b/lib/Catalyst/View/Component/SubInclude/ESI.pm
index f2e02b9..f2b499a 100644
--- a/lib/Catalyst/View/Component/SubInclude/ESI.pm
+++ b/lib/Catalyst/View/Component/SubInclude/ESI.pm
@@ -2,6 +2,56 @@ package Catalyst::View::Component::SubInclude::ESI;
 use warnings;
 use strict;
 
+=head1 NAME
+
+Catalyst::View::Component::SubInclude::ESI - Edge Side Includes (ESI) plugin for C::V::Component::SubInclude
+
+=head1 VERSION
+
+Version 0.01
+
+=cut
+
+our $VERSION = '0.01';
+
+=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 STASH FUNCTION
+
+=head2 C<subinclude( @args )>
+
+This will roughly translate to the following code:
+
+  my $url = $c->uri_for( @args );
+  <!--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;
@@ -9,4 +59,29 @@ sub generate_subinclude {
     return '<!--esi <esi:include src="' . $url->path . '" /> -->';
 }
 
+=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
+
 1;
diff --git a/lib/Catalyst/View/Component/SubInclude/SubRequest.pm b/lib/Catalyst/View/Component/SubInclude/SubRequest.pm
index cbf1886..5c8cf7a 100644
--- a/lib/Catalyst/View/Component/SubInclude/SubRequest.pm
+++ b/lib/Catalyst/View/Component/SubInclude/SubRequest.pm
@@ -2,14 +2,98 @@ package Catalyst::View::Component::SubInclude::SubRequest;
 use warnings;
 use strict;
 
+=head1 NAME
+
+Catalyst::View::Component::SubInclude::SubRequest - Sub-requests plugin for C::V::Component::SubInclude
+
+=head1 VERSION
+
+Version 0.01
+
+=cut
+
+our $VERSION = '0.01';
+
+=head1 SYNOPSIS
+
+In your application class:
+
+  package MyApp;
+
+  use Catalyst qw/
+    ConfigLoader
+    Static::Simple
+    ...
+    SubRequest
+  /;
+
+In your view class:
+
+  package MyApp::View::TT;
+  use Moose;
+
+  extends 'Catalyst::View::TT';
+  with 'Catalyst::View::Component::SubInclude';
+
+  __PACKAGE__->config( subinclude_plugin => 'SubRequest' );
+
+Then, somewhere in your templates:
+
+  [% subinclude('/my/widget') %]
+
+=head1 DESCRIPTION
+
+C<Catalyst::View::Component::SubInclude::SubRequest> uses Catalyst sub-requests
+to render the subinclude contents. 
+
+It requires L<Catalyst::Plugin::SubRequest>.
+
+=head1 STASH FUNCTION
+
+=head2 C<subinclude( $path, @args )>
+
+This will translate to the following sub-request call:
+
+  $c->sub_request( $path, {}, @args );
+
+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, $c, $path, $params) = @_;
+    my ($class, $c, $path, @params) = @_;
     my $stash = {};
 
     croak "subincludes through subrequests require Catalyst::Plugin::SubRequest"
         unless $c->can('sub_request');
 
-    $c->sub_request( $path, $stash, $params );
+    $c->sub_request( $path, $stash, @params );
 }
 
+=head1 SEE ALSO
+
+L<Catalyst::View::Component::SubInclude|Catalyst::View::Component::SubInclude>, 
+L<Catalyst::Plugin::SubRequest|Catalyst::Plugin::SubRequest>
+
+=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
+
 1;