Squiz/EmbeddedPhp: bug fix - close tag intended indent calculation

Yet another indentation calculation bug.

If the close tag is not on its own line, but is on a line containing a subsequent line of a star-slash style comment, the indentation would not be calculated correctly as the comment token will include the indentation.

Fixed now, includes test.

Author: jrfnl

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

@@ -253,7 +253,16 @@ private function validateMultilineEmbeddedPhp($phpcsFile, $stackPtr, $closingTag
                 ) {
                     $closerIndent = $indent;
                 } else {
-                    $first        = $phpcsFile->findFirstOnLine(T_WHITESPACE, $closingTag, true);
+                    $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $closingTag, true);
+
+                    while ($tokens[$first]['code'] === T_COMMENT
+                        && $tokens[$first]['content'] !== ltrim($tokens[$first]['content'])
+                    ) {
+                        // This is a subsequent line in a star-slash comment containing leading indent.
+                        // We'll need the first line of the comment to correctly determine the indent.
+                        $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, ($first - 1), true);
+                    }
+
                     $closerIndent = ($tokens[$first]['column'] - 1);
                 }
 

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

@@ -228,6 +228,18 @@ echo 'indent is correct - first on line for open tag is open tag';
 echo 'indent is incorrect - first on line for open tag is whitespace';
 ?>
 
+<!--
+Safeguard correct close tag indent calculation.
+-->
+    <?php
+    /* Single line star comments are not problematic. */ ?>
+
+    <?php
+    /* Subsequent lines of inline slash-star comments
+       contain the indent in the comment token.
+       This means the calculated indent would be 0 unless we
+       walk to the first line in the comment. */ ?>
+
 <?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

@@ -234,6 +234,20 @@ echo 'indent is incorrect - first on line for open tag is open tag';
     echo 'indent is incorrect - first on line for open tag is whitespace';
 ?>
 
+<!--
+Safeguard correct close tag indent calculation.
+-->
+    <?php
+    /* Single line star comments are not problematic. */
+    ?>
+
+    <?php
+    /* Subsequent lines of inline slash-star comments
+       contain the indent in the comment token.
+       This means the calculated indent would be 0 unless we
+       walk to the first line in the comment. */
+    ?>
+
 <?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

@@ -93,6 +93,8 @@ public function getErrorList($testFile='')
                 226 => 1,
                 227 => 2,
                 228 => 1,
+                235 => 1,
+                241 => 1,
             ];
 
         case 'EmbeddedPhpUnitTest.2.inc':