Updated Plugins.pod a bit

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

diff --git a/lib/Catalyst/Base.pm b/lib/Catalyst/Base.pm
index 0703b5c..f667fea 100644 (file)
--- a/lib/Catalyst/Base.pm
+++ b/lib/Catalyst/Base.pm
@@ -1,12 +1,14 @@
 package Catalyst::Base;
 
 use strict;
-use base qw/Catalyst::AttrContainer Class::Accessor::Fast/;
+use base qw/Catalyst::Component Catalyst::AttrContainer Class::Accessor::Fast/;
 
 use Catalyst::Exception;
+use Catalyst::Utils;
+use Class::Inspector;
 use NEXT;
 
-__PACKAGE__->mk_classdata($_) for qw/_config _dispatch_steps/;
+__PACKAGE__->mk_classdata($_) for qw/_dispatch_steps/;
 
 __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
 
@@ -52,97 +54,79 @@ sub _END : Private {
     return !@{ $c->error };
 }
 
-=head1 NAME
-
-Catalyst::Base - Catalyst Universal Base Class
+sub action_namespace {
+    my ( $self, $c ) = @_;
+    return
+        Catalyst::Utils::class2prefix(
+            ref $self, $c->config->{case_sensitive} ) || '';
+}
 
-=head1 SYNOPSIS
+sub register_actions {
+    my ( $self, $c ) = @_;
+    my $class = ref $self || $self;
+    my $namespace = $self->action_namespace( $c );
+    my %methods;
+    $methods{$self->can($_)} = $_ for @{Class::Inspector->methods($class)||[]};
+    foreach my $cache (@{$self->_action_cache}) {
+        my $code = $cache->[0];
+        my $method = $methods{$code};
+        next unless $method;
+        my $attrs = $self->_parse_attrs(@{$cache->[1]});
+        if ($attrs->{Private} && ( keys %$attrs > 1 ) ) {
+            $c->log->debug( 'Bad action definition "'
+                  . join( ' ', @{$cache->[1]} )
+                  . qq/" for "$class->$method"/ )
+              if $c->debug;
+            next;
+        }
+        my $reverse = $namespace ? "$namespace/$method" : $method;
+        my $action = Catalyst::Action->new(
+            {
+                name       => $method,
+                code       => $code,
+                reverse    => $reverse,
+                namespace  => $namespace,
+                class      => $class,
+                attributes => $attrs,
+            }
+        );
+        $c->dispatcher->register($c, $action);
+    }
+}
 
-    # lib/MyApp/Model/Something.pm
-    package MyApp::Model::Something;
+sub _parse_attrs {
+    my ( $self, @attrs ) = @_;
+    my %attributes;
+    foreach my $attr (@attrs) {
 
-    use base 'Catalyst::Base';
+        # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
 
-    __PACKAGE__->config( foo => 'bar' );
+        if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/ ) ) {
 
-    sub test {
-        my $self = shift;
-        return $self->{foo};
+            if ( defined $value ) {
+                ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
+            }
+            push( @{ $attributes{$key} }, $value );
+        }
     }
+    return \%attributes;
+}
 
-    sub forward_to_me {
-        my ( $self, $c ) = @_;
-        $c->response->output( $self->{foo} );
-    }
-    
-    1;
 
-    # Methods can be a request step
-    $c->forward(qw/MyApp::Model::Something forward_to_me/);
+=head1 NAME
 
-    # Or just methods
-    print $c->comp('MyApp::Model::Something')->test;
+Catalyst::Base - Catalyst Controller Base Class
 
-    print $c->comp('MyApp::Model::Something')->{foo};
+=head1 SYNOPSIS
 
-=head1 DESCRIPTION
 
-This is the universal base class for Catalyst components
-(Model/View/Controller).
+=head1 DESCRIPTION
 
-It provides you with a generic new() for instantiation through Catalyst's
-component loader with config() support and a process() method placeholder.
 
 =head1 METHODS
 
 =over 4
 
-=item new($c)
-
-=cut
-
-sub new {
-    my ( $self, $c ) = @_;
-
-    # Temporary fix, some components does not pass context to constructor
-    my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {};
-
-    return $self->NEXT::new( { %{ $self->config }, %{$arguments} } );
-}
-
-# remember to leave blank lines between the consecutive =item's
-# otherwise the pod tools don't recognize the subsequent =items
-
-=item $c->config
-
-=item $c->config($hashref)
-
-=item $c->config($key, $value, ...)
-
-=cut
-
-sub config {
-    my $self = shift;
-    $self->_config( {} ) unless $self->_config;
-    if (@_) {
-        my $config = @_ > 1 ? {@_} : $_[0];
-        while ( my ( $key, $val ) = each %$config ) {
-            $self->_config->{$key} = $val;
-        }
-    }
-    return $self->_config;
-}
-
-=item $c->process()
-
-=cut
-
-sub process {
-
-    Catalyst::Exception->throw( message => ( ref $_[0] || $_[0] )
-          . " did not override Catalyst::Base::process" );
-}
-
 =back
 
 =head1 SEE ALSO