Initial support for :Args attribute
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Dispatcher.pm
index cd56ad4..858c1ec 100644 (file)
@@ -8,20 +8,23 @@ use Catalyst::Action;
 use Catalyst::ActionContainer;
 use Catalyst::DispatchType::Default;
 use Catalyst::DispatchType::Index;
-use Text::ASCIITable;
+use Text::SimpleTable;
 use Tree::Simple;
 use Tree::Simple::Visitor::FindByPath;
 
 # Stringify to class
 use overload '""' => sub { return ref shift }, fallback => 1;
 
-__PACKAGE__->mk_accessors(qw/tree dispatch_types/);
+__PACKAGE__->mk_accessors(
+    qw/tree dispatch_types registered_dispatch_types
+      method_action_class action_container_class/
+);
 
 # 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
 
@@ -35,9 +38,7 @@ See L<Catalyst>.
 
 =head1 METHODS
 
-=over 4
-
-=item $self->detach( $c, $command [, \@arguments ] )
+=head2 $self->detach( $c, $command [, \@arguments ] )
 
 =cut
 
@@ -47,15 +48,14 @@ sub detach {
     die $Catalyst::DETACH;
 }
 
-=item $self->dispatch($c)
+=head2 $self->dispatch($c)
 
 =cut
 
 sub dispatch {
     my ( $self, $c ) = @_;
-
     if ( $c->action ) {
-        $c->forward( join( '/', '', $c->namespace, '_DISPATCH' ) );
+        $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) );
     }
 
     else {
@@ -68,7 +68,7 @@ sub dispatch {
     }
 }
 
-=item $self->forward( $c, $command [, \@arguments ] )
+=head2 $self->forward( $c, $command [, \@arguments ] )
 
 =cut
 
@@ -82,43 +82,50 @@ sub forward {
         return 0;
     }
 
-    # Relative forwards from detach
-    my $caller = ( caller(1) )[0]->isa('Catalyst::Dispatcher')
-      && ( ( caller(2) )[3] =~ /::detach$/ ) ? caller(3) : caller(1);
-
-    my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args;
+    my $local_args = 0;
+    my $arguments  = $c->req->args;
+    if ( ref( $_[-1] ) eq 'ARRAY' ) {
+        $arguments  = pop(@_);
+        $local_args = 1;
+    }
 
     my $result;
 
-    my $command_copy = $command;
+    unless ( ref $command ) {
+        my $command_copy = $command;
 
-    unless ( $command_copy =~ s/^\/// ) {
-        my $namespace =
-          Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} )
-          || '';
-        $command_copy = "${namespace}/${command}";
-    }
+        unless ( $command_copy =~ s/^\/// ) {
+            my $namespace = $c->stack->[-1]->namespace;
+            $command_copy = "${namespace}/${command}";
+        }
 
-    unless ( $command_copy =~ /\// ) {
-        $result = $c->get_action( $command_copy, '/' );
-    }
-    else {
-        my @extra_args;
-      DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) {
-            my $tail = $2;
-            $result = $c->get_action( $tail, $1 );
-            if ( $result ) {
-                $command = $tail;
-                push( @{$arguments}, @extra_args );
-                last DESCEND;
+        unless ( $command_copy =~ /\// ) {
+            $result = $c->get_action( $command_copy, '/' );
+        }
+        else {
+            my @extra_args;
+          DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) {
+                my $tail = $2;
+                $result = $c->get_action( $tail, $1 );
+                if ($result) {
+                    $local_args = 1;
+                    $command    = $tail;
+                    unshift( @{$arguments}, @extra_args );
+                    last DESCEND;
+                }
+                unshift( @extra_args, $tail );
             }
-            unshift( @extra_args, $tail );
         }
     }
 
