Merge pull request #89 from neos/task/node-label-generator

TASK: Add migration for getLabel with NodeLabelGeneratorRector

config/set/contentrepository-90.php

@@ -4,6 +4,7 @@
 use Neos\ContentRepository\Core\NodeType\NodeType;
 use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
 use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry;
+use Neos\Neos\Domain\NodeLabel\NodeLabelGeneratorInterface;
 use Neos\Neos\Domain\Service\RenderingModeService;
 use Neos\Rector\ContentRepository90\Legacy\LegacyContextStub;
 use Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub;
@@ -46,6 +47,7 @@
 use Neos\Rector\ContentRepository90\Rules\NodeGetPathRector;
 use Neos\Rector\ContentRepository90\Rules\NodeIsHiddenInIndexRector;
 use Neos\Rector\ContentRepository90\Rules\NodeIsHiddenRector;
+use Neos\Rector\ContentRepository90\Rules\NodeLabelGeneratorRector;
 use Neos\Rector\ContentRepository90\Rules\NodeTypeAllowsGrandchildNodeTypeRector;
 use Neos\Rector\ContentRepository90\Rules\NodeTypeGetAutoCreatedChildNodesRector;
 use Neos\Rector\ContentRepository90\Rules\NodeTypeGetNameRector;
@@ -137,6 +139,7 @@
     $fusionFlowQueryPropertyToComments[] = new FusionFlowQueryNodePropertyToWarningComment('_name', 'Line %LINE: !! You very likely need to rewrite "q(VARIABLE).property("_name")" to "VARIABLE.nodeName". We did not auto-apply this migration because we cannot be sure whether the variable is a Node.');
     // getLabel
     $rectorConfig->rule(FusionNodeLabelRector::class);
+    $rectorConfig->rule(NodeLabelGeneratorRector::class);
     // setProperty
     // hasProperty -> compatible with ES CR Node (nothing to do)
     // getProperty -> compatible with ES CR Node (nothing to do)
@@ -469,6 +472,7 @@
     $rectorConfig->ruleWithConfiguration(InjectServiceIfNeededRector::class, [
         new AddInjection('contentRepositoryRegistry', ContentRepositoryRegistry::class),
         new AddInjection('renderingModeService', RenderingModeService::class),
+        new AddInjection('nodeLabelGenerator', NodeLabelGeneratorInterface::class),
     ]);
     // TODO: does not fully seem to work.$rectorConfig->rule(RemoveDuplicateCommentRector::class);
 };

src/ContentRepository90/Rules/NodeLabelGeneratorRector.php

@@ -0,0 +1,60 @@
+<?php
+
+declare (strict_types=1);
+namespace Neos\Rector\ContentRepository90\Rules;
+
+use Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub;
+use Neos\Rector\Utility\CodeSampleLoader;
+use PhpParser\Node;
+use PHPStan\Type\ObjectType;
+use Rector\Core\Rector\AbstractRector;
+use Rector\PostRector\Collector\NodesToAddCollector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class NodeLabelGeneratorRector extends AbstractRector
+{
+    use AllTraits;
+
+    public function __construct(
+        private readonly NodesToAddCollector $nodesToAddCollector
+    )
+    {
+    }
+
+    public function getRuleDefinition() : RuleDefinition
+    {
+        return CodeSampleLoader::fromFile('"$node->getLabel()" will be rewritten.', __CLASS__);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes() : array
+    {
+        return [Node\Expr\MethodCall::class];
+    }
+    /**
+     * @param Node\Expr\MethodCall $node
+     */
+    public function refactor(Node $node) : ?Node
+    {
+        assert($node instanceof Node\Expr\MethodCall);
+
+        if (!$this->isObjectType($node->var, new ObjectType(NodeLegacyStub::class))) {
+            return null;
+        }
+
+        if (!$this->isName($node->name, 'getLabel')) {
+            return null;
+        }
+
+        return $this->nodeFactory->createMethodCall(
+            $this->nodeFactory->createPropertyFetch(
+                'this',
+                'nodeLabelGenerator'
+            ),
+            'getLabel',
+            [$node->var]
+        );
+    }
+}

tests/ContentRepository90/Rules/NodeLabelGeneratorRector/Fixture/some_class.php.inc

@@ -0,0 +1,29 @@
+<?php
+
+use Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub;
+
+class SomeClass
+{
+    public function run(NodeLegacyStub $node)
+    {
+        $label = $node->getLabel();
+    }
+}
+
+?>
+-----
+<?php
+
+use Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub;
+
+class SomeClass
+{
+    #[\Neos\Flow\Annotations\Inject]
+    protected \Neos\Neos\Domain\NodeLabel\NodeLabelGeneratorInterface $nodeLabelGenerator;
+    public function run(NodeLegacyStub $node)
+    {
+        $label = $this->nodeLabelGenerator->getLabel($node);
+    }
+}
+
+?>

tests/ContentRepository90/Rules/NodeLabelGeneratorRector/NodeLabelGeneratorRectorTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neos\Rector\Tests\ContentRepository90\Rules\NodeLabelGeneratorRector;
+
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class NodeLabelGeneratorRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $fileInfo): void
+    {
+        $this->doTestFile($fileInfo);
+    }
+
+    /**
+     * @return \Iterator<string>
+     */
+    public function provideData(): \Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

tests/ContentRepository90/Rules/NodeLabelGeneratorRector/config/configured_rule.php

@@ -0,0 +1,17 @@
+<?php
+
+declare (strict_types=1);
+
+use Neos\Neos\Domain\NodeLabel\NodeLabelGeneratorInterface;
+use Neos\Rector\ContentRepository90\Rules\NodeLabelGeneratorRector;
+use Neos\Rector\Generic\Rules\InjectServiceIfNeededRector;
+use Neos\Rector\Generic\ValueObject\AddInjection;
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(NodeLabelGeneratorRector::class);
+
+    $rectorConfig->ruleWithConfiguration(InjectServiceIfNeededRector::class, [
+        new AddInjection('nodeLabelGenerator', NodeLabelGeneratorInterface::class),
+    ]);
+};