Performance/TaxonomyMetaInOptions: extend AbstractFunctionParameterSniff

As things were, the determination of whether or not a `T_STRING` is a call to any of the global WP options  functions, was severely flawed.

By switching the sniff over to be based on the WordPressCS `AbstractFunctionParameterSniff` class, this flaw is mitigated.

Includes adding a slew of additional tests, some of which (line 8 - 13, line 50, 51) are specific to the flaw being addressed in this commit.

Additionally, the tests have been made more comprehensive and varied by:
* Testing against false positives for calls to methods or namespaced function calls (= the issue being addressed in this PR).
* Ensure function import `use` statements are not flagged. We're not interested in those.
* Safeguarding that function calls using PHP 5.6+ argument unpacking are not flagged.
* Safeguarding handling of PHP 8.0+ attribute class using the same name as a target function.
* Safeguarding that the functions are not flagged when used as a PHP 8.1+ first class callable.
* Adding tests with more variations:
    - Non-lowercase function call(s).
    - Fully qualified function calls.
    - Use PHP 7.3+ trailing comma's in a few function calls.
    - Comments in unexpected places.

Author: jrfnl

WordPressVIPMinimum/Sniffs/Performance/TaxonomyMetaInOptionsSniff.php

@@ -10,16 +10,18 @@
 namespace WordPressVIPMinimum\Sniffs\Performance;
 
 use PHP_CodeSniffer\Util\Tokens;
-use WordPressVIPMinimum\Sniffs\Sniff;
+use WordPressCS\WordPress\AbstractFunctionParameterSniff;
 
 /**
  * Restricts the implementation of taxonomy term meta via options.
  */
-class TaxonomyMetaInOptionsSniff extends Sniff {
+class TaxonomyMetaInOptionsSniff extends AbstractFunctionParameterSniff {
 
 	/**
 	 * List of options_ functions
 	 *
+	 * @deprecated 3.1.0 This property should never have been public.
+	 *
 	 * @var array<string>
 	 */
 	public $option_functions = [
@@ -45,27 +47,37 @@ class TaxonomyMetaInOptionsSniff extends Sniff {
 	];
 
 	/**
-	 * Returns an array of tokens this test wants to listen for.
+	 * The group name for this group of functions.
 	 *
-	 * @return array<int|string>
+	 * @var string
 	 */
-	public function register() {
-		return [ T_STRING ];
-	}
+	protected $group_name = 'option_functions';
 
 	/**
-	 * Process this test when one of its tokens is encountered
-	 *
-	 * @param int $stackPtr The position of the current token in the stack passed in $tokens.
+	 * Functions this sniff is looking for.
 	 *
-	 * @return void
+	 * @var array<string, true> Keys are the target functions, value irrelevant.
 	 */
-	public function process_token( $stackPtr ) {
+	protected $target_functions = [
+		'get_option'    => true,
+		'add_option'    => true,
+		'update_option' => true,
+		'delete_option' => true,
+	];
 
-		if ( in_array( $this->tokens[ $stackPtr ]['content'], $this->option_functions, true ) === false ) {
-			return;
-		}
 
+	/**
+	 * Process the parameters of a matched function.
+	 *
+	 * @param int    $stackPtr        The position of the current token in the stack.
+	 * @param string $group_name      The name of the group which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
+	 * @param array  $parameters      Array with information about the parameters.
+	 *
+	 * @return void
+	 */
+	public function process_parameters( $stackPtr, $group_name, $matched_content, $parameters ) {
 		$openBracket = $this->phpcsFile->findNext( Tokens::$emptyTokens, $stackPtr + 1, null, true );
 
 		if ( $this->tokens[ $openBracket ]['code'] !== T_OPEN_PARENTHESIS ) {

WordPressVIPMinimum/Tests/Performance/TaxonomyMetaInOptionsUnitTest.inc

@@ -1,8 +1,55 @@
 <?php
 
-get_option( "taxonomy_rating_$obj->term_id" ); // NOK.
-delete_option( "taxonomy_rating_{$obj->term_id}" ); // NOK.
-get_option( "taxonomy_rating_$tag_id" ); // NOK.
-update_option( 'taxonomy_rating_' . $category_id ); // NOK.
-get_option( "taxonomy_rating_{$cat_id}" ); // NOK.
-add_option( 'taxonomy_rating_' . $obj->term_id ); // NOK.
+/*
+ * Not the sniff target.
+ */
+use function add_option;
+
+my\ns\get_option( "taxonomy_rating_$tag_id" );
+$this->delete_option( "taxonomy_rating_$tag_id" );
+$this?->update_option( "taxonomy_rating_$tag_id" );
+MyClass::get_option( "taxonomy_rating_$tag_id", );
+echo DELETE_OPTION;
+namespace\add_option( "taxonomy_rating_$tag_id" );
+
+function &update_option() {}
+
+/*
+ * These should all be okay.
+ */
+// Incomplete function call, should be ignored by the sniff.
+$incorrect_but_ok = get_option();
+$incorrect_but_ok = update_option();
+
+// Ignore as undetermined.
+Get_Option( $option );
+\add_option( $obj->get_optionname() );
+update_option( OPTION_NAME, );
+\DELETE_OPTION( MyClass::$option_name );
+
+get_option(...$params); // PHP 5.6 argument unpacking, parameter value unknown.
+
+// Looks like a function call, but is a PHP 8.0+ class instantiation via an attribute.
+#[Get_Option('taxonomy_rating_')]
+function foo() {}
+
+array_walk($options, \update_option(...),); // PHP 8.1 first class callable.
+
+// Ignore as not touching taxonomy term patterns.
+\get_option( 'option_name' );
+add_option( 'option_' . $post_id, );
+update_Option( "prefix_{$setting}" );
+add_option( 'option_' . MY_CONSTANT, );
+add_option( 'foo_' . $obj->$propname );
+update_option( 'foo_' . $obj->page_id ); // NOK.
+
+
+/*
+ * These should all be flagged.
+ */
+get_option( "taxonomy_rating_$obj->term_id", ); // NOK.
+\delete_option( "taxonomy_rating_{$obj->term_id}" ); // NOK.
+get_option( /*comment*/ "taxonomy_rating_$tag_id" ); // NOK.
+UpDate_OPTION( 'taxonomy_rating_' . $category_id /*comment*/ , ); // NOK.
+\Get_Option( "taxonomy_rating_{$cat_id}" ); // NOK.
+add_option( 'taxonomy_rating_' . $obj->term_id ); // NOK.

WordPressVIPMinimum/Tests/Performance/TaxonomyMetaInOptionsUnitTest.php

@@ -32,12 +32,12 @@ public function getErrorList() {
 	 */
 	public function getWarningList() {
 		return [
-			3 => 1,
-			4 => 1,
-			5 => 1,
-			6 => 1,
-			7 => 1,
-			8 => 1,
+			50 => 1,
+			51 => 1,
+			52 => 1,
+			53 => 1,
+			54 => 1,
+			55 => 1,
 		];
 	}
 }