Start using Timing class in more places

... which allows for removing some duplicate code and streamlining consistent display of timing information.

Author: jrfnl

.github/workflows/build-phar.yml

@@ -16,6 +16,7 @@ on:
       - 'src/Exceptions/RuntimeException.php'
       - 'src/Exceptions/TokenizerException.php'
       - 'src/Tokenizers/PHP.php'
+      - 'src/Util/Timing.php'
       - 'src/Util/Tokens.php'
   pull_request:
     paths:
@@ -27,6 +28,7 @@ on:
       - 'src/Exceptions/RuntimeException.php'
       - 'src/Exceptions/TokenizerException.php'
       - 'src/Tokenizers/PHP.php'
+      - 'src/Util/Timing.php'
       - 'src/Util/Tokens.php'
 
   # Allow manually triggering the workflow.

scripts/build-phar.php

@@ -17,6 +17,7 @@
 use PHP_CodeSniffer\Exceptions\RuntimeException;
 use PHP_CodeSniffer\Exceptions\TokenizerException;
 use PHP_CodeSniffer\Tokenizers\PHP;
+use PHP_CodeSniffer\Util\Timing;
 use PHP_CodeSniffer\Util\Tokens;
 
 error_reporting(E_ALL);
@@ -78,7 +79,7 @@ function stripWhitespaceAndComments($fullpath, $config)
 }//end stripWhitespaceAndComments()
 
 
-$startTime = microtime(true);
+$timer = new Timing();
 
 $scripts = [
     'phpcs',
@@ -170,14 +171,7 @@ function stripWhitespaceAndComments($fullpath, $config)
     echo 'done'.PHP_EOL;
 }//end foreach
 
-$timeTaken = ((microtime(true) - $startTime) * 1000);
-if ($timeTaken < 1000) {
-    $timeTaken = round($timeTaken);
-    echo "DONE in {$timeTaken}ms".PHP_EOL;
-} else {
-    $timeTaken = round(($timeTaken / 1000), 2);
-    echo "DONE in $timeTaken secs".PHP_EOL;
-}
+$timer->printRunTime();
 
 echo PHP_EOL;
 echo 'Filesize generated phpcs.phar file: '.filesize(dirname(__DIR__).'/phpcs.phar').' bytes'.PHP_EOL;

src/Files/File.php

@@ -16,6 +16,7 @@
 use PHP_CodeSniffer\Ruleset;
 use PHP_CodeSniffer\Tokenizers\PHP;
 use PHP_CodeSniffer\Util\Common;
+use PHP_CodeSniffer\Util\Timing;
 use PHP_CodeSniffer\Util\Tokens;
 use PHP_CodeSniffer\Util\Writers\StatusWriter;
 
@@ -449,7 +450,7 @@ public function process()
                 $this->activeListener = $class;
 
                 if ($this->configCache['trackTime'] === true) {
-                    $startTime = microtime(true);
+                    $timer = new Timing();
                 }
 
                 if (PHP_CODESNIFFER_VERBOSITY > 2) {
@@ -462,7 +463,7 @@ public function process()
                 }
 
                 if ($this->configCache['trackTime'] === true) {
-                    $timeTaken = (microtime(true) - $startTime);
+                    $timeTaken = $timer->getDuration();
                     if (isset($this->listenerTimes[$this->activeListener]) === false) {
                         $this->listenerTimes[$this->activeListener] = 0;
                     }
@@ -471,8 +472,7 @@ public function process()
                 }
 
                 if (PHP_CODESNIFFER_VERBOSITY > 2) {
-                    $timeTaken = round(($timeTaken), 4);
-                    StatusWriter::write("DONE in $timeTaken seconds");
+                    StatusWriter::write('DONE in '.$timer->getHumanReadableDuration($timeTaken));
                 }
 
                 $this->activeListener = '';

src/Reports/Cbf.php

@@ -15,6 +15,7 @@
 
 use PHP_CodeSniffer\Exceptions\DeepExitException;
 use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Util\Timing;
 use PHP_CodeSniffer\Util\Writers\StatusWriter;
 
 class Cbf implements Report
