add node matching support for FileWithoutNamespace

Author: TomasVotruba

composer.json

@@ -28,9 +28,9 @@
         "react/promise": "^3.3",
         "react/socket": "^1.17",
         "rector/extension-installer": "^0.11.2",
-        "rector/rector-doctrine": "dev-tv-file-node",
-        "rector/rector-downgrade-php": "dev-tv-file-node",
-        "rector/rector-phpunit": "dev-tv-file-node",
+        "rector/rector-doctrine": "dev-main",
+        "rector/rector-downgrade-php": "dev-main",
+        "rector/rector-phpunit": "dev-main",
         "rector/rector-symfony": "dev-main",
         "sebastian/diff": "^6.0",
         "symfony/console": "^6.4.24",

phpstan.neon

@@ -189,8 +189,10 @@ parameters:
             message: '#Method Rector\\Util\\ArrayParametersMerger\:\:mergeLeftToRightWithCallable\(\) has parameter \$mergeCallback with no signature specified for callable#'
             path: src/Util/ArrayParametersMerger.php
 
-        # fixture class
-        - '#Class "Rector\\Tests\\Issues\\ScopeNotAvailable\\Variable\\ArrayItemForeachValueRector" is missing @see annotation with test case class reference#'
+        # fixture Rector rules
+        -
+            identifier:  symplify.seeAnnotationToTest
+            path: tests/Issues/
 
         # classes are part of *.php.inc fixture
         -
@@ -410,6 +412,16 @@ parameters:
             paths:
                 - rules/Transform/ValueObject/ClassMethodReference.php
                 - rules/CodeQuality/ValueObject/KeyAndExpr.php
+        -
+            identifier: symplify.forbiddenExtendOfNonAbstractClass
+            path: src/PhpParser/Node/FileNode.php
+        -
+            identifier: method.deprecatedClass
+            path: src/PhpParser/Node/FileNode.php
+
+        -
+            identifier: class.extendsDeprecatedClass
+            path: src/PhpParser/Node/FileNode.php
 
         -
             identifier: public.classConstant.unused
@@ -428,6 +440,21 @@ parameters:
         - '#Register "Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector" service to "php81\.php" config set#'
         - '#Class "Rector\\CodingStyle\\Rector\\String_\\SymplifyQuoteEscapeRector" is missing @see annotation with test case class reference#'
         - '#Access to constant on deprecated class Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector#'
+
+        # BC layer for FileWithoutNamespace node
+        - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
+        - '#BC layer for FileNode and FileWithoutNamespace compat, use FileNode instead#'
+        -
+            path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
+            identifier: symplify.forbiddenExtendOfNonAbstractClass
         -
             message: '#Only abstract classes can be extended#'
             path: rules/Php81/Rector/Array_/FirstClassCallableRector.php
+
+        # BC layer for FileWithoutNamespace node
+        - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
+
+
+        -
+            path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
+            identifier: symplify.forbiddenExtendOfNonAbstractClass

src/Application/FileProcessor.php

