Merge pull request #381 from PHPCSStandards/tokens/collection-add-new…

…-shortarraylistopentokensbc Collections: add new `shortArrayListOpenTokensBC()` token array
PHPCSStandards · Oct 19, 2022 · e11d8f9 · e11d8f9
2 parents 18f5d8f + 8ee11f2
commit e11d8f9
Show file tree

Hide file tree

Showing 13 changed files with 46 additions and 25 deletions.
diff --git a/PHPCSUtils/Tokens/Collections.php b/PHPCSUtils/Tokens/Collections.php
@@ -45,6 +45,8 @@
  * @method static array objectOperators()             Object operator tokens.
  * @method static array phpOpenTags()                 Tokens which open PHP.
  * @method static array propertyModifierKeywords()    Modifier keywords which can be used for a property declaration.
+ * @method static array shortArrayListOpenTokensBC()  Tokens which can open a short array or short list
+ *                                                    (PHPCS cross-version compatible).
  * @method static array shortArrayTokens()            Tokens which are used for short arrays.
  * @method static array shortArrayTokensBC()          Tokens which are used for short arrays
  *                                                    (PHPCS cross-version compatible).
@@ -577,6 +579,22 @@ final class Collections
         \T_TYPE_INTERSECTION => \T_TYPE_INTERSECTION,
     ];
 
+    /**
+     * Tokens which can open a short array or short list (PHPCS cross-version compatible).
+     *
+     * Includes `T_OPEN_SQUARE_BRACKET` to allow for handling intermittent tokenizer issues related
+     * to the retokenization to `T_OPEN_SHORT_ARRAY`.
+     * Should only be used selectively.
+     *
+     * @since 1.0.0-alpha4 Use the {@see Collections::shortArrayListOpenTokensBC()} method for access.
+     *
+     * @return array <int|string> => <int|string>
+     */
+    private static $shortArrayListOpenTokensBC = [
+        \T_OPEN_SHORT_ARRAY    => \T_OPEN_SHORT_ARRAY,
+        \T_OPEN_SQUARE_BRACKET => \T_OPEN_SQUARE_BRACKET,
+    ];
+
     /**
      * DEPRECATED: Tokens which are used for short arrays.
      *

diff --git a/PHPCSUtils/Utils/Lists.php b/PHPCSUtils/Utils/Lists.php
@@ -232,7 +232,7 @@ public static function isShortList(File $phpcsFile, $stackPtr)
         $parentOpen = $opener;
         do {
             $parentOpen = $phpcsFile->findPrevious(
-                [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET], // BC: PHPCS#1971.
+                Collections::shortArrayListOpenTokensBC(), // BC: PHPCS#1971.
                 ($parentOpen - 1),
                 null,
                 false,

diff --git a/PHPCSUtils/Utils/Namespaces.php b/PHPCSUtils/Utils/Namespaces.php
@@ -64,11 +64,10 @@ public static function getType(File $phpcsFile, $stackPtr)
                 + Tokens::$castTokens
                 + Tokens::$blockOpeners
                 + Collections::incrementDecrementOperators()
-                + Collections::objectOperators();
+                + Collections::objectOperators()
+                + Collections::shortArrayListOpenTokensBC();
 
-            $findAfter[\T_OPEN_CURLY_BRACKET]  = \T_OPEN_CURLY_BRACKET;
-            $findAfter[\T_OPEN_SQUARE_BRACKET] = \T_OPEN_SQUARE_BRACKET;
-            $findAfter[\T_OPEN_SHORT_ARRAY]    = \T_OPEN_SHORT_ARRAY;
+            $findAfter[\T_OPEN_CURLY_BRACKET] = \T_OPEN_CURLY_BRACKET;
         }
 
         $tokens = $phpcsFile->getTokens();

diff --git a/PHPCSUtils/Utils/PassedParameters.php b/PHPCSUtils/Utils/PassedParameters.php
@@ -103,8 +103,7 @@ public static function hasParameters(File $phpcsFile, $stackPtr, $isShortArray =
             }
         }
 
-        if (($tokens[$stackPtr]['code'] === \T_OPEN_SHORT_ARRAY
-            || $tokens[$stackPtr]['code'] === \T_OPEN_SQUARE_BRACKET)
+        if (isset(Collections::shortArrayListOpenTokensBC()[$tokens[$stackPtr]['code']]) === true
             && $isShortArray !== true
             && Arrays::isShortArray($phpcsFile, $stackPtr) === false
         ) {
@@ -119,9 +118,7 @@ public static function hasParameters(File $phpcsFile, $stackPtr, $isShortArray =
         }
 
         // Deal with short array syntax.
-        if ($tokens[$stackPtr]['code'] === \T_OPEN_SHORT_ARRAY
-            || $tokens[$stackPtr]['code'] === \T_OPEN_SQUARE_BRACKET
-        ) {
+        if (isset(Collections::shortArrayListOpenTokensBC()[$tokens[$stackPtr]['code']]) === true) {
             if ($next === $tokens[$stackPtr]['bracket_closer']) {
                 // No parameters.
                 return false;
@@ -224,9 +221,7 @@ public static function getParameters(File $phpcsFile, $stackPtr, $limit = 0, $is
         $tokens = $phpcsFile->getTokens();
 
         // Mark the beginning and end tokens.
-        if ($tokens[$stackPtr]['code'] === \T_OPEN_SHORT_ARRAY
-            || $tokens[$stackPtr]['code'] === \T_OPEN_SQUARE_BRACKET
-        ) {
+        if (isset(Collections::shortArrayListOpenTokensBC()[$tokens[$stackPtr]['code']]) === true) {
             $opener = $stackPtr;
             $closer = $tokens[$stackPtr]['bracket_closer'];
         } else {

diff --git a/Tests/Tokens/Collections/PropertyBasedTokenArraysTest.php b/Tests/Tokens/Collections/PropertyBasedTokenArraysTest.php
@@ -75,6 +75,7 @@ public function dataPropertyBasedTokenArrays()
             'objectOperators',
             'phpOpenTags',
             'propertyModifierKeywords',
+            'shortArrayListOpenTokensBC',
             'shortArrayTokens',
             'shortArrayTokensBC',
             'shortListTokens',

diff --git a/Tests/Utils/Arrays/GetOpenCloseTest.php b/Tests/Utils/Arrays/GetOpenCloseTest.php
@@ -11,6 +11,7 @@
 namespace PHPCSUtils\Tests\Utils\Arrays;
 
 use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
 use PHPCSUtils\Utils\Arrays;
 
 /**
@@ -46,7 +47,7 @@ public function testNonExistentToken()
      */
     public function testNotArrayToken($testMarker)
     {
-        $target = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+        $target = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
         $this->assertFalse(Arrays::getOpenClose(self::$phpcsFile, $target));
     }
 

