phpunit warnings and exceptions

README.md

@@ -10,6 +10,55 @@ Hamlet Type
 
 ## Motivation
 
+The support for types in the PHP type system can be split into two big domains: static analysis time and runtime. 
+The PHP interpreter and the static analyzers like Psalm and PHPStan have different levels of support for the types. 
+
+On the language level there are three general mechanisms for type support: hinting, assertions and cascading. 
+
+The hinting can be done at compile time or run time. The compile time hinting is done through a hierarchy of different 
+mechansisms: 
+- the lowest level (lowest in terms of the level of support for different types) is the type hints, 
+- followed by phpdoc, 
+- followed by Psalm specific types. 
+
+```php
+/**
+ * @return array<string>
+ * @psalm-return array<non-empty-string>
+ */
+public function number(): array ...
+```
+
+Additionally, there's a support for type hints by use of type expression in this library
+
+```php
+/**
+ * @template T
+ * @param mixed $value
+ * @param Type<T> $type 
+ * @return T
+ */
+function convert(mixed $value, Type $type): mixed ...
+```
+
+By wrapping the `Type<T>`, you can use the type hinting to enforce the return type.
+
+The compile time type hinting is only useful if you run static analysis tools, like Psalm or PHPStan. 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 The PHP type system is a complicated beast. PHP supports types in three ways: hinting, assertions, and casting.
 
 To unwrap the complexity, it's easiest to start with the basic type `int`. The type hinting support is thorough; 

phpunit.xml

@@ -1,5 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" bootstrap="vendor/autoload.php" executionOrder="depends,defects" cacheDirectory=".phpunit.cache">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         executionOrder="depends,defects"
+         displayDetailsOnIncompleteTests="true"
+         displayDetailsOnSkippedTests="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
+         displayDetailsOnTestsThatTriggerErrors="true"
+         displayDetailsOnTestsThatTriggerNotices="true"
+         displayDetailsOnTestsThatTriggerWarnings="true"
+         cacheDirectory=".phpunit.cache">
   <testsuites>
     <testsuite name="default">
       <directory suffix="Test.php">tests</directory>

src/Parser/DocBlockAstTraverser.php

