TASK: Simplify generation of Specifications

mficzel · mficzel · commit 5ee49f1393bb · 2025-08-08T22:55:39.000+02:00
diff --git a/Classes/Command/NodeObjectsCommandController.php b/Classes/Command/NodeObjectsCommandController.php
@@ -95,13 +95,13 @@ public function buildCommand(string $packageKey, string $crId = 'default'): void
         );
 
         foreach ($nodeTypes as $nodeType) {
-            $interfaceSpecification = NodeInterfaceSpecification::createFromPackageAndNodeType($package, $nodeType);
-            Files::createDirectoryRecursively($interfaceSpecification->directory);
+            $interfaceSpecification = NodeInterfaceSpecification::createFromNodeType($nodeType);
+            Files::createDirectoryRecursively($package->getPackagePath() . DIRECTORY_SEPARATOR . $interfaceSpecification->directory);
             file_put_contents(
-                $interfaceSpecification->interfaceFilename,
+                $package->getPackagePath() . DIRECTORY_SEPARATOR . $interfaceSpecification->interfaceFilename,
                 $interfaceSpecification->toPhpString()
             );
-            $this->outputLine(' - ' . $interfaceSpecification->interfaceName->nodeTypeName . ' -> <info>' . $interfaceSpecification->interfaceName->getFullyQualifiedClassName() . '</info>');
+            $this->outputLine(' - ' . $interfaceSpecification->interfaceName->nodeTypeName . ' -> <info>' . $interfaceSpecification->interfaceFilename . '</info>');
         }
 
         // loop 2 build objects for all non abstract nodetypes in package
@@ -115,13 +115,13 @@ public function buildCommand(string $packageKey, string $crId = 'default'): void
         );
 
         foreach ($nonAbstractNodeTypes as $nodeType) {
-            $objectSpecification = NodeObjectSpecification::createFromPackageAndNodeType($package, $nodeType);
-            Files::createDirectoryRecursively($objectSpecification->directory);
+            $objectSpecification = NodeObjectSpecification::createFromNodeType($nodeType);
+            Files::createDirectoryRecursively($package->getPackagePath() . DIRECTORY_SEPARATOR . $objectSpecification->directory);
             file_put_contents(
-                $objectSpecification->classFilename,
+                $package->getPackagePath() . DIRECTORY_SEPARATOR . $objectSpecification->classFilename,
                 $objectSpecification->toPhpString()
             );
-            $this->outputLine(' - ' . $objectSpecification->objectName->nodeTypeName . ' -> <info>' . $objectSpecification->objectName->getFullyQualifiedClassName() . '</info>');
+            $this->outputLine(' - ' . $objectSpecification->objectName->nodeTypeName . ' -> <info>' . $objectSpecification->classFilename . '</info>');
         }
     }
 
@@ -147,29 +147,29 @@ protected function getPackage(string $packageKey): FlowPackageInterface & Generi
             $this->quit(1);
         }
 
-        /**
-         * @var array<int, array{namespace:string, classPath:string, mappingType:string}> $autoloadConfigurations
-         */
-        $autoloadConfigurations = $package->getFlattenedAutoloadConfiguration();
-        $namespace = null;
-        foreach ($autoloadConfigurations as $autoloadConfiguration) {
-            if (
-                $autoloadConfiguration[ 'mappingType' ] === 'psr-4'
-                && str_ends_with($autoloadConfiguration[ 'namespace' ], '\\NodeTypes\\')
-                && (
-                    $autoloadConfiguration[ 'classPath' ] === $package->getPackagePath() . 'NodeTypes'
-                    || $autoloadConfiguration[ 'classPath' ] === $package->getPackagePath() . 'NodeTypes/'
-                )
-            ) {
-                $namespace = $autoloadConfiguration[ 'namespace' ];
-                break;
-            }
-        }
-
-        if ($namespace === null) {
-            $this->outputLine('<error>No PSR4-NodeTypes namespace for the NodeTypes folder is registered via composer</error>');
-            $this->quit(1);
-        }
+//        /**
+//         * @var array<int, array{namespace:string, classPath:string, mappingType:string}> $autoloadConfigurations
+//         */
+//        $autoloadConfigurations = $package->getFlattenedAutoloadConfiguration();
+//        $namespace = null;
+//        foreach ($autoloadConfigurations as $autoloadConfiguration) {
+//            if (
+//                $autoloadConfiguration[ 'mappingType' ] === 'psr-4'
+//                && str_ends_with($autoloadConfiguration[ 'namespace' ], '\\NodeTypes\\')
+//                && (
+//                    $autoloadConfiguration[ 'classPath' ] === $package->getPackagePath() . 'NodeTypes'
+//                    || $autoloadConfiguration[ 'classPath' ] === $package->getPackagePath() . 'NodeTypes/'
+//                )
+//            ) {
+//                $namespace = $autoloadConfiguration[ 'namespace' ];
+//                break;
+//            }
+//        }
+//
+//        if ($namespace === null) {
+//            $this->outputLine('<error>No PSR4-NodeTypes namespace for the NodeTypes folder is registered via composer</error>');
+//            $this->quit(1);
+//        }
         return $package;
     }
 }
