Merge pull request #45 from neos/task/4208-remove-internal-properties

TASK: Remove "internal" node properties

config/set/contentrepository-90.php

@@ -152,7 +152,7 @@
     $rectorConfig->rule(NodeIsHiddenInIndexRector::class);
     // Fusion: .hiddenInIndex -> node.properties._hiddenInIndex
     $rectorConfig->rule(FusionNodeHiddenInIndexRector::class);
-    $fusionFlowQueryPropertyToComments[] = new FusionFlowQueryNodePropertyToWarningComment('_hiddenInIndex', 'Line %LINE: !! You very likely need to rewrite "q(VARIABLE).property("_hiddenInIndex")" to "VARIABLE.properties._hiddenInIndex". We did not auto-apply this migration because we cannot be sure whether the variable is a Node.');
+    $fusionFlowQueryPropertyToComments[] = new FusionFlowQueryNodePropertyToWarningComment('_hiddenInIndex', 'Line %LINE: !! You very likely need to rewrite "q(VARIABLE).property("_hiddenInIndex")" to "VARIABLE.property(\'hiddenInMenu\')". We did not auto-apply this migration because we cannot be sure whether the variable is a Node.');
     // setAccessRoles
     $methodCallToWarningComments[] = new MethodCallToWarningComment(NodeLegacyStub::class, 'setAccessRoles', '!! Node::setAccessRoles() is not supported by the new CR.');
     // getAccessRoles

src/ContentRepository90/Rules/FusionNodeContextPathRector.php

@@ -28,6 +28,16 @@ public function refactorFileContent(string $fileContent): string
             ->addCommentsIfRegexMatches(
                 '/\.contextPath/',
                 '// TODO 9.0 migration: Line %LINE: !! You very likely need to rewrite "VARIABLE.contextPath" to "Neos.Node.serializedNodeAddress(VARIABLE)". We did not auto-apply this migration because we cannot be sure whether the variable is a Node.'
-            )->getProcessedContent();
+            )
+            ->process(fn(string $eelExpression) => preg_replace(
+                '/(node|documentNode|site)\.property\\((\'|")_contextPath(\'|")\\)/',
+                'Neos.Node.serializedNodeAddress($1)',
+                $eelExpression
+            ))
+            ->addCommentsIfRegexMatches(
+                '/\.property\\((\'|")_contextPath(\'|")\\)/',
+                '// TODO 9.0 migration: Line %LINE: !! You very likely need to rewrite "VARIABLE.property(\'_contextPath\')" to "Neos.Node.serializedNodeAddress(VARIABLE)". We did not auto-apply this migration because we cannot be sure whether the variable is a Node.'
+            )
+            ->getProcessedContent();
     }
 }

src/ContentRepository90/Rules/FusionNodeDepthRector.php

@@ -28,6 +28,15 @@ public function refactorFileContent(string $fileContent): string
             ->addCommentsIfRegexMatches(
                 '/\.depth$/',
                 '// TODO 9.0 migration: Line %LINE: You may need to rewrite "VARIABLE.depth" to Neos.Node.depth(VARIABLE). We did not auto-apply this migration because we cannot be sure whether the variable is a Node.'
+            )
+            ->process(fn(string $eelExpression) => preg_replace(
+                '/([a-zA-Z.]+)?(node|documentNode)\.property\\((\'|")_depth(\'|")\\)/',
+                'Neos.Node.depth($1$2)',
+                $eelExpression
+            ))
+            ->addCommentsIfRegexMatches(
+                '/\.property\\((\'|")_depth(\'|")\\)/',
+                '// TODO 9.0 migration: Line %LINE: You may need to rewrite "VARIABLE.property(\'_depth\')" to Neos.Node.depth(VARIABLE). We did not auto-apply this migration because we cannot be sure whether the variable is a Node.'
             )->getProcessedContent();
     }
 }

src/ContentRepository90/Rules/FusionNodeHiddenInIndexRector.php

