Use property type declarations

Author: sebastianbergmann

src/CodeCoverage.php

@@ -44,84 +44,44 @@ final class CodeCoverage
 {
     private const UNCOVERED_FILES = 'UNCOVERED_FILES';
 
-    /**
-     * @var Driver
-     */
-    private $driver;
+    private Driver $driver;
 
-    /**
-     * @var Filter
-     */
-    private $filter;
+    private Filter $filter;
 
     /**
      * @var Wizard
      */
     private $wizard;
 
-    /**
-     * @var bool
-     */
-    private $checkForUnintentionallyCoveredCode = false;
+    private bool $checkForUnintentionallyCoveredCode = false;
 
-    /**
-     * @var bool
-     */
-    private $includeUncoveredFiles = true;
+    private bool $includeUncoveredFiles = true;
 
-    /**
-     * @var bool
-     */
-    private $processUncoveredFiles = false;
+    private bool $processUncoveredFiles = false;
 
-    /**
-     * @var bool
-     */
-    private $ignoreDeprecatedCode = false;
+    private bool $ignoreDeprecatedCode = false;
 
     /**
      * @var PhptTestCase|string|TestCase
      */
     private $currentId;
 
-    /**
-     * Code coverage data.
-     *
-     * @var ProcessedCodeCoverageData
-     */
-    private $data;
+    private ProcessedCodeCoverageData $data;
 
-    /**
-     * @var bool
-     */
-    private $useAnnotationsForIgnoringCode = true;
+    private bool $useAnnotationsForIgnoringCode = true;
 
-    /**
-     * Test data.
-     *
-     * @var array
-     */
-    private $tests = [];
+    private array $tests = [];
 
     /**
      * @psalm-var list<class-string>
      */
-    private $parentClassesExcludedFromUnintentionallyCoveredCodeCheck = [];
+    private array $parentClassesExcludedFromUnintentionallyCoveredCodeCheck = [];
 
-    /**
-     * @var ?CoveredFileAnalyser
-     */
-    private $coveredFileAnalyser;
+    private ?CoveredFileAnalyser $coveredFileAnalyser = null;
 
-    /**
-     * @var ?UncoveredFileAnalyser
-     */
-    private $uncoveredFileAnalyser;
+    private ?UncoveredFileAnalyser $uncoveredFileAnalyser = null;
 
-    /**
-     * @var ?string
-     */
-    private $cacheDirectory;
+    private ?string $cacheDirectory = null;
 
     public function __construct(Driver $driver, Filter $filter)
     {
@@ -608,7 +568,11 @@ private function getAllowedLines(array $linesToBeCovered, array $linesToBeUsed):
     }
 
     /**
+     * @param list<string> $unintentionallyCoveredUnits
+     *
      * @throws ReflectionException
+     *
+     * @return list<string>
      */
     private function processUnintentionallyCoveredUnits(array $unintentionallyCoveredUnits): array
     {

src/CrapIndex.php

@@ -16,15 +16,9 @@
  */
 final class CrapIndex
 {
-    /**
-     * @var int
-     */
-    private $cyclomaticComplexity;
-
-    /**
-     * @var float
-     */
-    private $codeCoverage;
+    private int $cyclomaticComplexity;
+
+    private float $codeCoverage;
 
     public static function fromCyclomaticComplexityAndCoveragePercentage(int $cyclomaticComplexity, float $codeCoverage): self
     {

src/Driver/Driver.php

@@ -57,15 +57,9 @@ abstract class Driver
      */
     public const BRANCH_HIT = 1;
 
-    /**
-     * @var bool
-     */
-    private $collectBranchAndPathCoverage = false;
+    private bool $collectBranchAndPathCoverage = false;
 
-    /**
-     * @var bool
-     */
-    private $detectDeadCode = false;
+    private bool $detectDeadCode = false;
 
     /**
      * @throws NoCodeCoverageDriverAvailableException

src/Driver/PcovDriver.php

@@ -19,10 +19,7 @@
  */
 final class PcovDriver extends Driver
 {
-    /**
-     * @var Filter
-     */
-    private $filter;
+    private Filter $filter;
 
     /**
      * @throws PcovNotAvailableException

src/Driver/Xdebug2Driver.php

@@ -33,10 +33,7 @@
  */
 final class Xdebug2Driver extends Driver
 {
-    /**
-     * @var bool
-     */
-    private $pathCoverageIsMixedCoverage;
+    private bool $pathCoverageIsMixedCoverage;
 
     /**
      * @throws XdebugNotAvailableException

src/Exception/UnintentionallyCoveredCodeException.php

@@ -14,17 +14,23 @@
 final class UnintentionallyCoveredCodeException extends RuntimeException implements Exception
 {
     /**
-     * @var array
+     * @var list<string>
      */
-    private $unintentionallyCoveredUnits;
+    private array $unintentionallyCoveredUnits;
 
+    /**
+     * @param list<string> $unintentionallyCoveredUnits
+     */
     public function __construct(array $unintentionallyCoveredUnits)
     {
         $this->unintentionallyCoveredUnits = $unintentionallyCoveredUnits;
 
         parent::__construct($this->toString());
     }
 
+    /**
+     * @return list<string>
+     */
     public function getUnintentionallyCoveredUnits(): array
     {
         return $this->unintentionallyCoveredUnits;

src/Filter.php

@@ -20,12 +20,12 @@ final class Filter
     /**
      * @psalm-var array<string,true>
      */
-    private $files = [];
+    private array $files = [];
 
     /**
      * @psalm-var array<string,bool>
      */
-    private $isFileCache = [];
+    private array $isFileCache = [];
 
     public function includeDirectory(string $directory, string $suffix = '.php', string $prefix = ''): void
     {

src/Node/AbstractNode.php

@@ -22,30 +22,15 @@
  */
 abstract class AbstractNode implements Countable
 {
-    /**
-     * @var string
-     */
-    private $name;
-
-    /**
-     * @var string
-     */
-    private $pathAsString;
-
-    /**
-     * @var array
-     */
-    private $pathAsArray;
-
-    /**
-     * @var AbstractNode
-     */
-    private $parent;
-
-    /**
-     * @var string
-     */
-    private $id;
+    private string $name;
+
+    private string $pathAsString;
+
+    private array $pathAsArray;
+
+    private ?AbstractNode $parent;
+
+    private string $id;
 
     public function __construct(string $name, self $parent = null)
     {
@@ -55,6 +40,9 @@ public function __construct(string $name, self $parent = null)
 
         $this->name   = $name;
         $this->parent = $parent;
+
+        $this->processId();
+        $this->processPath();
     }
 
     public function name(): string
@@ -64,50 +52,16 @@ public function name(): string
 
     public function id(): string
     {
-        if ($this->id === null) {
-            $parent = $this->parent();
-
-            if ($parent === null) {
-                $this->id = 'index';
-            } else {
-                $parentId = $parent->id();
-
-                if ($parentId === 'index') {
-                    $this->id = str_replace(':', '_', $this->name);
-                } else {
-                    $this->id = $parentId . '/' . $this->name;
-                }
-            }
-        }
-
         return $this->id;
     }
 
     public function pathAsString(): string
     {
-        if ($this->pathAsString === null) {
-            if ($this->parent === null) {
-                $this->pathAsString = $this->name;
-            } else {
-                $this->pathAsString = $this->parent->pathAsString() . DIRECTORY_SEPARATOR . $this->name;
-            }
-        }
-
         return $this->pathAsString;
     }
 
     public function pathAsArray(): array
     {
-        if ($this->pathAsArray === null) {
-            if ($this->parent === null) {
-                $this->pathAsArray = [];
-            } else {
-                $this->pathAsArray = $this->parent->pathAsArray();
-            }
-
-            $this->pathAsArray[] = $this;
-        }
-
         return $this->pathAsArray;
     }
 
@@ -248,4 +202,36 @@ abstract public function numberOfTestedMethods(): int;
     abstract public function numberOfFunctions(): int;
 
     abstract public function numberOfTestedFunctions(): int;
+
+    private function processId(): void
+    {
+        if ($this->parent === null) {
+            $this->id = 'index';
+
+            return;
+        }
+
+        $parentId = $this->parent->id();
+
+        if ($parentId === 'index') {
+            $this->id = str_replace(':', '_', $this->name);
+        } else {
+            $this->id = $parentId . '/' . $this->name;
+        }
+    }
+
+    private function processPath(): void
+    {
+        if ($this->parent === null) {
+            $this->pathAsArray  = [$this];
+            $this->pathAsString = $this->name;
+
+            return;
+        }
+
+        $this->pathAsArray  = $this->parent->pathAsArray();
+        $this->pathAsString = $this->parent->pathAsString() . DIRECTORY_SEPARATOR . $this->name;
+
+        $this->pathAsArray[] = $this;
+    }
 }

src/Node/Builder.php

@@ -29,10 +29,7 @@
  */
 final class Builder
 {
-    /**
-     * @var CoveredFileAnalyser
-     */
-    private $coveredFileAnalyser;
+    private CoveredFileAnalyser $coveredFileAnalyser;
 
     public function __construct(CoveredFileAnalyser $coveredFileAnalyser)
     {