-
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #269 from PHPCSStandards/passedparameters/add-new-…
…isshortarray-param PassedParameters::[has|get]Parameters(): add new, optional `$isShortArray` parameter
- Loading branch information
Showing
3 changed files
with
238 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 19 additions & 0 deletions
19
Tests/Utils/PassedParameters/GetParametersSkipShortArrayCheckTest.inc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| <?php | ||
|
|
||
| /* testNoParams */ | ||
| $foo = []; | ||
|
|
||
| /* testLongArray */ | ||
| $foo = array( 1, 2 ); | ||
|
|
||
| /* testShortArray */ | ||
| $foo = [ 'a' => 1, 'b' => 2 ]; | ||
|
|
||
| /* testShortList */ | ||
| [ 'a' => 1, 'b' => 2 ] = $array; | ||
|
|
||
| /* testArrayAssign */ | ||
| $array[] = 'foo'; | ||
|
|
||
| /* testArrayAccess */ | ||
| $foo = $array[$keys['key']]; |
197 changes: 197 additions & 0 deletions
197
Tests/Utils/PassedParameters/GetParametersSkipShortArrayCheckTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| <?php | ||
| /** | ||
| * PHPCSUtils, utility functions and classes for PHP_CodeSniffer sniff developers. | ||
| * | ||
| * @package PHPCSUtils | ||
| * @copyright 2019-2020 PHPCSUtils Contributors | ||
| * @license https://opensource.org/licenses/LGPL-3.0 LGPL3 | ||
| * @link https://github.com/PHPCSStandards/PHPCSUtils | ||
| */ | ||
|
|
||
| namespace PHPCSUtils\Tests\Utils\PassedParameters; | ||
|
|
||
| use PHPCSUtils\TestUtils\UtilityMethodTestCase; | ||
| use PHPCSUtils\Utils\PassedParameters; | ||
|
|
||
| /** | ||
| * Tests for the \PHPCSUtils\Utils\PassedParameters::hasParameters() and | ||
| * the \PHPCSUtils\Utils\PassedParameters::getParameters() methods for | ||
| * when the $isShortArray parameter has been passed. | ||
| * | ||
| * @covers \PHPCSUtils\Utils\PassedParameters::hasParameters | ||
| * @covers \PHPCSUtils\Utils\PassedParameters::getParameters | ||
| * | ||
| * @group passedparameters | ||
| * | ||
| * @since 1.0.0 | ||
| */ | ||
| class GetParametersSkipShortArrayCheckTest extends UtilityMethodTestCase | ||
| { | ||
|
|
||
| /** | ||
| * Test receiving an expected exception when passed an invalid (non short array) token when the | ||
| * `$isShortArray` parameter is NOT passed (or not set to true). | ||
| * | ||
| * Also verify that for valid constructs, the method still behaves like normal. | ||
| * | ||
| * @dataProvider dataTestCases | ||
| * | ||
| * @param string $testMarker The comment which prefaces the target token in the test file. | ||
| * @param int|string $targetType The type of token to look for. | ||
| * @param bool $expectException Whether or not to expect an exception. | ||
| * | ||
| * @return void | ||
| */ | ||
| public function testHasParametersDontSkipShortArrayCheck($testMarker, $targetType, $expectException) | ||
| { | ||
| if ($expectException === true) { | ||
| $this->expectPhpcsException( | ||
| 'The hasParameters() method expects a function call, array, isset or unset token to be passed.' | ||
| ); | ||
| } | ||
|
|
||
| $target = $this->getTargetToken($testMarker, [$targetType]); | ||
| $hasParams = PassedParameters::hasParameters(self::$phpcsFile, $target); | ||
|
|
||
| if ($expectException === false) { | ||
| if (\method_exists($this, 'assertIsBool') === true) { | ||
| // PHPUnit 7.5+. | ||
| $this->assertIsBool($hasParams); | ||
| } else { | ||
| // PHPUnit < 7.5. | ||
| $this->assertInternalType('bool', $hasParams); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Test retrieving the parameter details for valid and invalid constructs when the | ||
| * `$isShortArray` parameter is set to TRUE. | ||
| * | ||
| * @dataProvider dataTestCases | ||
| * | ||
| * @param string $testMarker The comment which prefaces the target token in the test file. | ||
| * @param int|string $targetType The type of token to look for. | ||
| * @param bool $ignore Not used in this test. | ||
| * @param array $expected The expected return value. | ||
| * | ||
| * @return void | ||
| */ | ||
| public function testGetParametersSkipShortArrayCheck($testMarker, $targetType, $ignore, $expected) | ||
| { | ||
| $stackPtr = $this->getTargetToken($testMarker, [$targetType]); | ||
| $result = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, 0, true); | ||
|
|
||
| if (\method_exists($this, 'assertIsArray') === true) { | ||
| // PHPUnit 7.5+. | ||
| $this->assertIsArray($result); | ||
| } else { | ||
| // PHPUnit < 7.5. | ||
| $this->assertInternalType('array', $result); | ||
| } | ||
|
|
||
| // Start/end token position values in the expected array are set as offsets | ||
| // in relation to the target token. | ||
| // Change these to exact positions based on the retrieved stackPtr. | ||
| foreach ($expected as $key => $value) { | ||
| $expected[$key]['start'] = ($stackPtr + $value['start']); | ||
| $expected[$key]['end'] = ($stackPtr + $value['end']); | ||
| } | ||
|
|
||
| foreach ($result as $key => $value) { | ||
| // The GetTokensAsString functions have their own tests, no need to duplicate it here. | ||
| unset($result[$key]['clean']); | ||
| } | ||
|
|
||
| $this->assertSame($expected, $result); | ||
| } | ||
|
|
||
| /** | ||
| * Data provider. | ||
| * | ||
| * @see testGetParametersSkipShortArrayCheck() For the array format. | ||
| * @see testHasParametersDontSkipShortArrayCheck() For the array format. | ||
| * | ||
| * @return array | ||
| */ | ||
| public function dataTestCases() | ||
| { | ||
| return [ | ||
| 'no-params' => [ | ||
| '/* testNoParams */', | ||
| \T_OPEN_SHORT_ARRAY, | ||
| false, | ||
| [], | ||
| ], | ||
| 'long-array' => [ | ||
| '/* testLongArray */', | ||
| \T_ARRAY, | ||
| false, | ||
| [ | ||
| 1 => [ | ||
| 'start' => 2, | ||
| 'end' => 3, | ||
| 'raw' => '1', | ||
| ], | ||
| 2 => [ | ||
| 'start' => 5, | ||
| 'end' => 7, | ||
| 'raw' => '2', | ||
| ], | ||
| ], | ||
| ], | ||
| 'short-array' => [ | ||
| '/* testShortArray */', | ||
| \T_OPEN_SHORT_ARRAY, | ||
| false, | ||
| [ | ||
| 1 => [ | ||
| 'start' => 1, | ||
| 'end' => 6, | ||
| 'raw' => "'a' => 1", | ||
| ], | ||
| 2 => [ | ||
| 'start' => 8, | ||
| 'end' => 14, | ||
| 'raw' => "'b' => 2", | ||
| ], | ||
| ], | ||
| ], | ||
| 'short-list' => [ | ||
| '/* testShortList */', | ||
| \T_OPEN_SHORT_ARRAY, | ||
| true, | ||
| [ | ||
| 1 => [ | ||
| 'start' => 1, | ||
| 'end' => 6, | ||
| 'raw' => "'a' => 1", | ||
| ], | ||
| 2 => [ | ||
| 'start' => 8, | ||
| 'end' => 14, | ||
| 'raw' => "'b' => 2", | ||
| ], | ||
| ], | ||
| ], | ||
| 'array-assign' => [ | ||
| '/* testArrayAssign */', | ||
| \T_OPEN_SQUARE_BRACKET, | ||
| true, | ||
| [], | ||
| ], | ||
| 'array-access' => [ | ||
| '/* testArrayAccess */', | ||
| \T_OPEN_SQUARE_BRACKET, | ||
| true, | ||
| [ | ||
| 1 => [ | ||
| 'start' => 1, | ||
| 'end' => 4, | ||
| 'raw' => '$keys[\'key\']', | ||
| ], | ||
| ], | ||
| ], | ||
| ]; | ||
| } | ||
| } |