added docs for engine/dispatcher
[catagits/Catalyst-Runtime.git] / lib / Catalyst / DispatchType / Path.pm
index bec5b1c..d887a13 100644 (file)
@@ -2,7 +2,8 @@ package Catalyst::DispatchType::Path;
 
 use strict;
 use base qw/Catalyst::DispatchType/;
-use Text::ASCIITable;
+use Text::SimpleTable;
+use URI;
 
 =head1 NAME
 
@@ -16,78 +17,77 @@ See L<Catalyst>.
 
 =head1 METHODS
 
-=over 4
+=head2 $self->list($c)
 
-=item $self->list($c)
+Debug output for Path dispatch points
 
 =cut
 
 sub list {
     my ( $self, $c ) = @_;
-    my $paths = Text::ASCIITable->new;
-    $paths->setCols( 'Public', 'Private' );
-    $paths->setColWidth( 'Public',  36, 1 );
-    $paths->setColWidth( 'Private', 37, 1 );
+    my $paths = Text::SimpleTable->new( [ 36, 'Path' ], [ 37, 'Private' ] );
     for my $path ( sort keys %{ $self->{paths} } ) {
         my $action = $self->{paths}->{$path};
-        $paths->addRow( "/$path", "/$action" );
+        $path = "/$path" unless $path eq '/';
+        $paths->row( "$path", "/$action" );
     }
     $c->log->debug( "Loaded Path actions:\n" . $paths->draw )
-      if ( @{ $paths->{tbl_rows} } );
+      if ( keys %{ $self->{paths} } );
 }
 
-=item $self->match( $c, $path )
+=head2 $self->match( $c, $path )
+
+Check for paths that match the given path.
 
 =cut
 
 sub match {
     my ( $self, $c, $path ) = @_;
 
+    $path ||= '/';
     if ( my $action = $self->{paths}->{$path} ) {
+        return 0 unless $action->match($c);
         $c->req->action($path);
         $c->req->match($path);
         $c->action($action);
-        $c->namespace( $action->prefix );
+        $c->namespace( $action->namespace );
         return 1;
     }
 
     return 0;
 }
 
-=item $self->register( $c, $action )
+=head2 $self->register( $c, $action )
+
+Call register_path for every path attribute in the given $action.
 
 =cut
 
 sub register {
     my ( $self, $c, $action ) = @_;
 
-    my $attrs = $action->attributes;
-    my @register;
+    my @register = @{ $action->attributes->{Path} || [] };
 
-    foreach my $r ( @{ $attrs->{Path} || [] } ) {
-        unless ( $r =~ m!^/! ) {    # It's a relative path
-            $r = $action->prefix . "/$r";
-        }
-        push( @register, $r );
-    }
+    $self->register_path( $c, $_, $action ) for @register;
 
-    if ( $attrs->{Global} || $attrs->{Absolute} ) {
-        push( @register, $action->name );    # Register sub name against root
-    }
+    return 1 if @register;
+    return 0;
+}
 
-    if ( $attrs->{Local} || $attrs->{Relative} ) {
-        push( @register, join( '/', $action->prefix, $action->name ) );
+=head2 $self->register_path($c, $path, $action)
 
-        # Register sub name as a relative path
-    }
+register an action at a given path.
 
-    foreach my $r (@register) {
-        $r =~ s!^/!!;
-        $self->{paths}{$r} = $action;
-    }
-}
+=cut
+
+sub register_path {
+    my ( $self, $c, $path, $action ) = @_;
+    $path =~ s!^/!!;
+    $path = '/' unless length $path;
+    $path = URI->new($path)->canonical;
 
-=back
+    $self->{paths}{$path} = $action;
+}
 
 =head1 AUTHOR