Skip to content

[#2362] Use yield in data providers. #2367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexSkrypnyk merged 1 commit into from
Mar 12, 2026
Merged

[#2362] Use yield in data providers. #2367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .vortex/installer/phpcs.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,10 @@
<exclude-pattern>*.TestCase\.php</exclude-pattern>
<exclude-pattern>*.test</exclude-pattern>
</rule>
<!-- Avoid false positives on type-hinted return statements. -->
<rule ref="Drupal.Commenting.FunctionComment.MissingReturnComment">
<exclude-pattern>*.Test\.php</exclude-pattern>
<exclude-pattern>*.TestCase\.php</exclude-pattern>
<exclude-pattern>*.test</exclude-pattern>
</rule>
</ruleset>
2 changes: 2 additions & 0 deletions .vortex/installer/rector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
use Rector\Naming\Rector\ClassMethod\RenameVariableToMatchNewTypeRector;
use Rector\Php55\Rector\String_\StringClassNameToClassConstantRector;
use Rector\Php80\Rector\Switch_\ChangeSwitchToMatchRector;
use Rector\PHPUnit\CodeQuality\Rector\Class_\YieldDataProviderRector;
use Rector\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector;
use Rector\Privatization\Rector\MethodCall\PrivatizeLocalGetterToPropertyRector;
use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector;
Expand Down Expand Up @@ -80,6 +81,7 @@
// Additional rules.
->withRules([
DeclareStrictTypesRector::class,
YieldDataProviderRector::class,
])
->withFileExtensions([
'php',
Expand Down
3 changes: 3 additions & 0 deletions .vortex/installer/src/Prompts/Handlers/Tools.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,9 @@ public static function getToolDefinitions(string $filter = 'all'): array {
'ahoy test-functional',
'ahoy test -- --filter=TestClassName',
],
'rector.php' => [
'YieldDataProviderRector',
],
],
'ahoy' => [
'/^.*phpunit.*\n?/m',
Expand Down
2 changes: 2 additions & 0 deletions .vortex/installer/tests/Fixtures/handler_process/_baseline/rector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
use Rector\Php80\Rector\Switch_\ChangeSwitchToMatchRector;
use Rector\Php81\Rector\Array_\ArrayToFirstClassCallableRector;
use Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector;
use Rector\PHPUnit\CodeQuality\Rector\Class_\YieldDataProviderRector;
use Rector\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector;
use Rector\Privatization\Rector\MethodCall\PrivatizeLocalGetterToPropertyRector;
use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector;
Expand Down Expand Up @@ -98,6 +99,7 @@
// Additional rules.
->withRules([
DeclareStrictTypesRector::class,
YieldDataProviderRector::class,
])
// Configure Drupal autoloading.
->withAutoloadPaths((function (): array {
Expand Down
155 changes: 77 additions & 78 deletions ...er/tests/Fixtures/handler_process/_baseline/tests/phpunit/Drupal/DatabaseSettingsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,108 +30,107 @@ public function testDatabases(array $vars, array $expected): void {
/**
* Data provider for resulting database settings.
*/
public static function dataProviderDatabases(): array {
return [
public static function dataProviderDatabases(): \Iterator {
yield [
[],
[
[],
[
'default' => [
'default' => [
'default' => [
'database' => 'drupal',
'username' => 'drupal',
'password' => 'drupal',
'host' => 'localhost',
'port' => '3306',
'charset' => 'utf8mb4',
'collation' => 'utf8mb4_general_ci',
'driver' => 'mysql',
'prefix' => '',
],
'database' => 'drupal',
'username' => 'drupal',
'password' => 'drupal',
'host' => 'localhost',
'port' => '3306',
'charset' => 'utf8mb4',
'collation' => 'utf8mb4_general_ci',
'driver' => 'mysql',
'prefix' => '',
],
],
],
];

yield [
[
[
'DATABASE_NAME' => 'database_db_name',
'DATABASE_USERNAME' => 'database_db_user',
'DATABASE_PASSWORD' => 'database_db_pass',
'DATABASE_HOST' => 'database_db_host',
'DATABASE_PORT' => 'database_db_port',
'DATABASE_CHARSET' => 'database_utf8',
'DATABASE_COLLATION' => 'database_utf8_unicode_ci',
],
[
'DATABASE_NAME' => 'database_db_name',
'DATABASE_USERNAME' => 'database_db_user',
'DATABASE_PASSWORD' => 'database_db_pass',
'DATABASE_HOST' => 'database_db_host',
'DATABASE_PORT' => 'database_db_port',
'DATABASE_CHARSET' => 'database_utf8',
'DATABASE_COLLATION' => 'database_utf8_unicode_ci',
],
[
'default' => [
'default' => [
'default' => [
'database' => 'database_db_name',
'username' => 'database_db_user',
'password' => 'database_db_pass',
'host' => 'database_db_host',
'port' => 'database_db_port',
'charset' => 'database_utf8',
'collation' => 'database_utf8_unicode_ci',
'driver' => 'mysql',
'prefix' => '',
],
'database' => 'database_db_name',
'username' => 'database_db_user',
'password' => 'database_db_pass',
'host' => 'database_db_host',
'port' => 'database_db_port',
'charset' => 'database_utf8',
'collation' => 'database_utf8_unicode_ci',
'driver' => 'mysql',
'prefix' => '',
],
],
],
];

yield [
[
[
'MARIADB_DATABASE' => 'mariadb_db_name',
'MARIADB_USERNAME' => 'mariadb_db_user',
'MARIADB_PASSWORD' => 'mariadb_db_pass',
'MARIADB_HOST' => 'mariadb_db_host',
'MARIADB_PORT' => 'mariadb_db_port',
'MARIADB_CHARSET' => 'mariadb_latin1',
'MARIADB_COLLATION' => 'mariadb_latin1_swedish_ci',
],
[
'MARIADB_DATABASE' => 'mariadb_db_name',
'MARIADB_USERNAME' => 'mariadb_db_user',
'MARIADB_PASSWORD' => 'mariadb_db_pass',
'MARIADB_HOST' => 'mariadb_db_host',
'MARIADB_PORT' => 'mariadb_db_port',
'MARIADB_CHARSET' => 'mariadb_latin1',
'MARIADB_COLLATION' => 'mariadb_latin1_swedish_ci',
],
[
'default' => [
'default' => [
'default' => [
'database' => 'mariadb_db_name',
'username' => 'mariadb_db_user',
'password' => 'mariadb_db_pass',
'host' => 'mariadb_db_host',
'port' => 'mariadb_db_port',
'charset' => 'mariadb_latin1',
'collation' => 'mariadb_latin1_swedish_ci',
'driver' => 'mysql',
'prefix' => '',
],
'database' => 'mariadb_db_name',
'username' => 'mariadb_db_user',
'password' => 'mariadb_db_pass',
'host' => 'mariadb_db_host',
'port' => 'mariadb_db_port',
'charset' => 'mariadb_latin1',
'collation' => 'mariadb_latin1_swedish_ci',
'driver' => 'mysql',
'prefix' => '',
],
],
],
];

yield [
[
[
'DATABASE_DATABASE' => 'database_db_name',
'DATABASE_USERNAME' => 'database_db_user',
'DATABASE_PASSWORD' => 'database_db_pass',
'DATABASE_HOST' => 'database_db_host',
'DATABASE_PORT' => 'database_db_port',
'MYSQL_CHARSET' => 'mysql_utf8mb3',
'MYSQL_COLLATION' => 'mysql_utf8mb3_bin',
],
[
'DATABASE_DATABASE' => 'database_db_name',
'DATABASE_USERNAME' => 'database_db_user',
'DATABASE_PASSWORD' => 'database_db_pass',
'DATABASE_HOST' => 'database_db_host',
'DATABASE_PORT' => 'database_db_port',
'MYSQL_CHARSET' => 'mysql_utf8mb3',
'MYSQL_COLLATION' => 'mysql_utf8mb3_bin',
],
[
'default' => [
'default' => [
'default' => [
'database' => 'database_db_name',
'username' => 'database_db_user',
'password' => 'database_db_pass',
'host' => 'database_db_host',
'port' => 'database_db_port',
'charset' => 'mysql_utf8mb3',
'collation' => 'mysql_utf8mb3_bin',
'driver' => 'mysql',
'prefix' => '',
],
'database' => 'database_db_name',
'username' => 'database_db_user',
'password' => 'database_db_pass',
'host' => 'database_db_host',
'port' => 'database_db_port',
'charset' => 'mysql_utf8mb3',
'collation' => 'mysql_utf8mb3_bin',
'driver' => 'mysql',
'prefix' => '',
],
],
],
];

}

}
28 changes: 13 additions & 15 deletions ...tests/Fixtures/handler_process/_baseline/tests/phpunit/Drupal/EnvironmentSettingsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,28 +38,26 @@ public function testEnvironmentTypeDetection(array $vars, string $expected_env):
/**
* Data provider for testing environment type detection.
*/
public static function dataProviderEnvironmentTypeDetection(): array {
return [
// By default, the default environment type is local.
[[], self::ENVIRONMENT_LOCAL],
public static function dataProviderEnvironmentTypeDetection(): \Iterator {
// By default, the default environment type is local.
yield [[], self::ENVIRONMENT_LOCAL];

// CI.
// CI.
yield [
[
[
'CI' => 1,
],
self::ENVIRONMENT_CI,
'CI' => 1,
],
self::ENVIRONMENT_CI,
];

// Container.
// Container.
yield [
[
[
'VORTEX_LOCALDEV_URL' => 'https://example-site.docker.amazee.io',
],
self::ENVIRONMENT_LOCAL,
'VORTEX_LOCALDEV_URL' => 'https://example-site.docker.amazee.io',
],

self::ENVIRONMENT_LOCAL,
];

}

/**
Expand Down
Loading
Loading