Merge pull request #7656 from paulbalandan/normalize-data-provider-names

Normalize data provider names

Author: paulbalandan

.php-cs-fixer.dist.php

@@ -44,6 +44,10 @@
     ]);
 
 $overrides = [
+    'php_unit_data_provider_name' => [
+        'prefix' => 'provide',
+        'suffix' => '',
+    ],
     'php_unit_data_provider_return_type' => true,
     'no_extra_blank_lines'               => [
         'tokens' => [

.php-cs-fixer.no-header.php

@@ -30,6 +30,10 @@
     ]);
 
 $overrides = [
+    'php_unit_data_provider_name' => [
+        'prefix' => 'provide',
+        'suffix' => '',
+    ],
     'php_unit_data_provider_return_type' => true,
     'no_extra_blank_lines'               => [
         'tokens' => [

.php-cs-fixer.user-guide.php

@@ -53,6 +53,10 @@
             'use',
         ],
     ],
+    'php_unit_data_provider_name' => [
+        'prefix' => 'provide',
+        'suffix' => '',
+    ],
 ];
 
 $options = [

tests/system/AutoReview/FrameworkCodeTest.php

@@ -39,7 +39,7 @@ final class FrameworkCodeTest extends TestCase
     ];
 
     /**
-     * @dataProvider provideTestClassCases
+     * @dataProvider provideEachTestClassHasCorrectGroupAnnotation
      *
      * @phpstan-param class-string $class
      */
@@ -73,7 +73,7 @@ public function testEachTestClassHasCorrectGroupAnnotation(string $class): void
         ));
     }
 
-    public function provideTestClassCases(): iterable
+    public function provideEachTestClassHasCorrectGroupAnnotation(): iterable
     {
         foreach ($this->getTestClasses() as $class) {
             yield $class => [$class];

tests/system/CLI/CLITest.php

@@ -450,7 +450,7 @@ public function testWindow(): void
     }
 
     /**
-     * @dataProvider tableProvider
+     * @dataProvider provideTable
      *
      * @param array $tbody
      * @param array $thead
@@ -463,7 +463,7 @@ public function testTable($tbody, $thead, $expected): void
         $this->assertSame($this->getStreamFilterBuffer(), $expected);
     }
 
-    public function tableProvider(): iterable
+    public function provideTable(): iterable
     {
         $head = [
             'ID',

tests/system/Cache/Handlers/BaseHandlerTest.php

@@ -23,7 +23,7 @@
 final class BaseHandlerTest extends CIUnitTestCase
 {
     /**
-     * @dataProvider invalidTypeProvider
+     * @dataProvider provideValidateKeyInvalidType
      *
      * @param mixed $input
      */
@@ -35,7 +35,7 @@ public function testValidateKeyInvalidType($input): void
         BaseHandler::validateKey($input);
     }
 
-    public function invalidTypeProvider(): iterable
+    public function provideValidateKeyInvalidType(): iterable
     {
         return [
             [true],

tests/system/Cache/Handlers/FileHandlerTest.php

@@ -273,7 +273,7 @@ public function testIsSupported(): void
     }
 
     /**
-     * @dataProvider modeProvider
+     * @dataProvider provideSaveMode
      *
      * permissions given on Windows are fixed to `0666`
      *
@@ -296,7 +296,7 @@ public function testSaveMode(int $int, string $string): void
         $this->assertSame($string, $mode);
     }
 
-    public function modeProvider(): iterable
+    public function provideSaveMode(): iterable
     {
         return [
             [

tests/system/CodeIgniterTest.php

@@ -731,7 +731,7 @@ public function testPageCacheSendSecureHeaders(): void
     /**
      * @param array|bool $cacheQueryStringValue
      *
-     * @dataProvider cacheQueryStringProvider
+     * @dataProvider providePageCacheWithCacheQueryString
      *
      * @see https://github.com/codeigniter4/CodeIgniter4/pull/6410
      */
@@ -789,7 +789,7 @@ public function testPageCacheWithCacheQueryString($cacheQueryStringValue, int $e
         CITestStreamFilter::removeErrorFilter();
     }
 
-    public function cacheQueryStringProvider(): iterable
+    public function providePageCacheWithCacheQueryString(): iterable
     {
         $testingUrls = [
             'test', // URL #1

tests/system/Commands/CommandTest.php

@@ -128,7 +128,7 @@ public function testInexistentCommandsButWithManyAlternatives(): void
     }
 
     /**
-     * @dataProvider commandArgsProvider
+     * @dataProvider provideCommandParsesArgsCorrectly
      */
     public function testCommandParsesArgsCorrectly(string $input, array $expected): void
     {
@@ -138,7 +138,7 @@ public function testCommandParsesArgsCorrectly(string $input, array $expected):
         $this->assertSame($expected, ParamsReveal::$args);
     }
 
-    public function commandArgsProvider(): iterable
+    public function provideCommandParsesArgsCorrectly(): iterable
     {
         return [
             [

tests/system/Commands/Utilities/Routes/SampleURIGeneratorTest.php

@@ -22,7 +22,7 @@
 final class SampleURIGeneratorTest extends CIUnitTestCase
 {
     /**
-     * @dataProvider routeKeyProvider
+     * @dataProvider provideGet
      */
     public function testGet(string $routeKey, string $expected): void
     {
@@ -33,7 +33,7 @@ public function testGet(string $routeKey, string $expected): void
         $this->assertSame($expected, $uri);
     }
 
-    public function routeKeyProvider(): iterable
+    public function provideGet(): iterable
     {
         yield from [
             'root'                => ['/', '/'],