Functions/DynamicCalls: bug fix - don't blindly use the next text string

A variable value may be build up of multiple tokens.

As it was, the sniff would look for the first text string token after the equal sign within the variable assignment statement, but this disregards that:
1. The text string token found may not be the only token in the statement.
2. A statement can end on a PHP close tag (possibly a bug in PHPCS itself, but that's another matter), which would lead the sniff to look at the next statement for text strings.

Fixed now.

Includes unit tests, the first four of which resulted in false positives previously.

Author: jrfnl

WordPressVIPMinimum/Sniffs/Functions/DynamicCallsSniff.php

@@ -112,26 +112,36 @@ private function collect_variables() {
 		}
 
 		/*
-		 * Find encapsulated string ( "" ).
+		 * Find assignments which only assign a plain text string.
 		 */
-		$t_item_key = $this->phpcsFile->findNext(
-			[ T_CONSTANT_ENCAPSED_STRING ],
-			$t_item_key + 1,
-			null,
-			false,
-			null,
-			true
-		);
+		$end_of_statement = $this->phpcsFile->findNext( [ T_SEMICOLON, T_CLOSE_TAG ], ( $t_item_key + 1 ) );
+		$value_ptr        = null;
+
+		for ( $i = $t_item_key + 1; $i < $end_of_statement; $i++ ) {
+			if ( isset( Tokens::$emptyTokens[ $this->tokens[ $i ]['code'] ] ) === true ) {
+				continue;
+			}
+
+			if ( $this->tokens[ $i ]['code'] !== T_CONSTANT_ENCAPSED_STRING ) {
+				// Not a plain text string value. Value cannot be determined reliably.
+				return;
+			}
+
+			$value_ptr = $i;
+		}
 
-		if ( $t_item_key === false ) {
+		if ( isset( $value_ptr ) === false ) {
+			// Parse error. Bow out.
 			return;
 		}
 
 		/*
-		 * We have found variable-assignment, register its name and value in the
-		 * internal array for later usage.
+		 * If we reached the end of the loop and the $value_ptr was set, we know for sure
+		 * this was a plain text string variable assignment.
+		 *
+		 * Register its name and value in the internal array for later usage.
 		 */
-		$current_var_value = $this->tokens[ $t_item_key ]['content'];
+		$current_var_value = $this->tokens[ $value_ptr ]['content'];
 
 		$this->variables_arr[ $current_var_name ] = str_replace( "'", '', $current_var_value );
 	}

WordPressVIPMinimum/Tests/Functions/DynamicCallsUnitTest.inc

@@ -13,3 +13,20 @@ $my_okay_func(); // OK.
 
 $test_with_comment /*comment*/ = 'func_get_args';
 $test_with_comment(); // Bad.
+
+$test_getting_the_actual_value_1 = function_call( 'extract' );
+$test_getting_the_actual_value_1(); // OK. Unclear what the actual variable value will be.
+
+$test_getting_the_actual_value_2 = $array['compact'];
+$test_getting_the_actual_value_2(); // OK. Unclear what the actual variable value will be.
+
+$test_getting_the_actual_value_3 = 10 ?>
+<div>html</div>
+<?php
+echo 'extract';
+$test_getting_the_actual_value_3(); // OK. Broken function call, but not calling extract().
+
+$test_getting_the_actual_value_4 = 'get_defined_vars' . $source;
+$test_getting_the_actual_value_4(); // OK. Unclear what the actual variable value will be.
+
+$ensure_no_notices_are_thrown_on_parse_error = /*comment*/ ;