Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\InfoFiles\NamespacedDependencySniff.
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\InfoFiles;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@0:  * Checks that all declared dependencies are namespaced.
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 NamespacedDependencySniff 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_INLINE_HTML);
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 current file being processed.
Chris@17:      * @param int                         $stackPtr  The position of the current token
Chris@17:      *                                               in the stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return int
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         $fileExtension = strtolower(substr($phpcsFile->getFilename(), -9));
Chris@0:         if ($fileExtension !== '.info.yml') {
Chris@0:             return ($phpcsFile->numTokens + 1);
Chris@0:         }
Chris@0: 
Chris@0:         if (preg_match('/^dependencies:/', $tokens[$stackPtr]['content']) === 0) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $nextLine = ($stackPtr + 1);
Chris@0: 
Chris@0:         while (isset($tokens[$nextLine]) === true) {
Chris@0:             // Dependency line without namespace.
Chris@0:             if (preg_match('/^[\s]+- [^:]+[\s]*$/', $tokens[$nextLine]['content']) === 1) {
Chris@0:                 $error = 'All dependencies must be prefixed with the project name, for example "drupal:"';
Chris@0:                 $phpcsFile->addWarning($error, $nextLine, 'NonNamespaced');
Chris@0:             } else if (preg_match('/^[\s]+- [^:]+:[^:]+[\s]*$/', $tokens[$nextLine]['content']) === 0
Chris@0:                 && preg_match('/^[\s]*#.*$/', $tokens[$nextLine]['content']) === 0
Chris@0:             ) {
Chris@0:                 // Not a dependency line with namespace or comment - stop.
Chris@0:                 return $nextLine;
Chris@0:             }
Chris@0: 
Chris@0:             $nextLine++;
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class