Merge branch 'master' into fixPackageNameResolution

Author: Bernhard Schmitt

Classes/Command/ComponentCommandController.php

@@ -12,6 +12,7 @@
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\Enum\EnumGenerator;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\PackageKey;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\PackageResolver;
+use PackageFactory\AtomicFusion\PresentationObjects\Infrastructure\DefensiveConfirmationFileWriter;
 
 /**
  * The command controller for kick-starting PresentationObject components
@@ -25,16 +26,10 @@ class ComponentCommandController extends CommandController
     protected $packageResolver;
 
     /**
-     * @Flow\Inject
-     * @var ComponentGenerator
-     */
-    protected $componentGenerator;
-
-    /**
-     * @Flow\Inject
-     * @var EnumGenerator
+     * @Flow\InjectConfiguration(path="componentGeneration.colocate")
+     * @var bool
      */
-    protected $valueGenerator;
+    protected $colocate;
 
     /**
      * Create a new PresentationObject component and factory
@@ -50,6 +45,7 @@ class ComponentCommandController extends CommandController
      * The following values are allowed for types:
      *
      * * string, int, float, bool
+     * * slot
      * * Value class names created with <u>component:kickstartvalue</u> in the same
      *   component namespace
      * * Component class names created with <u>component:kickstart</u> in the same
@@ -60,19 +56,24 @@ class ComponentCommandController extends CommandController
      *
      * @param string $name The name of the new component
      * @param bool $listable If set, an additional list type will be generated
+     * @param bool $yes If set, no confirmation is going to be required for overwriting files
      * @return void
      * @throws \Neos\Utility\Exception\FilesException
      */
