chore: update changelog

chore(deps): add support for PHPUnit 9.4.3

.github/workflows/changelog.yml

@@ -5,6 +5,7 @@ on:
     branches: [ master ]
     paths:
       - CHANGELOG.md
+      - .github/workflows/changelog.yml
   pull_request:
     branches: [ master ]
     paths:
@@ -17,17 +18,21 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
+
     - name: Checkout website repository
       uses: actions/checkout@v2
       with:
         token: ${{ secrets.CHANGELOG_KEY }}
-        repository: pestphp/website
-        path: pestphp-website
+        repository: pestphp/docs
+        path: pestphp-docs
+        ref: master
+
     - name: Read CHANGELOG.md
       id: package
       uses: juliangruber/read-file-action@v1
       with:
         path: ./CHANGELOG.md
+
     - name: Add file headers
       uses: DamianReeves/write-file-action@v1.0
       with:
@@ -36,8 +41,6 @@ jobs:
           ---
           title: Changelog
           description: Changelog
-          extends: _layouts.documentation
-          section: content
           ---
           ${{ steps.package.outputs.content }}
 
@@ -45,14 +48,16 @@ jobs:
 
           Next section: [Upgrade Guide →](/docs/upgrade-guide)
         write-mode: overwrite
+
     - name: Copy CHANGELOG to website repository
-      run: cp CHANGELOG.md pestphp-website/source/docs/changelog.md
+      run: cp CHANGELOG.md pestphp-docs/changelog.md
+
     - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v2
+      uses: peter-evans/create-pull-request@v3
       with:
         token: ${{ secrets.CHANGELOG_KEY }}
         commit-message: Update changelog.md
         committer: GitHub Action <noreply@github.com>
         author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
         title: 'Update changelog.md'
-        path: ./pestphp-website
+        path: ./pestphp-docs

CHANGELOG.md

@@ -4,7 +4,30 @@ 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/).
 
