Merge pull request #5 from php-type-language/feature/second-level-meta

Added second level metadata

Author: SerafimArts

bench/src/Serializers/TypeLangAttributesBench.php

@@ -10,9 +10,8 @@
 use PhpBench\Attributes\Warmup;
 use TypeLang\Mapper\Bench\Stub\ExampleRequestDTO;
 use TypeLang\Mapper\Mapper;
-use TypeLang\Mapper\Mapping\Driver\AttributeDriver;
-use TypeLang\Mapper\Mapping\Driver\Psr16CachedDriver;
-use TypeLang\Mapper\Mapping\Driver\ReflectionDriver;
+use TypeLang\Mapper\Mapping\Provider\Psr16CacheProvider;
+use TypeLang\Mapper\Mapping\Reader\AttributeReader;
 use TypeLang\Mapper\Platform\StandardPlatform;
 
 #[Revs(30), Warmup(3), Iterations(5), BeforeMethods('prepare')]
@@ -25,22 +24,20 @@ public function prepare(): void
     {
         parent::prepare();
 
-        $driver = new AttributeDriver(
-            delegate: new ReflectionDriver(),
-        );
+        $driver = new AttributeReader();
 
         $this->cached = new Mapper(
             platform: new StandardPlatform(
-                driver: new Psr16CachedDriver(
-                    cache: $this->psr16,
+                meta: new Psr16CacheProvider(
+                    psr16: $this->psr16,
                     delegate: $driver,
                 ),
             ),
         );
 
         $this->raw = new Mapper(
             platform: new StandardPlatform(
-                driver: $driver,
+                meta: $driver,
             ),
         );
     }

bench/src/Serializers/TypeLangDocBlockBench.php

@@ -10,9 +10,9 @@
 use PhpBench\Attributes\Warmup;
 use TypeLang\Mapper\Bench\Stub\ExampleRequestDTO;
 use TypeLang\Mapper\Mapper;
-use TypeLang\Mapper\Mapping\Driver\DocBlockDriver;
-use TypeLang\Mapper\Mapping\Driver\Psr16CachedDriver;
-use TypeLang\Mapper\Mapping\Driver\ReflectionDriver;
+use TypeLang\Mapper\Mapping\Provider\Psr16CacheProvider;
+use TypeLang\Mapper\Mapping\Reader\PhpDocReader;
+use TypeLang\Mapper\Mapping\Reader\ReflectionReader;
 use TypeLang\Mapper\Platform\StandardPlatform;
 
 #[Revs(30), Warmup(3), Iterations(5), BeforeMethods('prepare')]
@@ -25,22 +25,20 @@ public function prepare(): void
     {
         parent::prepare();
 
-        $driver = new DocBlockDriver(
-            delegate: new ReflectionDriver(),
-        );
+        $driver = new PhpDocReader();
 
         $this->cached = new Mapper(
             platform: new StandardPlatform(
-                driver: new Psr16CachedDriver(
-                    cache: $this->psr16,
+                meta: new Psr16CacheProvider(
+                    psr16: $this->psr16,
                     delegate: $driver,
                 ),
             ),
         );
 
         $this->raw = new Mapper(
             platform: new StandardPlatform(
-                driver: $driver,
+                meta: $driver,
             ),
         );
     }

composer.json

@@ -10,6 +10,7 @@
     },
     "require": {
         "php": "^8.1",
+        "psr/clock": "^1.0",
         "psr/log": "^1.0|^2.0|^3.0",
         "psr/simple-cache": "^1.0|^2.0|^3.0",
         "type-lang/parser": "^1.4",
@@ -33,6 +34,8 @@
         "symfony/property-access": "^5.4|^6.0|^7.0",
         "symfony/stopwatch": "^5.4|^6.0|^7.0",
         "symfony/var-dumper": "^5.4|^6.0|^7.0",
+        "symfony/yaml": "^5.4|^6.0|^7.0",
+        "nette/neon": "^3.0",
         "type-lang/phpdoc": "^1.0",
         "type-lang/phpdoc-standard-tags": "^1.0"
     },
@@ -42,8 +45,11 @@
         }
     },
     "suggest": {
-        "type-lang/phpdoc-standard-tags": "(^1.0) Required for DocBlockDriver mapping driver support",
-        "justinrainbow/json-schema": "(^5.3|^6.0) Required for configuration drivers validation"
+        "ext-json": "Required for JSON mapping configuration files",
+        "nette/neon": "(^3.0) Required for NEON mapping configuration files",
+        "symfony/yaml": "(^5.4|^6.0|^7.0) Required for YAML mapping configuration files",
+        "type-lang/phpdoc-standard-tags": "(^1.0) Required for PhpDoc mapping configuration",
+        "justinrainbow/json-schema": "(^5.3|^6.0) Required for file-based configuration validation"
     },
     "extra": {
         "branch-alias": {

example/01.normalization/06.inherited-types-normalization.php

@@ -30,7 +30,7 @@ public function __construct(
 
 $result = $mapper->normalize($value);
 
-dd($result);
+var_dump($result);
 //
 // array:1 [
 //   "items" => array:3 [

example/01.normalization/08.object-output-normalization.php

@@ -37,17 +37,17 @@ public function __construct(
 
 var_dump($result);
 //
-// object{
-//   items: array:3 [
-//     "key1" => object{
-//       value: "first"
-//     }
-//     "key2" => object{
-//       value: "second"
-//     }
-//     0 => object{
-//       value: "third"
-//     }
+// array:1 [
+//   "items" => array:3 [
+//     "key1" => array:1 [
+//       "value" => "first"
+//     ]
+//     "key2" => array:1 [
+//       "value" => "second"
+//     ]
+//     0 => array:1 [
+//       "value" => "third"
+//     ]
 //   ]
-// }
+// ]
 //

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

@@ -26,19 +26,15 @@ public function __construct(
         ]
     ], ExampleDTO::class);
 } catch (RuntimeException $e) {
-    // Before
     var_dump($e->getMessage());
-    // - 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
+    // Before: Passed value in "values" of {"values": 42} must be of type
+    //         list<ExampleDTO>, but 42 given at $.values[1].values
+    // After:  Passed value in "values" of {"values": 42} must be of type
+    //         array, but 42 given at $.values[1].values
     var_dump($e->getMessage());
-    // - 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,11 +28,7 @@ public function __construct(
         ],
     ], ExampleDTO::class);
 } catch (RuntimeException $e) {
-    // Before
     var_dump($e->getMessage());
-    // - 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 {
@@ -42,9 +38,9 @@ protected function printNamedTypeNode(NamedTypeNode $node): string
         }
     };
 
