[FEATURE] Add traverseStatementsWithCallable

Author: simonschaufi

packages/fractor-typoscript/src/AbstractTypoScriptFractor.php

@@ -7,6 +7,7 @@
 use a9f\Fractor\Application\ValueObject\AppliedRule;
 use a9f\Fractor\Application\ValueObject\File;
 use a9f\FractorTypoScript\Contract\TypoScriptFractor;
+use a9f\FractorTypoScript\NodeTraverser\SimpleCallableStatementTraverser;
 use Helmich\TypoScriptParser\Parser\AST\Statement;
 
 abstract class AbstractTypoScriptFractor implements TypoScriptFractor
@@ -15,6 +16,11 @@ abstract class AbstractTypoScriptFractor implements TypoScriptFractor
 
     protected bool $hasChanged = false;
 
+    public function __construct(
+        private readonly SimpleCallableStatementTraverser $simpleCallableStatementTraverser
+    ) {
+    }
+
     /**
      * @param list<Statement> $statements
      */
@@ -23,7 +29,7 @@ final public function beforeTraversal(File $file, array $statements): void
         $this->file = $file;
     }
 
-    final public function enterNode(Statement $node): Statement|int
+    final public function enterNode(Statement $node): Statement|int|null
     {
         $result = $this->refactor($node);
 
@@ -37,8 +43,9 @@ final public function enterNode(Statement $node): Statement|int
         return $result;
     }
 
-    final public function leaveNode(Statement $node): void
+    final public function leaveNode(Statement $node): int|Statement|null
     {
+        return null;
     }
 
     /**
@@ -47,4 +54,9 @@ final public function leaveNode(Statement $node): void
     final public function afterTraversal(array $statements): void
     {
     }
+
+    protected function traverseStatementsWithCallable(?Statement $statement, callable $callable): void
+    {
+        $this->simpleCallableStatementTraverser->traverseNodesWithCallable($statement, $callable);
+    }
 }

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

@@ -17,9 +17,9 @@ interface TypoScriptNodeVisitor
      */
     public function beforeTraversal(File $file, array $statements): void;
 
-    public function enterNode(Statement $node): Statement|int;
+    public function enterNode(Statement $node): Statement|int|null;
 
-    public function leaveNode(Statement $node): void;
+    public function leaveNode(Statement $node): Statement|int|null;
 
     /**
      * @param list<Statement> $statements

packages/fractor-typoscript/src/NodeTraverser/SimpleCallableStatementTraverser.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorTypoScript\NodeTraverser;
+
+use a9f\Fractor\Application\ValueObject\File;
+use a9f\FractorTypoScript\NodeVisitor\CallableStatementVisitor;
+use a9f\FractorTypoScript\TypoScriptStatementsIterator;
+use Helmich\TypoScriptParser\Parser\AST\Statement;
+
+final class SimpleCallableStatementTraverser
+{
+    public function traverseNodesWithCallable(?Statement $statement, callable $callable): void
+    {
+        if ($statement === null) {
+            return;
+        }
+        $callableStatementVisitor = new CallableStatementVisitor($callable);
+
+        $nodeTraverser = new TypoScriptStatementsIterator([$callableStatementVisitor]);
+        $nodeTraverser->traverseDocument(new File('', ''), [$statement]);
+    }
+}

packages/fractor-typoscript/src/NodeVisitor/CallableStatementVisitor.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorTypoScript\NodeVisitor;
+
+use a9f\FractorTypoScript\TypoScriptStatementsIterator;
+use Helmich\TypoScriptParser\Parser\AST\Statement;
+
+final class CallableStatementVisitor extends StatementVisitorAbstract
+{
+    /**
+     * @var callable(Statement): (Statement|int|null)
+     */
+    private $callable;
+
+    private ?int $statementIdToRemove = null;
+
+    public function __construct(callable $callable)
+    {
+        $this->callable = $callable;
+    }
+
+    public function enterNode(Statement $node): int|null|Statement
+    {
+        $originalStatement = $node;
+        $callable = $this->callable;
+        /** @var int|Statement|null $newStatement */
+        $newStatement = $callable($node);
+        if ($newStatement === TypoScriptStatementsIterator::REMOVE_NODE) {
+            $this->statementIdToRemove = \spl_object_id($originalStatement);
+            return $originalStatement;
+        }
+        return $newStatement;
+    }
+
+    public function leaveNode(Statement $node): int|Statement
+    {
+        if ($this->statementIdToRemove !== null && $this->statementIdToRemove === \spl_object_id($node)) {
+            $this->statementIdToRemove = null;
+            return TypoScriptStatementsIterator::REMOVE_NODE;
+        }
+        return $node;
+    }
+}

packages/fractor-typoscript/src/NodeVisitor/StatementVisitorAbstract.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorTypoScript\NodeVisitor;
+
+use a9f\Fractor\Application\ValueObject\File;
+use a9f\FractorTypoScript\Contract\TypoScriptNodeVisitor;
+use Helmich\TypoScriptParser\Parser\AST\Statement;
+
+abstract class StatementVisitorAbstract implements TypoScriptNodeVisitor
+{
+    public function beforeTraversal(File $file, array $statements): void
+    {
+    }
+
+    public function enterNode(Statement $node): int|null|Statement
+    {
+        return null;
+    }
+
+    public function leaveNode(Statement $node): int|null|Statement
+    {
+        return null;
+    }
+
+    public function afterTraversal(array $statements): void
+    {
+    }
+}

packages/fractor-typoscript/src/TypoScriptStatementsIterator.php

@@ -69,7 +69,7 @@ private function processStatementList(array $statements): array
         return array_merge(...$resultingStatements);
     }
 
-    private function traverseNode(Statement $node): int|Statement
+    private function traverseNode(Statement $node): int|Statement|null
     {
         $lastCalledVisitor = null;
         $result = $node;

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

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