lots of new docs,

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

diff --git a/lib/Catalyst/Base.pm b/lib/Catalyst/Base.pm
index 35787a4..18e6f6e 100644 (file)
--- a/lib/Catalyst/Base.pm
+++ b/lib/Catalyst/Base.pm
@@ -43,7 +43,12 @@ sub _AUTO : Private {
 
 sub _ACTION : Private {
     my ( $self, $c ) = @_;
-    $c->action->execute($c);
+    if (   ref $c->action
+        && $c->action->can('execute')
+        && $c->req->action )
+    {
+        $c->action->execute($c);
+    }
     return !@{ $c->error };
 }
 
@@ -55,13 +60,51 @@ sub _END : Private {
     return !@{ $c->error };
 }
 
+=head1 NAME
+
+Catalyst::Base - Catalyst Base Class
+
+=head1 SYNOPSIS
+
+See L<Catalyst>
+
+=head1 DESCRIPTION
+
+Catalyst Base Class
+
+This is the base class for all Catalyst components. It also handles 
+dispatch of actions for controllers.
+
+=head1 METHODS
+
+=head2 $self->action_namespace($c)
+
+Determine the namespace for actions in this component.
+
+=cut
+
 sub action_namespace {
     my ( $self, $c ) = @_;
-    return Catalyst::Utils::class2prefix( ref $self,
+    return $self->config->{namespace} if exists $self->config->{namespace};
+    return Catalyst::Utils::class2prefix( ref($self) || $self,
         $c->config->{case_sensitive} )
       || '';
 }
 
+=head2 $self->path_prefix($c)
+
+alias for action_namespace
+
+=cut
+
+sub path_prefix { shift->action_namespace(@_); }
+
+=head2 $self->register_actions($c)
+
+register all actions for this component based on a given context.
+
+=cut
+
 sub register_actions {
     my ( $self, $c ) = @_;
     my $class = ref $self || $self;
@@ -84,7 +127,7 @@ sub register_actions {
         my $code   = $cache->[0];
         my $method = $methods{$code};
         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] } )
@@ -108,42 +151,74 @@ sub register_actions {
 }
 
 sub _parse_attrs {
-    my ( $self, @attrs ) = @_;
+    my ( $self, $c, $name, @attrs ) = @_;
     my %attributes;
     foreach my $attr (@attrs) {
 
         # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
 
-        if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/ ) ) {
+        if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+?)\s*\))?$/ ) )
+        {
 
             if ( defined $value ) {
                 ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
             }
+            my $meth = "_parse_${key}_attr";
+            if ( $self->can($meth) ) {
+                ( $key, $value ) = $self->$meth( $c, $name, $value );
+            }
             push( @{ $attributes{$key} }, $value );
         }
     }
     return \%attributes;
 }
 
-=head1 NAME
+sub _parse_Global_attr {
+    my ( $self, $c, $name, $value ) = @_;
+    return $self->_parse_Path_attr( $c, $name, "/$name" );
+}
 
-Catalyst::Base - Catalyst Controller Base Class
+sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); }
 
-=head1 SYNOPSIS
+sub _parse_Local_attr {
+    my ( $self, $c, $name, $value ) = @_;
+    return $self->_parse_Path_attr( $c, $name, $name );
+}
 
+sub _parse_Relative_attr { shift->_parse_Local_attr(@_); }
 
-=head1 DESCRIPTION
+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 );
+}
 
-=head1 METHODS
+sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); }
 
-=over 4
+sub _parse_LocalRegex_attr {
+    my ( $self, $c, $name, $value ) = @_;
+    unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; }
+    return ( 'Regex', '^' . $self->path_prefix($c) . "/${value}" );
+}
 
-=back
+sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); }
 
 =head1 SEE ALSO
 
-L<Catalyst>.
+L<Catalyst>, L<Catalyst::Controller>.
 
 =head1 AUTHOR