From b7cbbe71fdc3a9989cf7939158bcd5c5bc08822d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20M=C3=B6ller?= <am@localheinz.com>
Date: Sun, 24 Jan 2021 16:14:41 +0100
Subject: [PATCH] Enhancement: Rename Reporter\Reporter to
 Reporter\DefaultReporter and extract Reporter\Reporter interface

---
 CHANGELOG.md                                  |   4 +-
 src/Reporter/DefaultReporter.php              | 152 ++++++++++++++++++
 src/Reporter/Reporter.php                     | 135 +---------------
 ...porterTest.php => DefaultReporterTest.php} |  18 +--
 4 files changed, 166 insertions(+), 143 deletions(-)
 create mode 100644 src/Reporter/DefaultReporter.php
 rename test/Unit/Reporter/{ReporterTest.php => DefaultReporterTest.php} (97%)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3da963c9..ffad0d9a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -20,7 +20,8 @@ For a full diff see [`7afa59c...main`][7afa59c...main].
 
 ### Changed
 
-* Renamed `SlowTestReporter` to `Reporter\DefaultReporter` ([#20]), by [@localheinz]
+* Renamed `SlowTestReporter` to `Reporter\Reporter` ([#20]), by [@localheinz]
+* Renamed `Reporter\Reporter` to `Reporter\DefaultReporter` and extracted `Reporter\Reporter` interface ([#21]), by [@localheinz]
 
 [7afa59c...main]: https://github.com/ergebnis/phpunit-slow-test-detector/compare/7afa59c...main
 
@@ -32,5 +33,6 @@ For a full diff see [`7afa59c...main`][7afa59c...main].
 [#18]: https://github.com/ergebnis/phpunit-slow-test-detector/pull/18
 [#19]: https://github.com/ergebnis/phpunit-slow-test-detector/pull/19
 [#20]: https://github.com/ergebnis/phpunit-slow-test-detector/pull/20
+[#21]: https://github.com/ergebnis/phpunit-slow-test-detector/pull/21
 
 [@localheinz]: https://github.com/localheinz
diff --git a/src/Reporter/DefaultReporter.php b/src/Reporter/DefaultReporter.php
new file mode 100644
index 00000000..eeb64acd
--- /dev/null
+++ b/src/Reporter/DefaultReporter.php
@@ -0,0 +1,152 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/phpunit-slow-test-detector
+ */
+
+namespace Ergebnis\PHPUnit\SlowTestDetector\Reporter;
+
+use Ergebnis\PHPUnit\SlowTestDetector\Comparator;
+use Ergebnis\PHPUnit\SlowTestDetector\Exception;
+use Ergebnis\PHPUnit\SlowTestDetector\SlowTest;
+use PHPUnit\Event;
+
+final class DefaultReporter implements Reporter
+{
+    private Comparator\DurationComparator $durationComparator;
+
+    private Event\Telemetry\DurationFormatter $durationFormatter;
+
+    private int $maximumNumber;
+
+    private Event\Telemetry\Duration $maximumDuration;
+
+    /**
+     * @throws Exception\MaximumNumberNotGreaterThanZero
+     */
+    public function __construct(
+        Event\Telemetry\DurationFormatter $durationFormatter,
+        Event\Telemetry\Duration $maximumDuration,
+        int $maximumNumber
+    ) {
+        if (0 >= $maximumNumber) {
+            throw Exception\MaximumNumberNotGreaterThanZero::create($maximumNumber);
+        }
+
+        $this->durationComparator = new Comparator\DurationComparator();
+        $this->durationFormatter = $durationFormatter;
+        $this->maximumDuration = $maximumDuration;
+        $this->maximumNumber = $maximumNumber;
+    }
+
+    public function report(SlowTest ...$slowTests): string
+    {
+        if ([] === $slowTests) {
+            return '';
+        }
+
+        $header = $this->header(...$slowTests);
+        $list = $this->list(...$slowTests);
+        $footer = $this->footer(...$slowTests);
+
+        return <<<TXT
+{$header}
+{$list}
+{$footer}
+TXT;
+    }
+
+    private function header(SlowTest ...$slowTests): string
+    {
+        $count = \count($slowTests);
+
+        $formattedMaximumDuration = $this->durationFormatter->format($this->maximumDuration);
+
+        return <<<TXT
+Detected {$count} tests that took longer than {$formattedMaximumDuration}.
+
+TXT;
+    }
+
+    private function list(SlowTest ...$slowTests): string
+    {
+        $durationComparator = $this->durationComparator;
+
+        \usort($slowTests, static function (SlowTest $one, SlowTest $two) use ($durationComparator): int {
+            return $durationComparator->compare(
+                $two->duration(),
+                $one->duration()
+            );
+        });
+
+        $slowTestsToReport = \array_slice(
+            $slowTests,
+            0,
+            $this->maximumNumber
+        );
+
+        /** @var SlowTest $slowestTest */
+        $slowestTest = \reset($slowTestsToReport);
+
+        $durationFormatter = $this->durationFormatter;
+
+        $width = \strlen($durationFormatter->format($slowestTest->duration()));
+
+        $items = \array_map(static function (SlowTest $slowTest) use ($durationFormatter, $width): string {
+            $label = \str_pad(
+                $durationFormatter->format($slowTest->duration()),
+                $width,
+                ' ',
+                \STR_PAD_LEFT
+            );
+
+            $test = $slowTest->test();
+
+            $testName = \sprintf(
+                '%s::%s',
+                $test->className(),
+                $test->methodNameWithDataSet()
+            );
+
+            return <<<TXT
+{$label}: {$testName}
+TXT;
+        }, $slowTestsToReport);
+
+        return \implode(
+            "\n",
+            $items
+        );
+    }
+
+    private function footer(SlowTest ...$slowTests): string
+    {
+        $remainingCount = \max(
+            \count($slowTests) - $this->maximumNumber,
+            0
+        );
+
+        if (0 === $remainingCount) {
+            return '';
+        }
+
+        if (1 === $remainingCount) {
+            return <<<'TXT'
+
+There is one additional slow test that is not listed here.
+TXT;
+        }
+
+        return <<<TXT
+
+There are {$remainingCount} additional slow tests that are not listed here.
+TXT;
+    }
+}
diff --git a/src/Reporter/Reporter.php b/src/Reporter/Reporter.php
index 40c36caf..a5a59f4a 100644
--- a/src/Reporter/Reporter.php
+++ b/src/Reporter/Reporter.php
@@ -13,140 +13,9 @@
 
 namespace Ergebnis\PHPUnit\SlowTestDetector\Reporter;
 
-use Ergebnis\PHPUnit\SlowTestDetector\Comparator;
-use Ergebnis\PHPUnit\SlowTestDetector\Exception;
 use Ergebnis\PHPUnit\SlowTestDetector\SlowTest;
-use PHPUnit\Event;
 
-final class Reporter
+interface Reporter
 {
-    private Comparator\DurationComparator $durationComparator;
-
-    private Event\Telemetry\DurationFormatter $durationFormatter;
-
-    private int $maximumNumber;
-
-    private Event\Telemetry\Duration $maximumDuration;
-
-    /**
-     * @throws Exception\MaximumNumberNotGreaterThanZero
-     */
-    public function __construct(
-        Event\Telemetry\DurationFormatter $durationFormatter,
-        Event\Telemetry\Duration $maximumDuration,
-        int $maximumNumber
-    ) {
-        if (0 >= $maximumNumber) {
-            throw Exception\MaximumNumberNotGreaterThanZero::create($maximumNumber);
-        }
-
-        $this->durationComparator = new Comparator\DurationComparator();
-        $this->durationFormatter = $durationFormatter;
-        $this->maximumDuration = $maximumDuration;
-        $this->maximumNumber = $maximumNumber;
-    }
-
-    public function report(SlowTest ...$slowTests): string
-    {
-        if ([] === $slowTests) {
-            return '';
-        }
-
-        $header = $this->header(...$slowTests);
-        $list = $this->list(...$slowTests);
-        $footer = $this->footer(...$slowTests);
-
-        return <<<TXT
-{$header}
-{$list}
-{$footer}
-TXT;
-    }
-
-    private function header(SlowTest ...$slowTests): string
-    {
-        $count = \count($slowTests);
-
-        $formattedMaximumDuration = $this->durationFormatter->format($this->maximumDuration);
-
-        return <<<TXT
-Detected {$count} tests that took longer than {$formattedMaximumDuration}.
-
-TXT;
-    }
-
-    private function list(SlowTest ...$slowTests): string
-    {
-        $durationComparator = $this->durationComparator;
-
-        \usort($slowTests, static function (SlowTest $one, SlowTest $two) use ($durationComparator): int {
-            return $durationComparator->compare(
-                $two->duration(),
-                $one->duration()
-            );
-        });
-
-        $slowTestsToReport = \array_slice(
-            $slowTests,
-            0,
-            $this->maximumNumber
-        );
-
-        /** @var SlowTest $slowestTest */
-        $slowestTest = \reset($slowTestsToReport);
-
-        $durationFormatter = $this->durationFormatter;
-
-        $width = \strlen($durationFormatter->format($slowestTest->duration()));
-
-        $items = \array_map(static function (SlowTest $slowTest) use ($durationFormatter, $width): string {
-            $label = \str_pad(
-                $durationFormatter->format($slowTest->duration()),
-                $width,
-                ' ',
-                \STR_PAD_LEFT
-            );
-
-            $test = $slowTest->test();
-
-            $testName = \sprintf(
-                '%s::%s',
-                $test->className(),
-                $test->methodNameWithDataSet()
-            );
-
-            return <<<TXT
-{$label}: {$testName}
-TXT;
-        }, $slowTestsToReport);
-
-        return \implode(
-            "\n",
-            $items
-        );
-    }
-
-    private function footer(SlowTest ...$slowTests): string
-    {
-        $remainingCount = \max(
-            \count($slowTests) - $this->maximumNumber,
-            0
-        );
-
-        if (0 === $remainingCount) {
-            return '';
-        }
-
-        if (1 === $remainingCount) {
-            return <<<'TXT'
-
-There is one additional slow test that is not listed here.
-TXT;
-        }
-
-        return <<<TXT
-
-There are {$remainingCount} additional slow tests that are not listed here.
-TXT;
-    }
+    public function report(SlowTest ...$slowTests): string;
 }
diff --git a/test/Unit/Reporter/ReporterTest.php b/test/Unit/Reporter/DefaultReporterTest.php
similarity index 97%
rename from test/Unit/Reporter/ReporterTest.php
rename to test/Unit/Reporter/DefaultReporterTest.php
index 042b9703..fc19a1e6 100644
--- a/test/Unit/Reporter/ReporterTest.php
+++ b/test/Unit/Reporter/DefaultReporterTest.php
@@ -15,7 +15,7 @@
 
 use Ergebnis\PHPUnit\SlowTestDetector\Exception;
 use Ergebnis\PHPUnit\SlowTestDetector\Formatter\ToMillisecondsDurationFormatter;
-use Ergebnis\PHPUnit\SlowTestDetector\Reporter\Reporter;
+use Ergebnis\PHPUnit\SlowTestDetector\Reporter\DefaultReporter;
 use Ergebnis\PHPUnit\SlowTestDetector\SlowTest;
 use Ergebnis\PHPUnit\SlowTestDetector\Test\Fixture;
 use Ergebnis\Test\Util;
@@ -25,14 +25,14 @@
 /**
  * @internal
  *
- * @covers \Ergebnis\PHPUnit\SlowTestDetector\Reporter\Reporter
+ * @covers \Ergebnis\PHPUnit\SlowTestDetector\Reporter\DefaultReporter
  *
  * @uses \Ergebnis\PHPUnit\SlowTestDetector\Comparator\DurationComparator
  * @uses \Ergebnis\PHPUnit\SlowTestDetector\Exception\MaximumNumberNotGreaterThanZero
  * @uses \Ergebnis\PHPUnit\SlowTestDetector\Formatter\ToMillisecondsDurationFormatter
  * @uses \Ergebnis\PHPUnit\SlowTestDetector\SlowTest
  */
-final class ReporterTest extends Framework\TestCase
+final class DefaultReporterTest extends Framework\TestCase
 {
     use Util\Helper;
 
@@ -52,7 +52,7 @@ public function testConstructorRejectsMaximumCountLessThanOne(int $maximumCount)
 
         $this->expectException(Exception\MaximumNumberNotGreaterThanZero::class);
 
-        new Reporter(
+        new DefaultReporter(
             $durationFormatter,
             $maximumDuration,
             $maximumCount
@@ -70,7 +70,7 @@ public function testReportReturnsEmptyStringWhenNoSlowTestsHaveBeenSpecified():
         );
         $maximumCount = $faker->numberBetween();
 
-        $reporter = new Reporter(
+        $reporter = new DefaultReporter(
             $durationFormatter,
             $maximumDuration,
             $maximumCount
@@ -152,7 +152,7 @@ public function testReportReturnsReportWhenTheNumberOfSlowTestsIsSmallerThanTheM
 
         $maximumNumber = $faker->numberBetween(\count($slowTests) + 1);
 
-        $reporter = new Reporter(
+        $reporter = new DefaultReporter(
             $durationFormatter,
             $maximumDuration,
             $maximumNumber
@@ -243,7 +243,7 @@ public function testReportReturnsReportWhenTheNumberOfSlowTestsIsEqualToTheMaxim
 
         $maximumNumber = \count($slowTests);
 
-        $reporter = new Reporter(
+        $reporter = new DefaultReporter(
             $durationFormatter,
             $maximumDuration,
             $maximumNumber
@@ -334,7 +334,7 @@ public function testReportReturnsReportWhenTheNumberOfSlowTestsIsOneMoreThanTheM
 
         $maximumNumber = \count($slowTests) - 1;
 
-        $reporter = new Reporter(
+        $reporter = new DefaultReporter(
             $durationFormatter,
             $maximumDuration,
             $maximumNumber
@@ -425,7 +425,7 @@ public function testReportReturnsReportWhenTheNumberOfSlowTestsIsGreaterThanTheM
 
         $maximumNumber = \count($slowTests) - 2;
 
-        $reporter = new Reporter(
+        $reporter = new DefaultReporter(
             $durationFormatter,
             $maximumDuration,
             $maximumNumber