warn about deprecated type

Author: TomasVotruba

.github/workflows/code_analysis.yaml

@@ -50,7 +50,7 @@ jobs:
 
                     -
                         name: 'Finalize classes'
-                        run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run
+                        run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run --skip-file="src/PhpParser/Node/FileNode.php"
 
                     -
                         name: 'Check before/after test fixture on no-changes'

phpstan.neon

@@ -449,10 +449,11 @@ parameters:
             message: '#Only abstract classes can be extended#'
             path: rules/Php81/Rector/Array_/FirstClassCallableRector.php
 
+        - '#Method Rector\\Tests\\Issues\\FileWithoutNamespaceCompat\\Rector\\SubscribedToFileWithoutNamespaceRector\:\:refactor\(\) should return Rector\\PhpParser\\Node\\FileNode but returns Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace#'
+
         # BC layer for FileWithoutNamespace node
         - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
-
-
+        - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace extends final class Rector\\PhpParser\\Node\\FileNode#'
         -
             path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
             identifier: symplify.forbiddenExtendOfNonAbstractClass

rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

@@ -11,7 +11,6 @@
 use Rector\PhpParser\Node\FileNode;
 use Rector\Rector\AbstractRector;
 use Rector\TypeDeclaration\NodeAnalyzer\DeclareStrictTypeFinder;
-use Rector\ValueObject\Application\File;
 use Rector\ValueObject\PhpVersion;
 use Rector\VersionBonding\Contract\MinPhpVersionInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -64,14 +63,12 @@ function someFunction(int $number)
      */
     public function refactor(Node $node): ?FileNode
     {
-        //        parent::beforeTraverse($nodes);
-
-        if ($this->shouldSkipNodes($node->stmts, $this->file)) {
+        // shebang files cannot have declare strict types
+        if ($this->file->hasShebang()) {
             return null;
         }
 
-        //        /** @var Node $rootStmt */
-        //        $rootStmt = current();
+        // only add to namespaced files, as global namespace files are often included in other files
         if (! $node->isNamespaced()) {
             return null;
         }
@@ -82,13 +79,10 @@ public function refactor(Node $node): ?FileNode
             return null;
         }
 
-        //        $rectorWithLineChange = new RectorWithLineChange(self::class, $rootStmt->getStartLine());
-        //        $this->file->addRectorClassWithLine($rectorWithLineChange);
-
-        $node->stmts = array_merge([$this->nodeFactory->createDeclaresStrictType(), new Nop()], $node->stmts);
+        $declaresStrictType = $this->nodeFactory->createDeclaresStrictType();
+        $node->stmts = array_merge([$declaresStrictType, new Nop()], $node->stmts);
 
         return $node;
-        //        return [$this->nodeFactory->createDeclaresStrictType(), new Nop(), ...$nodes];
     }
 
     /**
@@ -103,21 +97,4 @@ public function provideMinPhpVersion(): int
     {
         return PhpVersion::PHP_70;
     }
-
-    /**
-     * @param Stmt[] $nodes
-     */
-    private function shouldSkipNodes(array $nodes, File $file): bool
-    {
-        if ($this->skipper->shouldSkipElementAndFilePath(self::class, $file->getFilePath())) {
-            return true;
-        }
-
-        // shebang files cannot have declare strict types
-        if (str_starts_with($file->getFileContent(), '#!')) {
-            return true;
-        }
-
-        return $nodes === [];
-    }
 }

src/Console/Command/ProcessCommand.php

@@ -179,6 +179,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $outputFormatter->report($processResult, $configuration);
 
+        // 4. Deprecations reporter
         $this->deprecatedRulesReporter->reportDeprecatedRules();
         $this->deprecatedRulesReporter->reportDeprecatedSkippedRules();
         $this->deprecatedRulesReporter->reportDeprecatedNodeTypes();

src/PhpParser/Node/CustomNode/FileWithoutNamespace.php

