getGuesses is documented to return an int, which requires updating getRawGuesses and a few tests

Xon · Xon · commit 00e1b26a868c · 2021-12-04T12:43:13.000+08:00
diff --git a/src/Matchers/BaseMatch.php b/src/Matchers/BaseMatch.php
@@ -139,9 +139,9 @@ public static function binom(int $n, int $k): int
         return $res;
     }
 
-    abstract protected function getRawGuesses(): float;
+    abstract protected function getRawGuesses(): int;
 
-    public function getGuesses(): float
+    public function getGuesses(): int
     {
         return max($this->getRawGuesses(), $this->getMinimumGuesses());
     }
diff --git a/src/Matchers/Bruteforce.php b/src/Matchers/Bruteforce.php
@@ -39,11 +39,12 @@ public function getFeedback(bool $isSoleMatch): array
         ];
     }
 
-    public function getRawGuesses(): float
+    public function getRawGuesses(): int
     {
         $guesses = pow(self::BRUTEFORCE_CARDINALITY, mb_strlen($this->token));
         if ($guesses === INF) {
-            return defined('PHP_FLOAT_MAX') ? PHP_FLOAT_MAX : 1e308;
+            // use 32bit max int if for some reason PHP_INT_MAX isn't defined
+            return defined('PHP_INT_MAX') ? PHP_INT_MAX : 2147483647;
         }
 
         // small detail: make bruteforce matches at minimum one guess bigger than smallest allowed
@@ -54,6 +55,6 @@ public function getRawGuesses(): float
             $minGuesses = Scorer::MIN_SUBMATCH_GUESSES_MULTI_CHAR + 1;
         }
 
-        return max($guesses, $minGuesses);
+        return (int)max($guesses, $minGuesses);
     }
 }
diff --git a/src/Matchers/DateMatch.php b/src/Matchers/DateMatch.php
@@ -408,7 +408,7 @@ protected static function removeRedundantMatches(array $matches): array
         });
     }
 
-    protected function getRawGuesses(): float
+    protected function getRawGuesses(): int
     {
         // base guesses: (year distance from REFERENCE_YEAR) * num_days * num_years
         $yearSpace = max(abs($this->year - static::getReferenceYear()), static::MIN_YEAR_SPACE);
diff --git a/src/Matchers/DictionaryMatch.php b/src/Matchers/DictionaryMatch.php
@@ -191,10 +191,7 @@ protected static function getRankedDictionaries(): array
         return self::$rankedDictionaries;
     }
 
-    /**
-     * @return integer
-     */
-    protected function getRawGuesses(): float
+    protected function getRawGuesses(): int
     {
         $guesses = $this->rank;
         $guesses *= $this->getUppercaseVariations();
diff --git a/src/Matchers/L33tMatch.php b/src/Matchers/L33tMatch.php
@@ -202,7 +202,7 @@ protected static function substitutionTableHelper(array $table, array $keys, arr
         return self::substitutionTableHelper($table, $otherKeys, $nextSubs);
     }
 
-    protected function getRawGuesses(): float
+    protected function getRawGuesses(): int
     {
         return parent::getRawGuesses() * $this->getL33tVariations();
     }
diff --git a/src/Matchers/MatchInterface.php b/src/Matchers/MatchInterface.php
@@ -16,13 +16,7 @@ interface MatchInterface
      */
     public static function match(string $password, array $userInputs = []): array;
 
-    /**
-     * @return integer
-     */
-    public function getGuesses(): float;
+    public function getGuesses(): int;
 
-    /**
-     * @return float
-     */
     public function getGuessesLog10(): float;
 }
diff --git a/src/Matchers/RepeatMatch.php b/src/Matchers/RepeatMatch.php
@@ -114,7 +114,7 @@ public function __construct(string $password, int $begin, int $end, string $toke
         }
     }
 
-    protected function getRawGuesses(): float
+    protected function getRawGuesses(): int
     {
         return $this->baseGuesses * $this->repeatCount;
     }
diff --git a/src/Matchers/ReverseDictionaryMatch.php b/src/Matchers/ReverseDictionaryMatch.php
@@ -34,7 +34,7 @@ public static function match(string $password, array $userInputs = [], array $ra
         return $matches;
     }
 
