X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=34fd2d062d45c0d66c83c2f1c87aeee8c81cabd4;hb=3b88a4556575f18382261e47214bb281694d8f16;hp=203f1c44a8053cb198e4062603fd82363f3748de;hpb=1627551a60fe1e220d390a565f793dea27cd36a6;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm
index 203f1c4..34fd2d0 100644
--- a/lib/Catalyst.pm
+++ b/lib/Catalyst.pm
@@ -14,7 +14,8 @@ use Catalyst::Controller;
 use File::stat;
 use NEXT;
 use Text::SimpleTable;
-use Path::Class;
+use Path::Class::Dir;
+use Path::Class::File;
 use Time::HiRes qw/gettimeofday tv_interval/;
 use URI;
 use Scalar::Util qw/weaken blessed/;
@@ -219,7 +220,7 @@ Specifies log level.
 
 =head1 METHODS
 
-=head2 Information about the current request
+=head2 INFORMATION ABOUT THE CURRENT REQUEST
 
 =head2 $c->action
 
@@ -241,7 +242,7 @@ corresponding to the controller of the current action. For example:
 Returns the current L<Catalyst::Request> object. See
 L<Catalyst::Request>.
 
-=head2 Processing and response to the current request
+=head2 PROCESSING AND RESPONSE TO THE CURRENT REQUEST
 
 =head2 $c->forward( $action [, \@arguments ] )
 
@@ -258,7 +259,7 @@ call to forward.
 
     my $foodata = $c->forward('/foo');
     $c->forward('index');
-    $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
+    $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
     $c->forward('MyApp::View::TT');
 
 =cut
@@ -291,11 +292,6 @@ Add a new error.
 
     $c->error('Something bad happened');
 
-Clear errors.  You probably don't want to clear the errors unless you are
-implementing a custom error screen.
-
-    $c->error(0);
-
 =cut
 
 sub error {
@@ -308,6 +304,22 @@ sub error {
     return $c->{error} || [];
 }
 
+=head2 $c->clear_errors
+
+Clear errors.  You probably don't want to clear the errors unless you are
+implementing a custom error screen.
+
+This is equivalent to running
+
+    $c->error(0);
+
+=cut
+
+sub clear_errors {
+    my $c = shift;
+    $c->error(0);
+}
+
 =head2 $c->response
 
 =head2 $c->res
@@ -350,17 +362,11 @@ Contains the return value of the last executed action.
 
 # search via regex
 sub _comp_search {
-    my ($c, @names) = @_;
+    my ( $c, @names ) = @_;
 
     foreach my $name (@names) {
         foreach my $component ( keys %{ $c->components } ) {
-            my $comp = $c->components->{$component} if $component =~ /$name/i;
-            if ($comp) {
-                if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
-                    return $comp->ACCEPT_CONTEXT($c);
-                }
-                else { return $comp }
-            }
+            return $c->components->{$component} if $component =~ /$name/i;
         }
     }
 
@@ -369,16 +375,10 @@ sub _comp_search {
 
 # try explicit component names
 sub _comp_explicit {
-    my ($c, @names) = @_;
+    my ( $c, @names ) = @_;
 
     foreach my $try (@names) {
-        if ( exists $c->components->{$try} ) {
-            my $comp = $c->components->{$try};
-            if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
-                return $comp->ACCEPT_CONTEXT($c);
-            }
-            else { return $comp }
-        }
+        return $c->components->{$try} if ( exists $c->components->{$try} );
     }
 
     return undef;
@@ -387,7 +387,7 @@ sub _comp_explicit {
 # like component, but try just these prefixes before regex searching,
 #  and do not try to return "sort keys %{ $c->components }"
 sub _comp_prefixes {
-    my ($c, $name, @prefixes) = @_;
+    my ( $c, $name, @prefixes ) = @_;
 
     my $appclass = ref $c || $c;
 
@@ -399,7 +399,50 @@ sub _comp_prefixes {
     return $comp;
 }
 
-=head2 Component Accessors
+# Find possible names for a prefix 
+
+sub _comp_names {
+    my ( $c, @prefixes ) = @_;
+
+    my $appclass = ref $c || $c;
+
+    my @pre = map { "${appclass}::${_}::" } @prefixes;
+
+    my @names;
+
+    COMPONENT: foreach my $comp ($c->component) {
+        foreach my $p (@pre) {
+            if ($comp =~ s/^$p//) {
+                push(@names, $comp);
+                next COMPONENT;
+            }
+        }
+    }
+
+    return @names;
+}
+
+# Return a component if only one matches.
+sub _comp_singular {
+    my ( $c, @prefixes ) = @_;
+
+    my $appclass = ref $c || $c;
+
+    my ( $comp, $rest ) =
+      map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
+    return $comp unless $rest;
+}
+
+# Filter a component before returning by calling ACCEPT_CONTEXT if available
+sub _filter_component {
+    my ( $c, $comp, @args ) = @_;
+    if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
+        return $comp->ACCEPT_CONTEXT( $c, @args );
+    }
+    else { return $comp }
+}
+
+=head2 COMPONENT ACCESSORS
 
 =head2 $c->comp($name)
 
@@ -428,10 +471,10 @@ sub component {
         );
 
         my $comp = $c->_comp_explicit(@names);
-        return $comp if defined($comp);
+        return $c->_filter_component( $comp, @_ ) if defined($comp);
 
         $comp = $c->_comp_search($name);
-        return $comp if defined($comp);
+        return $c->_filter_component( $comp, @_ ) if defined($comp);
     }
 
     return sort keys %{ $c->components };
@@ -443,11 +486,27 @@ Gets a L<Catalyst::Controller> instance by name.
 
     $c->controller('Foo')->do_stuff;
 
+If name is omitted, will return the controller for the dispatched action.
+
 =cut
 
 sub controller {
-    my ( $c, $name ) = @_;
-    return $c->_comp_prefixes($name, qw/Controller C/);
+    my ( $c, $name, @args ) = @_;
+    return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
+        @args )
+      if ($name);
+    return $c->component( $c->action->class );
+}
+
+=head2 $c->controllers
+
+Returns the available names which can be passed to $c->controller
+
+=cut
+
+sub controllers {
+    my ( $c ) = @_;
+    return $c->_comp_names(qw/Controller C/);
 }
 
 =head2 $c->model($name)
@@ -456,11 +515,31 @@ Gets a L<Catalyst::Model> instance by name.
 
     $c->model('Foo')->do_stuff;
 
+If the name is omitted, it will look for a config setting 'default_model',
+or check if there is only one model, and forward to it if that's the case.
+
 =cut
 
 sub model {
-    my ( $c, $name ) = @_;
-    return $c->_comp_prefixes($name, qw/Model M/);
+    my ( $c, $name, @args ) = @_;
+    return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
+        @args )
+      if $name;
+    return $c->component( $c->config->{default_model} )
+      if $c->config->{default_model};
+    return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
+
+}
+
+=head2 $c->models
+
+Returns the available names which can be passed to $c->model
+
+=cut
+
+sub models {
+    my ( $c ) = @_;
+    return $c->_comp_names(qw/Model M/);
 }
 
 =head2 $c->view($name)
