X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FCookbook%2FBasics%2FRecipe6.pod;h=a46e4c023314d1cfdca3a6a187c466240d1e6692;hb=ccea63ce44db05da6bbc1a51a136ead4c275f8e4;hp=bce383d66450c8c65d5a42f5503b4cc7e8273f2c;hpb=021b8139fcacfbd1c0d4dc26e07936457f1ba12b;p=gitmo%2FMoose.git

diff --git a/lib/Moose/Cookbook/Basics/Recipe6.pod b/lib/Moose/Cookbook/Basics/Recipe6.pod
index bce383d..a46e4c0 100644
--- a/lib/Moose/Cookbook/Basics/Recipe6.pod
+++ b/lib/Moose/Cookbook/Basics/Recipe6.pod
@@ -6,81 +6,131 @@
 Moose::Cookbook::Basics::Recipe6 - The augment/inner example
 
 =head1 SYNOPSIS
-    
+
   package Document::Page;
   use Moose;
-  
-  has 'body' => (is => 'rw', isa => 'Str', default => sub {''});
-  
+
+  has 'body' => ( is => 'rw', isa => 'Str', default => sub {''} );
+
   sub create {
       my $self = shift;
       $self->open_page;
       inner();
       $self->close_page;
   }
-  
-  sub append_body { 
-      my ($self, $appendage) = @_;
-      $self->body($self->body . $appendage);
+
+  sub append_body {
+      my ( $self, $appendage ) = @_;
+      $self->body( $self->body . $appendage );
   }
-  
+
   sub open_page  { (shift)->append_body('<page>') }
-  sub close_page { (shift)->append_body('</page>') }  
-  
+  sub close_page { (shift)->append_body('</page>') }
+
   package Document::PageWithHeadersAndFooters;
   use Moose;
-  
+
   extends 'Document::Page';
-  
+
   augment 'create' => sub {
       my $self = shift;
       $self->create_header;
       inner();
       $self->create_footer;
   };
-  
+
   sub create_header { (shift)->append_body('<header/>') }
-  sub create_footer { (shift)->append_body('<footer/>') }  
-  
+  sub create_footer { (shift)->append_body('<footer/>') }
+
   package TPSReport;
   use Moose;
-  
+
   extends 'Document::PageWithHeadersAndFooters';
-  
+
   augment 'create' => sub {
       my $self = shift;
       $self->create_tps_report;
+      inner();
   };
-  
+
   sub create_tps_report {
-     (shift)->append_body('<report type="tps"/>') 
+      (shift)->append_body('<report type="tps"/>');
   }
-  
-  print TPSReport->new->create # <page><header/><report type="tps"/><footer/></page>
+
+  # <page><header/><report type="tps"/><footer/></page>
+  print TPSReport->new->create;
 
 =head1 DESCRIPTION
 
-Coming Soon.
+This recipe shows how the C<augment> method modifier works. This
+modifier reverses the normal subclass to parent method resolution
+order. With an C<augment> modifier the I<least> specific method is
+called first. Each successive call to C<inner> descends the
+inheritance tree, ending at the most specific subclass.
 
-=head1 CONCLUSION
+The C<augment> modifier lets you design a parent class that can be
+extended in a specific way. The parent provides generic wrapper
+functionality, and the subclasses fill in the details.
 
-=head1 FOOTNOTES
+In the example above, we've created a set of document classes, with
+the most specific being the C<TPSReport> class.
 
-=over 4
+We start with the least specific class, C<Document::Page>. Its create
+method contains a call to C<inner()>:
 
-=back
+  sub create {
+      my $self = shift;
+      $self->open_page;
+      inner();
+      $self->close_page;
+  }
+
+The C<inner> function is exported by C<Moose>, and is like C<super>
+for augmented methods. When C<inner> is called, Moose finds the next
+method in the chain, which is the C<augment> modifier in
+C<Document::PageWithHeadersAndFooters>. You'll note that we can call
+C<inner> in our modifier:
+
+  augment 'create' => sub {
+      my $self = shift;
+      $self->create_header;
+      inner();
+      $self->create_footer;
+  };
+
+This finds the next most specific modifier, in the C<TPSReport> class.
+
+Finally, in the C<TPSReport> class, the chain comes to an end:
+
+  augment 'create' => sub {
+      my $self = shift;
+      $self->create_tps_report;
+      inner();
+  };
+
+We do call the C<inner> function one more time, but since there is no
+more specific subclass, this is a no-op. Making this call means we can
+easily subclass C<TPSReport> in the future.
+
+=head1 CONCLUSION
+
+The C<augment> modifier is a powerful tool for creating a set of
+nested wrappers. It's not something you will need often, but when you
+do it is very handy.
 
 =head1 AUTHOR
 
 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
+Dave Rolsky E<lt>autarch@urth.orgE<gt>
+
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2007 by Infinity Interactive, Inc.
+Copyright 2007-2009 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>
 
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself.
 
-=cut       
+=cut