Squiz.Arrays.ArrayDeclaration no longer tries to change multi-line arrays to single line when they contain comments (ref #2091)

Author: gsherwood

package.xml

@@ -47,6 +47,8 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Squiz.Arrays.ArrayDeclaration no longer removes the array opening brace while fixing
     -- This could occur when the opening brace was on a new line and the first array key directly followed
     -- This change also stops the KeyNotAligned error message being incorrectly reported in these cases
+  - Squiz.Arrays.ArrayDeclaration no longer tries to change multi-line arrays to single line when they contain comments
+    -- Fixes a conflict between this sniff and some indentation sniffs
   - Squiz.Classes.ClassDeclaration no longer enforces spacing rules when a class is followed by a function
     -- Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff
   - The Squiz.Classes.ValidClassName.NotCamelCaps message now references PascalCase instead of CamelCase

src/Standards/Squiz/Sniffs/Arrays/ArrayDeclarationSniff.php

@@ -524,8 +524,18 @@ public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $array
         if ($singleValue === true) {
             // Array cannot be empty, so this is a multi-line array with
             // a single value. It should be defined on single line.
-            $error = 'Multi-line array contains a single value; use single-line array instead';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'MultiLineNotAllowed');
+            $error     = 'Multi-line array contains a single value; use single-line array instead';
+            $errorCode = 'MultiLineNotAllowed';
+
+            $find    = Tokens::$phpcsCommentTokens;
+            $find[]  = T_COMMENT;
+            $comment = $phpcsFile->findNext($find, ($arrayStart + 1), $arrayEnd);
+            if ($comment === false) {
+                $fix = $phpcsFile->addFixableError($error, $stackPtr, $errorCode);
+            } else {
+                $fix = false;
+                $phpcsFile->addError($error, $stackPtr, $errorCode);
+            }
 
             if ($fix === true) {
                 $phpcsFile->fixer->beginChangeset();

src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.1.inc

@@ -378,3 +378,9 @@ $foo = array(
             : self::STATUS_VERIFIED,
         '3' => strtotime($row['date']),
        );
+
+$foo = foo(
+    array(
+    // comment
+    )
+);

src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.1.inc.fixed

@@ -406,3 +406,9 @@ $foo = array(
             : self::STATUS_VERIFIED,
         '3' => strtotime($row['date']),
        );
+
+$foo = foo(
+    array(
+    // comment
+    )
+);

src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.2.inc

@@ -366,3 +366,10 @@ $foo = [
             : self::STATUS_VERIFIED,
         '3' => strtotime($row['date']),
        ];
+
+
+$foo = foo(
+    [
+    // comment
+    ]
+);

src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.2.inc.fixed

@@ -392,3 +392,10 @@ $foo = [
             : self::STATUS_VERIFIED,
         '3' => strtotime($row['date']),
        ];
+
+
+$foo = foo(
+    [
+    // comment
+    ]
+);

src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.php

@@ -111,6 +111,7 @@ public function getErrorList($testFile='')
                 368 => 2,
                 369 => 1,
                 370 => 1,
+                383 => 1,
             ];
         case 'ArrayDeclarationUnitTest.2.inc':
             return [
@@ -184,6 +185,7 @@ public function getErrorList($testFile='')
                 356 => 2,
                 357 => 1,
                 358 => 1,
+                372 => 1,
             ];
         default:
             return [];