@@ -469,11 +548,30 @@ Gets a L<Catalyst::View> instance by name.
 
     $c->view('Foo')->do_stuff;
 
+If the name is omitted, it will look for a config setting 'default_view',
+or check if there is only one view, and forward to it if that's the case.
+
 =cut
 
 sub view {
-    my ( $c, $name ) = @_;
-    return $c->_comp_prefixes($name, qw/View V/);
+    my ( $c, $name, @args ) = @_;
+    return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
+        @args )
+      if $name;
+    return $c->component( $c->config->{default_view} )
+      if $c->config->{default_view};
+    return $c->_filter_component( $c->_comp_singular(qw/View V/) );
+}
+
+=head2 $c->views
+
+Returns the available names which can be passed to $c->view
+
+=cut
+
+sub views {
+    my ( $c ) = @_;
+    return $c->_comp_names(qw/View V/);
 }
 
 =head2 Class data and helper classes
@@ -538,7 +636,7 @@ L<Catalyst::Log> man page.
 
 =cut
 
-=head2 Utility methods
+=head2 UTILITY METHODS
 
 =head2 $c->path_to(@path)
 
@@ -553,9 +651,9 @@ For example:
 
 sub path_to {
     my ( $c, @path ) = @_;
-    my $path = dir( $c->config->{home}, @path );
+    my $path = Path::Class::Dir->new( $c->config->{home}, @path );
     if ( -d $path ) { return $path }
-    else { return file( $c->config->{home}, @path ) }
+    else { return Path::Class::File->new( $c->config->{home}, @path ) }
 }
 
 =head2 $c->plugin( $name, $class, @args )
@@ -725,7 +823,7 @@ EOF
     $class->setup_finished(1);
 }
 
-=head2 $c->uri_for( $path, [ @args ] )
+=head2 $c->uri_for( $path, @args?, \%query_values? )
 
 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
 with C<$c-E<gt>namespace> for relative uri's, then returns a
