codeigniter4 · kenjis · Jul 21, 2023 · Jul 17, 2023
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -43,7 +43,9 @@
         __DIR__ . '/spark',
     ]);
 
-$overrides = [];
+$overrides = [
+    'php_unit_data_provider_return_type' => true,
+];
 
 $options = [
     'cacheFile' => 'build/.php-cs-fixer.cache',

diff --git a/.php-cs-fixer.no-header.php b/.php-cs-fixer.no-header.php
@@ -29,7 +29,9 @@
         __DIR__ . '/admin/starter/builds',
     ]);
 
-$overrides = [];
+$overrides = [
+    'php_unit_data_provider_return_type' => true,
+];
 
 $options = [
     'cacheFile' => 'build/.php-cs-fixer.no-header.cache',

diff --git a/.php-cs-fixer.user-guide.php b/.php-cs-fixer.user-guide.php
@@ -29,10 +29,11 @@
     ]);
 
 $overrides = [
-    'echo_tag_syntax'             => false,
-    'php_unit_internal_class'     => false,
-    'no_unused_imports'           => false,
-    'class_attributes_separation' => false,
+    'echo_tag_syntax'                    => false,
+    'php_unit_internal_class'            => false,
+    'no_unused_imports'                  => false,
+    'class_attributes_separation'        => false,
+    'php_unit_data_provider_return_type' => true,
 ];
 
 $options = [

diff --git a/tests/system/CLI/CLITest.php b/tests/system/CLI/CLITest.php
@@ -463,7 +463,7 @@ public function testTable($tbody, $thead, $expected)
         $this->assertSame($this->getStreamFilterBuffer(), $expected);
     }
 
