TASK Refactor context methods

neos · Nov 1, 2023 · 6425df9 · 6425df9
1 parent 99a562f
commit 6425df9
Show file tree

Hide file tree

Showing 53 changed files with 788 additions and 124 deletions.
diff --git a/config/set/contentrepository-90.php b/config/set/contentrepository-90.php
diff --git a/src/ContentRepository90/Legacy/NodeLegacyStub.php b/src/ContentRepository90/Legacy/NodeLegacyStub.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Neos\Rector\ContentRepository90\Legacy;
+
+/**
+ * @deprecated
+ */
+class NodeLegacyStub
+{
+
+    public function getContext() : LegacyContextStub {
+        return new LegacyContextStub([]);
+    }
+
+    public function isLive() :bool {
+        return false;
+    }
+}
diff --git a/src/ContentRepository90/Rules/ContextGetCurrentRenderingModeRector.php b/src/ContentRepository90/Rules/ContextGetCurrentRenderingModeRector.php
@@ -0,0 +1,63 @@
+<?php
+
+declare (strict_types=1);
+
+namespace Neos\Rector\ContentRepository90\Rules;
+
+use Neos\Rector\Utility\CodeSampleLoader;
+use PhpParser\Node;
+use PHPStan\Type\ObjectType;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Rector\PostRector\Collector\NodesToAddCollector;
+use PhpParser\Node\Expr\Assign;
+
+final class ContextGetCurrentRenderingModeRector extends AbstractRector
+{
+    use AllTraits;
+    use ContextRectorTrait;
+
+    public function __construct(
+        private readonly NodesToAddCollector $nodesToAddCollector
+    ) {
+    }
+
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return CodeSampleLoader::fromFile('"ContentContext::getCurrentRenderingMode()" will be replaced with RenderingModeService::findByCurrentUser().', __CLASS__);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Node\Expr\MethodCall::class];
+    }
+
+    /**
+     * @param \PhpParser\Node\Stmt\Expression $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        assert($node instanceof Node\Expr\MethodCall);
+
+        $oldContextMethod = 'getCurrentRenderingMode';
+        if (
+            $this->isContextWithMethod($node, $oldContextMethod)
+        ) {
+
+            return $this->nodeFactory->createMethodCall(
+                $this->nodeFactory->createPropertyFetch(
+                    'this',
+                    'renderingModeService'
+                ),
+                'findByCurrentUser'
+            );
+        }
+
+        return null;
+    }
+
+}
diff --git a/src/ContentRepository90/Rules/ContextIsInBackendRector.php b/src/ContentRepository90/Rules/ContextIsInBackendRector.php
@@ -0,0 +1,67 @@
+<?php
+
+declare (strict_types=1);
+
+namespace Neos\Rector\ContentRepository90\Rules;
+
+use Neos\Rector\Utility\CodeSampleLoader;
+use PhpParser\Node;
+use PHPStan\Type\ObjectType;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Rector\PostRector\Collector\NodesToAddCollector;
+use PhpParser\Node\Expr\Assign;
+use PhpParser\NodeDumper;
+
+final class ContextIsInBackendRector extends AbstractRector
+{
+    use AllTraits;
+    use ContextRectorTrait;
+
+    public function __construct(
+        private readonly NodesToAddCollector $nodesToAddCollector
+    ) {
+    }
+
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return CodeSampleLoader::fromFile('"ContentContext::isLive()" will be replaced with RenderingModeService::findByCurrentUser().', __CLASS__);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Node\Expr\MethodCall::class];
+    }
+
+    /**
+     * @param \PhpParser\Node\Stmt\Expression $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        assert($node instanceof Node\Expr\MethodCall);
+
+        $oldContextMethod = 'isInBackend';
+        if ($this->isContextWithMethod($node, $oldContextMethod)) {
+
+            $renderingModeService = $this->nodeFactory->createMethodCall(
+                $this->nodeFactory->createPropertyFetch(
+                    'this',
+                    'renderingModeService'
+                ),
+                'findByCurrentUser'
+            );
+
+            return $this->nodeFactory->createPropertyFetch(
+                $renderingModeService, 'isEdit'
+            );
+
+        }
+
+        return null;
+    }
+
+}
diff --git a/src/ContentRepository90/Rules/ContextIsLiveRector.php b/src/ContentRepository90/Rules/ContextIsLiveRector.php
@@ -0,0 +1,80 @@
+<?php
+
+declare (strict_types=1);
+
+namespace Neos\Rector\ContentRepository90\Rules;
+
+use Neos\Rector\Utility\CodeSampleLoader;
+use PhpParser\Node;
+use PHPStan\Type\ObjectType;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Rector\PostRector\Collector\NodesToAddCollector;
+use PhpParser\Node\Expr\Assign;
+use PhpParser\NodeDumper;
+
+final class ContextIsLiveRector extends AbstractRector
+{
+    use AllTraits;
+    use ContextRectorTrait;
+
+    public function __construct(
+        private readonly NodesToAddCollector $nodesToAddCollector
+    ) {
+    }
+
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return CodeSampleLoader::fromFile('"ContentContext::isLive()" will be replaced with RenderingModeService::findByCurrentUser().', __CLASS__);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Node\Expr\MethodCall::class];
+    }
+
+    /**
+     * @param \PhpParser\Node\Stmt\Expression $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        assert($node instanceof Node\Expr\MethodCall);
+
+        $oldContextMethod = 'isLive';
+        if ($this->isContextWithMethod($node, $oldContextMethod)) {
+
+            $renderingModeService = $this->nodeFactory->createMethodCall(
+                $this->nodeFactory->createPropertyFetch(
+                    'this',
+                    'renderingModeService'
+                ),
+                'findByCurrentUser'
+            );
+
+            $isEdit = $this->nodeFactory->createPropertyFetch(
+                $renderingModeService, 'isEdit'
+            );
+            $isPreview = $this->nodeFactory->createPropertyFetch(
+                $renderingModeService, 'isPreview'
+            );
+
+            $replacementExpression = new Node\Expr\BinaryOp\BooleanAnd(
+                new Node\Expr\BooleanNot(
+                    $isEdit
+                ),
+                new Node\Expr\BooleanNot(
+                    $isPreview
+                ),
+            );
+
+            return $replacementExpression;
+        }
+
+        return null;
+    }
+
+}
diff --git a/src/ContentRepository90/Rules/ContextRectorTrait.php b/src/ContentRepository90/Rules/ContextRectorTrait.php
@@ -0,0 +1,27 @@
+<?php
+
+declare (strict_types=1);
+
+namespace Neos\Rector\ContentRepository90\Rules;
+
+use Neos\Rector\Utility\CodeSampleLoader;
+use PhpParser\Node;
+use PhpParser\NodeFinder;
+use PHPStan\Type\ObjectType;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Rector\PostRector\Collector\NodesToAddCollector;
+use PhpParser\Node\Expr\Assign;
+use PhpParser\NodeDumper;
+
+trait ContextRectorTrait
+{
+    private function isContextWithMethod(Node\Expr\MethodCall $node, string $methodName): bool
+    {
+        return (
+            $node->name == $methodName
+            && $this->isObjectType($node->var, new ObjectType('Neos\Rector\ContentRepository90\Legacy\LegacyContextStub')
+            )
+        );
+    }
+}
diff --git a/src/ContentRepository90/Rules/NodeFindParentNodeRector.php b/src/ContentRepository90/Rules/NodeFindParentNodeRector.php
@@ -41,7 +41,7 @@ public function refactor(Node $node): ?Node
     {
         assert($node instanceof Node\Expr\MethodCall);
 
-        if (!$this->isObjectType($node->var, new ObjectType(\Neos\ContentRepository\Core\Projection\ContentGraph\Node::class))) {
+        if (!$this->isObjectType($node->var, new ObjectType(\Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub::class))) {
             return null;
         }
         if (!$this->isName($node->name, 'findParentNode')) {

diff --git a/src/ContentRepository90/Rules/NodeGetChildNodesRector.php b/src/ContentRepository90/Rules/NodeGetChildNodesRector.php
@@ -39,7 +39,7 @@ public function refactor(Node $node) : ?Node
     {
         assert($node instanceof Node\Expr\MethodCall);
 
-        if (!$this->isObjectType($node->var, new ObjectType(\Neos\ContentRepository\Core\Projection\ContentGraph\Node::class))) {
+        if (!$this->isObjectType($node->var, new ObjectType(\Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub::class))) {
             return null;
         }
         if (!$this->isName($node->name, 'getChildNodes')) {

diff --git a/src/ContentRepository90/Rules/NodeGetContextGetWorkspaceNameRector.php b/src/ContentRepository90/Rules/NodeGetContextGetWorkspaceNameRector.php
@@ -51,7 +51,7 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        if (!$this->isObjectType($node->var->var, new ObjectType(\Neos\ContentRepository\Core\Projection\ContentGraph\Node::class))) {
+        if (!$this->isObjectType($node->var->var, new ObjectType(\Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub::class))) {
             return null;
         }
 

diff --git a/src/ContentRepository90/Rules/NodeGetContextGetWorkspaceRector.php b/src/ContentRepository90/Rules/NodeGetContextGetWorkspaceRector.php
@@ -51,7 +51,7 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        if (!$this->isObjectType($node->var->var, new ObjectType(\Neos\ContentRepository\Core\Projection\ContentGraph\Node::class))) {
+        if (!$this->isObjectType($node->var->var, new ObjectType(\Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub::class))) {
             return null;
         }
 

diff --git a/src/ContentRepository90/Rules/NodeGetDepthRector.php b/src/ContentRepository90/Rules/NodeGetDepthRector.php
@@ -39,7 +39,7 @@ public function refactor(Node $node) : ?Node
     {
         assert($node instanceof Node\Expr\MethodCall);
 
-        if (!$this->isObjectType($node->var, new ObjectType(\Neos\ContentRepository\Core\Projection\ContentGraph\Node::class))) {
+        if (!$this->isObjectType($node->var, new ObjectType(\Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub::class))) {
             return null;
         }
         if (!$this->isName($node->name, 'getDepth')) {

diff --git a/src/ContentRepository90/Rules/NodeGetDimensionsRector.php b/src/ContentRepository90/Rules/NodeGetDimensionsRector.php
@@ -39,7 +39,7 @@ public function refactor(Node $node) : ?Node
     {
         assert($node instanceof Node\Expr\MethodCall);
 
-        if (!$this->isObjectType($node->var, new ObjectType(\Neos\ContentRepository\Core\Projection\ContentGraph\Node::class))) {
+        if (!$this->isObjectType($node->var, new ObjectType(\Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub::class))) {
             return null;
         }
         if (!$this->isName($node->name, 'getDimensions')) {

diff --git a/src/ContentRepository90/Rules/NodeGetIdentifierRector.php b/src/ContentRepository90/Rules/NodeGetIdentifierRector.php
@@ -40,7 +40,7 @@ public function refactor(Node $node): ?Node
     {
         assert($node instanceof Node\Expr\MethodCall);
 
-        if (!$this->isObjectType($node->var, new ObjectType(\Neos\ContentRepository\Core\Projection\ContentGraph\Node::class))) {
+        if (!$this->isObjectType($node->var, new ObjectType(\Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub::class))) {
             return null;
         }
         if (!$this->isName($node->name, 'getIdentifier')) {

diff --git a/src/ContentRepository90/Rules/NodeGetParentRector.php b/src/ContentRepository90/Rules/NodeGetParentRector.php
@@ -39,7 +39,7 @@ public function refactor(Node $node) : ?Node
     {
         assert($node instanceof Node\Expr\MethodCall);
 
-        if (!$this->isObjectType($node->var, new ObjectType(\Neos\ContentRepository\Core\Projection\ContentGraph\Node::class))) {
+        if (!$this->isObjectType($node->var, new ObjectType(\Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub::class))) {
             return null;
         }
         if (!$this->isName($node->name, 'getParent')) {

diff --git a/src/ContentRepository90/Rules/NodeGetPathRector.php b/src/ContentRepository90/Rules/NodeGetPathRector.php
@@ -39,7 +39,7 @@ public function refactor(Node $node) : ?Node
     {
         assert($node instanceof Node\Expr\MethodCall);
 
-        if (!$this->isObjectType($node->var, new ObjectType(\Neos\ContentRepository\Core\Projection\ContentGraph\Node::class))) {
+        if (!$this->isObjectType($node->var, new ObjectType(\Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub::class))) {
             return null;
         }
         if (!$this->isName($node->name, 'getPath')) {

diff --git a/src/ContentRepository90/Rules/NodeIsHiddenInIndexRector.php b/src/ContentRepository90/Rules/NodeIsHiddenInIndexRector.php
@@ -41,7 +41,7 @@ public function refactor(Node $node) : ?Node
     {
         assert($node instanceof MethodCall);
 
-        if (!$this->isObjectType($node->var, new ObjectType(\Neos\ContentRepository\Core\Projection\ContentGraph\Node::class))) {
+        if (!$this->isObjectType($node->var, new ObjectType(\Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub::class))) {
             return null;
         }
         if (!$this->isName($node->name, 'isHiddenInIndex')) {

diff --git a/src/ContentRepository90/Rules/NodeIsHiddenRector.php b/src/ContentRepository90/Rules/NodeIsHiddenRector.php
@@ -41,7 +41,7 @@ public function refactor(Node $node) : ?Node
     {
         assert($node instanceof Node\Expr\MethodCall);
 
-        if (!$this->isObjectType($node->var, new ObjectType(\Neos\ContentRepository\Core\Projection\ContentGraph\Node::class))) {
+        if (!$this->isObjectType($node->var, new ObjectType(\Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub::class))) {
             return null;
         }
         if (!$this->isName($node->name, 'isHidden')) {

diff --git a/src/Generic/Rules/MethodCallToWarningCommentRector.php b/src/Generic/Rules/MethodCallToWarningCommentRector.php
@@ -13,6 +13,7 @@
 use Rector\PostRector\Collector\NodesToAddCollector;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 use Webmozart\Assert\Assert;
+use Neos\Rector\ContentRepository90\Legacy\NodeLegacyStub;
 
 final class MethodCallToWarningCommentRector extends AbstractRector implements ConfigurableRectorInterface
 {
@@ -32,7 +33,7 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return CodeSampleLoader::fromFile('"Warning comments for various non-supported use cases', __CLASS__, [
-            new MethodCallToWarningComment(Node::class, 'getWorkspace', '!! Node::getWorkspace() does not make sense anymore concept-wise. In Neos < 9, it pointed to the workspace where the node was *at home at*. Now, the closest we have here is the node identity.')
+            new MethodCallToWarningComment(NodeLegacyStub::class, 'getWorkspace', '!! Node::getWorkspace() does not make sense anymore concept-wise. In Neos < 9, it pointed to the workspace where the node was *at home at*. Now, the closest we have here is the node identity.')
         ]);
     }