docs: updates changelog

Add --thanks option plugin

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,10 @@
+| Q             | A
+| ------------- | ---
+| Bug fix?      | yes/no
+| New feature?  | yes/no
+| Fixed tickets | #... <!-- #-prefixed issue number(s), if any -->
+
+<!--
+- Replace this comment by a description of what your PR is solving.
+-->
+

.github/workflows/changelog.yml

@@ -38,6 +38,8 @@ jobs:
           section: content
           ---
           ${{ steps.package.outputs.content }}
+
+          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

.gitignore

@@ -8,3 +8,4 @@ coverage.xml
 .temp/coverage.php
 *.swp
 *.swo
+.vscode/

CHANGELOG.md

@@ -5,6 +5,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Added
+- `--init` and `pest:install` artisan command output changes ([#118](https://github.com/pestphp/pest/pull/118), [db7c4b1](https://github.com/pestphp/pest/commit/db7c4b174f0974969450dda71dcd649ef0c073a3))
+- `--version` option to view the current version of Pest ([9ea51ca](https://github.com/pestphp/pest/commit/9ea51caf3f74569debb1e465992e9ea916cb80fe))
+
+## [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))
 
 ## [v0.2.0 (2020-06-14)](https://github.com/pestphp/pest/compare/v0.1.5...v0.2.0)
 ### Adds

composer.json

@@ -18,7 +18,7 @@
     ],
     "require": {
         "php": "^7.3",
-        "nunomaduro/collision": "^5.0.0-BETA2",
+        "nunomaduro/collision": "^5.0.0-BETA3",
         "pestphp/pest-plugin": "^0.2",
         "pestphp/pest-plugin-coverage": "^0.2",
         "pestphp/pest-plugin-init": "^0.2",
@@ -31,6 +31,7 @@
         },
         "files": [
             "src/globals.php",
+            "src/Pest.php",
             "compiled/globals.php"
         ]
     },
@@ -43,15 +44,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",
@@ -67,10 +68,10 @@
         "compile": "@php ./scripts/compile.php",
         "lint": "rector process src && php-cs-fixer fix -v",
         "test:lint": "php-cs-fixer fix -v --dry-run && rector process src --dry-run",
-        "test:types": "phpstan analyse --ansi",
+        "test:types": "phpstan analyse --ansi --memory-limit=0",
         "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",
@@ -82,6 +83,11 @@
         "branch-alias": {
             "dev-master": "0.2.x-dev"
         },
+        "pest": {
+            "plugins": [
+                "Pest\\Plugins\\Version"
+            ]
+        },
         "laravel": {
             "providers": [
                 "Pest\\Laravel\\PestServiceProvider"

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/Console/Thanks.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Console;
+
+use Symfony\Component\Console\Helper\SymfonyQuestionHelper;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\ConfirmationQuestion;
+
+/**
+ * @internal
+ */
+final class Thanks
+{
+    /** @var array<int, string> */
+    private const FUNDING_MESSAGES = [
+        '',
+        '  - Star or contribute to Pest:',
+        '    <options=bold>https://github.com/pestphp/pest</>',
+        '  - Tweet something about Pest on Twitter:',
+        '    <options=bold>https://twitter.com/pestphp</>',
+        '  - Sponsor the creator:',
+        '    <options=bold>https://github.com/sponsors/nunomaduro</>',
+    ];
+
+    /** @var OutputInterface */
+    private $output;
+
+    public function __construct(OutputInterface $output)
+    {
+        $this->output = $output;
+    }
+
+    /**
+     * Asks the user to support Pest.
+     */
+    public function __invoke(): void
+    {
+        $wantsToSupport = (new SymfonyQuestionHelper())->ask(
+            new ArrayInput([]),
+            $this->output,
+            new ConfirmationQuestion(
+                'Can you quickly <options=bold>star our GitHub repository</>? 🙏🏻',
+                true,
+            )
+        );
+
+        if ($wantsToSupport === true) {
+            if (PHP_OS_FAMILY == 'Darwin') {
+                exec('open https://github.com/pestphp/pest');
+            }
+            if (PHP_OS_FAMILY == 'Windows') {
+                exec('start https://github.com/pestphp/pest');
+            }
+            if (PHP_OS_FAMILY == 'Linux') {
+                exec('xdg-open https://github.com/pestphp/pest');
+            }
+        }
+
+        foreach (self::FUNDING_MESSAGES as $message) {
+            $this->output->writeln($message);
+        }
+    }
+}

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/Laravel/Commands/PestInstallCommand.php

@@ -59,6 +59,8 @@ final class PestInstallCommand extends Command
 
         $this->output->success('`tests/Pest.php` created successfully.');
         $this->output->success('`tests/Helpers.php` created successfully.');
+
+        (new \Pest\Console\Thanks($this->output))();
     }
 
     /**

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

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest;
+
+function version(): string
+{
+    return '0.2.2';
+}

src/Plugins/Version.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Plugins;
+
+use Pest\Contracts\Plugins\HandlesArguments;
+use function Pest\version;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * @internal
+ */
+final class Version implements HandlesArguments
+{
+    /**
+     * @var OutputInterface
+     */
+    private $output;
+
+    /**
+     * Creates a new instance of the plugin.
+     */
+    public function __construct(OutputInterface $output)
+    {
+        $this->output = $output;
+    }
+
+    public function handleArguments(array $arguments): array
+    {
+        if (in_array('--version', $arguments, true)) {
+            $this->output->writeln(
+                sprintf('Pest    %s', version()),
+            );
+        }
+
+        return $arguments;
+    }
+}

src/Repositories/TestRepository.php

@@ -104,7 +104,14 @@ final class TestRepository
         }
 
         foreach ($paths as $path) {
-            $this->uses[$path] = [$classOrTraits, $groups];
+            if (array_key_exists($path, $this->uses)) {
+                $this->uses[$path] = [
+                    array_merge($this->uses[$path][0], $classOrTraits),
+                    array_merge($this->uses[$path][1], $groups),
+                ];
+            } else {
+                $this->uses[$path] = [$classOrTraits, $groups];
+            }
         }
     }
 

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);

