WIP ContextHelper::is_token_namespaced(): update for PHPCS 4.0

The tokenization of (namespaced) "names" has changed in PHP 8.0, and this new tokenization will come into effect for PHP_CodeSniffer as of version 4.0.0.

This commit adds handling for the new tokenization when determining if a token is namespaced or not. Since the tokenization of namespaced names changed between PHPCS 3 and 4, it was necessary to use different logic depending on the PHPCS version.

TODO check if the approach to support both PHPCS 3 and 4 is good.

Author: rodrigoprimo

WordPress/Helpers/ContextHelper.php

@@ -11,6 +11,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Util\Tokens;
+use PHPCSUtils\BackCompat\Helper;
 use PHPCSUtils\Tokens\Collections;
 use PHPCSUtils\Utils\Parentheses;
 use PHPCSUtils\Utils\PassedParameters;
@@ -176,6 +177,28 @@ public static function is_token_namespaced( File $phpcsFile, $stackPtr ) {
 			return false;
 		}
 
+		$isPhpcs3 = version_compare( Helper::getVersion(), '3.99.99', '<=' );
+
+		if ( true === $isPhpcs3 ) {
+			return self::is_token_namespaced_phpcs3( $phpcsFile, $stackPtr );
+		} else {
+			return self::is_token_namespaced_phpcs4( $phpcsFile, $stackPtr );
+		}
+	}
+
+	/**
+	 * Check if a particular token is prefixed with a namespace when running PHPCS <= 3. Different
+	 * methods are necessary because, the tokenization of namespaced names changed between PHPCS 3
+	 * and 4.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
+	 * @param int                         $stackPtr The index of the token in the stack.
+	 *
+	 * @return bool
+	 */
+	private static function is_token_namespaced_phpcs3( File $phpcsFile, $stackPtr ) {
+		$tokens = $phpcsFile->getTokens();
+
 		$prev = $phpcsFile->findPrevious( Tokens::$emptyTokens, ( $stackPtr - 1 ), null, true );
 
 		if ( \T_NS_SEPARATOR !== $tokens[ $prev ]['code'] ) {
@@ -192,6 +215,35 @@ public static function is_token_namespaced( File $phpcsFile, $stackPtr ) {
 		return true;
 	}
 
+	/**
+	 * Check if a particular token is prefixed with a namespace when running PHPCS <= 4. Different
+	 * methods are necessary because, the tokenization of namespaced names changed between PHPCS 3
+	 * and 4.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
+	 * @param int                         $stackPtr The index of the token in the stack.
+	 *
+	 * @return bool
+	 */
+	private static function is_token_namespaced_phpcs4( File $phpcsFile, $stackPtr ) {
+		$tokens = $phpcsFile->getTokens();
+
+		if ( \T_NAME_QUALIFIED === $tokens[ $stackPtr ]['code']
+			|| \T_NAME_RELATIVE === $tokens[ $stackPtr ]['code']
+		) {
+			return true;
+		}
+
+		// If the token is a fully qualified name, this methods consider it as namespaced if it
+		// contains more than one namespace separator (i.e., not in the global namespace).
+		if ( \T_NAME_FULLY_QUALIFIED === $tokens[ $stackPtr ]['code']
+			&& \substr_count( $tokens[ $stackPtr ]['content'], '\\' ) > 1 ) {
+			return true;
+		}
+
+		return false;
+	}
+
 	/**
 	 * Check if a token is (part of) a parameter for a function call to a select list of functions.
 	 *

WordPress/Tests/Security/EscapeOutputUnitTest.1.inc

@@ -676,3 +676,6 @@ throw new
 /* some comment */
 #[Attribute2('text', 10)]
 readonly class( $unescaped ) {}; // Bad.
+
+// printf( 'Hello %s', $foo ); // Bad.
+// \printf( 'Hello %s', \esc_html( $foo ) ); // Ok.

WordPress/Util/Tests/Helpers/ContextHelper/IsTokenNamespacedUnitTest.php

@@ -9,6 +9,7 @@
 
 namespace WordPressCS\WordPress\Util\Tests\Helpers\ContextHelper;
 
+use PHPCSUtils\BackCompat\Helper;
 use PHPCSUtils\Tokens\Collections;
 use WordPressCS\WordPress\Helpers\ContextHelper;
 use PHPCSUtils\TestUtils\UtilityMethodTestCase;
@@ -53,13 +54,15 @@ public function testIsTokenNamespacedShouldReturnFalse( $commentString, $tokenCo
 	 * @see testIsTokenNamespacedShouldReturnFalse()
 	 */
 	public static function dataIsTokenNamespacedShouldReturnFalse() {
+		$isPhpcs3 = version_compare( Helper::getVersion(), '3.99.99', '<=' );
+
 		return array(
 			array( '/* test return false 1 */', 'my_function' ),
-			array( '/* test return false 2 */', 'my_function' ),
+			array( '/* test return false 2 */', ( $isPhpcs3 ? 'my_function' : '\my_function' ) ),
 			array( '/* test return false 3 */', 'MyClass' ),
-			array( '/* test return false 4 */', 'MyClass' ),
+			array( '/* test return false 4 */', ( $isPhpcs3 ? 'MyClass' : '\MyClass' ) ),
 			array( '/* test return false 5 */', 'MY_CONSTANT' ),
-			array( '/* test return false 6 */', 'MY_CONSTANT' ),
+			array( '/* test return false 6 */', ( $isPhpcs3 ? 'MY_CONSTANT' : '\MY_CONSTANT' ) ),
 		);
 	}
 
@@ -85,12 +88,14 @@ public function testIsTokenNamespacedShouldReturnTrue( $commentString, $tokenCon
 	 * @see testIsTokenNamespacedShouldReturnTrue()
 	 */
 	public static function dataIsTokenNamespacedShouldReturnTrue() {
+		$isPhpcs3 = version_compare( Helper::getVersion(), '3.99.99', '<=' );
+
 		return array(
-			array( '/* test return true 1 */', 'my_function' ),
-			array( '/* test return true 2 */', 'my_function' ),
-			array( '/* test return true 3 */', 'my_function' ),
-			array( '/* test return true 4 */', 'MyClass' ),
-			array( '/* test return true 5 */', 'MY_CONSTANT' ),
+			array( '/* test return true 1 */', ( $isPhpcs3 ? 'my_function' : 'MyNamespace\my_function' ) ),
+			array( '/* test return true 2 */', ( $isPhpcs3 ? 'my_function' : '\MyNamespace\my_function' ) ),
+			array( '/* test return true 3 */', ( $isPhpcs3 ? 'my_function' : 'namespace\my_function' ) ),
+			array( '/* test return true 4 */', ( $isPhpcs3 ? 'MyClass' : 'MyNamespace\MyClass' ) ),
+			array( '/* test return true 5 */', ( $isPhpcs3 ? 'MY_CONSTANT' : 'MyNamespace\MY_CONSTANT' ) ),
 		);
 	}
 }