Util\Timing: class no longer needs to be "static"

Now the "total runtime" recording is started and displayed from within the same class (`Runner`), the `Timing` class no longer needs to be a static class.
It also no longer needs protection against the timer not having been started (as it will now be auto-started via the constructor) or against the time being printed twice.

The only method which will remain static is the `getHumanReadableDuration()`, which is basically a stand-alone method anyhow and keeping it static makes testing this more straight-forward.

Includes simplifying the tests significantly.

Author: jrfnl

src/Runner.php

@@ -61,7 +61,7 @@ public function runPHPCS()
         $this->registerOutOfMemoryShutdownMessage('phpcs');
 
         try {
-            Timing::startTiming();
+            $timing = new Timing();
 
             if (defined('PHP_CODESNIFFER_CBF') === false) {
                 define('PHP_CODESNIFFER_CBF', false);
@@ -123,7 +123,7 @@ public function runPHPCS()
             $this->reporter->printReports();
 
             if ($this->config->quiet === false) {
-                Timing::printRunTime();
+                $timing->printRunTime();
             }
         } catch (DeepExitException $e) {
             echo $e->getMessage();
@@ -158,7 +158,7 @@ public function runPHPCBF()
         }
 
         try {
-            Timing::startTiming();
+            $timing = new Timing();
 
             // Creating the Config object populates it with all required settings
             // based on the CLI arguments provided to the script and any config
@@ -209,7 +209,7 @@ public function runPHPCBF()
 
             if ($this->config->quiet === false) {
                 StatusWriter::print('');
-                Timing::printRunTime();
+                $timing->printRunTime();
             }
         } catch (DeepExitException $e) {
             echo $e->getMessage();

src/Util/Timing.php

@@ -1,17 +1,19 @@
 <?php
 /**
- * Timing functions for the run.
+ * Timing functions.
  *
  * @author    Greg Sherwood <[email protected]>
+ * @author    Juliette Reinders Folmer <[email protected]>
  * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
+ * @copyright 2025 PHPCSStandards and contributors
  * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
  */
 
 namespace PHP_CodeSniffer\Util;
 
 use PHP_CodeSniffer\Util\Writers\StatusWriter;
 
-class Timing
+final class Timing
 {
 
     /**
@@ -33,42 +35,29 @@ class Timing
      *
      * @var float
      */
-    private static $startTime;
-
-    /**
-     * Used to make sure we only print the run time once per run.
-     *
-     * @var boolean
-     */
-    private static $printed = false;
+    private $startTime;
 
 
     /**
      * Start recording time for the run.
      *
      * @return void
      */
-    public static function startTiming()
+    public function __construct()
     {
+        $this->startTime = microtime(true);
 
-        self::$startTime = microtime(true);
-
-    }//end startTiming()
+    }//end __construct()
 
 
     /**
      * Get the duration of the run up to "now".
      *
      * @return float Duration in milliseconds.
      */
-    public static function getDuration()
+    public function getDuration()
     {
-        if (self::$startTime === null) {
-            // Timing was never started.
-            return 0;
-        }
-
-        return ((microtime(true) - self::$startTime) * 1000);
+        return ((microtime(true) - $this->startTime) * 1000);
 
     }//end getDuration()
 
@@ -104,31 +93,16 @@ public static function getHumanReadableDuration($duration)
     /**
      * Print information about the run.
      *
-     * @param boolean $force If TRUE, prints the output even if it has
-     *                       already been printed during the run.
-     *
      * @return void
      */
-    public static function printRunTime($force=false)
+    public function printRunTime()
     {
-        if ($force === false && self::$printed === true) {
-            // A double call.
-            return;
-        }
-
-        if (self::$startTime === null) {
-            // Timing was never started.
-            return;
-        }
-
-        $duration = self::getDuration();
-        $duration = self::getHumanReadableDuration($duration);
+        $duration = $this->getDuration();
+        $duration = $this->getHumanReadableDuration($duration);
 
         $mem = round((memory_get_peak_usage(true) / (1024 * 1024)), 2).'MB';
         StatusWriter::write("Time: $duration; Memory: $mem");
 
-        self::$printed = true;
-
     }//end printRunTime()
 
 

tests/Core/Util/Timing/TimingTest.php

@@ -16,42 +16,23 @@
 /**
  * Tests for the \PHP_CodeSniffer\Util\Timing class.
  *
- * {@internal These tests need to run in separate processes as the Timing class uses static properties
- * to keep track of the start time and whether or not the runtime has been printed and these
- * can't be unset/reset once set.}
- *
  * @covers \PHP_CodeSniffer\Util\Timing
- *
- * @runTestsInSeparateProcesses
- * @preserveGlobalState         disabled
  */
 final class TimingTest extends TestCase
 {
     use StatusWriterTestHelper;
 
 
-    /**
-     * Verify that getDuration() returns 0 when the timer wasn't started.
-     *
-     * @return void
-     */
-    public function testGetDurationWithoutStartReturnsZero()
-    {
-        $this->assertSame(0, Timing::getDuration());
-
-    }//end testGetDurationWithoutStartReturnsZero()
-
-
     /**
      * Verify that getDuration() returns the time in milliseconds.
      *
      * @return void
      */
     public function testGetDurationWithStartReturnsMilliseconds()
     {
-        Timing::startTiming();
+        $timing = new Timing();
         usleep(1500);
-        $duration = Timing::getDuration();
+        $duration = $timing->getDuration();
 
         $this->assertIsFloat($duration);
         $this->assertGreaterThan(1, $duration);
@@ -61,77 +42,43 @@ public function testGetDurationWithStartReturnsMilliseconds()
 
 
     /**
-     * Verify that printRunTime() doesn't print anything if the timer wasn't started.
-     *
-     * @return void
-     */
-    public function testTimeIsNotPrintedIfTimerWasNeverStarted()
-    {
-        $this->expectNoStdoutOutput();
-
-        Timing::printRunTime();
-
-        $this->assertStderrOutputSameString('');
-
-    }//end testTimeIsNotPrintedIfTimerWasNeverStarted()
-
-
-    /**
-     * Verify that printRunTime() doesn't print anything if the timer wasn't started.
-     *
-     * @return void
-     */
-    public function testTimeIsNotPrintedIfTimerWasNeverStartedEvenWhenForced()
-    {
-        $this->expectNoStdoutOutput();
-
-        Timing::printRunTime(true);
-
-        $this->assertStderrOutputSameString('');
-
-    }//end testTimeIsNotPrintedIfTimerWasNeverStartedEvenWhenForced()
-
-
-    /**
-     * Verify that printRunTime() when called multiple times only prints the runtime information once.
+     * Verify that printRunTime() prints the runtime information.
      *
      * @return void
      */
-    public function testTimeIsPrintedOnlyOnce()
+    public function testTimeIsPrinted()
     {
         $this->expectNoStdoutOutput();
 
-        Timing::startTiming();
+        $timing = new Timing();
         usleep(2000);
-        Timing::printRunTime();
-        Timing::printRunTime();
-        Timing::printRunTime();
+        $timing->printRunTime();
 
         $regex = '`^Time: [0-9]+ms; Memory: [0-9\.]+MB'.PHP_EOL.'$`';
         $this->assertStderrOutputMatchesRegex($regex);
 
-    }//end testTimeIsPrintedOnlyOnce()
+    }//end testTimeIsPrinted()
 
 
     /**
-     * Verify that printRunTime() when called multiple times prints the runtime information multiple times if forced.
+     * Verify that printRunTime() when called multiple times prints the runtime information multiple times.
      *
      * @return void
      */
-    public function testTimeIsPrintedMultipleTimesOnlyIfForced()
+    public function testTimeIsPrintedMultipleTimesWhenRequestedMultipleTimes()
     {
         $this->expectNoStdoutOutput();
 
-        Timing::startTiming();
+        $timing = new Timing();
         usleep(2000);
-        Timing::printRunTime(true);
-        Timing::printRunTime(true);
-        Timing::printRunTime(true);
+        $timing->printRunTime(true);
+        $timing->printRunTime(true);
+        $timing->printRunTime(true);
 
         $regex = '`^(Time: [0-9]+ms; Memory: [0-9\.]+MB'.PHP_EOL.'){3}$`';
         $this->assertStderrOutputMatchesRegex($regex);
 
-    }//end testTimeIsPrintedMultipleTimesOnlyIfForced()
+    }//end testTimeIsPrintedMultipleTimesWhenRequestedMultipleTimes()
 
 
 }//end class