Actualize examples

Author: Kirill Nesmeyanov

example/01.normalization/05.typed-object-normalization.php

@@ -41,5 +41,5 @@ public function __construct(
 
 //
 // InvalidValueException: Passed value must be of type ChildDTO{name: string},
-//                        but int (42) given at $.children[2]
+//                        but 42 given at $.children[2]
 //

example/02.errors/01.custom-type-printer.php

@@ -26,17 +26,19 @@ public function __construct(
         ]
     ], ExampleDTO::class);
 } catch (RuntimeException $e) {
-    // Before: "list<ExampleDTO>"
+    // Before
     var_dump($e->getMessage());
-    // Passed value of field "values" must be of type list<ExampleDTO>,
-    // but 42 given at $.values[1].values
+    // - Type: "list<ExampleDTO>"
+    // - Message: Passed value in "values" of {"values": 42} must be of type
+    //   list<ExampleDTO>, but 42 given at $.values[1].values
 
     // Replace all "expected type" definition to PHP-supported printer
     // instead of PrettyPrinter
     $e->template->types = new \TypeLang\Printer\NativeTypePrinter();
 
-    // After: "array"
+    // After
     var_dump($e->getMessage());
-    // Passed value of field "values" must be of type array,
-    // but 42 given at $.values[1].values
+    // - Type: "array"
+    // - Message: Passed value in "values" of {"values": 42} must be of type
+    //   array, but 42 given at $.values[1].values
 }

example/02.errors/02.extended-type-printer.php

@@ -28,10 +28,11 @@ public function __construct(
         ],
     ], ExampleDTO::class);
 } catch (RuntimeException $e) {
-    // Before: "list<ExampleDTO>"
+    // Before
     var_dump($e->getMessage());
-    // Passed value of field "values" must be of type list<ExampleDTO>,
-    // but 42 given at $.values[1].values
+    // - Type: "list<ExampleDTO>"
+    // - Message: Passed value in "values" of {"values": 42} must be of type
+    //   list<ExampleDTO>, but 42 given at $.values[1].values
 
     // Print all NamedTypeNode AST statements as "!!!MODIFIED!!!" string
     $e->template->types = new class extends PrettyPrinter {
@@ -41,8 +42,9 @@ protected function printNamedTypeNode(NamedTypeNode $node): string
         }
     };
 
-    // After: "!!!MODIFIED!!!"
+    // After
     var_dump($e->getMessage());
-    // Passed value of field "values" must be of type !!!MODIFIED!!!,
-    // but 42 given at $.values[1].values
+    // - Type: "!!!MODIFIED!!!"
+    // - Message: Passed value in "values" of {"values": 42} must be of type
+    //   !!!MODIFIED!!!, but 42 given at $.values[1].values
 }

example/02.errors/03.custom-path-printer.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+use TypeLang\Mapper\Exception\Mapping\RuntimeException;
+use TypeLang\Mapper\Mapper;
+use TypeLang\Mapper\Mapping\MapType;
+use TypeLang\Mapper\Runtime\Value\PHPValuePrinter;
+use TypeLang\Mapper\Runtime\Value\SymfonyValuePrinter;
+
+require __DIR__ . '/../../vendor/autoload.php';
+
+class ExampleDTO
+{
+    public function __construct(
+        #[MapType(type: 'list<ExampleDTO>')]
+        public readonly array $values = [],
+    ) {}
+}
+
+$mapper = new Mapper();
+
+try {
+    $result = $mapper->denormalize([
+        'values' => [
+            ['values' => []],
+            ['values' => 42],
+        ],
+    ], ExampleDTO::class);
+} catch (RuntimeException $e) {
+    // Before
+    var_dump($e->getMessage());
+    // - Value#1: "of {"values": 42}"
+    // - Value#2: "but 42 given"
+    // - Message: Passed value in "values" of {"values": 42} must be of type
+    //   list<ExampleDTO>, but 42 given at $.values[1].values
+
+    // Print all values using PHP-compatible types
+    $e->template->values = new PHPValuePrinter();
+
+    // After#1
+    var_dump($e->getMessage());
+    // - Value#1: "of array"
+    // - Value#2: "but int given"
+    // - Message: Passed value in "values" of array must be of type
+    //   list<ExampleDTO>, but int given at $.values[1].values
+
+
+    // In case of symfony/var-dumper is installed, we can use it
+    if (\Composer\InstalledVersions::isInstalled('symfony/var-dumper')) {
+        // Print all values using SymfonyValuePrinter
+        $e->template->values = new SymfonyValuePrinter();
+
+        // After#2
+        var_dump($e->getMessage());
+        // - Value#1: "of array:1 [
+        //     "values" => 42
+        //   ]"
+        // - Value#2: "but 42 given"
+        // - Message: Passed value in "values" of array:1 [
+        //     "values" => 42
+        //   ] must be of type list<ExampleDTO>, but 42 given at $.values[1].values
+    }
+}

