docs: updates changelog

fix(depends): resolve issue with dependency names

.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,27 @@ 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.13 (2020-11-23)](https://github.com/pestphp/pest/compare/v0.3.12...v0.3.13)
+### Added
+- `toMatchArray` expectation ([7bea51f](https://github.com/pestphp/pest/commit/7bea51fe09dd2eca7093e4c34cf2dab2e8d39fa5), [3fd24d9](https://github.com/pestphp/pest/commit/3fd24d96d3145dcebdb0aab40aa8b76faa8b6979))
+
+## [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

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.4.0"
+        "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,14 @@ 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();
+
+        (new Help($this->output))();
+    }
 }

src/Console/Help.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Console;
+
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * @internal
+ */
+final class Help
+{
+    /** @var array<int, string> */
+    private const HELP_MESSAGES = [
+        '<comment>Pest Options:</comment>',
+        '  <info>--init</info>                      Initialise a standard Pest configuration',
+        '  <info>--coverage</info>                  Enable coverage and output to standard output',
+        '  <info>--min=<fg=cyan><N></></info>                   Set the minimum required coverage percentage (<N>), and fail if not met',
+        '  <info>--group=<fg=cyan><name></></info>              Only runs tests from the specified group(s)',
+    ];
+
+    /** @var OutputInterface */
+    private $output;
+
+    public function __construct(OutputInterface $output)
+    {
+        $this->output = $output;
+    }
+
+    public function __invoke(): void
+    {
+        foreach (self::HELP_MESSAGES as $message) {
+            $this->output->writeln($message);
+        }
+    }
+}

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/Expectation.php

@@ -408,10 +408,21 @@ final class Expectation
      * Asserts that the value array has the provided $key.
      *
      * @param string|int $key
+     * @param mixed      $value
      */
-    public function toHaveKey($key): Expectation
+    public function toHaveKey($key, $value = null): Expectation
     {
-        Assert::assertArrayHasKey($key, $this->value);
+        if (is_object($this->value) && method_exists($this->value, 'toArray')) {
+            $array = $this->value->toArray();
+        } else {
+            $array = (array) $this->value;
+        }
+
+        Assert::assertArrayHasKey($key, $array);
+
+        if (func_num_args() > 1) {
+            Assert::assertEquals($value, $array[$key]);
+        }
 
         return $this;
     }
@@ -490,6 +501,20 @@ final class Expectation
         return $this;
     }
 
