release: v1.22.3

[1.x] Fixes ignored dataset description only for string description

.php-cs-fixer.dist.php

@@ -20,6 +20,11 @@ $rules = [
     ],
     'concat_space'            => ['spacing' => 'one'],
     'not_operator_with_space' => false,
+    'global_namespace_import' => [
+        'import_classes'   => true,
+        'import_functions' => true,
+        'import_constants' => true,
+    ],
 ];
 
 $rules['increment_style'] = ['style' => 'post'];

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [v1.22.3 (2022-12-07)](https://github.com/pestphp/pest/compare/v1.22.2...v1.22.3)
+### Fixed
+- Fixes ignoring datasets description on lazy datasets ([#612](https://github.com/pestphp/pest/pull/612))
+
+## [v1.22.2 (2022-11-09)](https://github.com/pestphp/pest/compare/v1.22.1...v1.22.2)
+### Fixed
+- Fixes storing lazy datasets into internal array ([#602](https://github.com/pestphp/pest/pull/602))
+
 ## [v1.22.1 (2022-08-29)](https://github.com/pestphp/pest/compare/v1.22.0...v1.22.1)
 ### Fixed
 - Initial PHP 8.2 support ([d050ef8](https://github.com/pestphp/pest/commit/d050ef8d54ffe8dfe015adeb1188aae2cca33c33))

composer.json

@@ -18,9 +18,9 @@
     ],
     "require": {
         "php": "^7.3 || ^8.0",
-        "nunomaduro/collision": "^5.10.0|^6.0",
-        "pestphp/pest-plugin": "^1.0.0",
-        "phpunit/phpunit": "^9.5.5"
+        "nunomaduro/collision": "^5.11.0|^6.3.0",
+        "pestphp/pest-plugin": "^1.1.0",
+        "phpunit/phpunit": "^9.5.26"
     },
     "autoload": {
         "psr-4": {
@@ -40,11 +40,11 @@
         ]
     },
     "require-dev": {
-        "illuminate/console": "^8.47.0",
-        "illuminate/support": "^8.47.0",
-        "laravel/dusk": "^6.15.0",
-        "pestphp/pest-dev-tools": "dev-master",
-        "pestphp/pest-plugin-parallel": "^1.0"
+        "illuminate/console": "^8.83.26",
+        "illuminate/support": "^8.83.26",
+        "laravel/dusk": "^6.25.2",
+        "pestphp/pest-dev-tools": "^1.0.0",
+        "pestphp/pest-plugin-parallel": "^1.2"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,

phpstan-baseline.neon

@@ -90,11 +90,6 @@ parameters:
 			count: 1
 			path: src/Expectation.php
 
-		-
-			message: "#^Parameter \\#1 \\$actualJson of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertJson\\(\\) expects string, mixed given\\.$#"
-			count: 1
-			path: src/Expectation.php
-
 		-
 			message: "#^Parameter \\#1 \\$directory of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertDirectoryExists\\(\\) expects string, mixed given\\.$#"
 			count: 1
@@ -250,16 +245,6 @@ parameters:
 			count: 1
 			path: src/Support/ExceptionTrace.php
 
-		-
-			message: "#^Cannot access offset 'file' on mixed\\.$#"
-			count: 1
-			path: src/Support/ExceptionTrace.php
-
-		-
-			message: "#^Parameter \\#1 \\$haystack of function mb_strpos expects string, mixed given\\.$#"
-			count: 1
-			path: src/Support/ExceptionTrace.php
-
 		-
 			message: "#^Parameter \\#2 \\$array of function key_exists expects array, mixed given\\.$#"
 			count: 1

src/Concerns/Testable.php

@@ -9,6 +9,9 @@ use Pest\Support\ChainableClosure;
 use Pest\Support\ExceptionTrace;
 use Pest\TestSuite;
 use PHPUnit\Framework\ExecutionOrderDependency;
+
+use function sprintf;
+
 use Throwable;
 
 /**
@@ -257,7 +260,7 @@ trait Testable
      */
     public function toString(): string
     {
-        return \sprintf(
+        return sprintf(
             '%s::%s',
             self::$__filename,
             $this->__description

src/Console/Command.php

@@ -4,6 +4,8 @@ declare(strict_types=1);
 
 namespace Pest\Console;
 
+use function is_dir;
+
 use Pest\Actions\AddsDefaults;
 use Pest\Actions\AddsTests;
 use Pest\Actions\InteractsWithPlugins;
@@ -81,7 +83,7 @@ final class Command extends BaseCommand
         $testSuite  = $this->arguments['test'];
 
         if (is_string($testSuite)) {
-            if (\is_dir($testSuite)) {
+            if (is_dir($testSuite)) {
                 /** @var string[] $files */
                 $files = (new FileIteratorFacade())->getFilesAsArray(
                     $testSuite,

src/Datasets.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace Pest;
 
 use Closure;
+use Generator;
 use Pest\Exceptions\DatasetAlreadyExist;
 use Pest\Exceptions\DatasetDoesNotExist;
 use SebastianBergmann\Exporter\Exporter;
@@ -122,7 +123,10 @@ final class Datasets
             }
 
             if ($datasets[$index] instanceof Traversable) {
-                $datasets[$index] = iterator_to_array($datasets[$index]);
+                $preserveKeysForArrayIterator = $datasets[$index] instanceof Generator
+                    && is_string($datasets[$index]->key());
+
+                $datasets[$index] = iterator_to_array($datasets[$index], $preserveKeysForArrayIterator);
             }
 
             foreach ($datasets[$index] as $key => $values) {

src/Logging/TeamCity.php

@@ -86,6 +86,7 @@ final class TeamCity extends DefaultResultPrinter
         foreach ($filteredResults as $key => $info) {
             $this->writeWithColor($info['color'], $info['count'] . " $key", false);
 
+            /* @phpstan-ignore-next-line */
             if ($key !== array_reverse(array_keys($filteredResults))[0]) {
                 $this->write(', ');
             }

src/PendingObjects/TestCall.php

@@ -102,7 +102,7 @@ final class TestCall
      * Runs the current test multiple times with
      * each item of the given `iterable`.
      *
-     * @param array<\Closure|iterable<int|string, mixed>|string> $data
+     * @param array<Closure|iterable<int|string, mixed>|string> $data
      */
     public function with(...$data): TestCall
     {

src/Pest.php

@@ -6,7 +6,7 @@ namespace Pest;
 
 function version(): string
 {
-    return '1.22.1';
+    return '1.22.3';
 }
 
 function testDirectory(string $file = ''): string

src/Support/ExceptionTrace.php

@@ -44,7 +44,6 @@ final class ExceptionTrace
      */
     public static function removePestReferences(Throwable $t): void
     {
-        /* @phpstan-ignore-next-line */
         if (!property_exists($t, 'serializableTrace')) {
             return;
         }

src/Support/HigherOrderMessage.php

@@ -5,6 +5,9 @@ declare(strict_types=1);
 namespace Pest\Support;
 
 use Closure;
+
+use const PHP_MAJOR_VERSION;
+
 use ReflectionClass;
 use Throwable;
 
@@ -132,7 +135,7 @@ final class HigherOrderMessage
 
     private static function getUndefinedMethodMessage(object $target, string $methodName): string
     {
-        if (\PHP_MAJOR_VERSION >= 8) {
+        if (PHP_MAJOR_VERSION >= 8) {
             return sprintf(sprintf(self::UNDEFINED_METHOD, sprintf('%s::%s()', get_class($target), $methodName)));
         }
 

tests/.snapshots/success.txt

@@ -96,6 +96,13 @@
   ✓ more than two datasets with (2) / (4) / (5)
   ✓ more than two datasets with (2) / (4) / (6)
   ✓ more than two datasets did the job right
+  ✓ eager registered wrapped datasets with Generator functions with (1)
+  ✓ eager registered wrapped datasets with Generator functions with (2)
+  ✓ eager registered wrapped datasets with Generator functions with (3)
+  ✓ eager registered wrapped datasets with Generator functions with (4)
+  ✓ eager registered wrapped datasets with Generator functions did the job right
+  ✓ eager registered wrapped datasets with Generator functions display description with data set "taylor"
+  ✓ eager registered wrapped datasets with Generator functions display description with data set "james"
   ✓ it can resolve a dataset after the test case is available with (Closure Object (...))
   ✓ it can resolve a dataset after the test case is available with shared yield sets with (Closure Object (...)) #1
   ✓ it can resolve a dataset after the test case is available with shared yield sets with (Closure Object (...)) #2
@@ -722,5 +729,5 @@
   ✓ it is a test
   ✓ it uses correct parent class
 
-  Tests:  4 incompleted, 9 skipped, 480 passed
+  Tests:  4 incompleted, 9 skipped, 487 passed
   

tests/Datasets/Numbers.php

@@ -13,3 +13,20 @@ dataset('numbers.closure.wrapped', function () {
 dataset('numbers.array', [[1], [2]]);
 
 dataset('numbers.array.wrapped', [1, 2]);
+
+dataset('numbers.generators.wrapped', function () {
+    yield from firstSetOfNumber();
+    yield from secondSetOfNumbers();
+});
+
+function firstSetOfNumber(): Generator
+{
+    yield 1;
+    yield 2;
+}
+
+function secondSetOfNumbers(): Generator
+{
+    yield 3;
+    yield 4;
+}

tests/Features/Datasets.php

@@ -228,10 +228,38 @@ test('more than two datasets did the job right', function () use ($state) {
     expect($state->text)->toBe('121212121212131423241314232411122122111221221112212213142324135136145146235236245246');
 });
 
+$wrapped_generator_state             = new stdClass();
+$wrapped_generator_state->text       = '';
+$wrapped_generator_function_datasets = [1, 2, 3, 4];
+
+test(
+    'eager registered wrapped datasets with Generator functions',
+    function (int $text) use (
+        $wrapped_generator_state,
+        $wrapped_generator_function_datasets
+    ) {
+        $wrapped_generator_state->text .= $text;
+        expect(in_array($text, $wrapped_generator_function_datasets))->toBe(true);
+    }
+)->with('numbers.generators.wrapped');
+
+test('eager registered wrapped datasets with Generator functions did the job right', function () use ($wrapped_generator_state) {
+    expect($wrapped_generator_state->text)->toBe('1234');
+});
+
+test('eager registered wrapped datasets with Generator functions display description', function ($wrapped_generator_state_with_description) {
+    expect($wrapped_generator_state_with_description)->not->toBeEmpty();
+})->with(function () {
+    yield 'taylor' => 'taylor@laravel.com';
+    yield 'james' => 'james@laravel.com';
+});
+
 it('can resolve a dataset after the test case is available', function ($result) {
     expect($result)->toBe('bar');
 })->with([
-    function () { return $this->foo; },
+    function () {
+        return $this->foo;
+    },
 ]);
 
 it('can resolve a dataset after the test case is available with shared yield sets', function ($result) {