Skip to content

Commit 80e1916

Browse files
mficzelmficzel
committed
TASK: Simplify generation of Specifications
1 parent 5162d1f commit 80e1916

9 files changed

+160
-100
lines changed

‎Classes/Command/NodeObjectsCommandController.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,10 @@ public function buildCommand(string $packageKey, string $crId = 'default'): void
9595
);
9696

9797
foreach ($nodeTypes as $nodeType) {
98-
$interfaceSpecification = NodeInterfaceSpecification::createFromPackageAndNodeType($package, $nodeType);
99-
Files::createDirectoryRecursively($interfaceSpecification->directory);
98+
$interfaceSpecification = NodeInterfaceSpecification::createFromNodeType($nodeType);
99+
Files::createDirectoryRecursively($package->getPackagePath() . DIRECTORY_SEPARATOR . $interfaceSpecification->interfaceName->getLocalDirectoryName());
100100
file_put_contents(
101-
$interfaceSpecification->interfaceFilename,
101+
$package->getPackagePath() . DIRECTORY_SEPARATOR . $interfaceSpecification->interfaceName->getLocalFileName(),
102102
$interfaceSpecification->toPhpString()
103103
);
104104
$this->outputLine(' - ' . $interfaceSpecification->interfaceName->nodeTypeName . ' -> <info>' . $interfaceSpecification->interfaceName->getFullyQualifiedClassName() . '</info>');
@@ -115,10 +115,10 @@ public function buildCommand(string $packageKey, string $crId = 'default'): void
115115
);
116116

