adding support for MapKey object

nyamsprod · nyamsprod · commit 593e6cfa06da · 2023-03-22T17:27:59.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 - `Value` class to improve Item public API;
 - `Item` implements the `ValueAccess` interface;
 - `Item::fromValue` named constructor to instantiate a new `Item` from a `Value` object;
+- Adding support for `MapKey` object.
 
 ### Fixed
 
diff --git a/src/InnerList.php b/src/InnerList.php
@@ -53,7 +53,7 @@ private static function filterMember(mixed $member): object
     /**
      * Returns a new instance.
      */
-    public static function from(ValueAccess|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool ...$members): self
+    public static function from(StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool ...$members): self
     {
         return new self(Parameters::create(), $members);
     }
@@ -75,7 +75,7 @@ public static function fromPairs(
      */
     public static function fromAssociative(
         iterable $parameters,
-        ValueAccess|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool ...$members
+        StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool ...$members
     ): self {
         return new self(Parameters::fromAssociative($parameters), $members);
     }
@@ -97,47 +97,50 @@ public function parameters(): Parameters
         return $this->parameters;
     }
 
-    public function parameter(string $key): mixed
+    public function parameter(MapKey|string $key): mixed
     {
+        $key = $key instanceof MapKey ? $key->value : $key;
         if ($this->parameters->has($key)) {
             return $this->parameters->get($key)->value();
         }
 
         return null;
     }
 
