Compability with PhpParser v5

jolicode · Jan 11, 2024 · 456eea4 · 456eea4
1 parent d02c3b6
commit 456eea4
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 - [GH#27](https://github.com/jolicode/automapper/pull/27) Use PhpStanExtractor instead of PhpDocExtractor
+- [GH#31](https://github.com/jolicode/automapper/pull/31) Compability with PhpParser v5
 
 ## [8.1.0] - 2023-12-14
 ### Added

diff --git a/composer.json b/composer.json
@@ -18,7 +18,7 @@
     "require": {
         "php": "^8.2",
         "doctrine/inflector": "^1.4 || ^2.0",
-        "nikic/php-parser": "^4.0",
+        "nikic/php-parser": "^4.0 || ^5.0",
         "symfony/property-info": "^5.4 || ^6.0 || ^7.0",
         "symfony/serializer": "^5.4 || ^6.0 || ^7.0"
     },

diff --git a/src/AutoMapper.php b/src/AutoMapper.php
@@ -27,7 +27,6 @@
 use AutoMapper\Transformer\TransformerFactoryInterface;
 use AutoMapper\Transformer\UniqueTypeTransformerFactory;
 use Doctrine\Common\Annotations\AnnotationReader;
-use PhpParser\ParserFactory;
 use Symfony\Component\PropertyInfo\Extractor\PhpStanExtractor;
 use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
 use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
@@ -45,6 +44,8 @@
  */
 class AutoMapper implements AutoMapperInterface, AutoMapperRegistryInterface, MapperGeneratorMetadataRegistryInterface
 {
+    use PhpParserHelper;
+
     public const VERSION = '8.2.0-DEV';
     public const VERSION_ID = 80200;
     public const MAJOR_VERSION = 8;
@@ -179,7 +180,7 @@ public static function create(
             $loader = new EvalLoader(
                 new Generator(
                     new ClassMethodToCallbackExtractor(),
-                    (new ParserFactory())->create(ParserFactory::PREFER_PHP7),
+                    self::getParser(),
                     new ClassDiscriminatorFromClassMetadata($classMetadataFactory),
                     $allowReadOnlyTargetToPopulate
                 )

diff --git a/src/Extractor/ClassMethodToCallbackExtractor.php b/src/Extractor/ClassMethodToCallbackExtractor.php
@@ -7,13 +7,14 @@
 use AutoMapper\Exception\InvalidArgumentException;
 use AutoMapper\Exception\LogicException;
 use AutoMapper\Exception\RuntimeException;
+use AutoMapper\PhpParserHelper;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Identifier;
+use PhpParser\Node\Name;
 use PhpParser\Node\Param;
 use PhpParser\Node\Stmt;
 use PhpParser\Parser;
-use PhpParser\ParserFactory;
 
 /**
  * Extracts the code of the given method from a given class and wraps it inside a closure, in order to inject it
@@ -26,11 +27,13 @@
  */
 final readonly class ClassMethodToCallbackExtractor
 {
+    use PhpParserHelper;
+
     private Parser $parser;
 
     public function __construct(?Parser $parser = null)
     {
-        $this->parser = $parser ?? (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
+        $this->parser = $parser ?? self::getParser();
     }
 
     /**
@@ -66,15 +69,20 @@ public function extract(string $class, string $method, array $inputParameters):
         $closureParameters = [];
         foreach ($classMethod->getParams() as $parameter) {
             if ($parameter->var instanceof Expr\Variable && $parameter->type instanceof Identifier) {
-                $closureParameters[] = new Param(new Expr\Variable($parameter->var->name), type: $parameter->type->name);
+                $closureParameters[] = new Param(new Expr\Variable($parameter->var->name), type: new Name($parameter->type->name));
             }
         }
 
+        $returnType = $classMethod->returnType;
+        if (\is_string($returnType)) {
+            $returnType = new Name($returnType);
+        }
+
         return new Expr\FuncCall(
             new Expr\Closure([
                 'stmts' => $classMethod->stmts,
                 'params' => $closureParameters,
-                'returnType' => $classMethod->returnType,
+                'returnType' => $returnType,
             ]),
             $inputParameters,
         );

diff --git a/src/Generator/Generator.php b/src/Generator/Generator.php
@@ -12,17 +12,19 @@
 use AutoMapper\GeneratedMapper;
 use AutoMapper\MapperContext;
 use AutoMapper\MapperGeneratorMetadataInterface;
+use AutoMapper\PhpParserHelper;
 use AutoMapper\Transformer\AssignedByReferenceTransformerInterface;
 use AutoMapper\Transformer\DependentTransformerInterface;
 use AutoMapper\Transformer\TransformerInterface;
+use PhpParser\Modifiers;
 use PhpParser\Node\Arg;
+use PhpParser\Node\ArrayItem;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Name;
 use PhpParser\Node\Param;
 use PhpParser\Node\Scalar;
 use PhpParser\Node\Stmt;
 use PhpParser\Parser;
-use PhpParser\ParserFactory;
 use Symfony\Component\Serializer\Mapping\ClassDiscriminatorResolverInterface;
 
 /**
@@ -32,6 +34,8 @@
  */
 final readonly class Generator
 {
+    use PhpParserHelper;
+
     private Parser $parser;
 
     public function __construct(
@@ -40,7 +44,7 @@ public function __construct(
         private ?ClassDiscriminatorResolverInterface $classDiscriminator = null,
         private bool $allowReadOnlyTargetToPopulate = false,
     ) {
-        $this->parser = $parser ?? (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
+        $this->parser = $parser ?? self::getParser();
     }
 
     /**
@@ -353,7 +357,7 @@ public function generate(MapperGeneratorMetadataInterface $mapperGeneratorMetada
                             new Expr\Array_()
                         )),
                         new Arg(new Expr\Array_(array_map(function (string $group) {
-                            return new Expr\ArrayItem(new Scalar\String_($group));
+                            return new ArrayItem(new Scalar\String_($group));
                         }, $propertyMapping->sourceGroups))),
                     ])
                 );
@@ -379,7 +383,7 @@ public function generate(MapperGeneratorMetadataInterface $mapperGeneratorMetada
                             new Expr\Array_()
                         )),
                         new Arg(new Expr\Array_(array_map(function (string $group) {
-                            return new Expr\ArrayItem(new Scalar\String_($group));
+                            return new ArrayItem(new Scalar\String_($group));
                         }, $propertyMapping->targetGroups))),
                     ])
                 );
@@ -396,7 +400,7 @@ public function generate(MapperGeneratorMetadataInterface $mapperGeneratorMetada
                         new Expr\ArrayDimFetch($contextVariable, new Scalar\String_(MapperContext::DEPTH)),
                         new Expr\ConstFetch(new Name('0'))
                     ),
-                    new Scalar\LNumber($propertyMapping->maxDepth)
+                    new Scalar\Int_($propertyMapping->maxDepth)
                 );
             }
 
@@ -468,14 +472,14 @@ public function generate(MapperGeneratorMetadataInterface $mapperGeneratorMetada
          * }
          */
         $mapMethod = new Stmt\ClassMethod('map', [
-            'flags' => Stmt\Class_::MODIFIER_PUBLIC,
+            'flags' => Modifiers::PUBLIC,
             'params' => [
                 new Param(new Expr\Variable($sourceInput->name)),
-                new Param(new Expr\Variable('context'), new Expr\Array_(), 'array'),
+                new Param(new Expr\Variable('context'), new Expr\Array_(), new Name('array')),
             ],
             'byRef' => true,
             'stmts' => $statements,
-            'returnType' => \PHP_VERSION_ID >= 80000 ? 'mixed' : null,
+            'returnType' => \PHP_VERSION_ID >= 80000 ? new Name('mixed') : null,
         ]);
 
         /*
@@ -490,7 +494,7 @@ public function generate(MapperGeneratorMetadataInterface $mapperGeneratorMetada
          * }
          */
         $constructMethod = new Stmt\ClassMethod('__construct', [
-            'flags' => Stmt\Class_::MODIFIER_PUBLIC,
+            'flags' => Modifiers::PUBLIC,
             'stmts' => $constructStatements,
         ]);
 
@@ -509,11 +513,11 @@ public function generate(MapperGeneratorMetadataInterface $mapperGeneratorMetada
              * }
              */
             $classStmts[] = new Stmt\ClassMethod('injectMappers', [
-                'flags' => Stmt\Class_::MODIFIER_PUBLIC,
+                'flags' => Modifiers::PUBLIC,
                 'params' => [
                     new Param(new Expr\Variable('autoMapperRegistry'), null, new Name\FullyQualified(AutoMapperRegistryInterface::class)),
                 ],
-                'returnType' => 'void',
+                'returnType' => new Name('void'),
                 'stmts' => $injectMapperStatements,
             ]);
         }
@@ -526,7 +530,7 @@ public function generate(MapperGeneratorMetadataInterface $mapperGeneratorMetada
          * }
          */
         return new Stmt\Class_($mapperGeneratorMetadata->getMapperClassName(), [
-            'flags' => Stmt\Class_::MODIFIER_FINAL,
+            'flags' => Modifiers::FINAL,
             'extends' => new Name\FullyQualified(GeneratedMapper::class),
             'stmts' => $classStmts,
         ]);

diff --git a/src/PhpParserHelper.php b/src/PhpParserHelper.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AutoMapper;
+
+use PhpParser\Parser;
+use PhpParser\ParserFactory;
+
+/**
+ * @author Baptiste Leduc <[email protected]>
+ */
+trait PhpParserHelper
+{
+    public static function getParser(): Parser
+    {
+        if (method_exists(ParserFactory::class, 'create')) {
+            // nikic/php-parser v4
+            return (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
+        }
+
+        // nikic/php-parser v5
+        return (new ParserFactory())->createForHostVersion();
+    }
+}
diff --git a/src/Transformer/BuiltinTransformer.php b/src/Transformer/BuiltinTransformer.php
@@ -7,6 +7,7 @@
 use AutoMapper\Extractor\PropertyMapping;
 use AutoMapper\Generator\UniqueVariableScope;
 use PhpParser\Node\Arg;
+use PhpParser\Node\ArrayItem;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\Cast;
 use PhpParser\Node\Name;
@@ -100,7 +101,7 @@ public function transform(Expr $input, Expr $target, PropertyMapping $propertyMa
 
     private function toArray(Expr $input): Expr
     {
-        return new Expr\Array_([new Expr\ArrayItem($input)]);
+        return new Expr\Array_([new ArrayItem($input)]);
     }
 
     private function fromIteratorToArray(Expr $input): Expr

diff --git a/tests/AutoMapperBaseTest.php b/tests/AutoMapperBaseTest.php
@@ -38,7 +38,7 @@ protected function buildAutoMapper(bool $allowReadOnlyTargetToPopulate = false,
 
         $this->loader = new FileLoader(new Generator(
             new ClassMethodToCallbackExtractor(),
-            (new ParserFactory())->create(ParserFactory::PREFER_PHP7),
+            (new ParserFactory())->createForHostVersion(),
             new ClassDiscriminatorFromClassMetadata($classMetadataFactory),
             $allowReadOnlyTargetToPopulate
         ), __DIR__ . '/cache');

diff --git a/tests/Extractor/AstExtractorTest.php b/tests/Extractor/AstExtractorTest.php
@@ -29,7 +29,7 @@ public function testExtractSimpleMethod(string $varName): void
         $extractedMethod = new Expression($extractor->extract(FooCustomMapper::class, 'transform', [new Arg(new Variable($varName))]));
 
         $this->assertEquals(<<<PHP
-(function (mixed \$object) : mixed {
+(function (mixed \$object): mixed {
     if (\$object instanceof Foo) {
         \$object->bar = 'Hello World!';
     }
@@ -52,7 +52,7 @@ public function testExtractMethodWithTwoVariables(): void
         $extractedMethod = new Expression($extractor->extract(FooCustomMapper::class, 'switch', [new Arg(new Variable('someVar')), new Arg(new Variable('context'))]));
 
         $this->assertEquals(<<<PHP
-(function (mixed \$object, string \$someString) : mixed {
+(function (mixed \$object, string \$someString): mixed {
     if (\$object instanceof Foo) {
         \$object->bar = 'Hello World!';
         \$object->baz = \$someString;