diff --git a/Classes/Domain/NodeInterfaceNameSpecification.php b/Classes/Domain/NodeInterfaceNameSpecification.php
@@ -13,32 +13,34 @@
 {
     public function __construct(
         public string $nodeTypeName,
-        public string $phpNamespace,
-        public string $interfaceName
+        public string $packageNamespace,
+        public string $localNamespace,
+        public string $interfaceName,
     ) {
     }
 
+    public function getFullNamespace(): string
+    {
+        return $this->packageNamespace . '\\' . $this->localNamespace;
+    }
+
     public function getFullyQualifiedClassName(): string
     {
-        return $this->phpNamespace . '\\' . $this->interfaceName;
+        return $this->packageNamespace . '\\' . $this->localNamespace . '\\' . $this->interfaceName;
     }
 
     public static function createFromNodeTypeName(
         NodeTypeName $nodeTypeName
     ): self {
-
         list($packageKey, $nodeName) = explode(':', $nodeTypeName->value, 2);
-
+        $packageKeyParts = explode('.', $packageKey);
         $localNameParts = explode('.', $nodeName);
-        $localName = array_pop($localNameParts);
-
-        $phpNamespace = str_replace(['.', ':'], ['\\', '\\NodeTypes\\'], $nodeTypeName->value);
-        $interfaceName = str_replace('.', '\\', $localName) . 'NodeInterface';
-
+        $localName = $localNameParts[array_key_last($localNameParts)];
         return new self(
             $nodeTypeName->value,
-            $phpNamespace,
-            $interfaceName
+            PhpNameHelper::sanitize(implode('\\', $packageKeyParts)),
+            'NodeTypes\\' . PhpNameHelper::sanitize(implode('\\', $localNameParts)),
+            PhpNameHelper::sanitize(str_replace('.', '\\', $localName)) . 'NodeInterface'
         );
     }
 
diff --git a/Classes/Domain/NodeInterfaceNameSpecificationCollection.php b/Classes/Domain/NodeInterfaceNameSpecificationCollection.php
@@ -35,10 +35,16 @@ public static function createFromNodeType(NodeType $nodeType, bool $checkForExis
         $interfaces = [
             NodeInterfaceNameSpecification::createFromNodeType($nodeType)
         ];
-        foreach ($nodeType->getDeclaredSuperTypes() as $superType) {
+
+        if ($nodeType->name->value === 'Vendor.Site:Content.Text') {
+            var_dump(array_keys(self::getFlattenedSuperTypes($nodeType)));
+        }
+        foreach (self::getFlattenedSuperTypes($nodeType) as $superType) {
             $interface = NodeInterfaceNameSpecification::createFromNodeType($superType);
-            if ($checkForExistence && interface_exists($interface->getFullyQualifiedClassName())) {
-                $interfaces[] = $interface;
+            if ($checkForExistence) {
+                if (interface_exists($interface->getFullyQualifiedClassName(), true)) {
+                    $interfaces[] = $interface;
+                }
             } else {
                 $interfaces[] = $interface;
             }
@@ -54,4 +60,20 @@ public function asImplementsStatement(): string
             return 'implements ' . implode(', ', array_map(fn(NodeInterfaceNameSpecification $item)=> $item->getFullyQualifiedClassName(), $this->items));
         }
     }
+
+    /**
+     * Returns a flat list of super types to inherit from.
+     *
+     * @return array<string,NodeType>
+     */
+    protected static function getFlattenedSuperTypes(NodeType $nodeType): array
+    {
+        $flattenedSuperTypes = [];
+        foreach ($nodeType->getDeclaredSuperTypes() as $superTypeName => $superType) {
+            $flattenedSuperTypes += static::getFlattenedSuperTypes($superType);
+            $flattenedSuperTypes[$superTypeName] = $superType;
+        }
+
+        return $flattenedSuperTypes;
+    }
 }
diff --git a/Classes/Domain/NodeInterfaceSpecification.php b/Classes/Domain/NodeInterfaceSpecification.php
@@ -13,38 +13,22 @@
 {
     public function __construct(
         public NodeInterfaceNameSpecification $interfaceName,
-        public NodeInterfaceNameSpecificationCollection $interfaceNames,
         public NodePropertySpecificationCollection $properties,
         public string $directory,
         public string $interfaceFilename,
     ) {
     }
 
-    public static function createFromPackageAndNodeType(
-        FlowPackageInterface $package,
+    public static function createFromNodeType(
         NodeType $nodeType,
     ): self {
-
-        if (!str_starts_with($nodeType->name->value, $package->getPackageKey() . ':')) {
-            throw new \Exception("Only nodetypes from the given package are allowed");
-        }
-
         $nameSpecification = NodeInterfaceNameSpecification::createFromNodeType($nodeType);
 
-        $localNameParts = explode('.', str_replace($package->getPackageKey() . ':', '', $nodeType->name->value));
-        $localName = array_pop($localNameParts);
-        $localNamespace = implode('.', $localNameParts);
-
-        $directory = $package->getPackagePath()
-            . 'NodeTypes' . DIRECTORY_SEPARATOR
-            . ($localNamespace ? str_replace('.', DIRECTORY_SEPARATOR, $localNamespace) . DIRECTORY_SEPARATOR : '')
-            . $localName;
-
+        $directory = str_replace('\\', DIRECTORY_SEPARATOR, $nameSpecification->localNamespace);
         $interfaceFileName =  $directory . DIRECTORY_SEPARATOR . $nameSpecification->interfaceName . '.php';
 
         return new self(
             $nameSpecification,
-            NodeInterfaceNameSpecificationCollection::createFromNodeType($nodeType),
             NodePropertySpecificationCollection::createFromNodeType($nodeType),
             $directory,
             $interfaceFileName
@@ -71,7 +55,7 @@ public function toPhpString(): ?string
 
         declare(strict_types=1);
 
-        namespace {$this->interfaceName->phpNamespace};
+        namespace {$this->interfaceName->getFullNamespace()};
 
         use Neos\ContentRepository\Domain\Model\NodeInterface;
         use Neos\Flow\Annotations as Flow;
diff --git a/Classes/Domain/NodeObjectNameSpecification.php b/Classes/Domain/NodeObjectNameSpecification.php
@@ -13,32 +13,34 @@
 {
     public function __construct(
         public string $nodeTypeName,
-        public string $phpNamespace,
+        public string $packageNamespace,
+        public string $localNamespace,
         public string $className,
     ) {
     }
 
+    public function getFullNamespace(): string
+    {
+        return $this->packageNamespace . '\\' . $this->localNamespace;
+    }
+
     public function getFullyQualifiedClassName(): string
     {
-        return $this->phpNamespace . '\\' . $this->className;
+        return $this->packageNamespace . '\\' . $this->localNamespace . '\\' . $this->className;
     }
 
     public static function createFromNodeTypeName(
         NodeTypeName $nodeTypeName
     ): self {
-
         list($packageKey, $nodeName) = explode(':', $nodeTypeName->value, 2);
-
+        $packageKeyParts = explode('.', $packageKey);
         $localNameParts = explode('.', $nodeName);
-        $localName = array_pop($localNameParts);
-
-        $phpNamespace = str_replace(['.', ':'], ['\\', '\\NodeTypes\\'], $nodeTypeName->value);
-        $className = str_replace('.', '\\', $localName) . 'NodeObject';
-
+        $localName = $localNameParts[array_key_last($localNameParts)];
         return new self(
             $nodeTypeName->value,
-            $phpNamespace,
-            $className,
+            PhpNameHelper::sanitize(implode('\\', $packageKeyParts)),
+            'NodeTypes\\' . PhpNameHelper::sanitize(implode('\\', $localNameParts)),
+            PhpNameHelper::sanitize(str_replace('.', '\\', $localName)) . 'NodeObject'
         );
     }
 
diff --git a/Classes/Domain/NodeObjectSpecification.php b/Classes/Domain/NodeObjectSpecification.php
@@ -20,26 +20,12 @@ public function __construct(
     ) {
     }
 
-    public static function createFromPackageAndNodeType(
-        FlowPackageInterface $package,
+    public static function createFromNodeType(
         NodeType $nodeType,
     ): self {
-
-        if (!str_starts_with($nodeType->name->value, $package->getPackageKey() . ':')) {
-            throw new \Exception("Only nodetypes from the given package are allowed");
-        }
-
         $nameSpecification = NodeObjectNameSpecification::createFromNodeType($nodeType);
 
-        $localNameParts = explode('.', str_replace($package->getPackageKey() . ':', '', $nodeType->name->value));
-        $localName = array_pop($localNameParts);
-        $localNamespace = implode('.', $localNameParts);
-
-        $directory = $package->getPackagePath()
-            . 'NodeTypes' . DIRECTORY_SEPARATOR
-            . ($localNamespace ? str_replace('.', DIRECTORY_SEPARATOR, $localNamespace) . DIRECTORY_SEPARATOR : '')
-            . $localName;
-
+        $directory = str_replace('\\', DIRECTORY_SEPARATOR, $nameSpecification->localNamespace);
         $classFilename = $directory . DIRECTORY_SEPARATOR . $nameSpecification->className . '.php';
 
         return new self(
@@ -72,7 +58,7 @@ public function toPhpString(): string
 
         declare(strict_types=1);
 
-        namespace {$this->objectName->phpNamespace};
+        namespace {$this->objectName->getFullNamespace()};
 
         use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
         use Neos\Flow\Annotations as Flow;
diff --git a/Classes/Domain/PhpNameHelper.php b/Classes/Domain/PhpNameHelper.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace PackageFactory\NodeTypeObjects\Domain;
+
+use Neos\ContentRepository\Core\NodeType\NodeTypeName;
+
+class PhpNameHelper
+{
+    public static function sanitize(string $name): string
+    {
+        // pure number segments are prefixed by a number
+        /**
+         * @var string $name
+         */
+        $name = preg_replace('/(^|\\\\)([0-9]+)(\\\\|$)/us', '$1_$2$3', $name);
+        return $name;
+    }
+}
diff --git a/Tests/Unit/NodeInterfaceNameSpecificationTest.php b/Tests/Unit/NodeInterfaceNameSpecificationTest.php
@@ -11,11 +11,31 @@
 
 class NodeInterfaceNameSpecificationTest extends TestCase
 {
-    #[Test]
-    public function detectionOfNamesFromNodeType(): void
+    public static function detectionOfNamesFromNodeTypeDataProvider(): \Generator
+    {
+        yield [
+                'Vendor.Example:Foo.Bar',
+                'Vendor\Example',
+                'NodeTypes\Foo\Bar',
+                'BarNodeInterface'
+        ];
+
+        yield [
+            '404:404',
+            '_404',
+            'NodeTypes\_404',
+            '_404NodeInterface'
+        ];
+    }
+
+    /**
+     * @test
+     * @dataProvider detectionOfNamesFromNodeTypeDataProvider
+     */
+    public function detectionOfNamesFromNodeType(string $nodeTypeName, string $expectedPackageNamespace, string $expectedLocalNamespace,string $expectedInterface ): void
     {
         $nodeType = new NodeType(
-            NodeTypeName::fromString('Vendor.Example:Foo.Bar'),
+            NodeTypeName::fromString($nodeTypeName),
             [],
             []
         );
@@ -26,9 +46,10 @@ public function detectionOfNamesFromNodeType(): void
 
         $this->assertEquals(
             new NodeInterfaceNameSpecification(
-                'Vendor.Example:Foo.Bar',
-                'Vendor\Example\NodeTypes\Foo\Bar',
-                'BarNodeInterface',
+                $nodeTypeName,
+                $expectedPackageNamespace,
+                $expectedLocalNamespace,
+                $expectedInterface,
             ),
             $specification
         );
diff --git a/Tests/Unit/NodeObjectNameSpecificationTest.php b/Tests/Unit/NodeObjectNameSpecificationTest.php
