Return the number of cache hits and cache misses

Author: sebastianbergmann

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ on:
 name: CI
 
 env:
-  COMPOSER_ROOT_VERSION: "12.0.x-dev"
+  COMPOSER_ROOT_VERSION: "12.1.x-dev"
 
 jobs:
   coding-guidelines:

ChangeLog-12.0.md

@@ -2,6 +2,12 @@
 
 All notable changes are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
+## [12.1.0] - 2025-MM-DD
+
+### Changed
+
+* `CacheWarmer::warmCache()` now returns the number of cache hits and cache misses
+
 ## [12.0.5] - 2025-03-15
 
 ### Fixed
@@ -45,6 +51,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
 * This component is no longer supported on PHP 8.2
 * This component no longer supports Xdebug versions before Xdebug 3.1
 
+[12.1.0]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.0.5...main
 [12.0.5]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.0.4...12.0.5
 [12.0.4]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.0.3...12.0.4
 [12.0.3]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.0.2...12.0.3

composer.json

@@ -61,7 +61,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "12.0.x-dev"
+            "dev-main": "12.1.x-dev"
         }
     }
 }

src/StaticAnalysis/CacheWarmer.php

@@ -13,7 +13,10 @@
 
 final class CacheWarmer
 {
-    public function warmCache(string $cacheDirectory, bool $useAnnotationsForIgnoringCode, bool $ignoreDeprecatedCode, Filter $filter): void
+    /**
+     * @return array{cacheHits: non-negative-int, cacheMisses: non-negative-int}
+     */
+    public function warmCache(string $cacheDirectory, bool $useAnnotationsForIgnoringCode, bool $ignoreDeprecatedCode, Filter $filter): array
     {
         $analyser = new CachingFileAnalyser(
             $cacheDirectory,
@@ -25,8 +28,19 @@ public function warmCache(string $cacheDirectory, bool $useAnnotationsForIgnorin
             $ignoreDeprecatedCode,
         );
 
+        $cacheHits   = 0;
+        $cacheMisses = 0;
+
         foreach ($filter->files() as $file) {
-            $analyser->process($file);
+            $statistics = $analyser->process($file);
+
+            $cacheHits   += $statistics['cacheHits'];
+            $cacheMisses += $statistics['cacheMisses'];
         }
+
+        return [
+            'cacheHits'   => $cacheHits,
+            'cacheMisses' => $cacheMisses,
+        ];
     }
 }

src/StaticAnalysis/CachingFileAnalyser.php

@@ -138,14 +138,20 @@ public function ignoredLinesFor(string $filename): array
         return $this->cache[$filename]['ignoredLinesFor'];
     }
 
-    public function process(string $filename): void
+    /**
+     * @return array{cacheHits: non-negative-int, cacheMisses: non-negative-int}
+     */
+    public function process(string $filename): array
     {
         $cache = $this->read($filename);
 
         if ($cache !== false) {
             $this->cache[$filename] = $cache;
 
-            return;
+            return [
+                'cacheHits'   => 1,
+                'cacheMisses' => 0,
+            ];
         }
 
         $this->cache[$filename] = [
@@ -159,6 +165,11 @@ public function process(string $filename): void
         ];
 
         $this->write($filename, $this->cache[$filename]);
+
+        return [
+            'cacheHits'   => 0,
+            'cacheMisses' => 1,
+        ];
     }
 
     /**

src/Version.php

@@ -19,7 +19,7 @@ final class Version
     public static function id(): string
     {
         if (self::$version === '') {
-            self::$version = (new VersionId('12.0.5', dirname(__DIR__)))->asString();
+            self::$version = (new VersionId('12.1', dirname(__DIR__)))->asString();
         }
 
         return self::$version;