case-insensitive header key comparison

Author: Triplkrypl

src/Model/Server/HeaderRule.php

@@ -29,11 +29,11 @@ public function __construct(Exception $exceptionFactory, Validated $validated)
     /**
      * @param non-empty-string $key
      */
-    public function key(string $key): StringRule
+    public function key(string $key, bool $caseSensitive = false): StringRule
     {
-        $value = $this->validated->value();
-        $value = $value[$key] ?? [];
-        $value = array_pop($value);
+        $values = $this->headerValues($caseSensitive);
+        $values = $values[$caseSensitive ? $key : strtolower($key)] ?? [];
+        $value = array_pop($values);
         /** @var mixed $value */
         return new StringRule($this->exceptionFactory, new RuleChain(), new Validated($value), 'Request header: '.$key);
     }
@@ -44,10 +44,10 @@ public function key(string $key): StringRule
      * @param callable(StringRule): TMapped $callable
      * @return Collection<TMapped>
      */
-    public function keyOf(string $key, callable $callable): Collection
+    public function keyOf(string $key, callable $callable, bool $caseSensitive = false): Collection
     {
-        $value = $this->validated->value();
-        $values = $value[$key] ?? null;
+        $values = $this->headerValues($caseSensitive);
+        $values = $values[$caseSensitive ? $key : strtolower($key)] ?? null;
         /** @var mixed $values */
         return new Collection(
             $this->exceptionFactory,
@@ -57,4 +57,17 @@ public function keyOf(string $key, callable $callable): Collection
             fn (TypedKey $index) => $callable($index->string())
         );
     }
+
+    /**
+     * @return array<array<string>>|null
+     */
+    private function headerValues(bool $caseSensitive): ?array
+    {
+        $values = $this->validated->value();
+        if ($caseSensitive) {
+            return $values;
+        }
+
+        return $values !== null ? array_change_key_case($values, CASE_LOWER) : $values;
+    }
 }

test/Model/Server/HeaderRuleTest.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+use PHPUnit\Framework\TestCase;
+use SimpleAsFuck\ApiToolkit\Model\Server\HeaderRule;
+use SimpleAsFuck\Validator\Factory\UnexpectedValueException;
+use SimpleAsFuck\Validator\Model\Validated;
+use SimpleAsFuck\Validator\Rule\String\StringRule;
+
+/**
+ * @covers \SimpleAsFuck\ApiToolkit\Model\Server\HeaderRule
+ */
+final class HeaderRuleTest extends TestCase
+{
+    private HeaderRule $rule;
+
+    protected function setUp(): void
+    {
+        $testData = [
+            'header' => ['test'],
+            'Header1' => ['test1'],
+        ];
+        /** @var array<array<string>> $testData */
+        $this->rule = new HeaderRule(new UnexpectedValueException(), new Validated($testData));
+    }
+
+    /**
+     * @dataProvider dataProviderKeyOf
+     *
+     * @param non-empty-string $key
+     * @param array<string>|null $expectedValue
+     */
+    public function testKeyOf(?array $expectedValue, string $key, bool $caseSensitive): void
+    {
+        $headerValue = $this->rule->keyOf($key, fn (StringRule $rule): ?string => $rule->nullable(), $caseSensitive)->nullable();
+
+        self::assertSame($expectedValue, $headerValue);
+    }
+
+    /**
+     * @return non-empty-array<non-empty-array<mixed>>
+     */
+    public function dataProviderKeyOf(): array
+    {
+        return [
+            [null, 'notFound', false],
+            [null, 'notFound', true],
+            [['test'], 'header', false],
+            [['test'], 'Header', false],
+            [['test1'], 'header1', false],
+            [null, 'Header', true],
+            [['test1'], 'Header1', true],
+        ];
+    }
+
+    /**
+     * @dataProvider dataProviderKey
+     *
+     * @param non-empty-string $key
+     */
+    public function testKey(?string $expectedValue, string $key, bool $caseSensitive): void
+    {
+        $headerValue = $this->rule->key($key, $caseSensitive)->nullable();
+
+        self::assertSame($expectedValue, $headerValue);
+    }
+
+    /**
+     * @return non-empty-array<non-empty-array<mixed>>
+     */
+    public function dataProviderKey(): array
+    {
+        return [
+            [null, 'notFound', false],
+            [null, 'notFound', true],
+            ['test', 'header', false],
+            ['test', 'Header', false],
+            ['test1', 'header1', false],
+            [null, 'Header', true],
+            ['test1', 'Header1', true],
+        ];
+    }
+}