[typed-collections] Add AssertNullOnCollectionToAssertEmptyRector (#423)

Author: TomasVotruba

config/sets/typed-collections.php

@@ -26,6 +26,7 @@
 use Rector\Doctrine\TypedCollections\Rector\FuncCall\InArrayOnCollectionToContainsCallRector;
 use Rector\Doctrine\TypedCollections\Rector\If_\RemoveIfInstanceofCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\If_\RemoveIsArrayOnCollectionRector;
+use Rector\Doctrine\TypedCollections\Rector\MethodCall\AssertNullOnCollectionToAssertEmptyRector;
 use Rector\Doctrine\TypedCollections\Rector\MethodCall\SetArrayToNewCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\New_\RemoveNewArrayCollectionWrapRector;
 use Rector\Doctrine\TypedCollections\Rector\NullsafeMethodCall\RemoveNullsafeOnCollectionRector;
@@ -80,5 +81,6 @@
 
         // cleanup
         RemoveNullsafeOnCollectionRector::class,
+        AssertNullOnCollectionToAssertEmptyRector::class,
     ]);
 };

rules-tests/TypedCollections/Rector/MethodCall/AssertNullOnCollectionToAssertEmptyRector/AssertNullOnCollectionToAssertEmptyRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\MethodCall\AssertNullOnCollectionToAssertEmptyRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AssertNullOnCollectionToAssertEmptyRectorTest 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/TypedCollections/Rector/MethodCall/AssertNullOnCollectionToAssertEmptyRector/Fixture/assert_null_on_collection.php.inc

@@ -0,0 +1,37 @@
+<?php
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\MethodCall\AssertNullOnCollectionToAssertEmptyRector\Fixture;
+
+use Doctrine\Common\Collections\Collection;
+use PHPUnit\Framework\TestCase;
+
+final class AssertNullOnCollection extends TestCase
+{
+    public Collection $items;
+
+    public function someMethod()
+    {
+        $this->assertNull($this->items);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\MethodCall\AssertNullOnCollectionToAssertEmptyRector\Fixture;
+
+use Doctrine\Common\Collections\Collection;
+use PHPUnit\Framework\TestCase;
+
+final class AssertNullOnCollection extends TestCase
+{
+    public Collection $items;
+
+    public function someMethod()
+    {
+        $this->assertEmpty($this->items);
+    }
+}
+
+?>

rules-tests/TypedCollections/Rector/MethodCall/AssertNullOnCollectionToAssertEmptyRector/Fixture/skip_assert_null_on_anything_else.php.inc

@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\MethodCall\AssertNullOnCollectionToAssertEmptyRector\Fixture;
+
+use Doctrine\Common\Collections\Collection;
+use PHPUnit\Framework\TestCase;
+
+final class SkipAssertNullOnAnythingElse extends TestCase
+{
+    public $items;
+
+    public function someMethod()
+    {
+        $this->assertNull($this->items);
+    }
+}

rules-tests/TypedCollections/Rector/MethodCall/AssertNullOnCollectionToAssertEmptyRector/config/configured_rule.php

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

rules/TypedCollections/Rector/MethodCall/AssertNullOnCollectionToAssertEmptyRector.php

@@ -0,0 +1,98 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\TypedCollections\Rector\MethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use Rector\Doctrine\TypedCollections\TypeAnalyzer\CollectionTypeDetector;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Doctrine\Tests\TypedCollections\Rector\MethodCall\AssertNullOnCollectionToAssertEmptyRector\AssertNullOnCollectionToAssertEmptyRectorTest
+ */
+final class AssertNullOnCollectionToAssertEmptyRector extends AbstractRector
+{
+    public function __construct(
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+        private readonly CollectionTypeDetector $collectionTypeDetector
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Change $this->assertNull() on Collection object to $this->assertEmpty() in tests',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use Doctrine\Common\Collections\Collection;
+
+final class SomeClass extends \PHPUnit\Framework\TestCase
+{
+    private Collection $items;
+
+    public function test(): void
+    {
+        $this->assertNull($this->items);
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+use Doctrine\Common\Collections\Collection;
+
+final class SomeClass extends \PHPUnit\Framework\TestCase
+{
+    private Collection $items;
+
+    public function test(): void
+    {
+        $this->assertEmpty($this->items);
+    }
+}
+CODE_SAMPLE
+                )]
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [MethodCall::class];
+
+    }
+
+    /**
+     * @param MethodCall $node
+     */
+    public function refactor(Node $node): MethodCall|null
+    {
+        if ($node->isFirstClassCallable()) {
+            return null;
+        }
+
+        if (! $this->isName($node->name, 'assertNull')) {
+            return null;
+        }
+
+        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
+            return null;
+        }
+
+        $firstArg = $node->getArgs()[0];
+
+        if (! $this->collectionTypeDetector->isCollectionType($firstArg->value)) {
+            return null;
+        }
+
+        // rename
+        $node->name = new Identifier('assertEmpty');
+
+        return $node;
+    }
+}