docs: updates changelog

Add support for PHPUnit's @depends

CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [v0.2.2 (2020-06-21)](https://github.com/pestphp/pest/compare/v0.2.1...v0.2.2)
+### Added
+- `depends` phpunit feature ([#103](https://github.com/pestphp/pest/pull/103))
+
+### Fixes
+- datasets name conflit ([#101](https://github.com/pestphp/pest/pull/101))
+
 ## [v0.2.1 (2020-06-17)](https://github.com/pestphp/pest/compare/v0.2.0...v0.2.1)
 ### Fixes
 - Multiple `uses` in the same path override previous `uses` ([#97](https://github.com/pestphp/pest/pull/97))

composer.json

@@ -43,15 +43,15 @@
         ]
     },
     "require-dev": {
-        "ergebnis/phpstan-rules": "^0.14.4",
+        "ergebnis/phpstan-rules": "^0.15.0",
         "friendsofphp/php-cs-fixer": "^2.16.3",
-        "illuminate/console": "^7.10.3",
-        "illuminate/support": "^7.10.3",
-        "mockery/mockery": "^1.3.1",
-        "phpstan/phpstan": "^0.12.25",
+        "illuminate/console": "^7.16.1",
+        "illuminate/support": "^7.16.1",
+        "mockery/mockery": "^1.4.0",
+        "phpstan/phpstan": "^0.12.30",
         "phpstan/phpstan-strict-rules": "^0.12.2",
-        "rector/rector": "^0.7.25",
-        "symfony/var-dumper": "^5.0.8",
+        "rector/rector": "^0.7.37",
+        "symfony/var-dumper": "^5.1.2",
         "thecodingmachine/phpstan-strict-rules": "^0.12.0"
     },
     "minimum-stability": "dev",
@@ -70,7 +70,7 @@
         "test:types": "phpstan analyse --ansi",
         "test:unit": "php bin/pest --colors=always --exclude-group=integration",
         "test:integration": "php bin/pest --colors=always --group=integration",
-        "test:update:snapshots": "REBUILD_SNAPSHOTS=true php bin/pest --colors=always",
+        "update:snapshots": "REBUILD_SNAPSHOTS=true php bin/pest --colors=always",
         "test": [
             "@test:lint",
             "@test:types",

phpstan.neon

@@ -15,9 +15,9 @@ parameters:
     reportUnmatchedIgnoredErrors: true
 
     ignoreErrors:
+        - "#Undefined variable: \\$this#"
         - "#is not allowed to extend#"
         - "#Language construct eval#"
         - "# with null as default value#"
-        - "#Using \\$this in static method#"
         - "#has parameter \\$closure with default value.#"
         - "#has parameter \\$description with default value.#"

src/Concerns/TestCase.php

@@ -129,16 +129,25 @@ trait TestCase
 
     /**
      * Runs the test.
+     *
+     * @return mixed
+     *
+     * @throws \Throwable
      */
-    public function __test(): void
+    public function __test()
     {
-        $this->__callClosure($this->__test, func_get_args());
+        return $this->__callClosure($this->__test, func_get_args());
     }
 
-    private function __callClosure(Closure $closure, array $arguments): void
+    /**
+     * @return mixed
+     *
+     * @throws \Throwable
+     */
+    private function __callClosure(Closure $closure, array $arguments)
     {
-        ExceptionTrace::ensure(function () use ($closure, $arguments) {
-            call_user_func_array(Closure::bind($closure, $this, get_class($this)), $arguments);
+        return ExceptionTrace::ensure(function () use ($closure, $arguments) {
+            return call_user_func_array(Closure::bind($closure, $this, get_class($this)), $arguments);
         });
     }
 

src/Datasets.php

@@ -74,12 +74,30 @@ final class Datasets
             $data = iterator_to_array($data);
         }
 
-        $namedData = [];
+        $dataSetDescriptions = [];
+        $dataSetValues       = [];
+
         foreach ($data as $values) {
             $values = is_array($values) ? $values : [$values];
 
-            $name             = $description . self::getDataSetDescription($values);
-            $namedData[$name] = $values;
+            $dataSetDescriptions[] = $description . self::getDataSetDescription($values);
+            $dataSetValues[]       = $values;
+        }
+
+        foreach (array_count_values($dataSetDescriptions) as $descriptionToCheck => $count) {
+            if ($count > 1) {
+                $index = 1;
+                foreach ($dataSetDescriptions as $i => $dataSetDescription) {
+                    if ($dataSetDescription === $descriptionToCheck) {
+                        $dataSetDescriptions[$i] .= sprintf(' #%d', $index++);
+                    }
+                }
+            }
+        }
+
+        $namedData = [];
+        foreach ($dataSetDescriptions as $i => $dataSetDescription) {
+            $namedData[$dataSetDescription] = $dataSetValues[$i];
         }
 
         return $namedData;

src/Factories/TestCaseFactory.php

@@ -132,10 +132,14 @@ final class TestCaseFactory
         $proxies     = $this->proxies;
         $factoryTest = $this->test;
 
-        $test = function () use ($chains, $proxies, $factoryTest): void {
+        /**
+         * @return mixed
+         */
+        $test = function () use ($chains, $proxies, $factoryTest) {
             $proxies->proxy($this);
             $chains->chain($this);
-            call_user_func(Closure::bind($factoryTest, $this, get_class($this)), ...func_get_args());
+
+            return call_user_func(Closure::bind($factoryTest, $this, get_class($this)), ...func_get_args());
         };
 
         $className = $this->makeClassFromFilename($this->filename);

src/PendingObjects/TestCall.php

@@ -84,6 +84,18 @@ final class TestCall
         return $this;
     }
 
+    /**
+     * Sets the test depends.
+     */
+    public function depends(string ...$tests): TestCall
+    {
+        $this->testCaseFactory
+            ->factoryProxies
+            ->add(Backtrace::file(), Backtrace::line(), 'setDependencies', [$tests]);
+
+        return $this;
+    }
+
     /**
      * Makes the test suite only this test case.
      */
@@ -95,7 +107,7 @@ final class TestCall
     }
 
     /**
-     * Sets the test groups(s).
+     * Sets the test group(s).
      */
     public function group(string ...$groups): TestCall
     {

src/Support/ExceptionTrace.php

@@ -17,11 +17,15 @@ final class ExceptionTrace
     /**
      * Ensures the given closure reports
      * the good execution context.
+     *
+     * @return mixed
+     *
+     * @throws \Throwable
      */
-    public static function ensure(Closure $closure): void
+    public static function ensure(Closure $closure)
     {
         try {
-            $closure();
+            return $closure();
         } catch (Throwable $throwable) {
             if (Str::startsWith($message = $throwable->getMessage(), self::UNDEFINED_METHOD)) {
                 $message = str_replace(self::UNDEFINED_METHOD, 'Call to undefined method ', $message);

tests/.snapshots/success.txt

@@ -41,6 +41,21 @@
   ✓ eager wrapped registered datasets with (2)
   ✓ eager registered wrapped 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
+  ✓ it creates unique test case names with ('Name 1', Pest\Plugin Object (), false)
+  ✓ it creates unique test case names with ('Name 2', Pest\Plugin Object (), false)
+  ✓ it creates unique test case names with ('Name 2', Pest\Plugin Object (), true)
+  ✓ it creates unique test case names with ('Name 1', Pest\Plugin Object (), true) #3
+  ✓ it creates unique test case names - count
+
+   PASS  Tests\Features\Depends
+  ✓ first
+  ✓ second
+  ✓ depends
+  ✓ depends with ...params
+  ✓ depends with defined arguments
+  ✓ depends run test only once
 
    PASS  Tests\Features\Exceptions
   ✓ it gives access the the underlying expectException
@@ -144,5 +159,5 @@
    WARN  Tests\Visual\Success
   s visual snapshot of test suite on success
 
-  Tests:  6 skipped, 79 passed
-  Time:   3.44s
+  Tests:  6 skipped, 92 passed
+  Time:   3.40s

tests/Features/Datasets.php

@@ -3,6 +3,7 @@
 use Pest\Datasets;
 use Pest\Exceptions\DatasetAlreadyExist;
 use Pest\Exceptions\DatasetDoesNotExist;
+use Pest\Plugin;
 
 it('throws exception if dataset does not exist', function () {
     $this->expectException(DatasetDoesNotExist::class);
@@ -106,3 +107,21 @@ $namedDatasets = [
 test('lazy named datasets', function ($text) use ($state, $datasets) {
     assertTrue(true);
 })->with($namedDatasets);
+
+$counter = 0;
+
+it('creates unique test case names', function (string $name, Plugin $plugin, bool $bool) use (&$counter) {
+    assertTrue(true);
+    $counter++;
+})->with([
+    ['Name 1', new Plugin(), true],
+    ['Name 1', new Plugin(), true],
+    ['Name 1', new Plugin(), false],
+    ['Name 2', new Plugin(), false],
+    ['Name 2', new Plugin(), true],
+    ['Name 1', new Plugin(), true],
+]);
+
+it('creates unique test case names - count', function () use (&$counter) {
+    assertEquals(6, $counter);
+});

tests/Features/Depends.php

@@ -0,0 +1,40 @@
+<?php
+
+$runCounter = 0;
+
+test('first', function () use (&$runCounter) {
+    assertTrue(true);
+    $runCounter++;
+
+    return 'first';
+});
+
+test('second', function () use (&$runCounter) {
+    assertTrue(true);
+    $runCounter++;
+
+    return 'second';
+});
+
+test('depends', function () {
+    assertEquals(
+        ['first', 'second'],
+        func_get_args()
+    );
+})->depends('first', 'second');
+
+test('depends with ...params', function (string ...$params) {
+    assertEquals(
+        ['first', 'second'],
+        $params
+    );
+})->depends('first', 'second');
+
+test('depends with defined arguments', function (string $first, string $second) {
+    assertEquals('first', $first);
+    assertEquals('second', $second);
+})->depends('first', 'second');
+
+test('depends run test only once', function () use (&$runCounter) {
+    assertEquals(2, $runCounter);
+})->depends('first', 'second');