@@ -125,7 +125,7 @@ private function traverseTupleNode(ArrayShapeNode $node, ?NameContext $nameConte
     {
         $fields = [];
         foreach ($node->items as $item) {
-            if ($item->keyName->name) {
+            if ($item->keyName?->name) {
                 throw new RuntimeException('Unsupported object like arrays: ' . $node);
             }
             $fields[] = $this->traverse($item->valueType, $nameContext);

src/Types/NonEmptyStringType.php

@@ -26,7 +26,11 @@
         if (is_object($value) && !method_exists($value, '__toString')) {
             throw new CastException($value, $this);
         }
-        $stringValue = (string) $value;
+        if (is_array($value)) {
+            $stringValue = 'Array';
+        } else {
+            $stringValue = (string) $value;
+        }
         if ($stringValue === '') {
             throw new CastException($value, $this);
         }

src/Types/TupleType.php

@@ -59,6 +59,7 @@ public function __construct(array $fields)
         }
 
         $result = [];
+        $value = array_values($value);
         foreach ($this->fields as $i => $field) {
             $result[] = $field->resolveAndCast($value[$i], $resolver);
         }

src/Types/UnionType.php

@@ -24,6 +24,10 @@
      */
     public function __construct(array $options)
     {
+        $options = array_unique($options);
+        usort($options, fn (Type $a, Type $b) =>
+            $a instanceof NullType <=> $b instanceof NullType
+        );
         $this->options = $options;
     }
 
@@ -42,6 +46,13 @@ public function __construct(array $options)
         if ($this->matches($value)) {
             return $value;
         }
+        if (count($this->options) == 2 && $this->options[1] instanceof NullType) {
+            if ($value === null) {
+                return null;
+            } else {
+                return $this->options[0]->resolveAndCast($value, $resolver);
+            }
+        }
         throw new CastException($value, $this);
     }
 

tests/Parser/ParserTest.php

@@ -66,7 +66,7 @@ public static function typeDeclarations(): array
     #[DataProvider('typeDeclarations')] public function testTypeParser(string $specification): void
     {
         $type = type_of($specification);
-        Assert::assertNotNull($type);
+        $this->assertNotNull($type);
     }
 
     public static function phpDocDeclarations(): array
@@ -118,7 +118,7 @@ public static function phpDocDeclarations(): array
     #[DataProvider('phpDocDeclarations')] public function testPhpDocParser(string $specification)
     {
         $data = DocBlockParser::parseDoc($specification);
-        Assert::assertNotNull($data);
+        $this->assertNotNull($data);
     }
 
     /**
@@ -134,8 +134,8 @@ public function testNameResolver(): void
         $typeA = DocBlockParser::fromProperty($type, $type->getProperty('a'));
         $typeB = DocBlockParser::fromProperty($type, $type->getProperty('b'));
 
-        Assert::assertEquals('array<int,array<list{DateTime}>>', (string) $typeA);
-        Assert::assertEquals("'x'|'y'|'z'|Hamlet\Type\CastException|DateTime|null", (string) $typeB);
+        $this->assertEquals('array<int,array<list{DateTime}>>', (string)$typeA);
+        $this->assertEquals("'x'|'y'|'z'|Hamlet\Type\CastException|DateTime|null", (string)$typeB);
     }
 
     #[DataProvider('typeDeclarations')] public function testSerialization(string $specification): void

tests/TypeDeclarationTest.php

@@ -27,7 +27,7 @@ public function testTypeString(): void
                 _class(DateTime::class)
             )
         );
-        $this->assertEquals('array<int,null|DateTime>', (string)$type);
+        $this->assertEquals('array<int,DateTime|null>', (string)$type);
     }
 
     public function testLiteralType(): void

tests/Types/ArrayKeyTypeTest.php

@@ -29,7 +29,7 @@ protected function strictCastResultComparison(): bool
     protected function baselineCast(mixed $value): int|string|null
     {
         try {
-            $a = [
+            $a = @[
                 $value => 1
             ];
             return array_key_first($a);

tests/Types/ArrayTypeTest.php

@@ -28,10 +28,10 @@ protected function type(): Type
     protected function baselineCast(mixed $value): array
     {
         try {
-            $arrayValue = is_array($value) ? $value : (array) $value;
+            $arrayValue = is_array($value) ? $value : (array)$value;
             $expectedResult = [];
             foreach ($arrayValue as $key => $property) {
-                $expectedResult[$key] = (int) $property;
+                $expectedResult[$key] = @(int)$property;
             }
             return $expectedResult;
         } catch (Error) {

tests/Types/BoolTypeTest.php

@@ -20,7 +20,7 @@ protected function type(): Type
     protected function baselineCast(mixed $value): bool
     {
         try {
-            return (bool) $value;
+            return (bool)$value;
         } catch (TypeError) {
             throw new RuntimeException;
         }

tests/Types/CastCasesTrait.php

@@ -122,6 +122,8 @@ public function __toString()
             [[null, 1 => null]],
             [[false, 'barbeque' => 'sausage']],
             [['sausage', 2 => 3.1415, true]],
+            [['sausage', 2 => [0, 0 => null]]],
+            [[1 => [1 => [1 => [1 => [1 => [1 => [1 => [1 => [1 => []]]]]]]]]]],
             [new stdClass],
             [$object],
             [$stringableObject],
@@ -131,6 +133,7 @@ public function __toString()
             [null],
             [$intGenerator()],
             [$stringGenerator()],
+            [[1 => new stdClass, 2 => $object, 3 => $stringableObject, 4 => $callable, 5 => $resource, 6 => null]],
         ];
     }
 }

tests/Types/FloatTypeTest.php

@@ -17,10 +17,10 @@ protected function type(): Type
         return _float();
     }
 
-    protected function baselineCast(mixed $value): mixed
+    protected function baselineCast(mixed $value): float
     {
         try {
-            return (float) $value;
+            return @(float)$value;
         } catch (TypeError) {
             throw new RuntimeException;
         }

tests/Types/IntTypeTest.php

@@ -20,7 +20,7 @@ protected function type(): Type
     protected function baselineCast(mixed $value): int
     {
         try {
-            return (int) $value;
+            return @(int)$value;
         } catch (TypeError) {
             throw new RuntimeException;
         }

tests/Types/NonEmptyArrayTypeTest.php

@@ -21,13 +21,13 @@ protected function type(): Type
     protected function baselineCast(mixed $value): array
     {
         try {
-            $arrayValue = is_array($value) ? $value : (array) $value;
+            $arrayValue = is_array($value) ? $value : (array)$value;
             if (count($arrayValue) == 0) {
                 throw new RuntimeException;
             } else {
                 $expectedResult = [];
                 foreach ($arrayValue as $key => $property) {
-                    $expectedResult[$key] = (int) $property;
+                    $expectedResult[$key] = @(int)$property;
                 }
                 return $expectedResult;
             }

tests/Types/NonEmptyListTypeTest.php

@@ -27,7 +27,7 @@ protected function baselineCast(mixed $value): array
             } else {
                 $expectedResult = [];
                 foreach ($arrayValue as $property) {
-                    $expectedResult[] = (int) $property;
+                    $expectedResult[] = @(int)$property;
                 }
                 return $expectedResult;
             }

tests/Types/NonEmptyStringTypeTest.php

@@ -20,7 +20,7 @@ protected function type(): Type
     protected function baselineCast(mixed $value): string
     {
         try {
-            $stringValue = (string) $value;
+            $stringValue = @(string)$value;
             if ($stringValue !== '') {
                 return $stringValue;
             } else {

tests/Types/NumericStringTypeTest.php

@@ -20,7 +20,7 @@ protected function type(): Type
     protected function baselineCast(mixed $value): string
     {
         try {
-            $stringValue = (string) $value;
+            $stringValue = @(string)$value;
             if (is_numeric($stringValue)) {
                 return $stringValue;
             } else {

tests/Types/StringTypeTest.php

@@ -20,7 +20,7 @@ protected function type(): Type
     protected function baselineCast(mixed $value): string
     {
         try {
-            return (string) $value;
+            return @(string)$value;
         } catch (Error) {
             throw new RuntimeException;
         }

tests/Types/TupleTypeTest.php

@@ -19,17 +19,16 @@ protected function type(): Type
         return _tuple(_int(), _string());
     }
 
-    protected function baselineCast(mixed $value): mixed
+    protected function baselineCast(mixed $value): array
     {
         try {
-            $arrayValue = is_array($value) ? $value : (array) $value;
+            $arrayValue = array_values(is_array($value) ? $value : (array) $value);
             if (count($arrayValue) == 2) {
-                return [(int) $arrayValue[0], (string) $arrayValue[1]];
-            } else {
-                throw new RuntimeException;
+                return [@(int)$arrayValue[0], @(string)$arrayValue[1]];
             }
         } catch (Error) {
             throw new RuntimeException;
         }
+        throw new RuntimeException;
     }
 }

tests/Types/UnionTypeTest.php

@@ -4,14 +4,14 @@
 
 use DateTime;
 use Exception;
-use Hamlet\Type\CastException;
 use Hamlet\Type\Type;
 use InvalidArgumentException;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
 use stdClass;
 use function Hamlet\Type\_bool;
+use function Hamlet\Type\_class;
 use function Hamlet\Type\_int;
 use function Hamlet\Type\_literal;
 use function Hamlet\Type\_null;
@@ -162,4 +162,10 @@ public function testNullableTailsFail8(): void
         $this->expectException(InvalidArgumentException::class);
         _union(_literal(1), _literal(2), _literal(3), _literal(4), _literal(5), _literal(6), _literal(7), null);
     }
+
+    public function testCollapsingAndSorting(): void
+    {
+        $type = _union(_null(), _int(), _class(DateTime::class), _null(), _int(), _string());
+        $this->assertEquals('int|DateTime|string|null', (string) $type);
+    }
 }