Skip to content

Commit

Permalink
Improve code quality and compatible with phpcs 3.x
Browse files Browse the repository at this point in the history
  • Loading branch information
@emgk
emgk committed Jul 27, 2017
1 parent 2106c46 commit b3d04e1
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 57 deletions.
85 changes: 29 additions & 56 deletions WordPress/Sniffs/VIP/SuppressFiltersSniff.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@
* @license https://opensource.org/licenses/MIT MIT
*/

namespace WordPress\Sniffs\VIP;

use WordPress\AbstractFunctionParameterSniff;
use PHP_CodeSniffer_Tokens as Tokens;

/**
* Checks for suppress_filters=>false being supplied in get_posts(), wp_get_recent_posts() and get_children().
*
Expand All @@ -16,7 +21,7 @@
*
* @since 0.14.0
*/
class WordPress_Sniffs_VIP_SuppressFiltersSniff extends WordPress_AbstractFunctionParameterSniff {
class SuppressFiltersSniff extends AbstractFunctionParameterSniff {

/**
* Functions this sniff is looking for.
Expand All @@ -36,10 +41,10 @@ class WordPress_Sniffs_VIP_SuppressFiltersSniff extends WordPress_AbstractFuncti
*
* @since 0.14.0
*
* @param int $stackPtr The position of the current token in the stack.
* @param array $group_name The name of the group which was matched.
* @param int $stackPtr The position of the current token in the stack.
* @param array $group_name The name of the group which was matched.
* @param string $matched_content The token content (function name) which was matched.
* @param array $parameters Array with information about the parameters.
* @param array $parameters Array with information about the parameters.
*
* @return void
*/
Expand All @@ -54,14 +59,10 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
$arrayValue = '';

// Retrieve the value parameter's details.
$argumentData = $this->phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, $parameters[1]['start'], ( $parameters[1]['end'] + 1 ), true );

/**
* When the list of argument were passed through variable.
*
* eg. $args = array( 'foo' => 'bar' );
* $args['foo'] => 'bar';
*/
$argumentData = $this->phpcsFile->findNext( Tokens::$emptyTokens, $parameters[1]['start'], ( $parameters[1]['end'] + 1 ), true );

// When the list of argument were passed through variable.
// eg. $args = array( 'foo' => 'bar' ), $args['foo'] => 'bar'.
if ( T_VARIABLE === $this->tokens[ $argumentData ]['code'] ) {

// Get the function in which the code placed.
Expand All @@ -81,60 +82,44 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p

if ( $this->tokens[ $i ]['content'] === $this->tokens[ $argumentData ]['content'] ) {

// Move to the next pointer where '=>' or ']' is placed;
$varData = $this->phpcsFile->findNext( array( T_CLOSE_SQUARE_BRACKET, T_DOUBLE_ARROW, T_ARRAY, T_OPEN_SHORT_ARRAY ), $i );
// Move to the next pointer where '=>' or ']' is placed.
$varData = $this->phpcsFile->findNext( array( T_CLOSE_SQUARE_BRACKET, T_DOUBLE_ARROW, T_ARRAY, T_OPEN_SHORT_ARRAY ), $i );

if ( in_array( $this->tokens[ $varData ]['code'], array( T_CLOSE_SQUARE_BRACKET, T_DOUBLE_ARROW ), true ) ) {
if ( in_array( $this->tokens[ $varData ]['code'], array( T_CLOSE_SQUARE_BRACKET, T_DOUBLE_ARROW ),true ) ) {

$operator = $varData; // T_DOUBLE_ARROW.

if ( T_CLOSE_SQUARE_BRACKET === $this->tokens[ $varData ]['code'] ) {

if ( T_CLOSE_SQUARE_BRACKET === $this->tokens[ $varData ]['code'] ) {
$operator = $this->phpcsFile->findNext( T_EQUAL, ( $varData ) );
}

$keyIdx = $this->phpcsFile->findPrevious( array( T_WHITESPACE, T_CLOSE_SQUARE_BRACKET ), ( $operator -1 ), null, true );
$keyIdx = $this->phpcsFile->findPrevious( array( T_WHITESPACE, T_CLOSE_SQUARE_BRACKET ), ( $operator - 1 ),null,true );

if ( ! is_numeric( $this->tokens[ $keyIdx ]['content'] ) ) {

$key = $this->strip_quotes( $this->tokens[ $keyIdx ]['content'] );
$valStart = $this->phpcsFile->findNext( array( T_WHITESPACE ), ( $operator + 1 ), null, true );
$valEnd = $this->phpcsFile->findNext( array( T_COMMA, T_SEMICOLON ), ( $valStart + 1 ), null, false, null, true );
$val = $this->phpcsFile->getTokensAsString( $valStart, ( $valEnd - $valStart ) );
$val = $this->strip_quotes( $val );
$arrayValue = $val;

}

} else if ( in_array( $this->tokens[ $varData ]['code'], array( T_ARRAY, T_OPEN_SHORT_ARRAY ), true ) ) {

} elseif ( in_array( $this->tokens[ $varData ]['code'], array( T_ARRAY, T_OPEN_SHORT_ARRAY ), true ) ) {
// Store array data into variable so that we can proceed later.
$paramItems = $this->get_function_call_parameters( $varData );

}

}
}
}
} elseif ( T_ARRAY === $this->tokens[ $argumentData ]['code'] || T_OPEN_SHORT_ARRAY === $this->tokens[ $argumentData ]['code'] ) {

} else if ( T_ARRAY === $this->tokens[ $argumentData ]['code'] || T_OPEN_SHORT_ARRAY === $this->tokens[ $argumentData ]['code'] ) {

/**
* It covers multiple array variable directly passed to function.
*
* eg. get_posts( array( 'foo' => 'bar', 'baz' => 'quux' ) )
*/
// It covers multiple array variable directly passed to function.
// eg. get_posts( array( 'foo' => 'bar', 'baz' => 'quux' ) ).
$paramItems = $this->get_function_call_parameters( $argumentData );

} elseif ( T_CONSTANT_ENCAPSED_STRING === $this->tokens[ $argumentData ]['code'] || T_DOUBLE_QUOTED_STRING === $this->tokens[ $argumentData ]['code'] ) {

} else if ( T_CONSTANT_ENCAPSED_STRING === $this->tokens[ $argumentData ]['code'] || T_DOUBLE_QUOTED_STRING === $this->tokens[ $argumentData ]['code'] ) {

/**
* It handles when key value comes in '&query=arg' format.
*
* eg. get_posts( 'foo=bar&baz=quux' );
*/

// It handles when key value comes in '&query=arg' format.
// eg. get_posts( 'foo=bar&baz=quux' ).
if ( preg_match_all( '#(?:^|&)([a-z_]+)=([^&]*)#i', $this->strip_quotes( $this->tokens[ $argumentData ]['content'] ), $arrKey ) <= 0 ) {
return;
}
Expand All @@ -146,9 +131,7 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
$isUsed = true;
$arrayValue = $arrKey[2][ $i ];
}

}

}

