actually document the new request body_data method

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

diff --git a/lib/Catalyst/Utils.pm b/lib/Catalyst/Utils.pm
index 6ba6f86..e6a8801 100644 (file)
--- a/lib/Catalyst/Utils.pm
+++ b/lib/Catalyst/Utils.pm
@@ -6,10 +6,10 @@ use HTTP::Request;
 use Path::Class;
 use URI;
 use Carp qw/croak/;
+use Cwd;
 use Class::MOP;
 use String::RewritePrefix;
-use List::MoreUtils qw/ any /;
-use Cwd qw/ cwd /;
+use Class::Load ();
 
 use namespace::clean;
 
@@ -155,24 +155,35 @@ sub class2tempdir {
     return $tmpdir->stringify;
 }
 
+=head2 home($class)
+
+Returns home directory for given class.
+
 =head2 dist_indicator_file_list
 
-Returns a list of files which can be tested to check if you're inside a checkout
+Returns a list of files which can be tested to check if you're inside
+a CPAN distribution which is not yet installed.
 
-=cut
+These are:
 
-sub dist_indicator_file_list {
-    qw/ Makefile.PL Build.PL dist.ini /;
-}
+=over
 
-=head2 home($class)
+=item Makefile.PL
 
-Returns home directory for given class.
+=item Build.PL
 
-Note that the class must be loaded for the home directory to be found using this function.
+=item dist.ini
+
+=item L<cpanfile>
+
+=back
 
 =cut
 
+sub dist_indicator_file_list {
+    qw{Makefile.PL Build.PL dist.ini cpanfile};
+}
+
 sub home {
     my $class = shift;
 
@@ -185,8 +196,25 @@ sub home {
 
             # find the @INC entry in which $file was found
             (my $path = $inc_entry) =~ s/$file$//;
-            my $home = find_home_unloaded_in_checkout($path);
-            return $home if $home;
+            $path ||= cwd() if !defined $path || !length $path;
+            my $home = dir($path)->absolute->cleanup;
+
+            # pop off /lib and /blib if they're there
+            $home = $home->parent while $home =~ /b?lib$/;
+
+            # only return the dir if it has a Makefile.PL or Build.PL or dist.ini
+            if (grep { -f $home->file($_) } dist_indicator_file_list()) {
+                # clean up relative path:
+                # MyApp/script/.. -> MyApp
+
+                my $dir;
+                my @dir_list = $home->dir_list();
+                while (($dir = pop(@dir_list)) && $dir eq '..') {
+                    $home = dir($home)->parent->parent;
+                }
+
+                return $home->stringify;
+            }
         }
 
         {
@@ -202,45 +230,7 @@ sub home {
     }
 
     # we found nothing
-    return;
-}
-
-=head2 find_home_unloaded_in_checkout ($path)
-
-Tries to determine if C<$path> (or the current working directory if not supplied)
-looks like a checkout. Any leading lib, script or blib components
-will be removed, then the directory produced will be checked
-for the existence of a C<< dist_indicator_file_list() >>.
-
-If one is found, the directory will be returned, otherwise false.
-
-=cut
-
-# XXX - Is this actually sane - should we just split into two simpler routines
-#       one for when we do have an @INC entry and one for when we don't?
-sub find_home_unloaded_in_checkout {
-    my ($path) = @_;
-    $path ||= cwd() if !defined $path || !length $path;
-    my $home = dir($path)->absolute->cleanup;
-    my $last_home;
-    do {
-        # only return the dir if it has a Makefile.PL or Build.PL or dist.ini
-        if (any { $_ } map { -f $home->file($_) } dist_indicator_file_list()) {
-            # clean up relative path:
-            # MyApp/script/.. -> MyApp
-
-            my $dir;
-            my @dir_list = $home->dir_list();
-            while (($dir = pop(@dir_list)) && $dir eq '..') {
-                $home = dir($home)->parent->parent;
-            }
-            return $home->stringify;
-        }
-        $last_home = $home;
-        $home = $home->parent;
-    }
-    while # pop off /lib and /blib or /script or /t/ if they're there
-        ($last_home =~ /b?lib$/ || $last_home =~ /script$/ || $last_home =~ /\/t(\/|$)/);
+    return 0;
 }
 
 =head2 prefix($class, $name);
@@ -444,6 +434,56 @@ sub resolve_namespace {
     }, @classes);
 }
 
+=head2 build_middleware (@args)
+
+Internal application that converts a single middleware definition (see
+L<Catalyst/psgi_middleware>) into an actual instance of middleware.
+
+=cut
+
+sub build_middleware {
+    my ($class, $namespace, @init_args) = @_;
+
+    if(
+      $namespace =~s/^\+// ||
+      $namespace =~/^Plack::Middleware/ ||
+      $namespace =~/^$class/
+    ) {  ## the string is a full namespace
+        return Class::Load::try_load_class($namespace) ?
+          $namespace->new(@init_args) :
+            die "Can't load class $namespace";
+    } else { ## the string is a partial namespace
+      if(Class::Load::try_load_class($class .'::Middleware::'. $namespace)) { ## Load Middleware from Project namespace
+          my $ns = $class .'::Middleware::'. $namespace;
+          return $ns->new(@init_args);
+        } elsif(Class::Load::try_load_class("Plack::Middleware::$namespace")) { ## Act like Plack::Builder
+          return "Plack::Middleware::$namespace"->new(@init_args);
+        }
+    }
+
+    return; ## be sure we can count on a proper return when valid
+}
+
+=head2 apply_registered_middleware ($psgi)
+
+Given a $psgi reference, wrap all the L<Catalyst/registered_middlewares>
+around it and return the wrapped version.
+
+This exists to deal with the fact Catalyst registered middleware can be
+either an object with a wrap method or a coderef.
+
+=cut
+
+sub apply_registered_middleware {
+    my ($class, $psgi) = @_;
+    my $new_psgi = $psgi;
+    foreach my $middleware ($class->registered_middlewares) {
+        $new_psgi = Scalar::Util::blessed $middleware ?
+          $middleware->wrap($new_psgi) :
+            $middleware->($new_psgi);
+    }
+    return $new_psgi;
+}
 
 =head1 AUTHORS