@@ -14,20 +14,29 @@ class FusionNodeHiddenInIndexRector implements FusionRectorInterface
 
     public function getRuleDefinition(): RuleDefinition
     {
-        return CodeSampleLoader::fromFile('Fusion: Rewrite node.hiddenInIndex to node.properties._hiddenInIndex', __CLASS__);
+        return CodeSampleLoader::fromFile('Fusion: Rewrite node.hiddenInIndex to node.property(\'hiddenInIndex\')', __CLASS__);
     }
 
     public function refactorFileContent(string $fileContent): string
     {
         return EelExpressionTransformer::parse($fileContent)
             ->process(fn(string $eelExpression) => preg_replace(
                 '/(node|documentNode|site)\.hiddenInIndex/',
-                '$1.properties._hiddenInIndex',
+                '$1.property(\'hiddenInIndex\')',
                 $eelExpression
             ))
             ->addCommentsIfRegexMatches(
                 '/\.hiddenInIndex/',
-                '// TODO 9.0 migration: Line %LINE: You may need to rewrite "VARIABLE.hiddenInIndex" to VARIABLE.properties._hiddenInIndex. We did not auto-apply this migration because we cannot be sure whether the variable is a Node.'
+                '// TODO 9.0 migration: Line %LINE: You may need to rewrite "VARIABLE.hiddenInIndex" to VARIABLE.property(\'hiddenInIndex\'). We did not auto-apply this migration because we cannot be sure whether the variable is a Node.'
+            )
+            ->process(fn(string $eelExpression) => preg_replace(
+                '/([a-zA-Z.]+(node|documentNode))\.property\\(\'_hiddenInIndex\'\\)/',
+                '$1.property(\'hiddenInIndex\')',
+                $eelExpression
+            ))
+            ->addCommentsIfRegexMatches(
+                '/\.property\\(\'_hiddenInIndex\'\\)/',
+                '// TODO 9.0 migration: Line %LINE: You may need to rewrite "VARIABLE.property(\'_hiddenInIndex\')" to VARIABLE.property(\'hiddenInIndex\'). We did not auto-apply this migration because we cannot be sure whether the variable is a Node.'
             )->getProcessedContent();
     }
 }

src/ContentRepository90/Rules/FusionNodeIdentifierRector.php

@@ -28,6 +28,15 @@ public function refactorFileContent(string $fileContent): string
             ->addCommentsIfRegexMatches(
                 '/\.identifier/',
                 '// TODO 9.0 migration: Line %LINE: You may need to rewrite "VARIABLE.identifier" to VARIABLE.nodeAggregateId.value. We did not auto-apply this migration because we cannot be sure whether the variable is a Node.'
+            )
+            ->process(fn(string $eelExpression) => preg_replace(
+                '/(node|documentNode|site)\.property\\(\'_identifier\'\\)/',
+                '$1.nodeAggregateId.value',
+                $eelExpression
+            ))
+            ->addCommentsIfRegexMatches(
+                '/\.property\\(\'_identifier\'\\)/',
+                '// TODO 9.0 migration: Line %LINE: You may need to rewrite "VARIABLE.identifier" to VARIABLE.nodeAggregateId.value. We did not auto-apply this migration because we cannot be sure whether the variable is a Node.'
             )->getProcessedContent();
     }
 }

src/ContentRepository90/Rules/FusionNodePathRector.php

@@ -28,6 +28,16 @@ public function refactorFileContent(string $fileContent): string
             ->addCommentsIfRegexMatches(
                 '/\.path$/',
                 '// TODO 9.0 migration: Line %LINE: You may need to rewrite "VARIABLE.path" to Neos.Node.path(VARIABLE). We did not auto-apply this migration because we cannot be sure whether the variable is a Node.'
-            )->getProcessedContent();
+            )
+            ->process(fn(string $eelExpression) => preg_replace(
+                '/(node|documentNode|site)\.property\\(\'_path\'\\)/',
+                'Neos.Node.path($1)',
+                $eelExpression
+            ))
+            ->addCommentsIfRegexMatches(
+                '/\.property\\(\'_path\'\\)/',
+                '// TODO 9.0 migration: Line %LINE: You may need to rewrite "VARIABLE.property(\'_path\')" to Neos.Node.path(VARIABLE). We did not auto-apply this migration because we cannot be sure whether the variable is a Node.'
+            )
+            ->getProcessedContent();
     }
 }

tests/ContentRepository90/Rules/FusionNodeContextPathRector/Fixture/some_file.fusion.inc

@@ -5,7 +5,8 @@ prototype(Neos.Fusion.Form:Checkbox)  < prototype(Neos.Fusion.Form:Component.Fie
         #
         # pass down props
         #
-        attributes = ${node.contextPath || documentNode.contextPath}
+        attributes = ${node.contextPath || documentNode.contextPath || node.property('_contextPath') || documentNode.property("_contextPath")}
+        foo = ${bar.property('_contextPath') || bar.property("_contextPath")}
 
         #
         # the `checked` state is calculated outside the renderer to allow` overriding via `attributes`
@@ -30,15 +31,17 @@ prototype(Neos.Fusion.Form:Checkbox)  < prototype(Neos.Fusion.Form:Component.Fie
     }
 }
 -----
