PhpCodeBuilder: add reference to the compiler used to compile the map…

…per (#18)
shipmonk-rnd · Aug 7, 2023 · 499b8dc · 499b8dc
1 parent 84986ea
commit 499b8dc
Show file tree

Hide file tree

Showing 68 changed files with 136 additions and 68 deletions.
diff --git a/src/Compiler/Php/PhpCodeBuilder.php b/src/Compiler/Php/PhpCodeBuilder.php
@@ -454,13 +454,15 @@ public function mapperClass(string $shortClassName, MapperCompiler $mapperCompil
         $outputType = $mapperCompiler->getOutputType();
         $this->importType($outputType);
 
+        $mapperCompilerType = $this->importClass($mapperCompiler::class);
+
         $implementsType = new GenericTypeNode(
             new IdentifierTypeNode($this->importClass(Mapper::class)),
             [$outputType],
         );
 
         $phpDoc = $this->phpDoc([
-            'Generated mapper. Do not edit directly.',
+            "Generated mapper by {@see $mapperCompilerType}. Do not edit directly.",
             '',
             "@implements {$implementsType}",
         ]);

diff --git a/tests/Compiler/Mapper/Array/Data/EmptySealedArrayShapeMapper.php b/tests/Compiler/Mapper/Array/Data/EmptySealedArrayShapeMapper.php
@@ -2,6 +2,7 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Array\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Array\MapArrayShape;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
@@ -11,7 +12,7 @@
 use function is_array;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapArrayShape}. Do not edit directly.
  *
  * @implements Mapper<array{}>
  */

diff --git a/tests/Compiler/Mapper/Array/Data/EmptyUnsealedArrayShapeMapper.php b/tests/Compiler/Mapper/Array/Data/EmptyUnsealedArrayShapeMapper.php
@@ -2,13 +2,14 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Array\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Array\MapArrayShape;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_array;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapArrayShape}. Do not edit directly.
  *
  * @implements Mapper<array{...}>
  */

diff --git a/tests/Compiler/Mapper/Array/Data/GenericArrayMapper.php b/tests/Compiler/Mapper/Array/Data/GenericArrayMapper.php
@@ -2,6 +2,7 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Array\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Array\MapArray;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
@@ -10,7 +11,7 @@
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapArray}. Do not edit directly.
  *
  * @implements Mapper<array<string, int>>
  */

diff --git a/tests/Compiler/Mapper/Array/Data/GenericListMapper.php b/tests/Compiler/Mapper/Array/Data/GenericListMapper.php
@@ -2,6 +2,7 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Array\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Array\MapList;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
@@ -10,7 +11,7 @@
 use function is_int;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapList}. Do not edit directly.
  *
  * @implements Mapper<list<int>>
  */

diff --git a/tests/Compiler/Mapper/Array/Data/SealedArrayShapeMapper.php b/tests/Compiler/Mapper/Array/Data/SealedArrayShapeMapper.php
@@ -2,6 +2,7 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Array\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Array\MapArrayShape;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
@@ -14,7 +15,7 @@
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapArrayShape}. Do not edit directly.
  *
  * @implements Mapper<array{a: int, b?: string}>
  */

diff --git a/tests/Compiler/Mapper/Data/MultiplyBySevenMapper.php b/tests/Compiler/Mapper/Data/MultiplyBySevenMapper.php
@@ -7,7 +7,7 @@
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapMultiplyBySeven}. Do not edit directly.
  *
  * @implements Mapper<int>
  */

diff --git a/tests/Compiler/Mapper/Mixed/Data/MixedMapper.php b/tests/Compiler/Mapper/Mixed/Data/MixedMapper.php
@@ -2,12 +2,13 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Mixed\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Mixed\MapMixed;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapMixed}. Do not edit directly.
  *
  * @implements Mapper<mixed>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/DateMapper.php b/tests/Compiler/Mapper/Object/Data/DateMapper.php
@@ -3,13 +3,14 @@
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Object\Data;
 
 use DateTimeImmutable;
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapDateTimeImmutable;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapDateTimeImmutable}. Do not edit directly.
  *
  * @implements Mapper<DateTimeImmutable>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/DateStandaloneMapper.php b/tests/Compiler/Mapper/Object/Data/DateStandaloneMapper.php
@@ -3,13 +3,14 @@
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Object\Data;
 
 use DateTimeImmutable;
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapDate;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapDate}. Do not edit directly.
  *
  * @implements Mapper<DateTimeImmutable>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/DateStandaloneWithTimeZoneMapper.php b/tests/Compiler/Mapper/Object/Data/DateStandaloneWithTimeZoneMapper.php
@@ -4,13 +4,14 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapDateTimeImmutable;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapDateTimeImmutable}. Do not edit directly.
  *
  * @implements Mapper<DateTimeImmutable>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/DateTimeImmutableMapper.php b/tests/Compiler/Mapper/Object/Data/DateTimeImmutableMapper.php
