Array sniffs: ignore short lists

WordPress/Sniff.php

@@ -3202,4 +3202,68 @@ protected function is_foreach_as( $stackPtr ) {
 		return ( $stackPtr > $as_ptr );
 	}
 
+	/**
+	 * Determine whether a T_OPEN/CLOSE_SHORT_ARRAY token is a short list() construct.
+	 *
+	 * @internal This function will be introduced in PHPCS upstream in version 3.5.0
+	 * and can be removed from WPCS once WPCS raises the minimum version.
+	 *
+	 * @since 2.2.0
+	 *
+	 * @param int $stackPtr The position of the array bracket token.
+	 *
+	 * @return bool True if the token passed is the open/close bracket of a short list.
+	 *              False if the token is a short array bracket or not
+	 *              a T_OPEN/CLOSE_SHORT_ARRAY token.
+	 */
+	protected function is_short_list( $stackPtr ) {
+		// Is this one of the tokens this function handles ?
+		if ( \T_OPEN_SHORT_ARRAY !== $this->tokens[ $stackPtr ]['code']
+			&& \T_CLOSE_SHORT_ARRAY !== $this->tokens[ $stackPtr ]['code']
+		) {
+			return false;
+		}
+
+		switch ( $this->tokens[ $stackPtr ]['code'] ) {
+			case \T_OPEN_SHORT_ARRAY:
+				$opener = $stackPtr;
+				$closer = $this->tokens[ $stackPtr ]['bracket_closer'];
+				break;
+
+			case \T_CLOSE_SHORT_ARRAY:
+				$opener = $this->tokens[ $stackPtr ]['bracket_opener'];
+				$closer = $stackPtr;
+				break;
+		}
+
+		$nextNonEmpty = $this->phpcsFile->findNext( Tokens::$emptyTokens, ( $closer + 1 ), null, true, null, true );
+		if ( false !== $nextNonEmpty && \T_EQUAL === $this->tokens[ $nextNonEmpty ]['code'] ) {
+			return true;
+		}
+
+		// Check for short list in foreach, i.e. `foreach($array as [$a, $b])`.
+		if ( $this->is_foreach_as( $stackPtr ) === true ) {
+			return true;
+		}
+
+		// Maybe this is a short list syntax nested inside another short list syntax ?
+		$parentOpen = $opener;
+		do {
+			$parentOpen = $this->phpcsFile->findPrevious(
+				\T_OPEN_SHORT_ARRAY,
+				( $parentOpen - 1 ),
+				null,
+				false,
+				null,
+				true
+			);
+
+			if ( false === $parentOpen ) {
+				return false;
+			}
+		} while ( $this->tokens[ $parentOpen ]['bracket_closer'] < $opener );
+
+		return $this->is_short_list( $parentOpen );
+	}
+
 }

WordPress/Sniffs/Arrays/ArrayDeclarationSpacingSniff.php