-    protected function getRawGuesses(): float
+    protected function getRawGuesses(): int
     {
         return parent::getRawGuesses() * 2;
     }
diff --git a/src/Matchers/SequenceMatch.php b/src/Matchers/SequenceMatch.php
@@ -110,7 +110,7 @@ public function __construct(string $password, int $begin, int $end, string $toke
         }
     }
 
-    protected function getRawGuesses(): float
+    protected function getRawGuesses(): int
     {
         $firstCharacter = mb_substr($this->token, 0, 1);
         $guesses = 0;
diff --git a/src/Matchers/SpatialMatch.php b/src/Matchers/SpatialMatch.php
@@ -214,7 +214,7 @@ public static function getAdjacencyGraphs(): array
         return self::$adjacencyGraphs;
     }
 
-    protected function getRawGuesses(): float
+    protected function getRawGuesses(): int
     {
         if ($this->graph === 'qwerty' || $this->graph === 'dvorak') {
             $startingPosition = self::KEYBOARD_STARTING_POSITION;
diff --git a/src/Matchers/YearMatch.php b/src/Matchers/YearMatch.php
@@ -41,7 +41,7 @@ public function getFeedback(bool $isSoleMatch): array
         ];
     }
 
-    protected function getRawGuesses(): float
+    protected function getRawGuesses(): int
     {
         $yearSpace = abs((int)$this->token - DateMatch::getReferenceYear());
         return max($yearSpace, DateMatch::MIN_YEAR_SPACE);
diff --git a/test/Matchers/MockMatch.php b/test/Matchers/MockMatch.php
@@ -26,10 +26,7 @@ public function getFeedback(bool $isSoleMatch): array
         return [];
     }
 
-    /**
-     * @return integer
-     */
-    public function getRawGuesses(): float
+    public function getRawGuesses(): int
     {
         return $this->guesses;
     }
diff --git a/test/Matchers/SpatialTest.php b/test/Matchers/SpatialTest.php
@@ -126,7 +126,7 @@ public function testShiftedCountForMultipleMatches()
         );
     }
 