-    public function tableProvider()
+    public function tableProvider(): iterable
     {
         $head = [
             'ID',

diff --git a/tests/system/Cache/Handlers/BaseHandlerTest.php b/tests/system/Cache/Handlers/BaseHandlerTest.php
@@ -35,7 +35,7 @@ public function testValidateKeyInvalidType($input)
         BaseHandler::validateKey($input);
     }
 
-    public function invalidTypeProvider(): array
+    public function invalidTypeProvider(): iterable
     {
         return [
             [true],

diff --git a/tests/system/Cache/Handlers/FileHandlerTest.php b/tests/system/Cache/Handlers/FileHandlerTest.php
@@ -296,7 +296,7 @@ public function testSaveMode(int $int, string $string): void
         $this->assertSame($string, $mode);
     }
 
-    public function modeProvider()
+    public function modeProvider(): iterable
     {
         return [
             [

diff --git a/tests/system/CodeIgniterTest.php b/tests/system/CodeIgniterTest.php
@@ -789,7 +789,7 @@ public function testPageCacheWithCacheQueryString($cacheQueryStringValue, int $e
         CITestStreamFilter::removeErrorFilter();
     }
 
-    public function cacheQueryStringProvider(): array
+    public function cacheQueryStringProvider(): iterable
     {
         $testingUrls = [
             'test', // URL #1

diff --git a/tests/system/Commands/CommandTest.php b/tests/system/Commands/CommandTest.php
@@ -138,7 +138,7 @@ public function testCommandParsesArgsCorrectly(string $input, array $expected)
         $this->assertSame($expected, ParamsReveal::$args);
     }
 
-    public function commandArgsProvider(): array
+    public function commandArgsProvider(): iterable
     {
         return [
             [

diff --git a/tests/system/Commands/Utilities/Routes/SampleURIGeneratorTest.php b/tests/system/Commands/Utilities/Routes/SampleURIGeneratorTest.php
@@ -13,7 +13,6 @@
 
 use CodeIgniter\Config\Services;
 use CodeIgniter\Test\CIUnitTestCase;
-use Generator;
 
 /**
  * @internal
@@ -34,7 +33,7 @@ public function testGet(string $routeKey, string $expected)
         $this->assertSame($expected, $uri);
     }
 
-    public function routeKeyProvider(): Generator
+    public function routeKeyProvider(): iterable
     {
         yield from [
             'root'                => ['/', '/'],

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

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()
+    public function extensionsList(): iterable
     {
         return [
             'null' => [
@@ -55,7 +55,7 @@ public function testGuessExtensionFromType(?string $expected, string $mime)
         $this->assertSame($expected, Mimes::guessExtensionFromType($mime));
     }
 
-    public function mimesList()
+    public function mimesList(): iterable
     {
         return [
             'null' => [

diff --git a/tests/system/Cookie/CookieTest.php b/tests/system/Cookie/CookieTest.php
@@ -16,7 +16,6 @@
 use Config\Cookie as CookieConfig;
 use DateTimeImmutable;
 use DateTimeZone;
-use Generator;
 use LogicException;
 
 /**
@@ -99,7 +98,7 @@ public function testConfigPrefix(string $configPrefix, string $optionPrefix, str
         $this->assertSame($expected, $cookie->getPrefixedName());
     }
 
-    public function prefixProvider(): Generator
+    public function prefixProvider(): iterable
     {
         yield from [
             ['prefix_', '', 'prefix_test'],

diff --git a/tests/system/Database/BaseConnectionTest.php b/tests/system/Database/BaseConnectionTest.php
@@ -14,7 +14,6 @@
 use CodeIgniter\Database\Exceptions\DatabaseException;
 use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\Test\Mock\MockConnection;
-use Generator;
 use Throwable;
 
 /**
@@ -184,7 +183,7 @@ public function testProtectIdentifiers(
         $this->assertSame($expected, $return);
     }
 
-    public function identifiersProvider(): Generator
+    public function identifiersProvider(): 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()
         $this->assertSame($newSQL, $query->getQuery());
     }
 
-    public function queryTypes()
+    public function queryTypes(): iterable
     {
         return [
             'select' => [
@@ -577,7 +577,7 @@ public function testSwapPrefixAfterGetQuery()
         $this->assertSame($expected, $query->getQuery());
     }
 
-    public function queryKeywords()
+    public function queryKeywords(): iterable
     {
         return [
             'highlightKeyWords' => [

diff --git a/tests/system/Database/Builder/WhereTest.php b/tests/system/Database/Builder/WhereTest.php
@@ -392,7 +392,7 @@ public function testWhereInSubQuery()
         $this->assertSame($expectedSQL, str_replace("\n", ' ', $builder->getCompiledSelect()));
     }
 
-    public function provideInvalidKeys()
+    public function provideInvalidKeys(): iterable
     {
         return [
             'null'         => [null],
@@ -413,7 +413,7 @@ public function testWhereInvalidKeyThrowInvalidArgumentException($key)
         $builder->whereIn($key, ['Politician', 'Accountant']);
     }
 
-    public function provideInvalidValues()
+    public function provideInvalidValues(): iterable
     {
         return [
             'null'                    => [null],

diff --git a/tests/system/Database/ConfigTest.php b/tests/system/Database/ConfigTest.php
@@ -13,7 +13,6 @@
 
 use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\Test\ReflectionHelper;
-use Generator;
 
 /**
  * @internal
@@ -209,7 +208,7 @@ public function testConvertDSN(string $input, string $expected)
         $this->assertSame($expected, $this->getPrivateProperty($conn, 'DSN'));
     }
 
-    public function convertDSNProvider(): Generator
+    public function convertDSNProvider(): iterable
     {
         yield from [
             [

diff --git a/tests/system/Email/EmailTest.php b/tests/system/Email/EmailTest.php
@@ -32,7 +32,7 @@ public function testEmailValidation()
         $this->assertStringContainsString('Invalid email address: "invalid"', $email->printDebugger());
     }
 
-    public function autoClearProvider()
+    public function autoClearProvider(): iterable
     {
         return [
             'autoclear'     => [true],

diff --git a/tests/system/Filters/FiltersTest.php b/tests/system/Filters/FiltersTest.php
@@ -208,7 +208,7 @@ public function testProcessMethodProcessGlobals()
         $this->assertSame($expected, $filters->initialize()->getFilters());
     }
 
-    public function provideExcept()
+    public function provideExcept(): iterable
     {
         return [
             [

diff --git a/tests/system/Filters/InvalidCharsTest.php b/tests/system/Filters/InvalidCharsTest.php
@@ -124,7 +124,7 @@ public function testCheckControlStringWithLineBreakAndTabReturnsTheString(string
         $this->invalidChars->before($this->request);
     }
 
-    public function stringWithLineBreakAndTabProvider()
+    public function stringWithLineBreakAndTabProvider(): iterable
     {
         yield from [
             ["String contains \n line break."],
@@ -148,7 +148,7 @@ public function testCheckControlStringWithControlCharsCausesException(string $in
         $this->invalidChars->before($this->request);
     }
 
-    public function stringWithControlCharsProvider()
+    public function stringWithControlCharsProvider(): iterable
     {
         yield from [
             ["String contains null char.\0"],

diff --git a/tests/system/Format/XMLFormatterTest.php b/tests/system/Format/XMLFormatterTest.php
@@ -115,7 +115,7 @@ public function testValidatingInvalidTags(string $expected, array $input)
         $this->assertSame($expectedXML, $this->xmlFormatter->format($input));
     }
 
-    public function invalidTagsProvider()
+    public function invalidTagsProvider(): iterable
     {
         return [
             [

diff --git a/tests/system/HTTP/CLIRequestTest.php b/tests/system/HTTP/CLIRequestTest.php
@@ -517,7 +517,7 @@ public function testFetchGlobalWithEmptyNotation()
         $this->assertSame($expected, $this->request->fetchGlobal('post', 'clients[]'));
     }
 
-    public function ipAddressChecks()
+    public function ipAddressChecks(): iterable
     {
         return [
             'empty' => [

diff --git a/tests/system/HTTP/IncomingRequestTest.php b/tests/system/HTTP/IncomingRequestTest.php
@@ -16,7 +16,6 @@
 use CodeIgniter\HTTP\Files\UploadedFile;
 use CodeIgniter\Test\CIUnitTestCase;
 use Config\App;
-use Generator;
 use InvalidArgumentException;
 use TypeError;
 
@@ -519,7 +518,7 @@ public function testCanGrabGetRawInput()
         $this->assertSame($expected, $request->getRawInput());
     }
 
-    public function provideRawInputVarChecks()
+    public function provideRawInputVarChecks(): iterable
     {
         return [
             [
@@ -627,7 +626,7 @@ public function testIsHTTPMethodLowerCase(string $value)
         $this->assertTrue($request->is(strtolower($value)));
     }
 
-    public function provideIsHTTPMethods(): Generator
+    public function provideIsHTTPMethods(): iterable
     {
         yield from [
             ['GET'],
@@ -840,7 +839,7 @@ public function testGetPostIndexNotExists()
         $this->assertNull($this->request->getGetPost('gc'));
     }
 
-    public function providePathChecks()
+    public function providePathChecks(): iterable
     {
         return [
             'not /index.php' => [

diff --git a/tests/system/HTTP/MessageTest.php b/tests/system/HTTP/MessageTest.php
@@ -185,7 +185,7 @@ public function testSetHeaderArrayValues()
         $this->assertSame('json, html, xml', $this->message->getHeaderLine('Accept'));
     }
 
-    public function provideArrayHeaderValue()
+    public function provideArrayHeaderValue(): iterable
     {
         return [
             'existing for next not append' => [

diff --git a/tests/system/HTTP/RequestTest.php b/tests/system/HTTP/RequestTest.php
@@ -532,7 +532,7 @@ public function testFetchGlobalFiltersWithArrayChildElement()
         $this->assertSame($expected, $this->request->fetchGlobal('post', 'people[0]', FILTER_VALIDATE_INT));
     }
 
-    public function ipAddressChecks()
+    public function ipAddressChecks(): iterable
     {
         return [
             'empty' => [

diff --git a/tests/system/HTTP/ResponseTest.php b/tests/system/HTTP/ResponseTest.php
@@ -291,7 +291,7 @@ public function testRedirect(
         $this->assertSame($expectedCode, $response->getStatusCode());
     }
 
-    public function provideForRedirect()
+    public function provideForRedirect(): iterable
     {
         yield from [
             ['Apache/2.4.17', 'HTTP/1.1', 'GET', null, 302],
@@ -337,7 +337,7 @@ public function testRedirectWithIIS(
         unset($_SERVER['SERVER_SOFTWARE']);
     }
 
-    public function provideForRedirectWithIIS()
+    public function provideForRedirectWithIIS(): iterable
     {
         yield from [
             ['HTTP/1.1', 'GET', null, 302],