extended uri_for, added uri_for_action to dispatcher

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

diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm
index 391fefc..f44b9db 100644 (file)
--- a/lib/Catalyst/Dispatcher.pm
+++ b/lib/Catalyst/Dispatcher.pm
@@ -11,6 +11,7 @@ use Catalyst::DispatchType::Index;
 use Text::SimpleTable;
 use Tree::Simple;
 use Tree::Simple::Visitor::FindByPath;
+use Scalar::Util ();
 
 # Stringify to class
 use overload '""' => sub { return ref shift }, fallback => 1;
@@ -133,19 +134,33 @@ Documented in L<Catalyst>
 =cut
 
 sub forward {
-    my ( $self, $c, $command ) = splice( @_, 0, 3 );
+    my ( $self, $c, $command, @extra_params ) = @_;
 
     unless ($command) {
         $c->log->debug('Nothing to forward to') if $c->debug;
         return 0;
     }
 
-    my $args = [ @{ $c->request->arguments } ];
+    my @args;
+    
+    if ( ref( $extra_params[-1] ) eq 'ARRAY' ) {
+        @args = @{ pop @extra_params }
+    } else {
+        # this is a copy, it may take some abuse from ->_invoke_as_path if the path had trailing parts
+        @args = @{ $c->request->arguments };
+    }
 
-    @$args = @{ pop @_ } if ( ref( $_[-1] ) eq 'ARRAY' );
+    my $action;
+
+    # forward to a string path ("/foo/bar/gorch") or action object which stringifies to that
+    $action = $self->_invoke_as_path( $c, "$command", \@args );
+
+    # forward to a component ( "MyApp::*::Foo" or $c->component("...") - a path or an object)
+    unless ($action) {
+        my $method = @extra_params ? $extra_params[0] : "process";
+        $action = $self->_invoke_as_component( $c, $command, $method );
+    }
 
-    my $action = $self->_invoke_as_path( $c, $command, $args )
-      || $self->_invoke_as_component( $c, $command, shift );
 
     unless ($action) {
         my $error =
@@ -158,8 +173,8 @@ sub forward {
 
     #push @$args, @_;
 
-    local $c->request->{arguments} = $args;
-    $action->execute($c);
+    local $c->request->{arguments} = \@args;
+    $action->dispatch( $c );
 
     return $c->state;
 }
@@ -179,8 +194,6 @@ sub _action_rel2abs {
 sub _invoke_as_path {
     my ( $self, $c, $rel_path, $args ) = @_;
 
-    return if ref $rel_path;    # it must be a string
-
     my $path = $self->_action_rel2abs( $c, $rel_path );
 
     my ( $tail, @extra_args );
@@ -212,7 +225,6 @@ sub _invoke_as_component {
     my ( $self, $c, $component, $method ) = @_;
 
     my $class = $self->_find_component_class( $c, $component ) || return 0;
-    $method ||= "process";
 
     if ( my $code = $class->can($method) ) {
         return $self->method_action_class->new(
@@ -286,12 +298,25 @@ returns a named action from a given namespace.
 sub get_action {
     my ( $self, $name, $namespace ) = @_;
     return unless $name;
-    $namespace ||= '';
-    $namespace = '' if $namespace eq '/';
+
+    $namespace = join( "/", grep { length } split '/', $namespace || "" );
 
     return $self->action_hash->{"$namespace/$name"};
 }
 
+=head2 $self->get_action_by_path( $path ); 
+   
+Returns the named action by its full path. 
+
+=cut 
+
+sub get_action_by_path {
+    my ( $self, $path ) = @_;
+    $path =~ s/^\///;
+    $path = "/$path" unless $path =~ /\//;
+    $self->action_hash->{$path};
+}
+
 =head2 $self->get_actions( $c, $action, $namespace )
 
 =cut
@@ -299,8 +324,8 @@ sub get_action {
 sub get_actions {
     my ( $self, $c, $action, $namespace ) = @_;
     return [] unless $action;
-    $namespace ||= '';
-    $namespace = '' if $namespace eq '/';
+
+    $namespace = join( "/", grep { length } split '/', $namespace || "" );
 
     my @match = $self->get_containers($namespace);
 
@@ -320,15 +345,38 @@ sub get_containers {
 
     my @containers;
 
-    do {
-        push @containers, $self->container_hash->{$namespace};
-    } while ( $namespace =~ s#/[^/]+$## );
+    if ( length $namespace ) {
+        do {
+            push @containers, $self->container_hash->{$namespace};
+        } while ( $namespace =~ s#/[^/]+$## );
+    }
 
     return reverse grep { defined } @containers, $self->container_hash->{''};
 
     my @parts = split '/', $namespace;
 }
 
+=head2 $self->uri_for_action($action, \@captures)
+
+Takes a Catalyst::Action object and action parameters and returns a URI
+part such that if $c->req->path were this URI part, this action would be
+dispatched to with $c->req->captures set to the supplied arrayref.
+
+If the action object is not available for external dispatch or the dispatcher
+cannot determine an appropriate URI, this method will return undef.
+
+=cut
+
+sub uri_for_action {
+    my ( $self, $action, $captures) = @_;
+    $captures ||= [];
+    foreach my $dispatch_type ( @{ $self->dispatch_types } ) {
+        my $uri = $dispatch_type->uri_for_action( $action, $captures );
+        return $uri if defined($uri);
+    }
+    return undef;
+}
+
 =head2 $self->register( $c, $action )
 
 Make sure all required dispatch types for this action are loaded, then
@@ -428,7 +476,7 @@ sub setup_actions {
 
     my $privates = Text::SimpleTable->new(
         [ 20, 'Private' ],
-        [ 38, 'Class' ],
+        [ 36, 'Class' ],
         [ 12, 'Method' ]
     );