release: v1.21.0

This reverts commit e853792a59, reversing
changes made to 205238fcbf.

CHANGELOG.md

@@ -4,6 +4,10 @@ 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.21.0 (2021-11-17)](https://github.com/pestphp/pest/compare/v1.20.0...v1.21.0)
+### Added
+- warn about xdebug modes ([1e011c](https://github.com/pestphp/pest/commit/1e011c7b4074d08f5dabab1f927d45383c85d210))
+
 ## [v1.20.0 (2021-09-25)](https://github.com/pestphp/pest/compare/v1.19.0...v1.20.0)
 ### Added
 - `throwsIf` test call ([#371](https://github.com/pestphp/pest/pull/371))

README.md

@@ -19,14 +19,18 @@
 
 We would like to extend our thanks to the following sponsors for funding Pest development. If you are interested in becoming a sponsor, please visit the Nuno Maduro's [Sponsors page](https://github.com/sponsors/nunomaduro).
 
+### Platinum Sponsors
+
+- **[Spatie](https://spatie.be)**
+- **[Worksome](https://www.worksome.com/)**
+
 ### Premium Sponsors
 
-- **[Akaunting](https://akaunting.com)**
-- **[Auth0](https://auth0.com)**
-- **[Codecourse](https://codecourse.com/)**
-- **[Fathom Analytics](https://usefathom.com/)**
-- **[Meema](https://meema.io)**
-- **[Scout APM](https://scoutapm.com)**
-- **[Spatie](https://spatie.be)**
+- [Akaunting](https://akaunting.com)
+- [Auth0](https://auth0.com)
+- [Codecourse](https://codecourse.com/)
+- [Fathom Analytics](https://usefathom.com/)
+- [Meema](https://meema.io)
+- [Scout APM](https://scoutapm.com)
 
 Pest is an open-sourced software licensed under the **[MIT license](https://opensource.org/licenses/MIT)**.

RELEASE.md

@@ -10,6 +10,7 @@ When releasing a new version of Pest there are some checks and updates that need
 - Push the changes to GitHub
 - Check that the CI is passing as expected: [github.com/pestphp/pest/actions](https://github.com/pestphp/pest/actions)
 - Tag and push the tag with `git tag vX.X.X && git push --tags`
+- Publish release here: [github.com/pestphp/pest/releases/new](https://github.com/pestphp/pest/releases/new).
 
 ### Plugins
 

phpstan-baseline.neon

@@ -0,0 +1,292 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Cannot access an offset on mixed\\.$#"
+			count: 1
+			path: src/Actions/AddsDefaults.php
+
+		-
+			message: "#^Parameter \\#1 \\$out of class Pest\\\\Logging\\\\JUnit constructor expects string, mixed given\\.$#"
+			count: 1
+			path: src/Actions/AddsDefaults.php
+
+		-
+			message: "#^Parameter \\#2 \\$verbose of class NunoMaduro\\\\Collision\\\\Adapters\\\\Phpunit\\\\Printer constructor expects bool, mixed given\\.$#"
+			count: 1
+			path: src/Actions/AddsDefaults.php
+
+		-
+			message: "#^Parameter \\#2 \\$verbose of class Pest\\\\Logging\\\\TeamCity constructor expects bool, mixed given\\.$#"
+			count: 1
+			path: src/Actions/AddsDefaults.php
+
+		-
+			message: "#^Parameter \\#3 \\$colors of class NunoMaduro\\\\Collision\\\\Adapters\\\\Phpunit\\\\Printer constructor expects string, mixed given\\.$#"
+			count: 1
+			path: src/Actions/AddsDefaults.php
+
+		-
+			message: "#^Parameter \\#3 \\$colors of class Pest\\\\Logging\\\\TeamCity constructor expects string, mixed given\\.$#"
+			count: 1
+			path: src/Actions/AddsDefaults.php
+
+		-
+			message: "#^Parameter \\#1 \\$filename of function file_exists expects string, mixed given\\.$#"
+			count: 1
+			path: src/Actions/ValidatesConfiguration.php
+
+		-
+			message: "#^Parameter \\#1 \\$filename of method PHPUnit\\\\TextUI\\\\XmlConfiguration\\\\Loader\\:\\:load\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/Actions/ValidatesConfiguration.php
+
+		-
+			message: "#^Parameter \\#1 \\$loader of class PHPUnit\\\\TextUI\\\\TestRunner constructor expects PHPUnit\\\\Runner\\\\TestSuiteLoader\\|null, mixed given\\.$#"
+			count: 1
+			path: src/Console/Command.php
+
+		-
+			message: "#^Parameter \\#1 \\$testSuite of static method Pest\\\\Actions\\\\AddsTests\\:\\:to\\(\\) expects iterable\\<PHPUnit\\\\Framework\\\\TestCase\\>&PHPUnit\\\\Framework\\\\TestSuite, mixed given\\.$#"
+			count: 1
+			path: src/Console/Command.php
+
+		-
+			message: "#^Parameter \\#2 \\$suffixes of method SebastianBergmann\\\\FileIterator\\\\Facade\\:\\:getFilesAsArray\\(\\) expects array\\|string, mixed given\\.$#"
+			count: 1
+			path: src/Console/Command.php
+
+		-
+			message: "#^Argument of an invalid type mixed supplied for foreach, only iterables are supported\\.$#"
+			count: 1
+			path: src/Datasets.php
+
+		-
+			message: "#^Method Pest\\\\Datasets\\:\\:getDataSetsCombinations\\(\\) has parameter \\$combinations with no value type specified in iterable type array\\.$#"
+			count: 1
+			path: src/Datasets.php
+
+		-
+			message: "#^Method Pest\\\\Datasets\\:\\:getDataSetsCombinations\\(\\) return type has no value type specified in iterable type array\\.$#"
+			count: 1
+			path: src/Datasets.php
+
+		-
+			message: "#^Method Pest\\\\Datasets\\:\\:processDatasets\\(\\) return type has no value type specified in iterable type array\\.$#"
+			count: 1
+			path: src/Datasets.php
+
+		-
+			message: "#^Parameter \\#1 \\$key of static method Pest\\\\Datasets\\:\\:getDataSetDescription\\(\\) expects int\\|string, mixed given\\.$#"
+			count: 1
+			path: src/Datasets.php
+
+		-
+			message: "#^Argument of an invalid type mixed supplied for foreach, only iterables are supported\\.$#"
+			count: 1
+			path: src/Each.php
+
+		-
+			message: "#^Parameter \\#1 \\$ of callable callable\\(Pest\\\\Expectation\\<TValue\\>\\)\\: mixed expects Pest\\\\Expectation\\<TValue\\>, Pest\\\\Expectation\\<mixed\\> given\\.$#"
+			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
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#1 \\$directory of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertDirectoryIsReadable\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#1 \\$directory of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertDirectoryIsWritable\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#1 \\$file of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertFileIsReadable\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#1 \\$file of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertFileIsWritable\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#1 \\$filename of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertFileExists\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#1 \\$json of function json_decode expects string, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#1 \\$needle of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#1 \\$object_or_class of function property_exists expects object\\|string, mixed given\\.$#"
+			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
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#2 \\$haystack of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertCount\\(\\) expects Countable\\|iterable, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#2 \\$string of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertMatchesRegularExpression\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#2 \\$string of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringEndsWith\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#2 \\$string of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringStartsWith\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Parameter \\#2 \\$value of method Pest\\\\Expectation\\<TValue\\>\\:\\:retrieve\\(\\) expects array\\<string, null\\>\\|object, mixed given\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Trying to invoke mixed but it's not a callable\\.$#"
+			count: 1
+			path: src/Expectation.php
+
+		-
+			message: "#^Method Pest\\\\Factories\\\\TestCaseFactory\\:\\:build\\(\\) should return array\\<int, PHPUnit\\\\Framework\\\\TestCase\\> but returns array\\<int, object\\>\\.$#"
+			count: 1
+			path: src/Factories/TestCaseFactory.php
+
+		-
+			message: "#^Function it\\(\\) should return Pest\\\\PendingObjects\\\\TestCall but returns mixed\\.$#"
+			count: 1
+			path: src/Functions.php
+
+		-
+			message: "#^Parameter \\#2 \\$classAndTraits of class Pest\\\\PendingObjects\\\\UsesCall constructor expects array\\<int, string\\>, array\\<int\\|string, string\\> given\\.$#"
+			count: 1
+			path: src/Functions.php
+
+		-
+			message: "#^Parameter \\#2 \\$value of method Pest\\\\HigherOrderExpectation\\:\\:retrieve\\(\\) expects array\\<string, null\\>\\|object, mixed given\\.$#"
+			count: 1
+			path: src/HigherOrderExpectation.php
+
+		-
+			message: "#^Dead catch \\- ReflectionException is never thrown in the try block\\.$#"
+			count: 1
+			path: src/Logging/JUnit.php
+
+		-
+			message: "#^Parameter \\#2 \\$value of method DOMElement\\:\\:setAttribute\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/Logging/JUnit.php
+
+		-
+			message: "#^Parameter \\$test of method Pest\\\\Logging\\\\JUnit\\:\\:startTest\\(\\) has invalid type Pest\\\\Concerns\\\\Testable\\.$#"
+			count: 1
+			path: src/Logging/JUnit.php
+
+		-
+			message: "#^Parameter \\$test of method Pest\\\\Logging\\\\TeamCity\\:\\:endTest\\(\\) has invalid type Pest\\\\Concerns\\\\Testable\\.$#"
+			count: 1
+			path: src/Logging/TeamCity.php
+
+		-
+			message: "#^Parameter \\$test of method Pest\\\\Logging\\\\TeamCity\\:\\:startTest\\(\\) has invalid type Pest\\\\Concerns\\\\Testable\\.$#"
+			count: 1
+			path: src/Logging/TeamCity.php
+
+		-
+			message: "#^Dead catch \\- PHPUnit\\\\Framework\\\\ExpectationFailedException is never thrown in the try block\\.$#"
+			count: 1
+			path: src/OppositeExpectation.php
+
+		-
+			message: "#^Property Pest\\\\PendingObjects\\\\UsesCall\\:\\:\\$groups \\(array\\<int, string\\>\\) does not accept array\\<int\\|string, string\\>\\.$#"
+			count: 1
+			path: src/PendingObjects/UsesCall.php
+
+		-
+			message: "#^Cannot cast mixed to float\\.$#"
+			count: 1
+			path: src/Plugins/Coverage.php
+
+		-
+			message: "#^Static property Pest\\\\Plugins\\\\Environment\\:\\:\\$instance is unused\\.$#"
+			count: 1
+			path: src/Plugins/Environment.php
+
+		-
+			message: "#^Method Pest\\\\Support\\\\Container\\:\\:get\\(\\) should return object but returns mixed\\.$#"
+			count: 1
+			path: src/Support/Container.php
+
+		-
+			message: "#^Argument of an invalid type mixed supplied for foreach, only iterables are supported\\.$#"
+			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
+			path: src/Support/ExceptionTrace.php
+
+		-
+			message: "#^Method Pest\\\\Support\\\\HigherOrderCallables\\:\\:expect\\(\\) should return Pest\\\\Expectation\\<TValue\\> but returns Pest\\\\Expectation\\<mixed\\>\\.$#"
+			count: 1
+			path: src/Support/HigherOrderCallables.php
+
+		-
+			message: "#^Parameter \\#1 \\$target of method Pest\\\\Support\\\\HigherOrderMessage\\:\\:call\\(\\) expects object, mixed given\\.$#"
+			count: 1
+			path: src/Support/HigherOrderMessageCollection.php
+
+		-
+			message: "#^Constant Pest\\\\Support\\\\HigherOrderTapProxy\\:\\:UNDEFINED_PROPERTY is unused\\.$#"
+			count: 1
+			path: src/Support/HigherOrderTapProxy.php
+
+		-
+			message: "#^Dead catch \\- Throwable is never thrown in the try block\\.$#"
+			count: 1
+			path: src/Support/HigherOrderTapProxy.php
+

phpstan.neon

@@ -2,6 +2,7 @@ includes:
     - vendor/phpstan/phpstan-strict-rules/rules.neon
     - vendor/ergebnis/phpstan-rules/rules.neon
     - vendor/thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon
+    - phpstan-baseline.neon
 
 parameters:
     level: max
@@ -23,9 +24,6 @@ parameters:
         -
             message: '#Call to an undefined method PHPUnit\\Framework\\Test::getName\(\)#'
             path: src/Logging
-        -
-            message: '#invalid typehint type Pest\\Concerns\\Testable#'
-            path: src/Logging
         -
             message: '#is not subtype of native type PHPUnit\\Framework\\Test#'
             path: src/Logging

src/Expectation.php

@@ -108,7 +108,6 @@ final class Expectation
     public function ray(...$arguments): self
     {
         if (function_exists('ray')) {
-            // @phpstan-ignore-next-line
             ray($this->value, ...$arguments);
         }
 

src/Logging/JUnit.php

@@ -283,7 +283,6 @@ final class JUnit extends Printer implements TestListener
             $class = new ReflectionClass($test);
             // @codeCoverageIgnoreStart
         } catch (ReflectionException $e) {
-            // @phpstan-ignore-next-line
             throw new Exception($e->getMessage(), (int) $e->getCode(), $e);
         }
         // @codeCoverageIgnoreEnd

src/OppositeExpectation.php

@@ -51,6 +51,8 @@ final class OppositeExpectation
      * Handle dynamic method calls into the original expectation.
      *
      * @param array<int, mixed> $arguments
+     *
+     * @return Expectation|never
      */
     public function __call(string $name, array $arguments): Expectation
     {
@@ -61,12 +63,13 @@ final class OppositeExpectation
             return $this->original;
         }
 
-        // @phpstan-ignore-next-line
         $this->throwExpectationFailedException($name, $arguments);
     }
 
     /**
      * Handle dynamic properties gets into the original expectation.
+     *
+     * @return Expectation|never
      */
     public function __get(string $name): Expectation
     {
@@ -77,7 +80,6 @@ final class OppositeExpectation
             return $this->original;
         }
 
-        // @phpstan-ignore-next-line
         $this->throwExpectationFailedException($name);
     }
 
@@ -85,6 +87,8 @@ final class OppositeExpectation
      * Creates a new expectation failed exception with a nice readable message.
      *
      * @param array<int, mixed> $arguments
+     *
+     * @return never
      */
     private function throwExpectationFailedException(string $name, array $arguments = []): void
     {

src/PendingObjects/TestCall.php

@@ -160,7 +160,7 @@ final class TestCall
 
         $condition = is_callable($condition)
             ? $condition
-            : function () use ($condition) { /* @phpstan-ignore-line */
+            : function () use ($condition) {
                 return $condition;
             };
 

src/Pest.php

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

src/Support/Coverage.php

@@ -30,14 +30,21 @@ final class Coverage
     }
 
     /**
-     * Runs true there is any code
-     * coverage driver available.
+     * Runs true there is any code coverage driver available.
      */
     public static function isAvailable(): bool
     {
         return (new Runtime())->canCollectCodeCoverage();
     }
 
+    /**
+     * If the user is using Xdebug.
+     */
+    public static function usingXdebug(): bool
+    {
+        return (new Runtime())->hasXdebug();
+    }
+
     /**
      * Reports the code coverage report to the
      * console and returns the result in float.
@@ -45,6 +52,14 @@ final class Coverage
     public static function report(OutputInterface $output): float
     {
         if (!file_exists($reportPath = self::getPath())) {
+            if (self::usingXdebug()) {
+                $output->writeln(
+                    "  <fg=black;bg=yellow;options=bold> WARN </> Unable to get coverage using Xdebug. Did you set <href=https://xdebug.org/docs/code_coverage#mode>Xdebug's coverage mode</>?</>",
+                );
+
+                return 0.0;
+            }
+
             throw ShouldNotHappen::fromMessage(sprintf('Coverage not found in path: %s.', $reportPath));
         }