@@ -3,13 +3,14 @@
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Object\Data;
 
 use DateTimeImmutable;
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapDateTimeImmutable;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapDateTimeImmutable}. Do not edit directly.
  *
  * @implements Mapper<DateTimeImmutable>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/DateTimeImmutableWithTargetTimeZoneMapper.php b/tests/Compiler/Mapper/Object/Data/DateTimeImmutableWithTargetTimeZoneMapper.php
@@ -4,13 +4,14 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapDateTimeImmutable;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapDateTimeImmutable}. Do not edit directly.
  *
  * @implements Mapper<DateTimeImmutable>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/DateTimeImmutableWithTimeZoneMapper.php b/tests/Compiler/Mapper/Object/Data/DateTimeImmutableWithTimeZoneMapper.php
@@ -4,13 +4,14 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapDateTimeImmutable;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapDateTimeImmutable}. Do not edit directly.
  *
  * @implements Mapper<DateTimeImmutable>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/DateWithDefaultTimeZoneMapper.php b/tests/Compiler/Mapper/Object/Data/DateWithDefaultTimeZoneMapper.php
@@ -4,13 +4,14 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapDateTimeImmutable;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapDateTimeImmutable}. Do not edit directly.
  *
  * @implements Mapper<DateTimeImmutable>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/DateWithDistinctDefaultAndTargetTimeZoneMapper.php b/tests/Compiler/Mapper/Object/Data/DateWithDistinctDefaultAndTargetTimeZoneMapper.php
@@ -4,13 +4,14 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapDateTimeImmutable;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapDateTimeImmutable}. Do not edit directly.
  *
  * @implements Mapper<DateTimeImmutable>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/DateWithTargetTimeZoneMapper.php b/tests/Compiler/Mapper/Object/Data/DateWithTargetTimeZoneMapper.php
@@ -4,13 +4,14 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapDateTimeImmutable;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapDateTimeImmutable}. Do not edit directly.
  *
  * @implements Mapper<DateTimeImmutable>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/DateWithTimeZoneMapper.php b/tests/Compiler/Mapper/Object/Data/DateWithTimeZoneMapper.php
@@ -4,13 +4,14 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapDateTimeImmutable;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapDateTimeImmutable}. Do not edit directly.
  *
  * @implements Mapper<DateTimeImmutable>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/MovieMapper.php b/tests/Compiler/Mapper/Object/Data/MovieMapper.php
@@ -2,6 +2,7 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Object\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapObject;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
@@ -16,7 +17,7 @@
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapObject}. Do not edit directly.
  *
  * @implements Mapper<MovieInput>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/PersonMapper.php b/tests/Compiler/Mapper/Object/Data/PersonMapper.php
@@ -2,6 +2,7 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Object\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapObject;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
@@ -15,7 +16,7 @@
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapObject}. Do not edit directly.
  *
  * @implements Mapper<PersonInput>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/PersonWithAllowedExtraPropertiesMapper.php b/tests/Compiler/Mapper/Object/Data/PersonWithAllowedExtraPropertiesMapper.php
@@ -2,6 +2,7 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Object\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapObject;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
@@ -12,7 +13,7 @@
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapObject}. Do not edit directly.
  *
  * @implements Mapper<PersonInput>
  */

diff --git a/tests/Compiler/Mapper/Object/Data/SuitEnumMapper.php b/tests/Compiler/Mapper/Object/Data/SuitEnumMapper.php
@@ -2,6 +2,7 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Object\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Object\MapEnum;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
@@ -10,7 +11,7 @@
 use function is_string;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapEnum}. Do not edit directly.
  *
  * @implements Mapper<SuitEnum>
  */

diff --git a/tests/Compiler/Mapper/Scalar/Data/BoolMapper.php b/tests/Compiler/Mapper/Scalar/Data/BoolMapper.php
@@ -2,13 +2,14 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Scalar\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Scalar\MapBool;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
 use function is_bool;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapBool}. Do not edit directly.
  *
  * @implements Mapper<bool>
  */

diff --git a/tests/Compiler/Mapper/Scalar/Data/FloatMapper.php b/tests/Compiler/Mapper/Scalar/Data/FloatMapper.php
@@ -2,6 +2,7 @@
 
 namespace ShipMonkTests\InputMapper\Compiler\Mapper\Scalar\Data;
 
+use ShipMonk\InputMapper\Compiler\Mapper\Scalar\MapFloat;
 use ShipMonk\InputMapper\Runtime\Exception\MappingFailedException;
 use ShipMonk\InputMapper\Runtime\Mapper;
 use ShipMonk\InputMapper\Runtime\MapperProvider;
@@ -11,7 +12,7 @@
 use function is_int;
 
 /**
- * Generated mapper. Do not edit directly.
+ * Generated mapper by {@see MapFloat}. Do not edit directly.
  *
  * @implements Mapper<float>
  */