Slevomat.Arrays.DisallowPartiallyKeyed: Fixed false positive with array unpacking

Author: kukulich

SlevomatCodingStandard/Helpers/ArrayHelper.php

@@ -146,7 +146,7 @@ public static function isKeyed(array $keyValues): bool
 	public static function isKeyedAll(array $keyValues): bool
 	{
 		foreach ($keyValues as $keyValue) {
-			if ($keyValue->getKey() === null) {
+			if (!$keyValue->isUnpacking() && $keyValue->getKey() === null) {
 				return false;
 			}
 		}
@@ -187,14 +187,19 @@ public static function isNotEmpty(File $phpcsFile, int $pointer): bool
 	 */
 	public static function isSortedByKey(array $keyValues): bool
 	{
-		$prev = '';
+		$previousKey = '';
 		foreach ($keyValues as $keyValue) {
-			$cmp = strnatcasecmp((string) $prev, (string) $keyValue->getKey());
-			if ($cmp === 1) {
+			if ($keyValue->isUnpacking()) {
+				continue;
+			}
+
+			if (strnatcasecmp($previousKey, $keyValue->getKey()) === 1) {
 				return false;
 			}
-			$prev = $keyValue->getKey();
+
+			$previousKey = $keyValue->getKey();
 		}
+
 		return true;
 	}
 

SlevomatCodingStandard/Helpers/ArrayKeyValue.php

@@ -10,6 +10,7 @@
 use function trim;
 use const T_COMMA;
 use const T_DOUBLE_ARROW;
+use const T_ELLIPSIS;
 use const T_WHITESPACE;
 
 /**
@@ -36,6 +37,9 @@ class ArrayKeyValue
 	/** @var ?int */
 	private $pointerComma = null;
 
+	/** @var bool */
+	private $unpacking = false;
+
 	public function __construct(File $phpcsFile, int $pointerStart, int $pointerEnd)
 	{
 		$this->pointerStart = $pointerStart;
@@ -102,6 +106,11 @@ public function getPointerStart(): int
 		return $this->pointerStart;
 	}
 
+	public function isUnpacking(): bool
+	{
+		return $this->unpacking;
+	}
+
 	private function addValues(File $phpcsFile): void
 	{
 		$key = '';
@@ -119,6 +128,8 @@ private function addValues(File $phpcsFile): void
 				$this->pointerArrow = $pointer;
 			} elseif ($token['code'] === T_COMMA) {
 				$this->pointerComma = $pointer;
+			} elseif ($token['code'] === T_ELLIPSIS) {
+				$this->unpacking = true;
 			} elseif ($this->pointerArrow === null) {
 				if ($firstNonWhitespace === null && $token['code'] !== T_WHITESPACE) {
 					$firstNonWhitespace = $pointer;

tests/Sniffs/Arrays/data/alphabeticallySortedByKeysErrors.fixed.php

@@ -48,6 +48,7 @@ public function log($msg)
 		'a4' => 'a4 val',
 	),
 );
+// @phpcs:enable SlevomatCodingStandard.Arrays.AlphabeticallySortedByKeys.IncorrectKeyOrder
 
 [
 	'I am',

tests/Sniffs/Arrays/data/alphabeticallySortedByKeysErrors.php

@@ -47,6 +47,7 @@ public function log($msg)
 		'a4' => 'a4 val',
 	),
 );
+// @phpcs:enable SlevomatCodingStandard.Arrays.AlphabeticallySortedByKeys.IncorrectKeyOrder
 
 [
 	'I am',

tests/Sniffs/Arrays/data/alphabeticallySortedByKeysNoErrors.php

@@ -53,3 +53,13 @@ public function log($msg)
 	'just a list',
 	'no keys',
 ];
+
+$a = [];
+$b = [];
+
+[
+	'b' => 'b',
+	...$b,
+	'a' => 'a',
+	...$a
+];

tests/Sniffs/Arrays/data/disallowPartiallyKeyedNoErrors.php

@@ -1,4 +1,4 @@
-<?php
+<?php // lint >= 7.4
 
 [];
 
@@ -8,7 +8,7 @@
 
 array('foo', 'bar', 'baz');
 
-[
+$a = [
 	0 => 'zero',
 	'foo' => 'foo',
 	'bar' => 'bar',
@@ -18,6 +18,8 @@
 array(
 	0 => 'zero',
 	'foo' => 'foo',
+	...$a,
 	'bar' => 'bar',
-	'baz' => 'baz'
+	'baz' => 'baz',
+	...$a
 );