Refactor (#143)

Co-authored-by: fbecker-complex <[email protected]>

Author: staabm

bin/phpstan-baseline-analyze.php

@@ -1,5 +1,6 @@
 <?php
 
+use staabm\PHPStanBaselineAnalysis\ResultPrinter;
 use function Safe\ini_set;
 
 // Finding composer
@@ -33,9 +34,9 @@
 }
 
 
-$format = \staabm\PHPStanBaselineAnalysis\ResultPrinter::FORMAT_TEXT;
+$format = ResultPrinter::FORMAT_TEXT;
 if (in_array('--json', $argv)) {
-    $format = \staabm\PHPStanBaselineAnalysis\ResultPrinter::FORMAT_JSON;
+    $format = ResultPrinter::FORMAT_JSON;
 }
 
 $exitCode = $app->start($argv[1], $format);

lib/Baseline.php

@@ -58,10 +58,10 @@ public function getIgnoreErrors(): Iterator {
         $ignoreErrors = $parameters['ignoreErrors'];
 
         foreach($ignoreErrors as $error) {
-            $baselineError = new BaselineError();
-            $baselineError->message = $error['message'];
-            $baselineError->count = $error['count'];
-            yield $baselineError;
+            yield new BaselineError(
+                $error['count'],
+                $error['message'],
+            );
         }
     }
 

lib/BaselineAnalyzer.php

@@ -65,13 +65,7 @@ public function analyze(): AnalyzerResult
 
     private function countDeprecations(BaselineError $baselineError): int
     {
-        return
-            str_contains($baselineError->message, ' deprecated class ')
-            || str_contains($baselineError->message, ' deprecated method ')
-            || str_contains($baselineError->message, ' deprecated function ')
-            || str_contains($baselineError->message, ' deprecated property ')
-            ? $baselineError->count
-            : 0;
+        return $baselineError->isDeprecationError() ? $baselineError->count : 0;
     }
 
     private function countClassesComplexity(BaselineError $baselineError): int
@@ -84,34 +78,28 @@ private function countClassesComplexity(BaselineError $baselineError): int
 
     private function countInvalidPhpdocs(BaselineError $baselineError): int
     {
-        return str_contains($baselineError->message, 'PHPDoc tag ')
+        return $baselineError->isInvalidPhpDocError()
             ? $baselineError->count
             : 0;
     }
 
     private function countUnknownTypes(BaselineError $baselineError): int
     {
-        $notFoundCount = preg_match('/Instantiated class .+ not found/', $baselineError->message, $matches) === 1
-            ? $baselineError->count
-            : 0;
-
-        $unknownCount = str_contains($baselineError->message, 'on an unknown class') || str_contains($baselineError->message, 'has invalid type unknown') || str_contains($baselineError->message, 'unknown_type as its type')
+        return $baselineError->isUnknownTypeError()
             ? $baselineError->count
             : 0;
-
-        return $notFoundCount + $unknownCount;
     }
 
     private function countAnonymousVariables(BaselineError $baselineError): int
     {
-        return str_contains($baselineError->message, 'Anonymous variable')
+        return $baselineError->isAnonymousVariableError()
             ? $baselineError->count
             : 0;
     }
 
     private function countUnusedSymbols(BaselineError $baselineError): int
     {
-        return str_ends_with($baselineError->message, 'is never used$#')
+        return $baselineError->isUnusedSymbolError()
             ? $baselineError->count
             : 0;
     }

lib/BaselineError.php

@@ -2,28 +2,62 @@
 
 namespace staabm\PHPStanBaselineAnalysis;
 
+use function Safe\preg_match;
+
+/**
+ * @immutable
+ */
 final class BaselineError
 {
-    /**
-     * @var int
-     */
-    public $count;
+    public int $count;
 
-    /**
-     * @var string
-     */
-    public $message;
+    private string $message;
+
+    public function __construct(int $count, string $message)
+    {
+        $this->count = $count;
+        $this->message = $message;
+    }
 
     /**
      * Returns the baseline error message, without regex delimiters.
      * Note: the message may still contain escaped regex meta characters.
-     *
-     * @return string
      */
     public function unwrapMessage(): string {
         $msg = $this->message;
         $msg = str_replace(['\\-', '\\.', '%%'], ['-', '.', '%'], $msg);
         $msg = trim($msg, '#^$');
         return $msg;
     }
+
+    public function isDeprecationError(): bool
+    {
+        return str_contains($this->message, ' deprecated class ')
+            || str_contains($this->message, ' deprecated method ')
+            || str_contains($this->message, ' deprecated function ')
+            || str_contains($this->message, ' deprecated property ');
+    }
+
+    public function isInvalidPhpDocError(): bool
+    {
+        return str_contains($this->message, 'PHPDoc tag ');
+    }
+
+    public function isUnknownTypeError(): bool
+    {
+        return preg_match('/Instantiated class .+ not found/', $this->message, $matches) === 1
+            || str_contains($this->message, 'on an unknown class')
+            || str_contains($this->message, 'has invalid type unknown')
+            || str_contains($this->message, 'unknown_type as its type');
+    }
+
+    public function isAnonymousVariableError(): bool
+    {
+        return str_contains($this->message, 'Anonymous variable');
+    }
+
+    public function isUnusedSymbolError(): bool
+    {
+        return str_ends_with($this->message, 'is never used$#');
+    }
 }