-## [Unreleased]
+## [v0.3.12 (2020-11-11)](https://github.com/pestphp/pest/compare/v0.3.11...v0.3.12)
+### Added
+- Add support for PHPUnit 9.4.3 ([#219](https://github.com/pestphp/pest/pull/219)
+
+## [v0.3.11 (2020-11-09)](https://github.com/pestphp/pest/compare/v0.3.10...v0.3.11)
+### Changed
+- Improved the exception output for the TeamCity printer (usage with phpstorm plugin) ([#215](https://github.com/pestphp/pest/pull/215))
+
+## [v0.3.10 (2020-11-01)](https://github.com/pestphp/pest/compare/v0.3.9...v0.3.10)
+### Added
+- Add support for PHPUnit 9.4.2 ([d177ab5](https://github.com/pestphp/pest/commit/d177ab5ec2030c5bb8e418d10834c370c94c433d))
+
+## [v0.3.9 (2020-10-13)](https://github.com/pestphp/pest/compare/v0.3.8...v0.3.9)
+### Added
+- Add support for named datasets in description output ([#134](https://github.com/pestphp/pest/pull/134))
+- Add Pest version to `--help` output ([#203](https://github.com/pestphp/pest/pull/203))
+- Add support for PHPUnit 9.4.1 ([#207](https://github.com/pestphp/pest/pull/207))
+
+## [v0.3.8 (2020-10-03)](https://github.com/pestphp/pest/compare/v0.3.7...v0.3.8)
+### Added
+- Add support for PHPUnit 9.4.0 ([#199](https://github.com/pestphp/pest/pull/199))
+
+### Fixed
+- Fix chained higher order assertions returning void ([#196](https://github.com/pestphp/pest/pull/196))
 
 ## [v0.3.7 (2020-09-30)](https://github.com/pestphp/pest/compare/v0.3.6...v0.3.7)
 ### Added

composer.json

@@ -22,7 +22,7 @@
         "pestphp/pest-plugin": "^0.3",
         "pestphp/pest-plugin-coverage": "^0.3",
         "pestphp/pest-plugin-init": "^0.3",
-        "phpunit/phpunit": ">= 9.3.7 <= 9.3.11"
+        "phpunit/phpunit": ">= 9.3.7 <= 9.4.3"
     },
     "autoload": {
         "psr-4": {

src/Console/Command.php

@@ -11,6 +11,8 @@ use Pest\Actions\ValidatesConfiguration;
 use Pest\Contracts\Plugins\AddsOutput;
 use Pest\Contracts\Plugins\HandlesArguments;
 use Pest\Plugin\Loader;
+use Pest\Plugins\Version;
+use Pest\Support\Container;
 use Pest\TestSuite;
 use PHPUnit\Framework\TestSuite as BaseTestSuite;
 use PHPUnit\TextUI\Command as BaseCommand;
@@ -139,4 +141,12 @@ final class Command extends BaseCommand
 
         exit($result);
     }
+
+    protected function showHelp(): void
+    {
+        /** @var Version $version */
+        $version = Container::getInstance()->get(Version::class);
+        $version->handleArguments(['--version']);
+        parent::showHelp();
+    }
 }

src/Datasets.php

@@ -77,10 +77,10 @@ final class Datasets
         $dataSetDescriptions = [];
         $dataSetValues       = [];
 
-        foreach ($data as $values) {
+        foreach ($data as $key => $values) {
             $values = is_array($values) ? $values : [$values];
 
-            $dataSetDescriptions[] = $description . self::getDataSetDescription($values);
+            $dataSetDescriptions[] = $description . self::getDataSetDescription($key, $values);
             $dataSetValues[]       = $values;
         }
 
@@ -104,12 +104,15 @@ final class Datasets
     }
 
     /**
+     * @param int|string        $key
      * @param array<int, mixed> $data
      */
-    private static function getDataSetDescription(array $data): string
+    private static function getDataSetDescription($key, array $data): string
     {
         $exporter = new Exporter();
 
-        return \sprintf(' with (%s)', $exporter->shortenedRecursiveExport($data));
+        $nameInsert = is_string($key) ? \sprintf('data set "%s" ', $key) : '';
+
+        return \sprintf(' with %s(%s)', $nameInsert, $exporter->shortenedRecursiveExport($data));
     }
 }

src/Pest.php

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

src/Support/HigherOrderMessageCollection.php

@@ -30,7 +30,7 @@ final class HigherOrderMessageCollection
     public function chain(object $target): void
     {
         foreach ($this->messages as $message) {
-            $target = $message->call($target);
+            $target = $message->call($target) ?? $target;
         }
     }
 

src/TeamCity.php

@@ -24,7 +24,6 @@ final class TeamCity extends DefaultResultPrinter
     private const DURATION            = 'duration';
     private const TEST_SUITE_STARTED  = 'testSuiteStarted';
     private const TEST_SUITE_FINISHED = 'testSuiteFinished';
-    private const TEST_FAILED         = 'testFailed';
 
     /** @var int */
     private $flowId;
@@ -149,19 +148,7 @@ final class TeamCity extends DefaultResultPrinter
      */
     public function addError(Test $test, Throwable $t, float $time): void
     {
-        if (!TeamCity::isPestTest($test)) {
-            $this->phpunitTeamCity->addError($test, $t, $time);
-
-            return;
-        }
-
-        $this->printEvent(
-            self::TEST_FAILED, [
-            self::NAME     => $test->getName(),
-            'message'      => $t->getMessage(),
-            'details'      => $t->getTraceAsString(),
-            self::DURATION => self::toMilliseconds($time),
-        ]);
+        $this->phpunitTeamCity->addError($test, $t, $time);
     }
 
     /**
@@ -171,19 +158,7 @@ final class TeamCity extends DefaultResultPrinter
      */
     public function addWarning(Test $test, Warning $e, float $time): void
     {
-        if (!TeamCity::isPestTest($test)) {
-            $this->phpunitTeamCity->addWarning($test, $e, $time);
-
-            return;
-        }
-
-        $this->printEvent(
-            self::TEST_FAILED, [
-            self::NAME     => $test->getName(),
-            'message'      => $e->getMessage(),
-            'details'      => $e->getTraceAsString(),
-            self::DURATION => self::toMilliseconds($time),
-        ]);
+        $this->phpunitTeamCity->addWarning($test, $e, $time);
     }
 
     public function addFailure(Test $test, AssertionFailedError $e, float $time): void

tests/.snapshots/success.txt

@@ -255,6 +255,9 @@
   ✓ eager wrapped registered datasets with (1)
   ✓ eager wrapped registered datasets with (2)
   ✓ eager registered wrapped datasets did the job right
+  ✓ named datasets with data set "one" (1)
+  ✓ named datasets with data set "two" (2)
+  ✓ named datasets did the job right
   ✓ lazy named datasets with (Bar Object (...))
   ✓ it creates unique test case names with ('Name 1', Pest\Plugin Object (), true) #1
   ✓ it creates unique test case names with ('Name 1', Pest\Plugin Object (), true) #2
@@ -278,6 +281,7 @@
 
    PASS  Tests\Features\HigherOrderTests
   ✓ it proxies calls to object
+  ✓ it is capable doing multiple assertions
 
    PASS  Tests\Features\It
   ✓ it is a test
@@ -302,6 +306,7 @@
   - it skips with truthy closure condition
   ✓ it do not skips with falsy closure condition
   - it skips with condition and message → skipped because foo
+  - it skips when skip after assertion
 
    PASS  Tests\Features\Test
   ✓ a test
@@ -343,6 +348,9 @@
   ✓ it throws exception when `process isolation` is true
   ✓ it do not throws exception when `process isolation` is false
 
+   PASS  Tests\Unit\Datasets
+  ✓ it show the names of named datasets in their description
+
    PASS  Tests\Unit\Plugins\Version
   ✓ it outputs the version when --version is used
   ✓ it do not outputs version when --version is not used
@@ -383,5 +391,5 @@
   ✓ depends with defined arguments
   ✓ depends run test only once
 
-  Tests:  6 skipped, 226 passed
+  Tests:  7 skipped, 231 passed
   

tests/Features/Datasets.php

@@ -95,6 +95,18 @@ test('eager registered wrapped datasets did the job right', function () use ($st
     expect($state->text)->toBe('1212121212');
 });
 
+test('named datasets', function ($text) use ($state, $datasets) {
+    $state->text .= $text;
+    expect($datasets)->toContain([$text]);
+})->with([
+    'one' => [1],
+    'two' => [2],
+]);
+
+test('named datasets did the job right', function () use ($state) {
+    expect($state->text)->toBe('121212121212');
+});
+
 class Bar
 {
     public $name = 1;

tests/Features/HigherOrderTests.php

@@ -4,4 +4,8 @@ beforeEach()->assertTrue(true);
 
 it('proxies calls to object')->assertTrue(true);
 
+it('is capable doing multiple assertions')
+    ->assertTrue(true)
+    ->assertFalse(false);
+
 afterEach()->assertTrue(true);

tests/Features/Skip.php

@@ -27,3 +27,7 @@ it('do not skips with falsy closure condition')
 it('skips with condition and message')
     ->skip(true, 'skipped because foo')
     ->assertTrue(false);
+
+it('skips when skip after assertion')
+    ->assertTrue(true)
+    ->skip();

tests/Unit/Datasets.php

@@ -0,0 +1,13 @@
+<?php
+
+use Pest\Datasets;
+
+it('show the names of named datasets in their description', function () {
+    $descriptions = array_keys(Datasets::resolve('test description', [
+        'one' => [1],
+        'two' => [[2]],
+    ]));
+
+    expect($descriptions[0])->toBe('test description with data set "one" (1)');
+    expect($descriptions[1])->toBe('test description with data set "two" (array(2))');
+});