// Process multi dimensional array.
Expand All @@ -166,24 +149,17 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
// '=>' detected.
if ( T_DOUBLE_ARROW === $this->tokens[ $ptr ]['code'] ) {

$acceptType = array( T_DOUBLE_QUOTED_STRING ,T_CONSTANT_ENCAPSED_STRING, T_BOOL_CAST, T_INT_CAST );

$keyValue = $this->phpcsFile->findNext( $acceptType, $ptr+1 );

if ( in_array( $this->tokens[$keyValue]['code'], $acceptType,true ) ) {
$acceptType = array( T_DOUBLE_QUOTED_STRING, T_CONSTANT_ENCAPSED_STRING, T_BOOL_CAST, T_INT_CAST );
$keyValue = $this->phpcsFile->findNext( $acceptType, $ptr + 1 );

if ( in_array( $this->tokens[ $keyValue ]['code'], $acceptType,true ) ) {
$isUsed = true;
$arrayValue = $this->strip_quotes( $this->tokens[$keyValue]['content'] );
$arrayValue = $this->strip_quotes( $this->tokens[ $keyValue ]['content'] );
}

}

}

}

}

}

// If so, expected value was not passed.
Expand All @@ -202,9 +178,6 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
);
}
}

return;

}

} // End class.
6 changes: 5 additions & 1 deletion WordPress/Tests/VIP/SuppressFiltersUnitTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@
* @license https://opensource.org/licenses/MIT MIT
*/

namespace WordPress\Tests\VIP;

use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;

/**
* Unit test class for the SuppressFilters sniff.
*
* @package WPCS\WordPressCodingStandards
* @since 0.14.0
*/
class WordPress_Tests_VIP_SuppressFiltersTest extends AbstractSniffUnitTest {
class SuppressFiltersUnitTest extends AbstractSniffUnitTest {

/**
* Returns the lines where errors should occur.
Expand Down

0 comments on commit b3d04e1

Please sign in to comment.