[TypeDeclaration] Add AddParamTypeBasedOnPHPUnitDataProviderRector + …

…remove too narrow KnownArrayParamTypeInferer (#3104)

build/target-repository/docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 402 Rules Overview
+# 403 Rules Overview
 
 <br>
 
@@ -64,7 +64,7 @@
 
 - [Transform](#transform) (34)
 
-- [TypeDeclaration](#typedeclaration) (30)
+- [TypeDeclaration](#typedeclaration) (31)
 
 - [Visibility](#visibility) (3)
 
@@ -8805,6 +8805,34 @@ Change private method param type to strict type, based on passed strict types
 
 <br>
 
+### AddParamTypeBasedOnPHPUnitDataProviderRector
+
+Adds param type declaration based on PHPUnit provider return type declaration
+
+- class: [`Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector`](../rules/TypeDeclaration/Rector/ClassMethod/AddParamTypeBasedOnPHPUnitDataProviderRector.php)
+
+```diff
+ use PHPUnit\Framework\TestCase
+
+ final class SomeTest extends TestCase
+ {
+     /**
+      * @dataProvider provideData()
+      */
+-    public function test($value)
++    public function test(string $value)
+     {
+     }
+
+     public function provideData()
+     {
+         yield ['name'];
+     }
+ }
+```
+
+<br>
+
 ### AddParamTypeDeclarationRector
 
 Add param types where needed

phpstan.neon

@@ -784,3 +784,6 @@ parameters:
 
         # returns bool for notifications
         - '#Method "renamePropertyPromotion\(\)" returns bool type, so the name should start with is/has/was#'
+
+        # false positive
+        - '#Method Rector\\TypeDeclaration\\Rector\\ClassMethod\\AddParamTypeBasedOnPHPUnitDataProviderRector\:\:resolveDataProviderPhpDocTagNode\(\) should return PHPStan\\PhpDocParser\\Ast\\PhpDoc\\PhpDocTagNode\|null but returns PHPStan\\PhpDocParser\\Ast\\Node\|null#'

tests/Issues/DoubleImportedTraitUse/DoubleImportedTraitUseTest.php → rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamTypeBasedOnPHPUnitDataProviderRector/AddParamTypeBasedOnPHPUnitDataProviderRectorTest.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Rector\Core\Tests\Issues\DoubleImportedTraitUse;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector;
 
 use Iterator;
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 
-final class DoubleImportedTraitUseTest extends AbstractRectorTestCase
+final class AddParamTypeBasedOnPHPUnitDataProviderRectorTest extends AbstractRectorTestCase
 {
     /**
      * @dataProvider provideData()
@@ -27,6 +27,6 @@ public function provideData(): Iterator
 
     public function provideConfigFilePath(): string
     {
-        return __DIR__ . '/config/double_imported_trait_use.php';
+        return __DIR__ . '/config/configured_rule.php';
     }
 }

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamTypeBasedOnPHPUnitDataProviderRector/Fixture/fixture.php.inc

@@ -0,0 +1,47 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector\Fixture;
+
+use Iterator;
+use PHPUnit\Framework\TestCase;
+
+final class SomeTestWithDataProvider extends TestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test($name)
+    {
+    }
+
+    public function provideData(): Iterator
+    {
+        yield ['some'];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector\Fixture;
+
+use Iterator;
+use PHPUnit\Framework\TestCase;
+
+final class SomeTestWithDataProvider extends TestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $name)
+    {
+    }
+
+    public function provideData(): Iterator
+    {
+        yield ['some'];
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/FunctionLike/ParamTypeDeclarationRector/Fixture/dataprovider_array.php.inc → rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamTypeBasedOnPHPUnitDataProviderRector/Fixture/many_scalars.php.inc

@@ -1,14 +1,16 @@
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\FunctionLike\ParamTypeDeclarationRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
 
 /**
  * Test case including a dataProvider using an array that lead to an incorrect types being added.
  * `array` was added for $one, but should be `string`, or the parameter should be left alone entirely.
  * The $two and $three parameters did not get hints added at all.
  * See: https://phpunit.readthedocs.io/en/9.3/writing-tests-for-phpunit.html#data-providers
  */
-final class DemoArrayTest
+final class ManyScalars extends TestCase
 {
     public function provideThings(): array {
         return [
@@ -23,18 +25,22 @@ final class DemoArrayTest
      */
     public function testGetFromId( $one, $two, $three, $four, $five ): void {}
 }
+
+?>
 -----
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\FunctionLike\ParamTypeDeclarationRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
 
 /**
  * Test case including a dataProvider using an array that lead to an incorrect types being added.
  * `array` was added for $one, but should be `string`, or the parameter should be left alone entirely.
  * The $two and $three parameters did not get hints added at all.
  * See: https://phpunit.readthedocs.io/en/9.3/writing-tests-for-phpunit.html#data-providers
  */
-final class DemoArrayTest
+final class ManyScalars extends TestCase
 {
     public function provideThings(): array {
         return [
@@ -49,3 +55,5 @@ final class DemoArrayTest
      */
     public function testGetFromId( int $one, bool $two, string $three, ?int $four, $five ): void {}
 }
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamTypeBasedOnPHPUnitDataProviderRector/Fixture/return_array.php.inc

@@ -0,0 +1,47 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector\Fixture;
+
+use Iterator;
+use PHPUnit\Framework\TestCase;
+
+final class ReturnArray extends TestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test($name, $number)
+    {
+    }
+
+    public function provideData()
+    {
+        return [['some', 100]];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector\Fixture;
+
+use Iterator;
+use PHPUnit\Framework\TestCase;
+
+final class ReturnArray extends TestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $name, int $number)
+    {
+    }
+
+    public function provideData()
+    {
+        return [['some', 100]];
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamTypeBasedOnPHPUnitDataProviderRector/Fixture/skip_no_type.php.inc

@@ -0,0 +1,21 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector\Fixture;
+
+use Iterator;
+use PHPUnit\Framework\TestCase;
+
+final class SkipNoType extends TestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test($name)
+    {
+    }
+
+    public function provideData($some): Iterator
+    {
+        yield [$some];
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamTypeBasedOnPHPUnitDataProviderRector/config/configured_rule.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Core\ValueObject\PhpVersionFeature;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(AddParamTypeBasedOnPHPUnitDataProviderRector::class);
+
+    $rectorConfig->phpVersion(PhpVersionFeature::UNION_TYPES - 1);
+};

rules/TypeDeclaration/Contract/TypeInferer/ParamTypeInfererInterface.php

@@ -7,6 +7,9 @@
 use PhpParser\Node\Param;
 use PHPStan\Type\Type;
 
+/**
+ * @deprecated This interface is not used anymore. Use the exact Rector rules instead.
+ */
 interface ParamTypeInfererInterface
 {
     public function inferParam(Param $param): Type;