Delegate factory rendering to interface in kickstarter

PackageFactory · Nov 16, 2022 · b28563f · b28563f
1 parent 27046ff
commit b28563f
Show file tree

Hide file tree

Showing 8 changed files with 161 additions and 53 deletions.
diff --git a/Classes/Command/ComponentCommandController.php b/Classes/Command/ComponentCommandController.php
@@ -13,6 +13,7 @@
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\ComponentGenerator;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\ComponentName;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\Enum\EnumGenerator;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\FactoryRendererInterface;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\PackageKey;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\PackageResolver;
 use PackageFactory\AtomicFusion\PresentationObjects\Infrastructure\DefensiveConfirmationFileWriter;
@@ -34,6 +35,9 @@ class ComponentCommandController extends CommandController
      */
     protected $colocate;
 
+    #[Flow\Inject]
+    protected FactoryRendererInterface $factoryRenderer;
+
     /**
      * Create a new PresentationObject component and factory
      *
@@ -66,7 +70,8 @@ class ComponentCommandController extends CommandController
     public function kickStartCommand(string $name, bool $listable = false, bool $yes = false): void
     {
         $componentGenerator = new ComponentGenerator(
-            new DefensiveConfirmationFileWriter($this->output, $yes)
+            new DefensiveConfirmationFileWriter($this->output, $yes),
+            $this->factoryRenderer
         );
         $package = $this->packageResolver->resolvePackage();
         $componentName = ComponentName::fromInput($name, PackageKey::fromPackage($package));

diff --git a/Classes/Domain/Component/Component.php b/Classes/Domain/Component/Component.php
@@ -14,8 +14,8 @@
 final class Component
 {
     public function __construct(
-        private ComponentName $name,
-        private Props $props
+        public readonly ComponentName $name,
+        public readonly Props $props
     ) {
     }
 
@@ -40,24 +40,6 @@ final class ' . $this->name->getSimpleClassName() . ' extends AbstractComponentP
 ';
     }
 
-    public function getFactoryContent(): string
-    {
-        return '<?php
-
-' . $this->name->renderClassComment() . '
-
-declare(strict_types=1);
-
-namespace ' . $this->name->getPhpNamespace() . ';
-
-use PackageFactory\AtomicFusion\PresentationObjects\Fusion\AbstractComponentPresentationObjectFactory;
-
-final class ' . $this->name->getSimpleFactoryName() . ' extends AbstractComponentPresentationObjectFactory
-{
-}
-';
-    }
-
     public function getComponentArrayContent(): string
     {
         return '<?php

diff --git a/Classes/Domain/Component/ComponentGenerator.php b/Classes/Domain/Component/ComponentGenerator.php
@@ -9,22 +9,21 @@
 namespace PackageFactory\AtomicFusion\PresentationObjects\Domain\Component;
 
 use Neos\Flow\Annotations as Flow;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\FactoryRendererInterface;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\FileWriterInterface;
 use Symfony\Component\Yaml\Parser as YamlParser;
 use Symfony\Component\Yaml\Dumper as YamlWriter;
 
 /**
  * The component generator domain service
- *
- * @Flow\Proxy(false)
  */
+#[Flow\Proxy(false)]
 final class ComponentGenerator
 {
-    private FileWriterInterface $fileWriter;
-
-    public function __construct(FileWriterInterface $fileWriter)
-    {
-        $this->fileWriter = $fileWriter;
+    public function __construct(
+        private readonly FileWriterInterface $fileWriter,
+        private readonly FactoryRendererInterface $factoryRenderer
+    ) {
     }
 
     /**
@@ -47,7 +46,10 @@ public function generateComponent(
         $component = new Component($componentName, $props);
 
         $this->fileWriter->writeFile($componentName->getClassPath($packagePath, $colocate), $component->getClassContent());
-        $this->fileWriter->writeFile($componentName->getFactoryPath($packagePath, $colocate), $component->getFactoryContent());
+        $this->fileWriter->writeFile(
+            $componentName->getFactoryPath($packagePath, $colocate),
+            $this->factoryRenderer->renderFactoryContent($component)
+        );
         $this->fileWriter->writeFile($componentName->getFusionComponentPath($packagePath), $component->getFusionContent());
 
         if ($listable) {

diff --git a/Classes/Domain/DummyFactoryRenderer.php b/Classes/Domain/DummyFactoryRenderer.php
@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the PackageFactory.AtomicFusion.PresentationObjects package
+ */
+
+declare(strict_types=1);
+
+namespace PackageFactory\AtomicFusion\PresentationObjects\Domain;
+
+use Neos\Flow\Annotations as Flow;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\Component;
+
+/**
+ * The dummy presentation object factory renderer
+ */
+#[Flow\Proxy(false)]
+final class DummyFactoryRenderer implements FactoryRendererInterface
+{
+    public function renderFactoryContent(Component $component): string
+    {
+        return '<?php
+
+' . $component->name->renderClassComment() . '
+
+declare(strict_types=1);
+
+namespace ' . $component->name->getPhpNamespace() . ';
+
+use PackageFactory\AtomicFusion\PresentationObjects\Fusion\AbstractComponentPresentationObjectFactory;
+
+final class ' . $component->name->getSimpleFactoryName() . ' extends AbstractComponentPresentationObjectFactory
+{
+}
+';
+    }
+}
diff --git a/Classes/Domain/FactoryRendererInterface.php b/Classes/Domain/FactoryRendererInterface.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the PackageFactory.AtomicFusion.PresentationObjects package
+ */
+
+declare(strict_types=1);
+
+namespace PackageFactory\AtomicFusion\PresentationObjects\Domain;
+
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\Component;
+
+interface FactoryRendererInterface
+{
+    public function renderFactoryContent(Component $component): string;
+}
diff --git a/Tests/Unit/Domain/Component/ComponentGeneratorTest.php b/Tests/Unit/Domain/Component/ComponentGeneratorTest.php
@@ -12,6 +12,7 @@
 use org\bovigo\vfs\vfsStream;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\ComponentGenerator;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\ComponentName;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\DummyFactoryRenderer;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\FusionNamespace;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\PackageKey;
 use PackageFactory\AtomicFusion\PresentationObjects\Infrastructure\SimpleFileWriter;
@@ -50,7 +51,8 @@ public function setUpComponentGeneratorTest(): void
         ]);
 
         $this->componentGenerator = new ComponentGenerator(
-            new SimpleFileWriter()
+            new SimpleFileWriter(),
+            new DummyFactoryRenderer()
         );
     }
 

