Merge pull request #270 from PHPCSStandards/passedparameters/test-document-behaviour-empty-list-items

Tests/PassedParameters::getParameters(): document behaviour with empty list items

Author: jrfnl

Tests/Utils/PassedParameters/GetParametersSkipShortArrayCheckTest.inc

@@ -10,10 +10,20 @@ $foo = array( 1, 2 );
 $foo = [ 'a' => 1, 'b' => 2 ];
 
 /* testShortList */
-[ 'a' => 1, 'b' => 2 ] = $array;
+[ 'a' => $a, 'b' => $b ] = $array;
 
 /* testArrayAssign */
 $array[] = 'foo';
 
 /* testArrayAccess */
 $foo = $array[$keys['key']];
+
+/* testShortListWithEmptyItemsBefore */
+[, , $a] = $array;
+
+/* testShortListWithEmptyItemsAfter */
+[$a,,] = $array;
+
+/* testShortListWithAllEmptyItems */
+// Not allowed, but not our concern.
+[,,] = $array;

Tests/Utils/PassedParameters/GetParametersSkipShortArrayCheckTest.php

@@ -165,12 +165,12 @@ public function dataTestCases()
  1 => [
  'start' => 1,
  'end' => 6,
- 'raw' => "'a' => 1",
+ 'raw' => '\'a\' => $a',
  ],
  2 => [
  'start' => 8,
  'end' => 14,
- 'raw' => "'b' => 2",
+ 'raw' => '\'b\' => $b',
  ],
  ],
  ],
@@ -192,6 +192,62 @@ public function dataTestCases()
  ],
  ],
  ],
+ 'short-list-with-empties-before' => [
+ '/* testShortListWithEmptyItemsBefore */',
+ \T_OPEN_SHORT_ARRAY,
+ true,
+ [
+ 1 => [
+ 'start' => 1,
+ 'end' => 0,
+ 'raw' => '',
+ ],
+ 2 => [
+ 'start' => 2,
+ 'end' => 2,
+ 'raw' => '',
+ ],
+ 3 => [
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => '$a',
+ ],
+ ],
+ ],
+ 'short-list-with-empties-after' => [
+ '/* testShortListWithEmptyItemsAfter */',
+ \T_OPEN_SHORT_ARRAY,
+ true,
+ [
+ 1 => [
+ 'start' => 1,
+ 'end' => 1,
+ 'raw' => '$a',
+ ],
+ 2 => [
+ 'start' => 3,
+ 'end' => 2,
+ 'raw' => '',
+ ],
+ ],
+ ],
+ 'short-list-with-all-empties' => [
+ '/* testShortListWithAllEmptyItems */',
+ \T_OPEN_SHORT_ARRAY,
+ true,
+ [
+ 1 => [
+ 'start' => 1,
+ 'end' => 0,
+ 'raw' => '',
+ ],
+ 2 => [
+ 'start' => 2,
+ 'end' => 1,
+ 'raw' => '',
+ ],
+ ],
+ ],
  ];
  }
 }