Squiz/EmbeddedPhp: bug fix - closer on own line indent is not calculated correctly

When the PHP close tag is on the same line as the first PHP content in a multi-line embedded PHP block and the indent of the first PHP content in the block is incorrect, the indent for the close tag when it is moved to its own line will be based on the (incorrect) indent of the first PHP content line and not on the corrected indent for the first PHP content, which the indent fixer uses.

This commit fixes this.

Covered by pre-existing tests and adjusting the "fixed" expectations for those.
Additionally, an extra test has been added for the case when `$indent` is not pre-calculated (= when the first content in the block is a scope closer).

Author: jrfnl

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

@@ -238,17 +238,29 @@ private function validateMultilineEmbeddedPhp($phpcsFile, $stackPtr, $closingTag
             $error = 'Closing PHP tag must be on a line by itself';
             $fix   = $phpcsFile->addFixableError($error, $closingTag, 'ContentBeforeEnd');
             if ($fix === true) {
-                $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $closingTag, true);
+                // Calculate the indent for the close tag.
+                // If the close tag is on the same line as the first content, re-use the indent
+                // calculated for the first content line to prevent the indent being based on an
+                // "old" indent, not the _new_ (fixed) indent.
+                if ($tokens[$firstContent]['line'] === $tokens[$lastContent]['line']
+                    && isset($indent) === true
+                ) {
+                    $closerIndent = $indent;
+                } else {
+                    $first        = $phpcsFile->findFirstOnLine(T_WHITESPACE, $closingTag, true);
+                    $closerIndent = ($tokens[$first]['column'] - 1);
+                }
+
                 $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->addContentBefore($closingTag, str_repeat(' ', $closerIndent));
                 $phpcsFile->fixer->addNewlineBefore($closingTag);
                 $phpcsFile->fixer->endChangeset();
-            }
+            }//end if
         } else if ($tokens[$firstContentAfterBlock]['line'] === $tokens[$closingTag]['line']) {
             $error = 'Closing PHP tag must be on a line by itself';
             $fix   = $phpcsFile->addFixableError($error, $closingTag, 'ContentAfterEnd');

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

@@ -181,6 +181,13 @@ Make sure the fixer does not add stray new lines when there are consecutive PHP
 echo 'embedded';
     ?>
 
+<!--
+Safeguard closing tag indent calculation for when the last content on the close tag line is a scope closer.
+-->
+<?php if (true) { ?>
+<?php
+    } ?>
+
 <?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.1.inc.fixed

@@ -182,6 +182,14 @@ Make sure the fixer does not add stray new lines when there are consecutive PHP
     echo 'embedded';
     ?>
 
+<!--
+Safeguard closing tag indent calculation for when the last content on the close tag line is a scope closer.
+-->
+<?php if (true) { ?>
+<?php
+    }
+    ?>
+
 <?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.20.inc.fixed

@@ -10,7 +10,7 @@ as long as it is followed by non-empty inline HTML.
 <div>
 <?php
 echo 'too much indent and close tag not on own line';
-    ?>
+?>
 
 </div>
 <p>Some more content after the last PHP tag block.</p>

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

@@ -10,7 +10,7 @@ as long as it is followed by non-empty inline HTML.
 <div>
 <?=
 'too much indent and close tag not on own line';
-    ?>
+?>
 
 </div>
 <p>Some more content after the last PHP tag block.</p>

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

@@ -84,6 +84,7 @@ public function getErrorList($testFile='')
                 179 => 1,
                 180 => 2,
                 181 => 1,
+                189 => 1,
             ];
 
         case 'EmbeddedPhpUnitTest.2.inc':