[type-declaration-docblocks] Add AddReturnDocblockForArrayDimAssignedObjectRector (#7302)

* [type-declaration-docblocks] Add AddReturnDocblockForArrayDimAssignedObjectRector

* fixup! [type-declaration-docblocks] Add AddReturnDocblockForArrayDimAssignedObjectRector

* cs

Author: TomasVotruba

config/set/type-declaration-docblocks.php

@@ -10,6 +10,7 @@
 use Rector\TypeDeclarationDocblocks\Rector\Class_\DocblockVarFromParamDocblockInConstructorRector;
 use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDataProviderRector;
 use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector;
+use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector;
 use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector;
 use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockGetterReturnArrayFromPropertyDocblockVarRector;
 use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockReturnArrayFromDirectArrayInstanceRector;
@@ -32,6 +33,7 @@
         AddReturnArrayDocblockBasedOnArrayMapRector::class,
         AddReturnDocblockForScalarArrayFromAssignsRector::class,
         DocblockReturnArrayFromDirectArrayInstanceRector::class,
+        AddReturnDocblockForArrayDimAssignedObjectRector::class,
 
         // tests
         AddParamArrayDocblockFromDataProviderRector::class,

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForArrayDimAssignedObjectRector/AddReturnDocblockForArrayDimAssignedObjectRectorTest.php

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

@@ -0,0 +1,44 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Source\SomeItem;
+
+final class AssignDimFetch
+{
+    public function provide(array $keys): array
+    {
+        $items = [];
+        foreach ($keys as $key) {
+            $items[] = new SomeItem($key);
+        }
+
+        return $items;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Source\SomeItem;
+
+final class AssignDimFetch
+{
+    /**
+     * @return \Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Source\SomeItem[]
+     */
+    public function provide(array $keys): array
+    {
+        $items = [];
+        foreach ($keys as $key) {
+            $items[] = new SomeItem($key);
+        }
+
+        return $items;
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForArrayDimAssignedObjectRector/Fixture/include_method_dim_fetch.php.inc

@@ -0,0 +1,54 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Source\SomeItem;
+
+final class IncludeMethodDimFetch
+{
+    public function provide(array $keys): array
+    {
+        $items = [];
+        foreach ($keys as $key) {
+            $items[] = $this->createSomeItem();
+        }
+
+        return $items;
+    }
+
+    private function createSomeItem(): SomeItem
+    {
+        return new SomeItem();
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Source\SomeItem;
+
+final class IncludeMethodDimFetch
+{
+    /**
+     * @return \Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Source\SomeItem[]
+     */
+    public function provide(array $keys): array
+    {
+        $items = [];
+        foreach ($keys as $key) {
+            $items[] = $this->createSomeItem();
+        }
+
+        return $items;
+    }
+
+    private function createSomeItem(): SomeItem
+    {
+        return new SomeItem();
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForArrayDimAssignedObjectRector/Fixture/skip_default_assign.php.inc

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Source\SomeItem;
+
+final class SkipDefaultAssign
+{
+    public function provide(array $keys): array
+    {
+        $items = [1000];
+        foreach ($keys as $key) {
+            $items[] = new SomeItem($key);
+        }
+
+        return $items;
+    }
+}

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForArrayDimAssignedObjectRector/Fixture/skip_dim_value.php.inc

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Source\SomeItem;
+
+final class SkipDimValue
+{
+    public function provide(array $keys): array
+    {
+        $items = [];
+        foreach ($keys as $key) {
+            $items[1000] = new SomeItem($key);
+        }
+
+        return $items;
+    }
+}

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForArrayDimAssignedObjectRector/Fixture/skip_docblock_return.php.inc

@@ -0,0 +1,26 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Source\SomeItem;
+
+final class SkipDocblockReturn
+{
+    public function provide(array $keys): array
+    {
+        $items = [];
+        foreach ($keys as $key) {
+            $items[] = $this->createSomeItem();
+        }
+
+        return $items;
+    }
+
+    /**
+     * @return FakeItem
+     */
+    private function createSomeItem()
+    {
+        return new SomeItem();
+    }
+}

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForArrayDimAssignedObjectRector/Fixture/skip_property_fetch_in_case_of_another_assign.php.inc

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Source\SomeItem;
+
+final class SkipPropertyFetchInCaseOfAnotherAssign
+{
+    public function provide(array $keys): array
+    {
+        $this->items = [];
+        foreach ($keys as $key) {
+            $this->items[] = new SomeItem($key);
+        }
+
+        return $this->items;
+    }
+}

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForArrayDimAssignedObjectRector/Source/SomeItem.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector\Source;
+
+final class SomeItem
+{
+}

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForArrayDimAssignedObjectRector/config/configured_rule.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector;
+
+return RectorConfig::configure()
+    ->withRules([AddReturnDocblockForArrayDimAssignedObjectRector::class]);