[#566] Replace vendor response headers container

Author: armanist

src/HttpClient/Adapters/CurlAdapter.php

@@ -11,7 +11,7 @@
 namespace Quantum\HttpClient\Adapters;
 
 use Quantum\HttpClient\Contracts\CurlAdapterInterface;
-use Curl\CaseInsensitiveArray;
+use Quantum\HttpClient\ResponseHeaders;
 use JsonSerializable;
 use RuntimeException;
 use CurlHandle;
@@ -46,7 +46,7 @@ class CurlAdapter implements CurlAdapterInterface
      */
     private $response;
 
-    private CaseInsensitiveArray $responseHeaders;
+    private ResponseHeaders $responseHeaders;
 
     /**
      * @var array<string, mixed>
@@ -74,7 +74,7 @@ public function __construct(?Curl $client = null)
         }
 
         $this->handle = $handle;
-        $this->responseHeaders = new CaseInsensitiveArray();
+        $this->responseHeaders = new ResponseHeaders();
         $this->applyOption(CURLOPT_RETURNTRANSFER, true);
         $this->applyOption(CURLOPT_HEADER, false);
         $this->applyOption(CURLOPT_HEADERFUNCTION, function ($handle, string $header): int {
@@ -356,7 +356,7 @@ private function resetResponseState(): void
     {
         $this->rawResponseHeaders = '';
         $this->response = null;
-        $this->responseHeaders = new CaseInsensitiveArray();
+        $this->responseHeaders = new ResponseHeaders();
         $this->responseCookies = [];
         $this->error = false;
         $this->errorCode = 0;
@@ -370,7 +370,7 @@ private function parseCookieHeader(string $header): void
         }
     }
 
-    private function parseResponseHeaders(string $rawHeaders): CaseInsensitiveArray
+    private function parseResponseHeaders(string $rawHeaders): ResponseHeaders
     {
         $headerBlocks = explode("\r\n\r\n", trim($rawHeaders));
         $responseHeader = '';
@@ -382,7 +382,7 @@ private function parseResponseHeaders(string $rawHeaders): CaseInsensitiveArray
             }
         }
 
-        $headers = new CaseInsensitiveArray();
+        $headers = new ResponseHeaders();
         $rawLines = preg_split('/\r\n/', $responseHeader, -1, PREG_SPLIT_NO_EMPTY);
 
         if ($rawLines === false || $rawLines === []) {

src/HttpClient/ResponseHeaders.php

@@ -0,0 +1,132 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Quantum PHP Framework
+ * An open-source software development framework for PHP
+ * @link https://quantumphp.io
+ */
+
+namespace Quantum\HttpClient;
+
+use ArrayAccess;
+use Countable;
+use Iterator;
+
+/**
+ * Class ResponseHeaders
+ * @package Quantum\HttpClient
+ * @implements ArrayAccess<int|string, mixed>
+ * @implements Iterator<int|string, mixed>
+ */
+class ResponseHeaders implements ArrayAccess, Countable, Iterator
+{
+    /**
+     * @var array<int|string, mixed>
+     */
+    private array $data = [];
+
+    /**
+     * @var array<string, int|string>
+     */
+    private array $keys = [];
+
+    /**
+     * @param array<int|string, mixed>|null $headers
+     */
+    public function __construct(?array $headers = null)
+    {
+        if ($headers !== null) {
+            foreach ($headers as $key => $value) {
+                $this->offsetSet($key, $value);
+            }
+        }
+    }
+
+    /**
+     * @param int|string|null $offset
+     * @param mixed $value
+     */
+    public function offsetSet($offset, $value): void
+    {
+        if ($offset === null) {
+            $this->data[] = $value;
+            return;
+        }
+
+        $normalizedOffset = strtolower((string) $offset);
+        $this->data[$normalizedOffset] = $value;
+        $this->keys[$normalizedOffset] = $offset;
+    }
+
+    /**
+     * @param int|string $offset
+     */
+    public function offsetExists($offset): bool
+    {
+        return array_key_exists(strtolower((string) $offset), $this->data);
+    }
+
+    /**
+     * @param int|string $offset
+     */
+    public function offsetUnset($offset): void
+    {
+        $normalizedOffset = strtolower((string) $offset);
+
+        unset($this->data[$normalizedOffset]);
+        unset($this->keys[$normalizedOffset]);
+    }
+
+    /**
+     * @param int|string $offset
+     * @return mixed|null
+     */
+    public function offsetGet($offset)
+    {
+        return $this->data[strtolower((string) $offset)] ?? null;
+    }
+
+    public function count(): int
+    {
+        return count($this->data);
+    }
+
+    /**
+     * @return mixed
+     */
+    public function current()
+    {
+        return current($this->data);
+    }
+
+    public function next(): void
+    {
+        next($this->data);
+    }
+
+    /**
+     * @return int|string|null
+     */
+    public function key()
+    {
+        $key = key($this->data);
+
+        if ($key === null) {
+            return null;
+        }
+
+        return $this->keys[$key] ?? $key;
+    }
+
+    public function valid(): bool
+    {
+        return key($this->data) !== null;
+    }
+
+    public function rewind(): void
+    {
+        reset($this->data);
+    }
+}

tests/Unit/HttpClient/Adapters/CurlAdapterTest.php

@@ -3,6 +3,7 @@
 namespace Quantum\Tests\Unit\HttpClient\Adapters;
 
 use Quantum\HttpClient\Adapters\CurlAdapter;
+use Quantum\HttpClient\ResponseHeaders;
 use Quantum\Tests\Unit\AppTestCase;
 use Curl\CaseInsensitiveArray;
 use Curl\Curl;
@@ -72,6 +73,7 @@ public function testCurlAdapterParsesNativeResponseHeaders(): void
             "HTTP/1.1 100 Continue\r\n\r\nHTTP/1.1 200 OK\r\nContent-Type: application/json\r\nMalformed Header\r\nX-Test: one\r\nX-Test: two\r\n\r\n",
         ]);
 
+        $this->assertInstanceOf(ResponseHeaders::class, $headers);
         $this->assertSame('HTTP/1.1 200 OK', $headers['status-line']);
         $this->assertSame('application/json', $headers['content-type']);
         $this->assertSame('one,two', $headers['x-test']);

tests/Unit/HttpClient/ResponseHeadersTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Quantum\Tests\Unit\HttpClient;
+
+use Quantum\HttpClient\ResponseHeaders;
+use Quantum\Tests\Unit\AppTestCase;
+
+class ResponseHeadersTest extends AppTestCase
+{
+    public function testResponseHeadersProvidesCaseInsensitiveAccess(): void
+    {
+        $headers = new ResponseHeaders(['Content-Type' => 'application/json']);
+
+        $this->assertSame('application/json', $headers['content-type']);
+        $this->assertSame('application/json', $headers['CONTENT-TYPE']);
+        $this->assertTrue(isset($headers['Content-Type']));
+    }
+
+    public function testResponseHeadersPreservesLatestOriginalKeyWhenIterating(): void
+    {
+        $headers = new ResponseHeaders(['Content-Type' => 'application/json']);
+        $headers['content-type'] = 'text/plain';
+
+        $this->assertSame(['content-type' => 'text/plain'], iterator_to_array($headers));
+    }
+
+    public function testResponseHeadersCanUnsetCaseInsensitively(): void
+    {
+        $headers = new ResponseHeaders(['Content-Type' => 'application/json']);
+
+        unset($headers['content-type']);
+
+        $this->assertCount(0, $headers);
+        $this->assertNull($headers['Content-Type']);
+    }
+}