Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Files\EndFileNewlineSniff.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@17: namespace Drupal\Sniffs\Files;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@0:  * Ensures the file ends with a newline character.
Chris@0:  *
Chris@0:  * Largely copied from PSR2, but we need to run it on *.txt files and templates as
Chris@0:  * well.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@17: class EndFileNewlineSniff implements Sniff
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * A list of tokenizers this sniff supports.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     public $supportedTokenizers = array(
Chris@0:                                    'PHP',
Chris@0:                                    'JS',
Chris@0:                                    'CSS',
Chris@0:                                   );
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array of tokens this test wants to listen for.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function register()
Chris@0:     {
Chris@0:         return array(
Chris@0:                 T_OPEN_TAG,
Chris@0:                 T_INLINE_HTML,
Chris@0:                );
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this sniff, when one of its tokens is encountered.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17:      * @param int                         $stackPtr  The position of the current token in
Chris@17:      *                                               the stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         // Skip to the end of the file.
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0:         if ($phpcsFile->tokenizerType === 'PHP') {
Chris@0:             $lastToken = ($phpcsFile->numTokens - 1);
Chris@0:         } else {
Chris@0:             // JS and CSS have an artificial token at the end which we have to
Chris@0:             // ignore.
Chris@0:             $lastToken = ($phpcsFile->numTokens - 2);
Chris@0:         }
Chris@0: 
Chris@0:         // Hard-coding the expected \n in this sniff as it is PSR-2 specific and
Chris@0:         // PSR-2 enforces the use of unix style newlines.
Chris@0:         if (substr($tokens[$lastToken]['content'], -1) !== "\n") {
Chris@0:             $error = 'Expected 1 newline at end of file; 0 found';
Chris@0:             $fix   = $phpcsFile->addFixableError($error, $lastToken, 'NoneFound');
Chris@0:             if ($fix === true) {
Chris@0:                 $phpcsFile->fixer->addNewline($lastToken);
Chris@0:             }
Chris@0: 
Chris@0:             $phpcsFile->recordMetric($stackPtr, 'Number of newlines at EOF', '0');
Chris@0:             return ($phpcsFile->numTokens + 1);
Chris@0:         }
Chris@0: 
Chris@0:         // Go looking for the last non-empty line.
Chris@0:         $lastLine = $tokens[$lastToken]['line'];
Chris@0:         if ($tokens[$lastToken]['code'] === T_WHITESPACE) {
Chris@0:             $lastCode = $phpcsFile->findPrevious(T_WHITESPACE, ($lastToken - 1), null, true);
Chris@0:         } else if ($tokens[$lastToken]['code'] === T_INLINE_HTML) {
Chris@0:             $lastCode = $lastToken;
Chris@0:             while ($lastCode > 0 && trim($tokens[$lastCode]['content']) === '') {
Chris@0:                 $lastCode--;
Chris@0:             }
Chris@0:         } else {
Chris@0:             $lastCode = $lastToken;
Chris@0:         }
Chris@0: 
Chris@0:         $lastCodeLine = $tokens[$lastCode]['line'];
Chris@0:         $blankLines   = ($lastLine - $lastCodeLine + 1);
Chris@0:         $phpcsFile->recordMetric($stackPtr, 'Number of newlines at EOF', $blankLines);
Chris@0: 
Chris@0:         if ($blankLines > 1) {
Chris@0:             $error = 'Expected 1 newline at end of file; %s found';
Chris@0:             $data  = array($blankLines);
Chris@0:             $fix   = $phpcsFile->addFixableError($error, $lastCode, 'TooMany', $data);
Chris@0: 
Chris@0:             if ($fix === true) {
Chris@0:                 $phpcsFile->fixer->beginChangeset();
Chris@0:                 $phpcsFile->fixer->replaceToken($lastCode, rtrim($tokens[$lastCode]['content']));
Chris@0:                 for ($i = ($lastCode + 1); $i < $lastToken; $i++) {
Chris@0:                     $phpcsFile->fixer->replaceToken($i, '');
Chris@0:                 }
Chris@0: 
Chris@0:                 $phpcsFile->fixer->replaceToken($lastToken, $phpcsFile->eolChar);
Chris@0:                 $phpcsFile->fixer->endChangeset();
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         // Skip the rest of the file.
Chris@0:         return ($phpcsFile->numTokens + 1);
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class