Fixed bug #2146 : Zend.Files.ClosingTag removes closing tag from end of file without inserting a semicolon

Author: gsherwood

package.xml

@@ -56,6 +56,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Fixed bug #2143 : PSR2.Namespaces.UseDeclaration does not properly fix "use function" and "use const" statements
     -- Thanks to Chris Wilkinson for the patch
   - Fixed bug #2144 : Squiz.Arrays.ArrayDeclaration does incorrect align calculation in array with cyrillic keys
+  - Fixed bug #2146 : Zend.Files.ClosingTag removes closing tag from end of file without inserting a semicolon
   - Fixed bug #2151 : XML schema not updated with the new array property syntax
  </notes>
  <contents>
@@ -1603,7 +1604,13 @@ http://pear.php.net/dtd/package-2.0.xsd">
        </dir>
        <dir name="Files">
         <file baseinstalldir="PHP/CodeSniffer" name="ClosingTagUnitTest.1.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="ClosingTagUnitTest.1.inc.fixed" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="ClosingTagUnitTest.2.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="ClosingTagUnitTest.3.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="ClosingTagUnitTest.3.inc.fixed" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="ClosingTagUnitTest.4.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="ClosingTagUnitTest.4.inc.fixed" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="ClosingTagUnitTest.5.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="ClosingTagUnitTest.php" role="test" />
        </dir>
        <dir name="NamingConventions">

src/Standards/Zend/Sniffs/Files/ClosingTagSniff.php

@@ -11,6 +11,7 @@
 
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Util\Tokens;
 
 class ClosingTagSniff implements Sniff
 {
@@ -51,13 +52,22 @@ public function process(File $phpcsFile, $stackPtr)
             $error = 'A closing tag is not permitted at the end of a PHP file';
             $fix   = $phpcsFile->addFixableError($error, $last, 'NotAllowed');
             if ($fix === true) {
-                $phpcsFile->fixer->replaceToken($last, '');
+                $phpcsFile->fixer->beginChangeset();
+                $phpcsFile->fixer->replaceToken($last, $phpcsFile->eolChar);
+                $prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($last - 1), null, true);
+                if ($tokens[$prev]['code'] !== T_SEMICOLON
+                    && $tokens[$prev]['code'] !== T_CLOSE_CURLY_BRACKET
+                ) {
+                    $phpcsFile->fixer->addContent($prev, ';');
+                }
+
+                $phpcsFile->fixer->endChangeset();
             }
 
             $phpcsFile->recordMetric($stackPtr, 'PHP closing tag at EOF', 'yes');
         } else {
             $phpcsFile->recordMetric($stackPtr, 'PHP closing tag at EOF', 'no');
-        }
+        }//end if
 
         // Ignore the rest of the file.
         return ($phpcsFile->numTokens + 1);

src/Standards/Zend/Tests/Files/ClosingTagUnitTest.1.inc.fixed

@@ -0,0 +1,12 @@
+<?php
+
+echo 'hi';
+
+?>
+
+<?php
+
+echo 'bye';
+
+
+

src/Standards/Zend/Tests/Files/ClosingTagUnitTest.2.inc

@@ -1,3 +1,3 @@
 <div class="clear"></div>
     <?php include('inc.php'); ?>
-</div>
+</div>

src/Standards/Zend/Tests/Files/ClosingTagUnitTest.3.inc

@@ -0,0 +1 @@
+<?php include($this->add('arg'))?>

src/Standards/Zend/Tests/Files/ClosingTagUnitTest.3.inc.fixed

@@ -0,0 +1 @@
+<?php include($this->add('arg'));

src/Standards/Zend/Tests/Files/ClosingTagUnitTest.4.inc

@@ -0,0 +1 @@
+<?php include($this->add('arg')) /* comment */ ?>

src/Standards/Zend/Tests/Files/ClosingTagUnitTest.4.inc.fixed

@@ -0,0 +1 @@
+<?php include($this->add('arg')); /* comment */ 

src/Standards/Zend/Tests/Files/ClosingTagUnitTest.5.inc

@@ -0,0 +1 @@
+<?php function foo() { include($this->add('arg')); } ?>

src/Standards/Zend/Tests/Files/ClosingTagUnitTest.5.inc.fixed

@@ -0,0 +1 @@
+<?php function foo() { include($this->add('arg')); }