@@ -43,8 +44,8 @@ public function generateFileReport($report, File $phpcsFile, $showSources=false,
         if ($errors !== 0) {
             if (PHP_CODESNIFFER_VERBOSITY > 0) {
                 ob_end_clean();
-                $startTime = microtime(true);
-                $newlines  = 0;
+                $timer    = new Timing();
+                $newlines = 0;
                 if (PHP_CODESNIFFER_VERBOSITY > 1) {
                     $newlines = 1;
                 }
@@ -74,14 +75,7 @@ public function generateFileReport($report, File $phpcsFile, $showSources=false,
                 StatusWriter::forceWrite('DONE', 0, 0);
             }
 
-            $timeTaken = ((microtime(true) - $startTime) * 1000);
-            if ($timeTaken < 1000) {
-                $timeTaken = round($timeTaken);
-                StatusWriter::forceWrite(" in {$timeTaken}ms");
-            } else {
-                $timeTaken = round(($timeTaken / 1000), 2);
-                StatusWriter::forceWrite(" in $timeTaken secs");
-            }
+            StatusWriter::forceWrite(' in '.$timer->getHumanReadableDuration($timer->getDuration()));
         }
 
         if ($fixed === true) {

src/Reports/Code.php

@@ -12,6 +12,7 @@
 use Exception;
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Util\Common;
+use PHP_CodeSniffer\Util\Timing;
 use PHP_CodeSniffer\Util\Writers\StatusWriter;
 
 class Code implements Report
@@ -47,7 +48,7 @@ public function generateFileReport($report, File $phpcsFile, $showSources=false,
         $tokens = $phpcsFile->getTokens();
         if (empty($tokens) === true) {
             if (PHP_CODESNIFFER_VERBOSITY === 1) {
-                $startTime = microtime(true);
+                $timer = new Timing();
                 StatusWriter::forceWrite('CODE report is parsing '.basename($file).' ', 0, 0);
             } else if (PHP_CODESNIFFER_VERBOSITY > 1) {
                 StatusWriter::forceWrite("CODE report is forcing parse of $file");
@@ -65,14 +66,7 @@ public function generateFileReport($report, File $phpcsFile, $showSources=false,
             }
 
             if (PHP_CODESNIFFER_VERBOSITY === 1) {
-                $timeTaken = ((microtime(true) - $startTime) * 1000);
-                if ($timeTaken < 1000) {
-                    $timeTaken = round($timeTaken);
-                    StatusWriter::forceWrite("DONE in {$timeTaken}ms");
-                } else {
-                    $timeTaken = round(($timeTaken / 1000), 2);
-                    StatusWriter::forceWrite("DONE in $timeTaken secs");
-                }
+                StatusWriter::forceWrite('DONE in '.$timer->getHumanReadableDuration($timer->getDuration()));
             }
 
             $tokens = $phpcsFile->getTokens();

src/Reports/Diff.php

@@ -10,6 +10,7 @@
 namespace PHP_CodeSniffer\Reports;
 
 use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Util\Timing;
 use PHP_CodeSniffer\Util\Writers\StatusWriter;
 
 class Diff implements Report
@@ -42,7 +43,7 @@ public function generateFileReport($report, File $phpcsFile, $showSources=false,
         $tokens = $phpcsFile->getTokens();
         if (empty($tokens) === true) {
             if (PHP_CODESNIFFER_VERBOSITY === 1) {
-                $startTime = microtime(true);
+                $timer = new Timing();
                 StatusWriter::write('DIFF report is parsing '.basename($report['filename']).' ', 0, 0);
             } else if (PHP_CODESNIFFER_VERBOSITY > 1) {
                 StatusWriter::write('DIFF report is forcing parse of '.$report['filename']);
@@ -51,14 +52,7 @@ public function generateFileReport($report, File $phpcsFile, $showSources=false,
             $phpcsFile->parse();
 
             if (PHP_CODESNIFFER_VERBOSITY === 1) {
-                $timeTaken = ((microtime(true) - $startTime) * 1000);
-                if ($timeTaken < 1000) {
-                    $timeTaken = round($timeTaken);
-                    StatusWriter::write("DONE in {$timeTaken}ms");
-                } else {
-                    $timeTaken = round(($timeTaken / 1000), 2);
-                    StatusWriter::write("DONE in $timeTaken secs");
-                }
+                StatusWriter::write('DONE in '.$timer->getHumanReadableDuration($timer->getDuration()));
             }
 
             $phpcsFile->fixer->startFile($phpcsFile);