Merge pull request #242 from andreaswolf/never-return-array

[TASK] NodeVisitor::enterNode and traverseNode will never return an array

Author: simonschaufi

packages/fractor-typoscript/src/AbstractTypoScriptFractor.php

@@ -23,10 +23,7 @@ final public function beforeTraversal(File $file, array $statements): void
         $this->file = $file;
     }
 
-    /**
-     * @return Statement|list<Statement>|int
-     */
-    final public function enterNode(Statement $node): Statement|array|int
+    final public function enterNode(Statement $node): Statement|int
     {
         $result = $this->refactor($node);
 

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

@@ -5,7 +5,6 @@
 namespace a9f\FractorTypoScript\Contract;
 
 use a9f\Fractor\Application\ValueObject\File;
-use a9f\FractorTypoScript\TypoScriptStatementsIterator;
 use Helmich\TypoScriptParser\Parser\AST\Statement;
 
 /**
@@ -18,10 +17,7 @@ interface TypoScriptNodeVisitor
      */
     public function beforeTraversal(File $file, array $statements): void;
 
-    /**
-     * @return Statement|list<Statement>|TypoScriptStatementsIterator::*
-     */
-    public function enterNode(Statement $node): Statement|array|int;
+    public function enterNode(Statement $node): Statement|int;
 
     public function leaveNode(Statement $node): void;
 

packages/fractor-typoscript/src/TypoScriptStatementsIterator.php

@@ -26,9 +26,8 @@
     /**
      * @param list<TypoScriptNodeVisitor> $visitors
      */
-    public function __construct(
-        iterable $visitors
-    ) {
+    public function __construct(iterable $visitors)
+    {
         $visitors = iterator_to_array($visitors);
         Assert::allIsInstanceOf($visitors, TypoScriptNodeVisitor::class);
         $this->visitors = $visitors;
@@ -63,19 +62,14 @@ private function processStatementList(array $statements): array
         foreach ($statements as $statement) {
             $result = $this->traverseNode($statement);
 
-            if (is_array($result)) {
-                $resultingStatements[] = $result;
-            } elseif ($result instanceof Statement) {
+            if ($result instanceof Statement) {
                 $resultingStatements[] = [$result];
             }
         }
         return array_merge(...$resultingStatements);
     }
 
-    /**
-     * @return self::*|Statement|list<Statement>
-     */
-    private function traverseNode(Statement $node): int|Statement|array
+    private function traverseNode(Statement $node): int|Statement
     {
         $lastCalledVisitor = null;
         $result = $node;

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

@@ -27,7 +27,7 @@ public function beforeTraversal(File $file, array $statements): void
         $this->calls[] = sprintf('%s:beforeTraversal:%s', $this->visitorName, count($statements));
     }
 
-    public function enterNode(Statement $node): Statement|array|int
+    public function enterNode(Statement $node): Statement|int
     {
         $this->calls[] = sprintf('%s:enterNode:%s:l-%d', $this->visitorName, $node::class, $node->sourceLine);
         return $node;