Fixed bug #2479 : Generic.WhiteSpace.ScopeIndent error when using array destructuring with exact indent checking

Author: gsherwood

package.xml

@@ -17,28 +17,16 @@ http://pear.php.net/dtd/package-2.0.xsd">
  <date>2019-04-11</date>
  <time>09:34:00</time>
  <version>
-  <release>3.4.2</release>
-  <api>3.4.2</api>
+  <release>3.5.0</release>
+  <api>3.5.0</api>
  </version>
  <stability>
   <release>stable</release>
   <api>stable</api>
  </stability>
  <license uri="https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt">BSD 3-Clause License</license>
  <notes>
-  - Squiz.Arrays.ArrayDeclaration now has improved handling of syntax errors
-  - Fixed an issue where the PCRE JIT on PHP 7.3 caused PHPCS to die when using the parallel option
-    -- PHPCS now disables the PCRE JIT before running
-  - Fixed bug #2368 : MySource.PHP.AjaxNullComparison throws error when first function has no doc comment 
-  - Fixed bug #2414 : Indention false positive in switch/case/if combination
-  - Fixed bug #2423 : Squiz.Formatting.OperatorBracket.MissingBrackets error with static
-  - Fixed bug #2450 : Indentation false positive when closure containing nested IF conditions used as function argument
-  - Fixed bug #2452 : LowercasePHPFunctions sniff failing on "new \File()"
-  - Fixed bug #2453 : Squiz.CSS.SemicolonSpacingSniff false positive when style name proceeded by an asterisk
-    -- Thanks to Juliette Reinders Folmer for the patch
-  - Fixed bug #2464 : Fixer conflict between Generic.WhiteSpace.ScopeIndent and Squiz.WhiteSpace.ScopeClosingBrace when class indented 1 space
-  - Fixed bug #2465 : Excluding a sniff by path is not working
-  - Fixed bug #2467 : PHP open/close tags inside CSS files are replaced with internal PHPCS token strings when auto fixing
+  - Fixed bug #2479 : Generic.WhiteSpace.ScopeIndent error when using array destructuring with exact indent checking
  </notes>
  <contents>
   <dir name="/">

src/Config.php

@@ -23,7 +23,7 @@ class Config
      *
      * @var string
      */
-    const VERSION = '3.4.2';
+    const VERSION = '3.5.0';
 
     /**
      * Package stability; either stable, beta or alpha.

src/Standards/Generic/Sniffs/WhiteSpace/ScopeIndentSniff.php

@@ -231,12 +231,24 @@ public function process(File $phpcsFile, $stackPtr)
 
             if ($tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) {
                 $disableExactEnd = max($disableExactEnd, $tokens[$i]['bracket_closer']);
+                if ($this->debug === true) {
+                    $line = $tokens[$i]['line'];
+                    $type = $tokens[$disableExactEnd]['type'];
+                    echo "Opening short array bracket found on line $line".PHP_EOL;
+                    echo "\t=> disabling exact indent checking until $disableExactEnd ($type)".PHP_EOL;
+                }
             }
 
             if ($tokens[$i]['code'] === T_OPEN_PARENTHESIS
                 && isset($tokens[$i]['parenthesis_closer']) === true
             ) {
                 $disableExactEnd = max($disableExactEnd, $tokens[$i]['parenthesis_closer']);
+                if ($this->debug === true) {
+                    $line = $tokens[$i]['line'];
+                    $type = $tokens[$disableExactEnd]['type'];
+                    echo "Opening parenthesis found on line $line".PHP_EOL;
+                    echo "\t=> disabling exact indent checking until $disableExactEnd ($type)".PHP_EOL;
+                }
             }
 
             if ($exact === true && $i < $disableExactEnd) {
@@ -977,6 +989,17 @@ public function process(File $phpcsFile, $stackPtr)
                 $i = $checkToken;
             }
 
+            // Don't check indents exactly between arrays as they tend to have custom rules.
+            if ($tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) {
+                $disableExactEnd = max($disableExactEnd, $tokens[$i]['bracket_closer']);
+                if ($this->debug === true) {
+                    $line = $tokens[$i]['line'];
+                    $type = $tokens[$disableExactEnd]['type'];
+                    echo "Opening short array bracket found on line $line".PHP_EOL;
+                    echo "\t=> disabling exact indent checking until $disableExactEnd ($type)".PHP_EOL;
+                }
+            }
+
             // Completely skip here/now docs as the indent is a part of the
             // content itself.
             if ($tokens[$i]['code'] === T_START_HEREDOC

src/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.3.inc

@@ -15,3 +15,10 @@ function test()
         'test3'
     );
 }
+
+if ($foo) {
+    [
+      'enabled'     => $enabled,
+      'compression' => $compression,
+    ] = $options;
+}

src/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.3.inc.fixed

@@ -15,3 +15,10 @@ function test()
         'test3'
     );
 }
+
+if ($foo) {
+    [
+      'enabled'     => $enabled,
+      'compression' => $compression,
+    ] = $options;
+}