[typed-collections] Add RemoveAssertNotNullOnCollectionRector

Author: TomasVotruba

config/sets/typed-collections.php

@@ -20,6 +20,7 @@
 use Rector\Doctrine\TypedCollections\Rector\ClassMethod\ReturnArrayToNewArrayCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\ClassMethod\ReturnCollectionDocblockRector;
 use Rector\Doctrine\TypedCollections\Rector\Empty_\EmptyOnCollectionToIsEmptyCallRector;
+use Rector\Doctrine\TypedCollections\Rector\Expression\RemoveAssertNotNullOnCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\Expression\RemoveCoalesceAssignOnCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\FuncCall\ArrayMapOnCollectionToArrayRector;
 use Rector\Doctrine\TypedCollections\Rector\FuncCall\ArrayMergeOnCollectionToArrayRector;
@@ -82,5 +83,6 @@
         // cleanup
         RemoveNullsafeOnCollectionRector::class,
         AssertNullOnCollectionToAssertEmptyRector::class,
+        RemoveAssertNotNullOnCollectionRector::class,
     ]);
 };

rules-tests/TypedCollections/Rector/Expression/RemoveAssertNotNullOnCollectionRector/Fixture/coalesce_assign_on_collection.php.inc

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\Expression\RemoveAssertNotNullOnCollectionRector\Fixture;
+
+use Doctrine\Common\Collections\Collection;
+
+final class SomeClass
+{
+    public Collection $items;
+
+    public function someMethod()
+    {
+        \PHPUnit\Framework\Assert::assertNotNull($this->items);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\Expression\RemoveAssertNotNullOnCollectionRector\Fixture;
+
+use Doctrine\Common\Collections\Collection;
+
+final class SomeClass
+{
+    public Collection $items;
+
+    public function someMethod()
+    {
+    }
+}
+
+?>

rules-tests/TypedCollections/Rector/Expression/RemoveAssertNotNullOnCollectionRector/RemoveAssertNotNullOnCollectionRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\Expression\RemoveAssertNotNullOnCollectionRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class RemoveAssertNotNullOnCollectionRectorTest 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/Expression/RemoveAssertNotNullOnCollectionRector/config/configured_rule.php

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

rules/TypedCollections/Rector/Expression/RemoveAssertNotNullOnCollectionRector.php

@@ -0,0 +1,95 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\TypedCollections\Rector\Expression;
+
+use PHPUnit\Framework\Assert;
+use PhpParser\Node;
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Stmt\Expression;
+use PhpParser\NodeVisitor;
+use Rector\Doctrine\TypedCollections\TypeAnalyzer\CollectionTypeDetector;
+use Rector\PHPUnit\Enum\PHPUnitClassName;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Doctrine\Tests\TypedCollections\Rector\Expression\RemoveAssertNotNullOnCollectionRector\RemoveAssertNotNullOnCollectionRectorTest
+ */
+final class RemoveAssertNotNullOnCollectionRector extends AbstractRector
+{
+    public function __construct(
+        private readonly CollectionTypeDetector $collectionTypeDetector,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Remove ' . Assert::class . '::assertNotNull() on a Collection type',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use Doctrine\Common\Collections\Collection;
+
+class SomeClass
+{
+    public function run(Collection $collection): void
+    {
+        Assert::assertNotNull($collection);
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+use Doctrine\Common\Collections\Collection;
+
+class SomeClass
+{
+    public function run(Collection $collection): void
+    {
+    }
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Expression::class];
+    }
+
+    /**
+     * @param Expression $node
+     */
+    public function refactor(Node $node): ?int
+    {
+        if (! $node->expr instanceof StaticCall) {
+            return null;
+        }
+
+        $staticCall = $node->expr;
+        if (! $this->isName($staticCall->name, 'assertNotNull')) {
+            return null;
+        }
+
+        if (! $this->isName($staticCall->class, PHPUnitClassName::ASSERT)) {
+            return null;
+        }
+
+        if (count($staticCall->args) !== 1) {
+            return null;
+        }
+
+        $firstArg = $staticCall->getArgs()[0];
+        if (! $this->collectionTypeDetector->isCollectionType($firstArg->value)) {
+            return null;
+        }
+
+        return NodeVisitor::REMOVE_NODE;
+    }
+}