src/Support/Reflection.php

@@ -27,11 +27,19 @@ final class Reflection
     {
         $reflectionClass = new ReflectionClass($object);
 
-        $reflectionMethod = $reflectionClass->getMethod($method);
+        try {
+            $reflectionMethod = $reflectionClass->getMethod($method);
 
-        $reflectionMethod->setAccessible(true);
+            $reflectionMethod->setAccessible(true);
 
-        return $reflectionMethod->invoke($object, ...$args);
+            return $reflectionMethod->invoke($object, ...$args);
+        } catch (ReflectionException $exception) {
+            if (method_exists($object, '__call')) {
+                return $object->__call($method, $args);
+            }
+
+            throw $exception;
+        }
     }
 
     /**

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
@@ -60,6 +75,10 @@
   ✓ it is a test
   ✓ it is a higher order message test
 
+   PASS  Tests\Features\Macro
+  ✓ it can call chained macro method
+  ✓ it will throw exception from call if no macro exists
+
    PASS  Tests\Features\Mocks
   ✓ it has bar
 
@@ -69,12 +88,12 @@
 
    WARN  Tests\Features\Skip
   ✓ it do not skips
-  s it skips with truthy
-  s it skips with truthy condition by default
-  s it skips with message → skipped because bar
-  s it skips with truthy closure condition
+  - it skips with truthy
+  - it skips with truthy condition by default
+  - it skips with message → skipped because bar
+  - it skips with truthy closure condition
   ✓ it do not skips with falsy closure condition
-  s it skips with condition and message → skipped because foo
+  - it skips with condition and message → skipped because foo
 
    PASS  Tests\Features\Test
   ✓ a test
@@ -101,6 +120,7 @@
 
    PASS  Tests\Plugins\Traits
   ✓ it allows global uses
+  ✓ it allows multiple global uses registered in the same path
 
    PASS  Tests\Unit\Actions\AddsDefaults
   ✓ it sets defaults
@@ -115,6 +135,10 @@
   ✓ it throws exception when `process isolation` is true
   ✓ it do not throws exception when `process isolation` is false
 
+   PASS  Tests\Unit\Plugins\Version
+  ✓ it outputs the version when --version is used
+  ✓ it do not outputs version when --version is not used
+
    PASS  Tests\Unit\Support\Backtrace
   ✓ it gets file name from called file
 
@@ -141,7 +165,7 @@
   ✓ it disable decorating printer when colors is set to never
 
    WARN  Tests\Visual\Success
-  s visual snapshot of test suite on success
+  - visual snapshot of test suite on success
 
-  Tests:  6 skipped, 78 passed
-  Time:   3.09s
+  Tests:  6 skipped, 96 passed
+  Time:   3.43s

tests/Autoload.php

@@ -12,4 +12,13 @@ trait PluginTrait
     }
 }
 
+trait SecondPluginTrait
+{
+    public function assertSecondPluginTraitGotRegistered(): void
+    {
+        assertTrue(true);
+    }
+}
+
 Pest\Plugin::uses(PluginTrait::class);
+Pest\Plugin::uses(SecondPluginTrait::class);

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

tests/Features/Macro.php

@@ -0,0 +1,16 @@
+<?php
+
+use Illuminate\Support\Traits\Macroable;
+use PHPUnit\Framework\TestCase;
+
+uses(Macroable::class);
+
+beforeEach()->macro('bar', function () {
+    assertInstanceOf(TestCase::class, $this);
+});
+
+it('can call chained macro method')->bar();
+
+it('will throw exception from call if no macro exists')
+    ->throws(BadMethodCallException::class)
+    ->foo();

tests/Plugins/Traits.php

@@ -1,3 +1,5 @@
 <?php
 
 it('allows global uses')->assertPluginTraitGotRegistered();
+
+it('allows multiple global uses registered in the same path')->assertSecondPluginTraitGotRegistered();

tests/Unit/Plugins/Version.php

@@ -0,0 +1,20 @@
+<?php
+
+use Pest\Plugins\Version;
+use Symfony\Component\Console\Output\BufferedOutput;
+
+it('outputs the version when --version is used', function () {
+    $output = new BufferedOutput();
+    $plugin = new Version($output);
+
+    $plugin->handleArguments(['foo', '--version']);
+    assertStringContainsString('Pest    0.2.2', $output->fetch());
+});
+
+it('do not outputs version when --version is not used', function () {
+    $output = new BufferedOutput();
+    $plugin = new Version($output);
+
+    $plugin->handleArguments(['foo', 'bar']);
+    assertEquals('', $output->fetch());
+});