Support type-coverage in trend reports (#123)

Author: staabm

lib/TrendApplication.php

@@ -128,13 +128,19 @@ private function createTrendResult(string $baselinePath, array $comparing, Analy
             return array($trendResult, $exitCode);
         }
 
-        $exitCode = $this->compare($trendResult, ResultPrinter::KEY_OVERALL_ERRORS, $reference->overallErrors, $comparing[$baselinePath]->overallErrors, $exitCode);
-        $exitCode = $this->compare($trendResult, ResultPrinter::KEY_CLASSES_COMPLEXITY, $reference->classesComplexity, $comparing[$baselinePath]->classesComplexity, $exitCode);
-        $exitCode = $this->compare($trendResult, ResultPrinter::KEY_DEPRECATIONS, $reference->deprecations, $comparing[$baselinePath]->deprecations, $exitCode);
-        $exitCode = $this->compare($trendResult, ResultPrinter::KEY_INVALID_PHPDOCS, $reference->invalidPhpdocs, $comparing[$baselinePath]->invalidPhpdocs, $exitCode);
-        $exitCode = $this->compare($trendResult, ResultPrinter::KEY_UNKNOWN_TYPES, $reference->unknownTypes, $comparing[$baselinePath]->unknownTypes, $exitCode);
-        $exitCode = $this->compare($trendResult, ResultPrinter::KEY_ANONYMOUS_VARIABLES, $reference->anonymousVariables, $comparing[$baselinePath]->anonymousVariables, $exitCode);
-        $exitCode = $this->compare($trendResult, ResultPrinter::KEY_UNUSED_SYMBOLS, $reference->unusedSymbols, $comparing[$baselinePath]->unusedSymbols, $exitCode);
+        // decreased trends are better
+        $exitCode = $this->compareDecreasing($trendResult, ResultPrinter::KEY_OVERALL_ERRORS, $reference->overallErrors, $comparing[$baselinePath]->overallErrors, $exitCode);
+        $exitCode = $this->compareDecreasing($trendResult, ResultPrinter::KEY_CLASSES_COMPLEXITY, $reference->classesComplexity, $comparing[$baselinePath]->classesComplexity, $exitCode);
+        $exitCode = $this->compareDecreasing($trendResult, ResultPrinter::KEY_DEPRECATIONS, $reference->deprecations, $comparing[$baselinePath]->deprecations, $exitCode);
+        $exitCode = $this->compareDecreasing($trendResult, ResultPrinter::KEY_INVALID_PHPDOCS, $reference->invalidPhpdocs, $comparing[$baselinePath]->invalidPhpdocs, $exitCode);
+        $exitCode = $this->compareDecreasing($trendResult, ResultPrinter::KEY_UNKNOWN_TYPES, $reference->unknownTypes, $comparing[$baselinePath]->unknownTypes, $exitCode);
+        $exitCode = $this->compareDecreasing($trendResult, ResultPrinter::KEY_ANONYMOUS_VARIABLES, $reference->anonymousVariables, $comparing[$baselinePath]->anonymousVariables, $exitCode);
+        $exitCode = $this->compareDecreasing($trendResult, ResultPrinter::KEY_UNUSED_SYMBOLS, $reference->unusedSymbols, $comparing[$baselinePath]->unusedSymbols, $exitCode);
+
+        // increased trends are better
+        $exitCode = $this->compareIncreasing($trendResult, ResultPrinter::KEY_RETURN_TYPE_COVERAGE, $reference->returnTypeCoverage, $comparing[$baselinePath]->returnTypeCoverage, $exitCode);
+        $exitCode = $this->compareIncreasing($trendResult, ResultPrinter::KEY_PROPERTY_TYPE_COVERAGE, $reference->propertyTypeCoverage, $comparing[$baselinePath]->propertyTypeCoverage, $exitCode);
+        $exitCode = $this->compareIncreasing($trendResult, ResultPrinter::KEY_PARAM_TYPE_COVERAGE, $reference->paramTypeCoverage, $comparing[$baselinePath]->paramTypeCoverage, $exitCode);
 
         return array($trendResult, $exitCode);
     }
