TASK: Restructure codebase

mhsdesign · mhsdesign · commit d11d51341cde · 2023-06-07T11:31:31.000+02:00
diff --git a/Classes/Application/Command/NodeTemplateCommandController.php b/Classes/Application/Command/NodeTemplateCommandController.php
@@ -4,7 +4,7 @@
 
 namespace Flowpack\NodeTemplates\Application\Command;
 
-use Flowpack\NodeTemplates\Infrastructure\NodeTemplateDumper\NodeTemplateDumper;
+use Flowpack\NodeTemplates\Domain\NodeTemplateDumper\NodeTemplateDumper;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Cli\CommandController;
 use Neos\Neos\Domain\Service\ContentContextFactory;
diff --git a/Classes/Domain/DelegatingDocumentTitleNodeCreationHandler.php b/Classes/Domain/DelegatingDocumentTitleNodeCreationHandler.php
@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Flowpack\NodeTemplates\Application\NodeCreationHandler;
+namespace Flowpack\NodeTemplates\Domain;
 
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\Flow\Annotations as Flow;
@@ -15,13 +15,13 @@
  *
  * @todo once we have sorting with https://github.com/neos/neos-ui/pull/3511 we can put our handler at the end instead.
  */
-class TemplatingDocumentTitleNodeCreationHandler implements NodeCreationHandlerInterface
+class DelegatingDocumentTitleNodeCreationHandler implements NodeCreationHandlerInterface
 {
     /**
      * @Flow\Inject
      * @var DocumentTitleNodeCreationHandler
      */
-    protected $augmentedDocumentTitleNodeCreationHandler;
+    protected $originalDocumentTitleNodeCreationHandler;
 
     /**
      * @throws \Neos\Eel\Exception
@@ -34,7 +34,7 @@ public function handle(NodeInterface $node, array $data): void
             !$template
             || !isset($template['properties']['uriPathSegment'])
         ) {
-            $this->augmentedDocumentTitleNodeCreationHandler->handle($node, $data);
+            $this->originalDocumentTitleNodeCreationHandler->handle($node, $data);
             return;
         }
 
diff --git a/Classes/Domain/ExceptionHandling/CaughtException.php b/Classes/Domain/ExceptionHandling/CaughtException.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Flowpack\NodeTemplates\Domain;
+namespace Flowpack\NodeTemplates\Domain\ExceptionHandling;
 
 
 use Neos\Flow\Annotations as Flow;
diff --git a/Classes/Domain/ExceptionHandling/CaughtExceptions.php b/Classes/Domain/ExceptionHandling/CaughtExceptions.php
@@ -1,7 +1,8 @@
 <?php
 
-namespace Flowpack\NodeTemplates\Domain;
+namespace Flowpack\NodeTemplates\Domain\ExceptionHandling;
 
+use Flowpack\NodeTemplates\Domain\ExceptionHandling\CaughtException;
 use Neos\Flow\Annotations as Flow;
 
 /** @Flow\Proxy(false) */
diff --git a/Classes/Domain/ExceptionHandling/ExceptionHandlingStrategy.php b/Classes/Domain/ExceptionHandling/ExceptionHandlingStrategy.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Flowpack\NodeTemplates\Domain;
+namespace Flowpack\NodeTemplates\Domain\ExceptionHandling;
 
 use Neos\Flow\Annotations as Flow;
 
diff --git a/Classes/Domain/ExceptionHandling/TemplatePartiallyAppliedException.php b/Classes/Domain/ExceptionHandling/TemplatePartiallyAppliedException.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Flowpack\NodeTemplates\Domain;
+namespace Flowpack\NodeTemplates\Domain\ExceptionHandling;
 
 class TemplatePartiallyAppliedException extends \RuntimeException
 {
diff --git a/Classes/Domain/NodeCreation/NodeCreationService.php b/Classes/Domain/NodeCreation/NodeCreationService.php
@@ -1,20 +1,20 @@
 <?php
 
-namespace Flowpack\NodeTemplates\Infrastructure\ContentRepository;
+namespace Flowpack\NodeTemplates\Domain\NodeCreation;
 
-use Flowpack\NodeTemplates\Domain\CaughtException;
-use Flowpack\NodeTemplates\Domain\CaughtExceptions;
-use Flowpack\NodeTemplates\Domain\RootTemplate;
-use Flowpack\NodeTemplates\Domain\Template;
-use Flowpack\NodeTemplates\Domain\Templates;
+use Flowpack\NodeTemplates\Domain\ExceptionHandling\CaughtException;
+use Flowpack\NodeTemplates\Domain\ExceptionHandling\CaughtExceptions;
+use Flowpack\NodeTemplates\Domain\Template\RootTemplate;
+use Flowpack\NodeTemplates\Domain\Template\Template;
+use Flowpack\NodeTemplates\Domain\Template\Templates;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\ContentRepository\Domain\Service\NodeTypeManager;
 use Neos\ContentRepository\Exception\NodeConstraintException;
 use Neos\Flow\Annotations as Flow;
 use Neos\Neos\Service\NodeOperations;
 use Neos\Neos\Utility\NodeUriPathSegmentGenerator;
 
-class ContentRepositoryTemplateHandler
+class NodeCreationService
 {
     /**
      * @var NodeOperations
diff --git a/Classes/Domain/NodeCreation/PropertiesAndReferences.php b/Classes/Domain/NodeCreation/PropertiesAndReferences.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace Flowpack\NodeTemplates\Infrastructure\ContentRepository;
+namespace Flowpack\NodeTemplates\Domain\NodeCreation;
 
-use Flowpack\NodeTemplates\Domain\CaughtException;
-use Flowpack\NodeTemplates\Domain\CaughtExceptions;
+use Flowpack\NodeTemplates\Domain\ExceptionHandling\CaughtException;
+use Flowpack\NodeTemplates\Domain\ExceptionHandling\CaughtExceptions;
 use Neos\ContentRepository\Domain\Model\NodeType;
 use Neos\ContentRepository\Domain\Service\Context;
 use Neos\Flow\Annotations as Flow;
diff --git a/Classes/Domain/NodeCreation/PropertyIgnoredException.php b/Classes/Domain/NodeCreation/PropertyIgnoredException.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Flowpack\NodeTemplates\Infrastructure\ContentRepository;
+namespace Flowpack\NodeTemplates\Domain\NodeCreation;
 
 class PropertyIgnoredException extends \RuntimeException
 {
diff --git a/Classes/Domain/NodeCreation/PropertyType.php b/Classes/Domain/NodeCreation/PropertyType.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Flowpack\NodeTemplates\Infrastructure\ContentRepository;
+namespace Flowpack\NodeTemplates\Domain\NodeCreation;
 
 use GuzzleHttp\Psr7\Uri;
 use Neos\ContentRepository\Domain\Model\NodeType;
diff --git a/Classes/Domain/NodeCreation/ReferenceType.php b/Classes/Domain/NodeCreation/ReferenceType.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Flowpack\NodeTemplates\Infrastructure\ContentRepository;
+namespace Flowpack\NodeTemplates\Domain\NodeCreation;
 
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\ContentRepository\Domain\Model\NodeType;
@@ -73,7 +73,7 @@ public function getValue(): string
         return $this->value;
     }
 
-    public function isMatchedBy($propertyValue, Context $subgraph): bool
+    public function isMatchedBy($propertyValue, Context $subgraphForResolving): bool
     {
         if ($propertyValue === null) {
             return true;
@@ -86,7 +86,7 @@ public function isMatchedBy($propertyValue, Context $subgraph): bool
             if ($singleNodeAggregateOrId instanceof NodeInterface) {
                 continue;
             }
-            if (is_string($singleNodeAggregateOrId) && $subgraph->getNodeByIdentifier($singleNodeAggregateOrId) instanceof NodeInterface) {
+            if (is_string($singleNodeAggregateOrId) && $subgraphForResolving->getNodeByIdentifier($singleNodeAggregateOrId) instanceof NodeInterface) {
                 continue;
             }
             return false;
diff --git a/Classes/Domain/NodeTemplateDumper/Comment.php b/Classes/Domain/NodeTemplateDumper/Comment.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Flowpack\NodeTemplates\Infrastructure\NodeTemplateDumper;
+namespace Flowpack\NodeTemplates\Domain\NodeTemplateDumper;
 
 use Neos\Flow\Annotations as Flow;
 
diff --git a/Classes/Domain/NodeTemplateDumper/Comments.php b/Classes/Domain/NodeTemplateDumper/Comments.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Flowpack\NodeTemplates\Infrastructure\NodeTemplateDumper;
+namespace Flowpack\NodeTemplates\Domain\NodeTemplateDumper;
 
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Utility\Algorithms;
diff --git a/Classes/Domain/NodeTemplateDumper/NodeTemplateDumper.php b/Classes/Domain/NodeTemplateDumper/NodeTemplateDumper.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Flowpack\NodeTemplates\Infrastructure\NodeTemplateDumper;
+namespace Flowpack\NodeTemplates\Domain\NodeTemplateDumper;
 
 use Neos\ContentRepository\Domain\Model\ArrayPropertyCollection;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
diff --git a/Classes/Domain/Template/RootTemplate.php b/Classes/Domain/Template/RootTemplate.php
@@ -1,8 +1,10 @@
 <?php
 declare(strict_types=1);
 
-namespace Flowpack\NodeTemplates\Domain;
+namespace Flowpack\NodeTemplates\Domain\Template;
 
+use Flowpack\NodeTemplates\Domain\Template\Template;
+use Flowpack\NodeTemplates\Domain\Template\Templates;
 use Neos\Flow\Annotations as Flow;
 
 /**
diff --git a/Classes/Domain/Template/Template.php b/Classes/Domain/Template/Template.php
@@ -1,8 +1,9 @@
 <?php
 declare(strict_types=1);
 
-namespace Flowpack\NodeTemplates\Domain;
+namespace Flowpack\NodeTemplates\Domain\Template;
 
+use Flowpack\NodeTemplates\Domain\Template\Templates;
 use Neos\ContentRepository\Domain\NodeType\NodeTypeName;
 use Neos\ContentRepository\Domain\NodeAggregate\NodeName;
 use Neos\Flow\Annotations as Flow;
diff --git a/Classes/Domain/Template/Templates.php b/Classes/Domain/Template/Templates.php
@@ -1,7 +1,9 @@
 <?php
 
-namespace Flowpack\NodeTemplates\Domain;
+namespace Flowpack\NodeTemplates\Domain\Template;
 
+use Flowpack\NodeTemplates\Domain\Template\RootTemplate;
+use Flowpack\NodeTemplates\Domain\Template\Template;
 use Neos\Flow\Annotations as Flow;
 
 /** @Flow\Proxy(false) */
diff --git a/Classes/Domain/TemplateConfiguration/EelEvaluationService.php b/Classes/Domain/TemplateConfiguration/EelEvaluationService.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Flowpack\NodeTemplates\Infrastructure;
+namespace Flowpack\NodeTemplates\Domain\TemplateConfiguration;
 
 use Neos\Eel\CompilingEvaluator;
 use Neos\Eel\ParserException;
diff --git a/Classes/Domain/TemplateConfiguration/StopBuildingTemplatePartException.php b/Classes/Domain/TemplateConfiguration/StopBuildingTemplatePartException.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Flowpack\NodeTemplates\Domain\TemplateConfiguration;
+
+/** @internal implementation detail of {@see TemplateConfigurationProcessor} */
+class StopBuildingTemplatePartException extends \RuntimeException
+{
+}
diff --git a/Classes/Domain/TemplateConfiguration/TemplateConfigurationProcessor.php b/Classes/Domain/TemplateConfiguration/TemplateConfigurationProcessor.php
@@ -1,21 +1,21 @@
 <?php
 
-namespace Flowpack\NodeTemplates\Domain\TemplateFactory;
+namespace Flowpack\NodeTemplates\Domain\TemplateConfiguration;
 
-use Flowpack\NodeTemplates\Domain\CaughtException;
-use Flowpack\NodeTemplates\Domain\CaughtExceptions;
-use Flowpack\NodeTemplates\Domain\RootTemplate;
-use Flowpack\NodeTemplates\Domain\Template;
-use Flowpack\NodeTemplates\Domain\Templates;
-use Flowpack\NodeTemplates\Infrastructure\EelEvaluationService;
+use Flowpack\NodeTemplates\Domain\ExceptionHandling\CaughtException;
+use Flowpack\NodeTemplates\Domain\ExceptionHandling\CaughtExceptions;
+use Flowpack\NodeTemplates\Domain\Template\RootTemplate;
+use Flowpack\NodeTemplates\Domain\Template\Template;
+use Flowpack\NodeTemplates\Domain\Template\Templates;
+use Flowpack\NodeTemplates\Domain\TemplateConfiguration\EelEvaluationService;
 use Neos\ContentRepository\Domain\NodeAggregate\NodeName;
 use Neos\ContentRepository\Domain\NodeType\NodeTypeName;
 use Neos\Flow\Annotations as Flow;
 
 /**
  * @Flow\Scope("singleton")
  */
-class TemplateFactory
+class TemplateConfigurationProcessor
 {
     /**
      * @Flow\Inject
@@ -29,53 +29,53 @@ class TemplateFactory
      * @param CaughtExceptions $caughtEvaluationExceptions
      * @return RootTemplate
      */
-    public function createFromTemplateConfiguration(array $configuration, array $evaluationContext, CaughtExceptions $caughtEvaluationExceptions): RootTemplate
+    public function processTemplateConfiguration(array $configuration, array $evaluationContext, CaughtExceptions $caughtEvaluationExceptions): RootTemplate
     {
-        $builder = TemplateBuilder::createForRoot(
+        $templatePart = TemplatePart::createRoot(
             $configuration,
             $evaluationContext,
             fn ($value, $evaluationContext) => $this->preprocessConfigurationValue($value, $evaluationContext),
             $caughtEvaluationExceptions
         );
-        return $this->createTemplatesFromBuilder($builder)->toRootTemplate();
+        return $this->createTemplatesFromTemplatePart($templatePart)->toRootTemplate();
     }
 
-    private function createTemplatesFromBuilder(TemplateBuilder $builder): Templates
+    private function createTemplatesFromTemplatePart(TemplatePart $templatePart): Templates
     {
         try {
             $withContext = [];
-            foreach ($builder->getRawConfiguration('withContext') ?? [] as $key => $_) {
-                $withContext[$key] = $builder->processConfiguration(['withContext', $key]);
+            foreach ($templatePart->getRawConfiguration('withContext') ?? [] as $key => $_) {
+                $withContext[$key] = $templatePart->processConfiguration(['withContext', $key]);
             }
-            $builder = $builder->withMergedEvaluationContext($withContext);
+            $templatePart = $templatePart->withMergedEvaluationContext($withContext);
 
-            if ($builder->hasConfiguration('when') && !$builder->processConfiguration('when')) {
+            if ($templatePart->hasConfiguration('when') && !$templatePart->processConfiguration('when')) {
                 return Templates::empty();
             }
 
-            if (!$builder->hasConfiguration('withItems')) {
-                return new Templates($this->createTemplateFromBuilder($builder));
+            if (!$templatePart->hasConfiguration('withItems')) {
+                return new Templates($this->createTemplateFromTemplatePart($templatePart));
             }
-            $items = $builder->processConfiguration('withItems');
+            $items = $templatePart->processConfiguration('withItems');
 
             if (!is_iterable($items)) {
-                $builder->getCaughtExceptions()->add(
+                $templatePart->getCaughtExceptions()->add(
                     CaughtException::fromException(
                         new \RuntimeException(sprintf('Type %s is not iterable.', gettype($items)), 1685802354186)
-                    )->withOrigin(sprintf('Configuration "%s" in "%s"', json_encode($builder->getRawConfiguration('withItems')), join('.', array_merge($builder->getFullPathToConfiguration(), ['withItems']))))
+                    )->withOrigin(sprintf('Configuration "%s" in "%s"', json_encode($templatePart->getRawConfiguration('withItems')), join('.', array_merge($templatePart->getFullPathToConfiguration(), ['withItems']))))
                 );
                 return Templates::empty();
             }
 
             $templates = Templates::empty();
             foreach ($items as $itemKey => $itemValue) {
-                $itemBuilder = $builder->withMergedEvaluationContext([
+                $itemTemplatePart = $templatePart->withMergedEvaluationContext([
                     'item' => $itemValue,
                     'key' => $itemKey
                 ]);
 
                 try {
-                    $templates = $templates->withAdded($this->createTemplateFromBuilder($itemBuilder));
+                    $templates = $templates->withAdded($this->createTemplateFromTemplatePart($itemTemplatePart));
                 } catch (StopBuildingTemplatePartException $e) {
                 }
             }
@@ -85,33 +85,33 @@ private function createTemplatesFromBuilder(TemplateBuilder $builder): Templates
         }
     }
 
-    private function createTemplateFromBuilder(TemplateBuilder $builder): Template
+    private function createTemplateFromTemplatePart(TemplatePart $templatePart): Template
     {
         // process the properties
         $processedProperties = [];
-        foreach ($builder->getRawConfiguration('properties') ?? [] as $propertyName => $value) {
+        foreach ($templatePart->getRawConfiguration('properties') ?? [] as $propertyName => $value) {
             if (!is_scalar($value) && !is_null($value)) {
                 throw new \InvalidArgumentException(sprintf('Template configuration properties can only hold int|float|string|bool|null. Property "%s" has type "%s"', $propertyName, gettype($value)), 1685725310730);
             }
             try {
-                $processedProperties[$propertyName] = $builder->processConfiguration(['properties', $propertyName]);
+                $processedProperties[$propertyName] = $templatePart->processConfiguration(['properties', $propertyName]);
             } catch (StopBuildingTemplatePartException $e) {
             }
         }
 
         // process the childNodes
         $childNodeTemplates = Templates::empty();
-        foreach ($builder->getRawConfiguration('childNodes') ?? [] as $childNodeConfigurationPath => $_) {
-            $childNodeBuilder = $builder->withConfigurationByConfigurationPath(['childNodes', $childNodeConfigurationPath]);
-            $childNodeTemplates = $childNodeTemplates->merge($this->createTemplatesFromBuilder($childNodeBuilder));
+        foreach ($templatePart->getRawConfiguration('childNodes') ?? [] as $childNodeConfigurationPath => $_) {
+            $childNodeTemplatePart = $templatePart->withConfigurationByConfigurationPath(['childNodes', $childNodeConfigurationPath]);
+            $childNodeTemplates = $childNodeTemplates->merge($this->createTemplatesFromTemplatePart($childNodeTemplatePart));
         }
 
-        $type = $builder->processConfiguration('type');
-        $name = $builder->processConfiguration('name');
+        $type = $templatePart->processConfiguration('type');
+        $name = $templatePart->processConfiguration('name');
         return new Template(
             $type ? NodeTypeName::fromString($type) : null,
             $name ? NodeName::fromString($name) : null,
-            $builder->hasConfiguration('disabled') ? (bool)$builder->processConfiguration('disabled') : null,
+            $templatePart->hasConfiguration('disabled') ? (bool)$templatePart->processConfiguration('disabled') : null,
             $processedProperties,
             $childNodeTemplates
         );
diff --git a/Classes/Domain/TemplateConfiguration/TemplatePart.php b/Classes/Domain/TemplateConfiguration/TemplatePart.php
diff --git a/Classes/Domain/TemplateFactory/StopBuildingTemplatePartException.php b/Classes/Domain/TemplateFactory/StopBuildingTemplatePartException.php
diff --git a/Classes/Domain/TemplateNodeCreationHandler.php b/Classes/Domain/TemplateNodeCreationHandler.php
diff --git a/Configuration/NodeTypes.yaml b/Configuration/NodeTypes.yaml
diff --git a/Tests/Functional/NodeTemplateTest.php b/Tests/Functional/NodeTemplateTest.php
diff --git a/Tests/Unit/Domain/NodeCreation/Fixture/PostalAddress.php b/Tests/Unit/Domain/NodeCreation/Fixture/PostalAddress.php
diff --git a/Tests/Unit/Domain/NodeCreation/PropertyTypeTest.php b/Tests/Unit/Domain/NodeCreation/PropertyTypeTest.php
diff --git a/Tests/Unit/Domain/NodeCreation/ReferenceTypeTest.php b/Tests/Unit/Domain/NodeCreation/ReferenceTypeTest.php

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace Flowpack\NodeTemplates\Domain;`
	`3`	`+namespace Flowpack\NodeTemplates\Domain\ExceptionHandling;`
`4`	`4`
`5`	`5`	`class TemplatePartiallyAppliedException extends \RuntimeException`
`6`	`6`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace Flowpack\NodeTemplates\Infrastructure\ContentRepository;`
	`3`	`+namespace Flowpack\NodeTemplates\Domain\NodeCreation;`
`4`	`4`
`5`	`5`	`class PropertyIgnoredException extends \RuntimeException`
`6`	`6`	`{`