Change namespace from JohnKary\PHPUnit\Listener to JohnKary\PHPUnit\Extension

Author: johnkary

CHANGELOG.md

@@ -18,10 +18,6 @@ Version 3.3 adds supports for PHPUnit 9.5+, and a way to enable or disable the S
 * [PR #73](https://github.com/johnkary/phpunit-speedtrap/pull/73) Compatibility with PHPUnit 9.5
 * [PR #66](https://github.com/johnkary/phpunit-speedtrap/pull/66) Environment variable PHPUNIT_SPEEDTRAP="disabled" can disable profiling
 
-## Master
-
-* [PR #67](https://github.com/johnkary/phpunit-speedtrap/pull/67) Handle deprecated TestListener in PHPUnit 8
-
 ## 3.2.0 (2020-02-12)
 
 Version 3.2 introduces supports for PHPUnit 9.0+.

README.md

@@ -20,27 +20,15 @@ SpeedTrap is installed using [Composer](http://getcomposer.org). Add it as a `re
 ## Usage
 
 Enable with all defaults by adding the following code to your project's `phpunit.xml` file:
-
-If you are using PHPUnit 8 or above, and phpunit-speedtrap >= 4.0.0, you should register the listener like this:
 
 ```xml
 <phpunit bootstrap="vendor/autoload.php">
 ...
     <extensions>
-        <extension class="JohnKary\PHPUnit\Listener\SpeedTrapListener" />
+        <extension class="JohnKary\PHPUnit\Extension\SpeedTrap" />
     </extensions>
 </phpunit>
 ```
-Otherwise you can add the following:
- 
-```xml
-<phpunit bootstrap="vendor/autoload.php">
-...
-    <listeners>
-        <listener class="JohnKary\PHPUnit\Listener\SpeedTrapListener" />
-    </listeners>
-</phpunit>
-```
 
 Now run the test suite. If one or more test executions exceed the slowness threshold (500ms by default), SpeedTrap will report on those tests in the console after all tests have completed.
 
@@ -58,7 +46,7 @@ Each parameter is set in `phpunit.xml`:
     <!-- ... other suite configuration here ... -->
 
     <extensions>
-        <extension class="JohnKary\PHPUnit\Listener\SpeedTrapListener">
+        <extension class="JohnKary\PHPUnit\Extension\SpeedTrap">
             <arguments>
                 <array>
                     <element key="slowThreshold">
@@ -95,15 +83,15 @@ class SomeTestCase extends PHPUnit\Framework\TestCase
 
 ## Disable slowness profiling using an environment variable
 
-SpeedTrapListener profiles for slow tests when enabled in phpunit.xml. But using an environment variable named `PHPUNIT_SPEEDTRAP` can enable or disable the listener.
+SpeedTrap profiles for slow tests when enabled in phpunit.xml. But using an environment variable named `PHPUNIT_SPEEDTRAP` can enable or disable the extension:
 
     $ PHPUNIT_SPEEDTRAP="disabled" ./vendor/bin/phpunit
 
 #### Use case: Disable profiling in development, but profile with Travis CI
 
 Travis CI is popular for running tests in the cloud after pushing new code to a repository.
 
-Step 1) Enable SpeedTrapListener in phpunit.xml, but set `PHPUNIT_SPEEDTRAP="disabled"` to disable profiling when running tests.
+Step 1) Enable SpeedTrap in phpunit.xml, but set `PHPUNIT_SPEEDTRAP="disabled"` to disable profiling when running tests.
 
 ```xml
 <phpunit bootstrap="vendor/autoload.php">
@@ -112,9 +100,9 @@ Step 1) Enable SpeedTrapListener in phpunit.xml, but set `PHPUNIT_SPEEDTRAP="dis
         <env name="PHPUNIT_SPEEDTRAP" value="disabled" />
     </php>
 
-    <listeners>
-        <listener class="JohnKary\PHPUnit\Listener\SpeedTrapListener" />
-    </listeners>
+    <extensions>
+        <extension class="JohnKary\PHPUnit\Extension\SpeedTrap" />
+    </extensions>
 </phpunit>
 ```
 
@@ -136,14 +124,14 @@ Step 3) View the Travis CI build output and read the slowness report printed in
 
 #### Use case: Enable profiling in development, but disable with Travis CI
 
-Step 1) Enable SpeedTrapListener in phpunit.xml. The slowness report will output during all test suite executions.
+Step 1) Enable SpeedTrap in phpunit.xml. The slowness report will output during all test suite executions.
 
 ```xml
 <phpunit bootstrap="vendor/autoload.php">
 ...
-    <listeners>
-        <listener class="JohnKary\PHPUnit\Listener\SpeedTrapListener" />
-    </listeners>
+    <extensions>
+        <extension class="JohnKary\PHPUnit\Extension\SpeedTrap" />
+    </extensions>
 </phpunit>
 ```
 
@@ -161,11 +149,11 @@ env:
 
 Step 3) View the Travis CI build output and confirm the slowness report is not printed in the console.
 
-#### Use case: Only enable SpeedTrapListener on demand via command-line
+#### Use case: Only enable SpeedTrap on demand via command-line
 
 Useful when you only want to profile slow tests once in a while.
 
-Step 1) Setup phpunit.xml to enable SpeedTrapListener, but disable slowness profiling by setting `PHPUNIT_SPEEDTRAP="disabled"` like this:
+Step 1) Setup phpunit.xml to enable SpeedTrap, but disable slowness profiling by setting `PHPUNIT_SPEEDTRAP="disabled"` like this:
 
 ```xml
 <phpunit bootstrap="vendor/autoload.php">
@@ -174,9 +162,9 @@ Step 1) Setup phpunit.xml to enable SpeedTrapListener, but disable slowness prof
         <env name="PHPUNIT_SPEEDTRAP" value="disabled" />
     </php>
 
-    <listeners>
-        <listener class="JohnKary\PHPUnit\Listener\SpeedTrapListener" />
-    </listeners>
+    <extensions>
+        <extension class="JohnKary\PHPUnit\Extension\SpeedTrap" />
+    </extensions>
 </phpunit>
 ```
 

composer.json

@@ -26,12 +26,12 @@
     },
     "autoload": {
         "psr-4": {
-            "JohnKary\\PHPUnit\\Listener\\": "src/"
+            "JohnKary\\PHPUnit\\Extension\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "JohnKary\\PHPUnit\\Listener\\Tests\\": "tests/"
+            "JohnKary\\PHPUnit\\Extension\\Tests\\": "tests/"
         }
     }
 }

phpunit.xml.dist

@@ -21,7 +21,7 @@
     </testsuites>
 
     <extensions>
-        <extension class="JohnKary\PHPUnit\Listener\SpeedTrapListener">
+        <extension class="JohnKary\PHPUnit\Extension\SpeedTrap">
             <arguments>
                 <array>
                     <element key="slowThreshold">

src/SpeedTrapListener.php renamed to src/SpeedTrap.php

@@ -1,18 +1,18 @@
 <?php
 declare(strict_types=1);
 
-namespace JohnKary\PHPUnit\Listener;
+namespace JohnKary\PHPUnit\Extension;
 
 use PHPUnit\Runner\AfterLastTestHook;
 use PHPUnit\Runner\AfterSuccessfulTestHook;
 use PHPUnit\Runner\BeforeFirstTestHook;
 use PHPUnit\Util\Test as TestUtil;
 
 /**
- * A PHPUnit TestHook that exposes your slowest running tests by outputting
+ * A PHPUnit Extension that exposes your slowest running tests by outputting
  * results directly to the console.
  */
-class SpeedTrapListener implements AfterSuccessfulTestHook, BeforeFirstTestHook, AfterLastTestHook
+class SpeedTrap implements AfterSuccessfulTestHook, BeforeFirstTestHook, AfterLastTestHook
 {
     /**
      * Slowness profiling enabled by default. Set to false to disable profiling
@@ -149,7 +149,7 @@ protected function toMilliseconds(float $time): int
      * Label describing a slow test case. Formatted to support copy/paste with
      * PHPUnit's --filter CLI option:
      *
-     *     vendor/bin/phpunit --filter 'JohnKary\\PHPUnit\\Listener\\Tests\\SomeSlowTest::testWithDataProvider with data set "Rock"'
+     *     vendor/bin/phpunit --filter 'JohnKary\\PHPUnit\\Extension\\Tests\\SomeSlowTest::testWithDataProvider with data set "Rock"'
      */
     protected function makeLabel(string $test): string
     {

tests/ExceptionalTest.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace JohnKary\PHPUnit\Listener\Tests;
+namespace JohnKary\PHPUnit\Extension\Tests;
 
 use PHPUnit\Framework\TestCase;
 
@@ -16,12 +16,12 @@ public function testExceptionCanBeThrownInTest()
 
     public function testSkippedTest()
     {
-        $this->markTestSkipped('Skipped tests do not cause Exceptions in Listener');
+        $this->markTestSkipped('Skipped tests do not cause Exceptions in SpeedTrap extension');
     }
 
     public function testIncompleteTest()
     {
-        $this->markTestIncomplete('Incomplete tests do not cause Exceptions in Listener');
+        $this->markTestIncomplete('Incomplete tests do not cause Exceptions in SpeedTrap extension');
     }
 }
 

tests/SomeSlowTest.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace JohnKary\PHPUnit\Listener\Tests;
+namespace JohnKary\PHPUnit\Extension\Tests;
 
 use PHPUnit\Framework\TestCase;