Chris@0: <?php
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\Commenting\ExpectedExceptionSniff.
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:  * Checks that the PHPunit @expectedExcpetion tags are not used.
Chris@0:  *
Chris@0:  * See https://thephp.cc/news/2016/02/questioning-phpunit-best-practices .
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 ExpectedExceptionSniff 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_DOC_COMMENT_TAG);
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:         $content = $tokens[$stackPtr]['content'];
Chris@0:         if ($content === '@expectedException' || $content === '@expectedExceptionCode'
Chris@0:             || $content === '@expectedExceptionMessage'
Chris@0:             || $content === '@expectedExceptionMessageRegExp'
Chris@0:         ) {
Chris@17:             $warning = '%s tags should not be used, use $this->setExpectedException() or $this->expectException() instead';
Chris@0:             $phpcsFile->addWarning($warning, $stackPtr, 'TagFound', [$content]);
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class