chore: prepare for phpunit-9 support

Author: mikeerickson

.gitignore

@@ -15,4 +15,5 @@ sandbox/
 scripts/
 *.taskpaper
 NOTES.md
-.phpunit.result.cache
+.phpunit.result.cache
+phpunit-printer.yml

README.md

@@ -1,30 +1,33 @@
-# CD PHPUnit Pretty Result Printer 
-#### Version 0.26
+# CD PHPUnit Pretty Result Printer
 
+Version 0.26
 Extend the default PHPUnit Result Printer with a modern, pretty printer!
 
-[PHPUnit Pretty Result Printer -- Packagist](https://packagist.org/packages/codedungeon/phpunit-result-printer)
+---
+
+📦 [PHPUnit Pretty Result Printer -- Packagist](https://packagist.org/packages/codedungeon/phpunit-result-printer)
 
 ## Installation
 
 Installation is provided via composer and can be done with the following command, the current version requires PHP 7.1 or greater:
 
 ```bash
-$ composer require --dev codedungeon/phpunit-result-printer
+> composer require --dev codedungeon/phpunit-result-printer
 ```
 
 ### Execute Initialization Script (Optional)
+
 The following steps are optional, but will provide zero configuration for implementing **phpunit-pretty-result-printer**
 
 - Adds `printerClass="Codedungeon\PHPUnitPrettyResultPrinter\Printer"` to `phpunit.xml` file
 - Copies default `phpunit-printer.yml` to project root for easier customization
 
-
 ```bash
-$ php ./vendor/codedungeon/phpunit-result-printer/src/init.php
+> php ./vendor/codedungeon/phpunit-result-printer/src/init.php
 ```
 
 #### Manual Configuration
+
 Alternately, if you wish to configure **phpunit-pretty-result-printer** manually, you will need to update your `phpunit.xml` file as follows
 
 ```xml
@@ -37,58 +40,59 @@ Alternately, if you wish to configure **phpunit-pretty-result-printer** manually
 Or from Command-Line:
 
 ```bash
-$ phpunit --printer=Codedungeon\\PHPUnitPrettyResultPrinter\\Printer
+ > phpunit --printer=Codedungeon\\PHPUnitPrettyResultPrinter\\Printer
 ```
 
 ### Laravel 5.3 with PHP version 7.0.x
 
 If you are using PHP 7.0.x, you will need to use a compatible version of PHPUnit Result Printer (version 0.8.x)
 
 ```bash
-$ composer require --dev codedungeon/phpunit-result-printer:^0.8
+> composer require --dev codedungeon/phpunit-result-printer:^0.8
 ```
 
 ### AnyBar Integration
 
-If you have AnyBar installed, it will be enabled by default.  You can disable using `cd-printer-anybar-enabled` option (see below)
+If you have AnyBar installed, it will be enabled by default. You can disable using `cd-printer-anybar-enabled` option (see below)
 
 [https://github.com/tonsky/AnyBar](https://github.com/tonsky/AnyBar)
 
-**Anybar is off by default, thus you will need to set the `cd-printer-anybar` option in the `phpunit-printer.yml` to `true` if you wish to use Anybar.  
+**Anybar is off by default, thus you will need to set the `cd-printer-anybar` option in the `phpunit-printer.yml` to `true` if you wish to use Anybar.
 This has been done to address issues with using CI tools such as travis (please see [Issue 122](https://github.com/mikeerickson/phpunit-pretty-result-printer/issues/122) for details) **
 
-_NOTE: AnyBar is only available with PHPUnit 7.1 or greater.  
-If you need support for previous versions, please let us know.  We are slowly deprecating versions before 7.1._
+_NOTE: AnyBar is only available with PHPUnit 7.1 or greater.
+If you need support for previous versions, please let us know. We are slowly deprecating versions before 7.1._
 
 ### Configuration Options
 
-* Create a `phpunit-printer.yml` file in your application root to override default (or anywhere use up the parent tree. It will search recursively up the tree until a configuration file is found. If not found, default configuration will be used).
-The following options are available (along with their default values):
+- Create a `phpunit-printer.yml` file in your application root to override default (or anywhere use up the parent tree. It will search recursively up the tree until a configuration file is found. If not found, default configuration will be used).
+  The following options are available (along with their default values):
+
+#### Options
 
-#### Options ####
+| **Property Name**           | **Default** | **Description**                                                      |
+| --------------------------- | ----------- | -------------------------------------------------------------------- |
+| `cd-printer-hide-class`     | false       | Hides the display of the test class name                             |
+| `cd-printer-simple-output`  | false       | Uses the default PHPUnit markers (but still uses Printer)            |
+| `cd-printer-show-config`    | true        | Show path to used configuration file                                 |
+| `cd-printer-hide-namespace` | true        | Hide test class namespaces (will only show print class name)         |
+| `cd-printer-anybar`         | true        | Enable AnyBar (if anybar is not installed, settings will be ignored) |
+| `cd-printer-anybar-port`    | 1738        | Define AnyBar port number                                            |
 
-| **Property Name** | **Default** | **Description**
-| ------------------|-------------|----------------|
-| `cd-printer-hide-class` | false | Hides the display of the test class name
-| `cd-printer-simple-output`| false | Uses the default PHPUnit markers (but still uses Printer)
-| `cd-printer-show-config`| true | Show path to used configuration file
-| `cd-printer-hide-namespace`| true |Hide test class namespaces (will only show print class name)
-| `cd-printer-anybar`| true |Enable AnyBar (if anybar is not installed, settings will be ignored)
-| `cd-printer-anybar-port`| 1738 |Define AnyBar port number
+#### Markers
 
-#### Markers ###
 You can customize the markers which are used for `success`, `fail`, `error`, `skipped`, `incomplete` by modifying the `phpunit-printer.yml` file.
 
-| **Marker** | **Value** *
-|---------------|----------| 
-| cd-pass | "✔ " |
-| cd-fail | "✖ " |
-| cd-error | "⚈ " |
-| cd-skipped | "→ " |
-| cd-incomplete | "∅ " |
-| cd-risky | "⌽ " |
+| **Marker**    | **Value** \* |
+| ------------- | ------------ |
+| cd-pass       | "✔ "         |
+| cd-fail       | "✖ "         |
+| cd-error      | "⚈ "         |
+| cd-skipped    | "→ "         |
+| cd-incomplete | "∅ "         |
+| cd-risky      | "⌽ "         |
 
-_* Notice space after each marker.  This makes the output a little more visually appealing, thus keep that in mind when creating your own custom markers_
+_\* Notice space after each marker. This makes the output a little more visually appealing, thus keep that in mind when creating your own custom markers_
 
 ## License
 

phpunit-printer.yml

@@ -0,0 +1,14 @@
+options:
+  cd-printer-hide-class: false
+  cd-printer-simple-output: false
+  cd-printer-show-config: true
+  cd-printer-hide-namespace: true
+  cd-printer-anybar: true
+  cd-printer-anybar-port: 1738
+markers:
+  cd-pass: "✔ "
+  cd-fail: "✖ "
+  cd-error: "⚈ "
+  cd-skipped: "=> "
+  cd-incomplete: "∅ "
+  cd-risky: "⌽ "

src/PrinterTrait.php

@@ -71,6 +71,10 @@ trait PrinterTrait
      */
     private $defaultMarkers = [];
 
+    private $anyBarEnabled = false;
+
+    private $anyBarPort = null;
+
     /**
      * {@inheritdoc}
      */

src/ResultPrinter80.php

@@ -10,7 +10,7 @@
 use PHPUnit\TextUI\ResultPrinter;
 use PHPUnit\Framework\TestFailure;
 
-$low  = version_compare(Version::series(), '7.1', '>=');
+$low  = version_compare(Version::series(), '8.0', '>=');
 $high = true; // version_compare(Version::series(),'7.1.99','<=');
 
 if ($low && $high) {
@@ -83,7 +83,7 @@ protected function formatExceptionMsg($exceptionMessage): string
             return "$exceptionMessage";
         }
 
-        protected function printDefectTrace(TestFailure $defect):void
+        protected function printDefectTrace(TestFailure $defect): void
         {
             $this->write($this->formatExceptionMsg($defect->getExceptionAsString()));
             $trace = Filter::getFilteredStacktrace(
@@ -96,8 +96,8 @@ protected function printDefectTrace(TestFailure $defect):void
             while ($exception) {
                 $this->write(
                     "\nCaused by\n" .
-                    TestFailure::exceptionToString($exception) . "\n" .
-                    Filter::getFilteredStacktrace($exception)
+                        TestFailure::exceptionToString($exception) . "\n" .
+                        Filter::getFilteredStacktrace($exception)
                 );
                 $exception = $exception->getPrevious();
             }

src/ResultPrinter90.php

@@ -0,0 +1,184 @@
+<?php
+
+namespace Codedungeon\PHPUnitPrettyResultPrinter;
+
+use PHPUnit\Util\Filter;
+use PHPUnit\Framework\Test;
+use PHPUnit\Runner\Version;
+use Bakyt\Console\Phanybar;
+use PHPUnit\Framework\TestResult;
+use PHPUnit\TextUI\DefaultResultPrinter;
+use PHPUnit\Framework\TestFailure;
+
+// PHPUnit 9.x requires PHP 7.3 or 7.4
+// https://phpunit.de/supported-versions.html
+
+$low  = version_compare(Version::series(), '9.0', '>=');
+$high = true; // version_compare(Version::series(),'7.1.99','<=');
+
+if ($low && $high) {
+    class ResultPrinter90 implements DefaultResultPrinter
+    {
+        private $defectListPrinted = false;
+
+        private $reverse = true;
+
+        public function startTest(Test $test): void
+        {
+            $this->className = \get_class($test);
+            parent::startTest($test);
+        }
+
+        protected function writeProgress(string $progress): void
+        {
+            $this->writeProgressEx($progress);
+        }
+
+        protected function writeProgressWithColor(string $progress, string $buffer): void
+        {
+            $this->writeProgressWithColorEx($progress, $buffer);
+        }
+
+        protected function printFooter(TestResult $result): void
+        {
+            parent::printFooter($result);
+            if ($this->anyBarEnabled) {
+                $phanyBar = new Phanybar();
+                if (sizeof($result->failures())) {
+                    // if errors, we will always show red bar
+                    $phanyBar->send('exclamation', $this->anyBarPort);
+                } else {
+                    // if no errors and successful, show green
+                    if ($result->wasSuccessful()) {
+                        $phanyBar->send('green', $this->anyBarPort);
+                    } else {
+                        // otherwise show yellow for remaining
+                        $phanyBar->send('yellow', $this->anyBarPort);
+                    }
+                }
+            }
+        }
+
+        protected function formatExceptionMsg($exceptionMessage): string
+        {
+            $exceptionMessage = preg_replace('/%/u', '%%', $exceptionMessage);
+
+            $exceptionMessage = str_replace("+++ Actual\n", '', $exceptionMessage);
+            $exceptionMessage = str_replace("--- Expected\n", '', $exceptionMessage);
+            $exceptionMessage = str_replace('@@ @@', '', $exceptionMessage);
+
+            if (strpos($exceptionMessage, 'This test did not perform any assertions') !== false) {
+                $exceptionMessage = $this->setMessageColor('risky', 'This test did not perform any assertions.');
+            } else {
+                $marker = $this->markers['fail'];
+                if ($this->colors) {
+                    $exceptionMessage = preg_replace('/^(Exception.*)$/m', "\033[01;31m$1\033[0m", $exceptionMessage);
+                    $exceptionMessage = preg_replace('/(Failed.*)$/m', "\033[01;31m %1\$s$1\033[0m", $exceptionMessage);
+                    $exceptionMessage = preg_replace("/(\-+.*)$/m", "\033[01;32m$1\033[0m", $exceptionMessage);
+                    $exceptionMessage = preg_replace("/(\++.*)$/m", "\033[01;31m$1\033[0m", $exceptionMessage);
+                }
+
+                $exceptionMessage = sprintf($exceptionMessage, $marker);
+            }
+
+            $exceptionMessage = '  ' . $exceptionMessage;
+
+            return "$exceptionMessage";
+        }
+
+        protected function printDefectTrace(TestFailure $defect): void
+        {
+            $this->write($this->formatExceptionMsg($defect->getExceptionAsString()));
+            $trace = Filter::getFilteredStacktrace(
+                $defect->thrownException()
+            );
+            if (!empty($trace)) {
+                $this->write("\n" . $trace);
+            }
+            $exception = $defect->thrownException()->getPrevious();
+            while ($exception) {
+                $this->write(
+                    "\nCaused by\n" .
+                    TestFailure::exceptionToString($exception) . "\n" .
+                    Filter::getFilteredStacktrace($exception)
+                );
+                $exception = $exception->getPrevious();
+            }
+        }
+
+        protected function printDefects(array $defects, string $type): void
+        {
+            $count = \count($defects);
+
+            if ($count == 0) {
+                return;
+            }
+
+            if ($this->defectListPrinted) {
+                $this->write("\n--\n\n");
+            }
+
+            $msg = \sprintf("There %s %d %s%s:\n", ($count == 1) ? 'was' : 'were', $count, $type, ($count == 1) ? '' : 's');
+            $msg = $this->setMessageColor($type, $msg);
+
+            $this->write($msg);
+
+            $i = 1;
+
+            if ($this->reverse) {
+                $defects = \array_reverse($defects);
+            }
+
+            foreach ($defects as $defect) {
+                $this->printDefect($defect, $i++);
+            }
+
+            $this->defectListPrinted = true;
+        }
+
+        /**
+         * @param string $type
+         * @param $msg
+         *
+         * @return string
+         */
+        protected function setMessageColor(string $type, $msg): string
+        {
+            // 30m == gray
+            // 31m == red
+            // 32m == green
+            // 33m == yellow
+            // 34m == blue (cyan)
+            // 35m == magenta
+            // 36m == cyan
+            // 37m == white
+
+            $color  = '37';
+            $marker = '';
+
+            if (strpos($type, 'failure') !== false || strpos($type, 'error') !== false) {
+                $color  = '31';
+                $marker = 'fail';
+            } elseif (strpos($type, 'incomplete') !== false) {
+                $color  = '34';
+                $marker = 'incomplete';
+            } elseif (strpos($type, 'risky') !== false) {
+                $color  = '35';
+                $marker = 'risky';
+            } elseif (strpos($type, 'skipped') !== false) {
+                $color  = '33';
+                $marker = 'skipped';
+            }
+
+            // if user turned off colors, return msg as we are down
+            if (!$this->colors) {
+                return $msg;
+            }
+
+            // otherwise, we have colors enabled and time to make it pretty
+            $testMarker = $this->markers[$marker] ?? '';
+
+            return "\033[01;{$color}m{$testMarker}{$msg}\033[0m";
+        }
+    }
+}