- Start of DispatchType refactor
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Dispatcher.pm
index 02b3122..36493ec 100644 (file)
@@ -6,6 +6,8 @@ use Catalyst::Exception;
 use Catalyst::Utils;
 use Catalyst::Action;
 use Catalyst::ActionContainer;
+use Catalyst::DispatchType::Regex;
+use Catalyst::DispatchType::Default;
 use Text::ASCIITable;
 use Tree::Simple;
 use Tree::Simple::Visitor::FindByPath;
@@ -13,7 +15,7 @@ use Tree::Simple::Visitor::FindByPath;
 # Stringify to class
 use overload '""' => sub { return ref shift }, fallback => 1;
 
-__PACKAGE__->mk_accessors(qw/actions tree/);
+__PACKAGE__->mk_accessors(qw/actions tree dispatch_types/);
 
 =head1 NAME
 
@@ -45,40 +47,32 @@ sub detach {
 
 sub dispatch {
     my ( $self, $c ) = @_;
-    my $action    = $c->req->action;
-    my $namespace = '';
-    $namespace = ( join( '/', @{ $c->req->args } ) || '/' )
-      if $action eq 'default';
-
-    unless ($namespace) {
-        if ( my $result = $c->get_action($action) ) {
-            $namespace = $result->[0]->[0]->prefix;
-        }
-    }
 
-    my $default = $action eq 'default' ? $namespace : undef;
-    my $results = $c->get_action( $action, $default, $default ? 1 : 0 );
-    $namespace ||= '/';
-
-    my @containers = $self->get_containers( $namespace );
-    my %actions;
-    foreach my $name (qw/begin auto end/) {
-        $actions{$name} = [
-            map { $_->{$name} }
-            grep { exists $_->{$name} }
-            map { $_->actions }
-            @containers
-        ];
-    }
+    if ( $c->action ) {
+
+        my @containers = $self->get_containers( $c->namespace );
+        my %actions;
+        foreach my $name (qw/begin auto end/) {
 
-    if ( @{$results} ) {
+            # Go down the container list representing each part of the
+            # current namespace inheritance tree, grabbing the actions hash
+            # of the ActionContainer object and looking for actions of the
+            # appropriate name registered to the namespace
+
+            $actions{$name} = [
+                map { $_->{$name} }
+                grep { exists $_->{$name} }
+                map { $_->actions }
+                @containers
+            ];
+        }
 
         # Errors break the normal flow and the end action is instantly run
         my $error = 0;
 
         # Execute last begin
         $c->state(1);
-        if ( my $begin = @{ $actions{begin}  }[-1] ) {
+        if ( my $begin = @{ $actions{begin} }[-1] ) {
             $begin->execute($c);
             $error++ if scalar @{ $c->error };
         }
@@ -95,14 +89,10 @@ sub dispatch {
 
         # Execute the action or last default
         my $mkay = $autorun ? $c->state ? 1 : 0 : 1;
-        if ( ( my $action = $c->req->action ) && $mkay ) {
+        if ( $mkay ) {
             unless ($error) {
-                if ( my $result =
-                    @{ $c->get_action( $action, $default, 1 ) }[-1] )
-                {
-                    $result->[0]->execute($c);
-                    $error++ if scalar @{ $c->error };
-                }
+                $c->action->execute($c);
+                $error++ if scalar @{ $c->error };
             }
         }
 
@@ -226,7 +216,7 @@ sub prepare_action {
     my @path = split /\//, $c->req->path;
     $c->req->args( \my @args );
 
-    while (@path) {
+  DESCEND: while (@path) {
         $path = join '/', @path;
         if ( my $result = ${ $c->get_action($path) }[0] ) {
 
@@ -250,14 +240,19 @@ sub prepare_action {
             }
 
             $c->req->match($path);
-            last;
+            $c->action($result->[0]);
+            $c->namespace($result->[0]->prefix);
+            last DESCEND;
         }
-        unshift @args, pop @path;
-    }
 
-    unless ( $c->req->action ) {
-        $c->req->action('default');
-        $c->req->match('');
+        unless ( $c->action ) {
+            foreach my $type (@{$self->dispatch_types}) {
+                last DESCEND if $type->prepare_action($c, $path);
+                #last DESCEND if $c->action;
+            }
+        }
+
+        unshift @args, pop @path;
     }
 
     $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
@@ -288,21 +283,21 @@ sub get_action {
     }
 
     elsif ( my $p = $self->actions->{plain}->{$action} ) { return [ [$p] ] }
-    elsif ( my $r = $self->actions->{regex}->{$action} ) { return [ [$r] ] }
+    #elsif ( my $r = $self->actions->{regex}->{$action} ) { return [ [$r] ] }
 
-    else {
+    #else {
 
-        for my $i ( 0 .. $#{ $self->actions->{compiled} } ) {
-            my $name  = $self->actions->{compiled}->[$i]->[0];
-            my $regex = $self->actions->{compiled}->[$i]->[1];
+    #    for my $i ( 0 .. $#{ $self->actions->{compiled} } ) {
+    #        my $name  = $self->actions->{compiled}->[$i]->[0];
+    #        my $regex = $self->actions->{compiled}->[$i]->[1];
 
-            if ( my @snippets = ( $action =~ $regex ) ) {
-                return [
-                    [ $self->actions->{regex}->{$name}, $name, \@snippets ] ];
-            }
+    #        if ( my @snippets = ( $action =~ $regex ) ) {
+    #            return [
+    #                [ $self->actions->{regex}->{$name}, $name, \@snippets ] ];
+    #        }
 
-        }
-    }
+    #    }
+    #}
     return [];
 }
 
@@ -313,8 +308,13 @@ sub get_action {
 sub get_containers {
     my ( $self, $namespace ) = @_;
 
+    # If the namespace is / just return the root ActionContainer
+
     return ($self->tree->getNodeValue) if $namespace eq '/';
 
+    # Use a visitor to recurse down the tree finding the ActionContainers
+    # for each namespace in the chain.
+
     my $visitor = Tree::Simple::Visitor::FindByPath->new;
     my @path = split('/', $namespace);
     $visitor->setSearchPath( @path );
@@ -324,6 +324,14 @@ sub get_containers {
     @match = ($self->tree) unless @match;
 
     if (!defined $visitor->getResult) {
+
+        # If we don't manage to match, the visitor doesn't return the last
+        # node is matched, so foo/bar/baz would only find the 'foo' node,
+        # not the foo and foo/bar nodes as it should. This does another
+        # single-level search to see if that's the case, and the 'last unless'
+        # 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);
@@ -345,6 +353,7 @@ sub set_action {
       Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} )
       || '';
     my %flags;
+    my %attributes;
 
     for my $attr ( @{$attrs} ) {
         if    ( $attr =~ /^(Local|Relative)$/ )    { $flags{local}++ }
@@ -356,6 +365,12 @@ sub set_action {
         elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) {
             push @{ $flags{regex} }, $2;
         }
+        if ( my ($key, $value) = ($attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/) ) {
+            if ( defined $value ) {
+                ($value =~ s/^'(.*)'$/$1/) || ($value =~ s/^"(.*)"/$1/);
+            }
+            push(@{$attributes{$key}}, $value);
+        }
     }
 
     if ( $flags{private} && ( keys %flags > 1 ) ) {
@@ -377,6 +392,10 @@ sub set_action {
             my $child = $visitor->getResult;
     
             unless ($child) {
+
+                # Create a new tree node and an ActionContainer to form
+                # its value.
+
                 my $container = Catalyst::ActionContainer->new(
                                     { part => $part, actions => {} });
                 $child = $parent->addChild( Tree::Simple->new($container) );
@@ -393,13 +412,15 @@ sub set_action {
 
     my $action = Catalyst::Action->new(
         {
-            code      => $code,
-            reverse   => $reverse,
-            namespace => $namespace,
-            prefix    => $prefix,
+            code       => $code,
+            reverse    => $reverse,
+            namespace  => $namespace,
+            prefix     => $prefix,
+            attributes => \%attributes,
         }
     );
 
+    # Set the method value
     $parent->getNodeValue->actions->{$method} = $action;
 
     my @path;
@@ -439,6 +460,10 @@ sub set_action {
         push @{ $self->actions->{compiled} }, [ $regex, qr#$regex# ];
         $self->actions->{regex}->{$regex} = $action;
     }
+
+    foreach my $type ( @{ $self->dispatch_types } ) {
+        $type->register_action($c, $action);
+    }
 }
 
 =item $self->setup_actions( $class, $component )
@@ -458,6 +483,10 @@ sub setup_actions {
         }
     );
 
+    $self->dispatch_types([
+        map { "Catalyst::DispatchType::$_"->new }
+            qw/Regex Default/ ]);
+
     # We use a tree
     my $container = Catalyst::ActionContainer->new(
                         { part => '/', actions => {} } );