comparison vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Files/EndFileNewlineSniff.php @ 0:4c8ae668cc8c

Initial import (non-working)

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