@@ -147,7 +153,7 @@ private function createTrendResult(string $baselinePath, array $comparing, Analy
      *
      * @return self::EXIT_*
      */
-    private function compare(TrendResult $trendResult, string $key, $referenceValue, $comparingValue, int $exitCode): int
+    private function compareDecreasing(TrendResult $trendResult, string $key, $referenceValue, $comparingValue, int $exitCode): int
     {
         if ($comparingValue > $referenceValue) {
             $trendResult->setKey($key, $referenceValue, $comparingValue, 'worse');
@@ -162,4 +168,28 @@ private function compare(TrendResult $trendResult, string $key, $referenceValue,
 
         return $exitCode;
     }
+
+    /**
+     * @param ResultPrinter::KEY_* $key
+     * @param int $referenceValue
+     * @param int $comparingValue
+     * @param self::EXIT_* $exitCode
+     *
+     * @return self::EXIT_*
+     */
+    private function compareIncreasing(TrendResult $trendResult, string $key, $referenceValue, $comparingValue, int $exitCode): int
+    {
+        if ($comparingValue > $referenceValue) {
+            $trendResult->setKey($key, $referenceValue, $comparingValue, 'improved');
+            $exitCode = max($exitCode, self::EXIT_IMPROVED);
+        } elseif ($comparingValue < $referenceValue) {
+            $trendResult->setKey($key, $referenceValue, $comparingValue, 'worse');
+            $exitCode = max($exitCode, self::EXIT_WORSE);
+        } else {
+            $trendResult->setKey($key, $referenceValue, $comparingValue, 'good');
+            $exitCode = max($exitCode, self::EXIT_STEADY);
+        }
+
+        return $exitCode;
+    }
 }

tests/TrendApplicationTest.php

@@ -25,6 +25,9 @@ function testSameTrend():void
   Unknown-Types: 5 -> 5 => good
   Anonymous-Variables: 2 -> 2 => good
   Unused-Symbols: 1 -> 1 => good
+  Native-Return-Type-Coverage: 2 -> 2 => good
+  Native-Property-Type-Coverage: 3 -> 3 => good
+  Native-Param-Type-Coverage: 4 -> 4 => good
 
 PHP;
 
@@ -51,6 +54,9 @@ function testHigherTrend():void
   Unknown-Types: 5 -> 15 => worse
   Anonymous-Variables: 2 -> 5 => worse
   Unused-Symbols: 1 -> 10 => worse
+  Native-Return-Type-Coverage: 2 -> 20 => improved
+  Native-Property-Type-Coverage: 3 -> 30 => improved
+  Native-Param-Type-Coverage: 4 -> 40 => improved
 
 PHP;
 
@@ -77,11 +83,14 @@ function testLowerTrend():void
   Unknown-Types: 5 -> 3 => improved
   Anonymous-Variables: 2 -> 1 => improved
   Unused-Symbols: 1 -> 0 => improved
+  Native-Return-Type-Coverage: 2 -> 1 => worse
+  Native-Property-Type-Coverage: 3 -> 2 => worse
+  Native-Param-Type-Coverage: 4 -> 3 => worse
 
 PHP;
 
         $this->assertSame($expected, $rendered);
-        $this->assertSame(TrendApplication::EXIT_IMPROVED, $exitCode);
+        $this->assertSame(TrendApplication::EXIT_WORSE, $exitCode);
     }
 
     function testSameTrendFormatJson():void
@@ -95,7 +104,7 @@ function testSameTrendFormatJson():void
         $rendered = str_replace(__DIR__, '', $rendered);
 
         $expected = <<<PHP
-[{"headline":"Analyzing Trend for \/fixtures\/all-in.neon","results":{"Overall-Errors":{"reference":18,"comparing":18,"trend":"good"},"Classes-Cognitive-Complexity":{"reference":70,"comparing":70,"trend":"good"},"Deprecations":{"reference":1,"comparing":1,"trend":"good"},"Invalid-Phpdocs":{"reference":3,"comparing":3,"trend":"good"},"Unknown-Types":{"reference":5,"comparing":5,"trend":"good"},"Anonymous-Variables":{"reference":2,"comparing":2,"trend":"good"},"Unused-Symbols":{"reference":1,"comparing":1,"trend":"good"}}}]
+[{"headline":"Analyzing Trend for \/fixtures\/all-in.neon","results":{"Overall-Errors":{"reference":18,"comparing":18,"trend":"good"},"Classes-Cognitive-Complexity":{"reference":70,"comparing":70,"trend":"good"},"Deprecations":{"reference":1,"comparing":1,"trend":"good"},"Invalid-Phpdocs":{"reference":3,"comparing":3,"trend":"good"},"Unknown-Types":{"reference":5,"comparing":5,"trend":"good"},"Anonymous-Variables":{"reference":2,"comparing":2,"trend":"good"},"Unused-Symbols":{"reference":1,"comparing":1,"trend":"good"},"Native-Return-Type-Coverage":{"reference":2,"comparing":2,"trend":"good"},"Native-Property-Type-Coverage":{"reference":3,"comparing":3,"trend":"good"},"Native-Param-Type-Coverage":{"reference":4,"comparing":4,"trend":"good"}}}]
 PHP;
 
         $this->assertSame($expected, $rendered);
@@ -113,7 +122,7 @@ function testHigherTrendFormatJson():void
         $rendered = str_replace(__DIR__, '', $rendered);
 
         $expected = <<<PHP
-[{"headline":"Analyzing Trend for \/fixtures\/all-in.neon","results":{"Overall-Errors":{"reference":18,"comparing":24,"trend":"worse"},"Classes-Cognitive-Complexity":{"reference":70,"comparing":90,"trend":"worse"},"Deprecations":{"reference":1,"comparing":10,"trend":"worse"},"Invalid-Phpdocs":{"reference":3,"comparing":30,"trend":"worse"},"Unknown-Types":{"reference":5,"comparing":15,"trend":"worse"},"Anonymous-Variables":{"reference":2,"comparing":5,"trend":"worse"},"Unused-Symbols":{"reference":1,"comparing":10,"trend":"worse"}}}]
+[{"headline":"Analyzing Trend for \/fixtures\/all-in.neon","results":{"Overall-Errors":{"reference":18,"comparing":24,"trend":"worse"},"Classes-Cognitive-Complexity":{"reference":70,"comparing":90,"trend":"worse"},"Deprecations":{"reference":1,"comparing":10,"trend":"worse"},"Invalid-Phpdocs":{"reference":3,"comparing":30,"trend":"worse"},"Unknown-Types":{"reference":5,"comparing":15,"trend":"worse"},"Anonymous-Variables":{"reference":2,"comparing":5,"trend":"worse"},"Unused-Symbols":{"reference":1,"comparing":10,"trend":"worse"},"Native-Return-Type-Coverage":{"reference":2,"comparing":20,"trend":"improved"},"Native-Property-Type-Coverage":{"reference":3,"comparing":30,"trend":"improved"},"Native-Param-Type-Coverage":{"reference":4,"comparing":40,"trend":"improved"}}}]
 PHP;
 
         $this->assertSame($expected, $rendered);
@@ -131,10 +140,10 @@ function testLowerTrendFormatJson():void
         $rendered = str_replace(__DIR__, '', $rendered);
 
         $expected = <<<PHP
-[{"headline":"Analyzing Trend for \/fixtures\/all-in.neon","results":{"Overall-Errors":{"reference":18,"comparing":10,"trend":"improved"},"Classes-Cognitive-Complexity":{"reference":70,"comparing":50,"trend":"improved"},"Deprecations":{"reference":1,"comparing":0,"trend":"improved"},"Invalid-Phpdocs":{"reference":3,"comparing":1,"trend":"improved"},"Unknown-Types":{"reference":5,"comparing":3,"trend":"improved"},"Anonymous-Variables":{"reference":2,"comparing":1,"trend":"improved"},"Unused-Symbols":{"reference":1,"comparing":0,"trend":"improved"}}}]
+[{"headline":"Analyzing Trend for \/fixtures\/all-in.neon","results":{"Overall-Errors":{"reference":18,"comparing":10,"trend":"improved"},"Classes-Cognitive-Complexity":{"reference":70,"comparing":50,"trend":"improved"},"Deprecations":{"reference":1,"comparing":0,"trend":"improved"},"Invalid-Phpdocs":{"reference":3,"comparing":1,"trend":"improved"},"Unknown-Types":{"reference":5,"comparing":3,"trend":"improved"},"Anonymous-Variables":{"reference":2,"comparing":1,"trend":"improved"},"Unused-Symbols":{"reference":1,"comparing":0,"trend":"improved"},"Native-Return-Type-Coverage":{"reference":2,"comparing":1,"trend":"worse"},"Native-Property-Type-Coverage":{"reference":3,"comparing":2,"trend":"worse"},"Native-Param-Type-Coverage":{"reference":4,"comparing":3,"trend":"worse"}}}]
 PHP;
 
         $this->assertSame($expected, $rendered);
-        $this->assertSame(TrendApplication::EXIT_IMPROVED, $exitCode);
+        $this->assertSame(TrendApplication::EXIT_WORSE, $exitCode);
     }
 }

