Make Value more strict

Author: nyamsprod

README.md

@@ -213,9 +213,11 @@ The `Item` value object exposes a number of named constructors to construct
 bare items (ie: item without parameters attached to them).
 
 ```php
+use Bakame\Http\StructuredFields\ByteSequence;
 use Bakame\Http\StructuredFields\Item;
+use Bakame\Http\StructuredFields\Token;
 
-Item::new(mixed $value): self;
+Item:new(DateTimeInterface|ByteSequence|Token|string|int|float|bool $value): self
 Item::fromDecodedByteSequence(Stringable|string $value): self;
 Item::fromEncodedByteSequence(Stringable|string $value): self;
 Item::fromToken(Stringable|string $value): self;

src/InnerList.php

@@ -5,6 +5,7 @@
 namespace Bakame\Http\StructuredFields;
 
 use ArrayAccess;
+use DateTimeImmutable;
 use DateTimeInterface;
 use Iterator;
 use Stringable;
@@ -66,7 +67,7 @@ public static function fromHttpValue(Stringable|string $httpValue): self
      * Returns a new instance with an iter.
      *
      * @param iterable<SfItemInput> $value
-     * @param iterable<string, SfItemInput> $parameters
+     * @param MemberOrderedMap<string, SfItem>|iterable<string, SfItemInput> $parameters
      */
     public static function fromAssociative(iterable $value, iterable $parameters): self
     {
@@ -85,19 +86,11 @@ public static function fromAssociative(iterable $value, iterable $parameters): s
      */
     public static function fromPair(array $pair): self
     {
-        if (!array_is_list($pair)) { /* @phpstan-ignore-line */
-            throw new SyntaxError('The pair must be represented by an array as a list.');
-        }
-
-        if (2 !== count($pair)) { /* @phpstan-ignore-line */
-            throw new SyntaxError('The pair first member must be the member list and the optional second member the inner list parameters.');
-        }
-
-        if (!$pair[1] instanceof Parameters) {
-            $pair[1] = Parameters::fromPairs($pair[1]);
-        }
-
-        return new self($pair[0], $pair[1]);
+        return match (true) {
+            !array_is_list($pair) => throw new SyntaxError('The pair must be represented by an array as a list.'), /* @phpstan-ignore-line */
+            2 !== count($pair) => throw new SyntaxError('The pair first member must be the member list and the second member the inner list parameters.'), /* @phpstan-ignore-line */
+            default => new self($pair[0], !$pair[1] instanceof Parameters ? Parameters::fromPairs($pair[1]) : $pair[1]),
+        };
     }
 
     /**
@@ -136,7 +129,7 @@ public function parameters(): Parameters
         return $this->parameters;
     }
 
-    public function parameter(string $key): mixed
+    public function parameter(string $key): Token|ByteSequence|DateTimeImmutable|int|float|string|bool|null
     {
         try {
             return $this->parameters->get($key)->value();

src/Item.php

@@ -59,7 +59,7 @@ public static function fromHttpValue(Stringable|string $httpValue): self
      *
      * @throws SyntaxError If the value or the parameters are not valid
      */
-    public static function fromAssociative(mixed $value, iterable $parameters): self
+    public static function fromAssociative(DateTimeInterface|ByteSequence|Token|string|int|float|bool $value, iterable $parameters): self
     {
         if (!$parameters instanceof Parameters) {
             $parameters = Parameters::fromAssociative($parameters);
@@ -70,35 +70,27 @@ public static function fromAssociative(mixed $value, iterable $parameters): self
 
     /**
      * @param array{
-     *     0:SfItemInput,
+     *     0:DateTimeInterface|ByteSequence|Token|string|int|float|bool,
      *     1:MemberOrderedMap<string, SfItem>|iterable<array{0:string, 1:SfItemInput}>
      * } $pair
      *
      * @throws SyntaxError If the pair or its content is not valid.
      */
     public static function fromPair(array $pair): self
     {
-        if (!array_is_list($pair)) { /* @phpstan-ignore-line */
-            throw new SyntaxError('The pair must be represented by an array as a list.');
-        }
-
-        if (2 !== count($pair)) { /* @phpstan-ignore-line */
-            throw new SyntaxError('The pair first member is the item value; its second member is the item parameters.');
-        }
-
-        if (!$pair[1] instanceof Parameters) {
-            $pair[1] = Parameters::fromPairs($pair[1]);
-        }
-
-        return new self(new Value($pair[0]), $pair[1]);
+        return match (true) {
+            !array_is_list($pair) => throw new SyntaxError('The pair must be represented by an array as a list.'), /* @phpstan-ignore-line */
+            2 !== count($pair) => throw new SyntaxError('The pair first member is the item value; its second member is the item parameters.'), /* @phpstan-ignore-line */
+            default => new self(new Value($pair[0]), $pair[1] instanceof Parameters ? $pair[1] : Parameters::fromPairs($pair[1])),
+        };
     }
 
     /**
      * Returns a new bare instance from value.
      *
      * @throws SyntaxError If the value is not valid.
      */
-    public static function new(mixed $value): self
+    public static function new(DateTimeInterface|ByteSequence|Token|string|int|float|bool $value): self
     {
         return self::fromValue(new Value($value));
     }
@@ -242,7 +234,7 @@ public function parameters(): Parameters
         return $this->parameters;
     }
 
-    public function parameter(string $key): mixed
+    public function parameter(string $key): Token|ByteSequence|DateTimeImmutable|int|float|string|bool|null
     {
         try {
             return $this->parameters->get($key)->value();
@@ -274,7 +266,7 @@ public function toPair(): array
         return [$this->value->value, $this->parameters];
     }
 
-    public function withValue(mixed $value): static
+    public function withValue(DateTimeInterface|ByteSequence|Token|string|int|float|bool $value): static
     {
         $value = new Value($value);
         if ($value->equals($this->value)) {

src/ItemTest.php

@@ -32,7 +32,7 @@ final class ItemTest extends StructuredFieldTestCase
 
     #[Test]
     #[DataProvider('provideInvalidArguments')]
-    public function it_fails_to_instantiate_an_item(mixed $value): void
+    public function it_fails_to_instantiate_an_item(ByteSequence|Token|DateTimeInterface|string|int|float|bool $value): void
     {
         $this->expectException(SyntaxError::class);
 
@@ -75,19 +75,16 @@ public static function provideInvalidArguments(): iterable
 
     #[Test]
     #[DataProvider('provideFrom1stArgument')]
-    public function it_instantiate_many_types(ValueAccess|ByteSequence|Token|DateTimeInterface|string|int|float|bool $value, string $expected): void
+    public function it_instantiate_many_types(ByteSequence|Token|DateTimeInterface|string|int|float|bool $value, string $expected): void
     {
         self::assertSame($expected, Item::new($value)->toHttpValue());
     }
 
     #[Test]
     #[DataProvider('provideFrom1stArgument')]
-    public function it_updates_item(ValueAccess|ByteSequence|Token|DateTimeInterface|string|int|float|bool $value, string $expected): void
+    public function it_updates_item(ByteSequence|Token|DateTimeInterface|string|int|float|bool $value, string $expected): void
     {
         $parameters = Parameters::fromAssociative(['foo' => 'bar']);
-        if ($value instanceof ParameterAccess && $value instanceof ValueAccess) {
-            $expected = $value->withoutAnyParameter()->toHttpValue();
-        }
 
         self::assertSame(
             $expected.$parameters->toHttpValue(),
@@ -100,8 +97,6 @@ public function it_updates_item(ValueAccess|ByteSequence|Token|DateTimeInterface
      */
     public static function provideFrom1stArgument(): iterable
     {
-        $item = Item::new(42);
-
         return [
             'decimal' => ['value' => 42.0, 'expected' => '42.0'],
             'string' => ['value' => 'forty-two', 'expected' => '"forty-two"'],
@@ -111,7 +106,6 @@ public static function provideFrom1stArgument(): iterable
             'token' => ['value' => Token::fromString('helloworld'), 'expected' => 'helloworld'],
             'byte sequence' => ['value' => ByteSequence::fromDecoded('foobar'), 'expected' => ':Zm9vYmFy:'],
             'datetime' => ['value' => new DateTime('2020-03-04 19:23:15'), 'expected' => '@1583349795'],
-            'value' => ['value' => $item, 'expected' => $item->toHttpValue()],
         ];
     }
 

src/ParameterAccess.php

@@ -4,8 +4,9 @@
 
 namespace Bakame\Http\StructuredFields;
 
+use DateTimeImmutable;
+
 /**
- * @phpstan-import-type SfTypeInput from StructuredField
  * @phpstan-import-type SfItem from StructuredField
  */
 interface ParameterAccess
@@ -22,10 +23,8 @@ public function parameters(): Parameters;
 
     /**
      * Returns the member value or null if no members value exists.
-     *
-     * @return SfTypeInput|null
      */
-    public function parameter(string $key): mixed;
+    public function parameter(string $key): Token|ByteSequence|DateTimeImmutable|int|float|string|bool|null;
 
     /**
      * Adds a member if its key is not present at the of the associated parameter instance or update the instance at the given key.

src/Parameters.php

@@ -20,7 +20,6 @@
 /**
  * @see https://www.rfc-editor.org/rfc/rfc8941.html#section-3.1.2
  *
- * @phpstan-import-type SfTypeInput from StructuredField
  * @phpstan-import-type SfItem from StructuredField
  * @phpstan-import-type SfItemInput from StructuredField
  *

src/Parser.php

@@ -187,7 +187,7 @@ private static function parseInnerListValue(string $httpValue): array
      *
      * @see https://www.rfc-editor.org/rfc/rfc8941.html#section-4.2.3.1
      *
-     * @return array{0:SfTypeInput, 1:int}
+     * @return array{0:ByteSequence|Token|DateTimeImmutable|string|int|float|bool, 1:int}
      */
     public static function parseBareItem(string $httpValue): array
     {

src/Type.php

@@ -4,6 +4,7 @@
 
 namespace Bakame\Http\StructuredFields;
 
+use DateTimeInterface;
 use Throwable;
 
 /**
@@ -28,15 +29,15 @@ public function equals(mixed $other): bool
         return $other instanceof self && $other === $this;
     }
 
-    public static function fromValue(mixed $value): self
+    public static function fromValue(ValueAccess|Token|ByteSequence|DateTimeInterface|int|float|string|bool $value): self
     {
         return (new Value($value))->type;
     }
 
     public static function tryFromValue(mixed $value): self|null
     {
         try {
-            return self::fromValue($value);
+            return self::fromValue($value); /* @phpstan-ignore-line */
         } catch (Throwable) {
             return null;
         }

src/TypeTest.php

@@ -12,14 +12,6 @@
 
 final class TypeTest extends TestCase
 {
-    #[Test]
-    public function it_will_throw_if_the_type_is_no_supported(): void
-    {
-        $this->expectException(InvalidArgument::class);
-
-        Type::fromValue([]);
-    }
-
     #[Test]
     public function it_will_return_null_if_the_type_is_no_supported(): void
     {
@@ -43,7 +35,7 @@ public function it_can_tell_the_item_type_from_a_value_instance(): void
     #[DataProvider('itemTypeProvider')]
     public function it_can_tell_the_item_type(mixed $value, Type $expectedType): void
     {
-        self::assertTrue($expectedType->equals(Type::fromValue($value)));
+        self::assertTrue($expectedType->equals(Type::fromValue($value))); /* @phpstan-ignore-line */
         self::assertTrue($expectedType->equals(Type::tryFromValue($value)));
     }
 

src/Value.php

@@ -15,7 +15,6 @@
 use function is_bool;
 use function is_float;
 use function is_int;
-use function is_string;
 use function json_encode;
 use function preg_match;
 use function preg_replace;
@@ -32,7 +31,7 @@ final class Value
     public readonly Token|ByteSequence|DateTimeImmutable|int|float|string|bool $value;
     public readonly Type $type;
 
-    public function __construct(mixed $value)
+    public function __construct(ValueAccess|Token|ByteSequence|DateTimeInterface|int|float|string|bool $value)
     {
         [$this->value, $this->type] = match (true) {
             $value instanceof ValueAccess => [$value->value(), $value->type()],
@@ -42,8 +41,7 @@ public function __construct(mixed $value)
             is_int($value) => [self::filterIntegerRange($value, 'Integer'), Type::Integer],
             is_float($value) => [self::filterDecimal($value), Type::Decimal],
             is_bool($value) => [$value, Type::Boolean],
-            is_string($value) => [self::filterString($value), Type::String],
-            default => throw new InvalidArgument('The type "'.(is_object($value) ? $value::class : gettype($value)).'" is not supported.')
+            default => [self::filterString($value), Type::String],
         };
     }
 
@@ -216,13 +214,13 @@ public static function false(): self
     public function serialize(): string
     {
         return match (true) {
-            is_string($this->value) => '"'.preg_replace('/(["\\\])/', '\\\$1', $this->value).'"',
+            $this->value instanceof DateTimeImmutable => '@'.$this->value->getTimestamp(),
+            $this->value instanceof Token => $this->value->toString(),
+            $this->value instanceof ByteSequence => ':'.$this->value->encoded().':',
             is_int($this->value) => (string) $this->value,
             is_float($this->value) => self::serializeDecimal($this->value),
             is_bool($this->value) => '?'.($this->value ? '1' : '0'),
-            $this->value instanceof Token => $this->value->toString(),
-            $this->value instanceof DateTimeImmutable => '@'.$this->value->getTimestamp(),
-            default => ':'.$this->value->encoded().':',
+            default => '"'.preg_replace('/(["\\\])/', '\\\$1', $this->value).'"',
         };
     }
 

src/ValueAccess.php

@@ -5,10 +5,8 @@
 namespace Bakame\Http\StructuredFields;
 
 use DateTimeImmutable;
+use DateTimeInterface;
 
-/**
- * @phpstan-import-type SfTypeInput from StructuredField
- */
 interface ValueAccess extends StructuredField
 {
     /**
@@ -27,9 +25,7 @@ public function type(): Type;
      * This method MUST retain the state of the current instance, and return
      * an instance that contains the specified value change.
      *
-     * @param ValueAccess|SfTypeInput $value
-     *
      * @throws SyntaxError If the value is invalid or not supported
      */
-    public function withValue(mixed $value): static;
+    public function withValue(DateTimeInterface|ByteSequence|Token|string|int|float|bool $value): static;
 }