+    /**
+     * Asserts that the value array matches the given array subset.
+     *
+     * @param array<int|string, mixed> $array
+     */
+    public function toMatchArray($array): Expectation
+    {
+        foreach ($array as $property => $value) {
+            $this->toHaveKey($property, $value);
+        }
+
+        return $this;
+    }
+
     /**
      * Asserts that the value object matches a subset
      * of the properties of an given object.

src/PendingObjects/TestCall.php

@@ -95,7 +95,11 @@ final class TestCall
         $className = $this->testCaseFactory->getClassName();
 
         $tests = array_map(function (string $test) use ($className): ExecutionOrderDependency {
-            return ExecutionOrderDependency::createFromDependsAnnotation($className, $test);
+            if (strpos($test, '::') === false) {
+                $test = "{$className}::{$test}";
+            }
+
+            return new ExecutionOrderDependency($test, null, '');
         }, $tests);
 
         $this->testCaseFactory

src/Pest.php

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

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/help-command.txt

@@ -0,0 +1,5 @@
+Pest Options:
+  --init                      Initialise a standard Pest configuration
+  --coverage                  Enable coverage and output to standard output
+  --min=<N>                   Set the minimum required coverage percentage (<N>), and fail if not met
+  --group=<name>              Only runs tests from the specified group(s)

tests/.snapshots/success.txt

@@ -200,6 +200,11 @@
    PASS  Tests\Expect\toMatch
   ✓ pass
   ✓ failures
+  ✓ not failures
+
+   PASS  Tests\Expect\toMatchArray
+  ✓ pass
+  ✓ failures
   ✓ not failures
 
    PASS  Tests\Expect\toMatchConstraint
@@ -255,6 +260,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
@@ -345,6 +353,12 @@
   ✓ it throws exception when `process isolation` is true
   ✓ it do not throws exception when `process isolation` is false
 
+   PASS  Tests\Unit\Console\Help
+  ✓ it outputs the help information when --help is used
+
+   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
@@ -368,6 +382,9 @@
    PASS  Tests\Unit\TestSuite
   ✓ it does not allow to add the same test description twice
 
+   PASS  Tests\Visual\Help
+  ✓ visual snapshot of help command output
+
    PASS  Tests\Visual\SingleTestOrDirectory
   ✓ allows to run a single test
   ✓ allows to run a directory
@@ -380,10 +397,12 @@
    PASS  Tests\Features\Depends
   ✓ first
   ✓ second
+  ✓ it asserts true is true
   ✓ depends
   ✓ depends with ...params
   ✓ depends with defined arguments
   ✓ depends run test only once
+  ✓ depends works with the correct test name
 
-  Tests:  7 skipped, 227 passed
+  Tests:  7 skipped, 238 passed
   

tests/Expect/toMatchArray.php

@@ -0,0 +1,31 @@
+<?php
+
+use PHPUnit\Framework\ExpectationFailedException;
+
+beforeEach(function () {
+    $this->user = [
+        'id'    => 1,
+        'name'  => 'Nuno',
+        'email' => 'enunomaduro@gmail.com',
+    ];
+});
+
+test('pass', function () {
+    expect($this->user)->toMatchArray([
+        'name'  => 'Nuno',
+        'email' => 'enunomaduro@gmail.com',
+    ]);
+});
+
+test('failures', function () {
+    expect($this->user)->toMatchArray([
+        'name'  => 'Not the same name',
+        'email' => 'enunomaduro@gmail.com',
+    ]);
+})->throws(ExpectationFailedException::class);
+
+test('not failures', function () {
+    expect($this->user)->not->toMatchArray([
+        'id' => 1,
+    ]);
+})->throws(ExpectationFailedException::class);

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/Depends.php

@@ -32,3 +32,7 @@ test('depends with defined arguments', function (string $first, string $second)
 test('depends run test only once', function () use (&$runCounter) {
     expect($runCounter)->toBe(2);
 })->depends('first', 'second');
+
+// Regression tests. See https://github.com/pestphp/pest/pull/216
+it('asserts true is true')->assertTrue(true);
+test('depends works with the correct test name')->assertTrue(true)->depends('it asserts true is true');

tests/Unit/Console/Help.php

@@ -0,0 +1,12 @@
+<?php
+
+use Pest\Console\Help;
+use Symfony\Component\Console\Output\BufferedOutput;
+
+it('outputs the help information when --help is used', function () {
+    $output = new BufferedOutput();
+    $plugin = new Help($output);
+
+    $plugin();
+    expect($output->fetch())->toContain('Pest Options:');
+});

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))');
+});

tests/Visual/Help.php

@@ -0,0 +1,27 @@
+<?php
+
+use Pest\Console\Help;
+use Symfony\Component\Console\Output\BufferedOutput;
+
+test('visual snapshot of help command output', function () {
+    $snapshot = __DIR__ . '/../.snapshots/help-command.txt';
+
+    if (getenv('REBUILD_SNAPSHOTS')) {
+        $outputBuffer = new BufferedOutput();
+        $plugin = new Help($outputBuffer);
+
+        $plugin();
+
+        file_put_contents($snapshot, $outputBuffer->fetch());
+    }
+
+    $output = function () {
+        $process = (new Symfony\Component\Process\Process(['php', 'bin/pest', '--help']));
+
+        $process->run();
+
+        return preg_replace('#\\x1b[[][^A-Za-z]*[A-Za-z]#', '', $process->getOutput());
+    };
+
+    expect($output())->toContain(file_get_contents($snapshot));
+})->skip(PHP_OS_FAMILY === 'Windows');