Remove some kane-isms that hurt my eyes
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Test.pm
index 7868e03..4c77778 100644 (file)
@@ -27,9 +27,7 @@ my $build_exports = sub {
         }
         $class->import;
 
-        my $app = $class->psgi_app;
-
-        $request = sub { local_request( $app, @_ ) };
+        $request = sub { local_request( $class, @_ ) };
     }
 
     my $get = sub { $request->(@_)->content };
@@ -37,35 +35,44 @@ my $build_exports = sub {
     my $ctx_request = sub {
         my $me = ref $self || $self;
 
-        ### throw an exception if ctx_request is being used against a remote
-        ### server
+        # fail if ctx_request is being used against a remote server
         Catalyst::Exception->throw("$me only works with local requests, not remote")
             if $ENV{CATALYST_SERVER};
 
-        ### check explicitly for the class here, or the Cat->meta call will blow
-        ### up in our face
+        # check explicitly for the class here, or the Cat->meta call will blow
+        # up in our face
         Catalyst::Exception->throw("Must specify a test app: use Catalyst::Test 'TestApp'") unless $class;
 
-        ### place holder for $c after the request finishes; reset every time
-        ### requests are done.
-        my $c;
+        # place holder for $c after the request finishes; reset every time
+        # requests are done.
+        my $ctx_closed_over;
 
-        ### hook into 'dispatch' -- the function gets called after all plugins
-        ### have done their work, and it's an easy place to capture $c.
+        # hook into 'dispatch' -- the function gets called after all plugins
+        # have done their work, and it's an easy place to capture $c.
 
         my $meta = Class::MOP::get_metaclass_by_name($class);
         $meta->make_mutable;
         $meta->add_after_method_modifier( "dispatch", sub {
-            $c = shift;
+            $ctx_closed_over = shift;
         });
         $meta->make_immutable( replace_constructor => 1 );
         Class::C3::reinitialize(); # Fixes RT#46459, I've failed to write a test for how/why, but it does.
-        ### do the request; C::T::request will know about the class name, and
-        ### we've already stopped it from doing remote requests above.
+
+        # do the request; C::T::request will know about the class name, and
+        # we've already stopped it from doing remote requests above.
         my $res = $request->( @_ );
 
-        ### return both values
-        return ( $res, $c );
+        # Make sure not to leave a reference $ctx hanging around.
+        # This means that the context will go out of scope as soon as the
+        # caller disposes of it, rather than waiting till the next time
+        # that ctx_request is called. This can be important if your $ctx
+        # ends up with a reference to a shared resource or lock (for example)
+        # which you want to clean up in test teardown - if the $ctx is still
+        # closed over then you're stuffed...
+        my $ctx = $ctx_closed_over;
+        undef $ctx_closed_over;
+
+        return ( $res, $ctx );
     };
 
     return {
@@ -107,6 +114,12 @@ our $default_host;
 
     sub import {
         my ($self, $class, $opts) = @_;
+        Carp::carp(
+qq{Importing Catalyst::Test without an application name is deprecated:\n
+Instead of saying: use Catalyst::Test;
+say: use Catalyst::Test (); # If you don't want to import a test app right now.
+or say: use Catalyst::Test 'MyApp'; # If you do want to import a test app.\n\n})
+        unless $class;
         $import->($self, '-all' => { class => $class });
         $opts = {} unless ref $opts eq 'HASH';
         $default_host = $opts->{default_host} if exists $opts->{default_host};
@@ -200,6 +213,9 @@ method and the L<request|/"$res = request( ... );"> method below:
     is ( $uri->path , '/y');
     my $content = get($uri->path);
 
+Note also that the content is returned as raw bytes, without any attempt
+to decode it into characters.
+
 =head2 $res = request( ... );
 
 Returns an L<HTTP::Response> object. Accepts an optional hashref for request
@@ -222,7 +238,9 @@ Simulate a request using L<HTTP::Request::AsCGI>.
 =cut
 
 sub local_request {
-    my $app = shift;
+    my $class = shift;
+
+    my $app = ref($class) eq "CODE" ? $class : $class->_finalized_psgi_app;
 
     my $request = Catalyst::Utils::request(shift);
     my %extra_env;
@@ -231,7 +249,32 @@ sub local_request {
     my $ret;
     test_psgi
         app    => sub { $app->({ %{ $_[0] }, %extra_env }) },
-        client => sub { $ret = shift->($request) };
+        client => sub {
+            my $psgi_app = shift;
+
+            my $resp = $psgi_app->($request);
+
+            # HTML head parsing based on LWP::UserAgent
+            #
+            # This is not just horrible and possibly broken, but also really
+            # doesn't belong here. Whoever wants this should be working on
+            # getting it into Plack::Test, or make a middleware out of it, or
+            # whatever. Seriously - horrible.
+
+            require HTML::HeadParser;
+
+            my $parser = HTML::HeadParser->new();
+            $parser->xml_mode(1) if $resp->content_is_xhtml;
+            $parser->utf8_mode(1) if $] >= 5.008 && $HTML::Parser::VERSION >= 3.40;
+
+            $parser->parse( $resp->content );
+            my $h = $parser->header;
+            for my $f ( $h->header_field_names ) {
+                $resp->init_header( $f, [ $h->header($f) ] );
+            }
+
+            $ret = $resp;
+        };
 
     return $ret;
 }