Merge pull request #1045 from WordPress-Coding-Standards/WPCS-0.13.0/…

…feature/phpcs-3.x-prep-getgroups-in-abstracts PHPCS 3.x prep: work round a function which will no longer exist
WordPress · Jul 22, 2017 · 99146fd · 99146fd
2 parents 1c4399f + b14688d
commit 99146fd
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 20 deletions.
diff --git a/WordPress/AbstractArrayAssignmentRestrictionsSniff.php b/WordPress/AbstractArrayAssignmentRestrictionsSniff.php
@@ -47,12 +47,26 @@ abstract class WordPress_AbstractArrayAssignmentRestrictionsSniff extends WordPr
 	 */
 	protected $excluded_groups = array();
 
+	/**
+	 * Cache for the group information.
+	 *
+	 * @since 0.13.0
+	 *
+	 * @var array
+	 */
+	protected $groups_cache = array();
+
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
 	 * @return array
 	 */
 	public function register() {
+		// Retrieve the groups only once and don't set up a listener if there are no groups.
+		if ( false === $this->setup_groups() ) {
+			return array();
+		}
+
 		return array(
 			T_DOUBLE_ARROW,
 			T_CLOSE_SQUARE_BRACKET,
@@ -80,6 +94,28 @@ public function register() {
 	 */
 	abstract public function getGroups();
 
+	/**
+	 * Cache the groups.
+	 *
+	 * @since 0.13.0
+	 *
+	 * @return bool True if the groups were setup. False if not.
+	 */
+	protected function setup_groups() {
+		$this->groups_cache = $this->getGroups();
+
+		if ( empty( $this->groups_cache ) && empty( self::$groups ) ) {
+			return false;
+		}
+
+		// Allow for adding extra unit tests.
+		if ( ! empty( self::$groups ) ) {
+			$this->groups_cache = array_merge( $this->groups_cache, self::$groups );
+		}
+
+		return true;
+	}
+
 	/**
 	 * Processes this test, when one of its tokens is encountered.
 	 *
@@ -89,15 +125,8 @@ abstract public function getGroups();
 	 */
 	public function process_token( $stackPtr ) {
 
-		$groups = $this->getGroups();
-
-		if ( empty( $groups ) ) {
-			$this->phpcsFile->removeTokenListener( $this, $this->register() );
-			return;
-		}
-
 		$this->excluded_groups = $this->merge_custom_array( $this->exclude );
-		if ( array_diff_key( $groups, $this->excluded_groups ) === array() ) {
+		if ( array_diff_key( $this->groups_cache, $this->excluded_groups ) === array() ) {
 			// All groups have been excluded.
 			// Don't remove the listener as the exclude property can be changed inline.
 			return;
@@ -149,7 +178,7 @@ public function process_token( $stackPtr ) {
 			return;
 		}
 
-		foreach ( $groups as $groupName => $group ) {
+		foreach ( $this->groups_cache as $groupName => $group ) {
 
 			if ( isset( $this->excluded_groups[ $groupName ] ) ) {
 				continue;

diff --git a/WordPress/AbstractVariableRestrictionsSniff.php b/WordPress/AbstractVariableRestrictionsSniff.php
@@ -48,12 +48,26 @@ abstract class WordPress_AbstractVariableRestrictionsSniff extends WordPress_Sni
 	 */
 	protected $excluded_groups = array();
 
+	/**
+	 * Cache for the group information.
+	 *
+	 * @since 0.13.0
+	 *
+	 * @var array
+	 */
+	protected $groups_cache = array();
+
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
 	 * @return array
 	 */
 	public function register() {
+		// Retrieve the groups only once and don't set up a listener if there are no groups.
+		if ( false === $this->setup_groups() ) {
+			return array();
+		}
+
 		return array(
 			T_VARIABLE,
 			T_OBJECT_OPERATOR,
@@ -84,6 +98,28 @@ public function register() {
 	 */
 	abstract public function getGroups();
 
+	/**
+	 * Cache the groups.
+	 *
+	 * @since 0.13.0
+	 *
+	 * @return bool True if the groups were setup. False if not.
+	 */
+	protected function setup_groups() {
+		$this->groups_cache = $this->getGroups();
+
+		if ( empty( $this->groups_cache ) && empty( self::$groups ) ) {
+			return false;
+		}
+
+		// Allow for adding extra unit tests.
+		if ( ! empty( self::$groups ) ) {
+			$this->groups_cache = array_merge( $this->groups_cache, self::$groups );
+		}
+
+		return true;
+	}
+
 	/**
 	 * Processes this test, when one of its tokens is encountered.
 	 *
@@ -94,16 +130,10 @@ abstract public function getGroups();
 	 */
 	public function process_token( $stackPtr ) {
 
-		$token  = $this->tokens[ $stackPtr ];
-		$groups = $this->getGroups();
-
-		if ( empty( $groups ) ) {
-			$this->phpcsFile->removeTokenListener( $this, $this->register() );
-			return;
-		}
+		$token = $this->tokens[ $stackPtr ];
 
 		$this->excluded_groups = $this->merge_custom_array( $this->exclude );
-		if ( array_diff_key( $groups, $this->excluded_groups ) === array() ) {
+		if ( array_diff_key( $this->groups_cache, $this->excluded_groups ) === array() ) {
 			// All groups have been excluded.
 			// Don't remove the listener as the exclude property can be changed inline.
 			return;
@@ -118,7 +148,7 @@ public function process_token( $stackPtr ) {
 			}
 		}
 
-		foreach ( $groups as $groupName => $group ) {
+		foreach ( $this->groups_cache as $groupName => $group ) {
 
 			if ( isset( $this->excluded_groups[ $groupName ] ) ) {
 				continue;

diff --git a/WordPress/Sniffs/Arrays/ArrayAssignmentRestrictionsSniff.php b/WordPress/Sniffs/Arrays/ArrayAssignmentRestrictionsSniff.php
@@ -38,7 +38,7 @@ class WordPress_Sniffs_Arrays_ArrayAssignmentRestrictionsSniff extends WordPress
 	 * @return array
 	 */
 	public function getGroups() {
-		return parent::$groups;
+		return array();
 	}
 
 	/**

diff --git a/WordPress/Sniffs/Variables/VariableRestrictionsSniff.php b/WordPress/Sniffs/Variables/VariableRestrictionsSniff.php
@@ -39,7 +39,7 @@ class WordPress_Sniffs_Variables_VariableRestrictionsSniff extends WordPress_Abs
 	 * @return array
 	 */
 	public function getGroups() {
-		return parent::$groups;
+		return array();
 	}
 
 } // End class.