tests/fixtures/compare-higher-result.json

@@ -1 +1 @@
-[{"\/fixtures\/all-in.neon":{"Overall-Errors":24,"Classes-Cognitive-Complexity":90,"Deprecations": 10,"Invalid-Phpdocs": 30,"Unknown-Types": 15,"Anonymous-Variables": 5,"Unused-Symbols": 10}}]
+[{"\/fixtures\/all-in.neon":{"Overall-Errors":24,"Classes-Cognitive-Complexity":90,"Deprecations": 10,"Invalid-Phpdocs": 30,"Unknown-Types": 15,"Anonymous-Variables": 5,"Unused-Symbols": 10,"Native-Return-Type-Coverage": 20,"Native-Property-Type-Coverage": 30,"Native-Param-Type-Coverage": 40}}]

tests/fixtures/compare-lower-result.json

@@ -1 +1 @@
-[{"\/fixtures\/all-in.neon":{"Overall-Errors":10,"Classes-Cognitive-Complexity":50,"Invalid-Phpdocs": 1,"Unknown-Types": 3,"Anonymous-Variables": 1}}]
+[{"\/fixtures\/all-in.neon":{"Overall-Errors":10,"Classes-Cognitive-Complexity":50,"Invalid-Phpdocs": 1,"Unknown-Types": 3,"Anonymous-Variables": 1,"Unused-Symbols": 0,"Native-Return-Type-Coverage": 1,"Native-Property-Type-Coverage": 2,"Native-Param-Type-Coverage": 3}}]

