Add type declarations

Author: sebastianbergmann

src/CLI/Arguments.php

@@ -14,67 +14,37 @@ final class Arguments
     /**
      * @psalm-var list<string>
      */
-    private $directories;
+    private array $directories;
 
     /**
      * @psalm-var list<string>
      */
-    private $suffixes;
+    private array $suffixes;
 
     /**
      * @psalm-var list<string>
      */
-    private $exclude;
+    private array $exclude;
 
-    /**
-     * @var ?string
-     */
-    private $pmdCpdXmlLogfile;
+    private ?string $pmdCpdXmlLogfile;
 
-    /**
-     * @var int
-     */
-    private $linesThreshold;
+    private int $linesThreshold;
 
-    /**
-     * @var int
-     */
-    private $tokensThreshold;
+    private int $tokensThreshold;
 
-    /**
-     * @var bool
-     */
-    private $fuzzy;
+    private bool $fuzzy;
 
-    /**
-     * @var bool
-     */
-    private $verbose;
+    private bool $verbose;
 
-    /**
-     * @var bool
-     */
-    private $help;
+    private bool $help;
 
-    /**
-     * @var bool
-     */
-    private $version;
+    private bool $version;
 
-    /**
-     * @var ?string
-     */
-    private $algorithm;
+    private ?string $algorithm;
 
-    /**
-     * @var int
-     */
-    private $editDistance;
+    private int $editDistance;
 
