docs: update changelog

chore(deps): add support for PHPUnit 9.5.3

.github/FUNDING.yml

@@ -1,5 +1,5 @@
 # These are supported funding model platforms
 
-github: nunomaduro
+github: [nunomaduro,owenvoke,olivernybroe,octoper]
 patreon: nunomaduro
 custom: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=66BYDWAT92N6L

.github/workflows/static.yml

@@ -15,7 +15,7 @@ jobs:
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
       with:
-        php-version: 7.4
+        php-version: 8.0
         tools: composer:v2
         coverage: none
 
@@ -40,7 +40,7 @@ jobs:
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
       with:
-        php-version: 7.4
+        php-version: 8.0
         tools: composer:v2
         coverage: none
 

CHANGELOG.md

@@ -4,6 +4,33 @@ 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.0.4 (2021-03-17)](https://github.com/pestphp/pest/compare/v1.0.3...v1.0.4)
+### Added
+- Support for PHPUnit 9.5.3 ([#278](https://github.com/pestphp/pest/pull/278))
+
+## [v1.0.3 (2021-03-13)](https://github.com/pestphp/pest/compare/v1.0.2...v1.0.3)
+### Added
+- Support for test extensions ([#269](https://github.com/pestphp/pest/pull/269))
+
+## [v1.0.2 (2021-02-04)](https://github.com/pestphp/pest/compare/v1.0.1...v1.0.2)
+### Added
+- Support for PHPUnit 9.5.2 ([#267](https://github.com/pestphp/pest/pull/267))
+
+## [v1.0.1 (2021-01-18)](https://github.com/pestphp/pest/compare/v1.0.0...v1.0.1)
+### Added
+- Support for PHPUnit 9.5.1 ([#261](https://github.com/pestphp/pest/pull/261))
+
+### Fixed
+- Fix `TestCase@expect` PHPDoc tag ([#251](https://github.com/pestphp/pest/pull/251))
+
+## [v1.0.0 (2021-01-03)](https://github.com/pestphp/pest/compare/v0.3.19...v1.0.0)
+### Added
+- `pest:test --dusk` option ([#245](https://github.com/pestphp/pest/pull/245))
+
+### Changed
+- Stable version
+- Updates init structure ([#240](https://github.com/pestphp/pest/pull/240))
+
 ## [v0.3.19 (2020-12-27)](https://github.com/pestphp/pest/compare/v0.3.18...v0.3.19)
 ### Fixed
 - Fix binary path in `pest:dusk` command ([#239](https://github.com/pestphp/pest/pull/239))

README.md

@@ -21,6 +21,7 @@ We would like to extend our thanks to the following sponsors for funding Pest de
 
 ### Premium Sponsors
 
-- **[Scout APM](https://github.com/scoutapp)**
+- **[Scout APM](https://scoutapm.com)**
+- **[Akaunting](https://akaunting.com)**
 
 Pest was created by **[Nuno Maduro](https://twitter.com/enunomaduro)** under the **[Sponsorware license](https://github.com/sponsorware/docs)**. It got open-sourced and is now licensed under the **[MIT license](https://opensource.org/licenses/MIT)**.

composer.json

@@ -19,11 +19,11 @@
     "require": {
         "php": "^7.3 || ^8.0",
         "nunomaduro/collision": "^5.0",
-        "pestphp/pest-plugin": "^0.3",
-        "pestphp/pest-plugin-coverage": "^0.3",
-        "pestphp/pest-plugin-expectations": "^0.3.3",
-        "pestphp/pest-plugin-init": "^0.3",
-        "phpunit/phpunit": ">= 9.3.7 <= 9.5.0"
+        "pestphp/pest-plugin": "^1.0",
+        "pestphp/pest-plugin-coverage": "^1.0",
+        "pestphp/pest-plugin-expectations": "^1.0",
+        "pestphp/pest-plugin-init": "^1.0",
+        "phpunit/phpunit": ">= 9.3.7 <= 9.5.3"
     },
     "autoload": {
         "psr-4": {
@@ -43,10 +43,10 @@
         ]
     },
     "require-dev": {
-        "illuminate/console": "^7.16.1",
-        "illuminate/support": "^7.16.1",
-        "laravel/dusk": "^6.9.1",
-        "mockery/mockery": "^1.4.1",
+        "illuminate/console": "^8.32.1",
+        "illuminate/support": "^8.32.1",
+        "laravel/dusk": "^6.13.0",
+        "mockery/mockery": "^1.4.3",
         "pestphp/pest-dev-tools": "dev-master"
     },
     "minimum-stability": "dev",
@@ -74,7 +74,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "0.3.x-dev"
+            "dev-master": "1.x-dev"
         },
         "pest": {
             "plugins": [

phpstan.neon

@@ -14,7 +14,6 @@ parameters:
 
     ignoreErrors:
         - "#type mixed is not subtype of native#"
-        - "#Undefined variable: \\$this#"
         - "#is not allowed to extend#"
         - "#Language construct eval#"
         - "# with null as default value#"

src/Factories/TestCaseFactory.php

@@ -5,14 +5,17 @@ declare(strict_types=1);
 namespace Pest\Factories;
 
 use Closure;
+use ParseError;
 use Pest\Concerns;
 use Pest\Contracts\HasPrintableTestCaseName;
 use Pest\Datasets;
 use Pest\Exceptions\ShouldNotHappen;
 use Pest\Support\HigherOrderMessageCollection;
 use Pest\Support\NullClosure;
+use Pest\Support\Str;
 use Pest\TestSuite;
 use PHPUnit\Framework\TestCase;
+use RuntimeException;
 
 /**
  * @internal
@@ -139,6 +142,7 @@ final class TestCaseFactory
             $proxies->proxy($this);
             $chains->chain($this);
 
+            /* @phpstan-ignore-next-line */
             return call_user_func(Closure::bind($factoryTest, $this, get_class($this)), ...func_get_args());
         };
 
@@ -168,7 +172,7 @@ final class TestCaseFactory
             }, $filename);
         }
 
-        $filename     = (string) realpath($filename);
+        $filename     = str_replace('\\\\', '\\', addslashes((string) realpath($filename)));
         $rootPath     = TestSuite::getInstance()->rootPath;
         $relativePath = str_replace($rootPath . DIRECTORY_SEPARATOR, '', $filename);
         $relativePath = dirname(ucfirst($relativePath)) . DIRECTORY_SEPARATOR . basename($relativePath, '.php');
@@ -176,8 +180,12 @@ final class TestCaseFactory
 
         // Strip out any %-encoded octets.
         $relativePath = (string) preg_replace('|%[a-fA-F0-9][a-fA-F0-9]|', '', $relativePath);
+        // Remove escaped quote sequences (maintain namespace)
+        $relativePath = str_replace(array_map(function (string $quote): string {
+            return sprintf('\\%s', $quote);
+        }, ['\'', '"']), '', $relativePath);
         // Limit to A-Z, a-z, 0-9, '_', '-'.
-        $relativePath = (string) preg_replace('/[^A-Za-z0-9.\\\]/', '', $relativePath);
+        $relativePath = (string) preg_replace('/[^A-Za-z0-9\\\\]/', '', $relativePath);
 
         $classFQN = 'P\\' . $relativePath;
         if (class_exists($classFQN)) {
@@ -194,15 +202,24 @@ final class TestCaseFactory
         $namespace = implode('\\', $partsFQN);
         $baseClass = sprintf('\%s', $this->class);
 
-        eval("
-            namespace $namespace;
+        if ('' === trim($className)) {
+            $className = 'InvalidTestName' . Str::random();
+            $classFQN .= $className;
+        }
 
-            final class $className extends $baseClass implements $hasPrintableTestCaseClassFQN {
-                $traitsCode
+        try {
+            eval("
+                namespace $namespace;
 
-                private static \$__filename = '$filename';
-            }
-        ");
+                final class $className extends $baseClass implements $hasPrintableTestCaseClassFQN {
+                    $traitsCode
+
+                    private static \$__filename = '$filename';
+                }
+            ");
+        } catch (ParseError $caught) {
+            throw new RuntimeException(sprintf('Unable to create test case for test file at %s', $filename), 1, $caught);
+        }
 
         return $classFQN;
     }

src/Laravel/Commands/PestInstallCommand.php

@@ -8,7 +8,6 @@ use Illuminate\Console\Command;
 use Illuminate\Support\Facades\File;
 use Pest\Console\Thanks;
 use Pest\Exceptions\InvalidConsoleArgument;
-use Pest\Support\Str;
 
 /**
  * @internal
@@ -36,14 +35,10 @@ final class PestInstallCommand extends Command
     {
         /* @phpstan-ignore-next-line */
         $pest    = base_path('tests/Pest.php');
-        /* @phpstan-ignore-next-line */
-        $helpers = base_path('tests/Helpers.php');
-        $stubs   = $this->isLumen() ? 'stubs/Lumen' : 'stubs/Laravel';
+        $stubs   = 'stubs/Laravel';
 
-        foreach ([$pest, $helpers] as $file) {
-            if (File::exists($file)) {
-                throw new InvalidConsoleArgument(sprintf('%s already exist', $file));
-            }
+        if (File::exists($pest)) {
+            throw new InvalidConsoleArgument(sprintf('%s already exist', $pest));
         }
 
         File::copy(implode(DIRECTORY_SEPARATOR, [
@@ -52,26 +47,10 @@ final class PestInstallCommand extends Command
             'Pest.php',
         ]), $pest);
 
-        File::copy(implode(DIRECTORY_SEPARATOR, [
-            dirname(__DIR__, 3),
-            $stubs,
-            'Helpers.php',
-        ]), $helpers);
-
         $this->output->success('`tests/Pest.php` created successfully.');
-        $this->output->success('`tests/Helpers.php` created successfully.');
 
         if (!(bool) $this->option('no-interaction')) {
             (new Thanks($this->output))();
         }
     }
-
-    /**
-     * Determine if this is a Lumen application.
-     */
-    private function isLumen(): bool
-    {
-        /* @phpstan-ignore-next-line */
-        return Str::startsWith(app()->version(), 'Lumen');
-    }
 }

src/Laravel/Commands/PestTestCommand.php

@@ -19,7 +19,7 @@ final class PestTestCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'pest:test {name : The name of the file} {--unit : Create a unit test}';
+    protected $signature = 'pest:test {name : The name of the file} {--unit : Create a unit test} {--dusk : Create a Dusk test}';
 
     /**
      * The console command description.
@@ -36,7 +36,7 @@ final class PestTestCommand extends Command
         /** @var string $name */
         $name = $this->argument('name');
 
-        $type = ((bool) $this->option('unit')) ? 'Unit' : 'Feature';
+        $type = ((bool) $this->option('unit')) ? 'Unit' : (((bool) $this->option('dusk')) ? 'Browser' : 'Feature');
 
         $relativePath = sprintf('tests/%s/%s.php',
             $type,

src/PendingObjects/TestCall.php

@@ -12,7 +12,7 @@ use Pest\TestSuite;
 use SebastianBergmann\Exporter\Exporter;
 
 /**
- * @method \Pest\Expectation expect(mixed $value)
+ * @method \Pest\Expectations\Expectation expect(mixed $value)
  *
  * @internal
  */

src/Pest.php

@@ -6,5 +6,5 @@ namespace Pest;
 
 function version(): string
 {
-    return '0.3.19';
+    return '1.0.4';
 }

src/Support/ChainableClosure.php

@@ -17,7 +17,9 @@ final class ChainableClosure
     public static function from(Closure $closure, Closure $next): Closure
     {
         return function () use ($closure, $next): void {
+            /* @phpstan-ignore-next-line */
             call_user_func_array(Closure::bind($closure, $this, get_class($this)), func_get_args());
+            /* @phpstan-ignore-next-line */
             call_user_func_array(Closure::bind($next, $this, get_class($this)), func_get_args());
         };
     }

src/Support/Container.php

@@ -79,6 +79,7 @@ final class Container
 
                         if ($candidate === null) {
                             $type = $param->getType();
+                            /* @phpstan-ignore-next-line */
                             if ($type !== null && $type->isBuiltin()) {
                                 $candidate = $param->getName();
                             } else {

src/Support/Str.php

@@ -9,6 +9,25 @@ namespace Pest\Support;
  */
 final class Str
 {
+    /**
+     * Pool of alpha-numeric characters for generating (unsafe) random strings
+     * from.
+     */
+    private const POOL = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
+
+    /**
+     * Create a (unsecure & non-cryptographically safe) random alpha-numeric
+     * string value.
+     *
+     * @param int $length the length of the resulting randomized string
+     *
+     * @see https://github.com/laravel/framework/blob/4.2/src/Illuminate/Support/Str.php#L240-L242
+     */
+    public static function random(int $length = 16): string
+    {
+        return substr(str_shuffle(str_repeat(self::POOL, 5)), 0, $length);
+    }
+
     /**
      * Checks if the given `$target` starts with the given `$search`.
      */

stubs/Browser.php

@@ -0,0 +1,10 @@
+<?php
+
+use Laravel\Dusk\Browser;
+
+it('has {name} page', function () {
+    $this->browse(function (Browser $browser) {
+        $browser->visit('/{name}')
+            ->assertSee('{name}');
+    });
+});

stubs/Laravel/Helpers.php

@@ -1,11 +0,0 @@
-<?php
-
-namespace Tests;
-
-/**
- * A basic assert example.
- */
-function assertExample(): void
-{
-    test()->assertTrue(true);
-}

stubs/Laravel/Pest.php

@@ -1,3 +1,45 @@
 <?php
 
+/*
+|--------------------------------------------------------------------------
+| Test Case
+|--------------------------------------------------------------------------
+|
+| The closure you provide to your test functions is always bound to a specific PHPUnit test
+| case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
+| need to change it using the "uses()" function to bind a different classes or traits.
+|
+*/
+
 uses(Tests\TestCase::class)->in('Feature');
+
+/*
+|--------------------------------------------------------------------------
+| Expectations
+|--------------------------------------------------------------------------
+|
+| When you're writing tests, you often need to check that values meet certain conditions. The
+| "expect()" function gives you access to a set of "expectations" methods that you can use
+| to assert different things. Of course, you may extend the Expectation API at any time.
+|
+*/
+
+expect()->extend('toBeOne', function () {
+    return $this->toBe(1);
+});
+
+/*
+|--------------------------------------------------------------------------
+| Functions
+|--------------------------------------------------------------------------
+|
+| While Pest is very powerful out-of-the-box, you may have some testing code specific to your
+| project that you don't want to repeat in every file. Here you can also expose helpers as
+| global functions to help you to reduce the number of lines of code in your test files.
+|
+*/
+
+function something()
+{
+    // ..
+}

stubs/Lumen/Helpers.php

@@ -1,11 +0,0 @@
-<?php
-
-namespace Tests;
-
-/**
- * A basic assert example.
- */
-function assertExample(): void
-{
-    test()->assertTrue(true);
-}

stubs/Lumen/Pest.php

@@ -1,3 +0,0 @@
-<?php
-
-uses(TestCase::class)->in(__DIR__);

stubs/Lumen/phpunit.xml

@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         colors="true"
->
-    <testsuites>
-        <testsuite name="Application Test Suite">
-            <directory suffix="Test.php">./tests</directory>
-        </testsuite>
-    </testsuites>
-    <coverage processUncoveredFiles="true">
-        <include>
-            <directory suffix=".php">./app</directory>
-        </include>
-    </coverage>
-</phpunit>

tests/.snapshots/success.txt

@@ -103,6 +103,27 @@
    PASS  Tests\Fixtures\ExampleTest
   ✓ it example 2
 
+   PASS  Tests\PHPUnit\CustomAffixes\InvalidTestName
+  ✓ it runs file names like `@#$%^&()-_=+.php`
+
+   PASS  Tests\PHPUnit\CustomAffixes\ATestWithSpaces
+  ✓ it runs file names like `A Test With Spaces.php`
+
+   PASS  Tests\PHPUnit\CustomAffixes\AdditionalFileExtensionspec
+  ✓ it runs file names like `AdditionalFileExtension.spec.php`
+
+   PASS  Tests\PHPUnit\CustomAffixes\ManyExtensionsclasstest
+  ✓ it runs file names like `ManyExtensions.class.test.php`
+
+   PASS  Tests\PHPUnit\CustomAffixes\TestCaseWithQuotes
+  ✓ it runs file names like `Test 'Case' With Quotes.php`
+
+   PASS  Tests\PHPUnit\CustomAffixes\kebabcasespec
+  ✓ it runs file names like `kebab-case-spec.php`
+
+   PASS  Tests\PHPUnit\CustomAffixes\snakecasespec
+  ✓ it runs file names like `snake_case_spec.php`
+
    PASS  Tests\PHPUnit\CustomTestCase\UsesPerDirectory
   ✓ closure was bound to CustomTestCase
 
@@ -188,5 +209,5 @@
   ✓ it is a test
   ✓ it uses correct parent class
 
-  Tests:  7 skipped, 108 passed
+  Tests:  7 skipped, 115 passed
   

tests/PHPUnit/CustomAffixes/@#$%^&()-_=+.php

@@ -0,0 +1,10 @@
+<?php
+
+/*
+ * NOTE: To preserve cross-platform testing compatibility we cannot use ! * and
+ * other Windows reserved characters in this test's filename.
+ *
+ * See https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions
+ */
+
+it(sprintf('runs file names like `%s`', basename(__FILE__)))->assertTrue(true);

tests/PHPUnit/CustomAffixes/A Test With Spaces.php

@@ -0,0 +1,3 @@
+<?php
+
+it(sprintf('runs file names like `%s`', basename(__FILE__)))->assertTrue(true);

tests/PHPUnit/CustomAffixes/AdditionalFileExtension.spec.php

@@ -0,0 +1,3 @@
+<?php
+
+it(sprintf('runs file names like `%s`', basename(__FILE__)))->assertTrue(true);

tests/PHPUnit/CustomAffixes/ManyExtensions.class.test.php

@@ -0,0 +1,3 @@
+<?php
+
+it(sprintf('runs file names like `%s`', basename(__FILE__)))->assertTrue(true);

tests/PHPUnit/CustomAffixes/Test 'Case' With Quotes.php

@@ -0,0 +1,3 @@
+<?php
+
+it(sprintf('runs file names like `%s`', basename(__FILE__)))->assertTrue(true);

tests/PHPUnit/CustomAffixes/kebab-case-spec.php

@@ -0,0 +1,3 @@
+<?php
+
+it(sprintf('runs file names like `%s`', basename(__FILE__)))->assertTrue(true);

tests/PHPUnit/CustomAffixes/snake_case_spec.php

@@ -0,0 +1,3 @@
+<?php
+
+it(sprintf('runs file names like `%s`', basename(__FILE__)))->assertTrue(true);

tests/Visual/Success.php

@@ -13,7 +13,13 @@ test('visual snapshot of test suite on success', function () {
 
         $process->run();
 
-        return preg_replace('#\\x1b[[][^A-Za-z]*[A-Za-z]#', '', $process->getOutput());
+        return preg_replace([
+            '#\\x1b[[][^A-Za-z]*[A-Za-z]#',
+            '/(Tests\\\PHPUnit\\\CustomAffixes\\\InvalidTestName)([A-Za-z0-9]*)/',
+        ], [
+            '',
+            '$1',
+        ], $process->getOutput());
     };
 
     if (getenv('REBUILD_SNAPSHOTS')) {