added docs for engine/dispatcher

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Dispatcher.pm

diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm
index 7ba40cc..e74a49d 100644 (file)
--- a/lib/Catalyst/Dispatcher.pm
+++ b/lib/Catalyst/Dispatcher.pm
@@ -17,14 +17,16 @@ use overload '""' => sub { return ref shift }, fallback => 1;
 
 __PACKAGE__->mk_accessors(
     qw/tree dispatch_types registered_dispatch_types
-      method_action_class action_container_class/
+      method_action_class action_container_class
+      preload_dispatch_types postload_dispatch_types
+    /
 );
 
 # Preload these action types
-our @PRELOAD = qw/Path Regex/;
+our @PRELOAD = qw/Index Path Regex/;
 
 # Postload these action types
-our @POSTLOAD = qw/Index Default/;
+our @POSTLOAD = qw/Default/;
 
 =head1 NAME
 
@@ -36,11 +38,52 @@ See L<Catalyst>.
 
 =head1 DESCRIPTION
 
+This is the class that maps public urls to actions in your Catalyst
+application based on the attributes you set.
+
 =head1 METHODS
 
-=over 4
+=item new 
+
+Construct a new dispatcher.
+
+=cut
+
+sub new {
+    my $self = shift;
+    my $class = ref($self) || $self;
+                                    
+    my $obj = $class->SUPER::new( @_ );
+                                       
+    # set the default pre- and and postloads
+    $obj->preload_dispatch_types(  \@PRELOAD );        
+    $obj->postload_dispatch_types( \@POSTLOAD );
+    return $obj;                        
+}
+
+=head2 $self->preload_dispatch_types
+
+An arrayref of pre-loaded dispatchtype classes
+
+Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
+To use a custom class outside the regular C<Catalyst> namespace, prefix
+it with a C<+>, like so:
+
+    +My::Dispatch::Type
+
+=head2 $self->postload_dispatch_types
+
+An arrayref of post-loaded dispatchtype classes
+
+Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
+To use a custom class outside the regular C<Catalyst> namespace, prefix
+it with a C<+>, like so:
 
-=item $self->detach( $c, $command [, \@arguments ] )
+    +My::Dispatch::Type
+
+=head2 $self->detach( $c, $command [, \@arguments ] )
+
+Documented in L<Catalyst>
 
 =cut
 
@@ -50,13 +93,16 @@ sub detach {
     die $Catalyst::DETACH;
 }
 
-=item $self->dispatch($c)
+=head2 $self->dispatch($c)
+
+Delegate the dispatch to the action that matched the url, or return a
+message about unknown resource
+
 
 =cut
 
 sub dispatch {
     my ( $self, $c ) = @_;
-
     if ( $c->action ) {
         $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) );
     }
@@ -71,7 +117,9 @@ sub dispatch {
     }
 }
 
-=item $self->forward( $c, $command [, \@arguments ] )
+=head2 $self->forward( $c, $command [, \@arguments ] )
+
+Documented in L<Catalyst>
 
 =cut
 
@@ -123,8 +171,10 @@ sub forward {
 
     unless ($result) {
 
-        my $class  = ref($command) || ref( $c->component($command) );
-        my $method = shift         || 'process';
+        my $class = ref($command)
+          || ref( $c->component($command) )
+          || $c->component($command);
+        my $method = shift || 'process';
 
         unless ($class) {
             my $error =
@@ -169,7 +219,9 @@ qq/Couldn't forward to command "$command". Invalid action or component./;
     return $c->state;
 }
 
-=item $self->prepare_action($c)
+=head2 $self->prepare_action($c)
+
+Find an dispatch type that matches $c->req->path, and set args from it.
 
 =cut
 
@@ -179,12 +231,13 @@ sub prepare_action {
     my @path = split /\//, $c->req->path;
     $c->req->args( \my @args );
 
-    push( @path, '/' ) unless @path;    # Root action
+    unshift( @path, '' );    # Root action
 
   DESCEND: while (@path) {
         $path = join '/', @path;
+        $path =~ s#^/##;
 
-        $path = '' if $path eq '/';     # Root action
+        $path = '' if $path eq '/';    # Root action
 
         # Check out dispatch types to see if any will handle the path at
         # this level
@@ -194,8 +247,9 @@ sub prepare_action {
         }
 
         # If not, move the last part path to args
-
-        unshift @args, pop @path;
+        my $arg = pop(@path);
+        $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
+        unshift @args, $arg;
     }
 
     $c->log->debug( 'Path is "' . $c->req->match . '"' )
@@ -205,7 +259,9 @@ sub prepare_action {
       if ( $c->debug && @args );
 }
 
-=item $self->get_action( $action, $namespace )
+=head2 $self->get_action( $action, $namespace )
+
+returns a named action from a given namespace.
 
 =cut
 
@@ -224,7 +280,7 @@ sub get_action {
     }
 }
 
-=item $self->get_actions( $c, $action, $namespace )
+=head2 $self->get_actions( $c, $action, $namespace )
 
 =cut
 
@@ -239,7 +295,9 @@ sub get_actions {
     return map { $_->get_action($action) } @match;
 }
 
-=item $self->get_containers( $namespace )
+=head2 $self->get_containers( $namespace )
+
+Return all the action containers for a given namespace, inclusive
 
 =cut
 
@@ -281,7 +339,11 @@ sub get_containers {
     return map { $_->getNodeValue } @match;
 }
 
-=item $self->register( $c, $action )
+=head2 $self->register( $c, $action )
+
+Make sure all required dispatch types for this action are loaded, then
+pass the action to our dispatch types so they can register it if required.
+Also, set up the tree with the action containers.
 
 =cut
 
@@ -341,7 +403,8 @@ sub register {
     $parent->getNodeValue->actions->{ $action->name } = $action;
 }
 
-=item $self->setup_actions( $class, $component )
+=head2 $self->setup_actions( $class, $context )
+
 
 =cut
 
@@ -354,8 +417,8 @@ sub setup_actions {
     $self->action_container_class('Catalyst::ActionContainer');
 
     # Preload action types
-    for my $type (@PRELOAD) {
-        my $class = "Catalyst::DispatchType::$type";
+    for my $type ( @{$self->preload_dispatch_types} ) {
+        my $class = ($type =~ /^\+(.*)$/) ? $1 : "Catalyst::DispatchType::${type}";
         eval "require $class";
         Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
           if $@;
@@ -373,8 +436,8 @@ sub setup_actions {
     }
 
     # Postload action types
-    for my $type (@POSTLOAD) {
-        my $class = "Catalyst::DispatchType::$type";
+    for my $type ( @{$self->postload_dispatch_types} ) {
+        my $class = ($type =~ /^\+(.*)$/) ? $1 : "Catalyst::DispatchType::${type}";
         eval "require $class";
         Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
           if $@;
@@ -416,8 +479,6 @@ sub setup_actions {
     $_->list($c) for @{ $self->dispatch_types };
 }
 
-=back
-
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@cpan.org>