docs

Author: TomasVotruba

UPGRADING.md

@@ -1,6 +1,18 @@
 # Upgrading from Rector 2.2.11 to 2.2.12
 
 
+@todo
+
+* FileWithoutNamespace is deprecated, and replaced by `FileNode`
+* `beforeTraverse()` is @final, use getNodeTypes() with `FileNode::class` instead
+
+**Before**
+
+@todo
+
+
+**After**
+
 @todo
 
 

rules/CodingStyle/ClassNameImport/ShortNameResolver.php

@@ -66,7 +66,7 @@ public function resolveShortClassLikeNames(File $file): array
         $rootNode = $file->getUseImportsRootNode();
 
         // nothing to resolve
-        if (! $rootNode instanceof \PhpParser\Node) {
+        if (! $rootNode instanceof Node) {
             return [];
         }
 

src/Application/FileProcessor.php

@@ -140,27 +140,14 @@ private function parseFileAndDecorateNodes(File $file): ?SystemError
     private function printFile(File $file, Configuration $configuration, string $filePath): void
     {
         // only save to string first, no need to print to file when not needed
-        $newStmts = $file->getNewStmts();
-
-        $oldStmts = $file->getOldStmts();
-
-        // unwrap FileNode stmts to allow printing
-        if ($newStmts[0] instanceof FileNode) {
-            $newStmts = $newStmts[0]->stmts;
-        }
-
-        if ($oldStmts[0] instanceof FileNode) {
-            $oldStmts = $oldStmts[0]->stmts;
-        }
-
-        $newContent = $this->betterStandardPrinter->printFormatPreserving(
-            $newStmts,
-            $oldStmts,
+        $newFileContent = $this->betterStandardPrinter->printFormatPreserving(
+            $file->getNewStmts(),
+            $file->getOldStmts(),
             $file->getOldTokens()
         );
 
         // change file content early to make $file->hasChanged() based on new content
-        $file->changeFileContent($newContent);
+        $file->changeFileContent($newFileContent);
         if ($configuration->isDryRun()) {
             return;
         }
@@ -169,7 +156,7 @@ private function printFile(File $file, Configuration $configuration, string $fil
             return;
         }
 
-        FileSystem::write($filePath, $newContent, null);
+        FileSystem::write($filePath, $newFileContent, null);
     }
 
     private function parseFileNodes(File $file, bool $forNewestSupportedVersion = true): void
@@ -184,6 +171,7 @@ private function parseFileNodes(File $file, bool $forNewestSupportedVersion = tr
 
         // wrap in FileNode to allow file-level rules
         $oldStmts = [new FileNode($oldStmts)];
+
         $oldTokens = $stmtsAndTokens->getTokens();
 
         $newStmts = $this->nodeScopeAndMetadataDecorator->decorateNodesFromFile($file->getFilePath(), $oldStmts);

src/PhpParser/Node/FileNode.php

@@ -4,6 +4,7 @@
 
 namespace Rector\PhpParser\Node;
 
+use PhpParser\Node;
 use PhpParser\Node\Stmt;
 use PhpParser\Node\Stmt\GroupUse;
 use PhpParser\Node\Stmt\Namespace_;
@@ -21,7 +22,7 @@ public function __construct(
         public array $stmts
     ) {
         $firstStmt = $stmts[0] ?? null;
-        parent::__construct($firstStmt instanceof \PhpParser\Node ? $firstStmt->getAttributes() : []);
+        parent::__construct($firstStmt instanceof Node ? $firstStmt->getAttributes() : []);
 
         parent::__construct();
 
@@ -32,6 +33,9 @@ public function getType(): string
         return 'CustomNode_File';
     }
 
+    /**
+     * @return array<int, string>
+     */
     public function getSubNodeNames(): array
     {
         return ['stmts'];
@@ -40,15 +44,15 @@ public function getSubNodeNames(): array
     public function isNamespaced(): bool
     {
         foreach ($this->stmts as $stmt) {
-            if ($stmt instanceof Stmt\Namespace_) {
+            if ($stmt instanceof Namespace_) {
                 return true;
             }
         }
 
         return false;
     }
 
-    public function getNamespace(): ?Stmt\Namespace_
+    public function getNamespace(): ?Namespace_
     {
         /** @var Namespace_[] $namespaces */
         $namespaces = array_filter($this->stmts, static fn (Stmt $stmt): bool => $stmt instanceof Namespace_);

src/PhpParser/Printer/BetterStandardPrinter.php

@@ -66,6 +66,7 @@ public function __construct(
     public function printFormatPreserving(array $stmts, array $origStmts, array $origTokens): string
     {
         $newStmts = $this->unwrapFileNode($stmts);
+        $origStmts = $this->unwrapFileNode($origStmts);
 
         $content = parent::printFormatPreserving($newStmts, $origStmts, $origTokens);
 
@@ -519,7 +520,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);
         }

src/PostRector/Rector/ClassRenamingPostRector.php

@@ -6,7 +6,6 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Namespace_;
-use PhpParser\NodeTraverser;
 use PhpParser\NodeVisitor;
 use Rector\CodingStyle\Application\UseImportsRemover;
 use Rector\Configuration\RenamedClassesDataCollector;

src/ValueObject/Application/File.php

@@ -4,6 +4,7 @@
 
 namespace Rector\ValueObject\Application;
 
+use PhpParser\Node\Stmt\Namespace_;
 use PhpParser\Node;
 use PhpParser\Node\Stmt;
 use PhpParser\Node\Stmt\InlineHTML;
@@ -156,7 +157,7 @@ public function addRectorClassWithLine(RectorWithLineChange $rectorWithLineChang
      * This node returns top most node,
      * that includes use imports
      */
-    public function getUseImportsRootNode(): Stmt\Namespace_|FileNode|null
+    public function getUseImportsRootNode(): Namespace_|FileNode|null
     {
         if ($this->newStmts === []) {
             return null;
@@ -171,7 +172,7 @@ public function getUseImportsRootNode(): Stmt\Namespace_|FileNode|null
             // return sole Namespace, or none
             $namespaces = [];
             foreach ($firstStmt->stmts as $stmt) {
-                if ($stmt instanceof Stmt\Namespace_) {
+                if ($stmt instanceof Namespace_) {
                     $namespaces[] = $stmt;
                 }
             }