Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\Commenting\CommentEmptyLineSniff
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 DrupalPractice\Sniffs\Commenting;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@0:  * Throws a warning if there is a blank line after an inline comment.
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 CommentEmptyLineSniff implements Sniff
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(T_COMMENT);
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this test, 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
Chris@17:      *                                               in 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:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         $comment = rtrim($tokens[$stackPtr]['content']);
Chris@0: 
Chris@0:         // Only want inline comments.
Chris@0:         if (substr($comment, 0, 2) !== '//') {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         // The line below the last comment cannot be empty.
Chris@0:         for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) {
Chris@0:             if ($tokens[$i]['line'] === ($tokens[$stackPtr]['line'] + 1)) {
Chris@0:                 if ($tokens[$i]['code'] !== T_WHITESPACE) {
Chris@0:                     return;
Chris@0:                 }
Chris@0:             } else if ($tokens[$i]['line'] > ($tokens[$stackPtr]['line'] + 1)) {
Chris@0:                 break;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $warning = 'There must be no blank line following an inline comment';
Chris@0:         $phpcsFile->addWarning($warning, $stackPtr, 'SpacingAfter');
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class