tests/fixtures/compare-same-result.json

@@ -1 +1 @@
-[{"\/fixtures\/all-in.neon":{"Overall-Errors":18,"Classes-Cognitive-Complexity":70,"Deprecations": 1,"Invalid-Phpdocs": 3,"Unknown-Types": 5,"Anonymous-Variables": 2,"Unused-Symbols": 1}}]
+[{"\/fixtures\/all-in.neon":{"Overall-Errors":18,"Classes-Cognitive-Complexity":70,"Deprecations": 1,"Invalid-Phpdocs": 3,"Unknown-Types": 5,"Anonymous-Variables": 2,"Unused-Symbols": 1,"Native-Return-Type-Coverage": 2,"Native-Property-Type-Coverage": 3,"Native-Param-Type-Coverage": 4}}]

tests/fixtures/reference-result.json

@@ -1 +1 @@
-[{"\/fixtures\/all-in.neon":{"Overall-Errors":18,"Classes-Cognitive-Complexity":70,"Deprecations": 1,"Invalid-Phpdocs": 3,"Unknown-Types": 5,"Anonymous-Variables": 2,"Unused-Symbols": 1}}]
+[{"\/fixtures\/all-in.neon":{"Overall-Errors":18,"Classes-Cognitive-Complexity":70,"Deprecations": 1,"Invalid-Phpdocs": 3,"Unknown-Types": 5,"Anonymous-Variables": 2,"Unused-Symbols": 1,"Native-Return-Type-Coverage": 2,"Native-Property-Type-Coverage": 3,"Native-Param-Type-Coverage": 4}}]