rework $c->stats to cooperate with new subrequest plugin

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

diff --git a/lib/Catalyst/Base.pm b/lib/Catalyst/Base.pm
index 0671838..dd09c8b 100644 (file)
--- a/lib/Catalyst/Base.pm
+++ b/lib/Catalyst/Base.pm
@@ -13,6 +13,11 @@ __PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/;
 __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
 __PACKAGE__->_action_class('Catalyst::Action');
 
+__PACKAGE__->mk_accessors( qw/_application/ );
+
+### _app as alias
+*_app = *_application;
+
 sub _DISPATCH : Private {
     my ( $self, $c ) = @_;
 
@@ -60,6 +65,14 @@ sub _END : Private {
     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,20 +85,46 @@ See L<Catalyst>
 
 Catalyst Base Class
 
-This is the base class for all Catalyst components. It also handles 
-dispatch of actions for controllers.
+This is the base class for all Catalyst components.  It is a subclass
+of L<Catalyst::Component> which is the universal base class for
+catalyst components.  This module includes handling of dispatching for
+controller actions.
 
 =head1 METHODS
 
+=head2 $class->new($app, @args)
+
+Proxies through to NEXT::new and stashes the application instance as
+$self->_application.
+
+=head2 $self->action_for('name')
+
+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)
 
-Determine the namespace for actions in this component.
+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 $self->config->{namespace} if exists $self->config->{namespace};
+    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} )
       || '';
@@ -93,15 +132,27 @@ sub action_namespace {
 
 =head2 $self->path_prefix($c)
 
-alias for action_namespace
+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 { shift->action_namespace(@_); }
+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.
+Finds all applicable actions for this component, creates Catalyst::Action
+objects (using $self->create_action) for them and registers them with
+$c->dispatcher.
 
 =cut
 
@@ -125,7 +176,7 @@ 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( $c, $method, @{ $cache->[1] } );
         if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) {
@@ -149,6 +200,15 @@ sub register_actions {
     }
 }
 
+=head2 $self->create_action(%args)
+
+Called with a hash of data to be use for construction of a new Catalyst::Action
+(or appropriate sub/alternative class) object.
+
+Primarily designed for the use of register_actions.
+
+=cut
+
 sub create_action {
     my $self = shift;
     my %args = @_;
@@ -183,11 +243,22 @@ sub _parse_attrs {
         }
     }
 
+    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) {
 
-        foreach my $value (@{$raw_attributes{$key}}) {
+        my $raw = $raw_attributes{$key};
+
+        foreach my $value (ref($raw) eq 'ARRAY' ? @$raw : $raw) {
 
             my $meth = "_parse_${key}_attr";
             if ( $self->can($meth) ) {
@@ -251,6 +322,12 @@ sub _parse_ActionClass_attr {
     return ( 'ActionClass', $value );
 }
 
+=head2 $self->_application  
+
+=head2 $self->_app
+
+Returns the application instance stored by C<new()>
+
 =head1 SEE ALSO
 
 L<Catalyst>, L<Catalyst::Controller>.