-    unless ( $result ) {
+    unless ($result) {
+
+        my $class = ref($command)
+          || ref( $c->component($command) )
+          || $c->component($command);
+        my $method = shift || 'process';
 
-        unless ( $c->components->{$command} ) {
+        unless ($class) {
             my $error =
 qq/Couldn't forward to command "$command". Invalid action or component./;
             $c->error($error);
@@ -126,17 +133,16 @@ qq/Couldn't forward to command "$command". Invalid action or component./;
             return 0;
         }
 
-        my $class  = $command;
-        my $method = shift || 'process';
-
-        if ( my $code = $c->components->{$class}->can($method) ) {
-            my $action = Catalyst::Action->new(
+        if ( my $code = $class->can($method) ) {
+            my $action = $self->method_action_class->new(
                 {
                     name      => $method,
                     code      => $code,
                     reverse   => "$class->$method",
                     class     => $class,
-                    namespace => $class,
+                    namespace => Catalyst::Utils::class2prefix(
+                        $class, $c->config->{case_sensitive}
+                    ),
                 }
             );
             $result = $action;
@@ -153,14 +159,16 @@ qq/Couldn't forward to command "$command". Invalid action or component./;
 
     }
 
-    local $c->request->{arguments} = [ @{$arguments} ];
-
-    $result->execute($c);
+    if ($local_args) {
+        local $c->request->{arguments} = [ @{$arguments} ];
+        $result->execute($c);
+    }
+    else { $result->execute($c) }
 
     return $c->state;
 }
 
-=item $self->prepare_action($c)
+=head2 $self->prepare_action($c)
 
 =cut
 
@@ -170,12 +178,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
@@ -185,36 +194,38 @@ 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 . '"' )
+      if ( $c->debug && $c->req->match );
+
     $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
       if ( $c->debug && @args );
 }
 
-=item $self->get_action( $c, $action, $namespace )
+=head2 $self->get_action( $action, $namespace )
 
 =cut
 
 sub get_action {
-    my ( $self, $c, $action, $namespace ) = @_;
-    return [] unless $action;
+    my ( $self, $name, $namespace ) = @_;
+    return unless $name;
     $namespace ||= '';
     $namespace = '' if $namespace eq '/';
 
     my @match = $self->get_containers($namespace);
 
-    my $node = $match[-1]->actions;    # Only bother looking at the last one
+    return unless @match;
 
-    if ( defined $node->{$action}
-        && ( $node->{$action}->namespace eq $namespace ) )
-    {
-        return $node->{$action};
+    if ( my $action = $match[-1]->get_action($name) ) {
+        return $action if $action->namespace eq $namespace;
     }
 }
 
-=item $self->get_actions( $c, $action, $namespace )
+=head2 $self->get_actions( $c, $action, $namespace )
 
 =cut
 
@@ -226,14 +237,10 @@ sub get_actions {
 
     my @match = $self->get_containers($namespace);
 
-    return
-        map    { $_->{$action} }
-          grep { defined $_->{$action} }    # If it exists in the container
-          map  { $_->actions }              # Get action hash for container
-          @match
+    return map { $_->get_action($action) } @match;
 }
 
-=item $self->get_containers( $namespace )
+=head2 $self->get_containers( $namespace )
 
 =cut
 
@@ -265,63 +272,47 @@ sub get_containers {
         # should catch any failures - or short-circuit this if this *is* a
         # bug in the visitor and gets fixed.
 
-        my $extra = $path[ ( scalar @match ) - 1 ];
-        last unless $extra;
-        $visitor->setSearchPath($extra);
-        $match[-1]->accept($visitor);
-        push( @match, $visitor->getResult ) if defined $visitor->getResult;
+        if ( my $extra = $path[ ( scalar @match ) - 1 ] ) {
+            $visitor->setSearchPath($extra);
+            $match[-1]->accept($visitor);
+            push( @match, $visitor->getResult ) if defined $visitor->getResult;
+        }
     }
 
     return map { $_->getNodeValue } @match;
 }
 
-=item $self->set_action( $c, $action, $code, $class, $attrs )
+=head2 $self->register( $c, $action )
 
 =cut
 
-sub set_action {
-    my ( $self, $c, $method, $code, $class, $attrs ) = @_;
-
-    my $namespace =
-      Catalyst::Utils::class2prefix( $class, $c->config->{case_sensitive} )
-      || '';
-    my %attributes;
-
-    for my $attr ( @{$attrs} ) {
-
-        # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
-
-        my %initialized;
-        $initialized{ ref $_ }++ for @{ $self->dispatch_types };
+sub register {
+    my ( $self, $c, $action ) = @_;
 
-        if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/ ) ) {
+    my $registered = $self->registered_dispatch_types;
 
-            # Initialize types
-            my $class = "Catalyst::DispatchType::$key";
-            unless ( $initialized{$class} ) {
-                eval "require $class";
-                push( @{ $self->dispatch_types }, $class->new ) unless $@;
-                $initialized{$class}++;
-            }
-
-            if ( defined $value ) {
-                ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
-            }
-            push( @{ $attributes{$key} }, $value );
+    my $priv = 0;
+    foreach my $key ( keys %{ $action->attributes } ) {
+        $priv++ if $key eq 'Private';
+        my $class = "Catalyst::DispatchType::$key";
+        unless ( $registered->{$class} ) {
+            eval "require $class";
+            push( @{ $self->dispatch_types }, $class->new ) unless $@;
+            $registered->{$class} = 1;
         }
     }
 
-    if ( $attributes{Private} && ( keys %attributes > 1 ) ) {
-        $c->log->debug( 'Bad action definition "'
-              . join( ' ', @{$attrs} )
-              . qq/" for "$class->$method"/ )
-          if $c->debug;
-        return;
+    # Pass the action to our dispatch types so they can register it if reqd.
+    my $reg = 0;
+    foreach my $type ( @{ $self->dispatch_types } ) {
+        $reg++ if $type->register( $c, $action );
     }
-    return unless keys %attributes;
 
-    my $parent  = $self->tree;
-    my $visitor = Tree::Simple::Visitor::FindByPath->new;
+    return unless $reg + $priv;
+
+    my $namespace = $action->namespace;
+    my $parent    = $self->tree;
+    my $visitor   = Tree::Simple::Visitor::FindByPath->new;
 
     if ($namespace) {
         for my $part ( split '/', $namespace ) {
@@ -347,29 +338,11 @@ sub set_action {
         }
     }
 
-    my $reverse = $namespace ? "$namespace/$method" : $method;
-
-    my $action = Catalyst::Action->new(
-        {
-            name       => $method,
-            code       => $code,
-            reverse    => $reverse,
-            namespace  => $namespace,
-            class      => $class,
-            attributes => \%attributes,
-        }
-    );
-
     # Set the method value
-    $parent->getNodeValue->actions->{$method} = $action;
-
-    # Pass the action to our dispatch types so they can register it if reqd.
-    foreach my $type ( @{ $self->dispatch_types } ) {
-        $type->register( $c, $action );
-    }
+    $parent->getNodeValue->actions->{ $action->name } = $action;
 }
 
-=item $self->setup_actions( $class, $component )
+=head2 $self->setup_actions( $class, $component )
 
 =cut
 
@@ -377,6 +350,9 @@ sub setup_actions {
     my ( $self, $c ) = @_;
 
     $self->dispatch_types( [] );
+    $self->registered_dispatch_types( {} );
+    $self->method_action_class('Catalyst::Action');
+    $self->action_container_class('Catalyst::ActionContainer');
 
     # Preload action types
     for my $type (@PRELOAD) {
@@ -385,6 +361,7 @@ sub setup_actions {
         Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
           if $@;
         push @{ $self->dispatch_types }, $class->new;
+        $self->registered_dispatch_types->{$class} = 1;
     }
 
     # We use a tree
@@ -392,37 +369,8 @@ sub setup_actions {
       Catalyst::ActionContainer->new( { part => '/', actions => {} } );
     $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
 
-    for my $comp ( keys %{ $c->components } ) {
-
-        # We only setup components that inherit from Catalyst::Base
-        next unless $comp->isa('Catalyst::Base');
-
-        for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) {
-            my ( $code, $attrs ) = @{$action};
-            my $name = '';
-            no strict 'refs';
-            my @cache = ( $comp, @{"$comp\::ISA"} );
-            my %classes;
-
-            while ( my $class = shift @cache ) {
-                $classes{$class}++;
-                for my $isa ( @{"$class\::ISA"} ) {
-                    next if $classes{$isa};
-                    push @cache, $isa;
-                    $classes{$isa}++;
-                }
-            }
-
-            for my $class ( keys %classes ) {
-                for my $sym ( values %{ $class . '::' } ) {
-                    if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
-                        $name = *{$sym}{NAME};
-                        $self->set_action( $c, $name, $code, $comp, $attrs );
-                        last;
-                    }
-                }
-            }
-        }
+    foreach my $comp ( values %{ $c->components } ) {
+        $comp->register_actions($c) if $comp->can('register_actions');
     }
 
     # Postload action types
@@ -436,11 +384,13 @@ sub setup_actions {
 
     return unless $c->debug;
 
-    my $privates = Text::ASCIITable->new;
-    $privates->setCols( 'Private', 'Class' );
-    $privates->setColWidth( 'Private', 36, 1 );
-    $privates->setColWidth( 'Class',   37, 1 );
+    my $privates = Text::SimpleTable->new(
+        [ 20, 'Private' ],
+        [ 38, 'Class' ],
+        [ 12, 'Method' ]
+    );
 
+    my $has_private = 0;
     my $walker = sub {
         my ( $walker, $parent, $prefix ) = @_;
         $prefix .= $parent->getNodeValue || '';
@@ -452,7 +402,8 @@ sub setup_actions {
             next
               if ( ( $action =~ /^_.*/ )
                 && ( !$c->config->{show_internal_actions} ) );
-            $privates->addRow( "$prefix$action", $action_obj->class );
+            $privates->row( "$prefix$action", $action_obj->class, $action );
+            $has_private = 1;
         }
 
         $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
@@ -460,17 +411,16 @@ sub setup_actions {
 
     $walker->( $walker, $self->tree, '' );
     $c->log->debug( "Loaded Private actions:\n" . $privates->draw )
-      if ( @{ $privates->{tbl_rows} } );
+      if ($has_private);
 
     # List all public actions
     $_->list($c) for @{ $self->dispatch_types };
 }
 
-=back
-
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@cpan.org>
+Matt S Trout, C<mst@shadowcatsystems.co.uk>
 
 =head1 COPYRIGHT