diff --git a/Tests/Utils/Lists/GetAssignmentsTest.php b/Tests/Utils/Lists/GetAssignmentsTest.php
@@ -12,6 +12,7 @@
 
 use PHPCSUtils\Internal\Cache;
 use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
 use PHPCSUtils\Utils\Lists;
 
 /**
@@ -539,7 +540,7 @@ public function dataGetAssignments()
             ],
             'short-list-with-keys-nested-lists' => [
                 'testMarker'  => '/* testShortListWithKeysNestedLists */',
-                'targetToken' => [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET],
+                'targetToken' => Collections::shortArrayListOpenTokensBC(),
                 'expected'    => [
                     0 => [
                         'raw'                  => '\'a\' => [&$a, $b]',

diff --git a/Tests/Utils/Lists/GetOpenCloseTest.php b/Tests/Utils/Lists/GetOpenCloseTest.php
@@ -11,6 +11,7 @@
 namespace PHPCSUtils\Tests\Utils\Lists;
 
 use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
 use PHPCSUtils\Utils\Lists;
 
 /**
@@ -46,7 +47,7 @@ public function testNonExistentToken()
      */
     public function testNotListToken($testMarker)
     {
-        $target = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+        $target = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
         $this->assertFalse(Lists::getOpenClose(self::$phpcsFile, $target));
     }
 

diff --git a/Tests/Utils/Lists/IsShortArrayOrListTokenizerBC1Test.php b/Tests/Utils/Lists/IsShortArrayOrListTokenizerBC1Test.php
@@ -11,6 +11,7 @@
 namespace PHPCSUtils\Tests\Utils\Lists;
 
 use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
 use PHPCSUtils\Utils\Arrays;
 use PHPCSUtils\Utils\Lists;
 
@@ -63,7 +64,7 @@ public function testValidDataProvider($ignore, $data)
      */
     public function testIsShortArray($testMarker, $expected)
     {
-        $stackPtr = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+        $stackPtr = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
         $result   = Arrays::isShortArray(self::$phpcsFile, $stackPtr);
 
         $this->assertSame($expected['array'], $result);
@@ -83,7 +84,7 @@ public function testIsShortArray($testMarker, $expected)
      */
     public function testIsShortList($testMarker, $expected)
     {
-        $stackPtr = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+        $stackPtr = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
         $result   = Lists::isShortList(self::$phpcsFile, $stackPtr);
 
         $this->assertSame($expected['list'], $result);

diff --git a/Tests/Utils/Lists/IsShortArrayOrListTokenizerBC2Test.php b/Tests/Utils/Lists/IsShortArrayOrListTokenizerBC2Test.php
@@ -11,6 +11,7 @@
 namespace PHPCSUtils\Tests\Utils\Lists;
 
 use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
 use PHPCSUtils\Utils\Arrays;
 use PHPCSUtils\Utils\Lists;
 
@@ -63,7 +64,7 @@ public function testValidDataProvider($ignore, $data)
      */
     public function testIsShortArray($testMarker, $expected)
     {
-        $stackPtr = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+        $stackPtr = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
         $result   = Arrays::isShortArray(self::$phpcsFile, $stackPtr);
 
         $this->assertSame($expected['array'], $result);
@@ -83,7 +84,7 @@ public function testIsShortArray($testMarker, $expected)
      */
     public function testIsShortList($testMarker, $expected)
     {
-        $stackPtr = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+        $stackPtr = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
         $result   = Lists::isShortList(self::$phpcsFile, $stackPtr);
 
         $this->assertSame($expected['list'], $result);

diff --git a/Tests/Utils/Lists/IsShortArrayOrListTokenizerBC3Test.php b/Tests/Utils/Lists/IsShortArrayOrListTokenizerBC3Test.php
@@ -11,6 +11,7 @@
 namespace PHPCSUtils\Tests\Utils\Lists;
 
 use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
 use PHPCSUtils\Utils\Arrays;
 use PHPCSUtils\Utils\Lists;
 
@@ -63,7 +64,7 @@ public function testValidDataProvider($ignore, $data)
      */
     public function testIsShortArray($testMarker, $expected)
     {
-        $stackPtr = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+        $stackPtr = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
         $result   = Arrays::isShortArray(self::$phpcsFile, $stackPtr);
 
         $this->assertSame($expected['array'], $result);
@@ -83,7 +84,7 @@ public function testIsShortArray($testMarker, $expected)
      */
     public function testIsShortList($testMarker, $expected)
     {
-        $stackPtr = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+        $stackPtr = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
         $result   = Lists::isShortList(self::$phpcsFile, $stackPtr);
 
         $this->assertSame($expected['list'], $result);

diff --git a/Tests/Utils/Lists/IsShortArrayOrListTokenizerBC4Test.php b/Tests/Utils/Lists/IsShortArrayOrListTokenizerBC4Test.php
@@ -11,6 +11,7 @@
 namespace PHPCSUtils\Tests\Utils\Lists;
 
 use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
 use PHPCSUtils\Utils\Arrays;
 use PHPCSUtils\Utils\Lists;
 
@@ -63,7 +64,7 @@ public function testValidDataProvider($ignore, $data)
      */
     public function testIsShortArray($testMarker, $expected)
     {
-        $stackPtr = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+        $stackPtr = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
         $result   = Arrays::isShortArray(self::$phpcsFile, $stackPtr);
 
         $this->assertSame($expected['array'], $result);
@@ -83,7 +84,7 @@ public function testIsShortArray($testMarker, $expected)
      */
     public function testIsShortList($testMarker, $expected)
     {
-        $stackPtr = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+        $stackPtr = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
         $result   = Lists::isShortList(self::$phpcsFile, $stackPtr);
 
         $this->assertSame($expected['list'], $result);

diff --git a/Tests/Utils/PassedParameters/HasParametersTest.php b/Tests/Utils/PassedParameters/HasParametersTest.php
@@ -11,6 +11,7 @@
 namespace PHPCSUtils\Tests\Utils\PassedParameters;
 
 use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
 use PHPCSUtils\Utils\PassedParameters;
 
 /**
@@ -113,7 +114,7 @@ public function testNotAShortArray()
 
         $self = $this->getTargetToken(
             '/* testShortListNotShortArray */',
-            [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
+            Collections::shortArrayListOpenTokensBC()
         );
         PassedParameters::hasParameters(self::$phpcsFile, $self);
     }