release: v1.22.0

[1.x] Dynamic properties handling

CHANGELOG.md

@@ -4,6 +4,18 @@ 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.0 (2022-08-28)](https://github.com/pestphp/pest/compare/v1.21.3...v1.22.0)
+### Added
+- Initial PHP 8.2 support ([#563](https://github.com/pestphp/pest/pull/563))
+
+## [v1.21.3 (2022-05-12)](https://github.com/pestphp/pest/compare/v1.21.2...v1.21.3)
+### Fixed
+- Debug of high order tests ([c1b32b9](https://github.com/pestphp/pest/commit/c1b32b9ffb5134803c490592454b11b8c05ea27d))
+
+## [v1.21.2 (2022-03-05)](https://github.com/pestphp/pest/compare/v1.21.1...v1.21.2)
+### Fixed
+- `toThrow` expectation when exception does not exist ([#487](https://github.com/pestphp/pest/pull/487))
+
 ## [v1.21.1 (2021-11-25)](https://github.com/pestphp/pest/compare/v1.21.0...v1.21.1)
 ### Fixed
 - sequence callables causing problems ([#442](https://github.com/pestphp/pest/pull/442))

RELEASE.md

@@ -2,8 +2,8 @@
 
 When releasing a new version of Pest there are some checks and updates that need to be done:
 
-- Clear your local repository with: `git add . && git reset --hard && git checkout master` 
-- On the GitHub repository, check the contents of [github.com/pestphp/pest/compare/{latest_version}...master](https://github.com/pestphp/pest/compare/{latest_version}...master) and update the [changelog](CHANGELOG.md) file with the main changes for this release
+- Clear your local repository with: `git add . && git reset --hard && git checkout 1.x` 
+- On the GitHub repository, check the contents of [github.com/pestphp/pest/compare/{latest_version}...1.x](https://github.com/pestphp/pest/compare/{latest_version}...1.x) and update the [changelog](CHANGELOG.md) file with the main changes for this release
 - Update the version number in [src/Pest.php](src/Pest.php)
 - Run the tests locally using: `composer test`
 - Commit the CHANGELOG and Pest file with the message: `git commit -m "release: vX.X.X"`

composer.json

@@ -18,7 +18,7 @@
     ],
     "require": {
         "php": "^7.3 || ^8.0",
-        "nunomaduro/collision": "^5.4.0|^6.0",
+        "nunomaduro/collision": "^5.10.0|^6.0",
         "pestphp/pest-plugin": "^1.0.0",
         "phpunit/phpunit": "^9.5.5"
     },
@@ -50,7 +50,10 @@
     "prefer-stable": true,
     "config": {
         "sort-packages": true,
-        "preferred-install": "dist"
+        "preferred-install": "dist",
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     },
     "bin": [
         "bin/pest"
@@ -73,7 +76,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.x-dev"
+            "dev-1.x": "1.x-dev"
         },
         "pest": {
             "plugins": [

phpstan-baseline.neon

@@ -140,11 +140,6 @@ parameters:
 			count: 2
 			path: src/Expectation.php
 
-		-
-			message: "#^Parameter \\#1 \\$value of method Pest\\\\Expectation\\<TValue\\>\\:\\:and\\(\\) expects TValue, mixed given\\.$#"
-			count: 2
-			path: src/Expectation.php
-
 		-
 			message: "#^Parameter \\#2 \\$haystack of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertContains\\(\\) expects iterable, mixed given\\.$#"
 			count: 1

src/Actions/LoadStructure.php

@@ -5,7 +5,9 @@ declare(strict_types=1);
 namespace Pest\Actions;
 
 use Pest\Support\Str;
+
 use function Pest\testDirectory;
+
 use PHPUnit\Util\FileLoader;
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
@@ -50,6 +52,7 @@ final class LoadStructure
                 $directory = new RecursiveDirectoryIterator($filename);
                 $iterator  = new RecursiveIteratorIterator($directory);
                 foreach ($iterator as $file) {
+                    /* @phpstan-ignore-next-line */
                     $filename = $file->__toString();
                     if (Str::endsWith($filename, '.php') && file_exists($filename)) {
                         require_once $filename;

src/Expectation.php

@@ -6,6 +6,7 @@ namespace Pest;
 
 use BadMethodCallException;
 use Closure;
+use Error;
 use InvalidArgumentException;
 use Pest\Concerns\Extendable;
 use Pest\Concerns\RetrievesValues;
@@ -911,8 +912,12 @@ final class Expectation
 
         try {
             ($this->value)();
-        } catch (Throwable $e) { // @phpstan-ignore-line
+        } catch (Throwable $e) {
             if (!class_exists($exception)) {
+                if ($e instanceof Error && (bool) preg_match("/Class [\"']{$exception}[\"'] not found/", $e->getMessage())) {
+                    throw $e;
+                }
+
                 Assert::assertStringContainsString($exception, $e->getMessage());
 
                 return $this;

src/Factories/TestCaseFactory.php

@@ -216,6 +216,7 @@ final class TestCaseFactory
             eval("
                 namespace $namespace;
 
+                #[AllowDynamicProperties]
                 final class $className extends $baseClass implements $hasPrintableTestCaseClassFQN {
                     $traitsCode
 

src/Laravel/Commands/PestDatasetCommand.php

@@ -8,7 +8,9 @@ use Illuminate\Console\Command;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Str;
 use Pest\Exceptions\InvalidConsoleArgument;
+
 use function Pest\testDirectory;
+
 use Pest\TestSuite;
 
 /**

src/Laravel/Commands/PestInstallCommand.php

@@ -8,7 +8,9 @@ use Illuminate\Console\Command;
 use Illuminate\Support\Facades\File;
 use Pest\Console\Thanks;
 use Pest\Exceptions\InvalidConsoleArgument;
+
 use function Pest\testDirectory;
+
 use Pest\TestSuite;
 
 /**

src/Laravel/Commands/PestTestCommand.php

@@ -8,7 +8,9 @@ use Illuminate\Console\Command;
 use Illuminate\Support\Facades\File;
 use Pest\Exceptions\InvalidConsoleArgument;
 use Pest\Support\Str;
+
 use function Pest\testDirectory;
+
 use Pest\TestSuite;
 
 /**

src/Logging/JUnit.php

@@ -13,11 +13,14 @@ declare(strict_types=1);
 namespace Pest\Logging;
 
 use function class_exists;
+
 use DOMDocument;
 use DOMElement;
 use Exception;
+
 use function get_class;
 use function method_exists;
+
 use Pest\Concerns\Testable;
 use PHPUnit\Framework\AssertionFailedError;
 use PHPUnit\Framework\ExceptionWrapper;
@@ -32,9 +35,12 @@ use PHPUnit\Util\Printer;
 use PHPUnit\Util\Xml;
 use ReflectionClass;
 use ReflectionException;
+
 use function sprintf;
 use function str_replace;
+
 use Throwable;
+
 use function trim;
 
 /**
@@ -173,7 +179,6 @@ final class JUnit extends Printer implements TestListener
         $this->doAddSkipped();
     }
 
-    /** @phpstan-ignore-next-line */
     public function startTestSuite(TestSuite $suite): void
     {
         $testSuite = $this->document->createElement('testsuite');
@@ -212,7 +217,6 @@ final class JUnit extends Printer implements TestListener
         $this->testSuiteTimes[$this->testSuiteLevel]      = 0;
     }
 
-    /** @phpstan-ignore-next-line */
     public function endTestSuite(TestSuite $suite): void
     {
         $this->testSuites[$this->testSuiteLevel]->setAttribute(

src/Logging/TeamCity.php

@@ -5,10 +5,13 @@ declare(strict_types=1);
 namespace Pest\Logging;
 
 use function getmypid;
+
 use Pest\Concerns\Logging\WritesToConsole;
 use Pest\Concerns\Testable;
 use Pest\Support\ExceptionTrace;
+
 use function Pest\version;
+
 use PHPUnit\Framework\AssertionFailedError;
 use PHPUnit\Framework\Test;
 use PHPUnit\Framework\TestCase;
@@ -16,9 +19,11 @@ use PHPUnit\Framework\TestResult;
 use PHPUnit\Framework\TestSuite;
 use PHPUnit\Framework\Warning;
 use PHPUnit\TextUI\DefaultResultPrinter;
+
 use function round;
 use function str_replace;
 use function strlen;
+
 use Throwable;
 
 final class TeamCity extends DefaultResultPrinter
@@ -106,7 +111,6 @@ final class TeamCity extends DefaultResultPrinter
             - $result->riskyCount();
     }
 
-    /** @phpstan-ignore-next-line */
     public function startTestSuite(TestSuite $suite): void
     {
         $suiteName = $suite->getName();
@@ -164,7 +168,6 @@ final class TeamCity extends DefaultResultPrinter
         );
     }
 
-    /** @phpstan-ignore-next-line */
     public function endTestSuite(TestSuite $suite): void
     {
         $suiteName = $suite->getName();

src/PendingObjects/TestCall.php

@@ -183,7 +183,7 @@ final class TestCall
      */
     public function __get(string $name): self
     {
-        return $this->addChain($name);
+        return $this->addChain(Backtrace::file(), Backtrace::line(), $name);
     }
 
     /**
@@ -193,7 +193,7 @@ final class TestCall
      */
     public function __call(string $name, array $arguments): self
     {
-        return $this->addChain($name, $arguments);
+        return $this->addChain(Backtrace::file(), Backtrace::line(), $name, $arguments);
     }
 
     /**
@@ -201,11 +201,11 @@ final class TestCall
      *
      * @param array<int, mixed>|null $arguments
      */
-    private function addChain(string $name, array $arguments = null): self
+    private function addChain(string $file, int $line, string $name, array $arguments = null): self
     {
         $this->testCaseFactory
             ->chains
-            ->add(Backtrace::file(), Backtrace::line(), $name, $arguments);
+            ->add($file, $line, $name, $arguments);
 
         if ($this->descriptionLess) {
             $exporter = new Exporter();

src/Pest.php

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

src/Plugins/Version.php

@@ -5,7 +5,9 @@ declare(strict_types=1);
 namespace Pest\Plugins;
 
 use Pest\Contracts\Plugins\HandlesArguments;
+
 use function Pest\version;
+
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**

src/Support/Backtrace.php

@@ -26,6 +26,7 @@ final class Backtrace
         $current = null;
 
         foreach (debug_backtrace(self::BACKTRACE_OPTIONS) as $trace) {
+            assert(array_key_exists(self::FILE, $trace));
             if (Str::endsWith($trace[self::FILE], (string) realpath('vendor/phpunit/phpunit/src/Util/FileLoader.php'))) {
                 break;
             }
@@ -45,7 +46,11 @@ final class Backtrace
      */
     public static function file(): string
     {
-        return debug_backtrace(self::BACKTRACE_OPTIONS)[1][self::FILE];
+        $trace = debug_backtrace(self::BACKTRACE_OPTIONS)[1];
+
+        assert(array_key_exists(self::FILE, $trace));
+
+        return $trace[self::FILE];
     }
 
     /**
@@ -53,7 +58,11 @@ final class Backtrace
      */
     public static function dirname(): string
     {
-        return dirname(debug_backtrace(self::BACKTRACE_OPTIONS)[1][self::FILE]);
+        $trace = debug_backtrace(self::BACKTRACE_OPTIONS)[1];
+
+        assert(array_key_exists(self::FILE, $trace));
+
+        return dirname($trace[self::FILE]);
     }
 
     /**
@@ -61,6 +70,10 @@ final class Backtrace
      */
     public static function line(): int
     {
-        return debug_backtrace(self::BACKTRACE_OPTIONS)[1]['line'];
+        $trace = debug_backtrace(self::BACKTRACE_OPTIONS)[1];
+
+        assert(array_key_exists('line', $trace));
+
+        return $trace['line'];
     }
 }

tests/.snapshots/success.txt

@@ -496,6 +496,8 @@
   ✓ not failures
   ✓ closure missing parameter
   ✓ closure missing type-hint
+  ✓ it can handle a non-defined exception
+  ✓ it can handle a class not found Error
 
    PASS  Tests\Features\Expect\unless
   ✓ it pass
@@ -720,5 +722,5 @@
   ✓ it is a test
   ✓ it uses correct parent class
 
-  Tests:  4 incompleted, 9 skipped, 478 passed
+  Tests:  4 incompleted, 9 skipped, 480 passed
   

tests/Features/Expect/sequence.php

@@ -9,9 +9,15 @@ test('an exception is thrown if the the type is not iterable', function () {
 test('allows for sequences of checks to be run on iterable data', function () {
     expect([1, 2, 3])
         ->sequence(
-            function ($expectation) { $expectation->toBeInt()->toEqual(1); },
-            function ($expectation) { $expectation->toBeInt()->toEqual(2); },
-            function ($expectation) { $expectation->toBeInt()->toEqual(3); },
+            function ($expectation) {
+                $expectation->toBeInt()->toEqual(1);
+            },
+            function ($expectation) {
+                $expectation->toBeInt()->toEqual(2);
+            },
+            function ($expectation) {
+                $expectation->toBeInt()->toEqual(3);
+            },
         );
 
     expect(static::getCount())->toBe(6);
@@ -20,9 +26,15 @@ test('allows for sequences of checks to be run on iterable data', function () {
 test('loops back to the start if it runs out of sequence items', function () {
     expect([1, 2, 3, 1, 2, 3, 1, 2])
         ->sequence(
-            function ($expectation) { $expectation->toBeInt()->toEqual(1); },
-            function ($expectation) { $expectation->toBeInt()->toEqual(2); },
-            function ($expectation) { $expectation->toBeInt()->toEqual(3); },
+            function ($expectation) {
+                $expectation->toBeInt()->toEqual(1);
+            },
+            function ($expectation) {
+                $expectation->toBeInt()->toEqual(2);
+            },
+            function ($expectation) {
+                $expectation->toBeInt()->toEqual(3);
+            },
         );
 
     expect(static::getCount())->toBe(16);
@@ -31,17 +43,29 @@ test('loops back to the start if it runs out of sequence items', function () {
 test('fails if the number of iterable items is greater than the number of expectations', function () {
     expect([1, 2])
         ->sequence(
-            function ($expectation) { $expectation->toBeInt()->toEqual(1); },
-            function ($expectation) { $expectation->toBeInt()->toEqual(2); },
-            function ($expectation) { $expectation->toBeInt()->toEqual(3); },
+            function ($expectation) {
+                $expectation->toBeInt()->toEqual(1);
+            },
+            function ($expectation) {
+                $expectation->toBeInt()->toEqual(2);
+            },
+            function ($expectation) {
+                $expectation->toBeInt()->toEqual(3);
+            },
         );
 })->throws(ExpectationFailedException::class);
 
 test('it works with associative arrays', function () {
     expect(['foo' => 'bar', 'baz' => 'boom'])
         ->sequence(
-            function ($expectation, $key) { $expectation->toEqual('bar'); $key->toEqual('foo'); },
-            function ($expectation, $key) { $expectation->toEqual('boom'); $key->toEqual('baz'); },
+            function ($expectation, $key) {
+                $expectation->toEqual('bar');
+                $key->toEqual('foo');
+            },
+            function ($expectation, $key) {
+                $expectation->toEqual('boom');
+                $key->toEqual('baz');
+            },
         );
 });
 
@@ -54,7 +78,9 @@ test('it can be passed non-callable values', function () {
 test('it can be passed a mixture of value types', function () {
     expect(['foo', 'bar', 'baz'])->sequence(
         'foo',
-        function ($expectation) { $expectation->toEqual('bar')->toBeString(); },
+        function ($expectation) {
+            $expectation->toEqual('bar')->toBeString();
+        },
         'baz'
     );
 

tests/Features/Expect/toThrow.php

@@ -58,3 +58,15 @@ test('closure missing parameter', function () {
 test('closure missing type-hint', function () {
     expect(function () {})->toThrow(function ($e) {});
 })->throws(InvalidArgumentException::class, 'The given closure\'s parameter must be type-hinted as the class string.');
+
+it('can handle a non-defined exception', function () {
+    expect(function () {
+        throw new NonExistingException();
+    })->toThrow(NonExistingException::class);
+})->throws(Error::class);
+
+it('can handle a class not found Error', function () {
+    expect(function () {
+        throw new NonExistingException();
+    })->toThrow(Error::class);
+});

tests/PHPUnit/CustomTestCase/CustomTestCase.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace Tests\CustomTestCase;
 
 use function PHPUnit\Framework\assertTrue;
+
 use PHPUnit\Framework\TestCase;
 
 class CustomTestCase extends TestCase

tests/PHPUnit/CustomTestCase/ExecutedTest.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace Tests\CustomTestCase;
 
 use function PHPUnit\Framework\assertTrue;
+
 use PHPUnit\Framework\TestCase;
 
 class ExecutedTest extends TestCase

tests/Unit/Plugins/Version.php

@@ -1,7 +1,9 @@
 <?php
 
 use Pest\Plugins\Version;
+
 use function Pest\version;
+
 use Symfony\Component\Console\Output\BufferedOutput;
 
 it('outputs the version when --version is used', function () {