Fixed bug #2498 : Squiz.Arrays.ArrayDeclaration.MultiLineNotAllowed a…

…utofix breaks heredoc
squizlabs · May 13, 2019 · 6868096 · 6868096
1 parent 9c90cbf
commit 6868096
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 29 deletions.
diff --git a/package.xml b/package.xml
@@ -49,6 +49,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
     -- Thanks to Juliette Reinders Folmer for the patch
   - Fixed bug #2478 : FunctionCommentThrowTag.WrongNumber when exception is thrown once but built conditionally
   - Fixed bug #2479 : Generic.WhiteSpace.ScopeIndent error when using array destructing with exact indent checking
+  - Fixed bug #2498 : Squiz.Arrays.ArrayDeclaration.MultiLineNotAllowed autofix breaks heredoc
  </notes>
  <contents>
   <dir name="/">

diff --git a/src/Standards/Squiz/Sniffs/Arrays/ArrayDeclarationSniff.php b/src/Standards/Squiz/Sniffs/Arrays/ArrayDeclarationSniff.php
@@ -530,43 +530,47 @@ 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';
-            $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);
-            }
+            // Before we complain, make sure the single value isn't a here/nowdoc.
+            $next = $phpcsFile->findNext(Tokens::$heredocTokens, ($arrayStart + 1), ($arrayEnd - 1));
+            if ($next === false) {
+                // 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';
+                $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();
-                for ($i = ($arrayStart + 1); $i < $arrayEnd; $i++) {
-                    if ($tokens[$i]['code'] !== T_WHITESPACE) {
-                        break;
+                if ($fix === true) {
+                    $phpcsFile->fixer->beginChangeset();
+                    for ($i = ($arrayStart + 1); $i < $arrayEnd; $i++) {
+                        if ($tokens[$i]['code'] !== T_WHITESPACE) {
+                            break;
+                        }
+
+                        $phpcsFile->fixer->replaceToken($i, '');
                     }
 
-                    $phpcsFile->fixer->replaceToken($i, '');
-                }
+                    for ($i = ($arrayEnd - 1); $i > $arrayStart; $i--) {
+                        if ($tokens[$i]['code'] !== T_WHITESPACE) {
+                            break;
+                        }
 
-                for ($i = ($arrayEnd - 1); $i > $arrayStart; $i--) {
-                    if ($tokens[$i]['code'] !== T_WHITESPACE) {
-                        break;
+                        $phpcsFile->fixer->replaceToken($i, '');
                     }
 
-                    $phpcsFile->fixer->replaceToken($i, '');
+                    $phpcsFile->fixer->endChangeset();
                 }
 
-                $phpcsFile->fixer->endChangeset();
-            }
-
-            return;
+                return;
+            }//end if
         }//end if
 
         /*

diff --git a/src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.1.inc b/src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.1.inc
@@ -404,6 +404,12 @@ $paths = array(
           Init::ROOT_DIR.'/цвет' => 'синий',
          );
 
+$foo = array(<<<JSON
+{
+}
+JSON
+       );
+
 // Intentional syntax error.
 $a = array(
       'a' =>

diff --git a/src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.1.inc.fixed b/src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.1.inc.fixed
@@ -432,6 +432,12 @@ $paths = array(
           Init::ROOT_DIR.'/цвет' => 'синий',
          );
 
+$foo = array(<<<JSON
+{
+}
+JSON
+       );
+
 // Intentional syntax error.
 $a = array(
       'a' =>

diff --git a/src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.2.inc b/src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.2.inc
@@ -393,6 +393,12 @@ $paths = [
           Init::ROOT_DIR.'/цвет' => 'синий',
          ];
 
+$foo = [<<<JSON
+{
+}
+JSON
+       ];
+
 // Intentional syntax error.
 $a = [
       'a' =>

diff --git a/src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.2.inc.fixed b/src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.2.inc.fixed
@@ -419,6 +419,12 @@ $paths = [
           Init::ROOT_DIR.'/цвет' => 'синий',
          ];
 
+$foo = [<<<JSON
+{
+}
+JSON
+       ];
+
 // Intentional syntax error.
 $a = [
       'a' =>