Merge branch 'develop' into 3.0/fix/613-remove-batcache-sniff

Author: GaryJones

.github/CONTRIBUTING.md

@@ -64,6 +64,7 @@ When you introduce new `public` sniff properties, or your sniff extends a class
 ### Pre-requisites
 * VIP Coding Standards
 * WordPress-Coding-Standards
+* PHPCSUtils 1.x
 * PHP_CodeSniffer 3.x
 * PHPUnit 4.x, 5.x, 6.x or 7.x
 

.github/ISSUE_TEMPLATE/bug_report.md

@@ -44,6 +44,7 @@ Use `php -v` and `composer show` to get versions.
 | ------------------------ | -------
 | PHP version              | x.y.z
 | PHP_CodeSniffer version  | x.y.z
+| PHPCSUtils version       | x.y.z
 | VIPCS version            | x.y.z
 | WordPressCS version      | x.y.z
 | VariableAnalysis version | x.y.z

README.md

@@ -17,6 +17,7 @@ Go to https://docs.wpvip.com/technical-references/code-review/phpcs-report/ to l
 
 * PHP 5.4+
 * [PHPCS 3.7.1+](https://github.com/squizlabs/PHP_CodeSniffer/releases)
+* [PHPCSUtils 1.0.8+](https://github.com/PHPCSStandards/PHPCSUtils)
 * [WPCS 2.3.0+](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/releases)
 * [VariableAnalysis 2.11.17+](https://github.com/sirbrillig/phpcs-variable-analysis/releases)
 
@@ -34,7 +35,7 @@ composer g config allow-plugins.dealerdirect/phpcodesniffer-composer-installer t
 composer g require automattic/vipwpcs
 ```
 
-This will install the latest compatible versions of PHPCS, WPCS and VariableAnalysis and register the external standards with PHP_CodeSniffer.
+This will install the latest compatible versions of PHPCS, PHPCSUtils, WPCS and VariableAnalysis and register the external standards with PHP_CodeSniffer.
 
 Please refer to the [installation instructions for installing PHP_CodeSniffer for WordPress.com VIP](https://docs.wpvip.com/how-tos/code-review/php_codesniffer/) for more details.
 

WordPress-VIP-Go/ruleset-test.inc

@@ -322,8 +322,8 @@ class MyWidget extends WP_Widget {
 class BadTestClass extends WP_CLI_Command { // Warning.
 }
 
-// WordPressVIPMinimum.Compatibility.ZoninatorSniff
-wpcom_vip_load_plugin( 'zoninator', 'plugins', '0.8' ); // Warning.
+
+
 
 // WordPressVIPMinimum.Constants.ConstantString
 define( WPCOM_VIP ); // Error.

WordPress-VIP-Go/ruleset-test.php

@@ -197,7 +197,6 @@
 		269 => 1,
 		273 => 1,
 		322 => 1,
-		326 => 1,
 		332 => 1,
 		392 => 1,
 		394 => 1,

WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php

@@ -9,7 +9,8 @@
 
 namespace WordPressVIPMinimum\Sniffs;
 
-use WordPressVIPMinimum\Sniffs\Sniff;
+use PHPCSUtils\Utils\GetTokensAsString;
+use PHPCSUtils\Utils\MessageHelper;
 
 /**
  * Restricts usage of some variables.
@@ -179,7 +180,7 @@ public function process_token( $stackPtr ) {
 
 				if ( isset( $token['bracket_closer'] ) ) {
 					$owner  = $this->phpcsFile->findPrevious( \T_VARIABLE, $stackPtr );
-					$inside = $this->phpcsFile->getTokensAsString( $stackPtr, $token['bracket_closer'] - $stackPtr + 1 );
+					$inside = GetTokensAsString::normal( $this->phpcsFile, $stackPtr, $token['bracket_closer'] );
 					$var    = implode( '', [ $this->tokens[ $owner ]['content'], $inside ] );
 				}
 			}
@@ -200,11 +201,13 @@ public function process_token( $stackPtr ) {
 				continue;
 			}
 
-			$this->addMessage(
+			$code = MessageHelper::stringToErrorcode( $groupName . '_' . $match[1] );
+			MessageHelper::addMessage(
+				$this->phpcsFile,
 				$group['message'],
 				$stackPtr,
 				$group['type'] === 'error',
-				$this->string_to_errorcode( $groupName . '_' . $match[1] ),
+				$code,
 				[ $var ]
 			);
 

WordPressVIPMinimum/Sniffs/Classes/DeclarationCompatibilitySniff.php

@@ -9,6 +9,8 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\AbstractScopeSniff;
+use PHPCSUtils\Utils\FunctionDeclarations;
+use PHPCSUtils\Utils\ObjectDeclarations;
 
 /**
  * Class WordPressVIPMinimum_Sniffs_Classes_DeclarationCompatibilitySniff
@@ -201,15 +203,15 @@ public function __construct() {
 	 */
 	protected function processTokenWithinScope( File $phpcsFile, $stackPtr, $currScope ) {
 
-		$className = $phpcsFile->getDeclarationName( $currScope );
+		$className = ObjectDeclarations::getName( $phpcsFile, $currScope );
 
 		if ( $className !== $this->currentClass ) {
 			$this->currentClass = $className;
 		}
 
-		$methodName = $phpcsFile->getDeclarationName( $stackPtr );
+		$methodName = FunctionDeclarations::getName( $phpcsFile, $stackPtr );
 
-		$parentClassName = $phpcsFile->findExtendedClassName( $currScope );
+		$parentClassName = ObjectDeclarations::findExtendedClassName( $phpcsFile, $currScope );
 		if ( $parentClassName === false ) {
 			// This class does not extend any other class.
 			return;
@@ -242,7 +244,7 @@ protected function processTokenWithinScope( File $phpcsFile, $stackPtr, $currSco
 			return;
 		}
 
-		$signatureParams = $phpcsFile->getMethodParameters( $stackPtr );
+		$signatureParams = FunctionDeclarations::getParameters( $phpcsFile, $stackPtr );
 
 		$parentSignature = $this->checkClasses[ $parentClassName ][ $methodName ];
 

WordPressVIPMinimum/Sniffs/Compatibility/ZoninatorSniff.php

@@ -8,8 +8,9 @@
 
 namespace WordPressVIPMinimum\Sniffs\Constants;
 
-use WordPressVIPMinimum\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Tokens;
+use PHPCSUtils\Utils\PassedParameters;
+use WordPressVIPMinimum\Sniffs\Sniff;
 
 /**
  * Sniff for properly using constant name when checking whether a constant is defined.
@@ -55,7 +56,7 @@ public function process_token( $stackPtr ) {
 			return;
 		}
 
-		$param = $this->get_function_call_parameter( $stackPtr, 1 );
+		$param = PassedParameters::getParameter( $this->phpcsFile, $stackPtr, 1, 'constant_name' );
 		if ( $param === false ) {
 			// Target parameter not found.
 			return;

WordPressVIPMinimum/Sniffs/Constants/ConstantStringSniff.php

@@ -9,6 +9,7 @@
 
 use WordPressVIPMinimum\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Tokens;
+use PHPCSUtils\BackCompat\BCFile;
 
 /**
  * Ensure that non-PHP files are included via `file_get_contents()` instead of using `include/require[_once]`.
@@ -59,7 +60,7 @@ public function register() {
 	 * @return void
 	 */
 	public function process_token( $stackPtr ) {
-		$end_of_statement = $this->phpcsFile->findEndOfStatement( $stackPtr );
+		$end_of_statement = BCFile::findEndOfStatement( $this->phpcsFile, $stackPtr );
 		$curStackPtr      = ( $end_of_statement + 1 );
 
 		do {