Skip to content

Commit b1018cb

Browse files
GaryJonesGaryJones
authored
Merge pull request #777 from Automattic/3.0/feature/start-using-phpcsutils
2 parents 05aa45a + 02888e6 commit b1018cb

17 files changed

+60
-29
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ When you introduce new `public` sniff properties, or your sniff extends a class
6464
### Pre-requisites
6565
* VIP Coding Standards
6666
* WordPress-Coding-Standards
67+
* PHPCSUtils 1.x
6768
* PHP_CodeSniffer 3.x
6869
* PHPUnit 4.x, 5.x, 6.x or 7.x
6970

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Use `php -v` and `composer show` to get versions.
4444
| ------------------------ | -------
4545
| PHP version | x.y.z
4646
| PHP_CodeSniffer version | x.y.z
47+
| PHPCSUtils version | x.y.z
4748
| VIPCS version | x.y.z
4849
| WordPressCS version | x.y.z
4950
| VariableAnalysis version | x.y.z

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Go to https://docs.wpvip.com/technical-references/code-review/phpcs-report/ to l
1717

1818
* PHP 5.4+
1919
* [PHPCS 3.7.1+](https://github.com/squizlabs/PHP_CodeSniffer/releases)
20+
* [PHPCSUtils 1.0.8+](https://github.com/PHPCSStandards/PHPCSUtils)
2021
* [WPCS 2.3.0+](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/releases)
2122
* [VariableAnalysis 2.11.17+](https://github.com/sirbrillig/phpcs-variable-analysis/releases)
2223

@@ -34,7 +35,7 @@ composer g config allow-plugins.dealerdirect/phpcodesniffer-composer-installer t
3435
composer g require automattic/vipwpcs
3536
```
3637

37-
This will install the latest compatible versions of PHPCS, WPCS and VariableAnalysis and register the external standards with PHP_CodeSniffer.
38+
This will install the latest compatible versions of PHPCS, PHPCSUtils, WPCS and VariableAnalysis and register the external standards with PHP_CodeSniffer.
3839

3940
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.
4041

‎WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99

1010
namespace WordPressVIPMinimum\Sniffs;
1111

12-
use WordPressVIPMinimum\Sniffs\Sniff;
12+
use PHPCSUtils\Utils\GetTokensAsString;
13+
use PHPCSUtils\Utils\MessageHelper;
1314

1415
/**
1516
* Restricts usage of some variables.
@@ -179,7 +180,7 @@ public function process_token( $stackPtr ) {
179180

180181
if ( isset( $token['bracket_closer'] ) ) {
181182
$owner = $this->phpcsFile->findPrevious( \T_VARIABLE, $stackPtr );
182-
$inside = $this->phpcsFile->getTokensAsString( $stackPtr, $token['bracket_closer'] - $stackPtr + 1 );
183+
$inside = GetTokensAsString::normal( $this->phpcsFile, $stackPtr, $token['bracket_closer'] );
183184
$var = implode( '', [ $this->tokens[ $owner ]['content'], $inside ] );
184185
}
185186
}
@@ -200,11 +201,13 @@ public function process_token( $stackPtr ) {
200201
continue;
201202
}
202203

203-
$this->addMessage(
204+
$code = MessageHelper::stringToErrorcode( $groupName . '_' . $match[1] );
205+
MessageHelper::addMessage(
206+
$this->phpcsFile,
204207
$group['message'],
205208
$stackPtr,
206209
$group['type'] === 'error',
207-
$this->string_to_errorcode( $groupName . '_' . $match[1] ),
210+
$code,
208211
[ $var ]
209212
);
210213

‎WordPressVIPMinimum/Sniffs/Classes/DeclarationCompatibilitySniff.php‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010
use PHP_CodeSniffer\Files\File;
1111
use PHP_CodeSniffer\Sniffs\AbstractScopeSniff;
12+
use PHPCSUtils\Utils\FunctionDeclarations;
13+
use PHPCSUtils\Utils\ObjectDeclarations;
1214

1315
/**
1416
* Class WordPressVIPMinimum_Sniffs_Classes_DeclarationCompatibilitySniff
@@ -201,15 +203,15 @@ public function __construct() {
201203
*/
202204
protected function processTokenWithinScope( File $phpcsFile, $stackPtr, $currScope ) {
203205

204-
$className = $phpcsFile->getDeclarationName( $currScope );
206+
$className = ObjectDeclarations::getName( $phpcsFile, $currScope );
205207

206208
if ( $className !== $this->currentClass ) {
207209
$this->currentClass = $className;
208210
}
209211

210-
$methodName = $phpcsFile->getDeclarationName( $stackPtr );
212+
$methodName = FunctionDeclarations::getName( $phpcsFile, $stackPtr );
211213

212-
$parentClassName = $phpcsFile->findExtendedClassName( $currScope );
214+
$parentClassName = ObjectDeclarations::findExtendedClassName( $phpcsFile, $currScope );
213215
if ( $parentClassName === false ) {
214216
// This class does not extend any other class.
215217
return;
@@ -242,7 +244,7 @@ protected function processTokenWithinScope( File $phpcsFile, $stackPtr, $currSco
242244
return;
243245
}
244246

245-
$signatureParams = $phpcsFile->getMethodParameters( $stackPtr );
247+
$signatureParams = FunctionDeclarations::getParameters( $phpcsFile, $stackPtr );
246248

247249
$parentSignature = $this->checkClasses[ $parentClassName ][ $methodName ];
248250

‎WordPressVIPMinimum/Sniffs/Constants/ConstantStringSniff.php‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@
88

99
namespace WordPressVIPMinimum\Sniffs\Constants;
1010

11-
use WordPressVIPMinimum\Sniffs\Sniff;
1211
use PHP_CodeSniffer\Util\Tokens;
12+
use PHPCSUtils\Utils\PassedParameters;
13+
use WordPressVIPMinimum\Sniffs\Sniff;
1314

1415
/**
1516
* Sniff for properly using constant name when checking whether a constant is defined.
@@ -55,7 +56,7 @@ public function process_token( $stackPtr ) {
5556
return;
5657
}
5758

58-
$param = $this->get_function_call_parameter( $stackPtr, 1 );
59+
$param = PassedParameters::getParameter( $this->phpcsFile, $stackPtr, 1, 'constant_name' );
5960
if ( $param === false ) {
6061
// Target parameter not found.
6162
return;

‎WordPressVIPMinimum/Sniffs/Files/IncludingNonPHPFileSniff.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
use WordPressVIPMinimum\Sniffs\Sniff;
1111
use PHP_CodeSniffer\Util\Tokens;
12+
use PHPCSUtils\BackCompat\BCFile;
1213

1314
/**
1415
* Ensure that non-PHP files are included via `file_get_contents()` instead of using `include/require[_once]`.
@@ -59,7 +60,7 @@ public function register() {
5960
* @return void
6061
*/
6162
public function process_token( $stackPtr ) {
62-
$end_of_statement = $this->phpcsFile->findEndOfStatement( $stackPtr );
63+
$end_of_statement = BCFile::findEndOfStatement( $this->phpcsFile, $stackPtr );
6364
$curStackPtr = ( $end_of_statement + 1 );
6465

6566
do {

‎WordPressVIPMinimum/Sniffs/Functions/DynamicCallsSniff.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
namespace WordPressVIPMinimum\Sniffs\Functions;
99

1010
use PHP_CodeSniffer\Util\Tokens;
11+
use PHPCSUtils\Utils\TextStrings;
1112
use WordPressVIPMinimum\Sniffs\Sniff;
1213

1314
/**
@@ -139,7 +140,7 @@ private function collect_variables() {
139140
* If we reached the end of the loop and the $value_ptr was set, we know for sure
140141
* this was a plain text string variable assignment.
141142
*/
142-
$current_var_value = $this->strip_quotes( $this->tokens[ $value_ptr ]['content'] );
143+
$current_var_value = TextStrings::stripQuotes( $this->tokens[ $value_ptr ]['content'] );
143144

144145
if ( isset( $this->disallowed_functions[ $current_var_value ] ) === false ) {
145146
// Text string is not one of the ones we're looking for.

‎WordPressVIPMinimum/Sniffs/Hooks/AlwaysReturnInFilterSniff.php‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77

88
namespace WordPressVIPMinimum\Sniffs\Hooks;
99

10-
use WordPressVIPMinimum\Sniffs\Sniff;
1110
use PHP_CodeSniffer\Util\Tokens;
11+
use PHPCSUtils\Utils\Arrays;
12+
use PHPCSUtils\Utils\FunctionDeclarations;
13+
use WordPressVIPMinimum\Sniffs\Sniff;
1214

1315
/**
1416
* This sniff validates that filters always return a value
@@ -96,7 +98,7 @@ public function process_token( $stackPtr ) {
9698
*/
9799
private function processArray( $stackPtr ) {
98100

99-
$open_close = $this->find_array_open_close( $stackPtr );
101+
$open_close = Arrays::getOpenClose( $this->phpcsFile, $stackPtr );
100102
if ( $open_close === false ) {
101103
return;
102104
}
@@ -185,7 +187,7 @@ private function processFunctionBody( $stackPtr ) {
185187

186188
$filterName = $this->tokens[ $this->filterNamePtr ]['content'];
187189

188-
$methodProps = $this->phpcsFile->getMethodProperties( $stackPtr );
190+
$methodProps = FunctionDeclarations::getProperties( $this->phpcsFile, $stackPtr );
189191
if ( $methodProps['is_abstract'] === true ) {
190192
$message = 'The callback for the `%s` filter hook-in points to an abstract method. Please ensure that child class implementations of this method always return a value.';
191193
$data = [ $filterName ];

‎WordPressVIPMinimum/Sniffs/Hooks/PreGetPostsSniff.php‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@
77

88
namespace WordPressVIPMinimum\Sniffs\Hooks;
99

10-
use WordPressVIPMinimum\Sniffs\Sniff;
1110
use PHP_CodeSniffer\Util\Tokens;
11+
use PHPCSUtils\Utils\Arrays;
12+
use WordPressVIPMinimum\Sniffs\Sniff;
1213

1314
/**
1415
* This sniff validates a proper usage of pre_get_posts action callback.
@@ -97,7 +98,7 @@ public function process_token( $stackPtr ) {
9798
*/
9899
private function processArray( $stackPtr ) {
99100

100-
$open_close = $this->find_array_open_close( $stackPtr );
101+
$open_close = Arrays::getOpenClose( $this->phpcsFile, $stackPtr );
101102
if ( $open_close === false ) {
102103
return;
103104
}

0 commit comments

Comments
 (0)