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

Normalize data provider names
codeigniter4 · Aug 3, 2023 · b3fe701 · b3fe701
2 parents 06e5089 + 0e7e31a
commit b3fe701
Show file tree

Hide file tree

Showing 53 changed files with 266 additions and 255 deletions.
diff --git a/.php-cs-fixer.dist.php b/.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' => [

diff --git a/.php-cs-fixer.no-header.php b/.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' => [

diff --git a/.php-cs-fixer.user-guide.php b/.php-cs-fixer.user-guide.php
@@ -53,6 +53,10 @@
             'use',
         ],
     ],
+    'php_unit_data_provider_name' => [
+        'prefix' => 'provide',
+        'suffix' => '',
+    ],
 ];
 
 $options = [

diff --git a/tests/system/AutoReview/FrameworkCodeTest.php b/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];

diff --git a/tests/system/CLI/CLITest.php b/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',

diff --git a/tests/system/Cache/Handlers/BaseHandlerTest.php b/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],

diff --git a/tests/system/Cache/Handlers/FileHandlerTest.php b/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 [
             [

diff --git a/tests/system/CodeIgniterTest.php b/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

diff --git a/tests/system/Commands/CommandTest.php b/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 [
             [

diff --git a/tests/system/Commands/Utilities/Routes/SampleURIGeneratorTest.php b/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'                => ['/', '/'],

diff --git a/tests/system/CommonFunctionsTest.php b/tests/system/CommonFunctionsTest.php
@@ -594,7 +594,7 @@ public function testForceHttpsNullRequestAndResponse(): void
     }
 
     /**
-     * @dataProvider dirtyPathsProvider
+     * @dataProvider provideCleanPathActuallyCleaningThePaths
      *
      * @param mixed $input
      * @param mixed $expected
@@ -604,7 +604,7 @@ public function testCleanPathActuallyCleaningThePaths($input, $expected): void
         $this->assertSame($expected, clean_path($input));
     }
 
-    public function dirtyPathsProvider(): iterable
+    public function provideCleanPathActuallyCleaningThePaths(): iterable
     {
         $ds = DIRECTORY_SEPARATOR;
 

diff --git a/tests/system/CommonSingleServiceTest.php b/tests/system/CommonSingleServiceTest.php
@@ -27,7 +27,7 @@
 final class CommonSingleServiceTest extends CIUnitTestCase
 {
     /**
-     * @dataProvider serviceNamesProvider
+     * @dataProvider provideServiceNames
      */
     public function testSingleServiceWithNoParamsSupplied(string $service): void
     {
@@ -43,7 +43,7 @@ public function testSingleServiceWithNoParamsSupplied(string $service): void
     }
 
     /**
-     * @dataProvider serviceNamesProvider
+     * @dataProvider provideServiceNames
      */
     public function testSingleServiceWithAtLeastOneParamSupplied(string $service): void
     {
@@ -99,7 +99,7 @@ public function testSingleServiceWithGibberishGiven(): void
         $this->assertNull(single_service('timers'));
     }
 
-    public static function serviceNamesProvider(): iterable
+    public static function provideServiceNames(): iterable
     {
         static $services = [];
         static $excl     = [

diff --git a/tests/system/Config/DotEnvTest.php b/tests/system/Config/DotEnvTest.php
@@ -56,7 +56,7 @@ public function testReturnsFalseIfCannotFindFile(): void
     }
 
     /**
-     * @dataProvider provideLoadVars
+     * @dataProvider provideLoadsVars
      */
     public function testLoadsVars(string $expected, string $varname): void
     {
@@ -66,7 +66,7 @@ public function testLoadsVars(string $expected, string $varname): void
         $this->assertSame($expected, getenv($varname));
     }
 
-    public function provideLoadVars(): iterable
+    public function provideLoadsVars(): iterable
     {
         yield from [
             ['bar', 'FOO'],

diff --git a/tests/system/Config/MimesTest.php b/tests/system/Config/MimesTest.php
@@ -21,7 +21,7 @@
  */
 final class MimesTest extends CIUnitTestCase
 {
-    public function extensionsList(): iterable
+    public function provideGuessExtensionFromType(): iterable
     {
         return [
             'null' => [
@@ -48,14 +48,14 @@ public function extensionsList(): iterable
     }
 
     /**
-     * @dataProvider extensionsList
+     * @dataProvider provideGuessExtensionFromType
      */
     public function testGuessExtensionFromType(?string $expected, string $mime): void
     {
         $this->assertSame($expected, Mimes::guessExtensionFromType($mime));
     }
 
-    public function mimesList(): iterable
+    public function provideGuessTypeFromExtension(): iterable
     {
         return [
             'null' => [
@@ -82,7 +82,7 @@ public function mimesList(): iterable
     }
 
     /**
-     * @dataProvider mimesList
+     * @dataProvider provideGuessTypeFromExtension
      */
     public function testGuessTypeFromExtension(?string $expected, string $ext): void
     {

diff --git a/tests/system/Cookie/CookieTest.php b/tests/system/Cookie/CookieTest.php
@@ -79,7 +79,7 @@ public function testConfigInjectionForDefaults(): void
     }
 
     /**
-     * @dataProvider prefixProvider
+     * @dataProvider provideConfigPrefix
      */
     public function testConfigPrefix(string $configPrefix, string $optionPrefix, string $expected): void
     {
@@ -98,7 +98,7 @@ public function testConfigPrefix(string $configPrefix, string $optionPrefix, str
         $this->assertSame($expected, $cookie->getPrefixedName());
     }
 
-    public function prefixProvider(): iterable
+    public function provideConfigPrefix(): iterable
     {
         yield from [
             ['prefix_', '', 'prefix_test'],
@@ -165,7 +165,7 @@ public function testExpirationTime(): void
     }
 
     /**
-     * @dataProvider invalidExpiresProvider
+     * @dataProvider provideInvalidExpires
      *
      * @param bool|float|string $expires
      */
@@ -175,7 +175,7 @@ public function testInvalidExpires($expires): void
         new Cookie('test', 'value', ['expires' => $expires]);
     }
 
-    public static function invalidExpiresProvider(): iterable
+    public static function provideInvalidExpires(): iterable
     {
         $cases = [
             'non-numeric-string' => ['yes'],
@@ -189,7 +189,7 @@ public static function invalidExpiresProvider(): iterable
     }
 
     /**
-     * @dataProvider setCookieHeaderProvider
+     * @dataProvider provideSetCookieHeaderCreation
      */
     public function testSetCookieHeaderCreation(string $header, array $changed): void
     {
@@ -198,7 +198,7 @@ public function testSetCookieHeaderCreation(string $header, array $changed): voi
         $this->assertSame(array_merge($cookie, $changed), $cookie);
     }
 
-    public static function setCookieHeaderProvider(): iterable
+    public static function provideSetCookieHeaderCreation(): iterable
     {
         yield 'basic' => [
             'test=value',

diff --git a/tests/system/Database/BaseConnectionTest.php b/tests/system/Database/BaseConnectionTest.php
@@ -167,7 +167,7 @@ public function testMagicGetMissing(): void
      * These tests are intended to confirm the current behavior.
      * We do not know if all of these are the correct behavior.
      *
-     * @dataProvider identifiersProvider
+     * @dataProvider provideProtectIdentifiers
      */
     public function testProtectIdentifiers(
         bool $prefixSingle,
@@ -183,7 +183,7 @@ public function testProtectIdentifiers(
         $this->assertSame($expected, $return);
     }
 
-    public function identifiersProvider(): iterable
+    public function provideProtectIdentifiers(): iterable
     {
         yield from [
             // $prefixSingle, $protectIdentifiers, $fieldExists, $item, $expected

diff --git a/tests/system/Database/BaseQueryTest.php b/tests/system/Database/BaseQueryTest.php
@@ -104,7 +104,7 @@ public function testSwapPrefix(): void
         $this->assertSame($newSQL, $query->getQuery());
     }
 
-    public function queryTypes(): iterable
+    public function provideIsWriteType(): iterable
     {
         return [
             'select' => [
@@ -183,7 +183,7 @@ public function queryTypes(): iterable
     }
 
     /**
-     * @dataProvider queryTypes
+     * @dataProvider provideIsWriteType
      *
      * @param mixed $expected
      * @param mixed $sql
@@ -577,7 +577,7 @@ public function testSwapPrefixAfterGetQuery(): void
         $this->assertSame($expected, $query->getQuery());
     }
 
-    public function queryKeywords(): iterable
+    public function provideHighlightQueryKeywords(): iterable
     {
         return [
             'highlightKeyWords' => [
@@ -596,7 +596,7 @@ public function queryKeywords(): iterable
     }
 
     /**
-     * @dataProvider queryKeywords
+     * @dataProvider provideHighlightQueryKeywords
      *
      * @param mixed $expected
      * @param mixed $sql