example/02.errors/03.custom-value-printer.php

@@ -18,5 +18,5 @@
 
 var_dump($result);
 //
-// TypeNotFoundException: Type "string" is not registered
+// TypeNotFoundException: Type "string" is not defined
 //

…le/02.errors/04.custom-value-printer.php …ple/02.errors/04.custom-path-printer.phpexample/02.errors/04.custom-value-printer.php renamed to example/02.errors/04.custom-path-printer.php example/02.errors/04.custom-value-printer.php renamed to example/02.errors/04.custom-path-printer.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use TypeLang\Mapper\Exception\Runtime\InvalidValueException;
+use TypeLang\Mapper\Exception\Mapping\InvalidValueException;
 use TypeLang\Mapper\Mapper;
 use TypeLang\Mapper\Platform\DelegatePlatform;
 use TypeLang\Mapper\Platform\StandardPlatform;
@@ -26,9 +26,10 @@ public function cast(mixed $value, Context $context): string
             return $value;
         }
 
-        throw InvalidValueException::createFromContext(
+        throw new InvalidValueException(
             value: $value,
-            context: $context,
+            path: $context->getPath(),
+            template: 'Passed value cannot be empty, but {{value}} given',
         );
     }
 }
@@ -46,5 +47,11 @@ public function cast(mixed $value, Context $context): string
 
 var_dump($result);
 //
-// InvalidValueException: Passed value "" is invalid at $[1]
+// expected exception:
+//   TypeLang\Mapper\Exception\Mapping\InvalidIterableValueException:
+//     Passed value "" on index 1 in ["example", ""] is invalid at $[1]
+//
+// previous exception:
+//   TypeLang\Mapper\Exception\Mapping\InvalidValueException:
+//     Passed value cannot be empty, but "" given at $[1]
 //

example/03.types/01.type-platforms.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use TypeLang\Mapper\Exception\Runtime\InvalidValueException;
+use TypeLang\Mapper\Exception\Mapping\InvalidValueException;
 use TypeLang\Mapper\Mapper;
 use TypeLang\Mapper\Platform\DelegatePlatform;
 use TypeLang\Mapper\Platform\StandardPlatform;
@@ -89,19 +89,17 @@ public function cast(mixed $value, Context $context): mixed
 
 var_dump($mapper->normalize([], 'non-empty<string>'));
 //
-// InvalidValueException: Passed value must be of type non-empty, but
-//                        array given at root.
+// InvalidValueException: Passed value [] is invalid
 //
 
 
 var_dump($mapper->normalize('example', 'non-empty'));
 //
-// MissingTemplateArgumentsException: Type "non-empty" expects 1 template
-//                                    argument, but only 0 were passed
+// MissingTemplateArgumentsException: Type "non-empty" expects at least 1
+//                                    template argument(s), but 0 were passed
 //
 
 var_dump($mapper->normalize('', 'non-empty<string>'));
 //
-// InvalidValueException: Passed value must be of type non-empty, but
-//                        null given at root.
+// InvalidValueException: Passed value "" is invalid
 //

example/03.types/02.custom-type.php

@@ -48,7 +48,7 @@ public function __construct(
 var_dump($mapper->normalize(new ExampleDTO()));
 //
 // TypeRequiredException: Type "int" for property ExampleDTO::$value
-//                        is not registered.
+//                        is not defined
 //
 
 var_dump($mapper->normalize([new ExampleDTO()], 'array<ExampleDTO>'));