Squiz/EmbeddedPhp: opener on own line fixer should remove trailing spaces

As things were, the "opener on own line / content after" fixer would always leave at least one trailing space behind.
For most codebases, this means the sniff would always need to be run in conjunction with a sniff which removes trailing spaces and that there is always a second fixer round needed: the first to fix the embedded PHP formatting, the second to allow the other sniff to remove the trailing spaces introduced by the fixes made by this sniff.

It also makes updating the test case file fiddly.

Secondly, if the space between the open tag and the first content was larger than exactly one space, the sniff would also need an extra fixer round to fix the indent of the "first content", which was moved to the next line and given indent, but with the extra space having being moved as well, the indent would now be too large.

This commit fixes the "opener on own line / content after" fixer to remove trailing spaces and prevent the potential extra fixer loop to fix the indent.

Covered by pre-existing tests + an additional newly added test.

Author: jrfnl

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

@@ -97,9 +97,16 @@ private function validateMultilineEmbeddedPhp($phpcsFile, $stackPtr, $closingTag
             if ($fix === true) {
                 $first   = $phpcsFile->findFirstOnLine(T_WHITESPACE, $stackPtr, true);
                 $padding = (strlen($tokens[$first]['content']) - strlen(ltrim($tokens[$first]['content'])));
+
                 $phpcsFile->fixer->beginChangeset();
+                $phpcsFile->fixer->replaceToken($stackPtr, rtrim($tokens[$stackPtr]['content']));
                 $phpcsFile->fixer->addNewline($stackPtr);
                 $phpcsFile->fixer->addContent($stackPtr, str_repeat(' ', $padding));
+
+                if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) {
+                    $phpcsFile->fixer->replaceToken(($stackPtr + 1), '');
+                }
+
                 $phpcsFile->fixer->endChangeset();
             }
         } else {

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

@@ -145,6 +145,12 @@ or indentation if there is code _after_ the removed empty tag.
     <?php if (true) { ?><?php echo $i; ?>  <?php
     ?>  <?php } ?>
 
+<!--
+Make sure the "content after opener" fixer does not leave trailing space behind.
+-->
+    <?php   echo $openerNeedsOwnLine;
+    ?>
+
 <?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

@@ -32,7 +32,7 @@
     <?php
     echo $closerNeedsOwnLine; 
     ?>
-    <?php 
+    <?php
     echo $openerNeedsOwnLine;
     ?>
 
@@ -51,12 +51,12 @@ function test()
     foreach ($root->section as $section) {
         ?>
         <table>
-            <?php 
+            <?php
             if ($foo) {
             ?>
             <tr>
             </tr>
-            <?php 
+            <?php
             }
             ?>
         <?php
@@ -139,6 +139,13 @@ or indentation if there is code _after_ the removed empty tag.
 
     <?php if (true) { ?><?php echo $i; ?>    <?php } ?>
 
+<!--
+Make sure the "content after opener" fixer does not leave trailing space behind.
+-->
+    <?php
+    echo $openerNeedsOwnLine;
+    ?>
+
 <?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

@@ -70,6 +70,7 @@ public function getErrorList()
             138 => 1,
             142 => 1,
             145 => 1,
+            151 => 1,
         ];
 
     }//end getErrorList()