@@ -87,6 +87,14 @@ public function register() {
 	 * @return void
 	 */
 	public function process_token( $stackPtr ) {
+
+		if ( \T_OPEN_SHORT_ARRAY === $this->tokens[ $stackPtr ]['code']
+			&& $this->is_short_list( $stackPtr )
+		) {
+			// Short list, not short array.
+			return;
+		}
+
 		/*
 		 * Determine the array opener & closer.
 		 */

WordPress/Sniffs/Arrays/ArrayIndentationSniff.php

@@ -92,6 +92,13 @@ public function process_token( $stackPtr ) {
 			$this->tab_width = PHPCSHelper::get_tab_width( $this->phpcsFile );
 		}
 
+		if ( \T_OPEN_SHORT_ARRAY === $this->tokens[ $stackPtr ]['code']
+			&& $this->is_short_list( $stackPtr )
+		) {
+			// Short list, not short array.
+			return;
+		}
+
 		/*
 		 * Determine the array opener & closer.
 		 */

WordPress/Sniffs/Arrays/CommaAfterArrayItemSniff.php

@@ -51,6 +51,14 @@ public function register() {
 	 * @return void
 	 */
 	public function process_token( $stackPtr ) {
+
+		if ( \T_OPEN_SHORT_ARRAY === $this->tokens[ $stackPtr ]['code']
+			&& $this->is_short_list( $stackPtr )
+		) {
+			// Short list, not short array.
+			return;
+		}
+
 		/*
 		 * Determine the array opener & closer.
 		 */

WordPress/Sniffs/Arrays/MultipleStatementAlignmentSniff.php

@@ -164,6 +164,14 @@ public function register() {
 	 *                  normal file processing.
 	 */
 	public function process_token( $stackPtr ) {
+
+		if ( \T_OPEN_SHORT_ARRAY === $this->tokens[ $stackPtr ]['code']
+			&& $this->is_short_list( $stackPtr )
+		) {
+			// Short list, not short array.
+			return;
+		}
+
 		/*
 		 * Determine the array opener & closer.
 		 */

WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.2.inc

@@ -107,3 +107,29 @@ $bad = [
 	end */
 	'key4' => 'value4'
 ];
+
+/*
+ * Issue #1692: Test distinguishing between short array and short list.
+ *
+ * Note: these short lists should all contain "violations" against the array
+ * declaration sniff if they would be recognized as short array to make sure
+ * they are correctly recognized as short lists.
+ */
+// Empty list, not allowed since PHP 7.0, but not our concern.
+[  ] = $array; // OK.
+[, ,] = $array; // OK.
+
+[$var1, $var2] = $array; // OK.
+
+// Keyed list.
+[$foo => $bar] = $bar; // OK.
+['enabled' => $enabled, 'compression' => $compression] = [ 'enabled' => true, 'compression' => 'gzip' ]; // Bad x 1 - only for the short array, not the short list.
+
+// Nested short lists.
+[$var1, , [$var2, $var3,], $var4] = $array; // OK.
+[ 'o' => [[ $one, $two, $three ], [ 'what' => $what ]] ] = $x; // OK.
+
+// Destructuring - multiline.
+[
+	'prop1' => $prop1, 'prop2' => $prop2, // OK.
+] = $some_var;

WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.2.inc.fixed

@@ -164,3 +164,32 @@ $bad = [
 	end */
 	'key4' => 'value4'
 ];
+
+/*
+ * Issue #1692: Test distinguishing between short array and short list.
+ *
+ * Note: these short lists should all contain "violations" against the array
+ * declaration sniff if they would be recognized as short array to make sure
+ * they are correctly recognized as short lists.
+ */
+// Empty list, not allowed since PHP 7.0, but not our concern.
+[  ] = $array; // OK.
+[, ,] = $array; // OK.
+
+[$var1, $var2] = $array; // OK.
+
+// Keyed list.
+[$foo => $bar] = $bar; // OK.
+['enabled' => $enabled, 'compression' => $compression] = [
+'enabled' => true,
+'compression' => 'gzip'
+]; // Bad x 1 - only for the short array, not the short list.
+
+// Nested short lists.
+[$var1, , [$var2, $var3,], $var4] = $array; // OK.
+[ 'o' => [[ $one, $two, $three ], [ 'what' => $what ]] ] = $x; // OK.
+
+// Destructuring - multiline.
+[
+	'prop1' => $prop1, 'prop2' => $prop2, // OK.
+] = $some_var;

WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.php

@@ -93,6 +93,7 @@ public function getErrorList( $testFile = '' ) {
 					91  => 1,
 					92  => 1,
 					104 => 1,
+					126 => 1,
 				);
 
 			default:

WordPress/Tests/Arrays/ArrayIndentationUnitTest.1.inc

@@ -428,3 +428,11 @@ $my_array = [
 // B
 	'something_else',
 ];
+
+/*
+ * Issue #1692: Test distinguishing between short array and short list.
+ */
+[
+'prop1' => $prop1,
+			'prop2' => $prop2,
+] = $some_var;

WordPress/Tests/Arrays/ArrayIndentationUnitTest.1.inc.fixed

@@ -428,3 +428,11 @@ $my_array = [
 // B
 	'something_else',
 ];
+
+/*
+ * Issue #1692: Test distinguishing between short array and short list.
+ */
+[
+'prop1' => $prop1,
+			'prop2' => $prop2,
+] = $some_var;

WordPress/Tests/Arrays/ArrayIndentationUnitTest.2.inc

@@ -429,4 +429,12 @@ $my_array = [
     'something_else',
 ];
 
+/*
+ * Issue #1692: Test distinguishing between short array and short list.
+ */
+[
+'prop1' => $prop1,
+			'prop2' => $prop2,
+] = $some_var;
+
 // phpcs:set WordPress.Arrays.ArrayIndentation tabIndent true

WordPress/Tests/Arrays/ArrayIndentationUnitTest.2.inc.fixed

@@ -429,4 +429,12 @@ $my_array = [
     'something_else',
 ];
 
+/*
+ * Issue #1692: Test distinguishing between short array and short list.
+ */
+[
+'prop1' => $prop1,
+			'prop2' => $prop2,
+] = $some_var;
+
 // phpcs:set WordPress.Arrays.ArrayIndentation tabIndent true

WordPress/Tests/Arrays/CommaAfterArrayItemUnitTest.inc

@@ -190,3 +190,23 @@ $bad = array(
          'second'
          // phpcs:enable Standard.Category.Sniff
         );
+
+/*
+ * Issue #1692: Test distinguishing between short array and short list.
+ */
+// Empty list, not allowed since PHP 7.0, but not our concern.
+[,,] = $array; // OK.
+
+[$var1, $var2,] = $array; // OK.
+
+// Keyed list.
+['enabled' => $enabled, 'compression' => $compression,] = [ 'enabled' => true, 'compression' => 'gzip', ]; // Bad x 1 - only for the short array, not the short list.
+
+// Nested short lists.
+[$var1, , [$var2, $var3,], $var4,] = $array; // OK.
+
+// Destructuring - multiline.
+[
+	'prop1' => $prop1,
+	'prop2' => $prop2
+] = $some_var;

WordPress/Tests/Arrays/CommaAfterArrayItemUnitTest.inc.fixed

@@ -179,3 +179,23 @@ $bad = array(
          'second',
          // phpcs:enable Standard.Category.Sniff
         );
+
+/*
+ * Issue #1692: Test distinguishing between short array and short list.
+ */
+// Empty list, not allowed since PHP 7.0, but not our concern.
+[,,] = $array; // OK.
+
+[$var1, $var2,] = $array; // OK.
+
+// Keyed list.
+['enabled' => $enabled, 'compression' => $compression,] = [ 'enabled' => true, 'compression' => 'gzip' ]; // Bad x 1 - only for the short array, not the short list.
+
+// Nested short lists.
+[$var1, , [$var2, $var3,], $var4,] = $array; // OK.
+
+// Destructuring - multiline.
+[
+	'prop1' => $prop1,
+	'prop2' => $prop2
+] = $some_var;

WordPress/Tests/Arrays/CommaAfterArrayItemUnitTest.php

@@ -74,6 +74,7 @@ public function getErrorList() {
 			184 => 2,
 			185 => 2,
 			190 => 1,
+			203 => 1,
 		);
 	}
 

WordPress/Tests/Arrays/MultipleStatementAlignmentUnitTest.1.inc

@@ -571,4 +571,12 @@ $deprecated_functions = array(
 					string', // Bad.
 );
 
+/*
+ * This isn't actually testing something, but is the long version of the "short list" test.
+ */
+list(
+	'prop1' => $prop1,
+	'prop2'    => $prop2,
+) = $some_var;
+
 // phpcs:set WordPress.Arrays.MultipleStatementAlignment alignMultilineItems always

WordPress/Tests/Arrays/MultipleStatementAlignmentUnitTest.1.inc.fixed

@@ -557,4 +557,12 @@ $deprecated_functions = array(
 					string', // Bad.
 );
 
+/*
+ * This isn't actually testing something, but is the long version of the "short list" test.
+ */
+list(
+	'prop1' => $prop1,
+	'prop2'    => $prop2,
+) = $some_var;
+
 // phpcs:set WordPress.Arrays.MultipleStatementAlignment alignMultilineItems always

WordPress/Tests/Arrays/MultipleStatementAlignmentUnitTest.2.inc

@@ -571,4 +571,12 @@ $deprecated_functions = [
                     string', // Bad.
 ];
 
+/*
+ * Issue #1692: Test distinguishing between short array and short list.
+ */
+[
+	'prop1' => $prop1,
+	'prop2'    => $prop2,
+] = $some_var;
+
 // phpcs:set WordPress.Arrays.MultipleStatementAlignment alignMultilineItems always

WordPress/Tests/Arrays/MultipleStatementAlignmentUnitTest.2.inc.fixed

@@ -557,4 +557,12 @@ $deprecated_functions = [
                     string', // Bad.
 ];
 
+/*
+ * Issue #1692: Test distinguishing between short array and short list.
+ */
+[
+	'prop1' => $prop1,
+	'prop2'    => $prop2,
+] = $some_var;
+
 // phpcs:set WordPress.Arrays.MultipleStatementAlignment alignMultilineItems always