Add PHPStan, fix phpstan errors

mkopinsky · mkopinsky · commit 69bb0d11f657 · 2024-11-19T19:43:23.000-05:00
diff --git a/composer.json b/composer.json
@@ -19,7 +19,8 @@
     "require-dev": {
         "phpunit/phpunit": "^8.5",
         "php-coveralls/php-coveralls": "*",
-        "squizlabs/php_codesniffer": "3.*"
+        "squizlabs/php_codesniffer": "3.*",
+        "phpstan/phpstan": "^2.0"
     },
     "suggest": {
         "ext-gmp": "Required for optimized binomial calculations (also requires PHP >= 7.3)"
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,5 @@
+parameters:
+	level: 0
+	paths:
+		- src
+		- test
diff --git a/src/Matchers/BaseMatch.php b/src/Matchers/BaseMatch.php
@@ -4,7 +4,6 @@
 
 namespace ZxcvbnPhp\Matchers;
 
-use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Math\Binomial;
 use ZxcvbnPhp\Scorer;
 
@@ -48,10 +47,8 @@ public function __construct(string $password, int $begin, int $end, string $toke
      *
      * @param  bool $isSoleMatch
      *   Whether this is the only match in the password
-     * @return array
-     *   Associative array with warning (string) and suggestions (array of strings)
+     * @return array{'warning': string, "suggestions": string[]}
      */
-    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
     abstract public function getFeedback(bool $isSoleMatch): array;
 
     /**
diff --git a/src/Matchers/Bruteforce.php b/src/Matchers/Bruteforce.php
@@ -4,7 +4,6 @@
 
 namespace ZxcvbnPhp\Matchers;
 
-use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Scorer;
 
 /**
@@ -13,7 +12,7 @@
  *
  * Intentionally not named with Match suffix to prevent autoloading from Matcher.
  */
-class Bruteforce extends BaseMatch
+final class Bruteforce extends BaseMatch
 {
     public const BRUTEFORCE_CARDINALITY = 10;
 
@@ -32,7 +31,9 @@ public static function match(string $password, array $userInputs = []): array
     }
 
 
-    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
+    /**
+     * @return array{'warning': string, "suggestions": string[]}
+     */
     public function getFeedback(bool $isSoleMatch): array
     {
         return [
diff --git a/src/Matchers/DateMatch.php b/src/Matchers/DateMatch.php
@@ -4,10 +4,9 @@
 
 namespace ZxcvbnPhp\Matchers;
 
-use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matcher;
 
-class DateMatch extends BaseMatch
+final class DateMatch extends BaseMatch
 {
     public const NUM_YEARS = 119; // Years match against 1900 - 2019
     public const NUM_MONTHS = 12;
@@ -108,7 +107,9 @@ public static function match(string $password, array $userInputs = []): array
         return $matches;
     }
 
-    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
+    /**
+     * @return array{'warning': string, "suggestions": string[]}
+     */
     public function getFeedback(bool $isSoleMatch): array
     {
         return [
diff --git a/src/Matchers/DictionaryMatch.php b/src/Matchers/DictionaryMatch.php
@@ -4,7 +4,6 @@
 
 namespace ZxcvbnPhp\Matchers;
 
-use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matcher;
 use ZxcvbnPhp\Math\Binomial;
 
@@ -63,7 +62,7 @@ public static function match(string $password, array $userInputs = [], array $ra
             $results = static::dictionaryMatch($password, $dict);
             foreach ($results as $result) {
                 $result['dictionary_name'] = $name;
-                $matches[] = new static($password, $result['begin'], $result['end'], $result['token'], $result);
+                $matches[] = new DictionaryMatch($password, $result['begin'], $result['end'], $result['token'], $result);
             }
         }
         Matcher::usortStable($matches, [Matcher::class, 'compareMatches']);
@@ -88,10 +87,8 @@ public function __construct(string $password, int $begin, int $end, string $toke
     }
 
     /**
-     * @param bool $isSoleMatch
-     * @return array
+     * @return array{'warning': string, "suggestions": string[]}
      */
-    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
     public function getFeedback(bool $isSoleMatch): array
     {
         $startUpper = '/^[A-Z][^A-Z]+$/u';
diff --git a/src/Matchers/L33tMatch.php b/src/Matchers/L33tMatch.php
@@ -4,7 +4,6 @@
 
 namespace ZxcvbnPhp\Matchers;
 
-use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matcher;
 use ZxcvbnPhp\Math\Binomial;
 
@@ -98,7 +97,9 @@ public function __construct(string $password, int $begin, int $end, string $toke
         }
     }
 
-    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
+    /**
+     * @return array{'warning': string, "suggestions": string[]}
+     */
     public function getFeedback(bool $isSoleMatch): array
     {
         $feedback = parent::getFeedback($isSoleMatch);
diff --git a/src/Matchers/RepeatMatch.php b/src/Matchers/RepeatMatch.php
@@ -4,11 +4,10 @@
 
 namespace ZxcvbnPhp\Matchers;
 
-use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matcher;
 use ZxcvbnPhp\Scorer;
 
-class RepeatMatch extends BaseMatch
+final class RepeatMatch extends BaseMatch
 {
     public const GREEDY_MATCH = '/(.+)\1+/u';
     public const LAZY_MATCH = '/(.+?)\1+/u';
@@ -85,7 +84,9 @@ public static function match(string $password, array $userInputs = []): array
         return $matches;
     }
 
-    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
+    /**
+     * @return array{'warning': string, "suggestions": string[]}
+     */
     public function getFeedback(bool $isSoleMatch): array
     {
         $warning = mb_strlen($this->repeatedChar) == 1
diff --git a/src/Matchers/ReverseDictionaryMatch.php b/src/Matchers/ReverseDictionaryMatch.php
@@ -4,7 +4,6 @@
 
 namespace ZxcvbnPhp\Matchers;
 
-use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matcher;
 
 class ReverseDictionaryMatch extends DictionaryMatch
@@ -42,7 +41,9 @@ protected function getRawGuesses(): float
         return parent::getRawGuesses() * 2;
     }
 
-    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
+    /**
+     * @return array{'warning': string, "suggestions": string[]}
+     */
     public function getFeedback(bool $isSoleMatch): array
     {
         $feedback = parent::getFeedback($isSoleMatch);
diff --git a/src/Matchers/SequenceMatch.php b/src/Matchers/SequenceMatch.php
@@ -4,9 +4,7 @@
 
 namespace ZxcvbnPhp\Matchers;
 
-use JetBrains\PhpStorm\ArrayShape;
-
-class SequenceMatch extends BaseMatch
+final class SequenceMatch extends BaseMatch
 {
     public const MAX_DELTA = 5;
 
@@ -87,7 +85,9 @@ public static function findSequenceMatch(string $password, int $begin, int $end,
         }
     }
 
-    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
+    /**
+     * @return array{'warning': string, "suggestions": string[]}
+     */
     public function getFeedback(bool $isSoleMatch): array
     {
         return [
diff --git a/src/Matchers/SpatialMatch.php b/src/Matchers/SpatialMatch.php
@@ -4,11 +4,10 @@
 
 namespace ZxcvbnPhp\Matchers;
 
-use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matcher;
 use ZxcvbnPhp\Math\Binomial;
 
-class SpatialMatch extends BaseMatch
+final class SpatialMatch extends BaseMatch
 {
     public const SHIFTED_CHARACTERS = '~!@#$%^&*()_+QWERTYUIOP{}|ASDFGHJKL:"ZXCVBNM<>?';
 
@@ -58,7 +57,9 @@ public static function match(string $password, array $userInputs = [], array $gr
         return $matches;
     }
 
-    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
+    /**
+     * @return array{'warning': string, "suggestions": string[]}
+     */
     public function getFeedback(bool $isSoleMatch): array
     {
         $warning = $this->turns == 1
@@ -93,7 +94,7 @@ public function __construct(string $password, int $begin, int $end, string $toke
     /**
      * Match spatial patterns in a adjacency graph.
      * @param string $password
-     * @param array  $graph
+     * @param array $graph
      * @param string $graphName
      * @return array
      */
diff --git a/src/Matchers/YearMatch.php b/src/Matchers/YearMatch.php
@@ -4,10 +4,9 @@
 
 namespace ZxcvbnPhp\Matchers;
 
-use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matcher;
 
-class YearMatch extends BaseMatch
+final class YearMatch extends BaseMatch
 {
     public const NUM_YEARS = 119;
 
@@ -32,7 +31,10 @@ public static function match(string $password, array $userInputs = []): array
         return $matches;
     }
 
-    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
+
+    /**
+     * @return array{'warning': string, "suggestions": string[]}
+     */
     public function getFeedback(bool $isSoleMatch): array
     {
         return [
diff --git a/test/Matchers/MockMatch.php b/test/Matchers/MockMatch.php
@@ -4,7 +4,6 @@
 
 namespace ZxcvbnPhp\Test\Matchers;
 
-use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matchers\BaseMatch;
 
 class MockMatch extends BaseMatch
@@ -22,10 +21,8 @@ public function __construct(int $begin, int $end, float $guesses)
      * Get feedback to a user based on the match.
      * @param  bool $isSoleMatch
      *   Whether this is the only match in the password
-     * @return array
-     *   Associative array with warning (string) and suggestions (array of strings)
+     * @return array{'warning': string, "suggestions": string[]}
      */
-    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
     public function getFeedback(bool $isSoleMatch): array
     {
         return [

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +parameters:
 +	level: 0
 +	paths:
 +		- src
 +		- test
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`
`5`	`5`	`namespace ZxcvbnPhp\Matchers;`
`6`	`6`
`7`		`-use JetBrains\PhpStorm\ArrayShape;`
`8`	`7`	`use ZxcvbnPhp\Scorer;`
`9`	`8`
`10`	`9`	`/**`
`@@ -13,7 +12,7 @@`
`13`	`12`	`*`
`14`	`13`	`* Intentionally not named with Match suffix to prevent autoloading from Matcher.`
`15`	`14`	`*/`
`16`		`-class Bruteforce extends BaseMatch`
	`15`	`+final class Bruteforce extends BaseMatch`
`17`	`16`	`{`
`18`	`17`	`public const BRUTEFORCE_CARDINALITY = 10;`
`19`	`18`
`@@ -32,7 +31,9 @@ public static function match(string $password, array $userInputs = []): array`
`32`	`31`	`}`
`33`	`32`
`34`	`33`
`35`		`- #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]`
	`34`	`+ /**`
	`35`	`+ * @return array{'warning': string, "suggestions": string[]}`
	`36`	`+ */`
`36`	`37`	`public function getFeedback(bool $isSoleMatch): array`
`37`	`38`	`{`
`38`	`39`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,9 @@`
`4`	`4`
`5`	`5`	`namespace ZxcvbnPhp\Matchers;`
`6`	`6`
`7`		`-use JetBrains\PhpStorm\ArrayShape;`
`8`	`7`	`use ZxcvbnPhp\Matcher;`
`9`	`8`
`10`		`-class DateMatch extends BaseMatch`
	`9`	`+final class DateMatch extends BaseMatch`
`11`	`10`	`{`
`12`	`11`	`public const NUM_YEARS = 119; // Years match against 1900 - 2019`
`13`	`12`	`public const NUM_MONTHS = 12;`
`@@ -108,7 +107,9 @@ public static function match(string $password, array $userInputs = []): array`
`108`	`107`	`return $matches;`
`109`	`108`	`}`
`110`	`109`
`111`		`- #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]`
	`110`	`+ /**`
	`111`	`+ * @return array{'warning': string, "suggestions": string[]}`
	`112`	`+ */`
`112`	`113`	`public function getFeedback(bool $isSoleMatch): array`
`113`	`114`	`{`
`114`	`115`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -4,11 +4,10 @@`
`4`	`4`
`5`	`5`	`namespace ZxcvbnPhp\Matchers;`
`6`	`6`
`7`		`-use JetBrains\PhpStorm\ArrayShape;`
`8`	`7`	`use ZxcvbnPhp\Matcher;`
`9`	`8`	`use ZxcvbnPhp\Scorer;`
`10`	`9`
`11`		`-class RepeatMatch extends BaseMatch`
	`10`	`+final class RepeatMatch extends BaseMatch`
`12`	`11`	`{`
`13`	`12`	`public const GREEDY_MATCH = '/(.+)\1+/u';`
`14`	`13`	`public const LAZY_MATCH = '/(.+?)\1+/u';`
`@@ -85,7 +84,9 @@ public static function match(string $password, array $userInputs = []): array`
`85`	`84`	`return $matches;`
`86`	`85`	`}`
`87`	`86`
`88`		`- #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]`
	`87`	`+ /**`
	`88`	`+ * @return array{'warning': string, "suggestions": string[]}`
	`89`	`+ */`
`89`	`90`	`public function getFeedback(bool $isSoleMatch): array`
`90`	`91`	`{`
`91`	`92`	`$warning = mb_strlen($this->repeatedChar) == 1`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace ZxcvbnPhp\Matchers;`
`6`	`6`
`7`		`-use JetBrains\PhpStorm\ArrayShape;`
`8`		`-`
`9`		`-class SequenceMatch extends BaseMatch`
	`7`	`+final class SequenceMatch extends BaseMatch`
`10`	`8`	`{`
`11`	`9`	`public const MAX_DELTA = 5;`
`12`	`10`
`@@ -87,7 +85,9 @@ public static function findSequenceMatch(string $password, int $begin, int $end,`
`87`	`85`	`}`
`88`	`86`	`}`
`89`	`87`
`90`		`- #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]`
	`88`	`+ /**`
	`89`	`+ * @return array{'warning': string, "suggestions": string[]}`
	`90`	`+ */`
`91`	`91`	`public function getFeedback(bool $isSoleMatch): array`
`92`	`92`	`{`
`93`	`93`	`return [`