-    // After
+    // Before: Passed value in "values" of {"values": 42} must be of type
+    //         list<ExampleDTO>, but 42 given at $.values[1].values
+    // After:  Passed value in "values" of {"values": 42} must be of type
+    //         !!!MODIFIED!!!, but 42 given at $.values[1].values
     var_dump($e->getMessage());
-    // - 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-value-printer.php

@@ -28,37 +28,30 @@ public function __construct(
         ],
     ], 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
+    // Before:  Passed value in "values" of {"values": 42} must be of type
+    //          list<ExampleDTO>, but 42 given at $.values[1].values
+    // After#1: Passed value in string of stdClass must be of type
+    //          list<ExampleDTO>, but int given at $.values[1].values
     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
+        // Before:  Passed value in "values" of {"values": 42} must be of type
+        //          list<ExampleDTO>, but 42 given at $.values[1].values
+        // After#1: Passed value in string of stdClass must be of type
+        //          list<ExampleDTO>, but int given at $.values[1].values
+        // After#2: Passed value in "values" of {#394
+        //            +"values": 42
+        //          } must be of type list<ExampleDTO>, but 42 given at $.values[1].values
         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/04.custom-path-printer.php

@@ -28,10 +28,7 @@ public function __construct(
         ],
     ], ExampleDTO::class);
 } catch (RuntimeException $e) {
-    // Before: "at $.values[1].values"
     var_dump($e->getMessage());
-    // Passed value of field "values" must be of type list<ExampleDTO>,
-    // but 42 given at $.values[1].values
 
     // Print full path using ">" delimiter
     $e->template->paths = new class implements PathPrinterInterface {
@@ -41,8 +38,10 @@ public function print(PathInterface $path): string
         }
     };
 
-    // After: "at ExampleDTO > values > 1 > ExampleDTO > values"
+    // Before: Passed value in "values" of {"values": 42} must be of type
+    //         list<ExampleDTO>, but 42 given at $.values[1].values
+    // After:  Passed value in "values" of {"values": 42} must be of type
+    //         list<ExampleDTO>, but 42 given at ExampleDTO > values >
+    //         1 > ExampleDTO > values
     var_dump($e->getMessage());
-    // Passed value of field "values" must be of type list<ExampleDTO>,
-    // but 42 given at ExampleDTO > values > 1 > ExampleDTO > values
 }

example/03.types/03.custom-type-template-arguments.php

@@ -87,19 +87,30 @@ public function cast(mixed $value, Context $context): mixed
 // ]
 //
 
-var_dump($mapper->normalize([], 'non-empty<string>'));
+try {
+    var_dump($mapper->normalize([], 'non-empty<string>'));
+} catch (\Throwable $e) {
+    echo $e->getMessage() . "\n";
+}
 //
 // InvalidValueException: Passed value [] is invalid
 //
 
-
-var_dump($mapper->normalize('example', 'non-empty'));
+try {
+    var_dump($mapper->normalize('example', 'non-empty'));
+} catch (\Throwable $e) {
+    echo $e->getMessage() . "\n";
+}
 //
 // MissingTemplateArgumentsException: Type "non-empty" expects at least 1
 //                                    template argument(s), but 0 were passed
 //
 
-var_dump($mapper->normalize('', 'non-empty<string>'));
+try {
+    var_dump($mapper->normalize('', 'non-empty<string>'));
+} catch (\Throwable $e) {
+    echo $e->getMessage() . "\n";
+}
 //
 // InvalidValueException: Passed value "" is invalid
 //