Generic/DisallowMultipleStatements: add fixed file + minor bug fix

The sniff contain a fixer, but didn't have a `fixed` file.

The fixer did not yet take the new PHPCS annotations into account. The only one which is problematic if it's moved, is the `T_PHPCS_IGNORE` token, so if that token would be encountered, the error will still be thrown, but will no longer be fixable.

Includes additional unit test covering this.

Author: jrfnl

package.xml

@@ -589,6 +589,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
        </dir>
        <dir name="Formatting">
         <file baseinstalldir="PHP/CodeSniffer" name="DisallowMultipleStatementsUnitTest.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="DisallowMultipleStatementsUnitTest.inc.fixed" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="DisallowMultipleStatementsUnitTest.php" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="MultipleStatementAlignmentUnitTest.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="MultipleStatementAlignmentUnitTest.inc.fixed" role="test" />

src/Standards/Generic/Sniffs/Formatting/DisallowMultipleStatementsSniff.php

@@ -39,16 +39,24 @@ public function register()
      */
     public function process(File $phpcsFile, $stackPtr)
     {
-        $tokens = $phpcsFile->getTokens();
+        $tokens  = $phpcsFile->getTokens();
+        $fixable = true;
+        $prev    = $stackPtr;
+
+        do {
+            $prev = $phpcsFile->findPrevious([T_SEMICOLON, T_OPEN_TAG, T_OPEN_TAG_WITH_ECHO, T_PHPCS_IGNORE], ($prev - 1));
+            if ($prev === false
+                || $tokens[$prev]['code'] === T_OPEN_TAG
+                || $tokens[$prev]['code'] === T_OPEN_TAG_WITH_ECHO
+            ) {
+                $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no');
+                return;
+            }
 
-        $prev = $phpcsFile->findPrevious([T_SEMICOLON, T_OPEN_TAG, T_OPEN_TAG_WITH_ECHO], ($stackPtr - 1));
-        if ($prev === false
-            || $tokens[$prev]['code'] === T_OPEN_TAG
-            || $tokens[$prev]['code'] === T_OPEN_TAG_WITH_ECHO
-        ) {
-            $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no');
-            return;
-        }
+            if ($tokens[$prev]['code'] === T_PHPCS_IGNORE) {
+                $fixable = false;
+            }
+        } while ($tokens[$prev]['code'] === T_PHPCS_IGNORE);
 
         // Ignore multiple statements in a FOR condition.
         if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
@@ -69,7 +77,13 @@ public function process(File $phpcsFile, $stackPtr)
             $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'yes');
 
             $error = 'Each PHP statement must be on a line by itself';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SameLine');
+            $code  = 'SameLine';
+            if ($fixable === false) {
+                $phpcsFile->addError($error, $stackPtr, $code);
+                return;
+            }
+
+            $fix = $phpcsFile->addFixableError($error, $stackPtr, $code);
             if ($fix === true) {
                 $phpcsFile->fixer->beginChangeset();
                 $phpcsFile->fixer->addNewline($prev);
@@ -81,7 +95,7 @@ public function process(File $phpcsFile, $stackPtr)
             }
         } else {
             $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no');
-        }
+        }//end if
 
     }//end process()
 

src/Standards/Generic/Tests/Formatting/DisallowMultipleStatementsUnitTest.inc

@@ -11,3 +11,6 @@ $this->wizardid = 10; $this->paint(); echo 'x';
 <div class="<?php echo $class ?>" id="<?php echo $id ?>"></div>
 <div class="<?= $class; ?>" id="<?= $id; ?>"></div>
 <div class="<?= $class ?>" id="<?= $id ?>"></div>
+
+<?php
+echo 'x'; /* phpcs:ignore Standard */ echo $y; /* phpcs:ignore OtherStandard */;

src/Standards/Generic/Tests/Formatting/DisallowMultipleStatementsUnitTest.inc.fixed

@@ -0,0 +1,21 @@
+<?php
+$y = 2;
+;
+echo $y;
+for ($i = 1; $i < $length; $i++) {}
+for (; $i < $length; $i++) {}
+echo 'x';
+echo $y;
+$x = 10;
+echo $y;
+$this->wizardid = 10;
+$this->paint();
+echo 'x';
+?>
+<div class="<?php echo $class; ?>" id="<?php echo $id; ?>"></div>
+<div class="<?php echo $class ?>" id="<?php echo $id ?>"></div>
+<div class="<?= $class; ?>" id="<?= $id; ?>"></div>
+<div class="<?= $class ?>" id="<?= $id ?>"></div>
+
+<?php
+echo 'x'; /* phpcs:ignore Standard */ echo $y; /* phpcs:ignore OtherStandard */;

src/Standards/Generic/Tests/Formatting/DisallowMultipleStatementsUnitTest.php

@@ -26,10 +26,11 @@ class DisallowMultipleStatementsUnitTest extends AbstractSniffUnitTest
     public function getErrorList()
     {
         return [
-            2 => 1,
-            6 => 1,
-            7 => 1,
-            8 => 2,
+            2  => 1,
+            6  => 1,
+            7  => 1,
+            8  => 2,
+            16 => 2,
         ];
 
     }//end getErrorList()