-    public function kickStartCommand(string $name, bool $listable = false): void
+    public function kickStartCommand(string $name, bool $listable = false, bool $yes = false): void
     {
+        $componentGenerator = new ComponentGenerator(
+            new DefensiveConfirmationFileWriter($this->output, $yes)
+        );
         $package = $this->packageResolver->resolvePackage();
-        $component = ComponentName::fromInput($name, PackageKey::fromPackage($package));
-        $componentPackage = $this->packageResolver->resolvePackage((string)$component->getPackageKey());
+        $componentName = ComponentName::fromInput($name, PackageKey::fromPackage($package));
+        $componentPackage = $this->packageResolver->resolvePackage((string)$componentName->getPackageKey());
 
-        $this->componentGenerator->generateComponent(
-            $component,
+        $componentGenerator->generateComponent(
+            $componentName,
             $this->request->getExceedingArguments(),
             $componentPackage->getPackagePath(),
+            $this->colocate,
             $listable
         );
     }
@@ -92,20 +93,26 @@ public function kickStartCommand(string $name, bool $listable = false): void
      * @param string $name The name of the new pseudo-enum
      * @param string $type The type of the new pseudo-enum (must be one of: "string", "int")
      * @param array|string[] $values A comma-separated colon list of names:values for the new pseudo-enum, e.g. a,b,c , a:1,b:2,c:3 or a:1.2,b:2.4,c:3.6
+     * @param bool $yes If set, no confirmation is going to be required for overwriting files
      * @return void
      */
-    public function kickStartEnumCommand(string $componentName, string $name, string $type, array $values = []): void
+    public function kickStartEnumCommand(string $componentName, string $name, string $type, array $values = [], bool $yes = false): void
     {
+        $enumGenerator = new EnumGenerator(
+            new \DateTimeImmutable(),
+            new DefensiveConfirmationFileWriter($this->output, $yes)
+        );
         $package = $this->packageResolver->resolvePackage();
-        $component = ComponentName::fromInput($componentName, PackageKey::fromPackage($package));
-        $componentPackage = $this->packageResolver->resolvePackage((string)$component->getPackageKey());
+        $componentNameObject = ComponentName::fromInput($componentName, PackageKey::fromPackage($package));
+        $componentPackage = $this->packageResolver->resolvePackage((string)$componentNameObject->getPackageKey());
 
-        $this->valueGenerator->generateEnum(
-            $component,
+        $enumGenerator->generateEnum(
+            $componentNameObject,
             $name,
             $type,
             $values,
-            $componentPackage->getPackagePath()
+            $componentPackage->getPackagePath(),
+            $this->colocate
         );
     }
 }

Classes/Domain/AbstractImmutableArrayObject.php

@@ -7,7 +7,7 @@
 
 /**
  * The abstract class for immutable array objects
- * @template K
+ * @template K of int|string
  * @template V
  * @extends \ArrayObject<K,V>
  */

Classes/Domain/Component/Component.php

@@ -53,7 +53,7 @@ public function isGeneric(): bool
      */
     public function getInterfaceContent(): string
     {
-        return '<?php
+        return '<?php declare(strict_types=1);
 namespace ' . $this->name->getPhpNamespace() . ';
 
 ' . $this->name->renderClassComment() . '
@@ -72,7 +72,7 @@ interface ' . $this->name->getSimpleInterfaceName() . ' extends ComponentPresent
      */
     public function getClassContent(): string
     {
-        return '<?php
+        return '<?php declare(strict_types=1);
 namespace ' . $this->name->getPhpNamespace() . ';
 
 ' . $this->name->renderClassComment() . '
@@ -99,7 +99,7 @@ final class ' . $this->name->getSimpleClassName() . ' extends AbstractComponentP
      */
     public function getFactoryContent(): string
     {
-        return '<?php
+        return '<?php declare(strict_types=1);
 namespace ' . $this->name->getPhpNamespace() . ';
 
 ' . $this->name->renderClassComment() . '
@@ -117,7 +117,7 @@ final class ' . $this->name->getSimpleFactoryName() . ' extends AbstractComponen
      */
     public function getComponentArrayContent(): string
     {
-        return '<?php
+        return '<?php declare(strict_types=1);
 namespace ' . $this->name->getPhpNamespace() . ';
 
 ' . $this->name->renderClassComment() . '

Classes/Domain/Component/ComponentGenerator.php

@@ -6,21 +6,29 @@
  */
 
 use Neos\Flow\Annotations as Flow;
-use Neos\Utility\Files;
+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\Scope("singleton")
+ * @Flow\Proxy(false)
  */
 final class ComponentGenerator
 {
+    private FileWriterInterface $fileWriter;
+
+    public function __construct(FileWriterInterface $fileWriter)
+    {
+        $this->fileWriter = $fileWriter;
+    }
+
     /**
      * @param ComponentName $componentName
      * @param array|string[] $serializedProps
      * @param string $packagePath
+     * @param bool $colocate
      * @param bool $listable
      * @return void
      * @throws \Neos\Utility\Exception\FilesException
@@ -29,25 +37,19 @@ public function generateComponent(
         ComponentName $componentName,
         array $serializedProps,
         string $packagePath,
+        bool $colocate,
         bool $listable = false
     ): void {
         $props = Props::fromInputArray($componentName, $serializedProps);
         $component = new Component($componentName, $props, $listable);
 
-        $classPath = $componentName->getPhpFilePath($packagePath);
-        if (!file_exists($classPath)) {
-            Files::createDirectoryRecursively($classPath);
-        }
-        $fusionPath = $componentName->getFusionFilePath($packagePath);
-        if (!file_exists($fusionPath)) {
-            Files::createDirectoryRecursively($fusionPath);
-        }
-        file_put_contents($componentName->getInterfacePath($packagePath), $component->getInterfaceContent());
-        file_put_contents($componentName->getClassPath($packagePath), $component->getClassContent());
-        file_put_contents($componentName->getFactoryPath($packagePath), $component->getFactoryContent());
-        file_put_contents($componentName->getFusionComponentPath($packagePath), $component->getFusionContent());
+        $this->fileWriter->writeFile($componentName->getInterfacePath($packagePath, $colocate), $component->getInterfaceContent());
+        $this->fileWriter->writeFile($componentName->getClassPath($packagePath, $colocate), $component->getClassContent());
+        $this->fileWriter->writeFile($componentName->getFactoryPath($packagePath, $colocate), $component->getFactoryContent());
+        $this->fileWriter->writeFile($componentName->getFusionComponentPath($packagePath), $component->getFusionContent());
+
         if ($listable) {
-            file_put_contents($componentName->getComponentArrayPath($packagePath), $component->getComponentArrayContent());
+            $this->fileWriter->writeFile($componentName->getComponentArrayPath($packagePath, $colocate), $component->getComponentArrayContent());
         }
         $this->registerFactory($packagePath, $componentName);
     }
@@ -62,7 +64,6 @@ private function registerFactory(string $packagePath, ComponentName $componentNa
         $configurationPath = $packagePath . 'Configuration/';
         $configurationFilePath = $configurationPath . 'Settings.PresentationHelpers.yaml';
         if (!file_exists($configurationFilePath)) {
-            Files::createDirectoryRecursively($configurationPath);
             $configuration = ['Neos' => ['Fusion' => ['defaultContext' => [
                 $componentName->getHelperName() => $componentName->getFullyQualifiedFactoryName()
             ]]]];
@@ -73,6 +74,6 @@ private function registerFactory(string $packagePath, ComponentName $componentNa
         }
 
         $writer = new YamlWriter(2);
-        file_put_contents($configurationFilePath, $writer->dump($configuration, 100));
+        $this->fileWriter->writeFile($configurationFilePath, $writer->dump($configuration, 100));
     }
 }

Classes/Domain/Component/ComponentName.php

@@ -21,8 +21,11 @@ final class ComponentName
 
     private string $name;
 
-    public function __construct(PackageKey $packageKey, FusionNamespace $fusionNamespace, string $name)
-    {
+    public function __construct(
+        PackageKey $packageKey,
+        FusionNamespace $fusionNamespace,
+        string $name
+    ) {
         $this->packageKey = $packageKey;
         $this->fusionNamespace = $fusionNamespace;
         $this->name = $name;
@@ -204,29 +207,31 @@ public function getHelperName(): string
         return $this->packageKey->getSimpleName() . '.' . $this->name;
     }
 
-    public function getPhpFilePath(string $packagePath): string
+    public function getPhpFilePath(string $packagePath, bool $colocate): string
     {
-        return $packagePath . '/Classes/Presentation/' . $this->fusionNamespace->toFilePath() . '/' . $this->name;
+        return $colocate
+            ? $this->getFusionFilePath($packagePath)
+            : $packagePath . '/Classes/Presentation/' . $this->fusionNamespace->toFilePath() . '/' . $this->name;
     }
 
-    public function getInterfacePath(string $packagePath): string
+    public function getInterfacePath(string $packagePath, bool $colocate): string
     {
-        return $this->getPhpFilePath($packagePath) . '/'. $this->name . 'Interface.php';
+        return $this->getPhpFilePath($packagePath, $colocate) . '/'. $this->name . 'Interface.php';
     }
 
-    public function getClassPath(string $packagePath): string
+    public function getClassPath(string $packagePath, bool $colocate): string
     {
-        return $this->getPhpFilePath($packagePath) . '/'. $this->name . '.php';
+        return $this->getPhpFilePath($packagePath, $colocate) . '/'. $this->name . '.php';
     }
 
-    public function getFactoryPath(string $packagePath): string
+    public function getFactoryPath(string $packagePath, bool $colocate): string
     {
-        return $this->getPhpFilePath($packagePath) . '/'. $this->name . 'Factory.php';
+        return $this->getPhpFilePath($packagePath, $colocate) . '/'. $this->name . 'Factory.php';
     }
 
-    public function getComponentArrayPath(string $packagePath): string
+    public function getComponentArrayPath(string $packagePath, bool $colocate): string
     {
-        return $this->getPhpFilePath($packagePath) . '/'. PluralName::forName($this->name) . '.php';
+        return $this->getPhpFilePath($packagePath, $colocate) . '/'. PluralName::forName($this->name) . '.php';
     }
 
     public function getFusionFilePath(string $packagePath): string

Classes/Domain/Component/PropType/ComponentArrayPropType.php

@@ -48,8 +48,8 @@ public function getStyleGuideValue(int $nestingLevel = 0): string
         $componentPropType = new ComponentPropType($this->componentName, false);
         $componentStyleGuideValue = $componentPropType->getStyleGuideValue($nestingLevel + 1);
         return '{
-' . self::innerLeftPad($nestingLevel) . $componentStyleGuideValue . ',
-' . self::innerLeftPad($nestingLevel) . $componentStyleGuideValue . '
+' . self::innerLeftPad($nestingLevel) . '0 ' . $componentStyleGuideValue . '
+' . self::innerLeftPad($nestingLevel) . '1 ' .$componentStyleGuideValue . '
 ' . self::outerLeftPad($nestingLevel) . '}';
     }
 

Classes/Domain/Component/PropType/PropTypeFactory.php

@@ -8,6 +8,7 @@
 use Neos\Flow\Annotations as Flow;
 use GuzzleHttp\Psr7\Uri;
 use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\ComponentName;
+use PackageFactory\AtomicFusion\PresentationObjects\Presentation\Slot\SlotInterface;
 use Psr\Http\Message\UriInterface;
 use Sitegeist\Kaleidoscope\EelHelpers\ImageSourceHelperInterface;
 
@@ -39,6 +40,8 @@ public static function fromInputString(ComponentName $parentComponentName, strin
                 return new UriPropType($nullable);
             case 'ImageSource':
                 return new ImageSourcePropType($nullable);
+            case 'slot':
+                return new SlotPropType($nullable);
             default:
                 if ($isComponentArray = IsComponentArray::isSatisfiedByInputString($input)) {
                     $input = \mb_substr($input, 6, \mb_strlen($input) - 7);
@@ -80,6 +83,8 @@ public static function fromReflectionProperty(\ReflectionProperty $property): Pr
                     return new UriPropType($nullable);
                 case ImageSourceHelperInterface::class:
                     return new ImageSourcePropType($nullable);
+                case SlotInterface::class:
+                    return new SlotPropType($nullable);
                 default:
                     if (IsEnum::isSatisfiedByClassName($type)) {
                         /** @phpstan-var class-string<mixed> $type */

Classes/Domain/Component/PropType/SlotPropType.php

@@ -0,0 +1,54 @@
+<?php declare(strict_types=1);
+namespace PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\PropType;
+
+/*
+ * This file is part of the PackageFactory.AtomicFusion.PresentationObjects package
+ */
+
+use Neos\Flow\Annotations as Flow;
+
+/**
+ * @Flow\Proxy(false)
+ */
+final class SlotPropType implements PropTypeInterface
+{
+    private bool $nullable;
+
+    public function __construct(
+        bool $nullable
+    ) {
+        $this->nullable = $nullable;
+    }
+
+    public function isNullable(): bool
+    {
+        return $this->nullable;
+    }
+
+    public function getSimpleName(): string
+    {
+        return 'slot';
+    }
+
+    public function getUseStatement(): string
+    {
+        return 'use PackageFactory\AtomicFusion\PresentationObjects\Presentation\Slot\SlotInterface;' . PHP_EOL;
+    }
+
+    public function getType(): string
+    {
+        return ($this->nullable ? '?' : '') . 'SlotInterface';
+    }
+
+    public function getStyleGuideValue(int $nestingLevel = 0): string
+    {
+        return '= \'- Add Slot Content -\'';
+    }
+
+    public function getDefinitionData(string $propName): string
+    {
+        return '
+            <PackageFactory.AtomicFusion.PresentationObjects:Slot presentationObject={presentationObject.' . $propName . '} />
+        ';
+    }
+}