Support API Platform's #[ApiResource] attribute (#55)

* Introduce ConverterVisitor to improve modularity

* Adapt tests

* Support collectionOperations

* phpstan

* Support itemOperations

Author: kubk

README.md

@@ -76,7 +76,9 @@ By default `dto-converter` writes all the types into one file. You can configure
 
 $application->add(
     new ConvertCommand(
-        new Converter(new PhpAttributeFilter('Dto')),
+        new Converter([
+            new DtoVisitor(new PhpAttributeFilter('Dto')),
+        ]),
         new TypeScriptGenerator(
 -            new SingleFileOutputWriter('generated.ts'),
 +            new EntityPerClassOutputWriter(
@@ -106,8 +108,10 @@ Suppose you don't want to mark each DTO individually with `#[Dto]` but want to c
 ```diff
 $application->add(
     new ConvertCommand(
--       new Converter(new PhpAttributeFilter('Dto')),
-+       new Converter(),
+-       new Converter([
+-           new DtoVisitor(new PhpAttributeFilter('Dto')),
+-       ]),
++       new Converter([new DtoVisitor()]),
         new TypeScriptGenerator(
             new SingleFileOutputWriter('generated.ts'),
             [
@@ -133,7 +137,9 @@ You can even go further and use `NegationFilter` to exclude specific files as sh
 
 $application->add(
     new ConvertCommand(
-        new Converter(new PhpAttributeFilter('Dto')),
+        new Converter([
+            new DtoVisitor(new PhpAttributeFilter('Dto')),
+        ]),
         new TypeScriptGenerator(
             new SingleFileOutputWriter('generated.ts'),
             [
@@ -160,12 +166,14 @@ $application->add(
 
 ### How to customize generated output file?
 
-You may want to apply some transformations on the resulted file with types. For example you may want to format it with tool of your choice or prepend code with a warning like "// The file was autogenerated, don't edit it manually". To add such a warning you can already use the built-in extension:
+You may want to apply some transformations on the resulted file with types. For example, you may want to format it with tool of your choice or prepend code with a warning like "// The file was autogenerated, don't edit it manually". To add such a warning you can already use the built-in extension:
 
 ```diff
 $application->add(
     new ConvertCommand(
-        new Converter(new PhpAttributeFilter('Dto')),
+        new Converter([
+            new DtoVisitor(new PhpAttributeFilter('Dto')),
+        ]),
         new TypeScriptGenerator(
             new SingleFileOutputWriter('generated.ts'),
             [
@@ -220,7 +228,9 @@ Then add it to the list:
 ```diff
 $application->add(
     new ConvertCommand(
-        new Converter(new PhpAttributeFilter('Dto')),
+        new Converter([
+            new DtoVisitor(new PhpAttributeFilter('Dto')),
+        ]),
         new TypeScriptGenerator(
             new SingleFileOutputWriter('generated.ts'),
             [

bin/dto-converter-ts

@@ -6,6 +6,8 @@ declare(strict_types=1);
 require_once __DIR__ . '/../vendor/autoload.php';
 
 use Riverwaysoft\DtoConverter\Ast\Converter;
+use Riverwaysoft\DtoConverter\Ast\DtoVisitor;
+use Riverwaysoft\DtoConverter\Bridge\Symfony\SymfonyControllerVisitor;
 use Riverwaysoft\DtoConverter\ClassFilter\PhpAttributeFilter;
 use Riverwaysoft\DtoConverter\Cli\ConvertCommand;
 use Riverwaysoft\DtoConverter\CodeProvider\FileSystemCodeProvider;
@@ -21,9 +23,10 @@ $application = new Application();
 
 $application->add(
     new ConvertCommand(
-        new Converter(
-            new PhpAttributeFilter('Dto'),
-        ),
+        new Converter([
+           new DtoVisitor(new PhpAttributeFilter('Dto')),
+           new SymfonyControllerVisitor('DtoEndpoint'),
+        ]),
         new TypeScriptGenerator(
             new SingleFileOutputWriter('generated.ts'),
             [

src/Ast/Converter.php

@@ -19,41 +19,34 @@
 class Converter
 {
     private Parser $parser;
-    private PhpDocTypeParser $phpDocTypeParser;
-    private PhpTypeFactory $phpTypeFactory;
 
     public function __construct(
-        private ?ClassFilterInterface $dtoClassFilter = null,
+        /** @var ConverterVisitor[] */
+        private array $visitors,
     ) {
-        $this->phpTypeFactory = new PhpTypeFactory();
         $this->parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
-        $this->phpDocTypeParser = new PhpDocTypeParser($this->phpTypeFactory);
     }
 
     /** @param string[]|iterable $listings */
     public function convert(iterable $listings): ConverterResult
     {
-        $dtoList = new DtoList();
-        $apiEndpointList = new ApiEndpointList();
+        $converterResult = new ConverterResult();
 
         foreach ($listings as $listing) {
-            $this->normalize($listing, $dtoList, $apiEndpointList);
-        }
+            $ast = $this->parser->parse($listing);
+            $traverser = new NodeTraverser();
 
-        return new ConverterResult(
-            dtoList: $dtoList,
-            apiEndpointList: $apiEndpointList,
-        );
-    }
+            foreach ($this->visitors as $visitor) {
+                $traverser->addVisitor($visitor);
+            }
 
-    private function normalize(string $code, DtoList $dtoList, ApiEndpointList $apiEndpointList): void
-    {
-        $ast = $this->parser->parse($code);
-        $dtoVisitor = new DtoVisitor($dtoList, $this->phpDocTypeParser, $this->phpTypeFactory, $this->dtoClassFilter);
-        $symfonyControllerVisitor = new SymfonyControllerVisitor('DtoEndpoint', $apiEndpointList, $this->phpTypeFactory);
-        $traverser = new NodeTraverser();
-        $traverser->addVisitor($dtoVisitor);
-        $traverser->addVisitor($symfonyControllerVisitor);
-        $traverser->traverse($ast);
+            $traverser->traverse($ast);
+
+            foreach ($this->visitors as $visitor) {
+                $converterResult->merge($visitor->popResult());
+            }
+        }
+
+        return $converterResult;
     }
 }

src/Ast/ConverterResult.php

@@ -9,9 +9,22 @@
 
 class ConverterResult
 {
-    public function __construct(
-        public DtoList $dtoList,
-        public ApiEndpointList|null $apiEndpointList = null
-    ) {
+    public DtoList $dtoList;
+    public ApiEndpointList $apiEndpointList;
+
+    public function __construct()
+    {
+        $this->dtoList = new DtoList();
+        $this->apiEndpointList = new ApiEndpointList();
+    }
+
+    public function merge(self $result): void
+    {
+        foreach ($result->dtoList->getList() as $anotherDto) {
+            $this->dtoList->add($anotherDto);
+        }
+        foreach ($result->apiEndpointList->getList() as $anotherEndpoint) {
+            $this->apiEndpointList->add($anotherEndpoint);
+        }
     }
 }

src/Ast/ConverterVisitor.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Riverwaysoft\DtoConverter\Ast;
+
+use PhpParser\NodeVisitorAbstract;
+
+abstract class ConverterVisitor extends NodeVisitorAbstract
+{
+    abstract public function popResult(): ConverterResult;
+}

src/Ast/DtoVisitor.php

@@ -7,25 +7,25 @@
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\Enum_;
-use PhpParser\NodeVisitorAbstract;
 use Riverwaysoft\DtoConverter\ClassFilter\ClassFilterInterface;
 use Riverwaysoft\DtoConverter\Dto\DtoClassProperty;
 use Riverwaysoft\DtoConverter\Dto\DtoEnumProperty;
-use Riverwaysoft\DtoConverter\Dto\DtoList;
 use Riverwaysoft\DtoConverter\Dto\DtoType;
 use Riverwaysoft\DtoConverter\Dto\ExpressionType;
 use Riverwaysoft\DtoConverter\Dto\PhpType\PhpTypeFactory;
 use Riverwaysoft\DtoConverter\Dto\PhpType\PhpTypeInterface;
 use Riverwaysoft\DtoConverter\Dto\PhpType\PhpUnionType;
 
-class DtoVisitor extends NodeVisitorAbstract
+class DtoVisitor extends ConverterVisitor
 {
+    private PhpDocTypeParser $phpDocTypeParser;
+    private ConverterResult $converterResult;
+
     public function __construct(
-        private DtoList $dtoList,
-        private PhpDocTypeParser $phpDocTypeParser,
-        private PhpTypeFactory $phpTypeFactory,
         private ?ClassFilterInterface $classFilter = null
     ) {
+        $this->phpDocTypeParser = new PhpDocTypeParser();
+        $this->converterResult = new ConverterResult();
     }
 
     public function leaveNode(Node $node)
@@ -63,7 +63,7 @@ private function createSingleType(
             ? $param->parts[0]
             : $param->name;
 
-        return $this->phpTypeFactory->create($typeName);
+        return PhpTypeFactory::create($typeName);
     }
 
     private function createDtoType(Class_|Enum_ $node): void
@@ -137,7 +137,7 @@ private function createDtoType(Class_|Enum_ $node): void
             }
         }
 
-        $this->dtoList->add(new DtoType(
+        $this->converterResult->dtoList->add(new DtoType(
             name: $node->name->name,
             expressionType: $expressionType,
             properties: $properties,
@@ -158,4 +158,11 @@ public function resolveExpressionType(Class_|Enum_ $node): ExpressionType
             ? ExpressionType::enumNonStandard()
             : ExpressionType::class();
     }
+
+    public function popResult(): ConverterResult
+    {
+        $result = $this->converterResult;
+        $this->converterResult = new ConverterResult();
+        return $result;
+    }
 }

src/Ast/PhpDocTypeParser.php

@@ -25,7 +25,7 @@ class PhpDocTypeParser
     private Lexer $lexer;
     private PhpDocParser $phpDocParser;
 
-    public function __construct(private PhpTypeFactory $phpTypeFactory)
+    public function __construct()
     {
         $this->lexer = new Lexer();
         $constExprParser = new ConstExprParser();
@@ -62,7 +62,7 @@ public function parse(string $input): PhpTypeInterface|null
     private function convertToDto(TypeNode $node): PhpTypeInterface|null
     {
         if ($node instanceof IdentifierTypeNode) {
-            return $this->phpTypeFactory->create($node->name);
+            return PhpTypeFactory::create($node->name);
         }
         if ($node instanceof ArrayTypeNode) {
             return new PhpListType($this->convertToDto($node->type));

src/Ast/PhpDocTypeParserTest.php

@@ -17,7 +17,7 @@ class PhpDocTypeParserTest extends TestCase
     /** @dataProvider getData */
     public function testBasicScenario(string $explanation, string $input, PhpTypeInterface|null $expected): void
     {
-        $parser = new PhpDocTypeParser(new PhpTypeFactory());
+        $parser = new PhpDocTypeParser();
         $result = $parser->parse($input);
         $this->assertEquals($result, $expected, sprintf("Assert failed. Data row: '%s'", $explanation));
     }