-    protected function getBaseGuessCount($token)
+    protected function getBaseGuessCount($token): int
     {
         // KEYBOARD_STARTING_POSITIONS * KEYBOARD_AVERAGE_DEGREE * (length - 1)
         // - 1 term because: not counting spatial patterns of length 1
@@ -187,12 +187,12 @@ public function testGuessesEverythingShifted()
     public function complexGuessProvider()
     {
         return [
-            ['6yhgf',        2, 19596.255319547865],
-            ['asde3w',       3, 203315.1579961936],
-            ['zxcft6yh',     3, 558460.6174911747],
-            ['xcvgy7uj',     3, 558460.6174911747],
-            ['ertghjm,.',    5, 30160744.32861352],
-            ['qwerfdsazxcv', 5, 175281377.64553562],
+            ['6yhgf',        2, 19596],
+            ['asde3w',       3, 203315],
+            ['zxcft6yh',     3, 558460],
+            ['xcvgy7uj',     3, 558460],
+            ['ertghjm,.',    5, 30160744],
+            ['qwerfdsazxcv', 5, 175281377],
         ];
     }
 

Original file line number	Diff line number	Diff line change
`@@ -139,9 +139,9 @@ public static function binom(int $n, int $k): int`
`139`	`139`	`return $res;`
`140`	`140`	`}`
`141`	`141`
`142`		`- abstract protected function getRawGuesses(): float;`
	`142`	`+ abstract protected function getRawGuesses(): int;`
`143`	`143`
`144`		`- public function getGuesses(): float`
	`144`	`+ public function getGuesses(): int`
`145`	`145`	`{`
`146`	`146`	`return max($this->getRawGuesses(), $this->getMinimumGuesses());`
`147`	`147`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,11 +39,12 @@ public function getFeedback(bool $isSoleMatch): array`
`39`	`39`	`];`
`40`	`40`	`}`
`41`	`41`
`42`		`- public function getRawGuesses(): float`
	`42`	`+ public function getRawGuesses(): int`
`43`	`43`	`{`
`44`	`44`	`$guesses = pow(self::BRUTEFORCE_CARDINALITY, mb_strlen($this->token));`
`45`	`45`	`if ($guesses === INF) {`
`46`		`- return defined('PHP_FLOAT_MAX') ? PHP_FLOAT_MAX : 1e308;`
	`46`	`+ // use 32bit max int if for some reason PHP_INT_MAX isn't defined`
	`47`	`+ return defined('PHP_INT_MAX') ? PHP_INT_MAX : 2147483647;`
`47`	`48`	`}`
`48`	`49`
`49`	`50`	`// small detail: make bruteforce matches at minimum one guess bigger than smallest allowed`
`@@ -54,6 +55,6 @@ public function getRawGuesses(): float`
`54`	`55`	`$minGuesses = Scorer::MIN_SUBMATCH_GUESSES_MULTI_CHAR + 1;`
`55`	`56`	`}`
`56`	`57`
`57`		`- return max($guesses, $minGuesses);`
	`58`	`+ return (int)max($guesses, $minGuesses);`
`58`	`59`	`}`
`59`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -408,7 +408,7 @@ protected static function removeRedundantMatches(array $matches): array`
`408`	`408`	`});`
`409`	`409`	`}`
`410`	`410`
`411`		`- protected function getRawGuesses(): float`
	`411`	`+ protected function getRawGuesses(): int`
`412`	`412`	`{`
`413`	`413`	`// base guesses: (year distance from REFERENCE_YEAR) * num_days * num_years`
`414`	`414`	`$yearSpace = max(abs($this->year - static::getReferenceYear()), static::MIN_YEAR_SPACE);`
Original file line number	Diff line number	Diff line change
`@@ -191,10 +191,7 @@ protected static function getRankedDictionaries(): array`
`191`	`191`	`return self::$rankedDictionaries;`
`192`	`192`	`}`
`193`	`193`
`194`		`- /**`
`195`		`- * @return integer`
`196`		`- */`
`197`		`- protected function getRawGuesses(): float`
	`194`	`+ protected function getRawGuesses(): int`
`198`	`195`	`{`
`199`	`196`	`$guesses = $this->rank;`
`200`	`197`	`$guesses *= $this->getUppercaseVariations();`
Original file line number	Diff line number	Diff line change
`@@ -202,7 +202,7 @@ protected static function substitutionTableHelper(array $table, array $keys, arr`
`202`	`202`	`return self::substitutionTableHelper($table, $otherKeys, $nextSubs);`
`203`	`203`	`}`
`204`	`204`
`205`		`- protected function getRawGuesses(): float`
	`205`	`+ protected function getRawGuesses(): int`
`206`	`206`	`{`
`207`	`207`	`return parent::getRawGuesses() * $this->getL33tVariations();`
`208`	`208`	`}`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ public function __construct(string $password, int $begin, int $end, string $toke`
`114`	`114`	`}`
`115`	`115`	`}`
`116`	`116`
`117`		`- protected function getRawGuesses(): float`
	`117`	`+ protected function getRawGuesses(): int`
`118`	`118`	`{`
`119`	`119`	`return $this->baseGuesses * $this->repeatCount;`
`120`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public static function match(string $password, array $userInputs = [], array $ra`
`34`	`34`	`return $matches;`
`35`	`35`	`}`
`36`	`36`
`37`		`- protected function getRawGuesses(): float`
	`37`	`+ protected function getRawGuesses(): int`
`38`	`38`	`{`
`39`	`39`	`return parent::getRawGuesses() * 2;`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ public function __construct(string $password, int $begin, int $end, string $toke`
`110`	`110`	`}`
`111`	`111`	`}`
`112`	`112`
`113`		`- protected function getRawGuesses(): float`
	`113`	`+ protected function getRawGuesses(): int`
`114`	`114`	`{`
`115`	`115`	`$firstCharacter = mb_substr($this->token, 0, 1);`
`116`	`116`	`$guesses = 0;`
Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ public static function getAdjacencyGraphs(): array`
`214`	`214`	`return self::$adjacencyGraphs;`
`215`	`215`	`}`
`216`	`216`
`217`		`- protected function getRawGuesses(): float`
	`217`	`+ protected function getRawGuesses(): int`
`218`	`218`	`{`
`219`	`219`	`if ($this->graph === 'qwerty' \|\| $this->graph === 'dvorak') {`
`220`	`220`	`$startingPosition = self::KEYBOARD_STARTING_POSITION;`