Improve Container constraints

Author: nyamsprod

src/Dictionary.php

@@ -53,8 +53,7 @@ private static function filterMember(mixed $member): object
     {
         return match (true) {
             $member instanceof ParameterAccess && ($member instanceof MemberList || $member instanceof ValueAccess) => $member,
-            !$member instanceof ParameterAccess && ($member instanceof MemberList || $member instanceof ValueAccess),
-            $member instanceof MemberOrderedMap => throw new InvalidArgument('An instance of "'.$member::class.'" can not be a member of "'.self::class.'".'),
+            $member instanceof StructuredField => throw new InvalidArgument('An instance of "'.$member::class.'" can not be a member of "'.self::class.'".'),
             is_iterable($member) => InnerList::new(...$member),
             default => Item::new($member),
         };
@@ -186,6 +185,8 @@ public function has(string|int ...$keys): bool
     /**
      * @throws SyntaxError   If the key is invalid
      * @throws InvalidOffset If the key is not found
+     *
+     * @return SfMember
      */
     public function get(string|int $key): StructuredField
     {
@@ -236,15 +237,15 @@ public function pair(int $index): array
     public function add(string $key, StructuredField|Token|ByteSequence|DateTimeInterface|string|int|float|bool $member): static
     {
         $members = $this->members;
-        $members[$key] = self::filterMember($member);
+        $members[MapKey::from($key)->value] = self::filterMember($member);
 
         return $this->newInstance($members);
     }
 
     /**
      * @param array<string, SfMember> $members
      */
-    private function newInstance(array $members): static
+    private function newInstance(array $members): self
     {
         if ($members == $this->members) {
             return $this;
@@ -268,7 +269,7 @@ public function append(string $key, StructuredField|Token|ByteSequence|DateTimeI
     {
         $members = $this->members;
         unset($members[$key]);
-        $members[$key] = self::filterMember($member);
+        $members[MapKey::from($key)->value] = self::filterMember($member);
 
         return $this->newInstance($members);
     }
@@ -277,7 +278,7 @@ public function prepend(string $key, StructuredField|Token|ByteSequence|DateTime
     {
         $members = $this->members;
         unset($members[$key]);
-        $members = [$key => self::filterMember($member), ...$members];
+        $members = [MapKey::from($key)->value => self::filterMember($member), ...$members];
 
         return $this->newInstance($members);
     }

src/DictionaryTest.php

@@ -123,7 +123,7 @@ public function it_fails_to_add_an_item_with_wrong_key(): void
     }
 
     #[Test]
-    public function it_fails_to_insert_somethine_other_than_a_inner_list_or_an_item(): void
+    public function it_fails_to_insert_something_other_than_a_inner_list_or_an_item(): void
     {
         $this->expectException(InvalidArgument::class);
 

src/InnerList.php

@@ -22,6 +22,7 @@
  *
  * @phpstan-import-type SfItem from StructuredField
  * @phpstan-import-type SfItemInput from StructuredField
+ *
  * @implements MemberList<int, SfItem>
  */
 final class InnerList implements MemberList, ParameterAccess
@@ -62,11 +63,18 @@ public static function fromHttpValue(Stringable|string $httpValue): self
     }
 
     /**
-     * Returns a new instance.
+     * Returns a new instance with an iter.
+     *
+     * @param iterable<SfItemInput> $value
+     * @param iterable<string, SfItemInput> $parameters
      */
-    public static function new(StructuredField|Token|ByteSequence|DateTimeInterface|string|int|float|bool ...$members): self
+    public static function fromAssociative(iterable $value, iterable $parameters): self
     {
-        return new self($members, Parameters::new());
+        if (!$parameters instanceof Parameters) {
+            $parameters = Parameters::fromAssociative($parameters);
+        }
+
+        return new self($value, $parameters);
     }
 
     /**
@@ -93,32 +101,11 @@ public static function fromPair(array $pair): self
     }
 
     /**
-     * Returns a new instance with an iter.
-     *
-     * @param iterable<SfItemInput> $value
-     * @param iterable<string, SfItemInput> $parameters
+     * Returns a new instance.
      */
-    public static function fromAssociative(iterable $value, iterable $parameters): self
-    {
-        if (!$parameters instanceof Parameters) {
-            $parameters = Parameters::fromAssociative($parameters);
-        }
-
-        return new self($value, $parameters);
-    }
-
-    public function parameters(): Parameters
-    {
-        return $this->parameters;
-    }
-
-    public function parameter(string $key): mixed
+    public static function new(StructuredField|Token|ByteSequence|DateTimeInterface|string|int|float|bool ...$members): self
     {
-        try {
-            return $this->parameters->get($key)->value();
-        } catch (StructuredFieldError) {
-            return null;
-        }
+        return new self($members, Parameters::new());
     }
 
     public function toHttpValue(): string
@@ -139,6 +126,25 @@ public function toPair(): array
         return [$this->members, $this->parameters];
     }
 
+    public function getIterator(): Iterator
+    {
+        yield from $this->members;
+    }
+
+    public function parameters(): Parameters
+    {
+        return $this->parameters;
+    }
+
+    public function parameter(string $key): mixed
+    {
+        try {
+            return $this->parameters->get($key)->value();
+        } catch (StructuredFieldError) {
+            return null;
+        }
+    }
+
     public function count(): int
     {
         return count($this->members);
@@ -162,11 +168,6 @@ public function keys(): array
         return array_keys($this->members);
     }
 
-    public function getIterator(): Iterator
-    {
-        yield from $this->members;
-    }
-
     public function has(string|int ...$keys): bool
     {
         foreach ($keys as $offset) {
@@ -208,34 +209,6 @@ public function get(string|int $key): StructuredField
         return $this->members[$index];
     }
 
-    /**
-     * @param int $offset
-     */
-    public function offsetExists(mixed $offset): bool
-    {
-        return $this->has($offset);
-    }
-
-    /**
-     * @param int $offset
-     *
-     * @return SfItem
-     */
-    public function offsetGet(mixed $offset): mixed
-    {
-        return $this->get($offset);
-    }
-
-    public function offsetUnset(mixed $offset): void
-    {
-        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
-    }
-
-    public function offsetSet(mixed $offset, mixed $value): void
-    {
-        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
-    }
-
     /**
      * Inserts members at the beginning of the list.
      */
@@ -288,8 +261,13 @@ public function replace(int $key, StructuredField|Token|ByteSequence|DateTimeInt
             throw InvalidOffset::dueToIndexNotFound($key);
         }
 
+        $member = self::filterMember($member);
+        if ($member == $this->members[$offset]) {
+            return $this;
+        }
+
         $members = $this->members;
-        $members[$offset] = $member;
+        $members[$offset] = self::filterMember($member);
 
         return new self($members, $this->parameters);
     }
@@ -315,6 +293,34 @@ public function remove(string|int ...$keys): static
         ), $this->parameters);
     }
 
+    /**
+     * @param int $offset
+     */
+    public function offsetExists(mixed $offset): bool
+    {
+        return $this->has($offset);
+    }
+
+    /**
+     * @param int $offset
+     *
+     * @return SfItem
+     */
+    public function offsetGet(mixed $offset): mixed
+    {
+        return $this->get($offset);
+    }
+
+    public function offsetUnset(mixed $offset): void
+    {
+        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
+    }
+
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
+    }
+
     public function withParameters(Parameters $parameters): static
     {
         return ($this->parameters->toHttpValue() === $parameters->toHttpValue()) ? $this : new self($this->members, $parameters);

src/InnerListTest.php

@@ -75,6 +75,15 @@ public function it_can_unshift_insert_and_replace(): void
         self::assertSame('(:SGVsbG8gV29ybGQ=: 42.0 42)', (string) $container);
     }
 
+    #[Test]
+    public function it_can_return_the_same_object_if_no_replace_is_needed(): void
+    {
+        $item = Item::new(ByteSequence::fromDecoded('Hello World'));
+        $field = InnerList::new($item);
+
+        self::assertSame($field, $field->replace(0, ByteSequence::fromDecoded('Hello World')));
+    }
+
     #[Test]
     public function it_returns_the_same_object_if_nothing_is_changed(): void
     {

src/Item.php

@@ -83,7 +83,7 @@ public static function fromPair(array $pair): self
         }
 
         if (2 !== count($pair)) { /* @phpstan-ignore-line */
-            throw new SyntaxError('The pair first member must be the item value and the optional second member the item parameters.');
+            throw new SyntaxError('The pair first member is the item value; its second member is the item parameters.');
         }
 
         if (!$pair[1] instanceof Parameters) {