[code-quality] Add AddInstanceofAssertForNullableArgumentRector (#601)

* [code-quality] Add AddInstanceofAssertForNullableArgumentRector

* [ci-review] Rector Rectify

---------

Co-authored-by: GitHub Action <[email protected]>

Author: TomasVotruba

config/sets/phpunit-code-quality.php

@@ -101,6 +101,10 @@
 
         // avoid call on nullable object
         AddInstanceofAssertForNullableInstanceRector::class,
+
+        // enable next after testing
+        // \Rector\PHPUnit\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector::class,
+
         AssertArrayCastedObjectToAssertSameRector::class,
 
         /**

rules-tests/CodeQuality/Rector/ClassMethod/AddInstanceofAssertForNullableArgumentRector/AddInstanceofAssertForNullableArgumentRectorTest.php

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

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source\SomeClassUsedInTests;
+
+final class PassingNullableArg extends TestCase
+{
+    public function test(): void
+    {
+        $someObject = $this->getSomeObject();
+        $this->process($someObject);
+    }
+
+    private function getSomeObject(): ?SomeClassUsedInTests
+    {
+        if (mt_rand(0, 1)) {
+            return new SomeClassUsedInTests();
+        }
+
+        return null;
+    }
+
+    private function process(SomeClassUsedInTests $someObject): void
+    {
+        // non nullable required
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source\SomeClassUsedInTests;
+
+final class PassingNullableArg extends TestCase
+{
+    public function test(): void
+    {
+        $someObject = $this->getSomeObject();
+        $this->assertInstanceOf(\Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source\SomeClassUsedInTests::class, $someObject);
+        $this->process($someObject);
+    }
+
+    private function getSomeObject(): ?SomeClassUsedInTests
+    {
+        if (mt_rand(0, 1)) {
+            return new SomeClassUsedInTests();
+        }
+
+        return null;
+    }
+
+    private function process(SomeClassUsedInTests $someObject): void
+    {
+        // non nullable required
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/ClassMethod/AddInstanceofAssertForNullableArgumentRector/Fixture/skip_non_nullable_type.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source\SomeClassUsedInTests;
+
+final class SkipNonNullableType extends TestCase
+{
+    public function test(): void
+    {
+        $someObject = $this->getSomeObject();
+
+        $this->process($someObject);
+    }
+
+    private function getSomeObject(): SomeClassUsedInTests
+    {
+        return new SomeClassUsedInTests();
+    }
+
+    private function process(SomeClassUsedInTests $someObject)
+    {
+    }
+}

rules-tests/CodeQuality/Rector/ClassMethod/AddInstanceofAssertForNullableArgumentRector/Source/SomeClassUsedInTests.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source;
+
+final class SomeClassUsedInTests
+{
+    public function getSomeMethod(): int
+    {
+         return 1000;
+    }
+
+    public function getSomeNestedObject(): ?SomeNestedObject
+    {
+        return new SomeNestedObject();
+    }
+}

rules-tests/CodeQuality/Rector/ClassMethod/AddInstanceofAssertForNullableArgumentRector/Source/SomeNestedObject.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableArgumentRector\Source;
+
+final class SomeNestedObject
+{
+    public function getNumber(): int
+    {
+        return 456;
+    }
+}

rules-tests/CodeQuality/Rector/ClassMethod/AddInstanceofAssertForNullableArgumentRector/config/configured_rule.php

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

rules/CodeQuality/NodeFactory/AssertMethodCallFactory.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\CodeQuality\NodeFactory;
+
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\Expression;
+use Rector\PHPUnit\CodeQuality\ValueObject\VariableNameToType;
+
+final class AssertMethodCallFactory
+{
+    public function createAssertInstanceOf(VariableNameToType $variableNameToType): Expression
+    {
+        $args = [
+            new Arg(new ClassConstFetch(new FullyQualified($variableNameToType->getObjectType()), 'class')),
+            new Arg(new Variable($variableNameToType->getVariableName())),
+        ];
+
+        $methodCall = new MethodCall(new Variable('this'), 'assertInstanceOf', $args);
+
+        return new Expression($methodCall);
+    }
+}