@@ -18,11 +18,9 @@ final class FileWithoutNamespace extends FileNode
     /**
      * @param Stmt[] $stmts
      */
-    public function __construct(
-        public array $stmts,
-        public array $attributes = []
-    ) {
-        parent::__construct($stmts, $attributes);
+    public function __construct(array $stmts)
+    {
+        parent::__construct($stmts);
     }
 
     public function getType(): string

src/PhpParser/Node/FileNode.php

@@ -20,7 +20,6 @@ class FileNode extends Stmt
      */
     public function __construct(
         public array $stmts,
-        array $attributes = []
     ) {
         $firstStmt = $stmts[0] ?? null;
         $attributes = $firstStmt instanceof Node ? $firstStmt->getAttributes() : [];

src/PhpParser/NodeTraverser/RectorNodeTraverser.php

@@ -74,11 +74,9 @@ public function getVisitorsForNode(Node $node): array
             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 ($nodeType === FileWithoutNamespace::class && $nodeClass === FileNode::class) {
+                        $this->visitorsPerNodeClass[$nodeClass][] = $visitor;
+                        continue;
                     }
 
                     if (is_a($nodeClass, $nodeType, true)) {

src/Reporting/DeprecatedRulesReporter.php

@@ -10,6 +10,8 @@
 use Rector\Contract\PhpParser\Node\StmtsAwareInterface;
 use Rector\Contract\Rector\RectorInterface;
 use Rector\PhpParser\Enum\NodeGroup;
+use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
+use Rector\PhpParser\Node\FileNode;
 use Symfony\Component\Console\Style\SymfonyStyle;
 
 final readonly class DeprecatedRulesReporter
@@ -62,6 +64,11 @@ public function reportDeprecatedNodeTypes(): void
         static $reportedClasses = [];
 
         foreach ($this->rectors as $rector) {
+            if (in_array(FileWithoutNamespace::class, $rector->getNodeTypes(), true)) {
+                $this->reportDeprecatedFileWithoutNamespace($rector);
+                continue;
+            }
+
             if (! in_array(StmtsAwareInterface::class, $rector->getNodeTypes())) {
                 continue;
             }
@@ -84,4 +91,16 @@ public function reportDeprecatedNodeTypes(): void
             ));
         }
     }
+
+    private function reportDeprecatedFileWithoutNamespace(RectorInterface $rector): void
+    {
+        $this->symfonyStyle->warning(sprintf(
+            'Node type "%s" is deprecated and will be removed. Use "%s" in the "%s" rule instead instead.%sSee %s for upgrade path',
+            FileWithoutNamespace::class,
+            FileNode::class,
+            $rector::class,
+            PHP_EOL . PHP_EOL,
+            'https://github.com/rectorphp/rector-src/blob/main/UPGRADING.md'
+        ));
+    }
 }

src/ValueObject/Application/File.php

@@ -218,4 +218,9 @@ public function getFileNode(): ?FileNode
 
         return null;
     }
+
+    public function hasShebang(): bool
+    {
+        return str_starts_with($this->getFileContent(), '#!');
+    }
 }

tests/Issues/FileWithoutNamespaceCompat/Rector/SubscribedToFileWithoutNamespaceRector.php

@@ -5,6 +5,7 @@
 namespace Rector\Tests\Issues\FileWithoutNamespaceCompat\Rector;
 
 use PhpParser\Node;
+use PhpParser\Node\Name;
 use PhpParser\Node\Stmt\Function_;
 use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
 use Rector\PhpParser\Node\FileNode;
@@ -30,7 +31,7 @@ public function refactor(Node $node): FileNode
     {
         $function = new Function_('someFunction');
         // required for PHPStan scope resolver refresh
-        $function->namespacedName = new Node\Name('someFunction');
+        $function->namespacedName = new Name('someFunction');
 
         $node->stmts[] = $function;