-    public function addParameter(string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
+    public function withParameters(Parameters $parameters): static
     {
-        return $this->withParameters($this->parameters()->add($key, $member));
+        if ($this->parameters->toHttpValue() === $parameters->toHttpValue()) {
+            return $this;
+        }
+
+        return new static($parameters, $this->members);
     }
 
-    public function prependParameter(string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
+    public function addParameter(MapKey|string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
     {
-        return $this->withParameters($this->parameters()->prepend($key, $member));
+        return $this->withParameters($this->parameters()->add($key instanceof MapKey ? $key->value : $key, $member));
     }
 
-    public function appendParameter(string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
+    public function prependParameter(MapKey|string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
     {
-        return $this->withParameters($this->parameters()->append($key, $member));
+        return $this->withParameters($this->parameters()->prepend($key instanceof MapKey ? $key->value : $key, $member));
     }
 
-    public function withoutParameter(string ...$keys): static
+    public function appendParameter(MapKey|string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
     {
-        return $this->withParameters($this->parameters()->remove(...$keys));
+        return $this->withParameters($this->parameters()->append($key instanceof MapKey ? $key->value : $key, $member));
     }
 
-    public function withoutAnyParameter(): static
+    public function withoutParameter(MapKey|string ...$keys): static
     {
-        return $this->withParameters(Parameters::create());
+        return $this->withParameters($this->parameters()->remove(
+            ...array_map(fn (MapKey|string $key): string => $key instanceof MapKey ? $key->value : $key, $keys)
+        ));
     }
 
-    public function withParameters(Parameters $parameters): static
+    public function withoutAnyParameter(): static
     {
-        if ($this->parameters->toHttpValue() === $parameters->toHttpValue()) {
-            return $this;
-        }
-
-        return new static($parameters, $this->members);
+        return $this->withParameters(Parameters::create());
     }
 
     public function toHttpValue(): string
diff --git a/src/Item.php b/src/Item.php
@@ -200,24 +200,26 @@ public function withParameters(Parameters $parameters): static
         return $this->parameters->toHttpValue() === $parameters->toHttpValue() ? $this : new static($this->value, $parameters);
     }
 
-    public function addParameter(string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
+    public function addParameter(MapKey|string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
     {
-        return $this->withParameters($this->parameters()->add($key, $member));
+        return $this->withParameters($this->parameters()->add($key instanceof MapKey ? $key->value : $key, $member));
     }
 
-    public function prependParameter(string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
+    public function prependParameter(MapKey|string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
     {
-        return $this->withParameters($this->parameters()->prepend($key, $member));
+        return $this->withParameters($this->parameters()->prepend($key instanceof MapKey ? $key->value : $key, $member));
     }
 
-    public function withoutParameter(string ...$keys): static
+    public function appendParameter(MapKey|string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
     {
-        return $this->withParameters($this->parameters()->remove(...$keys));
+        return $this->withParameters($this->parameters()->append($key instanceof MapKey ? $key->value : $key, $member));
     }
 
-    public function appendParameter(string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
+    public function withoutParameter(MapKey|string ...$keys): static
     {
-        return $this->withParameters($this->parameters()->append($key, $member));
+        return $this->withParameters($this->parameters()->remove(
+            ...array_map(fn (MapKey|string $key): string => $key instanceof MapKey ? $key->value : $key, $keys)
+        ));
     }
 
     public function withoutAnyParameter(): static
diff --git a/src/ParameterAccess.php b/src/ParameterAccess.php
@@ -5,7 +5,7 @@
 namespace Bakame\Http\StructuredFields;
 
 /**
- * @phpstan-import-type SfTypeInput from ValueAccess
+ * @phpstan-import-type SfTypeInput from StructuredField
  */
 interface ParameterAccess
 {
diff --git a/src/Parameters.php b/src/Parameters.php
@@ -241,10 +241,10 @@ public function pair(int $index): array
         return [...$this->toPairs()][$this->filterIndex($index)];
     }
 
-    public function add(string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
+    public function add(MapKey|string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
     {
         $members = $this->members;
-        $members[$key] = $member;
+        $members[$key instanceof MapKey ? $key->value : $key] = $member;
 
         return new self($members);
     }
@@ -266,8 +266,9 @@ public function remove(MapKey|string|int ...$keys): static
     /**
      * @param SfItemInput $member
      */
-    public function append(string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
+    public function append(MapKey|string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
     {
+        $key = $key instanceof MapKey ? $key->value : $key;
         $members = $this->members;
         unset($members[$key]);
         $members[$key] = $member;
@@ -282,8 +283,9 @@ public function append(string $key, StructuredField|Token|ByteSequence|DateTimeI
     /**
      * @param SfItemInput $member
      */
-    public function prepend(string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
+    public function prepend(MapKey|string $key, StructuredField|Token|ByteSequence|DateTimeInterface|Stringable|string|int|float|bool $member): static
     {
+        $key = $key instanceof MapKey ? $key->value : $key;
         $members = $this->members;
         unset($members[$key]);
 

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ private static function filterMember(mixed $member): object`
`53`	`53`	`/**`
`54`	`54`	`* Returns a new instance.`
`55`	`55`	`*/`
`56`		`- public static function from(ValueAccess\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool ...$members): self`
	`56`	`+ public static function from(StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool ...$members): self`
`57`	`57`	`{`
`58`	`58`	`return new self(Parameters::create(), $members);`
`59`	`59`	`}`
`@@ -75,7 +75,7 @@ public static function fromPairs(`
`75`	`75`	`*/`
`76`	`76`	`public static function fromAssociative(`
`77`	`77`	`iterable $parameters,`
`78`		`- ValueAccess\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool ...$members`
	`78`	`+ StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool ...$members`
`79`	`79`	`): self {`
`80`	`80`	`return new self(Parameters::fromAssociative($parameters), $members);`
`81`	`81`	`}`
`@@ -97,47 +97,50 @@ public function parameters(): Parameters`
`97`	`97`	`return $this->parameters;`
`98`	`98`	`}`
`99`	`99`
`100`		`- public function parameter(string $key): mixed`
	`100`	`+ public function parameter(MapKey\|string $key): mixed`
`101`	`101`	`{`
	`102`	`+ $key = $key instanceof MapKey ? $key->value : $key;`
`102`	`103`	`if ($this->parameters->has($key)) {`
`103`	`104`	`return $this->parameters->get($key)->value();`
`104`	`105`	`}`
`105`	`106`
`106`	`107`	`return null;`
`107`	`108`	`}`
`108`	`109`
`109`		`- public function addParameter(string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
	`110`	`+ public function withParameters(Parameters $parameters): static`
`110`	`111`	`{`
`111`		`- return $this->withParameters($this->parameters()->add($key, $member));`
	`112`	`+ if ($this->parameters->toHttpValue() === $parameters->toHttpValue()) {`
	`113`	`+ return $this;`
	`114`	`+ }`
	`115`	`+`
	`116`	`+ return new static($parameters, $this->members);`
`112`	`117`	`}`
`113`	`118`
`114`		`- public function prependParameter(string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
	`119`	`+ public function addParameter(MapKey\|string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
`115`	`120`	`{`
`116`		`- return $this->withParameters($this->parameters()->prepend($key, $member));`
	`121`	`+ return $this->withParameters($this->parameters()->add($key instanceof MapKey ? $key->value : $key, $member));`
`117`	`122`	`}`
`118`	`123`
`119`		`- public function appendParameter(string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
	`124`	`+ public function prependParameter(MapKey\|string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
`120`	`125`	`{`
`121`		`- return $this->withParameters($this->parameters()->append($key, $member));`
	`126`	`+ return $this->withParameters($this->parameters()->prepend($key instanceof MapKey ? $key->value : $key, $member));`
`122`	`127`	`}`
`123`	`128`
`124`		`- public function withoutParameter(string ...$keys): static`
	`129`	`+ public function appendParameter(MapKey\|string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
`125`	`130`	`{`
`126`		`- return $this->withParameters($this->parameters()->remove(...$keys));`
	`131`	`+ return $this->withParameters($this->parameters()->append($key instanceof MapKey ? $key->value : $key, $member));`
`127`	`132`	`}`
`128`	`133`
`129`		`- public function withoutAnyParameter(): static`
	`134`	`+ public function withoutParameter(MapKey\|string ...$keys): static`
`130`	`135`	`{`
`131`		`- return $this->withParameters(Parameters::create());`
	`136`	`+ return $this->withParameters($this->parameters()->remove(`
	`137`	`+ ...array_map(fn (MapKey\|string $key): string => $key instanceof MapKey ? $key->value : $key, $keys)`
	`138`	`+ ));`
`132`	`139`	`}`
`133`	`140`
`134`		`- public function withParameters(Parameters $parameters): static`
	`141`	`+ public function withoutAnyParameter(): static`
`135`	`142`	`{`
`136`		`- if ($this->parameters->toHttpValue() === $parameters->toHttpValue()) {`
`137`		`- return $this;`
`138`		`- }`
`139`		`-`
`140`		`- return new static($parameters, $this->members);`
	`143`	`+ return $this->withParameters(Parameters::create());`
`141`	`144`	`}`
`142`	`145`
`143`	`146`	`public function toHttpValue(): string`
Original file line number	Diff line number	Diff line change
`@@ -200,24 +200,26 @@ public function withParameters(Parameters $parameters): static`
`200`	`200`	`return $this->parameters->toHttpValue() === $parameters->toHttpValue() ? $this : new static($this->value, $parameters);`
`201`	`201`	`}`
`202`	`202`
`203`		`- public function addParameter(string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
	`203`	`+ public function addParameter(MapKey\|string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
`204`	`204`	`{`
`205`		`- return $this->withParameters($this->parameters()->add($key, $member));`
	`205`	`+ return $this->withParameters($this->parameters()->add($key instanceof MapKey ? $key->value : $key, $member));`
`206`	`206`	`}`
`207`	`207`
`208`		`- public function prependParameter(string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
	`208`	`+ public function prependParameter(MapKey\|string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
`209`	`209`	`{`
`210`		`- return $this->withParameters($this->parameters()->prepend($key, $member));`
	`210`	`+ return $this->withParameters($this->parameters()->prepend($key instanceof MapKey ? $key->value : $key, $member));`
`211`	`211`	`}`
`212`	`212`
`213`		`- public function withoutParameter(string ...$keys): static`
	`213`	`+ public function appendParameter(MapKey\|string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
`214`	`214`	`{`
`215`		`- return $this->withParameters($this->parameters()->remove(...$keys));`
	`215`	`+ return $this->withParameters($this->parameters()->append($key instanceof MapKey ? $key->value : $key, $member));`
`216`	`216`	`}`
`217`	`217`
`218`		`- public function appendParameter(string $key, StructuredField\|Token\|ByteSequence\|DateTimeInterface\|Stringable\|string\|int\|float\|bool $member): static`
	`218`	`+ public function withoutParameter(MapKey\|string ...$keys): static`
`219`	`219`	`{`
`220`		`- return $this->withParameters($this->parameters()->append($key, $member));`
	`220`	`+ return $this->withParameters($this->parameters()->remove(`
	`221`	`+ ...array_map(fn (MapKey\|string $key): string => $key instanceof MapKey ? $key->value : $key, $keys)`
	`222`	`+ ));`
`221`	`223`	`}`
`222`	`224`
`223`	`225`	`public function withoutAnyParameter(): static`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`namespace Bakame\Http\StructuredFields;`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * @phpstan-import-type SfTypeInput from ValueAccess`
	`8`	`+ * @phpstan-import-type SfTypeInput from StructuredField`
`9`	`9`	`*/`
`10`	`10`	`interface ParameterAccess`
`11`	`11`	`{`