[tdd] Add AddReturnDocblockForDimFetchArrayFromAssignsRector

Author: TomasVotruba

phpstan.neon

@@ -464,3 +464,8 @@ parameters:
         -
             path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
             identifier: symplify.forbiddenExtendOfNonAbstractClass
+
+        # false positive
+        -
+             identifier: phpstanApi.varTagAssumption
+             path: rules/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForDimFetchArrayFromAssignsRector.php

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForDimFetchArrayFromAssignsRector/AddReturnDocblockForDimFetchArrayFromAssignsRectorTest.php

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

@@ -0,0 +1,42 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForDimFetchArrayFromAssignsRector\Fixture;
+
+final class ConditionalAssign
+{
+    public function toArray(): array
+    {
+        $items = [];
+
+        if (mt_rand(0, 1)) {
+            $items['key'] = 100;
+        }
+
+        return $items;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForDimFetchArrayFromAssignsRector\Fixture;
+
+final class ConditionalAssign
+{
+    /**
+     * @return array<string, int>
+     */
+    public function toArray(): array
+    {
+        $items = [];
+
+        if (mt_rand(0, 1)) {
+            $items['key'] = 100;
+        }
+
+        return $items;
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForDimFetchArrayFromAssignsRector/Fixture/multiple_conditional_assign.php.inc

@@ -0,0 +1,50 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForDimFetchArrayFromAssignsRector\Fixture;
+
+final class MultipleConditionalAssign
+{
+    public function toArray(): array
+    {
+        $items = [];
+
+        if (mt_rand(0, 1)) {
+            $items['key'] = 'some_string';
+        }
+
+        if (mt_rand(0, 1)) {
+            $items['another_key'] = 500;
+        }
+
+        return $items;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForDimFetchArrayFromAssignsRector\Fixture;
+
+final class MultipleConditionalAssign
+{
+    /**
+     * @return array<string, string|int>
+     */
+    public function toArray(): array
+    {
+        $items = [];
+
+        if (mt_rand(0, 1)) {
+            $items['key'] = 'some_string';
+        }
+
+        if (mt_rand(0, 1)) {
+            $items['another_key'] = 500;
+        }
+
+        return $items;
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddReturnDocblockForDimFetchArrayFromAssignsRector/Fixture/some_item.php.inc

@@ -0,0 +1,36 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForDimFetchArrayFromAssignsRector\Fixture;
+
+final class SomeItem
+{
+    public function toArray(): array
+    {
+        $items = [];
+        $items['key'] = 100;
+
+        return $items;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForDimFetchArrayFromAssignsRector\Fixture;
+
+final class SomeItem
+{
+    /**
+     * @return array<string, int>
+     */
+    public function toArray(): array
+    {
+        $items = [];
+        $items['key'] = 100;
+
+        return $items;
+    }
+}
+
+?>

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

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