[Php85] Replace null return with empty array in __debugInfo

Author: mttsch

config/set/php85.php

@@ -4,14 +4,15 @@
 
 use Rector\Config\RectorConfig;
 use Rector\Php85\Rector\ArrayDimFetch\ArrayFirstLastRector;
+use Rector\Php85\Rector\ClassMethod\NullDebugInfoReturnRector;
 use Rector\Removing\Rector\FuncCall\RemoveFuncCallArgRector;
 use Rector\Removing\ValueObject\RemoveFuncCallArg;
 use Rector\Renaming\Rector\FuncCall\RenameFunctionRector;
 use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
 use Rector\Renaming\ValueObject\MethodCallRename;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->rules([ArrayFirstLastRector::class]);
+    $rectorConfig->rules([ArrayFirstLastRector::class, NullDebugInfoReturnRector::class]);
 
     $rectorConfig->ruleWithConfiguration(
         RemoveFuncCallArgRector::class,

rules-tests/Php85/Rector/MethodCall/NullDebugInfoReturnRector/Fixture/explicit_null_return.php.inc

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php85\Rector\MethodCall\NullDebugInfoReturnRector\Fixture;
+
+final class ExplicitNullReturn
+{
+    public function __debugInfo(): ?array
+    {
+        return null;
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php85\Rector\MethodCall\NullDebugInfoReturnRector\Fixture;
+
+final class ExplicitNullReturn
+{
+    public function __debugInfo(): ?array
+    {
+        return [];
+    }
+}
+
+?>

rules-tests/Php85/Rector/MethodCall/NullDebugInfoReturnRector/Fixture/implicit_null_return.php.inc

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php85\Rector\MethodCall\NullDebugInfoReturnRector\Fixture;
+
+final class ImplicitNullReturn
+{
+    public function __debugInfo(): ?array
+    {
+        return;
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php85\Rector\MethodCall\NullDebugInfoReturnRector\Fixture;
+
+final class ImplicitNullReturn
+{
+    public function __debugInfo(): ?array
+    {
+        return [];
+    }
+}
+
+?>

rules-tests/Php85/Rector/MethodCall/NullDebugInfoReturnRector/Fixture/skip_different_method.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php85\Rector\MethodCall\NullDebugInfoReturnRector\Fixture;
+
+final class SkipDifferentMethod
+{
+    public function differentMethod()
+    {
+        return null;
+    }
+}
+
+?>

rules-tests/Php85/Rector/MethodCall/NullDebugInfoReturnRector/NullDebugInfoReturnRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php85\Rector\MethodCall\NullDebugInfoReturnRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class NullDebugInfoReturnRectorTest 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';
+    }
+}

rules-tests/Php85/Rector/MethodCall/NullDebugInfoReturnRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Php85\Rector\ClassMethod\NullDebugInfoReturnRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(NullDebugInfoReturnRector::class);
+};

rules/Php85/Rector/ClassMethod/NullDebugInfoReturnRector.php

@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Php85\Rector\ClassMethod;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\Array_;
+use PhpParser\Node\Expr\Closure;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Function_;
+use PhpParser\Node\Stmt\Return_;
+use PhpParser\NodeVisitor;
+use Rector\PhpParser\Node\Value\ValueResolver;
+use Rector\Rector\AbstractRector;
+use Rector\ValueObject\PhpVersionFeature;
+use Rector\VersionBonding\Contract\MinPhpVersionInterface;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see https://wiki.php.net/rfc/deprecations_php_8_5#deprecate_debuginfo_returning_null
+ * @see \Rector\Tests\Php85\Rector\MethodCall\NullDebugInfoReturnRector\NullDebugInfoReturnRectorTest
+ */
+final class NullDebugInfoReturnRector extends AbstractRector implements MinPhpVersionInterface
+{
+    public function __construct(
+        private readonly ValueResolver $valueResolver,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Replaces `null` return value with empty array in `__debugInfo` methods', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+new class
+{
+    public function __debugInfo() {
+        return null;
+    }
+};
+CODE_SAMPLE
+
+                ,
+                <<<'CODE_SAMPLE'
+new class
+{
+    public function __debugInfo() {
+        return [];
+    }
+};
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [ClassMethod::class];
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->isName($node, '__debugInfo')) {
+            return null;
+        }
+
+        $hasChanged = \false;
+        $this->traverseNodesWithCallable((array) $node->stmts, function (Node $node) use (&$hasChanged) {
+            if ($node instanceof Class_ || $node instanceof Function_ || $node instanceof Closure) {
+                return NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN;
+            }
+
+            if ($node instanceof Return_ && (! $node->expr instanceof Expr || $this->valueResolver->isNull(
+                $node->expr
+            ))) {
+                $hasChanged = \true;
+                $node->expr = new Array_();
+                return $node;
+            }
+
+            return null;
+        });
+
+        if ($hasChanged) {
+            return $node;
+        }
+
+        return null;
+    }
+
+    public function provideMinPhpVersion(): int
+    {
+        return PhpVersionFeature::DEPRECATED_NULL_DEBUG_INFO_RETURN;
+    }
+}

src/ValueObject/PhpVersionFeature.php

@@ -768,4 +768,10 @@ final class PhpVersionFeature
      * @var int
      */
     public const ARRAY_ANY = PhpVersion::PHP_84;
+
+    /**
+     * @see https://wiki.php.net/rfc/deprecations_php_8_5#deprecate_debuginfo_returning_null
+     * @var int
+     */
+    public const DEPRECATED_NULL_DEBUG_INFO_RETURN = PhpVersion::PHP_85;
 }