[TypeDeclaration] Add BinaryOpNullableToInstanceofRector (#3631)

build/target-repository/docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 418 Rules Overview
+# 419 Rules Overview
 
 <br>
 
@@ -64,7 +64,7 @@
 
 - [Transform](#transform) (34)
 
-- [TypeDeclaration](#typedeclaration) (38)
+- [TypeDeclaration](#typedeclaration) (39)
 
 - [Visibility](#visibility) (3)
 
@@ -9533,6 +9533,26 @@ Add array shape exact types based on constant keys of array
 
 <br>
 
+### BinaryOpNullableToInstanceofRector
+
+Change && and || between nullable objects to instanceof compares
+
+- class: [`Rector\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector`](../rules/TypeDeclaration/Rector/BooleanAnd/BinaryOpNullableToInstanceofRector.php)
+
+```diff
+ function someFunction(?SomeClass $someClass)
+ {
+-    if ($someClass && $someClass->someMethod()) {
++    if ($someClass instanceof SomeClass && $someClass->someMethod()) {
+         return 'yes';
+     }
+
+     return 'no';
+ }
+```
+
+<br>
+
 ### DeclareStrictTypesRector
 
 Add declare(strict_types=1) if missing

config/set/instanceof.php

@@ -8,6 +8,7 @@
 use Rector\Config\RectorConfig;
 use Rector\DeadCode\Rector\BinaryOp\RemoveDuplicatedInstanceOfRector;
 use Rector\DeadCode\Rector\If_\RemoveDeadInstanceOfRector;
+use Rector\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector;
 use Rector\TypeDeclaration\Rector\Empty_\EmptyOnNullableObjectToInstanceOfRector;
 use Rector\TypeDeclaration\Rector\Ternary\FlipNegatedTernaryInstanceofRector;
 
@@ -20,5 +21,6 @@
         RemoveDuplicatedInstanceOfRector::class,
         RemoveDeadInstanceOfRector::class,
         FlipNegatedTernaryInstanceofRector::class,
+        BinaryOpNullableToInstanceofRector::class,
     ]);
 };

rules-tests/TypeDeclaration/Rector/BooleanAnd/BinaryOpNullableToInstanceofRector/BinaryOpNullableToInstanceofRectorTest.php

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

@@ -0,0 +1,33 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance;
+
+function binaryOr(?SomeInstance $someClass)
+{
+    if ($someClass || $someClass->someMethod()) {
+        return 'yes';
+    }
+
+    return 'no';
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance;
+
+function binaryOr(?SomeInstance $someClass)
+{
+    if ($someClass instanceof \Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance || $someClass->someMethod()) {
+        return 'yes';
+    }
+
+    return 'no';
+}
+
+?>

rules-tests/TypeDeclaration/Rector/BooleanAnd/BinaryOpNullableToInstanceofRector/Fixture/other_direciton.php.inc

@@ -0,0 +1,35 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance;
+
+function otherDirection(?SomeInstance $someClass)
+{
+    if (mt_rand(0,1) && $someClass) {
+        return $someClass->someMethod();
+
+    }
+
+    return 'no';
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance;
+
+function otherDirection(?SomeInstance $someClass)
+{
+    if (mt_rand(0,1) && $someClass instanceof \Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance) {
+        return $someClass->someMethod();
+
+    }
+
+    return 'no';
+}
+
+?>

rules-tests/TypeDeclaration/Rector/BooleanAnd/BinaryOpNullableToInstanceofRector/Fixture/some_class.php.inc

@@ -0,0 +1,33 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance;
+
+function someFunction(?SomeInstance $someClass)
+{
+    if ($someClass && $someClass->someMethod()) {
+        return 'yes';
+    }
+
+    return 'no';
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance;
+
+function someFunction(?SomeInstance $someClass)
+{
+    if ($someClass instanceof \Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance && $someClass->someMethod()) {
+        return 'yes';
+    }
+
+    return 'no';
+}
+
+?>

rules-tests/TypeDeclaration/Rector/BooleanAnd/BinaryOpNullableToInstanceofRector/Fixture/with_property.php.inc

@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance;
+
+final class WithProperty
+{
+    private ?SomeInstance $someClass;
+
+    public function run()
+    {
+        if ($this->someClass && $this->someClass->someMethod()) {
+            return 'yes';
+        }
+
+        return 'no';
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Fixture;
+
+use Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance;
+
+final class WithProperty
+{
+    private ?SomeInstance $someClass;
+
+    public function run()
+    {
+        if ($this->someClass instanceof \Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source\SomeInstance && $this->someClass->someMethod()) {
+            return 'yes';
+        }
+
+        return 'no';
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/BooleanAnd/BinaryOpNullableToInstanceofRector/Source/SomeInstance.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\Source;
+
+final class SomeInstance
+{
+    public function someMethod()
+    {
+    }
+}

rules-tests/TypeDeclaration/Rector/BooleanAnd/BinaryOpNullableToInstanceofRector/config/configured_rule.php

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

rules/TypeDeclaration/Rector/BooleanAnd/BinaryOpNullableToInstanceofRector.php

@@ -0,0 +1,103 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypeDeclaration\Rector\BooleanAnd;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\BinaryOp\BooleanAnd;
+use PhpParser\Node\Expr\BinaryOp\BooleanOr;
+use PhpParser\Node\Expr\Instanceof_;
+use PhpParser\Node\Name\FullyQualified;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\TypeCombinator;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector\BinaryOpNullableToInstanceofRectorTest
+ */
+final class BinaryOpNullableToInstanceofRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Change && and || between nullable objects to instanceof compares', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+function someFunction(?SomeClass $someClass)
+{
+    if ($someClass && $someClass->someMethod()) {
+        return 'yes';
+    }
+
+    return 'no';
+}
+CODE_SAMPLE
+
+                ,
+                <<<'CODE_SAMPLE'
+function someFunction(?SomeClass $someClass)
+{
+    if ($someClass instanceof SomeClass && $someClass->someMethod()) {
+        return 'yes';
+    }
+
+    return 'no';
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [BooleanAnd::class, BooleanOr::class];
+    }
+
+    /**
+     * @param BooleanAnd|BooleanOr $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        $nullableObjectType = $this->returnNullableObjectType($node->left);
+
+        if ($nullableObjectType instanceof ObjectType) {
+            $node->left = $this->createExprInstanceof($node->left, $nullableObjectType);
+
+            return $node;
+        }
+
+        $nullableObjectType = $this->returnNullableObjectType($node->right);
+
+        if ($nullableObjectType instanceof ObjectType) {
+            $node->right = $this->createExprInstanceof($node->right, $nullableObjectType);
+
+            return $node;
+        }
+
+        return null;
+    }
+
+    private function returnNullableObjectType(Expr $expr): ObjectType|null
+    {
+        $exprType = $this->getType($expr);
+
+        $baseType = TypeCombinator::removeNull($exprType);
+        if (! $baseType instanceof ObjectType) {
+            return null;
+        }
+
+        return $baseType;
+    }
+
+    private function createExprInstanceof(Expr $expr, ObjectType $objectType): Instanceof_
+    {
+        $fullyQualified = new FullyQualified($objectType->getClassName());
+        return new Instanceof_($expr, $fullyQualified);
+    }
+}

utils/Command/MissingInSetCommand.php

@@ -13,6 +13,7 @@
 use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
 use Rector\Core\Contract\Rector\DeprecatedRectorInterface;
 use Rector\DeadCode\Rector\StmtsAwareInterface\RemoveJustPropertyFetchRector;
+use Rector\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\FalseReturnClassMethodToNullableRector;
 use Rector\TypeDeclaration\Rector\StmtsAwareInterface\DeclareStrictTypesRector;
 use Rector\TypeDeclaration\Rector\Ternary\FlipNegatedTernaryInstanceofRector;
@@ -49,6 +50,7 @@ final class MissingInSetCommand extends Command
         // optional
         DataProviderArrayItemsNewlinedRector::class,
         FlipNegatedTernaryInstanceofRector::class,
+        BinaryOpNullableToInstanceofRector::class,
     ];
 
     /**