Documented auto/forward/detach behaviour for chains in Intro
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Base.pm
index 9aa4dbf..65f3120 100644 (file)
@@ -27,7 +27,7 @@ sub _BEGIN : Private {
     my ( $self, $c ) = @_;
     my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1];
     return 1 unless $begin;
-    $begin->execute($c);
+    $begin->dispatch( $c );
     return !@{ $c->error };
 }
 
@@ -35,7 +35,7 @@ sub _AUTO : Private {
     my ( $self, $c ) = @_;
     my @auto = $c->get_actions( 'auto', $c->namespace );
     foreach my $auto (@auto) {
-        $auto->execute($c);
+        $auto->dispatch( $c );
         return 0 unless $c->state;
     }
     return 1;
@@ -44,10 +44,10 @@ sub _AUTO : Private {
 sub _ACTION : Private {
     my ( $self, $c ) = @_;
     if (   ref $c->action
-        && $c->action->isa('Catalyst::Action')
+        && $c->action->can('execute')
         && $c->req->action )
     {
-        $c->action->execute($c);
+        $c->action->dispatch( $c );
     }
     return !@{ $c->error };
 }
@@ -56,10 +56,18 @@ sub _END : Private {
     my ( $self, $c ) = @_;
     my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1];
     return 1 unless $end;
-    $end->execute($c);
+    $end->dispatch( $c );
     return !@{ $c->error };
 }
 
+sub new {
+  my $self = shift;
+  my $app = $_[0];
+  my $new = $self->NEXT::new(@_);
+  $new->{application} = $app;
+  return $new;
+}
+
 =head1 NAME
 
 Catalyst::Base - Catalyst Base Class
@@ -72,22 +80,65 @@ See L<Catalyst>
 
 Catalyst Base Class
 
+This is the base class for all Catalyst components. It also handles 
+dispatch of actions for controllers.
+
 =head1 METHODS
 
-=over 4
+=head2 $self->action_for('name')
 
-=item $self->action_namespace($c)
+Returns the Catalyst::Action object (if any) for a given method name in
+this component.
+
+=cut
+
+sub action_for {
+    my ( $self, $name ) = @_;
+    my $app = ($self->isa('Catalyst') ? $self : $self->{application});
+    return $app->dispatcher->get_action($name, $self->action_namespace);
+}
+
+=head2 $self->action_namespace($c)
+
+Returns the private namespace for actions in this component. Defaults to a value
+from the controller name (for e.g. MyApp::Controller::Foo::Bar becomes
+"foo/bar") or can be overriden from the "namespace" config key.
 
 =cut
 
 sub action_namespace {
     my ( $self, $c ) = @_;
-    return Catalyst::Utils::class2prefix( ref $self,
+    unless ( $c ) {
+        $c = ($self->isa('Catalyst') ? $self : $self->{application});
+    }
+    my $hash = (ref $self ? $self : $self->config); # hate app-is-class
+    return $hash->{namespace} if exists $hash->{namespace};
+    return Catalyst::Utils::class2prefix( ref($self) || $self,
         $c->config->{case_sensitive} )
       || '';
 }
 
-=item $self->register_actions($c)
+=head2 $self->path_prefix($c)
+
+Returns the default path prefix for :Local, :LocalRegex and relative :Path
+actions in this component. Defaults to the action_namespace or can be
+overriden from the "path" config key.
+
+=cut
+
+sub path_prefix {
+    my ( $self, $c ) = @_;
+    unless ( $c ) {
+        $c = ($self->isa('Catalyst') ? $self : $self->{application});
+    }
+    my $hash = (ref $self ? $self : $self->config); # hate app-is-class
+    return $hash->{path} if exists $hash->{path};
+    return shift->action_namespace(@_);
+}
+
+=head2 $self->register_actions($c)
+
+register all actions for this component based on a given context.
 
 =cut
 
@@ -111,9 +162,9 @@ sub register_actions {
 
     foreach my $cache (@action_cache) {
         my $code   = $cache->[0];
-        my $method = $methods{$code};
+        my $method = delete $methods{$code}; # avoid dupe registers
         next unless $method;
-        my $attrs = $self->_parse_attrs( @{ $cache->[1] } );
+        my $attrs = $self->_parse_attrs( $c, $method, @{ $cache->[1] } );
         if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) {
             $c->log->debug( 'Bad action definition "'
                   . join( ' ', @{ $cache->[1] } )
@@ -122,23 +173,39 @@ sub register_actions {
             next;
         }
         my $reverse = $namespace ? "$namespace/$method" : $method;
-        my $action = $self->_action_class->new(
-            {
-                name       => $method,
-                code       => $code,
-                reverse    => $reverse,
-                namespace  => $namespace,
-                class      => $class,
-                attributes => $attrs,
-            }
+        my $action = $self->create_action(
+            name       => $method,
+            code       => $code,
+            reverse    => $reverse,
+            namespace  => $namespace,
+            class      => $class,
+            attributes => $attrs,
         );
+
         $c->dispatcher->register( $c, $action );
     }
 }
 
+sub create_action {
+    my $self = shift;
+    my %args = @_;
+
+    my $class = (exists $args{attributes}{ActionClass}
+                    ? $args{attributes}{ActionClass}[0]
+                    : $self->_action_class);
+
+    unless ( Class::Inspector->loaded($class) ) {
+        require Class::Inspector->filename($class);
+    }
+    
+    return $class->new( \%args );
+}
+
 sub _parse_attrs {
-    my ( $self, @attrs ) = @_;
-    my %attributes;
+    my ( $self, $c, $name, @attrs ) = @_;
+
+    my %raw_attributes;
+
     foreach my $attr (@attrs) {
 
         # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
@@ -149,13 +216,88 @@ sub _parse_attrs {
             if ( defined $value ) {
                 ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
             }
-            push( @{ $attributes{$key} }, $value );
+            push( @{ $raw_attributes{$key} }, $value );
         }
     }
-    return \%attributes;
+
+    my $hash = (ref $self ? $self : $self->config); # hate app-is-class
+
+    if (exists $hash->{actions} || exists $hash->{action}) {
+      my $a = $hash->{actions} || $hash->{action};
+      %raw_attributes = ((exists $a->{'*'} ? %{$a->{'*'}} : ()),
+                         %raw_attributes,
+                         (exists $a->{$name} ? %{$a->{$name}} : ()));
+    }
+
+    my %final_attributes;
+
+    foreach my $key (keys %raw_attributes) {
+
+        my $raw = $raw_attributes{$key};
+
+        foreach my $value (ref($raw) ? @$raw : $raw) {
+
+            my $meth = "_parse_${key}_attr";
+            if ( $self->can($meth) ) {
+                ( $key, $value ) = $self->$meth( $c, $name, $value );
+            }
+            push( @{ $final_attributes{$key} }, $value );
+        }
+    }
+
+    return \%final_attributes;
+}
+
+sub _parse_Global_attr {
+    my ( $self, $c, $name, $value ) = @_;
+    return $self->_parse_Path_attr( $c, $name, "/$name" );
+}
+
+sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); }
+
+sub _parse_Local_attr {
+    my ( $self, $c, $name, $value ) = @_;
+    return $self->_parse_Path_attr( $c, $name, $name );
 }
 
-=back
+sub _parse_Relative_attr { shift->_parse_Local_attr(@_); }
+
+sub _parse_Path_attr {
+    my ( $self, $c, $name, $value ) = @_;
+    $value ||= '';
+    if ( $value =~ m!^/! ) {
+        return ( 'Path', $value );
+    }
+    elsif ( length $value ) {
+        return ( 'Path', join( '/', $self->path_prefix($c), $value ) );
+    }
+    else {
+        return ( 'Path', $self->path_prefix($c) );
+    }
+}
+
+sub _parse_Regex_attr {
+    my ( $self, $c, $name, $value ) = @_;
+    return ( 'Regex', $value );
+}
+
+sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); }
+
+sub _parse_LocalRegex_attr {
+    my ( $self, $c, $name, $value ) = @_;
+    unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; }
+    return ( 'Regex', '^' . $self->path_prefix($c) . "/${value}" );
+}
+
+sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); }
+
+sub _parse_ActionClass_attr {
+    my ( $self, $c, $name, $value ) = @_;
+    unless ( $value =~ s/^\+// ) {
+      $value = join('::', $self->_action_class, $value );
+    }
+    return ( 'ActionClass', $value );
+}
 
 =head1 SEE ALSO