[dx] warn about deprecated beforeTraverse() method once FileNode is ready

Author: TomasVotruba

composer-dependency-analyser.php

@@ -17,6 +17,8 @@
     // ensure use version ^3.2.0
     ->ignoreErrorsOnPackage('composer/pcre', [ErrorType::UNUSED_DEPENDENCY])
 
+    ->ignoreErrorsOnPath(__DIR__ . '/src/Reporting/DeprecatedRulesReporter.php', [ErrorType::UNKNOWN_CLASS])
+
     ->ignoreErrorsOnPaths([
         __DIR__ . '/stubs',
         __DIR__ . '/tests',

phpstan.neon

@@ -160,6 +160,8 @@ parameters:
                 - src/Validation/RectorConfigValidator.php
                 # for phpunit version check
                 - src/Testing/PHPUnit/AbstractLazyTestCase.php
+                # future node class exists check
+                - src/Reporting/DeprecatedRulesReporter.php
 
         # use of internal phpstan classes
         -

src/Console/Command/ProcessCommand.php

@@ -182,6 +182,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $this->deprecatedRulesReporter->reportDeprecatedRules();
         $this->deprecatedRulesReporter->reportDeprecatedSkippedRules();
         $this->deprecatedRulesReporter->reportDeprecatedNodeTypes();
+        $this->deprecatedRulesReporter->reportDeprecatedRectorUnsupportedMethods();
 
         $this->missConfigurationReporter->reportSkippedNeverRegisteredRules();
 

src/Reporting/DeprecatedRulesReporter.php

@@ -4,12 +4,14 @@
 
 namespace Rector\Reporting;
 
+use Rector\PhpParserNode\FileNode;
 use Rector\Configuration\Deprecation\Contract\DeprecatedInterface;
 use Rector\Configuration\Option;
 use Rector\Configuration\Parameter\SimpleParameterProvider;
 use Rector\Contract\PhpParser\Node\StmtsAwareInterface;
 use Rector\Contract\Rector\RectorInterface;
 use Rector\PhpParser\Enum\NodeGroup;
+use ReflectionMethod;
 use Symfony\Component\Console\Style\SymfonyStyle;
 
 final readonly class DeprecatedRulesReporter
@@ -56,6 +58,25 @@ public function reportDeprecatedSkippedRules(): void
         }
     }
 
+    public function reportDeprecatedRectorUnsupportedMethods(): void
+    {
+        // to be added in related PR
+        if (! class_exists(FileNode::class)) {
+            return;
+        }
+
+        foreach ($this->rectors as $rector) {
+            $beforeTraverseMethodReflection = new ReflectionMethod($rector, 'beforeTraverse');
+            if ($beforeTraverseMethodReflection->getDeclaringClass()->getName() === $rector::class) {
+                $this->symfonyStyle->warning(sprintf(
+                    'Rector rule "%s" uses deprecated "beforeTraverse" method. It should not be used, as will be marked as final. Not part of RectorInterface contract. Use "%s" to hook into file-level changes instead.',
+                    $rector::class,
+                    FileNode::class
+                ));
+            }
+        }
+    }
+
     public function reportDeprecatedNodeTypes(): void
     {
         // helper property to avoid reporting multiple times