- Added a bunch of comments to new dispatcher code
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Dispatcher.pm
index ea9a550..32a60a0 100644 (file)
@@ -6,6 +6,9 @@ use Catalyst::Exception;
 use Catalyst::Utils;
 use Catalyst::Action;
 use Catalyst::ActionContainer;
+use Catalyst::DispatchType::Path;
+use Catalyst::DispatchType::Regex;
+use Catalyst::DispatchType::Default;
 use Text::ASCIITable;
 use Tree::Simple;
 use Tree::Simple::Visitor::FindByPath;
@@ -13,7 +16,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
 
@@ -87,7 +90,7 @@ 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) {
                 $c->action->execute($c);
                 $error++ if scalar @{ $c->error };
@@ -173,6 +176,7 @@ qq/Couldn't forward to command "$command". Invalid action or component./;
         if ( my $code = $c->components->{$class}->can($method) ) {
             my $action = Catalyst::Action->new(
                 {
+                    name      => $method,
                     code      => $code,
                     reverse   => "$class->$method",
                     namespace => $class,
@@ -214,45 +218,19 @@ 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] ) {
-
-            # It's a regex
-            if ($#$result) {
-                my $match    = $result->[1];
-                my @snippets = @{ $result->[2] };
-                $c->log->debug(
-                    qq/Requested action is "$path" and matched "$match"/)
-                  if $c->debug;
-                $c->log->debug(
-                    'Snippets are "' . join( ' ', @snippets ) . '"' )
-                  if ( $c->debug && @snippets );
-                $c->req->action($match);
-                $c->req->snippets( \@snippets );
-            }
 
-            else {
-                $c->req->action($path);
-                $c->log->debug(qq/Requested action is "$path"/) if $c->debug;
-            }
+        # Check out dispatch types to see if any will handle the path at
+        # this level
 
-            $c->req->match($path);
-            $c->action($result->[0]);
-            $c->namespace($result->[0]->prefix);
-            last;
+        foreach my $type (@{$self->dispatch_types}) {
+            last DESCEND if $type->prepare_action($c, $path);
         }
-        unshift @args, pop @path;
-    }
 
-    unless ( $c->req->action ) {
-        my $result = @{$c->get_action('default', $c->req->path, 1) || []}[-1];
-        if ($result) {
-            $c->action( $result->[0] );
-            $c->namespace( $c->req->path );
-            $c->req->action('default');
-            $c->req->match('');
-        }
+        # If not, move the last part path to args
+
+        unshift @args, pop @path;
     }
 
     $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
@@ -282,22 +260,6 @@ sub get_action {
         return \@results;
     }
 
-    elsif ( my $p = $self->actions->{plain}->{$action} ) { return [ [$p] ] }
-    elsif ( my $r = $self->actions->{regex}->{$action} ) { return [ [$r] ] }
-
-    else {
-
-        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 ] ];
-            }
-
-        }
-    }
     return [];
 }
 
@@ -352,28 +314,28 @@ sub set_action {
     my $prefix =
       Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} )
       || '';
-    my %flags;
+    my %attributes;
 
     for my $attr ( @{$attrs} ) {
-        if    ( $attr =~ /^(Local|Relative)$/ )    { $flags{local}++ }
-        elsif ( $attr =~ /^(Global|Absolute)$/ )   { $flags{global}++ }
-        elsif ( $attr =~ /^Path\(\s*(.+)\s*\)$/i ) {
-            push @{ $flags{path} }, $1;
-        }
-        elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
-        elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) {
-            push @{ $flags{regex} }, $2;
+
+        # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
+
+        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 ) ) {
+    if ( $attributes{Private} && ( keys %attributes > 1 ) ) {
         $c->log->debug( 'Bad action definition "'
               . join( ' ', @{$attrs} )
               . qq/" for "$namespace->$method"/ )
           if $c->debug;
         return;
     }
-    return unless keys %flags;
+    return unless keys %attributes;
 
     my $parent  = $self->tree;
     my $visitor = Tree::Simple::Visitor::FindByPath->new;
@@ -405,52 +367,21 @@ sub set_action {
 
     my $action = Catalyst::Action->new(
         {
-            code      => $code,
-            reverse   => $reverse,
-            namespace => $namespace,
-            prefix    => $prefix,
+            name       => $method,
+            code       => $code,
+            reverse    => $reverse,
+            namespace  => $namespace,
+            prefix     => $prefix,
+            attributes => \%attributes,
         }
     );
 
     # Set the method value
     $parent->getNodeValue->actions->{$method} = $action;
 
-    my @path;
-    for my $path ( @{ $flags{path} } ) {
-        $path =~ s/^\w+//;
-        $path =~ s/\w+$//;
-        if ( $path =~ /^\s*'(.*)'\s*$/ ) { $path = $1 }
-        if ( $path =~ /^\s*"(.*)"\s*$/ ) { $path = $1 }
-        push @path, $path;
-    }
-    $flags{path} = \@path;
-
-    my @regex;
-    for my $regex ( @{ $flags{regex} } ) {
-        $regex =~ s/^\w+//;
-        $regex =~ s/\w+$//;
-        if ( $regex =~ /^\s*'(.*)'\s*$/ ) { $regex = $1 }
-        if ( $regex =~ /^\s*"(.*)"\s*$/ ) { $regex = $1 }
-        push @regex, $regex;
-    }
-    $flags{regex} = \@regex;
-
-    if ( $flags{local} || $flags{global} ) {
-        push( @{ $flags{path} }, $prefix ? "/$prefix/$method" : "/$method" )
-          if $flags{local};
-
-        push( @{ $flags{path} }, "/$method" ) if $flags{global};
-    }
-
-    for my $path ( @{ $flags{path} } ) {
-        if ( $path =~ /^\// ) { $path =~ s/^\/// }
-        else { $path = $prefix ? "$prefix/$path" : $path }
-        $self->actions->{plain}->{$path} = $action;
-    }
-
-    for my $regex ( @{ $flags{regex} } ) {
-        push @{ $self->actions->{compiled} }, [ $regex, qr#$regex# ];
-        $self->actions->{regex}->{$regex} = $action;
+    # Pass the action to our dispatch types so they can register it if reqd.
+    foreach my $type ( @{ $self->dispatch_types } ) {
+        $type->register_action($c, $action);
     }
 }
 
@@ -471,6 +402,10 @@ sub setup_actions {
         }
     );
 
+    $self->dispatch_types([
+        map { "Catalyst::DispatchType::$_"->new }
+            qw/Path Regex Default/ ]);
+
     # We use a tree
     my $container = Catalyst::ActionContainer->new(
                         { part => '/', actions => {} } );