diff --git a/Tests/Unit/Domain/Component/ComponentTest.php b/Tests/Unit/Domain/Component/ComponentTest.php
@@ -116,29 +116,6 @@ public function __construct(
         );
     }
 
-    public function testGetFactoryContent(): void
-    {
-        Assert::assertSame(
-            '<?php
-
-/*
- * This file is part of the Vendor.Site package.
- */
-
-declare(strict_types=1);
-
-namespace Vendor\Site\Presentation\Component\MyNewComponent;
-
-use PackageFactory\AtomicFusion\PresentationObjects\Fusion\AbstractComponentPresentationObjectFactory;
-
-final class MyNewComponentFactory extends AbstractComponentPresentationObjectFactory
-{
-}
-',
-            $this->subject->getFactoryContent()
-        );
-    }
-
     public function testGetFusionContent(): void
     {
         Assert::assertSame(

diff --git a/Tests/Unit/Domain/DummyFactoryRendererTest.php b/Tests/Unit/Domain/DummyFactoryRendererTest.php
@@ -0,0 +1,87 @@
+<?php
+
+/*
+ * This file is part of the PackageFactory.AtomicFusion.PresentationObjects package
+ */
+
+declare(strict_types=1);
+
+namespace PackageFactory\AtomicFusion\PresentationObjects\Tests\Unit\Domain;
+
+use Neos\Flow\Tests\UnitTestCase;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\Component;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\ComponentName;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\DummyFactoryRenderer;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\FusionNamespace;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\PackageKey;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\Props;
+use PHPUnit\Framework\Assert;
+
+/**
+ * Test cases for DummyFactoryRenderer
+ */
+class DummyFactoryRendererTest extends UnitTestCase
+{
+    private ?Component $component = null;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $componentName = new ComponentName(
+            new PackageKey('Vendor.Site'),
+            FusionNamespace::default(),
+            'MyNewComponent',
+        );
+        $this->component = new Component(
+            $componentName,
+            Props::fromInputArray(
+                $componentName,
+                [
+                    'bool:bool',
+                    'nullableBool:?bool',
+                    'float:float',
+                    'nullableFloat:?float',
+                    'int:int',
+                    'nullableInt:?int',
+                    'string:string',
+                    'nullableString:?string',
+                    'uri:Uri',
+                    'nullableUri:?Uri',
+                    'image:ImageSource',
+                    'nullableImage:?ImageSource',
+                    'subComponent:MyComponent',
+                    'nullableSubComponent:?MyComponent',
+                    'componentArray:array<MyComponent>',
+                    'enum:MyStringEnum',
+                    'nullableEnum:?MyStringEnum',
+                    'slot:slot',
+                    'nullableSlot:?slot',
+                ]
+            )
+        );
+    }
+
+    public function testGetFactoryContent(): void
+    {
+        Assert::assertSame(
+            '<?php
+
+/*
+ * This file is part of the Vendor.Site package.
+ */
+
+declare(strict_types=1);
+
+namespace Vendor\Site\Presentation\Component\MyNewComponent;
+
+use PackageFactory\AtomicFusion\PresentationObjects\Fusion\AbstractComponentPresentationObjectFactory;
+
+final class MyNewComponentFactory extends AbstractComponentPresentationObjectFactory
+{
+}
+',
+            (new DummyFactoryRenderer())->renderFactoryContent($this->component)
+        );
+    }
+}