ReadmeTest: Add support for multiple examples

By moving the mock data to comments in the readme.

Author: jtojnar

README.md

@@ -11,6 +11,9 @@ $ composer require fossar/guzzle-transcoder
 
 ## Basic usage
 
+<!-- Headers: {"content-type": "text/html; charset=iso-8859-1; someOtherRandom=\"header in here\""} -->
+<!-- Mock response: iso-8859-1.html -->
+<!-- Expected: utf-8.html -->
 ```php
 use Fossar\GuzzleTranscoder\GuzzleTranscoder;
 use GuzzleHttp\Client;

tests/ReadmeTest.php

@@ -8,37 +8,45 @@
 use GuzzleHttp\Psr7\Response;
 
 class ReadmeTest extends \PHPUnit\Framework\TestCase {
-    public function testReadme(): void {
-        $contents = file_get_contents(__DIR__ . '/../README.md');
-        \assert($contents !== false); // For PHPStan.
-
-        $mockedSource = file_get_contents(__DIR__ . '/resources/iso-8859-1.html');
-        \assert($mockedSource !== false); // For PHPStan.
-
+    /**
+     * @param array<string, string> $mockedHeaders
+     *
+     * @dataProvider readmeExamples
+     */
+    public function testReadme(string $script, string $mockedSourceBody, array $mockedHeaders, string $expectedBody): void {
         $mock = new MockHandler([
-            new Response(200, ['content-type' => 'text/html; charset=iso-8859-1; someOtherRandom="header in here"'], $mockedSource),
+            new Response(200, $mockedHeaders, $mockedSourceBody),
         ]);
 
-        $contents = str_replace('HandlerStack::create();', 'HandlerStack::create($mock);', $contents);
-
-        preg_match_all('(```php\n(.*?)\n```)s', $contents, $matches, \PREG_SET_ORDER);
+        $script = str_replace('HandlerStack::create();', 'HandlerStack::create($mock);', $script);
 
-        $codes = array_map(function($match) {
-            return $match[1];
-        }, $matches);
-
-        $expected1 = file_get_contents(__DIR__ . '/resources/utf-8.html');
-        \assert($expected1 !== false); // For PHPStan.
-        $expectations = [
-            $expected1,
-        ];
+        $this->expectOutputString($expectedBody);
+        eval($script);
+    }
 
-        $cases = array_combine($codes, $expectations);
-        \assert($cases !== false); // For PHPStan.
+    /**
+     * @return iterable<array{string, string, array<string, string>, string}>
+     */
+    public function readmeExamples(): iterable {
+        $contents = file_get_contents(__DIR__ . '/../README.md');
+        \assert($contents !== false); // For PHPStan.
 
-        foreach ($cases as $code => $expectation) {
-            $this->expectOutputString($expectation);
-            eval($code);
+        preg_match_all('/<!-- Headers:\s*(?P<headers>.*?)\s*-->\n<!-- Mock response:\s*(?P<response>.*?)\s*-->\n<!-- Expected:\s*(?P<expected>.*?)\s*-->\n```php\n(?P<code>(?s).*?)\n```/', $contents, $matches, \PREG_SET_ORDER);
+
+        foreach ($matches as $match) {
+            $mockedSourceBody = file_get_contents(__DIR__ . '/resources/' . $match['response']);
+            \assert($mockedSourceBody !== false); // For PHPStan.
+            $mockedHeaders = json_decode($match['headers'], true);
+            \assert(\is_array($mockedHeaders)); // For PHPStan.
+            $expectedBody = file_get_contents(__DIR__ . '/resources/' . $match['expected']);
+            \assert($expectedBody !== false); // For PHPStan.
+
+            yield [
+                $match['code'],
+                $mockedSourceBody,
+                $mockedHeaders,
+                $expectedBody,
+            ];
         }
     }
 }