-// TODO 9.0 migration: Line 26: !! You very likely need to rewrite "VARIABLE.contextPath" to "Neos.Node.serializedNodeAddress(VARIABLE)". We did not auto-apply this migration because we cannot be sure whether the variable is a Node.
+// TODO 9.0 migration: Line 11: !! You very likely need to rewrite "VARIABLE.property('_contextPath')" to "Neos.Node.serializedNodeAddress(VARIABLE)". We did not auto-apply this migration because we cannot be sure whether the variable is a Node.
+// TODO 9.0 migration: Line 27: !! You very likely need to rewrite "VARIABLE.contextPath" to "Neos.Node.serializedNodeAddress(VARIABLE)". We did not auto-apply this migration because we cannot be sure whether the variable is a Node.
 prototype(Neos.Fusion.Form:Checkbox)  < prototype(Neos.Fusion.Form:Component.Field) {
 
     renderer = Neos.Fusion:Component {
 
         #
         # pass down props
         #
-        attributes = ${Neos.Node.serializedNodeAddress(node) || Neos.Node.serializedNodeAddress(documentNode)}
+        attributes = ${Neos.Node.serializedNodeAddress(node) || Neos.Node.serializedNodeAddress(documentNode) || Neos.Node.serializedNodeAddress(node) || Neos.Node.serializedNodeAddress(documentNode)}
+        foo = ${bar.property('_contextPath') || bar.property("_contextPath")}
 
         #
         # the `checked` state is calculated outside the renderer to allow` overriding via `attributes`

tests/ContentRepository90/Rules/FusionNodeDepthRector/Fixture/some_file.fusion.inc

@@ -5,7 +5,8 @@ prototype(Neos.Fusion.Form:Checkbox)  < prototype(Neos.Fusion.Form:Component.Fie
     #
     # pass down props
     #
-    attributes = ${node.depth || documentNode.depth}
+    attributes = ${node.depth || documentNode.depth || node.property('_depth') || documentNode.property("_depth")}
+    foo = ${bar.property('_depth') || bar.property("_depth")}
 
     #
     # the `checked` state is calculated outside the renderer to allow` overriding via `attributes`
@@ -30,15 +31,17 @@ prototype(Neos.Fusion.Form:Checkbox)  < prototype(Neos.Fusion.Form:Component.Fie
   }
 }
 -----
-// TODO 9.0 migration: Line 26: You may need to rewrite "VARIABLE.depth" to Neos.Node.depth(VARIABLE). We did not auto-apply this migration because we cannot be sure whether the variable is a Node.
+// TODO 9.0 migration: Line 11: You may need to rewrite "VARIABLE.property('_depth')" to Neos.Node.depth(VARIABLE). We did not auto-apply this migration because we cannot be sure whether the variable is a Node.
+// TODO 9.0 migration: Line 27: You may need to rewrite "VARIABLE.depth" to Neos.Node.depth(VARIABLE). We did not auto-apply this migration because we cannot be sure whether the variable is a Node.
 prototype(Neos.Fusion.Form:Checkbox)  < prototype(Neos.Fusion.Form:Component.Field) {
 
   renderer = Neos.Fusion:Component {
 
     #
     # pass down props
     #
-    attributes = ${Neos.Node.depth(node) || Neos.Node.depth(documentNode)}
+    attributes = ${Neos.Node.depth(node) || Neos.Node.depth(documentNode) || Neos.Node.depth(node) || Neos.Node.depth(documentNode)}
+    foo = ${bar.property('_depth') || bar.property("_depth")}
 
     #
     # the `checked` state is calculated outside the renderer to allow` overriding via `attributes`

tests/ContentRepository90/Rules/FusionNodeHiddenInIndexRector/Fixture/some_file.fusion.inc

@@ -30,15 +30,15 @@ prototype(Neos.Fusion.Form:Checkbox)  < prototype(Neos.Fusion.Form:Component.Fie
   }
 }
 -----
-// TODO 9.0 migration: Line 26: You may need to rewrite "VARIABLE.hiddenInIndex" to VARIABLE.properties._hiddenInIndex. We did not auto-apply this migration because we cannot be sure whether the variable is a Node.
+// TODO 9.0 migration: Line 26: You may need to rewrite "VARIABLE.hiddenInIndex" to VARIABLE.property('hiddenInIndex'). We did not auto-apply this migration because we cannot be sure whether the variable is a Node.
 prototype(Neos.Fusion.Form:Checkbox)  < prototype(Neos.Fusion.Form:Component.Field) {
 
   renderer = Neos.Fusion:Component {
 
     #
     # pass down props
     #
-    attributes = ${node.properties._hiddenInIndex || documentNode.properties._hiddenInIndex || site.properties._hiddenInIndex}
+    attributes = ${node.property('hiddenInIndex') || documentNode.property('hiddenInIndex') || site.property('hiddenInIndex')}
 
     #
     # the `checked` state is calculated outside the renderer to allow` overriding via `attributes`
@@ -54,10 +54,10 @@ prototype(Neos.Fusion.Form:Checkbox)  < prototype(Neos.Fusion.Form:Component.Fie
     renderer = afx`
       <input
         type="checkbox"
-        name={node.properties._hiddenInIndex}
+        name={node.property('hiddenInIndex')}
         value={someOtherVariable.hiddenInIndex}
         checked={props.checked}
-        {...node.properties._hiddenInIndex}
+        {...node.property('hiddenInIndex')}
       />
     `
   }