Merge pull request #29 from picamator/development

Release 2.2.3

Author: picamator

README.md

@@ -122,7 +122,7 @@ Definition Files and Transfer Object generators have been tested against the fol
 4. Transfer Object is converted back to the array
 5. The converted array is compared with the API response
 
-✅ In all cases, data are matched.
+For all APIs, data are ✅ matched.
 
 For detailed information, please check [DefinitionGeneratorFacadeTest](/tests/integration/DefinitionGenerator/DefinitionGeneratorFacadeTest.php).
 
@@ -134,12 +134,12 @@ For more details, please visit [project's wiki](https://github.com/picamator/tra
 Acknowledgment
 --------------
 
-Many thanks for your contribution, support, feedback and simply using the Transfer Object Generator! ❤️
+Many thanks ❤️ for your contribution, support, feedback and simply using the Transfer Object Generator!
 
 Contribution
 ------------
 
-If you find this project useful, please star ⭐ the repository.
+If you find this project useful, please ⭐ star the repository.
 Follow the project to stay updated with all activities.
 
 If you have suggestions for improvements or new features, feel free to:

composer.lock

@@ -17,6 +17,9 @@ parameters:
     -
         identifier: encapsedStringPart.nonString
         path: src/TransferGenerator/Generator/Render/Template/Template.php
+    -
+        identifier: return.type
+        path: src/*/*Factory.php
 rules:
    - PHPStan\Rules\DisallowedConstructs\DisallowedBacktickRule
    - PHPStan\Rules\StrictCalls\StrictFunctionCallsRule

phpstan.neon

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Picamator\TransferObject\DefinitionGenerator\Builder;
+
+use Picamator\TransferObject\DefinitionGenerator\Builder\Expander\BuilderExpanderInterface;
+use Picamator\TransferObject\DefinitionGenerator\Builder\Expander\BuildInTypeBuilderExpander;
+use Picamator\TransferObject\DefinitionGenerator\Builder\Expander\CollectionTypeBuilderExpander;
+use Picamator\TransferObject\DefinitionGenerator\Builder\Expander\TransferTypeBuilderExpander;
+use Picamator\TransferObject\Shared\CachedFactoryTrait;
+
+class DefinitionBuilderFactory
+{
+    use CachedFactoryTrait;
+
+    public function createDefinitionBuilder(): DefinitionBuilderInterface
+    {
+        return $this->getCached(
+            key: 'definition-builder',
+            factory: fn (): DefinitionBuilderInterface => new DefinitionBuilder(
+                $this->createDefinitionContentBuilder(),
+                $this->createBuilderExpander(),
+            ),
+        );
+    }
+
+    protected function createDefinitionContentBuilder(): DefinitionContentBuilderInterface
+    {
+        return new DefinitionContentBuilder();
+    }
+
+    protected function createBuilderExpander(): BuilderExpanderInterface
+    {
+        $builderExpander = $this->createTransferTypeBuilderExpander();
+
+        $builderExpander
+            ->setNextExpander($this->createCollectionTypeBuilderExpander())
+            ->setNextExpander($this->createBuildInTypeBuilderExpander());
+
+        return $builderExpander;
+    }
+
+    protected function createBuildInTypeBuilderExpander(): BuilderExpanderInterface
+    {
+        return new BuildInTypeBuilderExpander();
+    }
+
+    protected function createCollectionTypeBuilderExpander(): BuilderExpanderInterface
+    {
+        return new CollectionTypeBuilderExpander();
+    }
+
+    protected function createTransferTypeBuilderExpander(): BuilderExpanderInterface
+    {
+        return new TransferTypeBuilderExpander();
+    }
+}

src/DefinitionGenerator/Builder/DefinitionBuilderFactory.php

@@ -5,14 +5,8 @@
 namespace Picamator\TransferObject\DefinitionGenerator\Generator;
 
 // phpcs:disable Generic.Files.LineLength
-use Picamator\TransferObject\DefinitionGenerator\Builder\DefinitionBuilder;
+use Picamator\TransferObject\DefinitionGenerator\Builder\DefinitionBuilderFactory;
 use Picamator\TransferObject\DefinitionGenerator\Builder\DefinitionBuilderInterface;
-use Picamator\TransferObject\DefinitionGenerator\Builder\DefinitionContentBuilder;
-use Picamator\TransferObject\DefinitionGenerator\Builder\DefinitionContentBuilderInterface;
-use Picamator\TransferObject\DefinitionGenerator\Builder\Expander\BuilderExpanderInterface;
-use Picamator\TransferObject\DefinitionGenerator\Builder\Expander\BuildInTypeBuilderExpander;
-use Picamator\TransferObject\DefinitionGenerator\Builder\Expander\CollectionTypeBuilderExpander;
-use Picamator\TransferObject\DefinitionGenerator\Builder\Expander\TransferTypeBuilderExpander;
 use Picamator\TransferObject\DefinitionGenerator\Generator\Builder\DefinitionGeneratorBuilder;
 use Picamator\TransferObject\DefinitionGenerator\Generator\Builder\DefinitionGeneratorBuilderInterface;
 use Picamator\TransferObject\DefinitionGenerator\Generator\Filesystem\DefinitionFilesystem;
@@ -37,9 +31,10 @@ class DefinitionGeneratorFactory
     use SharedFactoryTrait;
     use CachedFactoryTrait;
 
+    private static DefinitionBuilderFactory $definitionBuilderFactory;
+
     public function createDefinitionGeneratorService(): DefinitionGeneratorServiceInterface
     {
-        /** @phpstan-ignore return.type */
         return $this->getCached(
             key: 'definition-generator-service',
             factory: fn (): DefinitionGeneratorServiceInterface => new DefinitionGeneratorService(
@@ -50,7 +45,6 @@ public function createDefinitionGeneratorService(): DefinitionGeneratorServiceIn
 
     public function createDefinitionGeneratorBuilder(): DefinitionGeneratorBuilderInterface
     {
-        /** @phpstan-ignore return.type */
         return $this->getCached(
             key: 'definition-generator-builder',
             factory: fn (): DefinitionGeneratorBuilderInterface => new DefinitionGeneratorBuilder(
@@ -96,7 +90,6 @@ protected function createPreDefinitionProcessCommand(): PreDefinitionProcessComm
 
     protected function createDefinitionFilesystem(): DefinitionFilesystemInterface
     {
-        /** @phpstan-ignore return.type */
         return $this->getCached(
             key: 'definition-filesystem',
             factory: fn (): DefinitionFilesystemInterface => new DefinitionFilesystem(
@@ -108,7 +101,6 @@ protected function createDefinitionFilesystem(): DefinitionFilesystemInterface
 
     protected function createDefinitionRender(): DefinitionRenderInterface
     {
-        /** @phpstan-ignore return.type */
         return $this->getCached(
             key: 'definition-render',
             factory: fn (): DefinitionRenderInterface => new DefinitionRender()
@@ -117,40 +109,12 @@ protected function createDefinitionRender(): DefinitionRenderInterface
 
     protected function createDefinitionBuilder(): DefinitionBuilderInterface
     {
-        return new DefinitionBuilder(
-            $this->createDefinitionContentBuilder(),
-            $this->createBuilderExpander(),
-        );
-    }
-
-    protected function createDefinitionContentBuilder(): DefinitionContentBuilderInterface
-    {
-        return new DefinitionContentBuilder();
-    }
-
-    protected function createBuilderExpander(): BuilderExpanderInterface
-    {
-        $builderExpander = $this->createTransferTypeBuilderExpander();
-
-        $builderExpander
-            ->setNextExpander($this->createCollectionTypeBuilderExpander())
-            ->setNextExpander($this->createBuildInTypeBuilderExpander());
-
-        return $builderExpander;
-    }
-
-    protected function createBuildInTypeBuilderExpander(): BuilderExpanderInterface
-    {
-        return new BuildInTypeBuilderExpander();
-    }
-
-    protected function createCollectionTypeBuilderExpander(): BuilderExpanderInterface
-    {
-        return new CollectionTypeBuilderExpander();
+        return $this->getDefinitionBuilderFactory()
+            ->createDefinitionBuilder();
     }
 
-    protected function createTransferTypeBuilderExpander(): BuilderExpanderInterface
+    protected function getDefinitionBuilderFactory(): DefinitionBuilderFactory
     {
-        return new TransferTypeBuilderExpander();
+        return self::$definitionBuilderFactory ??= new DefinitionBuilderFactory();
     }
 }

src/DefinitionGenerator/Generator/DefinitionGeneratorFactory.php

@@ -36,7 +36,6 @@ class ConfigFactory
 
     public function createConfigLoader(): ConfigLoaderInterface
     {
-        /** @phpstan-ignore return.type */
         return $this->getCached(
             key: 'config-loader',
             factory: fn(): ConfigLoaderInterface =>

src/TransferGenerator/Config/ConfigFactory.php

@@ -5,6 +5,9 @@
 namespace Picamator\TransferObject\TransferGenerator\Definition;
 
 use Picamator\TransferObject\Shared\CachedFactoryTrait;
+use Picamator\TransferObject\Shared\SharedFactoryTrait;
+use Picamator\TransferObject\TransferGenerator\Config\ConfigFactoryTrait;
+use Picamator\TransferObject\TransferGenerator\Definition\Filesystem\DefinitionFinder;
 use Picamator\TransferObject\TransferGenerator\Definition\Filesystem\DefinitionFinderInterface;
 use Picamator\TransferObject\TransferGenerator\Definition\Parser\DefinitionParserInterface;
 use Picamator\TransferObject\TransferGenerator\Definition\Parser\ParserFactory;
@@ -15,6 +18,8 @@
 
 class DefinitionFactory
 {
+    use ConfigFactoryTrait;
+    use SharedFactoryTrait;
     use CachedFactoryTrait;
 
     private static ValidatorFactory $validatorFactory;
@@ -23,7 +28,6 @@ class DefinitionFactory
 
     public function createDefinitionReader(): DefinitionReaderInterface
     {
-        /** @phpstan-ignore return.type */
         return $this->getCached(
             key: 'definition-reader',
             factory: fn (): DefinitionReaderInterface =>
@@ -42,7 +46,10 @@ protected function createDefinitionValidator(): DefinitionValidatorInterface
 
     protected function createDefinitionFinder(): DefinitionFinderInterface
     {
-        return $this->getParserFactory()->createDefinitionFinder();
+        return new DefinitionFinder(
+            $this->getFinder(),
+            $this->getConfig(),
+        );
     }
 
     protected function createDefinitionParser(): DefinitionParserInterface

src/TransferGenerator/Definition/DefinitionFactory.php

@@ -7,4 +7,9 @@
 enum TypeSuffixEnum: string
 {
     case TRANSFER = 'Transfer';
+
+    public function getClassName(string $className): string
+    {
+        return $className . $this->value;
+    }
 }

src/TransferGenerator/Definition/Enum/TypeSuffixEnum.php

@@ -11,6 +11,8 @@
 
 readonly class ContentBuilder implements ContentBuilderInterface
 {
+    private const TypeSuffixEnum CLASS_SUFFIX = TypeSuffixEnum::TRANSFER;
+
     public function __construct(
         private PropertyExpanderInterface $propertyExpander,
     ) {
@@ -19,7 +21,7 @@ public function __construct(
     public function createContentTransfer(string $className, array $properties): DefinitionContentTransfer
     {
         $contentTransfer = new DefinitionContentTransfer();
-        $contentTransfer->className = $this->getTransferClassName($className);
+        $contentTransfer->className = self::CLASS_SUFFIX->getClassName($className);
 
         foreach ($properties as $propertyName => $propertyType) {
             $contentTransfer->properties[] = $this->createPropertyTransfer((string)$propertyName, $propertyType);
@@ -40,9 +42,4 @@ private function createPropertyTransfer(string $propertyName, array $propertyTyp
 
         return $propertyTransfer;
     }
-
-    private function getTransferClassName(string $className): string
-    {
-        return $className . TypeSuffixEnum::TRANSFER->value;
-    }
 }

src/TransferGenerator/Definition/Parser/ContentBuilder.php

@@ -19,13 +19,18 @@ public function setNextExpander(PropertyExpanderInterface $expander): PropertyEx
 
     public function expandPropertyTransfer(array $propertyType, DefinitionPropertyTransfer $propertyTransfer): void
     {
-        $this->handleExpander($propertyType, $propertyTransfer);
+        $matchedType = $this->matchType($propertyType);
+        if ($matchedType !== null) {
+            $this->handleExpander($matchedType, $propertyTransfer);
+        }
 
         $this->nextExpander?->expandPropertyTransfer($propertyType, $propertyTransfer);
     }
 
     /**
      * @param array<string,string|null> $propertyType
      */
-    abstract protected function handleExpander(array $propertyType, DefinitionPropertyTransfer $propertyTransfer): void;
+    abstract protected function matchType(array $propertyType): ?string;
+
+    abstract protected function handleExpander(string $matchedType, DefinitionPropertyTransfer $propertyTransfer): void;
 }