@@ -971,7 +1069,7 @@ sub execute {
     $class = $c->component($class) || $class;
     $c->state(0);
 
-    if ($c->depth >= $RECURSION) {
+    if ( $c->depth >= $RECURSION ) {
         my $action = "$code";
         $action = "/$action" unless $action =~ /\-\>/;
         my $error = qq/Deep recursion detected calling "$action"/;
@@ -981,7 +1079,6 @@ sub execute {
         return $c->state;
     }
 
-
     if ( $c->debug ) {
         my $action = "$code";
         $action = "/$action" unless $action =~ /\-\>/;
@@ -1103,21 +1200,28 @@ sub finalize {
         $c->log->error($error);
     }
 
-    $c->finalize_uploads;
-
-    # Error
-    if ( $#{ $c->error } >= 0 ) {
-        $c->finalize_error;
+    # Allow engine to handle finalize flow (for POE)
+    if ( $c->engine->can('finalize') ) {
+        $c->engine->finalize( $c );
     }
+    else {
 
-    $c->finalize_headers;
+        $c->finalize_uploads;
 
-    # HEAD request
-    if ( $c->request->method eq 'HEAD' ) {
-        $c->response->body('');
-    }
+        # Error
+        if ( $#{ $c->error } >= 0 ) {
+            $c->finalize_error;
+        }
+
+        $c->finalize_headers;
 
-    $c->finalize_body;
+        # HEAD request
+        if ( $c->request->method eq 'HEAD' ) {
+            $c->response->body('');
+        }
+
+        $c->finalize_body;
+    }
 
     return $c->response->status;
 }
@@ -1168,7 +1272,8 @@ sub finalize_headers {
     if ( $c->response->body && !$c->response->content_length ) {
 
         # get the length from a filehandle
-        if ( blessed($c->response->body) && $c->response->body->can('read') ) {
+        if ( blessed( $c->response->body ) && $c->response->body->can('read') )
+        {
             if ( my $stat = stat $c->response->body ) {
                 $c->response->content_length( $stat->size );
             }
@@ -1232,7 +1337,7 @@ namespaces.
 
 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
 
-=head2 handle_request( $class, @arguments )
+=head2 $c->handle_request( $class, @arguments )
 
 Called to handle each HTTP request.
 
@@ -1344,15 +1449,21 @@ sub prepare {
         $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
     }
 
-    $c->prepare_request(@arguments);
-    $c->prepare_connection;
-    $c->prepare_query_parameters;
-    $c->prepare_headers;
-    $c->prepare_cookies;
-    $c->prepare_path;
-
-    # On-demand parsing
-    $c->prepare_body unless $c->config->{parse_on_demand};
+    # Allow engine to direct the prepare flow (for POE)
+    if ( $c->engine->can('prepare') ) {
+        $c->engine->prepare( $c, @arguments );
+    }
+    else {
+        $c->prepare_request(@arguments);
+        $c->prepare_connection;
+        $c->prepare_query_parameters;
+        $c->prepare_headers;
+        $c->prepare_cookies;
+        $c->prepare_path;
+
+        # On-demand parsing
+        $c->prepare_body unless $c->config->{parse_on_demand};
+    }
 
     my $method  = $c->req->method  || '';
     my $path    = $c->req->path    || '';
@@ -1842,7 +1953,7 @@ sub setup_home {
 
     if ($home) {
         $class->config->{home} ||= $home;
-        $class->config->{root} ||= dir($home)->subdir('root');
+        $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
     }
 }
 
@@ -1898,7 +2009,7 @@ the plugin name does not begin with C<Catalyst::Plugin::>.
 
     sub registered_plugins {
         my $proto = shift;
-        return sort keys %{$proto->_plugins} unless @_;
+        return sort keys %{ $proto->_plugins } unless @_;
         my $plugin = shift;
         return 1 if exists $proto->_plugins->{$plugin};
         return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
@@ -1916,7 +2027,7 @@ the plugin name does not begin with C<Catalyst::Plugin::>.
                 message => qq/Couldn't load ${type}plugin "$plugin", $error/ );
         }
 
-        $proto->_plugins->{$plugin} = 1;        
+        $proto->_plugins->{$plugin} = 1;
         unless ($instant) {
             no strict 'refs';
             unshift @{"$class\::ISA"}, $plugin;
@@ -1942,7 +2053,8 @@ the plugin name does not begin with C<Catalyst::Plugin::>.
 
 =head2 $c->stack
 
-Returns the stack.
+Returns an arrayref of the internal execution stack (actions that are currently
+executing).
 
 =head2 $c->write( $data )