Squiz/EmbeddedPhp: closer on own line fixers should remove trailing spaces

As things were, the "closer on own line" fixers would, in most cases, leave trailing whitespace 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.

Additionally, when the next token is inline HTML, it could lead to weird/incorrect indents, which would not be fixable via a sniff (as determining intended indent for inline HTML is non-trivial).

This commit fixes the "closer on own line" fixers to remove trailing spaces and prevents them from affecting the indent of inline HTML unnecessarily.

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

Author: jrfnl

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

@@ -233,6 +233,11 @@ private function validateMultilineEmbeddedPhp($phpcsFile, $stackPtr, $closingTag
             if ($fix === true) {
                 $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $closingTag, true);
                 $phpcsFile->fixer->beginChangeset();
+
+                if ($tokens[($closingTag - 1)]['code'] === T_WHITESPACE) {
+                    $phpcsFile->fixer->replaceToken(($closingTag - 1), '');
+                }
+
                 $phpcsFile->fixer->addContentBefore($closingTag, str_repeat(' ', ($tokens[$first]['column'] - 1)));
                 $phpcsFile->fixer->addNewlineBefore($closingTag);
                 $phpcsFile->fixer->endChangeset();
@@ -245,8 +250,20 @@ private function validateMultilineEmbeddedPhp($phpcsFile, $stackPtr, $closingTag
                 $phpcsFile->fixer->beginChangeset();
                 $phpcsFile->fixer->addNewline($closingTag);
                 $phpcsFile->fixer->addContent($closingTag, str_repeat(' ', ($tokens[$first]['column'] - 1)));
+
+                if ($tokens[$firstContentAfterBlock]['code'] === T_INLINE_HTML) {
+                    $trimmedHtmlContent = ltrim($tokens[$firstContentAfterBlock]['content']);
+                    if ($trimmedHtmlContent === '') {
+                        // HTML token contains only whitespace and the next token after is PHP, not HTML, so remove the whitespace.
+                        $phpcsFile->fixer->replaceToken($firstContentAfterBlock, '');
+                    } else {
+                        // The HTML token has content, so remove leading whitespace in favour of the indent.
+                        $phpcsFile->fixer->replaceToken($firstContentAfterBlock, $trimmedHtmlContent);
+                    }
+                }
+
                 $phpcsFile->fixer->endChangeset();
-            }
+            }//end if
         }//end if
 
         $next = $phpcsFile->findNext(T_OPEN_TAG, ($closingTag + 1));

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

@@ -151,6 +151,23 @@ Make sure the "content after opener" fixer does not leave trailing space behind.
     <?php   echo $openerNeedsOwnLine;
     ?>
 
+<!--
+Make sure the "content before closer" fixer does not leave trailing space behind.
+-->
+    <?php
+    echo $closerNeedsOwnLine;   ?>
+
+<!--
+Make sure the "content after closer" fixer does not leave trailing space behind.
+-->
+    <?php
+    echo $closerNeedsOwnLine;
+    ?>  </div>
+
+    <?php
+    echo $closerNeedsOwnLine;
+    ?>  <?php echo $i; ?>
+
 <?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

@@ -30,7 +30,7 @@
         ?>
 
     <?php
-    echo $closerNeedsOwnLine; 
+    echo $closerNeedsOwnLine;
     ?>
     <?php
     echo $openerNeedsOwnLine;
@@ -146,6 +146,26 @@ Make sure the "content after opener" fixer does not leave trailing space behind.
     echo $openerNeedsOwnLine;
     ?>
 
+<!--
+Make sure the "content before closer" fixer does not leave trailing space behind.
+-->
+    <?php
+    echo $closerNeedsOwnLine;
+    ?>
+
+<!--
+Make sure the "content after closer" fixer does not leave trailing space behind.
+-->
+    <?php
+    echo $closerNeedsOwnLine;
+    ?>
+    </div>
+
+    <?php
+    echo $closerNeedsOwnLine;
+    ?>
+    <?php echo $i; ?>
+
 <?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

@@ -71,6 +71,9 @@ public function getErrorList()
             142 => 1,
             145 => 1,
             151 => 1,
+            158 => 1,
+            165 => 1,
+            169 => 1,
         ];
 
     }//end getErrorList()