Merge pull request #3 from kenjis/add-dd

Add dd() and d()

Author: kenjis

README.md

@@ -23,6 +23,7 @@ Provides helper traits for PHPUnit.
     - [`$this->getPrivateProperty()`](#this-getprivateproperty)
     - [`$this->setPrivateProperty()`](#this-setprivateproperty)
     - [`$this->getPrivateMethodInvoker()`](#this-getprivatemethodinvoker)
+  - [`DebugHelper`](#debughelper)
 - [License](#license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -339,6 +340,28 @@ $this->assertEquals(
 );
 ~~~
 
+### `DebugHelper`
+
+This trait provides helper functions, `dd()` and `d()` to dump variables.
+
+Import the `Kenjis\PhpUnitHelper\DebugHelper` trait into your test class:
+
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace Foo\Bar\Test\Unit;
+
+use Kenjis\PhpUnitHelper\DebugHelper;
+use PHPUnit\Framework;
+
+final class BazTest extends Framework\TestCase
+{
+    use DebugHelper;
+}
+```
+
 ## License
 
 This package is licensed using the MIT License.

src/DebugHelper.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kenjis\PhpUnitHelper;
+
+require_once __DIR__ . '/functions.php'; // @codeCoverageIgnore
+
+trait DebugHelper
+{
+}

src/functions.php

@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * Helper Functions
+ */
+
+declare(strict_types=1);
+
+/**
+ * @SuppressWarnings(PHPMD.ExitExpression)
+ * Does not work if I move to the function annotation
+ * See https://github.com/phpmd/phpmd/issues/337
+ */
+if (! function_exists('dd')) { // @codeCoverageIgnore
+
+    /**
+     * Alias of var_dump() and exit()
+     *
+     * @param mixed ...$vars
+     *
+     * @psalm-suppress ForbiddenCode Unsafe var_dump
+     * @codeCoverageIgnore
+     */
+    function dd(...$vars): void
+    {
+        var_dump(...$vars);
+        exit;
+    }
+}
+
+if (! function_exists('d')) { // @codeCoverageIgnore
+
+    /**
+     * Alias of var_dump()
+     *
+     * @param mixed ...$vars
+     *
+     * @psalm-suppress ForbiddenCode Unsafe var_dump
+     */
+    function d(...$vars): void
+    {
+        var_dump(...$vars);
+    }
+}

tests/DebugHelperTest.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kenjis\PhpUnitHelper;
+
+use PHPUnit\Framework\TestCase;
+
+class DebugHelperTest extends TestCase
+{
+    use DebugHelper;
+
+    public function test_d(): void
+    {
+        $this->expectOutputRegex(
+            '/string\(4\) "var1"\n*.*\nint\(100\)\n/'
+        );
+
+        $var1 = 'var1';
+        $var2 = 100;
+        d($var1, $var2);
+    }
+}