[BUGFIX] Handle newly returned TypoScript Statements (#356)

Resolves: #322

Author: simonschaufi

packages/fractor-typoscript/src/AbstractTypoScriptFractor.php

@@ -38,8 +38,9 @@ final public function enterNode(Statement $node): Statement|array|int
         return $result;
     }
 
-    final public function leaveNode(Statement $node): void
+    final public function leaveNode(Statement $node): ?Statement
     {
+        return null;
     }
 
     /**

packages/fractor-typoscript/src/Contract/TypoScriptNodeVisitor.php

@@ -22,7 +22,7 @@ public function beforeTraversal(File $file, array $statements): void;
      */
     public function enterNode(Statement $node): Statement|array|int;
 
-    public function leaveNode(Statement $node): void;
+    public function leaveNode(Statement $node): ?Statement;
 
     /**
      * @param Statement[] $statements

packages/fractor-typoscript/src/TypoScriptStatementsIterator.php

@@ -77,29 +77,53 @@ private function processStatementList(array $statements): array
     private function traverseNode(Statement $node): int|Statement|array
     {
         $lastCalledVisitor = null;
-        $result = $node;
+        $command = null;
+
         foreach ($this->visitors as $visitor) {
-            $result = $visitor->enterNode($node);
+            $return = $visitor->enterNode($node);
+
+            if ($return instanceof Statement) {
+                $node = $return;
+                continue;
+            }
 
-            if (is_int($result)) {
+            if (is_array($return)) {
+                return $return;
+            }
+
+            if ($return === self::REMOVE_NODE) {
+                $command = self::REMOVE_NODE;
                 $lastCalledVisitor = $visitor;
                 break;
             }
         }
 
-        if ($node instanceof ConditionalStatement) {
-            $node->ifStatements = $this->processStatementList($node->ifStatements);
-            $node->elseStatements = $this->processStatementList($node->elseStatements);
-        } elseif ($node instanceof NestedAssignment) {
-            $node->statements = $this->processStatementList($node->statements);
+        if ($command !== self::REMOVE_NODE) {
+            if ($node instanceof ConditionalStatement) {
+                $node->ifStatements = $this->processStatementList($node->ifStatements);
+                $node->elseStatements = $this->processStatementList($node->elseStatements);
+            } elseif ($node instanceof NestedAssignment) {
+                $node->statements = $this->processStatementList($node->statements);
+            }
         }
 
         foreach ($this->visitors as $visitor) {
             if ($lastCalledVisitor === $visitor) {
                 break;
             }
-            $visitor->leaveNode($node);
+
+            $return = $visitor->leaveNode($node);
+            if ($return === null) {
+                continue;
+            }
+
+            $node = $return;
         }
-        return $result;
+
+        if ($command === self::REMOVE_NODE) {
+            return self::REMOVE_NODE;
+        }
+
+        return $node;
     }
 }

packages/fractor-typoscript/tests/TypoScriptStatementsIterator/Fixture/StatementCollectingVisitor.php

@@ -33,9 +33,10 @@ public function enterNode(Statement $node): Statement
         return $node;
     }
 
-    public function leaveNode(Statement $node): void
+    public function leaveNode(Statement $node): Statement
     {
         $this->calls[] = sprintf('%s:leaveNode:%s:l-%d', $this->visitorName, $node::class, $node->sourceLine);
+        return $node;
     }
 
     /**

packages/typo3-fractor/rules/TYPO3v13/TypoScript/MigrateIncludeTypoScriptSyntaxFractor.php

@@ -133,6 +133,14 @@ public function refactor(Statement $statement): null|Statement
 
     private function shouldSkip(Statement $statement): bool
     {
-        return ! $statement instanceof FileIncludeStatement && ! $statement instanceof DirectoryIncludeStatement;
+        if (! $statement instanceof FileIncludeStatement && ! $statement instanceof DirectoryIncludeStatement) {
+            return true;
+        }
+
+        if ($statement instanceof FileIncludeStatement && $statement->newSyntax === true) {
+            return true;
+        }
+
+        return false;
     }
 }