Merge pull request #476 from PHPCSStandards/feature/abstractarraydeclaration-bugfix

AbstractArrayDeclarationSniff: extra defensive coding for live coding/parse errors

Author: jrfnl

PHPCSUtils/AbstractSniffs/AbstractArrayDeclarationSniff.php

@@ -184,9 +184,14 @@ final public function process(File $phpcsFile, $stackPtr)
             return;
         }
 
+        $openClose = Arrays::getOpenClose($phpcsFile, $stackPtr, true);
+        if ($openClose === false) {
+            // Parse error or live coding.
+            return;
+        }
+
         $this->stackPtr    = $stackPtr;
         $this->tokens      = $phpcsFile->getTokens();
-        $openClose         = Arrays::getOpenClose($phpcsFile, $stackPtr, true);
         $this->arrayOpener = $openClose['opener'];
         $this->arrayCloser = $openClose['closer'];
         $this->itemCount   = \count($this->arrayItems);

Tests/AbstractSniffs/AbstractArrayDeclaration/AbstractArrayDeclarationSniffTest.inc

@@ -30,3 +30,7 @@ $array = [1, 'a' => 2, ];
 
 /* testShortList */
 [$a, $b] = $array;
+
+/* testLiveCoding */
+// This must be the last test in the file!!
+$array = array(

Tests/AbstractSniffs/AbstractArrayDeclaration/AbstractArrayDeclarationSniffTest.php

@@ -611,4 +611,38 @@ public function testShortCircuitOnProcessComma()
 
         $mockObj->process(self::$phpcsFile, $target);
     }
+
+    /**
+     * Test that the abstract sniff correctly bows out when presented with an unfinished array.
+     *
+     * @return void
+     */
+    public function testBowOutOnUnfinishedArray()
+    {
+        $target = $this->getTargetToken('/* testLiveCoding */', Collections::arrayOpenTokensBC());
+
+        $mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
+            ->setMethods($this->methodsToMock)
+            ->getMockForAbstractClass();
+
+        $mockObj->expects($this->never())
+            ->method('processOpenClose');
+
+        $mockObj->expects($this->never())
+            ->method('processKey');
+
+        $mockObj->expects($this->never())
+            ->method('processNoKey');
+
+        $mockObj->expects($this->never())
+            ->method('processArrow');
+
+        $mockObj->expects($this->never())
+            ->method('processValue');
+
+        $mockObj->expects($this->never())
+            ->method('processComma');
+
+        $mockObj->process(self::$phpcsFile, $target);
+    }
 }