Squiz/EmbeddedPhp: bug fix - fixer adds stray new line

When the close tag of a previous multi-line embedded PHP snippet and the open tag of the next multi-line embedded PHP snippet are on the same line, the sniff would add a stray blank line with trailing whitespace between the two tokens due to the fixers both running in the same loop.

This commit adds a small tweak preventing this stray blank line from being added.

Includes unit tests proving the issue and safeguarding the fix.

Author: jrfnl

src/Standards/Squiz/Sniffs/PHP/EmbeddedPhpSniff.php

@@ -262,6 +262,13 @@ private function validateMultilineEmbeddedPhp($phpcsFile, $stackPtr, $closingTag
                     }
                 }
 
+                if ($tokens[$firstContentAfterBlock]['code'] === T_OPEN_TAG) {
+                    // Next token is a PHP open tag which will also have thrown an error.
+                    // Prevent both fixers running in the same loop by making sure the token is "touched" during this loop.
+                    // This prevents a stray new line being added between the close and open tags.
+                    $phpcsFile->fixer->replaceToken($firstContentAfterBlock, $tokens[$firstContentAfterBlock]['content']);
+                }
+
                 $phpcsFile->fixer->endChangeset();
             }//end if
         }//end if

src/Standards/Squiz/Tests/PHP/EmbeddedPhpUnitTest.inc

@@ -168,6 +168,19 @@ Make sure the "content after closer" fixer does not leave trailing space behind.
     echo $closerNeedsOwnLine;
     ?>  <?php echo $i; ?>
 
+<!--
+Make sure the fixer does not add stray new lines when there are consecutive PHP blocks.
+-->
+<?php
+    // Do something.
+    ?><?php
+    echo 'embedded';
+    ?>  <?php
+        echo 'embedded';
+    ?><?php
+echo 'embedded';
+    ?>
+
 <?php
 // This test case file MUST always end with an unclosed long open PHP tag (with this comment) to prevent
 // the tests running into the "last PHP closing tag excepted" condition breaking tests.

src/Standards/Squiz/Tests/PHP/EmbeddedPhpUnitTest.inc.fixed

@@ -166,6 +166,22 @@ Make sure the "content after closer" fixer does not leave trailing space behind.
     ?>
     <?php echo $i; ?>
 
+<!--
+Make sure the fixer does not add stray new lines when there are consecutive PHP blocks.
+-->
+<?php
+// Do something.
+    ?>
+    <?php
+    echo 'embedded';
+    ?>
+    <?php
+    echo 'embedded';
+    ?>
+    <?php
+    echo 'embedded';
+    ?>
+
 <?php
 // This test case file MUST always end with an unclosed long open PHP tag (with this comment) to prevent
 // the tests running into the "last PHP closing tag excepted" condition breaking tests.

src/Standards/Squiz/Tests/PHP/EmbeddedPhpUnitTest.php

@@ -74,6 +74,12 @@ public function getErrorList()
             158 => 1,
             165 => 1,
             169 => 1,
+            175 => 1,
+            176 => 2,
+            178 => 1,
+            179 => 1,
+            180 => 2,
+            181 => 1,
         ];
 
     }//end getErrorList()