[Jifty-commit] r1846 - in jifty/trunk: lib/Jifty t

[jifty-commit at lists.jifty.org]

Author: mark
Date: Wed Aug 23 09:46:18 2006
New Revision: 1846

Modified:
   jifty/trunk/   (props changed)
   jifty/trunk/lib/Jifty/Action.pm
   jifty/trunk/t/01-dependencies.t

Log:
 r1612 at travis:  mark | 2006-08-23 14:46:09 +0100
 forget about "use" statements inside pod


Modified: jifty/trunk/lib/Jifty/Action.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Action.pm	(original)
+++ jifty/trunk/lib/Jifty/Action.pm	Wed Aug 23 09:46:18 2006
@@ -7,12 +7,27 @@
 
 Jifty::Action - The ability to Do Things in the framework
 
+=head1 SYNOPSIS
+
+  package MyApp::Action::Foo;
+  use base qw/MyApp::Action Jifty::Action/;
+  
+  sub take_action {
+    ...
+  }
+  
+  1;
+
 =head1 DESCRIPTION
 
-C<Jifty::Action> is the meat of the L<Jifty> framework; it controls
-how form elements interact with the underlying model.  See also
-L<Jifty::Action::Record> for data-oriented actions, L<Jifty::Result>
-for how to return values from actions.
+C<Jifty::Action> is the superclass for all actions in Jifty.
+Action classes form the meat of the L<Jifty> framework; they
+control how form elements interact with the underlying model.
+
+See also L<Jifty::Action::Record> for data-oriented actions, 
+L<Jifty::Result> for how to return values from actions.
+
+See Jifty::Action::Schema;
 
 =cut
 
@@ -24,6 +39,8 @@
 
 =head1 COMMON METHODS
 
+These common methods are designed to 
+
 =head2 new 
 
 Construct a new action.  Subclasses who need do custom initialization
@@ -211,8 +228,7 @@
 
 =head2 setup
 
-Whatever the action needs to do to set itself up, it can do it by
-overriding C<setup>.  C<setup> is expected to return a true value, or
+.  C<setup> is expected to return a true value, or
 L</run> will skip all other actions.
 
 By default, does nothing.

Modified: jifty/trunk/t/01-dependencies.t
==============================================================================
--- jifty/trunk/t/01-dependencies.t	(original)
+++ jifty/trunk/t/01-dependencies.t	Wed Aug 23 09:46:18 2006
@@ -22,11 +22,18 @@
     return if $File::Find::dir =~ m!/.svn($|/)!;
     return if $File::Find::name =~ /~$/;
     return if $File::Find::name =~ /\.pod$/;
+    
+    # read in the file from disk
     my $filename = $_;
     local $/;
     open(FILE, $filename) or return;
     my $data = <FILE>;
     close(FILE);
+
+    # strip pod, in a really idiotic way.  Good enough though
+    $data =~ s/^=head.+?(^=cut|\Z)//gms;
+
+    # look for use and use base statements
     $used{$1}{$filename}++ while $data =~ /^\s*use\s+([\w:]+)/gm;
     while ($data =~ m|^\s*use base qw.([\w\s:]+)|gm) {
         $used{$_}{$filename}++ for split ' ', $1;