@@ -58,6 +58,7 @@ public function processFile(File $file, Configuration $configuration): FileProce
         do {
             $file->changeHasChanged(false);
 
+            // 1. change nodes with Rector Rules
             $newStmts = $this->rectorNodeTraverser->traverse($file->getNewStmts());
 
             // 2. apply post rectors

src/PhpParser/Node/CustomNode/FileWithoutNamespace.php

@@ -5,23 +5,24 @@
 namespace Rector\PhpParser\Node\CustomNode;
 
 use PhpParser\Node\Stmt;
-use Rector\Contract\PhpParser\Node\StmtsAwareInterface;
+use Rector\PhpParser\Node\FileNode;
 
 /**
  * @deprecated Use @see \Rector\PhpParser\Node\FileNode instead
  * @api
  *
  * Inspired by https://github.com/phpstan/phpstan-src/commit/ed81c3ad0b9877e6122c79b4afda9d10f3994092
  */
-final class FileWithoutNamespace extends Stmt implements StmtsAwareInterface
+final class FileWithoutNamespace extends FileNode
 {
     /**
      * @param Stmt[] $stmts
      */
     public function __construct(
-        public array $stmts
+        public array $stmts,
+        public array $attributes = []
     ) {
-        parent::__construct();
+        parent::__construct($stmts, $attributes);
     }
 
     public function getType(): string

src/PhpParser/Node/FileNode.php

@@ -13,19 +13,19 @@
 /**
  * Inspired by https://github.com/phpstan/phpstan-src/commit/ed81c3ad0b9877e6122c79b4afda9d10f3994092
  */
-final class FileNode extends Stmt
+class FileNode extends Stmt
 {
     /**
      * @param Stmt[] $stmts
      */
     public function __construct(
-        public array $stmts
+        public array $stmts,
+        array $attributes = []
     ) {
         $firstStmt = $stmts[0] ?? null;
-        parent::__construct($firstStmt instanceof Node ? $firstStmt->getAttributes() : []);
-
-        parent::__construct();
+        $attributes = $firstStmt instanceof Node ? $firstStmt->getAttributes() : [];
 
+        parent::__construct($attributes);
     }
 
     /**

src/PhpParser/NodeTraverser/RectorNodeTraverser.php

@@ -9,6 +9,8 @@
 use PhpParser\NodeVisitor;
 use Rector\Configuration\ConfigurationRuleFilter;
 use Rector\Contract\Rector\RectorInterface;
+use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
+use Rector\PhpParser\Node\FileNode;
 use Rector\VersionBonding\PhpVersionedFilter;
 
 /**
@@ -71,6 +73,14 @@ public function getVisitorsForNode(Node $node): array
             /** @var RectorInterface $visitor */
             foreach ($this->visitors as $visitor) {
                 foreach ($visitor->getNodeTypes() as $nodeType) {
+                    // BC layer matching
+                    if ($nodeType === FileWithoutNamespace::class) {
+                        if ($nodeClass === FileNode::class) {
+                            $this->visitorsPerNodeClass[$nodeClass][] = $visitor;
+                            continue;
+                        }
+                    }
+
                     if (is_a($nodeClass, $nodeType, true)) {
                         $this->visitorsPerNodeClass[$nodeClass][] = $visitor;
                         continue 2;

src/PhpParser/Printer/BetterStandardPrinter.php

@@ -524,7 +524,6 @@ private function getIndentCharacter(): string
      */
     private function unwrapFileNode(array $stmts): array
     {
-        //        $stmts = array_values($stmts);
         if (count($stmts) === 1 && $stmts[0] instanceof FileNode) {
             return array_values($stmts[0]->stmts);
         }

tests/Issues/FileWithoutNamespaceCompat/FileWithoutNamespaceCompatTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Issues\FileWithoutNamespaceCompat;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class FileWithoutNamespaceCompatTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

tests/Issues/FileWithoutNamespaceCompat/Fixture/namespace_less_file.php.inc

@@ -0,0 +1,16 @@
+<?php
+
+final class NamespaceLessFiles
+{
+}
+
+?>
+-----
+<?php
+
+final class NamespaceLessFiles
+{
+}
+function someFunction()
+{
+}

tests/Issues/FileWithoutNamespaceCompat/Rector/SubscribedToFileWithoutNamespaceRector.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Issues\FileWithoutNamespaceCompat\Rector;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Function_;
+use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
+use Rector\PhpParser\Node\FileNode;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class SubscribedToFileWithoutNamespaceRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Adds a function to FileWithoutNamespace nodes', []);
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [FileWithoutNamespace::class];
+    }
+
+    /**
+     * @param FileWithoutNamespace $node
+     */
+    public function refactor(Node $node): FileNode
+    {
+        $function = new Function_('someFunction');
+        // required for PHPStan scope resolver refresh
+        $function->namespacedName = new Node\Name('someFunction');
+
+        $node->stmts[] = $function;
+
+        return $node;
+    }
+}