[typed-collections] Add RemoveNullsafeOnCollectionRector (#420)

Author: TomasVotruba

config/sets/typed-collections.php

@@ -28,6 +28,7 @@
 use Rector\Doctrine\TypedCollections\Rector\If_\RemoveIsArrayOnCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\MethodCall\SetArrayToNewCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\New_\RemoveNewArrayCollectionWrapRector;
+use Rector\Doctrine\TypedCollections\Rector\NullsafeMethodCall\RemoveNullsafeOnCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\Property\NarrowPropertyUnionToCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\Property\TypedPropertyFromToManyRelationTypeRector;
 
@@ -76,5 +77,8 @@
         ReturnArrayToNewArrayCollectionRector::class,
         SetArrayToNewCollectionRector::class,
         RemoveNewArrayCollectionWrapRector::class,
+
+        // cleanup
+        RemoveNullsafeOnCollectionRector::class,
     ]);
 };

rules-tests/TypedCollections/Rector/NullsafeMethodCall/RemoveNullsafeOnCollectionRector/Fixture/redundant_nullsafe_on_collection.php.inc

@@ -0,0 +1,37 @@
+<?php
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\NullsafeMethodCall\RemoveNullsafeOnCollectionRector\Fixture;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
+
+final class RedundantNullsafeOnCollection
+{
+    public Collection $items;
+
+    public function someMethod()
+    {
+        $values = $this->items?->count();
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\NullsafeMethodCall\RemoveNullsafeOnCollectionRector\Fixture;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
+
+final class RedundantNullsafeOnCollection
+{
+    public Collection $items;
+
+    public function someMethod()
+    {
+        $values = $this->items->count();
+    }
+}
+
+?>

rules-tests/TypedCollections/Rector/NullsafeMethodCall/RemoveNullsafeOnCollectionRector/Fixture/skip_another_type.php.inc

@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\NullsafeMethodCall\RemoveNullsafeOnCollectionRector\Fixture;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
+
+final class SkipAnotherType
+{
+    public $items;
+
+    public function someMethod()
+    {
+        $values = $this->items?->count();
+    }
+}

rules-tests/TypedCollections/Rector/NullsafeMethodCall/RemoveNullsafeOnCollectionRector/RemoveNullsafeOnCollectionRectorTest.php

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

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

rules/TypedCollections/Rector/NullsafeMethodCall/RemoveNullsafeOnCollectionRector.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\TypedCollections\Rector\NullsafeMethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\NullsafeMethodCall;
+use Rector\Doctrine\TypedCollections\TypeAnalyzer\CollectionTypeDetector;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Doctrine\Tests\TypedCollections\Rector\NullsafeMethodCall\RemoveNullsafeOnCollectionRector\RemoveNullsafeOnCollectionRectorTest
+ */
+final class RemoveNullsafeOnCollectionRector extends AbstractRector
+{
+    public function __construct(
+        private readonly CollectionTypeDetector $collectionTypeDetector
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Remove nullsafe check on method call on a Collection type', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+use Doctrine\Common\Collections\Collection;
+
+class SomeClass
+{
+    private Collection $collection;
+
+    public function run()
+    {
+        return $this->collection?->empty();
+    }
+}
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+use Doctrine\Common\Collections\Collection;
+
+class SomeClass
+{
+    private Collection $collection;
+
+    public function run()
+    {
+        return $this->collection->empty();
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [NullsafeMethodCall::class];
+    }
+
+    /**
+     * @param NullsafeMethodCall $node
+     */
+    public function refactor(Node $node): ?MethodCall
+    {
+        if (! $this->collectionTypeDetector->isCollectionNonNullableType($node->var)) {
+            return null;
+        }
+
+        return new MethodCall($node->var, $node->name);
+    }
+}

rules/TypedCollections/TypeAnalyzer/CollectionTypeDetector.php

@@ -20,6 +20,12 @@ public function __construct(
     ) {
     }
 
+    public function isCollectionNonNullableType(Expr $expr): bool
+    {
+        $exprType = $this->nodeTypeResolver->getType($expr);
+        return $this->isCollectionObjectType($exprType);
+    }
+
     public function isCollectionType(Expr $expr): bool
     {
         $exprType = $this->nodeTypeResolver->getType($expr);