Merge pull request #50 from bjeavons/php8

PHP compatibility

Author: mkopinsky

.github/workflows/ci.yml

@@ -15,6 +15,7 @@ jobs:
           - '7.2'
           - '7.3'
           - '7.4'
+          - '8.0'
     name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
     steps:
     - name: Checkout

composer.json

@@ -12,7 +12,7 @@
         }
     ],
     "require": {
-        "php": "^7.2",
+        "php": "^7.2 | ^8.0",
         "symfony/polyfill-mbstring": ">=1.3.1"
     },
     "require-dev": {

src/Feedback.php

@@ -2,7 +2,7 @@
 
 namespace ZxcvbnPhp;
 
-use ZxcvbnPhp\Matchers\Match;
+use ZxcvbnPhp\Matchers\MatchInterface;
 
 /**
  * Feedback - gives some user guidance based on the strength
@@ -14,27 +14,27 @@ class Feedback
 {
     /**
      * @param int $score
-     * @param Match[] $sequence
+     * @param MatchInterface[] $sequence
      * @return array
      */
     public function getFeedback($score, array $sequence)
     {
         // starting feedback
         if (count($sequence) === 0) {
             return [
-                'warning' => '',
+                'warning'     => '',
                 'suggestions' => [
                     "Use a few words, avoid common phrases",
-                    "No need for symbols, digits, or uppercase letters"
-                ]
+                    "No need for symbols, digits, or uppercase letters",
+                ],
             ];
         }
 
         // no feedback if score is good or great.
         if ($score > 2) {
             return [
-                'warning' => '',
-                'suggestions' => []
+                'warning'     => '',
+                'suggestions' => [],
             ];
         }
 

src/Matcher.php

@@ -2,7 +2,7 @@
 
 namespace ZxcvbnPhp;
 
-use ZxcvbnPhp\Matchers\Match;
+use ZxcvbnPhp\Matchers\BaseMatch;
 use ZxcvbnPhp\Matchers\MatchInterface;
 
 class Matcher
@@ -23,14 +23,14 @@ class Matcher
     /**
      * Get matches for a password.
      *
-     * @see zxcvbn/src/matching.coffee::omnimatch
-     *
-     * @param string $password   Password string to match
-     * @param array  $userInputs Array of values related to the user (optional)
+     * @param string $password  Password string to match
+     * @param array $userInputs Array of values related to the user (optional)
      * @code array('Alice Smith')
      * @endcode
      *
-     * @return Match[] Array of Match objects.
+     * @return MatchInterface[] Array of Match objects.
+     *
+     * @see  zxcvbn/src/matching.coffee::omnimatch
      */
     public function getMatches($password, array $userInputs = [])
     {
@@ -77,7 +77,7 @@ public static function usortStable(array &$array, callable $value_compare_func)
     {
         $index = 0;
         foreach ($array as &$item) {
-            $item = array($index++, $item);
+            $item = [$index++, $item];
         }
         $result = usort($array, function ($a, $b) use ($value_compare_func) {
             $result = $value_compare_func($a[1], $b[1]);
@@ -89,7 +89,7 @@ public static function usortStable(array &$array, callable $value_compare_func)
         return $result;
     }
 
-    public static function compareMatches(Match $a, Match $b)
+    public static function compareMatches(BaseMatch $a, BaseMatch $b)
     {
         $beginDiff = $a->begin - $b->begin;
         if ($beginDiff) {

src/Matchers/Match.php renamed to src/Matchers/BaseMatch.php

@@ -4,7 +4,7 @@
 
 use ZxcvbnPhp\Scorer;
 
-abstract class Match implements MatchInterface
+abstract class BaseMatch implements MatchInterface
 {
 
     /**

src/Matchers/Bruteforce.php

@@ -10,7 +10,7 @@
  *
  * Intentionally not named with Match suffix to prevent autoloading from Matcher.
  */
-class Bruteforce extends Match
+class Bruteforce extends BaseMatch
 {
 
     public const BRUTEFORCE_CARDINALITY = 10;

src/Matchers/DateMatch.php

@@ -4,7 +4,7 @@
 
 use ZxcvbnPhp\Matcher;
 
-class DateMatch extends Match
+class DateMatch extends BaseMatch
 {
     public const NUM_YEARS = 119; // Years match against 1900 - 2019
     public const NUM_MONTHS = 12;

src/Matchers/DictionaryMatch.php

@@ -4,7 +4,7 @@
 
 use ZxcvbnPhp\Matcher;
 
-class DictionaryMatch extends Match
+class DictionaryMatch extends BaseMatch
 {
 
     public $pattern = 'dictionary';

src/Matchers/RepeatMatch.php

@@ -5,15 +5,15 @@
 use ZxcvbnPhp\Matcher;
 use ZxcvbnPhp\Scorer;
 
-class RepeatMatch extends Match
+class RepeatMatch extends BaseMatch
 {
     public const GREEDY_MATCH = '/(.+)\1+/u';
     public const LAZY_MATCH = '/(.+?)\1+/u';
     public const ANCHORED_LAZY_MATCH = '/^(.+?)\1+$/u';
 
     public $pattern = 'repeat';
 
-    /** @var Match[] An array of matches for the repeated section itself. */
+    /** @var MatchInterface[] An array of matches for the repeated section itself. */
     public $baseMatches = [];
 
     /** @var int The number of guesses required for the repeated section itself. */
@@ -70,9 +70,9 @@ public static function match($password, array $userInputs = [])
                 $match[0]['token'],
                 [
                     'repeated_char' => $repeatedChar,
-                    'base_guesses' => $baseGuesses,
-                    'base_matches' => $baseMatches,
-                    'repeat_count' => $repeatCount
+                    'base_guesses'  => $baseGuesses,
+                    'base_matches'  => $baseMatches,
+                    'repeat_count'  => $repeatCount,
                 ]
             );
 
@@ -89,10 +89,10 @@ public function getFeedback($isSoleMatch)
             : 'Repeats like "abcabcabc" are only slightly harder to guess than "abc"';
 
         return [
-            'warning' => $warning,
+            'warning'     => $warning,
             'suggestions' => [
-                'Avoid repeated words and characters'
-            ]
+                'Avoid repeated words and characters',
+            ],
         ];
     }
 

src/Matchers/SequenceMatch.php

@@ -2,7 +2,7 @@
 
 namespace ZxcvbnPhp\Matchers;
 
-class SequenceMatch extends Match
+class SequenceMatch extends BaseMatch
 {
     public const MAX_DELTA = 5;