Merge pull request #51 from picamator/development

Release 5.4.3

Author: picamator

AGENTS.md

@@ -98,6 +98,10 @@ Code Style
   * **validator** classes should have `public` methods prefixed by `validate`
   * methods returning `bool` should be prefixed by `is`
 
+### Tests
+
+- all tests classes should be a `final`
+
 Module Structure
 ----------------
 
@@ -148,6 +152,19 @@ Docker Environment can be stopped by running the following command:
 docker/sdk stop
 ```
 
+How to Run PHP Script
+---------------------
+
+The PHP script can be run by command:
+```console
+docker/sdk cli [path-to-script]
+```
+
+For instance, the `./examples/try-transfer-generator.php`:
+```console
+docker/sdk cli ./examples/try-transfer-generator.php
+```
+
 How to Generate Internal Transfer Objects
 -----------------------------------------
 

composer.lock

@@ -26,7 +26,7 @@ function show_usage() {
   echo -e "  $(wrap_in_yellow "build")                      Build Docker containers"
   echo -e "  $(wrap_in_yellow "start")                      Start Docker containers (honors -x / -p)"
   echo -e "  $(wrap_in_yellow "stop")                       Stop Docker containers"
-  echo -e "  $(wrap_in_yellow "cli")                        Open container shell"
+  echo -e "  $(wrap_in_yellow "cli")                        Open container shell or execute the PHP script when provided as an argument"
   echo -e "  $(wrap_in_yellow "composer <command>")         Run composer command"
   echo -e "  $(wrap_in_yellow "phpstan")                    Run PHPStan"
   echo -e "  $(wrap_in_yellow "phpunit")                    Run all PHPUnit tests or concrete test case when full qualified name provided as an argument"
@@ -84,7 +84,11 @@ case $1 in
     docker compose stop
     ;;
   cli)
-    $DOCKER_EXEC bash
+    if [ -n "$2" ]; then
+      $DOCKER_EXEC php -f $2
+    else
+      $DOCKER_EXEC bash
+    fi
     ;;
   composer)
     if [ -n "$5" ]; then

docker/sdk

@@ -9,27 +9,25 @@
 use Picamator\TransferObject\DefinitionGenerator\Generator\DefinitionGeneratorFactory;
 use Picamator\TransferObject\Generated\DefinitionGeneratorTransfer;
 
-class DefinitionGeneratorFacade implements DefinitionGeneratorFacadeInterface
+readonly class DefinitionGeneratorFacade implements DefinitionGeneratorFacadeInterface
 {
-    private static DefinitionGeneratorFactory $factory;
+    public function __construct(
+        private DefinitionGeneratorFactory $factory = new DefinitionGeneratorFactory(),
+    ) {
+    }
 
     #[NoDiscard('The result should be used to validate how many definitions were generated.')]
     public function generateDefinitionsOrFail(DefinitionGeneratorTransfer $generatorTransfer): int
     {
-        return $this->getFactory()
+        return $this->factory
             ->createDefinitionGeneratorService()
             ->generateDefinitionsOrFail($generatorTransfer);
     }
 
     #[NoDiscard('The builder should be used to create DefinitionGeneratorTransfer.')]
     public function createDefinitionGeneratorBuilder(): DefinitionGeneratorBuilderInterface
     {
-        return $this->getFactory()
+        return $this->factory
             ->createDefinitionGeneratorBuilder();
     }
-
-    private function getFactory(): DefinitionGeneratorFactory
-    {
-        return self::$factory ??= new DefinitionGeneratorFactory();
-    }
 }

src/DefinitionGenerator/DefinitionGeneratorFacade.php

@@ -29,7 +29,10 @@ class DefinitionGeneratorFactory
 {
     use SharedFactoryTrait;
 
-    private static DefinitionContentFactory $definitionContentFactory;
+    public function __construct(
+        private readonly DefinitionContentFactory $definitionContentFactory = new DefinitionContentFactory(),
+    ) {
+    }
 
     public function createDefinitionGeneratorService(): DefinitionGeneratorServiceInterface
     {
@@ -117,12 +120,7 @@ className: TemplateRender::class,
 
     protected function createContentReader(): ContentReaderInterface
     {
-        return $this->getDefinitionContentFactory()
+        return $this->definitionContentFactory
             ->createContentReader();
     }
-
-    protected function getDefinitionContentFactory(): DefinitionContentFactory
-    {
-        return self::$definitionContentFactory ??= new DefinitionContentFactory();
-    }
 }

src/DefinitionGenerator/Generator/DefinitionGeneratorFactory.php

@@ -20,9 +20,11 @@ class DefinitionFactory
     use ConfigFactoryTrait;
     use SharedFactoryTrait;
 
-    private static ValidatorFactory $validatorFactory;
-
-    private static ParserFactory $parserFactory;
+    public function __construct(
+        private readonly ValidatorFactory $validatorFactory = new ValidatorFactory(),
+        private readonly ParserFactory $parserFactory = new ParserFactory(),
+    ) {
+    }
 
     public function createDefinitionReader(): DefinitionReaderInterface
     {
@@ -39,7 +41,7 @@ public function createDefinitionReader(): DefinitionReaderInterface
 
     protected function createDefinitionValidator(): DefinitionValidatorInterface
     {
-        return $this->getValidatorFactory()->createDefinitionValidator();
+        return $this->validatorFactory->createDefinitionValidator();
     }
 
     protected function createDefinitionFinder(): DefinitionFinderInterface
@@ -52,16 +54,6 @@ protected function createDefinitionFinder(): DefinitionFinderInterface
 
     protected function createDefinitionParser(): DefinitionParserInterface
     {
-        return $this->getParserFactory()->createDefinitionParser();
-    }
-
-    protected function getValidatorFactory(): ValidatorFactory
-    {
-        return self::$validatorFactory ??= new ValidatorFactory();
-    }
-
-    protected function getParserFactory(): ParserFactory
-    {
-        return self::$parserFactory ??= new ParserFactory();
+        return $this->parserFactory->createDefinitionParser();
     }
 }

src/TransferGenerator/Definition/DefinitionFactory.php

@@ -13,7 +13,10 @@ class WorkflowFactory
 {
     use SharedFactoryTrait;
 
-    private static GeneratorFactory $generatorFactory;
+    public function __construct(
+        private readonly GeneratorFactory $generatorFactory = new GeneratorFactory(),
+    ) {
+    }
 
     public function createTransferGeneratorWorkflow(): TransferGeneratorWorkflowInterface
     {
@@ -26,11 +29,6 @@ public function createTransferGeneratorWorkflow(): TransferGeneratorWorkflowInte
 
     protected function createGeneratorProcessor(): GeneratorProcessorInterface
     {
-        return $this->getGeneratorFactory()->createGeneratorProcessor();
-    }
-
-    protected function getGeneratorFactory(): GeneratorFactory
-    {
-        return self::$generatorFactory ??= new GeneratorFactory();
+        return $this->generatorFactory->createGeneratorProcessor();
     }
 }

src/TransferGenerator/Generator/Generator/WorkflowFactory.php

@@ -22,6 +22,7 @@
 use Picamator\TransferObject\TransferGenerator\Generator\Render\Template\Helper\TemplateHelper;
 use Picamator\TransferObject\TransferGenerator\Generator\Render\Template\Helper\TemplateHelperInterface;
 use Picamator\TransferObject\TransferGenerator\Generator\Render\Template\Template;
+use Picamator\TransferObject\TransferGenerator\Generator\Render\Template\TemplateInterface;
 
 class RenderFactory
 {
@@ -45,7 +46,7 @@ className: TemplateRender::class,
         return $templateRender;
     }
 
-    protected function createTemplate(): Template
+    protected function createTemplate(): TemplateInterface
     {
         return new Template($this->createTemplateHelper());
     }

src/TransferGenerator/Generator/Render/RenderFactory.php

@@ -7,13 +7,13 @@
 use Picamator\TransferObject\Generated\TemplateTransfer;
 use Picamator\TransferObject\TransferGenerator\Generator\Render\Template\Helper\TemplateHelperInterface;
 
-readonly class Template
+readonly class Template implements TemplateInterface
 {
     public function __construct(private TemplateHelperInterface $helper)
     {
     }
 
-    public function __invoke(TemplateTransfer $templateTransfer): string
+    public function render(TemplateTransfer $templateTransfer): string
     {
         $this->helper->setTemplateTransfer($templateTransfer);
 

src/TransferGenerator/Generator/Render/Template/Template.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Picamator\TransferObject\TransferGenerator\Generator\Render\Template;
+
+use Picamator\TransferObject\Generated\TemplateTransfer;
+
+interface TemplateInterface
+{
+    public function render(TemplateTransfer $templateTransfer): string;
+}