Merge pull request #27 from kbond/response-public

Make Browser::response() public (crawler access option 1)

Author: kbond

README.md

@@ -224,6 +224,34 @@ $browser
     ->dd('foo') // if json response, array key
     ->dd('foo.*.baz') // if json response, JMESPath notation can be used
 ;
+
+// "response" object
+$response = $browser->response();
+$response->statusCode(); // ie 200
+$response->body(); // the raw body
+
+// html response
+$response->assertHtml()->crawler(); // Symfony\Component\DomCrawler\Crawler
+
+// xml response (not available with PantherBrowser)
+$response->assertXml()->crawler(); // Symfony\Component\DomCrawler\Crawler
+
+// json response (not available with PantherBrowser)
+$response->assertJson()->json(); // response content json decoded
+$response->assertJson()->search('some.selector'); // search the json using JMESPath expression
+
+// use the response without breaking the fluid browser session
+$browser
+    ->visit('/some/page')
+    ->use(function(\Zenstruck\Browser\Response $response) {
+        $response->statusCode(); // ie 200
+        $response->assertJson()->json(); // response content json decoded
+    })
+    ->use(function(\Zenstruck\Browser\Response\JsonResponse $response) {
+        // inject the expected response type
+        $response->json(); // response content json decoded
+    })
+;
 ```
 
 ### KernelBrowser/HttpBrowser

src/Browser.php

@@ -111,7 +111,8 @@ final public function use(callable $callback): self
             Parameter::union(
                 Parameter::untyped($this),
                 Parameter::typed(self::class, $this),
-                Parameter::typed(Component::class, Parameter::factory(fn(string $class) => new $class($this)))
+                Parameter::typed(Component::class, Parameter::factory(fn(string $class) => new $class($this))),
+                Parameter::typed(Response::class, Parameter::factory(fn() => $this->response()))
             )
         );
 
@@ -415,6 +416,11 @@ public function savedArtifacts(): array
         return ['Saved Source Files' => $this->savedSources];
     }
 
+    public function response(): Response
+    {
+        return Response::createFor($this->minkSession());
+    }
+
     /**
      * @internal
      */
@@ -439,11 +445,6 @@ final protected function documentElement(): DocumentElement
         return $this->minkSession()->getPage();
     }
 
-    protected function response(): Response
-    {
-        return Response::createFor($this->minkSession());
-    }
-
     /**
      * @internal
      *

src/Browser/BrowserKitBrowser.php

@@ -7,7 +7,6 @@
 use Symfony\Component\HttpKernel\Profiler\Profile;
 use Zenstruck\Browser;
 use Zenstruck\Browser\Mink\BrowserKitDriver;
-use Zenstruck\Browser\Response\JsonResponse;
 
 /**
  * @author Kevin Bond <[email protected]>
@@ -220,11 +219,7 @@ final public function assertJson(string $expectedContentType = 'json'): self
      */
     final public function assertJsonMatches(string $expression, $expected): self
     {
-        if (!$this->response() instanceof JsonResponse) {
-            PHPUnit::fail('Not a json response.');
-        }
-
-        PHPUnit::assertSame($expected, $this->response()->search($expression));
+        PHPUnit::assertSame($expected, $this->response()->assertJson()->search($expression));
 
         return $this;
     }

src/Browser/PantherBrowser.php

@@ -232,7 +232,7 @@ final public function savedArtifacts(): array
         );
     }
 
-    final protected function response(): PantherResponse
+    final public function response(): PantherResponse
     {
         return new PantherResponse($this->minkSession());
     }

src/Browser/Response.php

@@ -3,6 +3,7 @@
 namespace Zenstruck\Browser;
 
 use Behat\Mink\Session;
+use PHPUnit\Framework\Assert as PHPUnit;
 use Symfony\Component\VarDumper\VarDumper;
 use Zenstruck\Browser\Response\HtmlResponse;
 use Zenstruck\Browser\Response\JsonResponse;
@@ -15,6 +16,9 @@ class Response
 {
     private Session $session;
 
+    /**
+     * @internal
+     */
     final public function __construct(Session $session)
     {
         $this->session = $session;
@@ -25,6 +29,9 @@ final public function statusCode(): int
         return $this->session->getStatusCode();
     }
 
+    /**
+     * @internal
+     */
     final public static function createFor(Session $session): self
     {
         $contentType = (string) $session->getResponseHeader('content-type');
@@ -49,21 +56,60 @@ final public function body(): string
         return $this->session->getPage()->getContent();
     }
 
+    final public function assertJson(): JsonResponse
+    {
+        if (!$this instanceof JsonResponse) {
+            PHPUnit::fail('Not a json response.');
+        }
+
+        return $this;
+    }
+
+    final public function assertXml(): XmlResponse
+    {
+        if (!$this instanceof XmlResponse) {
+            PHPUnit::fail('Not an xml response.');
+        }
+
+        return $this;
+    }
+
+    final public function assertHtml(): HtmlResponse
+    {
+        if (!$this instanceof HtmlResponse) {
+            PHPUnit::fail('Not an html response.');
+        }
+
+        return $this;
+    }
+
+    /**
+     * @internal
+     */
     final public function raw(): string
     {
         return "{$this->rawMetadata()}\n{$this->rawBody()}";
     }
 
+    /**
+     * @internal
+     */
     final public function isSuccessful(): bool
     {
         return $this->statusCode() >= 200 && $this->statusCode() < 300;
     }
 
+    /**
+     * @internal
+     */
     final public function isRedirect(): bool
     {
         return $this->statusCode() >= 300 && $this->statusCode() < 400;
     }
 
+    /**
+     * @internal
+     */
     public function dump(?string $selector = null): void
     {
         if (null !== $selector) {
@@ -73,11 +119,17 @@ public function dump(?string $selector = null): void
         VarDumper::dump($this->raw());
     }
 
+    /**
+     * @internal
+     */
     final protected function session(): Session
     {
         return $this->session;
     }
 
+    /**
+     * @internal
+     */
     protected function rawMetadata(): string
     {
         $ret = "URL: {$this->session->getCurrentUrl()} ({$this->statusCode()})\n\n";
@@ -91,6 +143,9 @@ protected function rawMetadata(): string
         return $ret;
     }
 
+    /**
+     * @internal
+     */
     protected function rawBody(): string
     {
         return $this->body();

src/Browser/Response/HtmlResponse.php

@@ -2,7 +2,7 @@
 
 namespace Zenstruck\Browser\Response;
 
-use Behat\Mink\Element\NodeElement;
+use Symfony\Component\DomCrawler\Crawler;
 use Symfony\Component\VarDumper\VarDumper;
 use Zenstruck\Browser\Response;
 
@@ -11,23 +11,33 @@
  */
 class HtmlResponse extends Response
 {
-    public function dump(?string $selector = null): void
+    public function crawler(): Crawler
+    {
+        $crawler = new Crawler();
+        $crawler->addHtmlContent($this->body());
+
+        return $crawler;
+    }
+
+    /**
+     * @internal
+     */
+    final public function dump(?string $selector = null): void
     {
         if (null === $selector) {
             parent::dump();
 
             return;
         }
 
-        $elements = $this->session()->getPage()->findAll('css', $selector);
-        $elements = \array_map(static fn(NodeElement $node) => $node->getHtml(), $elements);
+        $elements = $this->crawler()->filter($selector);
 
-        if (empty($elements)) {
+        if (0 === $elements->count()) {
             throw new \RuntimeException("Element \"{$selector}\" not found.");
         }
 
-        foreach ($elements as $element) {
-            VarDumper::dump($element);
-        }
+        $elements->each(function(Crawler $node) {
+            VarDumper::dump($node->html());
+        });
     }
 }

src/Browser/Response/JsonResponse.php

@@ -20,6 +20,9 @@ public function json()
         return \json_decode($this->body(), true, 512, \JSON_THROW_ON_ERROR);
     }
 
+    /**
+     * @internal
+     */
     public function dump(?string $selector = null): void
     {
         if (null === $selector) {
@@ -34,6 +37,9 @@ public function search(string $selector)
         return search($selector, $this->json());
     }
 
+    /**
+     * @internal
+     */
     protected function rawBody(): string
     {
         return \json_encode($this->json(), \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES | \JSON_THROW_ON_ERROR);

src/Browser/Response/PantherResponse.php

@@ -4,6 +4,8 @@
 
 /**
  * @author Kevin Bond <[email protected]>
+ *
+ * @internal
  */
 final class PantherResponse extends HtmlResponse
 {

src/Browser/Response/XmlResponse.php

@@ -11,6 +11,17 @@
  */
 final class XmlResponse extends Response
 {
+    public function crawler(): Crawler
+    {
+        $dom = new \DOMDocument();
+        $dom->loadXML($this->body());
+
+        return new Crawler($dom);
+    }
+
+    /**
+     * @internal
+     */
     public function dump(?string $selector = null): void
     {
         if (null === $selector) {
@@ -19,10 +30,7 @@ public function dump(?string $selector = null): void
             return;
         }
 
-        $dom = new \DOMDocument();
-        $dom->loadXML($this->body());
-
-        $elements = (new Crawler($dom))->filter($selector);
+        $elements = $this->crawler()->filter($selector);
 
         if (!\count($elements)) {
             throw new \RuntimeException("Element \"{$selector}\" not found.");

tests/BrowserKitBrowserTests.php

@@ -367,6 +367,22 @@ public function can_save_formatted_json_source(): void
         $this->assertStringContainsString('    "content": "",', $contents);
     }
 
+    /**
+     * @test
+     */
+    public function can_access_json_response(): void
+    {
+        $response = $this->browser()
+            ->post('/json', ['json' => $expected = ['foo' => 'bar']])
+            ->assertSuccessful()
+            ->response()
+            ->assertJson()
+        ;
+
+        $this->assertSame($expected, $response->json());
+        $this->assertSame('bar', $response->search('foo'));
+    }
+
     /**
      * @test
      */
@@ -396,4 +412,20 @@ public function can_dump_xml_selector(): void
         $this->assertSame('https://www.example.com/page1', $output[0]);
         $this->assertSame('https://www.example.com/page2', $output[1]);
     }
+
+    /**
+     * @test
+     */
+    public function can_access_the_xml_crawler(): void
+    {
+        $crawler = $this->browser()
+            ->visit('/xml')
+            ->response()
+            ->assertXml()
+            ->crawler()
+            ->filter('url loc')
+        ;
+
+        $this->assertCount(2, $crawler);
+    }
 }