117117
foreach ($nonAbstractNodeTypes as $nodeType) {
118-
$objectSpecification = NodeObjectSpecification::createFromPackageAndNodeType($package, $nodeType);
119-
Files::createDirectoryRecursively($objectSpecification->directory);
118+
$objectSpecification = NodeObjectSpecification::createFromNodeType($nodeType);
119+
Files::createDirectoryRecursively($package->getPackagePath() . DIRECTORY_SEPARATOR . $objectSpecification->objectName->getLocalDirectoryName());
120120
file_put_contents(
121-
$objectSpecification->classFilename,
121+
$package->getPackagePath() . DIRECTORY_SEPARATOR . $objectSpecification->objectName->getLocalFileName(),
122122
$objectSpecification->toPhpString()
123123
);
124124
$this->outputLine(' - ' . $objectSpecification->objectName->nodeTypeName . ' -> <info>' . $objectSpecification->objectName->getFullyQualifiedClassName() . '</info>');

‎Classes/Domain/NodeInterfaceNameSpecification.php‎

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,32 +13,45 @@
1313
{
1414
public function __construct(
1515
public string $nodeTypeName,
16-
public string $phpNamespace,
17-
public string $interfaceName
16+
public string $packageNamespace,
17+
public string $localNamespace,
18+
public string $interfaceName,
1819
) {
1920
}
2021

22+
public function getFullNamespace(): string
23+
{
24+
return $this->packageNamespace . '\\' . $this->localNamespace;
25+
}
26+
2127
public function getFullyQualifiedClassName(): string
2228
{
23-
return $this->phpNamespace . '\\' . $this->interfaceName;
29+
return $this->packageNamespace . '\\' . $this->localNamespace . '\\' . $this->interfaceName;
30+
}
31+
32+
public function getLocalDirectoryName(): string
33+
{
34+
return str_replace('\\', DIRECTORY_SEPARATOR, $this->localNamespace);
35+
}
36+
37+
public function getLocalFileName(): string
38+
{
39+
return str_replace('\\', DIRECTORY_SEPARATOR, $this->localNamespace) . DIRECTORY_SEPARATOR . $this->interfaceName . '.php';
40+
;
2441
}
2542

2643
public static function createFromNodeTypeName(
2744
NodeTypeName $nodeTypeName
2845
): self {
29-
3046
list($packageKey, $nodeName) = explode(':', $nodeTypeName->value, 2);
31-
47+
$packageKeyParts = explode('.', $packageKey);
3248
$localNameParts = explode('.', $nodeName);
33-
$localName = array_pop($localNameParts);
34-
35-
$phpNamespace = str_replace(['.', ':'], ['\\', '\\NodeTypes\\'], $nodeTypeName->value);
36-
$interfaceName = str_replace('.', '\\', $localName) . 'NodeInterface';
37-
49+
$localName = $localNameParts[array_key_last($localNameParts)];
3850
return new self(
3951
$nodeTypeName->value,
40-
$phpNamespace,
41-
$interfaceName
52+
PhpNameHelper::sanitize(implode('\\', $packageKeyParts)),
53+
'NodeTypes\\' . PhpNameHelper::sanitize(implode('\\', $localNameParts)),
54+
PhpNameHelper::sanitize(str_replace('.', '\\', $localName)) . 'NodeInterface'
4255
);
4356
}
4457

‎Classes/Domain/NodeInterfaceNameSpecificationCollection.php‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,16 @@ public static function createFromNodeType(NodeType $nodeType, bool $checkForExis
3535
$interfaces = [
3636
NodeInterfaceNameSpecification::createFromNodeType($nodeType)
3737
];
38-
foreach ($nodeType->getDeclaredSuperTypes() as $superType) {
38+
39+
if ($nodeType->name->value === 'Vendor.Site:Content.Text') {
40+
var_dump(array_keys(self::getFlattenedSuperTypes($nodeType)));
41+
}
42+
foreach (self::getFlattenedSuperTypes($nodeType) as $superType) {
3943
$interface = NodeInterfaceNameSpecification::createFromNodeType($superType);
40-
if ($checkForExistence && interface_exists($interface->getFullyQualifiedClassName())) {
41-
$interfaces[] = $interface;
44+
if ($checkForExistence) {
45+
if (interface_exists($interface->getFullyQualifiedClassName(), true)) {
46+
$interfaces[] = $interface;
47+
}
4248
} else {
4349
$interfaces[] = $interface;
4450
}
@@ -51,7 +57,23 @@ public function asImplementsStatement(): string
5157
if (empty($this->items)) {
5258
return '';
5359
} else {
54-
return 'implements ' . implode(', ', array_map(fn(NodeInterfaceNameSpecification $item)=> $item->getFullyQualifiedClassName(), $this->items));
60+
return 'implements ' . implode(', ', array_map(fn(NodeInterfaceNameSpecification $item)=> '\\' . $item->getFullyQualifiedClassName(), $this->items));
61+
}
62+
}
63+
64+
/**
65+
* Returns a flat list of super types to inherit from.
66+
*
67+
* @return array<string,NodeType>
68+
*/
69+
protected static function getFlattenedSuperTypes(NodeType $nodeType): array
70+
{
71+
$flattenedSuperTypes = [];
72+
foreach ($nodeType->getDeclaredSuperTypes() as $superTypeName => $superType) {
73+
$flattenedSuperTypes += static::getFlattenedSuperTypes($superType);
74+
$flattenedSuperTypes[$superTypeName] = $superType;
5575
}
76+
77+
return $flattenedSuperTypes;
5678
}
5779
}

‎Classes/Domain/NodeInterfaceSpecification.php‎

Lines changed: 4 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -13,41 +13,16 @@
1313
{
1414
public function __construct(
1515
public NodeInterfaceNameSpecification $interfaceName,
16-
public NodeInterfaceNameSpecificationCollection $interfaceNames,
1716
public NodePropertySpecificationCollection $properties,
18-
public string $directory,
19-
public string $interfaceFilename,
2017
) {
2118
}
2219

23-
public static function createFromPackageAndNodeType(
24-
FlowPackageInterface $package,
20+
public static function createFromNodeType(
2521
NodeType $nodeType,
2622
): self {
27-
28-
if (!str_starts_with($nodeType->name->value, $package->getPackageKey() . ':')) {
29-
throw new \Exception("Only nodetypes from the given package are allowed");
30-
}
31-
32-
$nameSpecification = NodeInterfaceNameSpecification::createFromNodeType($nodeType);
33-
34-
$localNameParts = explode('.', str_replace($package->getPackageKey() . ':', '', $nodeType->name->value));
35-
$localName = array_pop($localNameParts);
36-
$localNamespace = implode('.', $localNameParts);
37-
38-
$directory = $package->getPackagePath()
39-
. 'NodeTypes' . DIRECTORY_SEPARATOR
40-
. ($localNamespace ? str_replace('.', DIRECTORY_SEPARATOR, $localNamespace) . DIRECTORY_SEPARATOR : '')
41-
. $localName;
42-
43-
$interfaceFileName = $directory . DIRECTORY_SEPARATOR . $nameSpecification->interfaceName . '.php';
44-
4523
return new self(
46-
$nameSpecification,
47-
NodeInterfaceNameSpecificationCollection::createFromNodeType($nodeType),
24+
NodeInterfaceNameSpecification::createFromNodeType($nodeType),
4825
NodePropertySpecificationCollection::createFromNodeType($nodeType),
49-
$directory,
50-
$interfaceFileName
5126
);
5227
}
5328

@@ -71,15 +46,15 @@ public function toPhpString(): ?string
7146
7247
declare(strict_types=1);
7348
74-
namespace {$this->interfaceName->phpNamespace};
49+
namespace {$this->interfaceName->getFullNamespace()};
7550
7651
use Neos\ContentRepository\Domain\Model\NodeInterface;
7752
use Neos\Flow\Annotations as Flow;
7853
7954
/**
8055
* AUTOGENERATED CODE ... DO NOT MODIFY !!!
8156
*
82-
* run `./flow nodetypeobjects:build` to regenerate this
57+
* run `./flow nodebjects:build` to regenerate this
8358
*/
8459
interface {$this->interfaceName->interfaceName}
8560
{

‎Classes/Domain/NodeObjectNameSpecification.php‎

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,32 +13,44 @@
1313
{
1414
public function __construct(
1515
public string $nodeTypeName,
16-
public string $phpNamespace,
16+
public string $packageNamespace,
17+
public string $localNamespace,
1718
public string $className,
1819
) {
1920
}
2021

22+
public function getFullNamespace(): string
23+
{
24+
return $this->packageNamespace . '\\' . $this->localNamespace;
25+
}
26+
2127
public function getFullyQualifiedClassName(): string
2228
{
23-
return $this->phpNamespace . '\\' . $this->className;
29+
return $this->packageNamespace . '\\' . $this->localNamespace . '\\' . $this->className;
30+
}
31+
32+
public function getLocalDirectoryName(): string
33+
{
34+
return str_replace('\\', DIRECTORY_SEPARATOR, $this->localNamespace);
35+
}
36+
37+
public function getLocalFileName(): string
38+
{
39+
return str_replace('\\', DIRECTORY_SEPARATOR, $this->localNamespace) . DIRECTORY_SEPARATOR . $this->className . '.php';
2440
}
2541

2642
public static function createFromNodeTypeName(
2743
NodeTypeName $nodeTypeName
2844
): self {
29-
3045
list($packageKey, $nodeName) = explode(':', $nodeTypeName->value, 2);
31-
46+
$packageKeyParts = explode('.', $packageKey);
3247
$localNameParts = explode('.', $nodeName);
33-
$localName = array_pop($localNameParts);
34-
35-
$phpNamespace = str_replace(['.', ':'], ['\\', '\\NodeTypes\\'], $nodeTypeName->value);
36-
$className = str_replace('.', '\\', $localName) . 'NodeObject';
37-
48+
$localName = $localNameParts[array_key_last($localNameParts)];
3849
return new self(
3950
$nodeTypeName->value,
40-
$phpNamespace,
41-
$className,
51+
PhpNameHelper::sanitize(implode('\\', $packageKeyParts)),
52+
'NodeTypes\\' . PhpNameHelper::sanitize(implode('\\', $localNameParts)),
53+
PhpNameHelper::sanitize(str_replace('.', '\\', $localName)) . 'NodeObject'
4254
);
4355
}
4456

‎Classes/Domain/NodeObjectSpecification.php‎

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -15,39 +15,16 @@ public function __construct(
1515
public NodeObjectNameSpecification $objectName,
1616
public NodeInterfaceNameSpecificationCollection $interfaceNames,
1717
public NodePropertySpecificationCollection $properties,
18-
public string $directory,
19-
public string $classFilename,
2018
) {
2119
}
2220

23-
public static function createFromPackageAndNodeType(
24-
FlowPackageInterface $package,
21+
public static function createFromNodeType(
2522
NodeType $nodeType,
2623
): self {
27-
28-
if (!str_starts_with($nodeType->name->value, $package->getPackageKey() . ':')) {
29-
throw new \Exception("Only nodetypes from the given package are allowed");
30-
}
31-
32-
$nameSpecification = NodeObjectNameSpecification::createFromNodeType($nodeType);
33-
34-
$localNameParts = explode('.', str_replace($package->getPackageKey() . ':', '', $nodeType->name->value));
35-
$localName = array_pop($localNameParts);
36-
$localNamespace = implode('.', $localNameParts);
37-
38-
$directory = $package->getPackagePath()
39-
. 'NodeTypes' . DIRECTORY_SEPARATOR
40-
. ($localNamespace ? str_replace('.', DIRECTORY_SEPARATOR, $localNamespace) . DIRECTORY_SEPARATOR : '')
41-
. $localName;
42-
43-
$classFilename = $directory . DIRECTORY_SEPARATOR . $nameSpecification->className . '.php';
44-
4524
return new self(
46-
$nameSpecification,
25+
NodeObjectNameSpecification::createFromNodeType($nodeType),
4726
NodeInterfaceNameSpecificationCollection::createFromNodeType($nodeType, true),
4827
NodePropertySpecificationCollection::createFromNodeType($nodeType),
49-
$directory,
50-
$classFilename
5128
);
5229
}
5330

@@ -72,7 +49,7 @@ public function toPhpString(): string
7249
7350
declare(strict_types=1);
7451
75-
namespace {$this->objectName->phpNamespace};
52+
namespace {$this->objectName->getFullNamespace()};
7653
7754
use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
7855
use Neos\Flow\Annotations as Flow;

‎Classes/Domain/PhpNameHelper.php‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?php
2+
3+
namespace PackageFactory\NodeTypeObjects\Domain;
4+
5+
use Neos\ContentRepository\Core\NodeType\NodeTypeName;
6+
7+
class PhpNameHelper
8+
{
9+
public static function sanitize(string $name): string
10+
{
11+
// pure number segments are prefixed by a number
12+
/**
13+
* @var string $name
14+
*/
15+
$name = preg_replace('/(^|\\\\)([0-9]+)(\\\\|$)/us', '$1_$2$3', $name);
16+
return $name;
17+
}
18+
}

‎Tests/Unit/NodeInterfaceNameSpecificationTest.php‎

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,31 @@
1111

1212
class NodeInterfaceNameSpecificationTest extends TestCase
1313
{
14-
#[Test]
15-
public function detectionOfNamesFromNodeType(): void
14+
public static function detectionOfNamesFromNodeTypeDataProvider(): \Generator
15+
{
16+
yield [
17+
'Vendor.Example:Foo.Bar',
18+
'Vendor\Example',
19+
'NodeTypes\Foo\Bar',
20+
'BarNodeInterface'
21+
];
22+
23+
yield [
24+
'404:404',
25+
'_404',
26+
'NodeTypes\_404',
27+
'_404NodeInterface'
28+
];
29+
}
30+
31+
/**
32+
* @test
33+
* @dataProvider detectionOfNamesFromNodeTypeDataProvider
34+
*/
35+
public function detectionOfNamesFromNodeType(string $nodeTypeName, string $expectedPackageNamespace, string $expectedLocalNamespace, string $expectedInterface): void
1636
{
1737
$nodeType = new NodeType(
18-
NodeTypeName::fromString('Vendor.Example:Foo.Bar'),
38+
NodeTypeName::fromString($nodeTypeName),
1939
[],
2040
[]
2141
);
@@ -26,9 +46,10 @@ public function detectionOfNamesFromNodeType(): void
2646

2747
$this->assertEquals(
2848
new NodeInterfaceNameSpecification(
29-
'Vendor.Example:Foo.Bar',
30-
'Vendor\Example\NodeTypes\Foo\Bar',
31-
'BarNodeInterface',
49+
$nodeTypeName,
50+
$expectedPackageNamespace,
51+
$expectedLocalNamespace,
52+
$expectedInterface,
3253
),
3354
$specification
3455
);

0 commit comments

Comments
 (0)