[DowngradePhp80] Add DowngradeInstanceofStringableRector (#275)

* [DowngradePhp80] Add DowngradeInstanceofStringableRector

* fix

* fix

* rectify

Author: samsonasik

config/set/downgrade-php80.php

@@ -25,6 +25,7 @@
 use Rector\DowngradePhp80\Rector\FuncCall\DowngradeStrStartsWithRector;
 use Rector\DowngradePhp80\Rector\FunctionLike\DowngradeMixedTypeDeclarationRector;
 use Rector\DowngradePhp80\Rector\FunctionLike\DowngradeUnionTypeDeclarationRector;
+use Rector\DowngradePhp80\Rector\Instanceof_\DowngradeInstanceofStringableRector;
 use Rector\DowngradePhp80\Rector\Instanceof_\DowngradePhp80ResourceReturnToObjectRector;
 use Rector\DowngradePhp80\Rector\MethodCall\DowngradeNamedArgumentRector;
 use Rector\DowngradePhp80\Rector\MethodCall\DowngradeReflectionClassGetConstantsFilterRector;
@@ -89,5 +90,6 @@
         DowngradeMixedTypeTypedPropertyRector::class,
         RemoveReturnTypeDeclarationFromCloneRector::class,
         DowngradeEnumToConstantListClassRector::class,
+        DowngradeInstanceofStringableRector::class,
     ]);
 };

rules-tests/DowngradePhp80/Rector/Instanceof_/DowngradeInstanceofStringableRector/DowngradeInstanceofStringableRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DowngradePhp80\Rector\Instanceof_\DowngradeInstanceofStringableRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class DowngradeInstanceofStringableRectorTest 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/DowngradePhp80/Rector/Instanceof_/DowngradeInstanceofStringableRector/Fixture/fixture.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\DowngradePhp80\Rector\Instanceof_\DowngradeInstanceofStringableRector\Fixture;
+
+class Fixture
+{
+    public function run($obj)
+    {
+        return $obj instanceof \Stringable;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DowngradePhp80\Rector\Instanceof_\DowngradeInstanceofStringableRector\Fixture;
+
+class Fixture
+{
+    public function run($obj)
+    {
+        return method_exists($obj, '__toString');
+    }
+}
+
+?>

rules-tests/DowngradePhp80/Rector/Instanceof_/DowngradeInstanceofStringableRector/Fixture/skip_different_object.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\DowngradePhp80\Rector\Instanceof_\DowngradeInstanceofStringableRector\Fixture;
+
+class SkipDifferentObject
+{
+    public function run($obj)
+    {
+        return $obj instanceof \stdClass;
+    }
+}

rules-tests/DowngradePhp80/Rector/Instanceof_/DowngradeInstanceofStringableRector/config/configured_rule.php

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

rules/DowngradePhp80/Rector/Instanceof_/DowngradeInstanceofStringableRector.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\DowngradePhp80\Rector\Instanceof_;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Instanceof_;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Scalar\String_;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see https://wiki.php.net/rfc/stringable
+ * @see \Rector\Tests\DowngradePhp80\Rector\Instanceof_\DowngradeInstanceofStringableRector\DowngradeInstanceofStringableRectorTest
+ */
+final class DowngradeInstanceofStringableRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('change instanceof Stringable to method_exists', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+$obj instanceof \Stringable;
+CODE_SAMPLE
+
+                ,
+                <<<'CODE_SAMPLE'
+method_exists($obj, '__toString');
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Instanceof_::class];
+    }
+
+    /**
+     * @param Instanceof_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $node->class instanceof FullyQualified) {
+            return null;
+        }
+
+        if (! $this->isName($node->class, 'Stringable')) {
+            return null;
+        }
+
+        return $this->nodeFactory->createFuncCall('method_exists', [$node->expr, new String_('__toString')]);
+    }
+}