Revamp Symfony generator (Close #97) (#99)

Author: kubk

README.md

@@ -22,8 +22,9 @@ composer require riverwaysoft/php-converter --dev
 If the installation causes dependency conflicts use the [standalone Phar version](#phar-installation) of the package.
 
 2) Mark a few classes with `#[Dto]` annotation to convert them into TypeScript or Dart
+
 ```php
-use Riverwaysoft\PhpConverter\ClassFilter\Dto;
+use Riverwaysoft\PhpConverter\Filter\Attributes\Dto;
 
 #[Dto]
 class UserOutput

bin/default-config.php

@@ -3,9 +3,9 @@
 declare(strict_types=1);
 
 use Riverwaysoft\PhpConverter\Ast\DtoVisitor;
-use Riverwaysoft\PhpConverter\ClassFilter\PhpAttributeFilter;
 use Riverwaysoft\PhpConverter\CodeProvider\FileSystemCodeProvider;
 use Riverwaysoft\PhpConverter\Config\PhpConverterConfig;
+use Riverwaysoft\PhpConverter\Filter\PhpAttributeFilter;
 use Riverwaysoft\PhpConverter\OutputGenerator\TypeScript\TypeScriptOutputGenerator;
 use Riverwaysoft\PhpConverter\OutputGenerator\UnknownTypeResolver\ClassNameTypeResolver;
 use Riverwaysoft\PhpConverter\OutputGenerator\UnknownTypeResolver\DateTimeTypeResolver;

src/Ast/ConverterVisitor.php

@@ -8,5 +8,6 @@
 
 abstract class ConverterVisitor extends NodeVisitorAbstract
 {
+    /** @phpstan-impure */
     abstract public function popResult(): ConverterResult;
 }

src/Ast/DtoVisitor.php

@@ -4,23 +4,23 @@
 
 namespace Riverwaysoft\PhpConverter\Ast;
 
+use Exception;
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\Enum_;
 use PhpParser\NodeTraverser;
-use Riverwaysoft\PhpConverter\ClassFilter\ClassFilterInterface;
 use Riverwaysoft\PhpConverter\Dto\DtoClassProperty;
 use Riverwaysoft\PhpConverter\Dto\DtoEnumProperty;
 use Riverwaysoft\PhpConverter\Dto\DtoType;
 use Riverwaysoft\PhpConverter\Dto\ExpressionType;
 use Riverwaysoft\PhpConverter\Dto\PhpType\PhpTypeFactory;
 use Riverwaysoft\PhpConverter\Dto\PhpType\PhpTypeInterface;
 use Riverwaysoft\PhpConverter\Dto\PhpType\PhpUnionType;
-use Exception;
 use Riverwaysoft\PhpConverter\Dto\PhpType\PhpUnknownType;
-use function sprintf;
-use function get_class;
+use Riverwaysoft\PhpConverter\Filter\FilterInterface;
 use function array_map;
+use function get_class;
+use function sprintf;
 
 class DtoVisitor extends ConverterVisitor
 {
@@ -29,7 +29,7 @@ class DtoVisitor extends ConverterVisitor
     private ConverterResult $converterResult;
 
     public function __construct(
-        private ?ClassFilterInterface $classFilter = null
+        private ?FilterInterface $filter = null
     ) {
         $this->phpDocTypeParser = new PhpDocTypeParser();
         $this->converterResult = new ConverterResult();
@@ -40,7 +40,7 @@ public function enterNode(Node $node)
         if (!$node instanceof Class_ && !$node instanceof Enum_) {
             return null;
         }
-        if ($this->classFilter && !$this->classFilter->isMatch($node)) {
+        if ($this->filter && !$this->filter->isMatch($node)) {
             return null;
         }
 

src/Ast/PhpDocTypeParser.php

@@ -145,7 +145,7 @@ private function convertToDto(TypeNode $node): PhpTypeInterface|null
             return new PhpUnionType(array_map(fn (TypeNode $child) => $this->convertToDto($child), $node->types));
         }
         if ($node instanceof GenericTypeNode) {
-            return PhpTypeFactory::create($node->type->name, [], array_map(
+            return PhpTypeFactory::create($node->type->name, array_map(
                 fn (TypeNode $child) => $this->convertToDto($child),
                 $node->genericTypes,
             ));

src/Ast/PhpDocTypeParserTest.php

@@ -173,11 +173,11 @@ public static function getDataVarAndReturn(): array
                 '/**
                   * @return JsonResponse<PaginatedResponse<User>>
                   */',
-                new PhpUnknownType('JsonResponse', [], [
-                    new PhpUnknownType('PaginatedResponse', [], [
+                new PhpUnknownType('JsonResponse', [
+                    new PhpUnknownType('PaginatedResponse', [
                         new PhpUnknownType('User'),
-                    ]),
-                ]),
+                    ], []),
+                ], []),
             ],
         ];
     }

src/Bridge/ApiPlatform/ApiPlatformDtoResourceVisitor.php

@@ -4,6 +4,7 @@
 
 namespace Riverwaysoft\PhpConverter\Bridge\ApiPlatform;
 
+use Exception;
 use Jawira\CaseConverter\Convert;
 use PhpParser\Node;
 use PhpParser\Node\Attribute;
@@ -14,22 +15,22 @@
 use Riverwaysoft\PhpConverter\Ast\ConverterResult;
 use Riverwaysoft\PhpConverter\Ast\ConverterVisitor;
 use Riverwaysoft\PhpConverter\Bridge\Symfony\SymfonyRoutingParser;
-use Riverwaysoft\PhpConverter\ClassFilter\ClassFilterInterface;
 use Riverwaysoft\PhpConverter\Dto\ApiClient\ApiEndpoint;
 use Riverwaysoft\PhpConverter\Dto\ApiClient\ApiEndpointMethod;
 use Riverwaysoft\PhpConverter\Dto\ApiClient\ApiEndpointParam;
 use Riverwaysoft\PhpConverter\Dto\PhpType\PhpBaseType;
 use Riverwaysoft\PhpConverter\Dto\PhpType\PhpOptionalType;
 use Riverwaysoft\PhpConverter\Dto\PhpType\PhpTypeFactory;
-use Exception;
-use function sprintf;
+use Riverwaysoft\PhpConverter\Dto\PhpType\PhpUnknownType;
+use Riverwaysoft\PhpConverter\Filter\FilterInterface;
 use function array_key_last;
-use function str_replace;
-use function count;
 use function array_map;
-use function rtrim;
-use function ltrim;
+use function count;
 use function in_array;
+use function ltrim;
+use function rtrim;
+use function sprintf;
+use function str_replace;
 
 class ApiPlatformDtoResourceVisitor extends ConverterVisitor
 {
@@ -41,11 +42,10 @@ class ApiPlatformDtoResourceVisitor extends ConverterVisitor
 
     public const API_PLATFORM_ATTRIBUTE = 'ApiResource';
 
-    // Is used to wrap output types in CollectionResponse<T>
-    public const COLLECTION_RESPONSE_CONTEXT_KEY = 'isCollectionResponse';
+    public const RESPONSE_TYPE_NAME = 'CollectionResponse';
 
     public function __construct(
-        private ?ClassFilterInterface $classFilter = null
+        private ?FilterInterface $filter = null
     ) {
         $this->converterResult = new ConverterResult();
         $this->iriGenerator = new ApiPlatformIriGenerator();
@@ -58,7 +58,7 @@ public function enterNode(Node $node)
             return null;
         }
 
-        if ($this->classFilter && !$this->classFilter->isMatch($node)) {
+        if ($this->filter && !$this->filter->isMatch($node)) {
             return null;
         }
 
@@ -189,10 +189,15 @@ private function createApiEndpoint(
         if (!$output) {
             throw new Exception(sprintf("The output is required for ApiResource %s. Context: %s", $node->name->name, $this->prettyPrinter->prettyPrint([$apiResourceAttribute])));
         }
-        $outputTypeContext = $isCollection ? [
-            self::COLLECTION_RESPONSE_CONTEXT_KEY => true,
-        ] : [];
-        $outputType = PhpTypeFactory::create($output, $outputTypeContext);
+
+        $outputType = PhpTypeFactory::create($output);
+        if ($isCollection) {
+            $outputType = new PhpUnknownType(self::RESPONSE_TYPE_NAME, [
+                $outputType,
+            ], [
+                PhpUnknownType::GENERIC_IGNORE_NO_RESOLVER => true,
+            ]);
+        }
 
         $queryParams = [];
         $routeParams = [];
@@ -296,10 +301,15 @@ private function createApiEndpointFromLegacyCode(
         if (!$output) {
             throw new Exception(sprintf("The output is required for ApiResource %s. Context: %s", $node->name->name, $this->prettyPrinter->prettyPrint([$apiResourceAttribute])));
         }
-        $outputTypeContext = $isCollection && $method->equals(ApiEndpointMethod::get()) ? [
-            self::COLLECTION_RESPONSE_CONTEXT_KEY => true,
-        ] : [];
-        $outputType = PhpTypeFactory::create($output, $outputTypeContext);
+
+        $outputType = PhpTypeFactory::create($output);
+        if ($isCollection && $method->equals(ApiEndpointMethod::get())) {
+            $outputType = new PhpUnknownType(self::RESPONSE_TYPE_NAME, [
+                $outputType,
+            ], [
+                PhpUnknownType::GENERIC_IGNORE_NO_RESOLVER => true,
+            ]);
+        }
 
         $input = null;
         if ($arrayItemValue) {

src/Bridge/ApiPlatform/CollectionResponseTypeResolver.php

@@ -4,6 +4,7 @@
 
 namespace Riverwaysoft\PhpConverter\Bridge\Symfony;
 
+use Exception;
 use PhpParser\Node;
 use PhpParser\Node\Attribute;
 use PhpParser\Node\Stmt\ClassMethod;
@@ -15,16 +16,15 @@
 use Riverwaysoft\PhpConverter\Dto\ApiClient\ApiEndpointMethod;
 use Riverwaysoft\PhpConverter\Dto\ApiClient\ApiEndpointParam;
 use Riverwaysoft\PhpConverter\Dto\PhpType\PhpBaseType;
-use Riverwaysoft\PhpConverter\Dto\PhpType\PhpListType;
 use Riverwaysoft\PhpConverter\Dto\PhpType\PhpTypeFactory;
-use Exception;
-use function in_array;
-use function count;
+use Riverwaysoft\PhpConverter\Filter\FilterInterface;
 use function array_flip;
-use function sprintf;
 use function array_key_first;
-use function implode;
 use function array_map;
+use function count;
+use function implode;
+use function in_array;
+use function sprintf;
 
 class SymfonyControllerVisitor extends ConverterVisitor
 {
@@ -33,16 +33,19 @@ class SymfonyControllerVisitor extends ConverterVisitor
     private PhpDocTypeParser $phpDocTypeParser;
 
     public function __construct(
-        // TODO: consider using class filter interface?
-        private string $attribute,
+        private ?FilterInterface $filter,
     ) {
         $this->converterResult = new ConverterResult();
         $this->phpDocTypeParser = new PhpDocTypeParser();
     }
 
     public function enterNode(Node $node)
     {
-        if (!$node instanceof ClassMethod || !$this->findAttribute($node, $this->attribute)) {
+        if (!$node instanceof ClassMethod) {
+            return null;
+        }
+
+        if ($this->filter && !$this->filter->isMatch($node)) {
             return null;
         }
 
@@ -53,7 +56,7 @@ public function enterNode(Node $node)
 
     private function findAttribute(ClassMethod|Node\Param $node, string $name): Attribute|null
     {
-        $attrGroups = $node instanceof Node\Param ? $node->attrGroups : $node->getAttrGroups();
+        $attrGroups = $node->attrGroups;
 
         foreach ($attrGroups as $attrGroup) {
             foreach ($attrGroup->attrs as $attr) {
@@ -82,7 +85,7 @@ private function createApiEndpoint(ClassMethod $node): void
         $routeAttribute = $this->findAttribute($node, 'Route');
 
         if (!$routeAttribute) {
-            throw new Exception('#[DtoEndpoint] is used on a method, that does not have #[Route] attribute');
+            throw new Exception('The method was marked as generated but it does not have #[Route] attribute');
         }
 
         $route = null;
@@ -130,28 +133,13 @@ private function createApiEndpoint(ClassMethod $node): void
             throw new Exception('#[Route()] argument "methods" is required');
         }
 
-        $dtoReturnAttribute = $this->findAttribute($node, 'DtoEndpoint');
-        if (!$dtoReturnAttribute) {
-            throw new Exception('Should not be reached, checked earlier');
-        }
-
         $outputType = PhpBaseType::null();
         $methodComment = $node->getDocComment()?->getText();
 
-        if ($methodComment && $returnType = $this->phpDocTypeParser->parseVarOrReturn($methodComment)) {
-            $outputType = $returnType;
-        } else {
-            if ($arg = $this->getAttributeArgumentByName($dtoReturnAttribute, 'returnOne')) {
-                if (!($arg->value instanceof Node\Expr\ClassConstFetch)) {
-                    throw new Exception('Argument of returnOne should be a class string');
-                }
-                $outputType = PhpTypeFactory::create($arg->value->class->getParts()[0]);
-            }
-            if ($arg = $this->getAttributeArgumentByName($dtoReturnAttribute, 'returnMany')) {
-                if (!($arg->value instanceof Node\Expr\ClassConstFetch)) {
-                    throw new Exception('Argument of returnMany should be a class string');
-                }
-                $outputType = new PhpListType(PhpTypeFactory::create($arg->value->class->getParts()[0]));
+        if ($methodComment) {
+            $returnType = $this->phpDocTypeParser->parseVarOrReturn($methodComment);
+            if ($returnType) {
+                $outputType = $returnType;
             }
         }