-    /**
-     * @var int
-     */
-    private $headEquality;
+    private int $headEquality;
 
     public function __construct(array $directories, array $suffixes, array $exclude, ?string $pmdCpdXmlLogfile, int $linesThreshold, int $tokensThreshold, bool $fuzzy, bool $verbose, bool $help, bool $version, ?string $algorithm, int $editDistance, int $headEquality)
     {

src/CodeClone.php

@@ -18,30 +18,18 @@
 
 final class CodeClone
 {
-    /**
-     * @var int
-     */
-    private $numberOfLines;
+    private int $numberOfLines;
 
-    /**
-     * @var int
-     */
-    private $numberOfTokens;
+    private int $numberOfTokens;
 
     /**
-     * @var CodeCloneFile[]
+     * @psalm-var array<string,CodeCloneFile>
      */
-    private $files = [];
+    private array $files = [];
 
-    /**
-     * @var string
-     */
-    private $id;
+    private string $id;
 
-    /**
-     * @var string
-     */
-    private $lines = '';
+    private string $lines = '';
 
     public function __construct(CodeCloneFile $fileA, CodeCloneFile $fileB, int $numberOfLines, int $numberOfTokens)
     {
@@ -63,22 +51,22 @@ public function add(CodeCloneFile $file): void
     }
 
     /**
-     * @return CodeCloneFile[]
+     * @psalm-return array<string,CodeCloneFile>
      */
     public function files(): array
     {
         return $this->files;
     }
 
-    public function lines($indent = ''): string
+    public function lines(string $indent = ''): string
     {
         if (empty($this->lines)) {
             $file = current($this->files);
 
             $this->lines = implode(
                 '',
                 array_map(
-                    static function ($line) use ($indent) {
+                    static function (string $line) use ($indent) {
                         return $indent . $line;
                     },
                     array_slice(

src/CodeCloneFile.php

@@ -11,20 +11,11 @@
 
 final class CodeCloneFile
 {
-    /**
-     * @var string
-     */
-    private $id;
+    private string $id;
 
-    /**
-     * @var string
-     */
-    private $name;
+    private string $name;
 
-    /**
-     * @var int
-     */
-    private $startLine;
+    private int $startLine;
 
     public function __construct(string $name, int $startLine)
     {

src/CodeCloneMap.php

@@ -20,32 +20,20 @@ final class CodeCloneMap implements Countable, IteratorAggregate
     /**
      * @var CodeClone[]
      */
-    private $clones = [];
+    private array $clones = [];
 
     /**
      * @var CodeClone[]
      */
-    private $clonesById = [];
+    private array $clonesById = [];
 
-    /**
-     * @var int
-     */
-    private $numberOfDuplicatedLines = 0;
+    private int $numberOfDuplicatedLines = 0;
 
-    /**
-     * @var int
-     */
-    private $numberOfLines = 0;
+    private int $numberOfLines = 0;
 
-    /**
-     * @var int
-     */
-    private $largestCloneSize = 0;
+    private int $largestCloneSize = 0;
 
-    /**
-     * @var array
-     */
-    private $filesWithClones = [];
+    private array $filesWithClones = [];
 
     public function add(CodeClone $clone): void
     {

src/CodeCloneMapIterator.php

@@ -19,12 +19,9 @@ final class CodeCloneMapIterator implements Iterator
     /**
      * @var CodeClone[]
      */
-    private $clones = [];
+    private array $clones;
 
-    /**
-     * @var int
-     */
-    private $position = 0;
+    private int $position = 0;
 
     public function __construct(CodeCloneMap $clones)
     {

src/Detector/Detector.php

@@ -14,10 +14,7 @@
 
 final class Detector
 {
-    /**
-     * @var AbstractStrategy
-     */
-    private $strategy;
+    private AbstractStrategy $strategy;
 
     public function __construct(AbstractStrategy $strategy)
     {

src/Detector/Strategy/AbstractStrategy.php

@@ -25,7 +25,7 @@ abstract class AbstractStrategy
     /**
      * @psalm-var array<int,true>
      */
-    protected $tokensIgnoreList = [
+    protected array $tokensIgnoreList = [
         T_INLINE_HTML        => true,
         T_COMMENT            => true,
         T_DOC_COMMENT        => true,
@@ -37,7 +37,7 @@ abstract class AbstractStrategy
         T_NS_SEPARATOR       => true,
     ];
 
-    protected $config;
+    protected StrategyConfiguration $config;
 
     public function __construct(StrategyConfiguration $config)
     {

src/Detector/Strategy/DefaultStrategy.php

@@ -42,7 +42,7 @@ final class DefaultStrategy extends AbstractStrategy
     /**
      * @psalm-var array<string,array{0: string, 1: int}>
      */
-    protected $hashes = [];
+    private array $hashes = [];
 
     public function processFile(string $file, CodeCloneMap $result): void
     {

src/Detector/Strategy/StrategyConfiguration.php

@@ -17,43 +17,15 @@
  */
 final class StrategyConfiguration
 {
-    /**
-     * Minimum lines to consider.
-     *
-     * @var int
-     */
-    private $minLines = 5;
+    private int $minLines = 5;
 
-    /**
-     * Minimum tokens to consider in a clone.
-     *
-     * @var int
-     */
-    private $minTokens = 70;
+    private int $minTokens = 70;
 
-    /**
-     * Edit distance to consider when comparing two clones
-     * Only available for the suffix-tree algorithm.
-     *
-     * @var int
-     */
-    private $editDistance = 5;
+    private int $editDistance = 5;
 
-    /**
-     * Tokens that must be equal to consider a clone
-     * Only available for the suffix-tree algorithm.
-     *
-     * @var int
-     */
-    private $headEquality = 10;
+    private int $headEquality = 10;
 
-    /**
-     * Fuzz variable names
-     * suffixtree always makes variables and functions fuzzy.
-     *
-     * @var bool
-     */
-    private $fuzzy = false;
+    private bool $fuzzy;
 
     public function __construct(Arguments $arguments)
     {

src/Detector/Strategy/SuffixTreeStrategy.php

@@ -28,14 +28,11 @@
 final class SuffixTreeStrategy extends AbstractStrategy
 {
     /**
-     * @var AbstractToken[]
+     * @psalm-var list<AbstractToken>
      */
-    private $word = [];
+    private array $word = [];
 
-    /**
-     * @var ?CodeCloneMap
-     */
-    private $result;
+    private ?CodeCloneMap $result = null;
 
     public function processFile(string $file, CodeCloneMap $result): void
     {

src/Log/AbstractXmlLogger.php

@@ -21,15 +21,9 @@
 
 abstract class AbstractXmlLogger
 {
-    /**
-     * @var DOMDocument
-     */
-    protected $document;
+    protected DOMDocument $document;
 
-    /**
-     * @var string
-     */
-    private $filename;
+    private string $filename;
 
     public function __construct(string $filename)
     {
@@ -39,7 +33,7 @@ public function __construct(string $filename)
         $this->filename = $filename;
     }
 
-    abstract public function processClones(CodeCloneMap $clones);
+    abstract public function processClones(CodeCloneMap $clones): void;
 
     protected function flush(): void
     {

tests/unit/PMDTest.php

@@ -32,20 +32,15 @@
  */
 final class PMDTest extends TestCase
 {
-    /** @var string */
-    private $testFile1;
+    private string $testFile1;
 
-    /** @var @var string */
-    private $testFile2;
+    private string $testFile2;
 
-    /** @var string */
-    private $pmdLogFile;
+    private string|false $pmdLogFile;
 
-    /** @var string */
-    private $expectedPmdLogFile;
+    private string|false $expectedPmdLogFile;
 
-    /** @var \SebastianBergmann\PHPCPD\Log\PMD */
-    private $pmdLogger;
+    private PMD $pmdLogger;
 
     protected function setUp(): void
     {