[typed-collections] Add CollectionDocblockGenericTypeRector

Author: TomasVotruba

rules-tests/TypedCollections/Rector/ClassMethod/CollectionDocblockGenericTypeRector/CollectionDocblockGenericTypeRectorTest.php

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

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\ClassMethod\CollectionDocblockGenericTypeRector\Fixture;
+
+use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Collections\ArrayCollection;
+use Rector\Doctrine\Tests\TypedCollections\Rector\ClassMethod\CollectionDocblockGenericTypeRector\Source\RandomHouse;
+
+final class SomeMethodWithReturnCollection
+{
+    public function getItems(): Collection
+    {
+        $collection = new ArrayCollection();
+        $collection->add(new RandomHouse());
+
+        return $collection;
+    }
+}
+
+?>
+-----
+    <?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\ClassMethod\CollectionDocblockGenericTypeRector\Fixture;
+
+use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Collections\ArrayCollection;
+use Rector\Doctrine\Tests\TypedCollections\Rector\ClassMethod\CollectionDocblockGenericTypeRector\Source\RandomHouse;
+
+final class SomeMethodWithReturnCollection
+{
+    /**
+     * @return Collection<int, RandomHouse>
+     */
+    public function getItems(): Collection
+    {
+        $collection = new ArrayCollection();
+        $collection->add(new RandomHouse());
+
+        return $collection;
+    }
+}
+
+?>
+

rules-tests/TypedCollections/Rector/ClassMethod/CollectionDocblockGenericTypeRector/Source/RandomHouse.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\ClassMethod\CollectionDocblockGenericTypeRector\Source;
+
+class RandomHouse
+{
+}

rules-tests/TypedCollections/Rector/ClassMethod/CollectionDocblockGenericTypeRector/config/configured_rule.php

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

rules/TypedCollections/Rector/ClassMethod/CollectionDocblockGenericTypeRector.php

@@ -0,0 +1,100 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\TypedCollections\Rector\ClassMethod;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\PropertyFetch;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Return_;
+use Rector\Doctrine\Enum\DoctrineClass;
+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\ClassMethod\CollectionDocblockGenericTypeRector\CollectionDocblockGenericTypeRectorTest
+ */
+final class CollectionDocblockGenericTypeRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Add more precise generics type to method that returns Collection',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Collections\ArrayCollection;
+
+final class SomeClass
+{
+    public function getItems(): Collection
+    {
+        $collection = new ArrayCollection();
+        $collection->add(new SomeClass());
+
+        return $collection;
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Collections\ArrayCollection;
+
+final class SomeClass
+{
+    /**
+     * @return Collection<int, SomeClass>
+     */
+    public function getItems(): Collection
+    {
+        $collection = new ArrayCollection();
+        $collection->add(new SomeClass());
+
+        return $collection;
+    }
+}
+CODE_SAMPLE
+                )]
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [ClassMethod::class];
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function refactor(Node $node): ?ClassMethod
+    {
+        if ($node->stmts === null) {
+            return null;
+        }
+
+        // already different type
+        if ($node->returnType instanceof \PhpParser\Node) {
+            return null;
+        }
+
+        if ($node->returnType === null) {
+            return null;
+        }
+
+        if (! $this->isName($node->returnType, DoctrineClass::COLLECTION)) {
+            return null;
+        }
+
+        // find return
+        // find new ArrayCollection()
+        // improve return type
+
+        return null;
+    }
+}