-
-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Tests/Tokenizer/EnumCaseTest: split the test class
... into two test classes, one targetting the `Tokenizer\PHP` class, one targetting the `Tokenizer\Tokenizer` class. While this does mean there is now some duplication between these test classes, I don't think that's problematic. It also allows for these tests to diverge based on the specific test needs for each of the classes under test.
- Loading branch information
Showing
4 changed files
with
260 additions
and
11 deletions.
There are no files selected for viewing
File renamed without changes.
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
95 changes: 95 additions & 0 deletions
95
tests/Core/Tokenizer/Tokenizer/RecurseScopeMapCaseKeywordConditionsTest.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,95 @@ | ||
| <?php | ||
|
|
||
| enum Foo | ||
| { | ||
| /* testPureEnumCase */ | ||
| case SOME_CASE; | ||
| } | ||
|
|
||
| enum Boo: int { | ||
| /* testBackingIntegerEnumCase */ | ||
| case ONE = 1; | ||
| } | ||
|
|
||
| enum Hoo: string | ||
| { | ||
| /* testBackingStringEnumCase */ | ||
| case ONE = 'one'; | ||
| } | ||
|
|
||
| enum ComplexEnum: int implements SomeInterface | ||
| { | ||
| use SomeTrait { | ||
| traitMethod as enumMethod; | ||
| } | ||
|
|
||
| const SOME_CONSTANT = true; | ||
|
|
||
| /* testEnumCaseInComplexEnum */ | ||
| case ONE = 1; | ||
|
|
||
| /* testEnumCaseIsCaseInsensitive */ | ||
| CaSe TWO = 2; | ||
|
|
||
| public function someMethod(): bool | ||
| { | ||
| switch (true) { | ||
| /* testCaseWithSemicolonIsNotEnumCase */ | ||
| case CONSTANT; | ||
| } | ||
| } | ||
|
|
||
| /* testEnumCaseAfterSwitch */ | ||
| case THREE = 3; | ||
|
|
||
| public function someOtherMethod(): bool | ||
| { | ||
| switch (true): | ||
| case false: | ||
| endswitch; | ||
| } | ||
|
|
||
| /* testEnumCaseAfterSwitchWithEndSwitch */ | ||
| case FOUR = 4; | ||
| } | ||
|
|
||
| switch (true) { | ||
| /* testCaseWithConstantIsNotEnumCase */ | ||
| case CONSTANT: | ||
| /* testCaseWithConstantAndIdenticalIsNotEnumCase */ | ||
| case CONSTANT === 1: | ||
| /* testCaseWithAssigmentToConstantIsNotEnumCase */ | ||
| case CONSTANT = 1: | ||
| /* testIsNotEnumCaseIsCaseInsensitive */ | ||
| cAsE CONSTANT: | ||
| } | ||
|
|
||
| switch ($x) { | ||
| /* testCaseInSwitchWhenCreatingEnumInSwitch1 */ | ||
| case 'a': { | ||
| enum Foo {} | ||
| break; | ||
| } | ||
|
|
||
| /* testCaseInSwitchWhenCreatingEnumInSwitch2 */ | ||
| case 'b'; | ||
| enum Bar {} | ||
| break; | ||
| } | ||
|
|
||
| enum Foo: string { | ||
| /* testKeywordAsEnumCaseNameShouldBeString1 */ | ||
| case INTERFACE = 'interface'; | ||
| /* testKeywordAsEnumCaseNameShouldBeString2 */ | ||
| case TRAIT = 'trait'; | ||
| /* testKeywordAsEnumCaseNameShouldBeString3 */ | ||
| case ENUM = 'enum'; | ||
| /* testKeywordAsEnumCaseNameShouldBeString4 */ | ||
| case FUNCTION = 'function'; | ||
| /* testKeywordAsEnumCaseNameShouldBeString5 */ | ||
| case FALSE = 'false'; | ||
| /* testKeywordAsEnumCaseNameShouldBeString6 */ | ||
| case DEFAULT = 'default'; | ||
| /* testKeywordAsEnumCaseNameShouldBeString7 */ | ||
| case ARRAY = 'array'; | ||
| } |
162 changes: 162 additions & 0 deletions
162
tests/Core/Tokenizer/Tokenizer/RecurseScopeMapCaseKeywordConditionsTest.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,162 @@ | ||
| <?php | ||
| /** | ||
| * Tests converting enum "case" to T_ENUM_CASE. | ||
| * | ||
| * @author Jaroslav Hanslík <kukulich@kukulich.cz> | ||
| * @copyright 2021 Squiz Pty Ltd (ABN 77 084 670 600) | ||
| * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence | ||
| */ | ||
|
|
||
| namespace PHP_CodeSniffer\Tests\Core\Tokenizer\Tokenizer; | ||
|
|
||
| use PHP_CodeSniffer\Tests\Core\Tokenizer\AbstractTokenizerTestCase; | ||
|
|
||
| final class RecurseScopeMapCaseKeywordConditionsTest extends AbstractTokenizerTestCase | ||
| { | ||
|
|
||
|
|
||
| /** | ||
| * Test that the enum "case" is converted to T_ENUM_CASE. | ||
| * | ||
| * @param string $testMarker The comment which prefaces the target token in the test file. | ||
| * | ||
| * @dataProvider dataEnumCases | ||
| * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap | ||
| * | ||
| * @return void | ||
| */ | ||
| public function testEnumCases($testMarker) | ||
| { | ||
| $tokens = $this->phpcsFile->getTokens(); | ||
| $enumCase = $this->getTargetToken($testMarker, [T_ENUM_CASE, T_CASE]); | ||
| $tokenArray = $tokens[$enumCase]; | ||
|
|
||
| // Make sure we're looking at the right token. | ||
| $this->assertSame(T_ENUM_CASE, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_ENUM_CASE (code)'); | ||
|
|
||
| $this->assertArrayNotHasKey('scope_condition', $tokenArray, 'Scope condition is set'); | ||
| $this->assertArrayNotHasKey('scope_opener', $tokenArray, 'Scope opener is set'); | ||
| $this->assertArrayNotHasKey('scope_closer', $tokenArray, 'Scope closer is set'); | ||
|
|
||
| }//end testEnumCases() | ||
|
|
||
|
|
||
| /** | ||
| * Data provider. | ||
| * | ||
| * @see testEnumCases() | ||
| * | ||
| * @return array<string, array<string>> | ||
| */ | ||
| public static function dataEnumCases() | ||
| { | ||
| return [ | ||
| 'enum case, no value' => ['/* testPureEnumCase */'], | ||
| 'enum case, integer value' => ['/* testBackingIntegerEnumCase */'], | ||
| 'enum case, string value' => ['/* testBackingStringEnumCase */'], | ||
| 'enum case, integer value in more complex enum' => ['/* testEnumCaseInComplexEnum */'], | ||
| 'enum case, keyword in mixed case' => ['/* testEnumCaseIsCaseInsensitive */'], | ||
| 'enum case, after switch statement' => ['/* testEnumCaseAfterSwitch */'], | ||
| 'enum case, after switch statement using alternative syntax' => ['/* testEnumCaseAfterSwitchWithEndSwitch */'], | ||
| ]; | ||
|
|
||
| }//end dataEnumCases() | ||
|
|
||
|
|
||
| /** | ||
| * Test that "case" that is not enum case is still tokenized as `T_CASE`. | ||
| * | ||
| * @param string $testMarker The comment which prefaces the target token in the test file. | ||
| * | ||
| * @dataProvider dataNotEnumCases | ||
| * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap | ||
| * | ||
| * @return void | ||
| */ | ||
| public function testNotEnumCases($testMarker) | ||
| { | ||
| $tokens = $this->phpcsFile->getTokens(); | ||
| $case = $this->getTargetToken($testMarker, [T_ENUM_CASE, T_CASE]); | ||
| $tokenArray = $tokens[$case]; | ||
|
|
||
| // Make sure we're looking at the right token. | ||
| $this->assertSame(T_CASE, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_CASE (code)'); | ||
|
|
||
| $this->assertArrayHasKey('scope_condition', $tokenArray, 'Scope condition is not set'); | ||
| $this->assertArrayHasKey('scope_opener', $tokenArray, 'Scope opener is not set'); | ||
| $this->assertArrayHasKey('scope_closer', $tokenArray, 'Scope closer is not set'); | ||
|
|
||
| }//end testNotEnumCases() | ||
|
|
||
|
|
||
| /** | ||
| * Data provider. | ||
| * | ||
| * @see testNotEnumCases() | ||
| * | ||
| * @return array<string, array<string>> | ||
| */ | ||
| public static function dataNotEnumCases() | ||
| { | ||
| return [ | ||
| 'switch case with constant, semicolon condition end' => ['/* testCaseWithSemicolonIsNotEnumCase */'], | ||
| 'switch case with constant, colon condition end' => ['/* testCaseWithConstantIsNotEnumCase */'], | ||
| 'switch case with constant, comparison' => ['/* testCaseWithConstantAndIdenticalIsNotEnumCase */'], | ||
| 'switch case with constant, assignment' => ['/* testCaseWithAssigmentToConstantIsNotEnumCase */'], | ||
| 'switch case with constant, keyword in mixed case' => ['/* testIsNotEnumCaseIsCaseInsensitive */'], | ||
| 'switch case, body in curlies declares enum' => ['/* testCaseInSwitchWhenCreatingEnumInSwitch1 */'], | ||
| 'switch case, body after semicolon declares enum' => ['/* testCaseInSwitchWhenCreatingEnumInSwitch2 */'], | ||
| ]; | ||
|
|
||
| }//end dataNotEnumCases() | ||
|
|
||
|
|
||
| /** | ||
| * Test that "case" that is not enum case is still tokenized as `T_CASE`. | ||
| * | ||
| * @param string $testMarker The comment which prefaces the target token in the test file. | ||
| * | ||
| * @dataProvider dataKeywordAsEnumCaseNameShouldBeString | ||
| * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap | ||
| * | ||
| * @return void | ||
| */ | ||
| public function testKeywordAsEnumCaseNameShouldBeString($testMarker) | ||
| { | ||
| $tokens = $this->phpcsFile->getTokens(); | ||
| $enumCaseName = $this->getTargetToken($testMarker, [T_STRING, T_INTERFACE, T_TRAIT, T_ENUM, T_FUNCTION, T_FALSE, T_DEFAULT, T_ARRAY]); | ||
| $tokenArray = $tokens[$enumCaseName]; | ||
|
|
||
| // Make sure we're looking at the right token. | ||
| $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); | ||
|
|
||
| $this->assertArrayNotHasKey('scope_condition', $tokenArray, 'Scope condition is set'); | ||
| $this->assertArrayNotHasKey('scope_opener', $tokenArray, 'Scope opener is set'); | ||
| $this->assertArrayNotHasKey('scope_closer', $tokenArray, 'Scope closer is set'); | ||
|
|
||
| }//end testKeywordAsEnumCaseNameShouldBeString() | ||
|
|
||
|
|
||
| /** | ||
| * Data provider. | ||
| * | ||
| * @see testKeywordAsEnumCaseNameShouldBeString() | ||
| * | ||
| * @return array<string, array<string>> | ||
| */ | ||
| public static function dataKeywordAsEnumCaseNameShouldBeString() | ||
| { | ||
| return [ | ||
| '"interface" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString1 */'], | ||
| '"trait" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString2 */'], | ||
| '"enum" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString3 */'], | ||
| '"function" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString4 */'], | ||
| '"false" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString5 */'], | ||
| '"default" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString6 */'], | ||
| '"array" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString7 */'], | ||
| ]; | ||
|
|
||
| }//end dataKeywordAsEnumCaseNameShouldBeString() | ||
|
|
||
|
|
||
| }//end class |