[code-quality] Add RemoveDataProviderParamKeysRector

config/sets/phpunit-code-quality.php

@@ -6,6 +6,7 @@
 use Rector\PHPUnit\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\NarrowUnusedSetUpDefinedPropertyRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\PreferPHPUnitThisCallRector;
+use Rector\PHPUnit\CodeQuality\Rector\Class_\RemoveDataProviderParamKeysRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\SingleMockPropertyTypeRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\TestWithToDataProviderRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\YieldDataProviderRector;
@@ -48,6 +49,10 @@
  TestWithToDataProviderRector::class,
  AssertEqualsOrAssertSameFloatParameterToSpecificMethodsTypeRector::class,
  DataProviderArrayItemsNewLinedRector::class,
+
+ // PHPUnit 11 reports warnings on typos + keys are rather noise than useful, fake system-keys for values
+ RemoveDataProviderParamKeysRector::class,
+
  FlipAssertRector::class,
 
  // narrow with consecutive

rules-tests/CodeQuality/Rector/Class_/RemoveDataProviderParamKeysRector/Fixture/keep_dataset_description.php.inc

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\RemoveDataProviderParamKeysRector\Fixture;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+final class KeepDatasetDescriptionTest extends TestCase
+{
+ #[DataProvider('provideData')]
+ public function test(string $name): void
+ {
+ }
+
+ public function provideData()
+ {
+ yield 'some description' => [
+ 'name' => 'Tom',
+ ];
+ }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\RemoveDataProviderParamKeysRector\Fixture;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+final class KeepDatasetDescriptionTest extends TestCase
+{
+ #[DataProvider('provideData')]
+ public function test(string $name): void
+ {
+ }
+
+ public function provideData()
+ {
+ yield 'some description' => [
+ 'Tom',
+ ];
+ }
+}
+
+?>

rules-tests/CodeQuality/Rector/Class_/RemoveDataProviderParamKeysRector/Fixture/skip_nested_arrays.php.inc

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\RemoveDataProviderParamKeysRector\Fixture;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+final class SkipNestedArraysTest extends TestCase
+{
+ #[DataProvider('provideData')]
+ public function test(string $name): void
+ {
+ }
+
+ public function provideData(): array
+ {
+ return [
+ [
+ ['name' => 'Tom']
+ ],
+ ];
+ }
+}

rules-tests/CodeQuality/Rector/Class_/RemoveDataProviderParamKeysRector/Fixture/some_data_provider.php.inc

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\RemoveDataProviderParamKeysRector\Fixture;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+final class SomeDataProviderTest extends TestCase
+{
+ #[DataProvider('provideData')]
+ public function test(string $name): void
+ {
+ }
+
+ public function provideData(): array
+ {
+ return [
+ ['name' => 'Tom'],
+ ];
+ }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\RemoveDataProviderParamKeysRector\Fixture;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+final class SomeDataProviderTest extends TestCase
+{
+ #[DataProvider('provideData')]
+ public function test(string $name): void
+ {
+ }
+
+ public function provideData(): array
+ {
+ return [
+ ['Tom'],
+ ];
+ }
+}
+
+?>

rules-tests/CodeQuality/Rector/Class_/RemoveDataProviderParamKeysRector/Fixture/some_data_provider_with_yields.php.inc

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\RemoveDataProviderParamKeysRector\Fixture;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+final class SomeDataProviderWithYieldsTest extends TestCase
+{
+ #[DataProvider('provideData')]
+ public function test(string $name): void
+ {
+ }
+
+ public function provideData(): \Iterator
+ {
+ yield ['name' => 'Tom'];
+ }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\RemoveDataProviderParamKeysRector\Fixture;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+final class SomeDataProviderWithYieldsTest extends TestCase
+{
+ #[DataProvider('provideData')]
+ public function test(string $name): void
+ {
+ }
+
+ public function provideData(): \Iterator
+ {
+ yield ['Tom'];
+ }
+}
+
+?>

rules-tests/CodeQuality/Rector/Class_/RemoveDataProviderParamKeysRector/RemoveDataProviderParamKeysRectorTest.php

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

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