nicer action sorting for Path

[catagits/Catalyst-Runtime.git] / lib / Catalyst / DispatchType / Path.pm

diff --git a/lib/Catalyst/DispatchType/Path.pm b/lib/Catalyst/DispatchType/Path.pm
index 64bc477..50fbf84 100644 (file)
--- a/lib/Catalyst/DispatchType/Path.pm
+++ b/lib/Catalyst/DispatchType/Path.pm
@@ -1,47 +1,81 @@
 package Catalyst::DispatchType::Path;
 
-use strict;
-use base qw/Catalyst::DispatchType/;
+use Moose;
+extends 'Catalyst::DispatchType';
+
 use Text::SimpleTable;
+use Catalyst::Utils;
 use URI;
 
+has _paths => (
+               is => 'rw',
+               isa => 'HashRef',
+               required => 1,
+               default => sub { +{} },
+              );
+
+no Moose;
+
 =head1 NAME
 
 Catalyst::DispatchType::Path - Path DispatchType
 
 =head1 SYNOPSIS
 
-See L<Catalyst>.
+See L<Catalyst::DispatchType>.
 
 =head1 DESCRIPTION
 
+Dispatch type managing full path matching behaviour.  For more information on
+dispatch types, see:
+
+=over 4
+
+=item * L<Catalyst::Manual::Intro> for how they affect application authors
+
+=item * L<Catalyst::DispatchType> for implementation information.
+
+=back
+
 =head1 METHODS
 
 =head2 $self->list($c)
 
+Debug output for Path dispatch points
+
 =cut
 
 sub list {
     my ( $self, $c ) = @_;
-    my $paths = Text::SimpleTable->new( [ 36, 'Path' ], [ 37, 'Private' ] );
-    for my $path ( sort keys %{ $self->{paths} } ) {
-        my $action = $self->{paths}->{$path};
-        $path = "/$path" unless $path eq '/';
-        $paths->row( "$path", "/$action" );
+    my $column_width = Catalyst::Utils::term_width() - 35 - 9;
+    my $paths = Text::SimpleTable->new(
+       [ 35, 'Path' ], [ $column_width, 'Private' ]
+    );
+    foreach my $path ( sort keys %{ $self->_paths } ) {
+        my $display_path = $path eq '/' ? $path : "/$path";
+        foreach my $action ( @{ $self->_paths->{$path} } ) {
+            $paths->row( $display_path, "/$action" );
+        }
     }
-    $c->log->debug( "Loaded Path actions:\n" . $paths->draw )
-      if ( keys %{ $self->{paths} } );
+    $c->log->debug( "Loaded Path actions:\n" . $paths->draw . "\n" )
+      if ( keys %{ $self->_paths } );
 }
 
 =head2 $self->match( $c, $path )
 
+For each action registered to this exact path, offers the action a chance to
+match the path (in the order in which they were registered). Succeeds on the
+first action that matches, if any; if not, returns 0.
+
 =cut
 
 sub match {
     my ( $self, $c, $path ) = @_;
 
-    $path ||= '/';
-    if ( my $action = $self->{paths}->{$path} ) {
+    $path = '/' if !defined $path || !length $path;
+
+    foreach my $action ( @{ $self->_paths->{$path} || [] } ) {
+        next unless $action->match($c);
         $c->req->action($path);
         $c->req->match($path);
         $c->action($action);
@@ -54,42 +88,25 @@ sub match {
 
 =head2 $self->register( $c, $action )
 
+Calls register_path for every Path attribute for the given $action.
+
 =cut
 
 sub register {
     my ( $self, $c, $action ) = @_;
 
-    my $attrs = $action->attributes;
-    my @register;
-
-    foreach my $r ( @{ $attrs->{Path} || [] } ) {
-        unless ($r) {
-            $r = $action->namespace;
-            $r = '/' unless length $r;
-        }
-        elsif ( $r !~ m!^/! ) {    # It's a relative path
-            $r = $action->namespace . "/$r";
-        }
-        push( @register, $r );
-    }
-
-    if ( $attrs->{Global} || $attrs->{Absolute} ) {
-        push( @register, $action->name );    # Register sub name against root
-    }
-
-    if ( $attrs->{Local} || $attrs->{Relative} ) {
-        push( @register, join( '/', $action->namespace, $action->name ) );
-
-        # Register sub name as a relative path
-    }
+    my @register = @{ $action->attributes->{Path} || [] };
 
     $self->register_path( $c, $_, $action ) for @register;
+
     return 1 if @register;
     return 0;
 }
 
 =head2 $self->register_path($c, $path, $action)
 
+Registers an action at a given path.
+
 =cut
 
 sub register_path {
@@ -97,19 +114,48 @@ sub register_path {
     $path =~ s!^/!!;
     $path = '/' unless length $path;
     $path = URI->new($path)->canonical;
-    $self->{paths}{$path} = $action;
+
+    unshift( @{ $self->_paths->{$path} ||= [] }, $action);
+
+    $self->_paths->{$path} = [ sort @{ $self->_paths->{$path} } ];
+
+    return 1;
+}
+
+=head2 $self->uri_for_action($action, $captures)
+
+get a URI part for an action; always returns undef is $captures is set
+since Path actions don't have captures
+
+=cut
+
+sub uri_for_action {
+    my ( $self, $action, $captures ) = @_;
+
+    return undef if @$captures;
+
+    if (my $paths = $action->attributes->{Path}) {
+        my $path = $paths->[0];
+        $path = '/' unless length($path);
+        $path = "/${path}" unless ($path =~ m/^\//);
+        $path = URI->new($path)->canonical;
+        return $path;
+    } else {
+        return undef;
+    }
 }
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Matt S Trout
-Sebastian Riedel, C<sri@cpan.org>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT
 
-This program is free software, you can redistribute it and/or modify it under
+This library is free software. You can redistribute it and/or modify it under
 the same terms as Perl itself.
 
 =cut
 
+__PACKAGE__->meta->make_immutable;
+
 1;