Support tomasvotruba/type-coverage 0.2.x format (#135)

Author: staabm

composer.json

@@ -23,7 +23,7 @@
         "symfony/var-dumper": "^5.3",
         "thecodingmachine/phpstan-safe-rule": "^1.2",
         "tomasvotruba/cognitive-complexity": "^0.1.1",
-        "tomasvotruba/type-coverage": "^0.1.0",
+        "tomasvotruba/type-coverage": "^0.2.0",
         "tomasvotruba/unused-public": "^0.3.2"
     },
     "config": {

lib/BaselineAnalyzer.php

@@ -16,17 +16,17 @@ final class BaselineAnalyzer
      * @api
      * @var string
      */
-    public const PROPERTY_TYPE_DEClARATION_SEA_LEVEL_MESSAGE = 'Out of %d possible property types, only %d %% actually have it. Add more property types to get over %d %%';
+    public const PROPERTY_TYPE_DEClARATION_SEA_LEVEL_MESSAGE = 'Out of %d possible property types, only %d - %.1f %% actually have it. Add more property types to get over %d %%';
     /**
      * @api
      * @var string
      */
-    public const PARAM_TYPE_DEClARATION_SEA_LEVEL_MESSAGE = 'Out of %d possible param types, only %d %% actually have it. Add more param types to get over %d %%';
+    public const PARAM_TYPE_DEClARATION_SEA_LEVEL_MESSAGE = 'Out of %d possible param types, only %d - %.1f %% actually have it. Add more param types to get over %d %%';
     /**
      * @api
      * @var string
      */
-    public const RETURN_TYPE_DEClARATION_SEA_LEVEL_MESSAGE = 'Out of %d possible return types, only %d %% actually have it. Add more return types to get over %d %%';
+    public const RETURN_TYPE_DEClARATION_SEA_LEVEL_MESSAGE = 'Out of %d possible return types, only %d - %.1f %% actually have it. Add more return types to get over %d %%';
 
     /**
      * @var Baseline
@@ -118,23 +118,47 @@ private function countUnusedSymbols(BaselineError $baselineError): int
 
     private function checkSeaLevels(AnalyzerResult $result, BaselineError $baselineError): void
     {
-        if (sscanf($baselineError->unwrapMessage(), self::PROPERTY_TYPE_DEClARATION_SEA_LEVEL_MESSAGE, $absoluteCount, $coveragePercent, $goalPercent) >= 2) {
+        if (
+            sscanf(
+                $baselineError->unwrapMessage(),
+                $this->printfToScanfFormat(self::PROPERTY_TYPE_DEClARATION_SEA_LEVEL_MESSAGE),
+                $absoluteCountMin, $coveragePercent, $goalPercent) >= 2
+        ) {
             if (!is_int($coveragePercent) || $coveragePercent < 0 || $coveragePercent > 100) {
                 throw new \LogicException('Invalid property coveragePercent: '. $coveragePercent);
             }
             $result->propertyTypeCoverage = $coveragePercent;
         }
-        if (sscanf($baselineError->unwrapMessage(), self::PARAM_TYPE_DEClARATION_SEA_LEVEL_MESSAGE, $absoluteCount, $coveragePercent, $goalPercent) >= 2) {
+
+        if (
+            sscanf(
+                $baselineError->unwrapMessage(),
+                $this->printfToScanfFormat(self::PARAM_TYPE_DEClARATION_SEA_LEVEL_MESSAGE),
+                $absoluteCountMin, $coveragePercent, $goalPercent) >= 2
+        ) {
             if (!is_int($coveragePercent) || $coveragePercent < 0 || $coveragePercent > 100) {
                 throw new \LogicException('Invalid parameter coveragePercent: '. $coveragePercent);
             }
             $result->paramTypeCoverage = $coveragePercent;
         }
-        if (sscanf($baselineError->unwrapMessage(), self::RETURN_TYPE_DEClARATION_SEA_LEVEL_MESSAGE, $absoluteCount, $coveragePercent, $goalPercent) >= 2) {
+
+        if (
+            sscanf(
+                $baselineError->unwrapMessage(),
+                $this->printfToScanfFormat(self::RETURN_TYPE_DEClARATION_SEA_LEVEL_MESSAGE),
+                $absoluteCountMin, $coveragePercent, $goalPercent) >= 2
+        ) {
             if (!is_int($coveragePercent) || $coveragePercent < 0 || $coveragePercent > 100) {
                 throw new \LogicException('Invalid return coveragePercent: '. $coveragePercent);
             }
             $result->returnTypeCoverage = $coveragePercent;
         }
     }
+
+    private function printfToScanfFormat(string $format): string {
+        // we don't need the float value, therefore simply ignore it, to make the format parseable by sscanf
+        // see https://github.com/php/php-src/issues/12126
+        // additionally this makes the output format of tomasvotruba/type-coverage 0.2.* compatible with tomasvotruba/type-coverage 0.1.*
+        return str_replace('%.1f', '', $format);
+    }
 }

tests/BaselineAnalyzerTest.php

@@ -133,6 +133,7 @@ function testAnonymousVariables():void
 
     function testSeaLevels():void
     {
+        # output format of tomasvotruba/type-coverage 0.1.*
         $analyzer = new BaselineAnalyzer(Baseline::forFile(__DIR__ . '/fixtures/sea-level.neon'));
         $result = $analyzer->analyze();
 
@@ -148,6 +149,24 @@ function testSeaLevels():void
         $this->assertSame(0, $result->unusedSymbols);
     }
 
+    function testSeaLevelsV02():void
+    {
+        # output format of tomasvotruba/type-coverage 0.2.*
+        $analyzer = new BaselineAnalyzer(Baseline::forFile(__DIR__ . '/fixtures/sea-level-0_2.neon'));
+        $result = $analyzer->analyze();
+
+        $this->assertSame(6, $result->overallErrors);
+        $this->assertSame(0, $result->classesComplexity);
+        $this->assertSame(0, $result->deprecations);
+        $this->assertSame(0, $result->invalidPhpdocs);
+        $this->assertSame(0, $result->unknownTypes);
+        $this->assertSame(0, $result->anonymousVariables);
+        $this->assertSame(1, $result->propertyTypeCoverage);
+        $this->assertSame(27, $result->paramTypeCoverage);
+        $this->assertSame(4, $result->returnTypeCoverage);
+        $this->assertSame(0, $result->unusedSymbols);
+    }
+
     public function testSymplifyCompat(): void {
         $this->assertSame(
             BaselineAnalyzer::CLASS_COMPLEXITY_ERROR_MESSAGE,

tests/fixtures/sea-level-0_2.neon

@@ -0,0 +1,18 @@
+# output format of tomasvotruba/type-coverage 0.2.*
+
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Out of 1 possible property types, only 1 \\- 36\\.0 %% actually have it\\. Add more property types to get over 99 %%$#"
+			count: 2
+			path: N/A
+
+		-
+			message: "#^Out of 22 possible return types, only 4 \\- 36\\.0 %% actually have it\\. Add more return types to get over 99 %%$#"
+			count: 2
+			path: N/A
+
+		-
+			message: "#^Out of 33 possible param types, only 27 \\- 36\\.0 %% actually have it\\. Add more param types to get over 99 %%$#"
+			count: 2
+			path: N/A

tests/fixtures/sea-level.neon

@@ -1,3 +1,5 @@
+# output format of tomasvotruba/type-coverage 0.1.*
+
 parameters:
 	ignoreErrors:
 		-