-
-### Use the latest version of PHP_CodeSniffer native utility functions.
-
-Normally to use the latest version of PHP_CodeSniffer native utility functions, you would have to raise the minimum requirements of your external PHPCS standard.
+### An ever-growing number of utility functions for use with PHP_CodeSniffer
-Now you won't have to anymore. This package allows you to use the latest version of those utility functions in all PHP_CodeSniffer versions from PHPCS 2.6.0 and up.
+Whether you need to split an `array` into the individual items, are trying to determine which variables are being assigned to in a `list()` or are figuring out whether a function has a DocBlock, PHPCSUtils has got you covered!
-### Several abstract sniff classes which your sniffs can extend.
+Includes improved versions of the PHPCS native utility functions and plenty of new utility functions.
-These classes take most of the heavy lifting away for some frequently occurring sniff types.
+These functions are compatible with PHPCS 3.7.1 up to PHPCS `master`.
-### A collection of static properties and methods for often-used token groups.
+### A collection of static properties and methods for often-used token groups
Collections of related tokens often-used and needed for sniffs.
These are additional "token groups" to compliment the ones available through the PHPCS native `PHP_CodeSniffer\Util\Tokens` class.
-### An ever-growing number of utility functions for use with PHP_CodeSniffer.
-
-Whether you need to split an `array` into the individual items, are trying to determine which variables are being assigned to in a `list()` or are figuring out whether a function has a DocBlock, PHPCSUtils has got you covered!
-
-Includes improved versions of the PHPCS native utility functions and plenty of new utility functions.
+### Several abstract sniff classes which your sniffs can extend
-These functions are, of course, compatible with PHPCS 2.6.0 up to PHPCS `master`.
+These classes take most of the heavy lifting away for some frequently occurring sniff types.
### Test utilities
An abstract `UtilityMethodTestCase` class to support testing of your utility methods written for PHP_CodeSniffer.
-Compatible with both PHPCS 2.x as well as 3.x. Supports PHPUnit 4.x up to 9.x.
+Supports PHPUnit 4.x up to 9.x.
-### Backward compatibility layer
+### Use the latest version of PHP_CodeSniffer native utility functions
-A `PHPCS23Utils` standard which allows sniffs to work in both PHPCS 2.x and 3.x, as well as a few helper functions for external standards which still want to support both PHP_CodeSniffer 2.x as well as 3.x.
+Normally to use the latest version of PHP_CodeSniffer native utility functions, you would have to raise the minimum requirements of your external PHPCS standard.
+
+Now you won't have to anymore. This package allows you to use the latest version of those utility functions in all PHP_CodeSniffer versions from PHPCS 3.7.1 and up.
### Fully documented
-To see detailed information about all the available abstract sniffs, utility functions and PHPCS helper functions, have a read through the [extensive documentation](https://phpcsutils.com/).
+To see detailed information about all the available abstract sniffs, utility functions and PHPCS helper functions, have a read through the [extensive documentation][phpcsutils-web].
-Minimum Requirements
--------------------------------------------
+
+## Minimum Requirements
* PHP 5.4 or higher.
-* [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) 2.6.0+, 3.1.0+ (with the exception of PHPCS 3.5.3).
+* [PHP_CodeSniffer] 3.7.1+.
* Recommended PHP extensions for optimal functionality:
- PCRE with Unicode support (normally enabled by default)
-Integrating PHPCSUtils in your external PHPCS standard
--------------------------------------------
+## Integrating PHPCSUtils in your external PHPCS standard
-### Composer-based with a minimum PHPCS requirement of PHPCS 3.1.0
+### Composer-based
-If your external PHP_CodeSniffer standard only supports Composer-based installs and has a minimum PHPCS requirement of PHP_CodeSniffer 3.1.0, integrating PHPCSUtils is pretty straight forward.
+If your external PHP_CodeSniffer standard only supports Composer-based installs, integrating PHPCSUtils is pretty straight forward.
Run the following from the root of your external PHPCS standard's project:
+
```bash
+composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer require phpcsstandards/phpcsutils:^1.0
```
No further action needed. You can start using all the utility functions, abstract sniff classes and other features of PHPCSUtils straight away.
-> :information_source: The PHPCSUtils package includes the [DealerDirect Composer PHPCS plugin](https://github.com/Dealerdirect/phpcodesniffer-composer-installer).
+> :information_source: The PHPCSUtils package includes the [Composer PHPCS plugin].
>
> This plugin will automatically register PHPCSUtils (and your own external standard) with PHP_CodeSniffer, so you and your users don't have to worry about this anymore.
>
> :warning: Note: if your end-user installation instructions include instructions on adding a Composer PHPCS plugin or on manually registering your standard with PHPCS using the `--config-set installed_paths` command, you can remove those instructions as they are no longer needed.
+>
+> :information_source: As of Composer 2.2, Composer will [ask for permission](https://blog.packagist.com/composer-2-2/#more-secure-plugin-execution) to allow the Composer PHPCS plugin to execute code. For the plugin to be functional, permission needs to be granted.
+> This can be done ahead of time by instructing your users to run the following command before installing your standard:
+>
+> ```bash
+> composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
+> ```
#### Running your unit tests
@@ -114,25 +119,6 @@ If you have your own unit test suite to test your sniffs, make sure to load the
If you intend to use the test utilities provided in the `PHPCSUtils/TestUtils` directory, make sure you also load the `vendor/phpcsstandards/phpcsutils/phpcsutils-autoload.php` file in your PHPUnit bootstrap file.
-### Composer-based with a minimum PHPCS requirement of PHPCS 2.6.0
-
-Follow the above instructions for use with PHPCS 3.x.
-
-In addition to that, add the following to the `ruleset.xml` file of your standard(s):
-```xml
-
-
+ 'excluded',
+ << 'excluded',
];
/* testAllEmptyString */
@@ -112,3 +120,19 @@ NOW
=> 6,
"abc" => 7,
];
+
+/* testHeredocWithEscapedVarInKey */
+$heredocStringKeyWithEscapedVar = [
+ << 1,
+ << 2,
+ << 3,
+];
diff --git a/Tests/AbstractSniffs/AbstractArrayDeclaration/GetActualArrayKeyTest.php b/Tests/AbstractSniffs/AbstractArrayDeclaration/GetActualArrayKeyTest.php
index 3e2390c8..ed3b2fe4 100644
--- a/Tests/AbstractSniffs/AbstractArrayDeclaration/GetActualArrayKeyTest.php
+++ b/Tests/AbstractSniffs/AbstractArrayDeclaration/GetActualArrayKeyTest.php
@@ -24,7 +24,7 @@
*
* @since 1.0.0
*/
-class GetActualArrayKeyTest extends UtilityMethodTestCase
+final class GetActualArrayKeyTest extends UtilityMethodTestCase
{
/**
@@ -75,35 +75,69 @@ public function dataGetActualArrayKey()
{
return [
'unsupported-key-types' => [
- '/* testAllVoid */',
- null,
- 0,
+ 'testMarker' => '/* testAllVoid */',
+ 'expected' => null,
+ 'expectedFrom' => 0,
],
'keys-all-empty-string' => [
- '/* testAllEmptyString */',
- '',
- 0,
+ 'testMarker' => '/* testAllEmptyString */',
+ 'expected' => '',
+ 'expectedFrom' => 0,
],
'keys-all-integer-zero' => [
- '/* testAllZero */',
- 0,
- 0,
+ 'testMarker' => '/* testAllZero */',
+ 'expected' => 0,
+ 'expectedFrom' => 0,
],
'keys-all-integer-one' => [
- '/* testAllOne */',
- 1,
- 1,
+ 'testMarker' => '/* testAllOne */',
+ 'expected' => 1,
+ 'expectedFrom' => 1,
],
'keys-all-integer-eleven' => [
- '/* testAllEleven */',
- 11,
- 0,
+ 'testMarker' => '/* testAllEleven */',
+ 'expected' => 11,
+ 'expectedFrom' => 0,
],
'keys-all-string-abc' => [
- '/* testAllStringAbc */',
- 'abc',
- 0,
+ 'testMarker' => '/* testAllStringAbc */',
+ 'expected' => 'abc',
+ 'expectedFrom' => 0,
],
];
}
+
+ /**
+ * Test retrieving the actual array key from a heredoc when the key could contain interpolation, but doesn't,
+ * as the interpolation is escaped.
+ *
+ * @return void
+ */
+ public function testGetActualArrayKeyFromHeredocWithEscapedVarInKey()
+ {
+ $testObj = new ArrayDeclarationSniffTestDouble();
+ $testObj->tokens = self::$phpcsFile->getTokens();
+
+ $stackPtr = $this->getTargetToken('/* testHeredocWithEscapedVarInKey */', [\T_ARRAY, \T_OPEN_SHORT_ARRAY]);
+ $arrayItems = PassedParameters::getParameters(self::$phpcsFile, $stackPtr);
+
+ $expected = [
+ 1 => 'a{$b}c',
+ 2 => 'a$bc',
+ 3 => '$\{abc}',
+ ];
+
+ $this->assertCount(\count($expected), $arrayItems);
+
+ foreach ($arrayItems as $itemNr => $arrayItem) {
+ $arrowPtr = Arrays::getDoubleArrowPtr(self::$phpcsFile, $arrayItem['start'], $arrayItem['end']);
+ $result = $testObj->getActualArrayKey(self::$phpcsFile, $arrayItem['start'], ($arrowPtr - 1));
+ $this->assertSame(
+ $expected[$itemNr],
+ $result,
+ 'Failed: actual key ' . $result . ' is not the same as the expected key ' . $expected[$itemNr]
+ . ' for item number ' . $itemNr
+ );
+ }
+ }
}
diff --git a/Tests/AssertAttributeSame.php b/Tests/AssertAttributeSame.php
index 6bc8c914..d8f7bfd2 100644
--- a/Tests/AssertAttributeSame.php
+++ b/Tests/AssertAttributeSame.php
@@ -58,27 +58,27 @@ public function assertAttributeValueSame($expected, $attributeName, $actualObjec
* Retrieve the value of an object's attribute.
* This also works for attributes that are declared protected or private.
*
- * @param object|string $object The object or class on which to check the property value.
- * @param string $attributeName The name of the property to check.
+ * @param object|string $objectUnderTest The object or class on which to check the property value.
+ * @param string $attributeName The name of the property to check.
*
* @return mixed Property value.
*
* @throws \Exception
*/
- public static function getObjectAttributeValue($object, $attributeName)
+ public static function getObjectAttributeValue($objectUnderTest, $attributeName)
{
- $reflector = new ReflectionObject($object);
+ $reflector = new ReflectionObject($objectUnderTest);
do {
try {
$attribute = $reflector->getProperty($attributeName);
if (!$attribute || $attribute->isPublic()) {
- return $object->$attributeName;
+ return $objectUnderTest->$attributeName;
}
$attribute->setAccessible(true);
- $value = $attribute->getValue($object);
+ $value = $attribute->getValue($objectUnderTest);
$attribute->setAccessible(false);
return $value;
diff --git a/Tests/BackCompat/BCFile/FindEndOfStatementTest.inc b/Tests/BackCompat/BCFile/FindEndOfStatementTest.inc
index 921e7996..83516798 100644
--- a/Tests/BackCompat/BCFile/FindEndOfStatementTest.inc
+++ b/Tests/BackCompat/BCFile/FindEndOfStatementTest.inc
@@ -39,17 +39,67 @@ $a = [
/* testStaticArrowFunction */
static fn ($a) => $a;
+return 0;
+
/* testArrowFunctionReturnValue */
fn(): array => [a($a, $b)];
+/* testArrowFunctionAsArgument */
$foo = foo(
- /* testArrowFunctionAsArgument */
fn() => bar()
);
+/* testArrowFunctionWithArrayAsArgument */
$foo = foo(
- /* testArrowFunctionWithArrayAsArgument */
fn() => [$row[0], $row[3]]
);
-return 0;
+$match = match ($a) {
+ /* testMatchCase */
+ 1 => 'foo',
+ /* testMatchDefault */
+ default => 'bar'
+};
+
+$match = match ($a) {
+ /* testMatchMultipleCase */
+ 1, 2, => $a * $b,
+ /* testMatchDefaultComma */
+ default, => 'something'
+};
+
+match ($pressedKey) {
+ /* testMatchFunctionCall */
+ Key::RETURN_ => save($value, $user)
+};
+
+$result = match (true) {
+ /* testMatchFunctionCallArm */
+ str_contains($text, 'Welcome') || str_contains($text, 'Hello') => 'en',
+ str_contains($text, 'Bienvenue') || str_contains($text, 'Bonjour') => 'fr',
+ default => 'pl'
+};
+
+/* testMatchClosure */
+$result = match ($key) {
+ 1 => function($a, $b) {},
+ 2 => function($b, $c) {},
+};
+
+/* testMatchArray */
+$result = match ($key) {
+ 1 => [1,2,3],
+ 2 => [1 => one(), 2 => two()],
+};
+
+/* testNestedMatch */
+$result = match ($key) {
+ 1 => match ($key) {
+ 1 => 'one',
+ 2 => 'two',
+ },
+ 2 => match ($key) {
+ 1 => 'two',
+ 2 => 'one',
+ },
+};
diff --git a/Tests/BackCompat/BCFile/FindEndOfStatementTest.php b/Tests/BackCompat/BCFile/FindEndOfStatementTest.php
index e144d598..1f42fd45 100644
--- a/Tests/BackCompat/BCFile/FindEndOfStatementTest.php
+++ b/Tests/BackCompat/BCFile/FindEndOfStatementTest.php
@@ -24,7 +24,6 @@
use PHPCSUtils\BackCompat\BCFile;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
-use PHPCSUtils\Tokens\Collections;
/**
* Tests for the \PHPCSUtils\BackCompat\BCFile::findEndOfStatement method.
@@ -33,7 +32,7 @@
*
* @since 1.0.0
*/
-class FindEndOfStatementTest extends UtilityMethodTestCase
+final class FindEndOfStatementTest extends UtilityMethodTestCase
{
/**
@@ -163,7 +162,9 @@ public function testUseGroup()
$start = $this->getTargetToken('/* testUseGroup */', T_USE);
$found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
- $this->assertSame(($start + 23), $found);
+ $expected = parent::usesPhp8NameTokens() ? ($start + 21) : ($start + 23);
+
+ $this->assertSame($expected, $found);
}
/**
@@ -173,7 +174,7 @@ public function testUseGroup()
*/
public function testArrowFunctionArrayValue()
{
- $start = $this->getTargetToken('/* testArrowFunctionArrayValue */', Collections::arrowFunctionTokensBC());
+ $start = $this->getTargetToken('/* testArrowFunctionArrayValue */', T_FN);
$found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
$this->assertSame(($start + 9), $found);
@@ -187,7 +188,7 @@ public function testArrowFunctionArrayValue()
public function testStaticArrowFunction()
{
$static = $this->getTargetToken('/* testStaticArrowFunction */', T_STATIC);
- $fn = $this->getTargetToken('/* testStaticArrowFunction */', Collections::arrowFunctionTokensBC());
+ $fn = $this->getTargetToken('/* testStaticArrowFunction */', T_FN);
$endOfStatementStatic = BCFile::findEndOfStatement(self::$phpcsFile, $static);
$endOfStatementFn = BCFile::findEndOfStatement(self::$phpcsFile, $fn);
@@ -202,7 +203,7 @@ public function testStaticArrowFunction()
*/
public function testArrowFunctionReturnValue()
{
- $start = $this->getTargetToken('/* testArrowFunctionReturnValue */', Collections::arrowFunctionTokensBC());
+ $start = $this->getTargetToken('/* testArrowFunctionReturnValue */', T_FN);
$found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
$this->assertSame(($start + 18), $found);
@@ -215,7 +216,7 @@ public function testArrowFunctionReturnValue()
*/
public function testArrowFunctionAsArgument()
{
- $start = $this->getTargetToken('/* testArrowFunctionAsArgument */', Collections::arrowFunctionTokensBC());
+ $start = $this->getTargetToken('/* testArrowFunctionAsArgument */', T_FN);
$found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
$this->assertSame(($start + 8), $found);
@@ -228,12 +229,166 @@ public function testArrowFunctionAsArgument()
*/
public function testArrowFunctionWithArrayAsArgument()
{
- $start = $this->getTargetToken(
- '/* testArrowFunctionWithArrayAsArgument */',
- Collections::arrowFunctionTokensBC()
- );
+ $start = $this->getTargetToken('/* testArrowFunctionWithArrayAsArgument */', T_FN);
$found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
$this->assertSame(($start + 17), $found);
}
+
+ /**
+ * Test simple match expression case.
+ *
+ * @return void
+ */
+ public function testMatchCase()
+ {
+ $start = $this->getTargetToken('/* testMatchCase */', T_LNUMBER);
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 5), $found);
+
+ $start = $this->getTargetToken('/* testMatchCase */', T_CONSTANT_ENCAPSED_STRING);
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 1), $found);
+ }
+
+ /**
+ * Test simple match expression default case.
+ *
+ * @return void
+ */
+ public function testMatchDefault()
+ {
+ $start = $this->getTargetToken('/* testMatchDefault */', T_MATCH_DEFAULT);
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 4), $found);
+
+ $start = $this->getTargetToken('/* testMatchDefault */', T_CONSTANT_ENCAPSED_STRING);
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame($start, $found);
+ }
+
+ /**
+ * Test multiple comma-separated match expression case values.
+ *
+ * @return void
+ */
+ public function testMatchMultipleCase()
+ {
+ $start = $this->getTargetToken('/* testMatchMultipleCase */', T_LNUMBER);
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+ $this->assertSame(($start + 13), $found);
+
+ $start += 6;
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+ $this->assertSame(($start + 7), $found);
+ }
+
+ /**
+ * Test match expression default case with trailing comma.
+ *
+ * @return void
+ */
+ public function testMatchDefaultComma()
+ {
+ $start = $this->getTargetToken('/* testMatchDefaultComma */', T_MATCH_DEFAULT);
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 5), $found);
+ }
+
+ /**
+ * Test match expression with function call.
+ *
+ * @return void
+ */
+ public function testMatchFunctionCall()
+ {
+ $start = $this->getTargetToken('/* testMatchFunctionCall */', T_STRING);
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 12), $found);
+
+ $start += 8;
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 1), $found);
+ }
+
+ /**
+ * Test match expression with function call in the arm.
+ *
+ * @return void
+ */
+ public function testMatchFunctionCallArm()
+ {
+ // Check the first case.
+ $start = $this->getTargetToken('/* testMatchFunctionCallArm */', T_STRING);
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 21), $found);
+
+ // Check the second case.
+ $start += 24;
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 21), $found);
+ }
+
+ /**
+ * Test match expression with closure.
+ *
+ * @return void
+ */
+ public function testMatchClosure()
+ {
+ $start = $this->getTargetToken('/* testMatchClosure */', T_LNUMBER);
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 14), $found);
+
+ $start += 17;
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 14), $found);
+ }
+
+ /**
+ * Test match expression with array declaration.
+ *
+ * @return void
+ */
+ public function testMatchArray()
+ {
+ $start = $this->getTargetToken('/* testMatchArray */', T_LNUMBER);
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 11), $found);
+
+ $start += 14;
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 22), $found);
+ }
+
+ /**
+ * Test nested match expressions.
+ *
+ * @return void
+ */
+ public function testNestedMatch()
+ {
+ $start = $this->getTargetToken('/* testNestedMatch */', T_LNUMBER);
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 30), $found);
+
+ $start += 21;
+ $found = BCFile::findEndOfStatement(self::$phpcsFile, $start);
+
+ $this->assertSame(($start + 5), $found);
+ }
}
diff --git a/Tests/BackCompat/BCFile/FindExtendedClassNameTest.inc b/Tests/BackCompat/BCFile/FindExtendedClassNameTest.inc
index dbe9ee38..58b73505 100644
--- a/Tests/BackCompat/BCFile/FindExtendedClassNameTest.inc
+++ b/Tests/BackCompat/BCFile/FindExtendedClassNameTest.inc
@@ -31,6 +31,9 @@ class testFECNNestedExtendedClass {
}
}
+/* testNamespaceRelativeQualifiedClass */
+class testFECNQualifiedClass extends Core\File\RelativeClass {}
+
/* testClassThatExtendsAndImplements */
class testFECNClassThatExtendsAndImplements extends testFECNClass implements InterfaceA, InterfaceB {}
@@ -44,7 +47,7 @@ $anon = new class( $a, $b ) extends testFECNExtendedAnonClass {};
interface Multi extends \Package\FooInterface, \BarInterface {};
/* testMissingExtendsName */
-class testMissingExtendsName extends { /* missing classname */ } // Internal parse error.
+class testMissingExtendsName extends { /* missing classname */ } // Intentional parse error.
// Intentional parse error. Has to be the last test in the file.
/* testParseError */
diff --git a/Tests/BackCompat/BCFile/FindExtendedClassNameTest.php b/Tests/BackCompat/BCFile/FindExtendedClassNameTest.php
index 279b4404..fb794dd5 100644
--- a/Tests/BackCompat/BCFile/FindExtendedClassNameTest.php
+++ b/Tests/BackCompat/BCFile/FindExtendedClassNameTest.php
@@ -137,6 +137,10 @@ public function dataExtendedClass()
'/* testNestedExtendedAnonClass */',
'testFECNAnonClass',
],
+ [
+ '/* testNamespaceRelativeQualifiedClass */',
+ 'Core\File\RelativeClass',
+ ],
[
'/* testClassThatExtendsAndImplements */',
'testFECNClass',
diff --git a/Tests/BackCompat/BCFile/FindImplementedInterfaceNamesTest.inc b/Tests/BackCompat/BCFile/FindImplementedInterfaceNamesTest.inc
index 4243fa3b..e1cc427a 100644
--- a/Tests/BackCompat/BCFile/FindImplementedInterfaceNamesTest.inc
+++ b/Tests/BackCompat/BCFile/FindImplementedInterfaceNamesTest.inc
@@ -20,17 +20,29 @@ class testFIINNamespacedClass implements \PHP_CodeSniffer\Tests\Core\File\testFI
/* testNonImplementedClass */
class testFIINNonImplementedClass {}
+/* testNamespaceRelativeQualifiedClass */
+class testFIINQualifiedClass implements Core\File\RelativeInterface {}
+
/* testClassThatExtendsAndImplements */
class testFECNClassThatExtendsAndImplements extends testFECNClass implements InterfaceA, \NameSpaced\Cat\InterfaceB {}
/* testClassThatImplementsAndExtends */
class testFECNClassThatImplementsAndExtends implements \InterfaceA, InterfaceB extends testFECNClass {}
+/* testBackedEnumWithoutImplements */
+enum Suit:string {}
+
+/* testEnumImplements */
+enum Suit implements Colorful {}
+
+/* testBackedEnumImplements */
+enum Suit: string implements Colorful, \Deck {}
+
/* testAnonClassImplements */
$anon = class() implements testFIINInterface {}
/* testMissingImplementsName */
-class testMissingExtendsName implements { /* missing interface name */ } // Internal parse error.
+class testMissingExtendsName implements { /* missing interface name */ } // Intentional parse error.
// Intentional parse error. Has to be the last test in the file.
/* testParseError */
diff --git a/Tests/BackCompat/BCFile/FindImplementedInterfaceNamesTest.php b/Tests/BackCompat/BCFile/FindImplementedInterfaceNamesTest.php
index 602aab86..ef44e19f 100644
--- a/Tests/BackCompat/BCFile/FindImplementedInterfaceNamesTest.php
+++ b/Tests/BackCompat/BCFile/FindImplementedInterfaceNamesTest.php
@@ -88,7 +88,7 @@ public function testFindImplementedInterfaceNames($identifier, $expected)
{
$testClass = static::TEST_CLASS;
- $OOToken = $this->getTargetToken($identifier, [T_CLASS, T_ANON_CLASS, T_INTERFACE]);
+ $OOToken = $this->getTargetToken($identifier, [T_CLASS, T_ANON_CLASS, T_INTERFACE, T_ENUM]);
$result = $testClass::findImplementedInterfaceNames(self::$phpcsFile, $OOToken);
$this->assertSame($expected, $result);
}
@@ -126,6 +126,10 @@ public function dataImplementedInterface()
'/* testInterface */',
false,
],
+ [
+ '/* testNamespaceRelativeQualifiedClass */',
+ ['Core\File\RelativeInterface'],
+ ],
[
'/* testClassThatExtendsAndImplements */',
[
@@ -140,6 +144,21 @@ public function dataImplementedInterface()
'InterfaceB',
],
],
+ [
+ '/* testBackedEnumWithoutImplements */',
+ false,
+ ],
+ [
+ '/* testEnumImplements */',
+ ['Colorful'],
+ ],
+ [
+ '/* testBackedEnumImplements */',
+ [
+ 'Colorful',
+ '\Deck',
+ ],
+ ],
[
'/* testAnonClassImplements */',
['testFIINInterface'],
diff --git a/Tests/BackCompat/BCFile/FindStartOfStatementTest.inc b/Tests/BackCompat/BCFile/FindStartOfStatementTest.inc
index 366047b6..7061c473 100644
--- a/Tests/BackCompat/BCFile/FindStartOfStatementTest.inc
+++ b/Tests/BackCompat/BCFile/FindStartOfStatementTest.inc
@@ -1,5 +1,136 @@
$foo + $bar, 'b' => true];
+
+/* testUseGroup */
+use Vendor\Package\{ClassA as A, ClassB, ClassC as C};
+
+$a = [
+ /* testArrowFunctionArrayValue */
+ 'a' => fn() => return 1,
+ 'b' => fn() => return 1,
+];
+
+/* testStaticArrowFunction */
+static fn ($a) => $a;
+
+/* testArrowFunctionReturnValue */
+fn(): array => [a($a, $b)];
+
+/* testArrowFunctionAsArgument */
+$foo = foo(
+ fn() => bar()
+);
+
+/* testArrowFunctionWithArrayAsArgument */
+$foo = foo(
+ fn() => [$row[0], $row[3]]
+);
+
+$match = match ($a) {
+ /* testMatchCase */
+ 1 => 'foo',
+ /* testMatchDefault */
+ default => 'bar'
+};
+
+$match = match ($a) {
+ /* testMatchMultipleCase */
+ 1, 2, => $a * $b,
+ /* testMatchDefaultComma */
+ default, => 'something'
+};
+
+match ($pressedKey) {
+ /* testMatchFunctionCall */
+ Key::RETURN_ => save($value, $user)
+};
+
+$result = match (true) {
+ /* testMatchFunctionCallArm */
+ str_contains($text, 'Welcome') || str_contains($text, 'Hello') => 'en',
+ str_contains($text, 'Bienvenue') || str_contains($text, 'Bonjour') => 'fr',
+ default => 'pl'
+};
+
+/* testMatchClosure */
+$result = match ($key) {
+ 1 => function($a, $b) {},
+ 2 => function($b, $c) {},
+};
+
+/* testMatchArray */
+$result = match ($key) {
+ 1 => [1,2,3],
+ 2 => [1 => one($a, $b), 2 => two($b, $c)],
+ 3 => [],
+};
+
+/* testNestedMatch */
+$result = match ($key) {
+ 1 => match ($key) {
+ 1 => 'one',
+ 2 => 'two',
+ },
+ 2 => match ($key) {
+ 1 => 'two',
+ 2 => 'one',
+ },
+};
+
+return 0;
+
+/* testOpenTag */
+?>
+
- */
- protected $commentTokens = [
- \T_COMMENT => \T_COMMENT,
- \T_DOC_COMMENT => \T_DOC_COMMENT,
- \T_DOC_COMMENT_STAR => \T_DOC_COMMENT_STAR,
- \T_DOC_COMMENT_WHITESPACE => \T_DOC_COMMENT_WHITESPACE,
- \T_DOC_COMMENT_TAG => \T_DOC_COMMENT_TAG,
- \T_DOC_COMMENT_OPEN_TAG => \T_DOC_COMMENT_OPEN_TAG,
- \T_DOC_COMMENT_CLOSE_TAG => \T_DOC_COMMENT_CLOSE_TAG,
- \T_DOC_COMMENT_STRING => \T_DOC_COMMENT_STRING,
- ];
-
- /**
- * Token types that are comments containing PHPCS instructions.
- *
- * @var array =>
- */
- protected $phpcsCommentTokens = [
- 'PHPCS_T_PHPCS_ENABLE' => 'PHPCS_T_PHPCS_ENABLE',
- 'PHPCS_T_PHPCS_DISABLE' => 'PHPCS_T_PHPCS_DISABLE',
- 'PHPCS_T_PHPCS_SET' => 'PHPCS_T_PHPCS_SET',
- 'PHPCS_T_PHPCS_IGNORE' => 'PHPCS_T_PHPCS_IGNORE',
- 'PHPCS_T_PHPCS_IGNORE_FILE' => 'PHPCS_T_PHPCS_IGNORE_FILE',
- ];
-
- /**
- * Test the Tokens::emptyTokens() method.
- *
- * @covers \PHPCSUtils\BackCompat\BCTokens::__callStatic
- *
- * @return void
- */
- public function testEmptyTokens()
- {
- $version = Helper::getVersion();
- $expected = [\T_WHITESPACE => \T_WHITESPACE] + $this->commentTokens;
-
- if (\version_compare($version, '3.2.0', '>=') === true) {
- $expected += $this->phpcsCommentTokens;
- }
-
- $this->assertSame($expected, BCTokens::emptyTokens());
- }
-
- /**
- * Test the Tokens::commentTokens() method.
- *
- * @covers \PHPCSUtils\BackCompat\BCTokens::__callStatic
- *
- * @return void
- */
- public function testCommentTokens()
- {
- $version = Helper::getVersion();
- $expected = $this->commentTokens;
-
- if (\version_compare($version, '3.2.0', '>=') === true) {
- $expected += $this->phpcsCommentTokens;
- }
-
- $this->assertSame($expected, BCTokens::commentTokens());
- }
-
- /**
- * Test the Tokens::phpcsCommentTokens() method.
- *
- * @covers \PHPCSUtils\BackCompat\BCTokens::phpcsCommentTokens
- *
- * @return void
- */
- public function testPhpcsCommentTokens()
- {
- $version = Helper::getVersion();
- $expected = [];
-
- if (\version_compare($version, '3.2.0', '>=') === true) {
- $expected = $this->phpcsCommentTokens;
- }
-
- $this->assertSame($expected, BCTokens::phpcsCommentTokens());
- }
-}
diff --git a/Tests/BackCompat/BCTokens/FunctionNameTokensTest.php b/Tests/BackCompat/BCTokens/FunctionNameTokensTest.php
index 25f66316..733aa00e 100644
--- a/Tests/BackCompat/BCTokens/FunctionNameTokensTest.php
+++ b/Tests/BackCompat/BCTokens/FunctionNameTokensTest.php
@@ -10,7 +10,9 @@
namespace PHPCSUtils\Tests\BackCompat\BCTokens;
+use PHP_CodeSniffer\Util\Tokens;
use PHPCSUtils\BackCompat\BCTokens;
+use PHPCSUtils\BackCompat\Helper;
use PHPUnit\Framework\TestCase;
/**
@@ -22,7 +24,7 @@
*
* @since 1.0.0
*/
-class FunctionNameTokensTest extends TestCase
+final class FunctionNameTokensTest extends TestCase
{
/**
@@ -33,20 +35,63 @@ class FunctionNameTokensTest extends TestCase
public function testFunctionNameTokens()
{
$expected = [
- \T_STRING => \T_STRING,
- \T_EVAL => \T_EVAL,
- \T_EXIT => \T_EXIT,
- \T_INCLUDE => \T_INCLUDE,
- \T_INCLUDE_ONCE => \T_INCLUDE_ONCE,
- \T_REQUIRE => \T_REQUIRE,
- \T_REQUIRE_ONCE => \T_REQUIRE_ONCE,
- \T_ISSET => \T_ISSET,
- \T_UNSET => \T_UNSET,
- \T_EMPTY => \T_EMPTY,
- \T_SELF => \T_SELF,
- \T_STATIC => \T_STATIC,
+ \T_STRING => \T_STRING,
+ \T_EVAL => \T_EVAL,
+ \T_EXIT => \T_EXIT,
+ \T_INCLUDE => \T_INCLUDE,
+ \T_INCLUDE_ONCE => \T_INCLUDE_ONCE,
+ \T_REQUIRE => \T_REQUIRE,
+ \T_REQUIRE_ONCE => \T_REQUIRE_ONCE,
+ \T_ISSET => \T_ISSET,
+ \T_UNSET => \T_UNSET,
+ \T_EMPTY => \T_EMPTY,
+ \T_SELF => \T_SELF,
+ \T_STATIC => \T_STATIC,
+ \T_PARENT => \T_PARENT,
+ \T_NAME_QUALIFIED => \T_NAME_QUALIFIED,
+ \T_NAME_FULLY_QUALIFIED => \T_NAME_FULLY_QUALIFIED,
+ \T_NAME_RELATIVE => \T_NAME_RELATIVE,
];
- $this->assertSame($expected, BCTokens::functionNameTokens());
+ \asort($expected);
+
+ $result = BCTokens::functionNameTokens();
+ \asort($result);
+
+ $this->assertSame($expected, $result);
+ }
+
+ /**
+ * Test whether the method in BCTokens is still in sync with the latest version of PHPCS.
+ *
+ * This group is not run by default and has to be specifically requested to be run.
+ *
+ * @group compareWithPHPCS
+ *
+ * @return void
+ */
+ public function testPHPCSFunctionNameTokens()
+ {
+ $version = Helper::getVersion();
+
+ if (\version_compare($version, '3.99.99', '>') === true) {
+ $this->assertSame(Tokens::$functionNameTokens, BCTokens::functionNameTokens());
+ } else {
+ /*
+ * Don't fail this test on the difference between PHPCS 4.x and 3.x.
+ * This test is only run against `dev-master` and `dev-master` is still PHPCS 3.x.
+ */
+ $expected = Tokens::$functionNameTokens;
+ $expected[\T_NAME_QUALIFIED] = \T_NAME_QUALIFIED;
+ $expected[\T_NAME_FULLY_QUALIFIED] = \T_NAME_FULLY_QUALIFIED;
+ $expected[\T_NAME_RELATIVE] = \T_NAME_RELATIVE;
+
+ \asort($expected);
+
+ $result = BCTokens::functionNameTokens();
+ \asort($result);
+
+ $this->assertSame($expected, $result);
+ }
}
}
diff --git a/Tests/BackCompat/BCTokens/OoScopeTokensTest.php b/Tests/BackCompat/BCTokens/OoScopeTokensTest.php
deleted file mode 100644
index 9a63b8bb..00000000
--- a/Tests/BackCompat/BCTokens/OoScopeTokensTest.php
+++ /dev/null
@@ -1,44 +0,0 @@
- \T_CLASS,
- \T_ANON_CLASS => \T_ANON_CLASS,
- \T_INTERFACE => \T_INTERFACE,
- \T_TRAIT => \T_TRAIT,
- ];
-
- $this->assertSame($expected, BCTokens::ooScopeTokens());
- }
-}
diff --git a/Tests/BackCompat/BCTokens/OperatorsTest.php b/Tests/BackCompat/BCTokens/OperatorsTest.php
deleted file mode 100644
index cdabe140..00000000
--- a/Tests/BackCompat/BCTokens/OperatorsTest.php
+++ /dev/null
@@ -1,65 +0,0 @@
- \T_MINUS,
- \T_PLUS => \T_PLUS,
- \T_MULTIPLY => \T_MULTIPLY,
- \T_DIVIDE => \T_DIVIDE,
- \T_MODULUS => \T_MODULUS,
- \T_POW => \T_POW,
- \T_SPACESHIP => \T_SPACESHIP,
- \T_BITWISE_AND => \T_BITWISE_AND,
- \T_BITWISE_OR => \T_BITWISE_OR,
- \T_BITWISE_XOR => \T_BITWISE_XOR,
- \T_SL => \T_SL,
- \T_SR => \T_SR,
- ];
-
- if (\version_compare($version, '2.6.1', '>=') === true
- || \version_compare(\PHP_VERSION_ID, '60999', '>=') === true
- ) {
- $expected[\T_COALESCE] = \T_COALESCE;
- }
-
- \asort($expected);
-
- $result = BCTokens::operators();
- \asort($result);
-
- $this->assertSame($expected, $result);
- }
-}
diff --git a/Tests/BackCompat/BCTokens/ParenthesisOpenersTest.php b/Tests/BackCompat/BCTokens/ParenthesisOpenersTest.php
index 94e1ef01..dd409f28 100644
--- a/Tests/BackCompat/BCTokens/ParenthesisOpenersTest.php
+++ b/Tests/BackCompat/BCTokens/ParenthesisOpenersTest.php
@@ -10,19 +10,21 @@
namespace PHPCSUtils\Tests\BackCompat\BCTokens;
+use PHP_CodeSniffer\Util\Tokens;
use PHPCSUtils\BackCompat\BCTokens;
+use PHPCSUtils\BackCompat\Helper;
use PHPUnit\Framework\TestCase;
/**
* Test class.
*
- * @covers \PHPCSUtils\BackCompat\BCTokens::parenthesisOpeners
+ * @covers \PHPCSUtils\BackCompat\BCTokens::__callStatic
*
* @group tokens
*
* @since 1.0.0
*/
-class ParenthesisOpenersTest extends TestCase
+final class ParenthesisOpenersTest extends TestCase
{
/**
@@ -32,6 +34,7 @@ class ParenthesisOpenersTest extends TestCase
*/
public function testParenthesisOpeners()
{
+ $version = Helper::getVersion();
$expected = [
\T_ARRAY => \T_ARRAY,
\T_LIST => \T_LIST,
@@ -46,8 +49,13 @@ public function testParenthesisOpeners()
\T_ELSEIF => \T_ELSEIF,
\T_CATCH => \T_CATCH,
\T_DECLARE => \T_DECLARE,
+ \T_MATCH => \T_MATCH,
];
+ if (\version_compare($version, '3.99.99', '>=') === true) {
+ $expected[\T_USE] = \T_USE;
+ }
+
\asort($expected);
$result = BCTokens::parenthesisOpeners();
@@ -55,4 +63,18 @@ public function testParenthesisOpeners()
$this->assertSame($expected, $result);
}
+
+ /**
+ * Test whether the method in BCTokens is still in sync with the latest version of PHPCS.
+ *
+ * This group is not run by default and has to be specifically requested to be run.
+ *
+ * @group compareWithPHPCS
+ *
+ * @return void
+ */
+ public function testPHPCSParenthesisOpeners()
+ {
+ $this->assertSame(Tokens::$parenthesisOpeners, BCTokens::parenthesisOpeners());
+ }
}
diff --git a/Tests/BackCompat/BCTokens/TextStringTokensTest.php b/Tests/BackCompat/BCTokens/TextStringTokensTest.php
deleted file mode 100644
index 5cb44269..00000000
--- a/Tests/BackCompat/BCTokens/TextStringTokensTest.php
+++ /dev/null
@@ -1,45 +0,0 @@
- \T_CONSTANT_ENCAPSED_STRING,
- \T_DOUBLE_QUOTED_STRING => \T_DOUBLE_QUOTED_STRING,
- \T_INLINE_HTML => \T_INLINE_HTML,
- \T_HEREDOC => \T_HEREDOC,
- \T_NOWDOC => \T_NOWDOC,
- ];
-
- $this->assertSame($expected, BCTokens::textStringTokens());
- }
-}
diff --git a/Tests/BackCompat/BCTokens/UnchangedTokenArraysTest.php b/Tests/BackCompat/BCTokens/UnchangedTokenArraysTest.php
index c179c949..d7199a74 100644
--- a/Tests/BackCompat/BCTokens/UnchangedTokenArraysTest.php
+++ b/Tests/BackCompat/BCTokens/UnchangedTokenArraysTest.php
@@ -10,8 +10,9 @@
namespace PHPCSUtils\Tests\BackCompat\BCTokens;
+use PHP_CodeSniffer\Util\Tokens;
use PHPCSUtils\BackCompat\BCTokens;
-use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
/**
* Test class.
@@ -22,15 +23,39 @@
*
* @since 1.0.0
*/
-class UnchangedTokenArraysTest extends TestCase
+final class UnchangedTokenArraysTest extends TestCase
{
+ /**
+ * Tokens that represent assignments.
+ *
+ * @var array
+ */
+ private $assignmentTokens = [
+ \T_EQUAL => \T_EQUAL,
+ \T_AND_EQUAL => \T_AND_EQUAL,
+ \T_OR_EQUAL => \T_OR_EQUAL,
+ \T_CONCAT_EQUAL => \T_CONCAT_EQUAL,
+ \T_DIV_EQUAL => \T_DIV_EQUAL,
+ \T_MINUS_EQUAL => \T_MINUS_EQUAL,
+ \T_POW_EQUAL => \T_POW_EQUAL,
+ \T_MOD_EQUAL => \T_MOD_EQUAL,
+ \T_MUL_EQUAL => \T_MUL_EQUAL,
+ \T_PLUS_EQUAL => \T_PLUS_EQUAL,
+ \T_XOR_EQUAL => \T_XOR_EQUAL,
+ \T_DOUBLE_ARROW => \T_DOUBLE_ARROW,
+ \T_SL_EQUAL => \T_SL_EQUAL,
+ \T_SR_EQUAL => \T_SR_EQUAL,
+ \T_COALESCE_EQUAL => \T_COALESCE_EQUAL,
+ \T_ZSR_EQUAL => \T_ZSR_EQUAL,
+ ];
+
/**
* Tokens that represent equality comparisons.
*
* @var array =>
*/
- protected $equalityTokens = [
+ private $equalityTokens = [
\T_IS_EQUAL => \T_IS_EQUAL,
\T_IS_NOT_EQUAL => \T_IS_NOT_EQUAL,
\T_IS_IDENTICAL => \T_IS_IDENTICAL,
@@ -39,12 +64,65 @@ class UnchangedTokenArraysTest extends TestCase
\T_IS_GREATER_OR_EQUAL => \T_IS_GREATER_OR_EQUAL,
];
+ /**
+ * Tokens that represent comparison operator.
+ *
+ * @var array
+ */
+ private $comparisonTokens = [
+ \T_IS_EQUAL => \T_IS_EQUAL,
+ \T_IS_IDENTICAL => \T_IS_IDENTICAL,
+ \T_IS_NOT_EQUAL => \T_IS_NOT_EQUAL,
+ \T_IS_NOT_IDENTICAL => \T_IS_NOT_IDENTICAL,
+ \T_LESS_THAN => \T_LESS_THAN,
+ \T_GREATER_THAN => \T_GREATER_THAN,
+ \T_IS_SMALLER_OR_EQUAL => \T_IS_SMALLER_OR_EQUAL,
+ \T_IS_GREATER_OR_EQUAL => \T_IS_GREATER_OR_EQUAL,
+ \T_SPACESHIP => \T_SPACESHIP,
+ \T_COALESCE => \T_COALESCE,
+ ];
+
+ /**
+ * Tokens that represent arithmetic operators.
+ *
+ * @var array
+ */
+ private $arithmeticTokens = [
+ \T_PLUS => \T_PLUS,
+ \T_MINUS => \T_MINUS,
+ \T_MULTIPLY => \T_MULTIPLY,
+ \T_DIVIDE => \T_DIVIDE,
+ \T_MODULUS => \T_MODULUS,
+ \T_POW => \T_POW,
+ ];
+
+ /**
+ * Tokens that perform operations.
+ *
+ * @var array
+ */
+ private $operators = [
+ \T_MINUS => \T_MINUS,
+ \T_PLUS => \T_PLUS,
+ \T_MULTIPLY => \T_MULTIPLY,
+ \T_DIVIDE => \T_DIVIDE,
+ \T_MODULUS => \T_MODULUS,
+ \T_POW => \T_POW,
+ \T_SPACESHIP => \T_SPACESHIP,
+ \T_COALESCE => \T_COALESCE,
+ \T_BITWISE_AND => \T_BITWISE_AND,
+ \T_BITWISE_OR => \T_BITWISE_OR,
+ \T_BITWISE_XOR => \T_BITWISE_XOR,
+ \T_SL => \T_SL,
+ \T_SR => \T_SR,
+ ];
+
/**
* Tokens that perform boolean operations.
*
* @var array =>
*/
- protected $booleanOperators = [
+ private $booleanOperators = [
\T_BOOLEAN_AND => \T_BOOLEAN_AND,
\T_BOOLEAN_OR => \T_BOOLEAN_OR,
\T_LOGICAL_AND => \T_LOGICAL_AND,
@@ -57,7 +135,7 @@ class UnchangedTokenArraysTest extends TestCase
*
* @var array =>
*/
- protected $castTokens = [
+ private $castTokens = [
\T_INT_CAST => \T_INT_CAST,
\T_STRING_CAST => \T_STRING_CAST,
\T_DOUBLE_CAST => \T_DOUBLE_CAST,
@@ -71,13 +149,14 @@ class UnchangedTokenArraysTest extends TestCase
/**
* Tokens that are allowed to open scopes.
*
- * @var array =>
+ * @var array
*/
- protected $scopeOpeners = [
+ private $scopeOpeners = [
\T_CLASS => \T_CLASS,
\T_ANON_CLASS => \T_ANON_CLASS,
\T_INTERFACE => \T_INTERFACE,
\T_TRAIT => \T_TRAIT,
+ \T_ENUM => \T_ENUM,
\T_NAMESPACE => \T_NAMESPACE,
\T_FUNCTION => \T_FUNCTION,
\T_CLOSURE => \T_CLOSURE,
@@ -98,6 +177,7 @@ class UnchangedTokenArraysTest extends TestCase
\T_PROPERTY => \T_PROPERTY,
\T_OBJECT => \T_OBJECT,
\T_USE => \T_USE,
+ \T_MATCH => \T_MATCH,
];
/**
@@ -105,7 +185,7 @@ class UnchangedTokenArraysTest extends TestCase
*
* @var array =>
*/
- protected $scopeModifiers = [
+ private $scopeModifiers = [
\T_PRIVATE => \T_PRIVATE,
\T_PUBLIC => \T_PUBLIC,
\T_PROTECTED => \T_PROTECTED,
@@ -116,7 +196,7 @@ class UnchangedTokenArraysTest extends TestCase
*
* @var array =>
*/
- protected $methodPrefixes = [
+ private $methodPrefixes = [
\T_PRIVATE => \T_PRIVATE,
\T_PUBLIC => \T_PUBLIC,
\T_PROTECTED => \T_PROTECTED,
@@ -130,21 +210,90 @@ class UnchangedTokenArraysTest extends TestCase
*
* @var array =>
*/
- protected $blockOpeners = [
+ private $blockOpeners = [
\T_OPEN_CURLY_BRACKET => \T_OPEN_CURLY_BRACKET,
\T_OPEN_SQUARE_BRACKET => \T_OPEN_SQUARE_BRACKET,
\T_OPEN_PARENTHESIS => \T_OPEN_PARENTHESIS,
\T_OBJECT => \T_OBJECT,
];
+ /**
+ * Tokens that don't represent code.
+ *
+ * @var array
+ */
+ private $emptyTokens = [
+ \T_WHITESPACE => \T_WHITESPACE,
+ \T_COMMENT => \T_COMMENT,
+ \T_DOC_COMMENT => \T_DOC_COMMENT,
+ \T_DOC_COMMENT_STAR => \T_DOC_COMMENT_STAR,
+ \T_DOC_COMMENT_WHITESPACE => \T_DOC_COMMENT_WHITESPACE,
+ \T_DOC_COMMENT_TAG => \T_DOC_COMMENT_TAG,
+ \T_DOC_COMMENT_OPEN_TAG => \T_DOC_COMMENT_OPEN_TAG,
+ \T_DOC_COMMENT_CLOSE_TAG => \T_DOC_COMMENT_CLOSE_TAG,
+ \T_DOC_COMMENT_STRING => \T_DOC_COMMENT_STRING,
+ \T_PHPCS_ENABLE => \T_PHPCS_ENABLE,
+ \T_PHPCS_DISABLE => \T_PHPCS_DISABLE,
+ \T_PHPCS_SET => \T_PHPCS_SET,
+ \T_PHPCS_IGNORE => \T_PHPCS_IGNORE,
+ \T_PHPCS_IGNORE_FILE => \T_PHPCS_IGNORE_FILE,
+ ];
+
+ /**
+ * Tokens that are comments.
+ *
+ * @var array
+ */
+ private $commentTokens = [
+ \T_COMMENT => \T_COMMENT,
+ \T_DOC_COMMENT => \T_DOC_COMMENT,
+ \T_DOC_COMMENT_STAR => \T_DOC_COMMENT_STAR,
+ \T_DOC_COMMENT_WHITESPACE => \T_DOC_COMMENT_WHITESPACE,
+ \T_DOC_COMMENT_TAG => \T_DOC_COMMENT_TAG,
+ \T_DOC_COMMENT_OPEN_TAG => \T_DOC_COMMENT_OPEN_TAG,
+ \T_DOC_COMMENT_CLOSE_TAG => \T_DOC_COMMENT_CLOSE_TAG,
+ \T_DOC_COMMENT_STRING => \T_DOC_COMMENT_STRING,
+ \T_PHPCS_ENABLE => \T_PHPCS_ENABLE,
+ \T_PHPCS_DISABLE => \T_PHPCS_DISABLE,
+ \T_PHPCS_SET => \T_PHPCS_SET,
+ \T_PHPCS_IGNORE => \T_PHPCS_IGNORE,
+ \T_PHPCS_IGNORE_FILE => \T_PHPCS_IGNORE_FILE,
+ ];
+
+ /**
+ * Tokens that are comments containing PHPCS instructions.
+ *
+ * @var array
+ */
+ private $phpcsCommentTokens = [
+ \T_PHPCS_ENABLE => \T_PHPCS_ENABLE,
+ \T_PHPCS_DISABLE => \T_PHPCS_DISABLE,
+ \T_PHPCS_SET => \T_PHPCS_SET,
+ \T_PHPCS_IGNORE => \T_PHPCS_IGNORE,
+ \T_PHPCS_IGNORE_FILE => \T_PHPCS_IGNORE_FILE,
+ ];
+
/**
* Tokens that represent strings.
*
* @var array =>
*/
- protected $stringTokens = [
+ private $stringTokens = [
+ \T_CONSTANT_ENCAPSED_STRING => \T_CONSTANT_ENCAPSED_STRING,
+ \T_DOUBLE_QUOTED_STRING => \T_DOUBLE_QUOTED_STRING,
+ ];
+
+ /**
+ * Tokens that represent text strings.
+ *
+ * @var array
+ */
+ private $textStringTokens = [
\T_CONSTANT_ENCAPSED_STRING => \T_CONSTANT_ENCAPSED_STRING,
\T_DOUBLE_QUOTED_STRING => \T_DOUBLE_QUOTED_STRING,
+ \T_INLINE_HTML => \T_INLINE_HTML,
+ \T_HEREDOC => \T_HEREDOC,
+ \T_NOWDOC => \T_NOWDOC,
];
/**
@@ -152,7 +301,7 @@ class UnchangedTokenArraysTest extends TestCase
*
* @var array =>
*/
- protected $bracketTokens = [
+ private $bracketTokens = [
\T_OPEN_CURLY_BRACKET => \T_OPEN_CURLY_BRACKET,
\T_CLOSE_CURLY_BRACKET => \T_CLOSE_CURLY_BRACKET,
\T_OPEN_SQUARE_BRACKET => \T_OPEN_SQUARE_BRACKET,
@@ -166,7 +315,7 @@ class UnchangedTokenArraysTest extends TestCase
*
* @var array =>
*/
- protected $includeTokens = [
+ private $includeTokens = [
\T_REQUIRE_ONCE => \T_REQUIRE_ONCE,
\T_REQUIRE => \T_REQUIRE,
\T_INCLUDE_ONCE => \T_INCLUDE_ONCE,
@@ -178,7 +327,7 @@ class UnchangedTokenArraysTest extends TestCase
*
* @var array =>
*/
- protected $heredocTokens = [
+ private $heredocTokens = [
\T_START_HEREDOC => \T_START_HEREDOC,
\T_END_HEREDOC => \T_END_HEREDOC,
\T_HEREDOC => \T_HEREDOC,
@@ -187,6 +336,117 @@ class UnchangedTokenArraysTest extends TestCase
\T_NOWDOC => \T_NOWDOC,
];
+ /**
+ * Tokens that open class and object scopes.
+ *
+ * @var array
+ */
+ private $ooScopeTokens = [
+ \T_CLASS => \T_CLASS,
+ \T_ANON_CLASS => \T_ANON_CLASS,
+ \T_INTERFACE => \T_INTERFACE,
+ \T_TRAIT => \T_TRAIT,
+ \T_ENUM => \T_ENUM,
+ ];
+
+ /**
+ * Tokens representing PHP magic constants.
+ *
+ * @var array =>
+ *
+ * @link https://www.php.net/language.constants.predefined PHP Manual on magic constants
+ */
+ private $magicConstants = [
+ \T_CLASS_C => \T_CLASS_C,
+ \T_DIR => \T_DIR,
+ \T_FILE => \T_FILE,
+ \T_FUNC_C => \T_FUNC_C,
+ \T_LINE => \T_LINE,
+ \T_METHOD_C => \T_METHOD_C,
+ \T_NS_C => \T_NS_C,
+ \T_TRAIT_C => \T_TRAIT_C,
+ ];
+
+ /**
+ * Tokens representing context sensitive keywords in PHP.
+ *
+ * @link https://wiki.php.net/rfc/context_sensitive_lexer
+ *
+ * @var array
+ */
+ private $contextSensitiveKeywords = [
+ \T_ABSTRACT => \T_ABSTRACT,
+ \T_ARRAY => \T_ARRAY,
+ \T_AS => \T_AS,
+ \T_BREAK => \T_BREAK,
+ \T_CALLABLE => \T_CALLABLE,
+ \T_CASE => \T_CASE,
+ \T_CATCH => \T_CATCH,
+ \T_CLASS => \T_CLASS,
+ \T_CLONE => \T_CLONE,
+ \T_CONST => \T_CONST,
+ \T_CONTINUE => \T_CONTINUE,
+ \T_DECLARE => \T_DECLARE,
+ \T_DEFAULT => \T_DEFAULT,
+ \T_DO => \T_DO,
+ \T_ECHO => \T_ECHO,
+ \T_ELSE => \T_ELSE,
+ \T_ELSEIF => \T_ELSEIF,
+ \T_EMPTY => \T_EMPTY,
+ \T_ENDDECLARE => \T_ENDDECLARE,
+ \T_ENDFOR => \T_ENDFOR,
+ \T_ENDFOREACH => \T_ENDFOREACH,
+ \T_ENDIF => \T_ENDIF,
+ \T_ENDSWITCH => \T_ENDSWITCH,
+ \T_ENDWHILE => \T_ENDWHILE,
+ \T_ENUM => \T_ENUM,
+ \T_EVAL => \T_EVAL,
+ \T_EXIT => \T_EXIT,
+ \T_EXTENDS => \T_EXTENDS,
+ \T_FINAL => \T_FINAL,
+ \T_FINALLY => \T_FINALLY,
+ \T_FN => \T_FN,
+ \T_FOR => \T_FOR,
+ \T_FOREACH => \T_FOREACH,
+ \T_FUNCTION => \T_FUNCTION,
+ \T_GLOBAL => \T_GLOBAL,
+ \T_GOTO => \T_GOTO,
+ \T_IF => \T_IF,
+ \T_IMPLEMENTS => \T_IMPLEMENTS,
+ \T_INCLUDE => \T_INCLUDE,
+ \T_INCLUDE_ONCE => \T_INCLUDE_ONCE,
+ \T_INSTANCEOF => \T_INSTANCEOF,
+ \T_INSTEADOF => \T_INSTEADOF,
+ \T_INTERFACE => \T_INTERFACE,
+ \T_ISSET => \T_ISSET,
+ \T_LIST => \T_LIST,
+ \T_LOGICAL_AND => \T_LOGICAL_AND,
+ \T_LOGICAL_OR => \T_LOGICAL_OR,
+ \T_LOGICAL_XOR => \T_LOGICAL_XOR,
+ \T_MATCH => \T_MATCH,
+ \T_NAMESPACE => \T_NAMESPACE,
+ \T_NEW => \T_NEW,
+ \T_PRINT => \T_PRINT,
+ \T_PRIVATE => \T_PRIVATE,
+ \T_PROTECTED => \T_PROTECTED,
+ \T_PUBLIC => \T_PUBLIC,
+ \T_READONLY => \T_READONLY,
+ \T_REQUIRE => \T_REQUIRE,
+ \T_REQUIRE_ONCE => \T_REQUIRE_ONCE,
+ \T_RETURN => \T_RETURN,
+ \T_STATIC => \T_STATIC,
+ \T_SWITCH => \T_SWITCH,
+ \T_THROW => \T_THROW,
+ \T_TRAIT => \T_TRAIT,
+ \T_TRY => \T_TRY,
+ \T_UNSET => \T_UNSET,
+ \T_USE => \T_USE,
+ \T_VAR => \T_VAR,
+ \T_WHILE => \T_WHILE,
+ \T_YIELD => \T_YIELD,
+ \T_YIELD_FROM => \T_YIELD_FROM,
+ ];
+
/**
* Test the method.
*
@@ -212,12 +472,15 @@ public function testUnchangedTokenArrays($name, $expected)
public function dataUnchangedTokenArrays()
{
$phpunitProp = [
- 'backupGlobals' => true,
- 'backupGlobalsBlacklist' => true,
- 'backupStaticAttributes' => true,
- 'backupStaticAttributesBlacklist' => true,
- 'runTestInSeparateProcess' => true,
- 'preserveGlobalState' => true,
+ 'backupGlobals' => true,
+ 'backupGlobalsBlacklist' => true,
+ 'backupGlobalsExcludeList' => true,
+ 'backupStaticAttributes' => true,
+ 'backupStaticAttributesBlacklist' => true,
+ 'backupStaticAttributesExcludeList' => true,
+ 'runTestInSeparateProcess' => true,
+ 'preserveGlobalState' => true,
+ 'providedTests' => true,
];
$data = [];
@@ -240,6 +503,27 @@ public function dataUnchangedTokenArrays()
*/
public function testUndeclaredTokenArray()
{
- $this->assertSame([], BCTokens::notATokenArray());
+ $this->expectException('PHPCSUtils\Exceptions\InvalidTokenArray');
+ $this->expectExceptionMessage('Call to undefined method PHPCSUtils\BackCompat\BCTokens::notATokenArray()');
+
+ BCTokens::notATokenArray();
+ }
+
+ /**
+ * Test whether the method in BCTokens is still in sync with the latest version of PHPCS.
+ *
+ * This group is not run by default and has to be specifically requested to be run.
+ *
+ * @group compareWithPHPCS
+ *
+ * @dataProvider dataUnchangedTokenArrays
+ *
+ * @param string $name The token array name.
+ *
+ * @return void
+ */
+ public function testPHPCSUnchangedTokenArrays($name)
+ {
+ $this->assertSame(Tokens::${$name}, BCTokens::$name());
}
}
diff --git a/Tests/BackCompat/Helper/ConfigDataTest.php b/Tests/BackCompat/Helper/ConfigDataTest.php
index 5677d454..9c3b1fcd 100644
--- a/Tests/BackCompat/Helper/ConfigDataTest.php
+++ b/Tests/BackCompat/Helper/ConfigDataTest.php
@@ -13,6 +13,7 @@
use PHP_CodeSniffer\Config;
use PHPCSUtils\BackCompat\Helper;
use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\Polyfills\ExpectException;
/**
* Test class.
@@ -24,8 +25,9 @@
*
* @since 1.0.0
*/
-class ConfigDataTest extends TestCase
+final class ConfigDataTest extends TestCase
{
+ use ExpectException;
/**
* Test the getConfigData() and setConfigData() method when used in a cross-version compatible manner.
@@ -34,10 +36,6 @@ class ConfigDataTest extends TestCase
*/
public function testConfigData34()
{
- if (\version_compare(Helper::getVersion(), '2.99.99', '<=') === true) {
- $this->markTestSkipped('Test only applicable to PHPCS > 2.x');
- }
-
$config = new Config();
$original = Helper::getConfigData('arbitrary_name');
$expected = 'expected';
@@ -57,7 +55,7 @@ public function testConfigData34()
*
* @return void
*/
- public function testConfigDataPHPCS23()
+ public function testConfigDataPHPCS3()
{
if (\version_compare(Helper::getVersion(), '3.99.99', '>') === true) {
$this->markTestSkipped('Test only applicable to PHPCS < 4.x');
@@ -87,17 +85,8 @@ public function testConfigDataPHPCS4Exception()
$this->markTestSkipped('Test only applicable to PHPCS 4.x');
}
- $msg = 'Passing the $config parameter is required in PHPCS 4.x';
- $exception = 'PHP_CodeSniffer\Exceptions\RuntimeException';
-
- if (\method_exists($this, 'expectException')) {
- // PHPUnit 5+.
- $this->expectException($exception);
- $this->expectExceptionMessage($msg);
- } else {
- // PHPUnit 4.
- $this->setExpectedException($exception, $msg);
- }
+ $this->expectException('PHP_CodeSniffer\Exceptions\RuntimeException');
+ $this->expectExceptionMessage('Passing the $config parameter is required in PHPCS 4.x');
Helper::setConfigData('arbitrary_name', 'test', true);
}
diff --git a/Tests/BackCompat/Helper/GetCommandLineDataTest.inc b/Tests/BackCompat/Helper/GetCommandLineDataTest.inc
deleted file mode 100644
index 3e0f3b14..00000000
--- a/Tests/BackCompat/Helper/GetCommandLineDataTest.inc
+++ /dev/null
@@ -1,3 +0,0 @@
-assertSame($expected, $result);
}
/**
* Test the getCommandLineData() method when requesting an unknown setting.
*
- * @covers \PHPCSUtils\BackCompat\Helper::getCommandLineData
+ * @covers ::getCommandLineData
*
* @return void
*/
@@ -59,149 +69,106 @@ public function testGetCommandLineDataNull()
/**
* Test the getTabWidth() method.
*
- * @covers \PHPCSUtils\BackCompat\Helper::getTabWidth
+ * @covers ::getTabWidth
*
* @return void
*/
public function testGetTabWidth()
{
+ self::$phpcsFile->config->tabWidth = null;
+
$result = Helper::getTabWidth(self::$phpcsFile);
$this->assertSame(4, $result, 'Failed retrieving the default tab width');
- if (\version_compare(static::$phpcsVersion, '2.99.99', '>') === true) {
- // PHPCS 3.x.
- self::$phpcsFile->config->tabWidth = 2;
- } else {
- // PHPCS 2.x.
- self::$phpcsFile->phpcs->cli->setCommandLineValues(['--tab-width=2']);
- }
+ self::$phpcsFile->config->tabWidth = 2;
$result = Helper::getTabWidth(self::$phpcsFile);
- $this->assertSame(2, $result, 'Failed retrieving the custom set tab width');
- // Restore defaults before moving to the next test.
- if (\version_compare(static::$phpcsVersion, '2.99.99', '>') === true) {
- self::$phpcsFile->config->restoreDefaults();
- } else {
- self::$phpcsFile->phpcs->cli->setCommandLineValues(['--tab-width=4']);
- }
+ // Restore default before moving to the next test.
+ self::$phpcsFile->config->restoreDefaults();
+
+ $this->assertSame(2, $result, 'Failed retrieving the custom set tab width');
}
/**
* Test the getEncoding() method.
*
- * @covers \PHPCSUtils\BackCompat\Helper::getEncoding
+ * @covers ::getEncoding
*
* @return void
*/
public function testGetEncoding()
{
+ self::$phpcsFile->config->encoding = null;
+
$result = Helper::getEncoding(self::$phpcsFile);
- $expected = \version_compare(static::$phpcsVersion, '2.99.99', '>') ? 'utf-8' : 'iso-8859-1';
+ $expected = 'utf-8';
$this->assertSame($expected, $result, 'Failed retrieving the default encoding');
- if (\version_compare(static::$phpcsVersion, '2.99.99', '>') === true) {
- // PHPCS 3.x.
- self::$phpcsFile->config->encoding = 'utf-16';
- } else {
- // PHPCS 2.x.
- self::$phpcsFile->phpcs->cli->setCommandLineValues(['--encoding=utf-16']);
- }
+ self::$phpcsFile->config->encoding = 'utf-16';
$result = Helper::getEncoding(self::$phpcsFile);
- $this->assertSame('utf-16', $result, 'Failed retrieving the custom set encoding');
- // Restore defaults before moving to the next test.
- if (\version_compare(static::$phpcsVersion, '2.99.99', '>') === true) {
- self::$phpcsFile->config->restoreDefaults();
- } else {
- self::$phpcsFile->phpcs->cli->setCommandLineValues(['--encoding=iso-8859-1']);
- }
+ // Restore default before moving to the next test.
+ self::$phpcsFile->config->restoreDefaults();
+
+ $this->assertSame('utf-16', $result, 'Failed retrieving the custom set encoding');
}
/**
* Test the getEncoding() method when not passing the PHPCS file parameter.
*
- * @covers \PHPCSUtils\BackCompat\Helper::getEncoding
+ * @covers ::getEncoding
*
* @return void
*/
public function testGetEncodingWithoutPHPCSFile()
{
+ self::$phpcsFile->config->encoding = null;
+
$result = Helper::getEncoding();
- $expected = \version_compare(static::$phpcsVersion, '2.99.99', '>') ? 'utf-8' : 'iso-8859-1';
+ $expected = 'utf-8';
$this->assertSame($expected, $result, 'Failed retrieving the default encoding');
- $config = null;
- if (isset(self::$phpcsFile->config) === true) {
- $config = self::$phpcsFile->config;
- }
-
- Helper::setConfigData('encoding', 'utf-16', true, $config);
+ Helper::setConfigData('encoding', 'utf-16', true, self::$phpcsFile->config);
$result = Helper::getEncoding();
- $this->assertSame('utf-16', $result, 'Failed retrieving the custom set encoding');
// Restore defaults before moving to the next test.
- if (\version_compare(static::$phpcsVersion, '2.99.99', '>') === true) {
- Helper::setConfigData('encoding', 'utf-8', true, $config);
- } else {
- Helper::setConfigData('encoding', 'iso-8859-1', true, $config);
- }
- }
-
- /**
- * Test the ignoreAnnotations() method.
- *
- * @covers \PHPCSUtils\BackCompat\Helper::ignoreAnnotations
- *
- * @return void
- */
- public function testIgnoreAnnotationsV2()
- {
- if (\version_compare(static::$phpcsVersion, '2.99.99', '>') === true) {
- $this->markTestSkipped('Test only applicable to PHPCS 2.x');
- }
+ Helper::setConfigData('encoding', 'utf-8', true, self::$phpcsFile->config);
- $this->assertFalse(Helper::ignoreAnnotations());
+ $this->assertSame('utf-16', $result, 'Failed retrieving the custom set encoding');
}
/**
* Test the ignoreAnnotations() method.
*
- * @covers \PHPCSUtils\BackCompat\Helper::ignoreAnnotations
+ * @covers ::ignoreAnnotations
*
* @return void
*/
- public function testIgnoreAnnotationsV3Default()
+ public function testIgnoreAnnotationsDefault()
{
- if (\version_compare(static::$phpcsVersion, '2.99.99', '<=') === true) {
- $this->markTestSkipped('Test only applicable to PHPCS 3.x');
- }
-
$result = Helper::ignoreAnnotations();
$this->assertFalse($result, 'Failed default ignoreAnnotations test without passing $phpcsFile');
$result = Helper::ignoreAnnotations(self::$phpcsFile);
- $this->assertFalse($result, 'Failed default ignoreAnnotations test while passing $phpcsFile');
// Restore defaults before moving to the next test.
self::$phpcsFile->config->restoreDefaults();
+
+ $this->assertFalse($result, 'Failed default ignoreAnnotations test while passing $phpcsFile');
}
/**
* Test the ignoreAnnotations() method.
*
- * @covers \PHPCSUtils\BackCompat\Helper::ignoreAnnotations
+ * @covers ::ignoreAnnotations
*
* @return void
*/
- public function testIgnoreAnnotationsV3SetViaMethod()
+ public function testIgnoreAnnotationsSetViaMethod()
{
- if (\version_compare(static::$phpcsVersion, '2.99.99', '<=') === true) {
- $this->markTestSkipped('Test only applicable to PHPCS 3.x');
- }
-
$config = null;
if (isset(self::$phpcsFile->config) === true) {
$config = self::$phpcsFile->config;
@@ -210,31 +177,29 @@ public function testIgnoreAnnotationsV3SetViaMethod()
Helper::setConfigData('annotations', false, true, $config);
$result = Helper::ignoreAnnotations();
- $this->assertTrue($result);
// Restore defaults before moving to the next test.
Helper::setConfigData('annotations', true, true, $config);
+
+ $this->assertTrue($result);
}
/**
* Test the ignoreAnnotations() method.
*
- * @covers \PHPCSUtils\BackCompat\Helper::ignoreAnnotations
+ * @covers ::ignoreAnnotations
*
* @return void
*/
- public function testIgnoreAnnotationsV3SetViaProperty()
+ public function testIgnoreAnnotationsSetViaProperty()
{
- if (\version_compare(static::$phpcsVersion, '2.99.99', '<=') === true) {
- $this->markTestSkipped('Test only applicable to PHPCS 3.x');
- }
-
self::$phpcsFile->config->annotations = false;
$result = Helper::ignoreAnnotations(self::$phpcsFile);
- $this->assertTrue($result);
// Restore defaults before moving to the next test.
self::$phpcsFile->config->restoreDefaults();
+
+ $this->assertTrue($result);
}
}
diff --git a/Tests/BackCompat/Helper/GetVersionTest.php b/Tests/BackCompat/Helper/GetVersionTest.php
index da6862aa..da022fc1 100644
--- a/Tests/BackCompat/Helper/GetVersionTest.php
+++ b/Tests/BackCompat/Helper/GetVersionTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetVersionTest extends TestCase
+final class GetVersionTest extends TestCase
{
/**
@@ -32,7 +32,7 @@ class GetVersionTest extends TestCase
*
* @var string
*/
- const DEVMASTER = '3.5.6';
+ const DEVMASTER = '3.7.1';
/**
* Test the method.
@@ -44,7 +44,7 @@ public function testGetVersion()
$expected = \getenv('PHPCS_VERSION');
if ($expected === false) {
$this->markTestSkipped('The test for the Helper::getVersion() method will only run'
- . ' if the PHPCS_VERSION environment variable is set, such as during a Travis CI build'
+ . ' if the PHPCS_VERSION environment variable is set, such as during a CI build'
. ' or when this variable has been set in the PHPUnit configuration file.');
return;
diff --git a/Tests/DummyFile.inc b/Tests/DummyFile.inc
new file mode 100644
index 00000000..f6de982b
--- /dev/null
+++ b/Tests/DummyFile.inc
@@ -0,0 +1,4 @@
+expectException('PHPCSUtils\Exceptions\InvalidTokenArray');
+ $this->expectExceptionMessage(\sprintf('Call to undefined method %s::dummy()', __CLASS__));
+
+ throw InvalidTokenArray::create('dummy');
+ }
+}
diff --git a/Tests/Exceptions/TestFileNotFound/TestFileNotFoundTest.php b/Tests/Exceptions/TestFileNotFound/TestFileNotFoundTest.php
new file mode 100644
index 00000000..a3760eae
--- /dev/null
+++ b/Tests/Exceptions/TestFileNotFound/TestFileNotFoundTest.php
@@ -0,0 +1,54 @@
+expectException('PHPCSUtils\Exceptions\TestFileNotFound');
+ $this->expectExceptionMessage(
+ 'Failed to find a tokenized test case file.' . \PHP_EOL
+ . 'Make sure the UtilityMethodTestCase::setUpTestFile() method has run'
+ );
+
+ throw new TestFileNotFound();
+ }
+
+ /**
+ * Test that a passed message overruled the default message.
+ *
+ * @return void
+ */
+ public function testWithCustomMessage()
+ {
+ $this->expectException('PHPCSUtils\Exceptions\TestFileNotFound');
+ $this->expectExceptionMessage('foobar');
+
+ throw new TestFileNotFound('foobar');
+ }
+}
diff --git a/Tests/Exceptions/TestMarkerNotFound/TestMarkerNotFoundTest.php b/Tests/Exceptions/TestMarkerNotFound/TestMarkerNotFoundTest.php
new file mode 100644
index 00000000..5b2b1a99
--- /dev/null
+++ b/Tests/Exceptions/TestMarkerNotFound/TestMarkerNotFoundTest.php
@@ -0,0 +1,38 @@
+expectException('PHPCSUtils\Exceptions\TestMarkerNotFound');
+ $this->expectExceptionMessage('Failed to find the test marker: /* testDummy */ in test case file filename.inc');
+
+ throw TestMarkerNotFound::create('/* testDummy */', 'filename.inc');
+ }
+}
diff --git a/Tests/Exceptions/TestTargetNotFound/TestTargetNotFoundTest.php b/Tests/Exceptions/TestTargetNotFound/TestTargetNotFoundTest.php
new file mode 100644
index 00000000..ddb77c84
--- /dev/null
+++ b/Tests/Exceptions/TestTargetNotFound/TestTargetNotFoundTest.php
@@ -0,0 +1,56 @@
+expectException('PHPCSUtils\Exceptions\TestTargetNotFound');
+ $this->expectExceptionMessage(
+ 'Failed to find test target token for comment string: /* testDummy */ in test case file: filename.inc'
+ );
+
+ throw TestTargetNotFound::create('/* testDummy */', null, 'filename.inc');
+ }
+
+ /**
+ * Test that the text of the exception is as expected.
+ *
+ * @return void
+ */
+ public function testCreateWithContent()
+ {
+ $this->expectException('PHPCSUtils\Exceptions\TestTargetNotFound');
+ $this->expectExceptionMessage(
+ 'Failed to find test target token for comment string: /* testDummy */'
+ . ' with token content: foo in test case file: filename.inc'
+ );
+
+ throw TestTargetNotFound::create('/* testDummy */', 'foo', 'filename.inc');
+ }
+}
diff --git a/Tests/Fixers/SpacesFixer/SpacesFixerExceptionsTest.php b/Tests/Fixers/SpacesFixer/SpacesFixerExceptionsTest.php
index 1400c7cc..3ff2ef0e 100644
--- a/Tests/Fixers/SpacesFixer/SpacesFixerExceptionsTest.php
+++ b/Tests/Fixers/SpacesFixer/SpacesFixerExceptionsTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class SpacesFixerExceptionsTest extends UtilityMethodTestCase
+final class SpacesFixerExceptionsTest extends UtilityMethodTestCase
{
/**
diff --git a/Tests/Fixers/SpacesFixer/SpacesFixerNewlineTest.php b/Tests/Fixers/SpacesFixer/SpacesFixerNewlineTest.php
index ce508d0d..9e426aad 100644
--- a/Tests/Fixers/SpacesFixer/SpacesFixerNewlineTest.php
+++ b/Tests/Fixers/SpacesFixer/SpacesFixerNewlineTest.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\Fixers\SpacesFixer;
-use PHPCSUtils\Tests\Fixers\SpacesFixer\SpacesFixerNoSpaceTest;
+use PHPCSUtils\Tests\Fixers\SpacesFixer\SpacesFixerTestCase;
/**
* Tests for the \PHPCSUtils\Fixers\SpacesFixer::checkAndFix() method.
@@ -21,7 +21,7 @@
*
* @since 1.0.0
*/
-class SpacesFixerNewlineTest extends SpacesFixerNoSpaceTest
+final class SpacesFixerNewlineTest extends SpacesFixerTestCase
{
/**
diff --git a/Tests/Fixers/SpacesFixer/SpacesFixerNoSpaceTest.php b/Tests/Fixers/SpacesFixer/SpacesFixerNoSpaceTest.php
index 1fd02d75..366706ef 100644
--- a/Tests/Fixers/SpacesFixer/SpacesFixerNoSpaceTest.php
+++ b/Tests/Fixers/SpacesFixer/SpacesFixerNoSpaceTest.php
@@ -10,8 +10,7 @@
namespace PHPCSUtils\Tests\Fixers\SpacesFixer;
-use PHPCSUtils\Fixers\SpacesFixer;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tests\Fixers\SpacesFixer\SpacesFixerTestCase;
/**
* Tests for the \PHPCSUtils\Fixers\SpacesFixer::checkAndFix() method.
@@ -22,7 +21,7 @@
*
* @since 1.0.0
*/
-class SpacesFixerNoSpaceTest extends UtilityMethodTestCase
+final class SpacesFixerNoSpaceTest extends SpacesFixerTestCase
{
/**
@@ -32,13 +31,6 @@ class SpacesFixerNoSpaceTest extends UtilityMethodTestCase
*/
const SPACES = 0;
- /**
- * Dummy error message phrase to use for the test.
- *
- * @var string
- */
- const MSG = 'Expected: %s. Found: %s';
-
/**
* The expected replacement for the first placeholder.
*
@@ -46,15 +38,6 @@ class SpacesFixerNoSpaceTest extends UtilityMethodTestCase
*/
const MSG_REPLACEMENT_1 = 'no space';
- /**
- * Dummy error code to use for the test.
- *
- * Using the dummy full error code to force it to record.
- *
- * @var string
- */
- const CODE = 'PHPCSUtils.SpacesFixer.Test.Found';
-
/**
* Dummy metric name to use for the test.
*
@@ -69,313 +52,10 @@ class SpacesFixerNoSpaceTest extends UtilityMethodTestCase
*/
protected $compliantCases = ['no-space'];
- /**
- * Full path to the test case file associated with this test class.
- *
- * @var string
- */
- protected static $caseFile = '';
-
/**
* Full path to the fixed version of the test case file associated with this test class.
*
* @var string
*/
protected static $fixedFile = '/SpacesFixerNoSpaceTest.inc.fixed';
-
- /**
- * Set the name of a sniff to pass to PHPCS to limit the run (and force it to record errors).
- *
- * @var array
- */
- protected static $selectedSniff = ['PHPCSUtils.SpacesFixer.Test'];
-
- /**
- * Initialize PHPCS & tokenize the test case file.
- *
- * @beforeClass
- *
- * @return void
- */
- public static function setUpTestFile()
- {
- self::$caseFile = __DIR__ . '/SpacesFixerTest.inc';
- parent::setUpTestFile();
- }
-
- /**
- * Test that no violation is reported for a test case complying with the correct number of spaces.
- *
- * @dataProvider dataCheckAndFixNoError
- *
- * @param string $testMarker The comment which prefaces the target token in the test file.
- * @param array $expected Expected error details (for the metric input).
- *
- * @return void
- */
- public function testCheckAndFixNoError($testMarker, $expected)
- {
- $stackPtr = $this->getTargetToken($testMarker, \T_ARRAY);
- $secondPtr = $this->getTargetToken($testMarker, \T_OPEN_PARENTHESIS);
-
- /*
- * Note: passing $stackPtr and $secondPtr in reverse order to make sure that case is
- * covered by a test as well.
- */
- SpacesFixer::checkAndFix(
- self::$phpcsFile,
- $secondPtr,
- $stackPtr,
- static::SPACES,
- static::MSG,
- static::CODE,
- 'error',
- 0,
- static::METRIC
- );
-
- $result = \array_merge(self::$phpcsFile->getErrors(), self::$phpcsFile->getWarnings());
-
- // Expect no errors.
- $this->assertCount(0, $result, 'Failed to assert that no violations were found');
-
- // Check that the metric is recorded correctly.
- $metrics = self::$phpcsFile->getMetrics();
- $this->assertGreaterThanOrEqual(
- 1,
- $metrics[static::METRIC]['values'][$expected['found']],
- 'Failed recorded metric check'
- );
- }
-
- /**
- * Data Provider.
- *
- * @see testCheckAndFixNoError() For the array format.
- *
- * @return array
- */
- public function dataCheckAndFixNoError()
- {
- $data = [];
- $baseData = $this->getAllData();
-
- foreach ($this->compliantCases as $caseName) {
- if (isset($baseData[$caseName])) {
- $data[$caseName] = $baseData[$caseName];
- }
- }
-
- return $data;
- }
-
- /**
- * Test that violations are correctly reported.
- *
- * @dataProvider dataCheckAndFix
- *
- * @param string $testMarker The comment which prefaces the target token in the test file.
- * @param array $expected Expected error details.
- * @param string $type The message type to test: 'error' or 'warning'.
- *
- * @return void
- */
- public function testCheckAndFix($testMarker, $expected, $type)
- {
- $stackPtr = $this->getTargetToken($testMarker, \T_ARRAY);
- $secondPtr = $this->getTargetToken($testMarker, \T_OPEN_PARENTHESIS);
-
- SpacesFixer::checkAndFix(
- self::$phpcsFile,
- $stackPtr,
- $secondPtr,
- static::SPACES,
- static::MSG,
- static::CODE,
- $type,
- 0,
- static::METRIC
- );
-
- if ($type === 'error') {
- $result = self::$phpcsFile->getErrors();
- } else {
- $result = self::$phpcsFile->getWarnings();
- }
-
- $tokens = self::$phpcsFile->getTokens();
-
- if (isset($result[$tokens[$stackPtr]['line']][$tokens[$stackPtr]['column']]) === false) {
- $this->fail('Expected 1 violation. None found.');
- }
-
- $messages = $result[$tokens[$stackPtr]['line']][$tokens[$stackPtr]['column']];
-
- // Expect one violation.
- $this->assertCount(1, $messages, 'Expected 1 violation, found: ' . \count($messages));
-
- /*
- * Test the violation details.
- */
-
- $expectedMessage = \sprintf(static::MSG, static::MSG_REPLACEMENT_1, $expected['found']);
- $this->assertSame($expectedMessage, $messages[0]['message'], 'Message comparison failed');
-
- // PHPCS 2.x places `unknownSniff.` before the actual error code for utility tests with a dummy error code.
- $errorCodeResult = \str_replace('unknownSniff.', '', $messages[0]['source']);
- $this->assertSame(static::CODE, $errorCodeResult, 'Error code comparison failed');
-
- $this->assertSame($expected['fixable'], $messages[0]['fixable'], 'Fixability comparison failed');
-
- // Check that the metric is recorded correctly.
- $metrics = self::$phpcsFile->getMetrics();
- $this->assertGreaterThanOrEqual(
- 1,
- $metrics[static::METRIC]['values'][$expected['found']],
- 'Failed recorded metric check'
- );
- }
-
- /**
- * Data Provider.
- *
- * @see testCheckAndFix() For the array format.
- *
- * @return array
- */
- public function dataCheckAndFix()
- {
- $data = $this->getAllData();
-
- foreach ($this->compliantCases as $caseName) {
- unset($data[$caseName]);
- }
-
- return $data;
- }
-
- /**
- * Test that the fixes are correctly made.
- *
- * @return void
- */
- public function testFixesMade()
- {
- self::$phpcsFile->fixer->startFile(self::$phpcsFile);
- self::$phpcsFile->fixer->enabled = true;
-
- $data = $this->getAllData();
- foreach ($data as $dataset) {
- $stackPtr = $this->getTargetToken($dataset[0], \T_ARRAY);
- $secondPtr = $this->getTargetToken($dataset[0], \T_OPEN_PARENTHESIS);
-
- SpacesFixer::checkAndFix(
- self::$phpcsFile,
- $stackPtr,
- $secondPtr,
- static::SPACES,
- static::MSG,
- static::CODE,
- $dataset[1],
- 0
- );
- }
-
- $fixedFile = __DIR__ . static::$fixedFile;
- $expected = \file_get_contents($fixedFile);
- $result = self::$phpcsFile->fixer->getContents();
-
- $this->assertSame(
- $expected,
- $result,
- \sprintf(
- 'Fixed version of %s does not match expected version in %s',
- \basename(static::$caseFile),
- \basename($fixedFile)
- )
- );
- }
-
- /**
- * Helper function holding the base data for the data providers.
- *
- * @return array
- */
- protected function getAllData()
- {
- return [
- 'no-space' => [
- '/* testNoSpace */',
- [
- 'found' => 'no spaces',
- 'fixable' => true,
- ],
- 'error',
- ],
- 'one-space' => [
- '/* testOneSpace */',
- [
- 'found' => '1 space',
- 'fixable' => true,
- ],
- 'error',
- ],
- 'two-spaces' => [
- '/* testTwoSpaces */',
- [
- 'found' => '2 spaces',
- 'fixable' => true,
- ],
- 'error',
- ],
- 'multiple-spaces' => [
- '/* testMultipleSpaces */',
- [
- 'found' => '13 spaces',
- 'fixable' => true,
- ],
- 'warning',
- ],
- 'newline-and-trailing-spaces' => [
- '/* testNewlineAndTrailingSpaces */',
- [
- 'found' => 'a new line',
- 'fixable' => true,
- ],
- 'error',
- ],
- 'multiple-newlines-and-spaces' => [
- '/* testMultipleNewlinesAndSpaces */',
- [
- 'found' => 'multiple new lines',
- 'fixable' => true,
- ],
- 'error',
- ],
- 'comment-no-space' => [
- '/* testCommentNoSpace */',
- [
- 'found' => 'non-whitespace tokens',
- 'fixable' => false,
- ],
- 'warning',
- ],
- 'comment-and-space' => [
- '/* testCommentAndSpaces */',
- [
- 'found' => '1 space',
- 'fixable' => false,
- ],
- 'error',
- ],
- 'comment-and-new line' => [
- '/* testCommentAndNewline */',
- [
- 'found' => 'a new line',
- 'fixable' => false,
- ],
- 'error',
- ],
- ];
- }
}
diff --git a/Tests/Fixers/SpacesFixer/SpacesFixerOneSpaceTest.php b/Tests/Fixers/SpacesFixer/SpacesFixerOneSpaceTest.php
index de3cff82..2fe33692 100644
--- a/Tests/Fixers/SpacesFixer/SpacesFixerOneSpaceTest.php
+++ b/Tests/Fixers/SpacesFixer/SpacesFixerOneSpaceTest.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\Fixers\SpacesFixer;
-use PHPCSUtils\Tests\Fixers\SpacesFixer\SpacesFixerNoSpaceTest;
+use PHPCSUtils\Tests\Fixers\SpacesFixer\SpacesFixerTestCase;
/**
* Tests for the \PHPCSUtils\Fixers\SpacesFixer::checkAndFix() method.
@@ -21,7 +21,7 @@
*
* @since 1.0.0
*/
-class SpacesFixerOneSpaceTest extends SpacesFixerNoSpaceTest
+final class SpacesFixerOneSpaceTest extends SpacesFixerTestCase
{
/**
diff --git a/Tests/Fixers/SpacesFixer/SpacesFixerTestCase.php b/Tests/Fixers/SpacesFixer/SpacesFixerTestCase.php
new file mode 100644
index 00000000..57988e94
--- /dev/null
+++ b/Tests/Fixers/SpacesFixer/SpacesFixerTestCase.php
@@ -0,0 +1,383 @@
+getTargetToken($testMarker, \T_ARRAY);
+ $secondPtr = $this->getTargetToken($testMarker, \T_OPEN_PARENTHESIS);
+
+ /*
+ * Note: passing $stackPtr and $secondPtr in reverse order to make sure that case is
+ * covered by a test as well.
+ */
+ SpacesFixer::checkAndFix(
+ self::$phpcsFile,
+ $secondPtr,
+ $stackPtr,
+ static::SPACES,
+ static::MSG,
+ static::CODE,
+ 'error',
+ 0,
+ static::METRIC
+ );
+
+ $result = \array_merge(self::$phpcsFile->getErrors(), self::$phpcsFile->getWarnings());
+
+ // Expect no errors.
+ $this->assertCount(0, $result, 'Failed to assert that no violations were found');
+
+ // Check that the metric is recorded correctly.
+ $metrics = self::$phpcsFile->getMetrics();
+ $this->assertGreaterThanOrEqual(
+ 1,
+ $metrics[static::METRIC]['values'][$expected['found']],
+ 'Failed recorded metric check'
+ );
+ }
+
+ /**
+ * Data Provider.
+ *
+ * @see testCheckAndFixNoError() For the array format.
+ *
+ * @return array
+ */
+ public function dataCheckAndFixNoError()
+ {
+ $data = [];
+ $baseData = $this->getAllData();
+
+ foreach ($this->compliantCases as $caseName) {
+ if (isset($baseData[$caseName])) {
+ $data[$caseName] = $baseData[$caseName];
+ }
+ }
+
+ return $data;
+ }
+
+ /**
+ * Test that violations are correctly reported.
+ *
+ * @covers \PHPCSUtils\Fixers\SpacesFixer::checkAndFix
+ *
+ * @dataProvider dataCheckAndFix
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param array $expected Expected error details.
+ * @param string $type The message type to test: 'error' or 'warning'.
+ *
+ * @return void
+ */
+ public function testCheckAndFix($testMarker, $expected, $type)
+ {
+ $stackPtr = $this->getTargetToken($testMarker, \T_ARRAY);
+ $secondPtr = $this->getTargetToken($testMarker, \T_OPEN_PARENTHESIS);
+
+ SpacesFixer::checkAndFix(
+ self::$phpcsFile,
+ $stackPtr,
+ $secondPtr,
+ static::SPACES,
+ static::MSG,
+ static::CODE,
+ $type,
+ 0,
+ static::METRIC
+ );
+
+ if ($type === 'error') {
+ $result = self::$phpcsFile->getErrors();
+ } else {
+ $result = self::$phpcsFile->getWarnings();
+ }
+
+ $tokens = self::$phpcsFile->getTokens();
+
+ if (isset($result[$tokens[$stackPtr]['line']][$tokens[$stackPtr]['column']]) === false) {
+ $this->fail('Expected 1 violation. None found.');
+ }
+
+ $messages = $result[$tokens[$stackPtr]['line']][$tokens[$stackPtr]['column']];
+
+ // Expect one violation.
+ $this->assertCount(1, $messages, 'Expected 1 violation, found: ' . \count($messages));
+
+ /*
+ * Test the violation details.
+ */
+
+ $expectedMessage = \sprintf(static::MSG, static::MSG_REPLACEMENT_1, $expected['found']);
+ $this->assertSame($expectedMessage, $messages[0]['message'], 'Message comparison failed');
+
+ $this->assertSame(static::CODE, $messages[0]['source'], 'Error code comparison failed');
+
+ $this->assertSame($expected['fixable'], $messages[0]['fixable'], 'Fixability comparison failed');
+
+ // Check that the metric is recorded correctly.
+ $metrics = self::$phpcsFile->getMetrics();
+ $this->assertGreaterThanOrEqual(
+ 1,
+ $metrics[static::METRIC]['values'][$expected['found']],
+ 'Failed recorded metric check'
+ );
+ }
+
+ /**
+ * Data Provider.
+ *
+ * @see testCheckAndFix() For the array format.
+ *
+ * @return array
+ */
+ public function dataCheckAndFix()
+ {
+ $data = $this->getAllData();
+
+ foreach ($this->compliantCases as $caseName) {
+ unset($data[$caseName]);
+ }
+
+ return $data;
+ }
+
+ /**
+ * Test that the fixes are correctly made.
+ *
+ * @covers \PHPCSUtils\Fixers\SpacesFixer::checkAndFix
+ *
+ * @return void
+ */
+ public function testFixesMade()
+ {
+ self::$phpcsFile->fixer->startFile(self::$phpcsFile);
+ self::$phpcsFile->fixer->enabled = true;
+
+ $data = $this->getAllData();
+ foreach ($data as $dataset) {
+ $stackPtr = $this->getTargetToken($dataset['testMarker'], \T_ARRAY);
+ $secondPtr = $this->getTargetToken($dataset['testMarker'], \T_OPEN_PARENTHESIS);
+
+ SpacesFixer::checkAndFix(
+ self::$phpcsFile,
+ $stackPtr,
+ $secondPtr,
+ static::SPACES,
+ static::MSG,
+ static::CODE,
+ $dataset['type'],
+ 0
+ );
+ }
+
+ $fixedFile = __DIR__ . static::$fixedFile;
+ $result = self::$phpcsFile->fixer->getContents();
+
+ $this->assertStringEqualsFile(
+ $fixedFile,
+ $result,
+ \sprintf(
+ 'Fixed version of %s does not match expected version in %s',
+ \basename(static::$caseFile),
+ \basename($fixedFile)
+ )
+ );
+ }
+
+ /**
+ * Helper function holding the base data for the data providers.
+ *
+ * @return array
+ */
+ protected function getAllData()
+ {
+ return [
+ 'no-space' => [
+ 'testMarker' => '/* testNoSpace */',
+ 'expected' => [
+ 'found' => 'no spaces',
+ 'fixable' => true,
+ ],
+ 'type' => 'error',
+ ],
+ 'one-space' => [
+ 'testMarker' => '/* testOneSpace */',
+ 'expected' => [
+ 'found' => '1 space',
+ 'fixable' => true,
+ ],
+ 'type' => 'error',
+ ],
+ 'two-spaces' => [
+ 'testMarker' => '/* testTwoSpaces */',
+ 'expected' => [
+ 'found' => '2 spaces',
+ 'fixable' => true,
+ ],
+ 'type' => 'error',
+ ],
+ 'multiple-spaces' => [
+ 'testMarker' => '/* testMultipleSpaces */',
+ 'expected' => [
+ 'found' => '13 spaces',
+ 'fixable' => true,
+ ],
+ 'type' => 'warning',
+ ],
+ 'newline-and-trailing-spaces' => [
+ 'testMarker' => '/* testNewlineAndTrailingSpaces */',
+ 'expected' => [
+ 'found' => 'a new line',
+ 'fixable' => true,
+ ],
+ 'type' => 'error',
+ ],
+ 'multiple-newlines-and-spaces' => [
+ 'testMarker' => '/* testMultipleNewlinesAndSpaces */',
+ 'expected' => [
+ 'found' => 'multiple new lines',
+ 'fixable' => true,
+ ],
+ 'type' => 'error',
+ ],
+ 'comment-no-space' => [
+ 'testMarker' => '/* testCommentNoSpace */',
+ 'expected' => [
+ 'found' => 'non-whitespace tokens',
+ 'fixable' => false,
+ ],
+ 'type' => 'warning',
+ ],
+ 'comment-and-space' => [
+ 'testMarker' => '/* testCommentAndSpaces */',
+ 'expected' => [
+ 'found' => '1 space',
+ 'fixable' => false,
+ ],
+ 'type' => 'error',
+ ],
+ 'comment-and-new line' => [
+ 'testMarker' => '/* testCommentAndNewline */',
+ 'expected' => [
+ 'found' => 'a new line',
+ 'fixable' => false,
+ ],
+ 'type' => 'error',
+ ],
+ ];
+ }
+}
diff --git a/Tests/Fixers/SpacesFixer/SpacesFixerTwoSpaceTest.php b/Tests/Fixers/SpacesFixer/SpacesFixerTwoSpaceTest.php
index a76f59cd..9c31d17b 100644
--- a/Tests/Fixers/SpacesFixer/SpacesFixerTwoSpaceTest.php
+++ b/Tests/Fixers/SpacesFixer/SpacesFixerTwoSpaceTest.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\Fixers\SpacesFixer;
-use PHPCSUtils\Tests\Fixers\SpacesFixer\SpacesFixerNoSpaceTest;
+use PHPCSUtils\Tests\Fixers\SpacesFixer\SpacesFixerTestCase;
/**
* Tests for the \PHPCSUtils\Fixers\SpacesFixer::checkAndFix() method.
@@ -21,7 +21,7 @@
*
* @since 1.0.0
*/
-class SpacesFixerTwoSpaceTest extends SpacesFixerNoSpaceTest
+final class SpacesFixerTwoSpaceTest extends SpacesFixerTestCase
{
/**
diff --git a/Tests/Fixers/SpacesFixer/TrailingCommentHandlingNewlineTest.inc b/Tests/Fixers/SpacesFixer/TrailingCommentHandlingNewlineTest.inc
new file mode 100644
index 00000000..04245e6b
--- /dev/null
+++ b/Tests/Fixers/SpacesFixer/TrailingCommentHandlingNewlineTest.inc
@@ -0,0 +1,12 @@
+getTargetToken($testMarker, \T_CLOSE_PARENTHESIS);
+ $secondPtr = self::$phpcsFile->findPrevious(\T_WHITESPACE, ($stackPtr - 1), null, true);
+
+ SpacesFixer::checkAndFix(
+ self::$phpcsFile,
+ $stackPtr,
+ $secondPtr,
+ self::SPACES,
+ self::MSG,
+ self::CODE,
+ 'error',
+ 0,
+ self::METRIC
+ );
+
+ $result = \array_merge(self::$phpcsFile->getErrors(), self::$phpcsFile->getWarnings());
+
+ // Expect no errors.
+ $this->assertCount(0, $result, 'Failed to assert that no violations were found');
+
+ // Check that the metric is recorded correctly.
+ $metrics = self::$phpcsFile->getMetrics();
+ $this->assertGreaterThanOrEqual(
+ 1,
+ $metrics[self::METRIC]['values'][self::MSG_REPLACEMENT_1],
+ 'Failed recorded metric check'
+ );
+ }
+
+ /**
+ * Test that no fixes are made.
+ *
+ * @return void
+ */
+ public function testNoFixesMade()
+ {
+ self::$phpcsFile->fixer->startFile(self::$phpcsFile);
+ self::$phpcsFile->fixer->enabled = true;
+
+ $data = $this->dataCheckAndFixNoError();
+ foreach ($data as $dataset) {
+ $stackPtr = $this->getTargetToken($dataset[0], \T_CLOSE_PARENTHESIS);
+ $secondPtr = self::$phpcsFile->findPrevious(\T_WHITESPACE, ($stackPtr - 1), null, true);
+
+ SpacesFixer::checkAndFix(
+ self::$phpcsFile,
+ $stackPtr,
+ $secondPtr,
+ self::SPACES,
+ self::MSG,
+ self::CODE,
+ 'error'
+ );
+ }
+
+ $fixedFile = __DIR__ . '/TrailingCommentHandlingNewlineTest.inc';
+ $result = self::$phpcsFile->fixer->getContents();
+
+ $this->assertStringEqualsFile(
+ $fixedFile,
+ $result,
+ \sprintf(
+ 'Fixed version of %s does not match expected version in %s',
+ \basename(self::$caseFile),
+ \basename($fixedFile)
+ )
+ );
+ }
+
+ /**
+ * Data Provider.
+ *
+ * @see testCheckAndFixNoError() For the array format.
+ *
+ * @return array
+ */
+ public function dataCheckAndFixNoError()
+ {
+ return [
+ 'correct-newline-before' => [
+ '/* testNewlineWithTrailingCommentBefore */',
+ ],
+ 'correct-blank-line-before' => [
+ '/* testNewlineWithTrailingBlankLineBefore */',
+ ],
+ ];
+ }
+}
diff --git a/Tests/Fixers/SpacesFixer/TrailingCommentHandlingTest.php b/Tests/Fixers/SpacesFixer/TrailingCommentHandlingTest.php
index a04858b3..5c771d57 100644
--- a/Tests/Fixers/SpacesFixer/TrailingCommentHandlingTest.php
+++ b/Tests/Fixers/SpacesFixer/TrailingCommentHandlingTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class TrailingCommentHandlingTest extends UtilityMethodTestCase
+final class TrailingCommentHandlingTest extends UtilityMethodTestCase
{
/**
@@ -120,9 +120,7 @@ public function testCheckAndFix($testMarker, $expected, $type)
$expectedMessage = \sprintf(self::MSG, self::MSG_REPLACEMENT_1, $expected['found']);
$this->assertSame($expectedMessage, $messages[0]['message'], 'Message comparison failed');
- // PHPCS 2.x places `unknownSniff.` before the actual error code for utility tests with a dummy error code.
- $errorCodeResult = \str_replace('unknownSniff.', '', $messages[0]['source']);
- $this->assertSame(self::CODE, $errorCodeResult, 'Error code comparison failed');
+ $this->assertSame(self::CODE, $messages[0]['source'], 'Error code comparison failed');
$this->assertSame($expected['fixable'], $messages[0]['fixable'], 'Fixability comparison failed');
@@ -132,7 +130,7 @@ public function testCheckAndFix($testMarker, $expected, $type)
// Check that no metric is recorded.
$metrics = self::$phpcsFile->getMetrics();
$this->assertFalse(
- isset($metrics[static::METRIC]['values'][$expected['found']]),
+ isset($metrics[self::METRIC]['values'][$expected['found']]),
'Failed recorded metric check'
);
}
@@ -149,8 +147,8 @@ public function testFixesMade()
$data = $this->dataCheckAndFix();
foreach ($data as $dataset) {
- $stackPtr = $this->getTargetToken($dataset[0], \T_COMMENT);
- $secondPtr = $this->getTargetToken($dataset[0], \T_LNUMBER, '3');
+ $stackPtr = $this->getTargetToken($dataset['testMarker'], \T_COMMENT);
+ $secondPtr = $this->getTargetToken($dataset['testMarker'], \T_LNUMBER, '3');
SpacesFixer::checkAndFix(
self::$phpcsFile,
@@ -159,16 +157,15 @@ public function testFixesMade()
self::SPACES,
self::MSG,
self::CODE,
- $dataset[1]
+ $dataset['type']
);
}
$fixedFile = __DIR__ . '/TrailingCommentHandlingTest.inc.fixed';
- $expected = \file_get_contents($fixedFile);
$result = self::$phpcsFile->fixer->getContents();
- $this->assertSame(
- $expected,
+ $this->assertStringEqualsFile(
+ $fixedFile,
$result,
\sprintf(
'Fixed version of %s does not match expected version in %s',
@@ -189,20 +186,20 @@ public function dataCheckAndFix()
{
return [
'trailing-comment-not-fixable' => [
- '/* testTrailingOpenCommentAsPtrA */',
- [
+ 'testMarker' => '/* testTrailingOpenCommentAsPtrA */',
+ 'expected' => [
'found' => 'a new line',
'fixable' => false,
],
- 'error',
+ 'type' => 'error',
],
'trailing-comment-fixable' => [
- '/* testTrailingClosedCommentAsPtrA */',
- [
+ 'testMarker' => '/* testTrailingClosedCommentAsPtrA */',
+ 'expected' => [
'found' => 'a new line',
'fixable' => true,
],
- 'error',
+ 'type' => 'error',
],
];
}
diff --git a/Tests/Internal/Cache/GetClearTest.php b/Tests/Internal/Cache/GetClearTest.php
new file mode 100644
index 00000000..420394a1
--- /dev/null
+++ b/Tests/Internal/Cache/GetClearTest.php
@@ -0,0 +1,419 @@
+ $dataset) {
+ Cache::set(self::$phpcsFile, 'Utility1', $id, $dataset['input']);
+ Cache::set(self::$phpcsFile, 'Utility2', $id, $dataset['input']);
+ }
+ }
+
+ /**
+ * Clear the cache between tests and reset the base fixer loop.
+ *
+ * @after
+ *
+ * @return void
+ */
+ protected function clearCacheAndFixer()
+ {
+ Cache::clear();
+ self::$phpcsFile->fixer->enabled = false;
+ self::$phpcsFile->fixer->loops = 0;
+ }
+
+ /**
+ * Reset the caching status.
+ *
+ * @afterClass
+ *
+ * @return void
+ */
+ public static function resetCachingStatus()
+ {
+ Cache::$enabled = self::$origCacheEnabled;
+ }
+
+ /**
+ * Test that a cache for a loop which has not been set is identified correctly as such.
+ *
+ * @covers ::isCached
+ *
+ * @return void
+ */
+ public function testIsCachedWillReturnFalseForUnavailableLoop()
+ {
+ self::$phpcsFile->fixer->enabled = true;
+ self::$phpcsFile->fixer->loops = 3;
+ $this->assertFalse(Cache::isCached(self::$phpcsFile, 'Utility1', 'numeric string'));
+ }
+
+ /**
+ * Test that a cache key which has not been set is identified correctly as such.
+ *
+ * @covers ::isCached
+ *
+ * @return void
+ */
+ public function testIsCachedWillReturnFalseForUnavailableKey()
+ {
+ $this->assertFalse(Cache::isCached(self::$phpcsFile, 'Utility3', 'numeric string'));
+ }
+
+ /**
+ * Test that a cache id which has not been set is identified correctly as such.
+ *
+ * @covers ::isCached
+ *
+ * @return void
+ */
+ public function testIsCachedWillReturnFalseForUnavailableId()
+ {
+ $this->assertFalse(Cache::isCached(self::$phpcsFile, 'Utility1', 'this ID does not exist'));
+ }
+
+ /**
+ * Test that disabling the cache will short-circuit cache checking.
+ *
+ * @covers ::isCached
+ *
+ * @return void
+ */
+ public function testIsCachedWillReturnFalseWhenCachingDisabled()
+ {
+ $wasEnabled = Cache::$enabled;
+ Cache::$enabled = false;
+
+ $isCached = Cache::isCached(self::$phpcsFile, 'Utility1', 'numeric string');
+
+ Cache::$enabled = $wasEnabled;
+
+ $this->assertFalse($isCached);
+ }
+
+ /**
+ * Test that retrieving a cache key for a loop which has not been set, yields null.
+ *
+ * @covers ::get
+ *
+ * @return void
+ */
+ public function testGetWillReturnNullForUnavailableLoop()
+ {
+ self::$phpcsFile->fixer->enabled = true;
+ self::$phpcsFile->fixer->loops = 2;
+ $this->assertNull(Cache::get(self::$phpcsFile, 'Utility1', 'numeric string'));
+ }
+
+ /**
+ * Test that retrieving a cache key which has not been set, yields null.
+ *
+ * @covers ::get
+ *
+ * @return void
+ */
+ public function testGetWillReturnNullForUnavailableKey()
+ {
+ $this->assertNull(Cache::get(self::$phpcsFile, 'Utility3', 'numeric string'));
+ }
+
+ /**
+ * Test that retrieving a cache id which has not been set, yields null.
+ *
+ * @covers ::get
+ *
+ * @return void
+ */
+ public function testGetWillReturnNullForUnavailableId()
+ {
+ $this->assertNull(Cache::get(self::$phpcsFile, 'Utility1', 'this ID does not exist'));
+ }
+
+ /**
+ * Test that disabling the cache will short-circuit cache retrieval.
+ *
+ * @covers ::get
+ *
+ * @return void
+ */
+ public function testGetWillReturnNullWhenCachingDisabled()
+ {
+ $wasEnabled = Cache::$enabled;
+ Cache::$enabled = false;
+
+ $retrieved = Cache::get(self::$phpcsFile, 'Utility1', 'numeric string');
+
+ Cache::$enabled = $wasEnabled;
+
+ $this->assertNull($retrieved);
+ }
+
+ /**
+ * Test that retrieving a cache set for a loop which has not been set, yields an empty array.
+ *
+ * @covers ::getForFile
+ *
+ * @return void
+ */
+ public function testGetForFileWillReturnEmptyArrayForUnavailableLoop()
+ {
+ self::$phpcsFile->fixer->enabled = true;
+ self::$phpcsFile->fixer->loops = 15;
+ $this->assertSame([], Cache::getForFile(self::$phpcsFile, 'Utility1'));
+ }
+
+ /**
+ * Test that retrieving a cache set for a cache key which has not been set, yields an empty array.
+ *
+ * @covers ::getForFile
+ *
+ * @return void
+ */
+ public function testGetForFileWillReturnEmptyArrayForUnavailableKey()
+ {
+ $this->assertSame([], Cache::getForFile(self::$phpcsFile, 'Utility3'));
+ }
+
+ /**
+ * Test that disabling the cache will short-circuit cache for file retrieval.
+ *
+ * @covers ::getForFile
+ *
+ * @return void
+ */
+ public function testGetForFileWillReturnEmptyArrayWhenCachingDisabled()
+ {
+ $wasEnabled = Cache::$enabled;
+ Cache::$enabled = false;
+
+ $retrieved = Cache::getForFile(self::$phpcsFile, 'Utility1');
+
+ Cache::$enabled = $wasEnabled;
+
+ $this->assertSame([], $retrieved);
+ }
+
+ /**
+ * Test that previously cached data can be retrieved correctly.
+ *
+ * @dataProvider dataEveryTypeOfInput
+ *
+ * @covers ::get
+ *
+ * @param int|string $id The ID of the cached value to retrieve.
+ * @param mixed $expected The expected cached value.
+ *
+ * @return void
+ */
+ public function testGetWillRetrievedPreviouslySetValue($id, $expected)
+ {
+ if (\is_object($expected)) {
+ $this->assertEquals($expected, Cache::get(self::$phpcsFile, 'Utility1', $id));
+ } else {
+ $this->assertSame($expected, Cache::get(self::$phpcsFile, 'Utility1', $id));
+ }
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function dataEveryTypeOfInput()
+ {
+ $allTypes = TypeProviderHelper::getAll();
+ $data = [];
+ foreach ($allTypes as $key => $dataset) {
+ $data[$key] = [
+ 'id' => $key,
+ 'expected' => $dataset['input'],
+ ];
+ }
+
+ return $data;
+ }
+
+ /**
+ * Test that the `getForFile()` method correctly retrieves a subset of the cached data.
+ *
+ * @covers ::getForFile
+ *
+ * @return void
+ */
+ public function testGetForFile()
+ {
+ $dataSet1 = Cache::getForFile(self::$phpcsFile, 'Utility1');
+ $dataSet2 = Cache::getForFile(self::$phpcsFile, 'Utility2');
+ $this->assertSame($dataSet1, $dataSet2);
+ }
+
+ /**
+ * Test that data cached during a previous loop will not be recognized once we're in a different loop.
+ *
+ * @covers ::isCached
+ *
+ * @return void
+ */
+ public function testIsCachedWillNotConfuseDataFromDifferentLoops()
+ {
+ $id = 50;
+
+ // Set an initial cache value and verify it is available.
+ Cache::set(self::$phpcsFile, __METHOD__, $id, 'Test value');
+
+ $this->assertTrue(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $id),
+ 'Cache::isCached() could not find the originally cached value'
+ );
+
+ self::$phpcsFile->fixer->enabled = true;
+ self::$phpcsFile->fixer->loops = 2;
+
+ // Verify that the original cache is disregarded.
+ $this->assertFalse(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $id),
+ 'Cache::isCached() still found the originally cached value'
+ );
+ }
+
+ /**
+ * Test that data cached during a previous loop will not be returned once we're in a different loop.
+ *
+ * @covers ::get
+ *
+ * @return void
+ */
+ public function testGetWillNotConfuseDataFromDifferentLoops()
+ {
+ $id = 872;
+
+ // Set an initial cache value and verify it is available.
+ Cache::set(self::$phpcsFile, __METHOD__, $id, 'Test value');
+
+ $this->assertTrue(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $id),
+ 'Cache::isCached() could not find the originally cached value'
+ );
+
+ self::$phpcsFile->fixer->enabled = true;
+ self::$phpcsFile->fixer->loops = 4;
+
+ // Verify that the original cache is disregarded.
+ $this->assertNull(
+ Cache::get(self::$phpcsFile, __METHOD__, $id),
+ 'Cache::get() still returned the originally cached value'
+ );
+ }
+
+ /**
+ * Test that data cached during a previous loop will not be returned once we're in a different loop.
+ *
+ * @covers ::getForFile
+ *
+ * @return void
+ */
+ public function testGetForFileWillNotConfuseDataFromDifferentLoops()
+ {
+ $id = 233;
+
+ // Set an initial cache value and verify it is available.
+ Cache::set(self::$phpcsFile, __METHOD__, $id, 'Test value');
+
+ $this->assertTrue(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $id),
+ 'Cache::isCached() could not find the originally cached value'
+ );
+
+ self::$phpcsFile->fixer->enabled = true;
+ self::$phpcsFile->fixer->loops = 1;
+
+ // Verify that the original cache is disregarded.
+ $this->assertSame(
+ [],
+ Cache::getForFile(self::$phpcsFile, __METHOD__),
+ 'Cache::getForFile() still returned the originally cached value'
+ );
+ }
+
+ /**
+ * Test that previously cached data is no longer available when the cache has been cleared.
+ *
+ * @dataProvider dataEveryTypeOfInput
+ *
+ * @covers ::clear
+ *
+ * @param int|string $id The ID of the cached value to retrieve.
+ *
+ * @return void
+ */
+ public function testClearCache($id)
+ {
+ Cache::clear();
+
+ $this->assertFalse(Cache::isCached(self::$phpcsFile, 'Utility1', $id));
+ $this->assertFalse(Cache::isCached(self::$phpcsFile, 'Utility2', $id));
+ }
+}
diff --git a/Tests/Internal/Cache/SetTest.php b/Tests/Internal/Cache/SetTest.php
new file mode 100644
index 00000000..b82e67ec
--- /dev/null
+++ b/Tests/Internal/Cache/SetTest.php
@@ -0,0 +1,308 @@
+fixer->enabled = false;
+ self::$phpcsFile->fixer->loops = 0;
+ }
+
+ /**
+ * Reset the caching status.
+ *
+ * @afterClass
+ *
+ * @return void
+ */
+ public static function resetCachingStatus()
+ {
+ Cache::$enabled = self::$origCacheEnabled;
+ }
+
+ /**
+ * Test that every data type is accepted as a cachable value, including `null`, that the
+ * `Cache::isCached()` function recognizes a set value correctly and that all values can be retrieved.
+ *
+ * @dataProvider dataEveryTypeOfInput
+ *
+ * @param mixed $input Value to cache.
+ *
+ * @return void
+ */
+ public function testSetAcceptsEveryTypeOfInput($input)
+ {
+ $id = $this->getName();
+ Cache::set(self::$phpcsFile, __METHOD__, $id, $input);
+
+ $this->assertTrue(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $id),
+ 'Cache::isCached() could not find the cached value'
+ );
+
+ $this->assertSame(
+ $input,
+ Cache::get(self::$phpcsFile, __METHOD__, $id),
+ 'Value retrieved via Cache::get() did not match expectations'
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function dataEveryTypeOfInput()
+ {
+ return TypeProviderHelper::getAll();
+ }
+
+ /**
+ * Verify that all supported types of IDs are accepted.
+ *
+ * Note: this doesn't test the unhappy path of passing an unsupported type of key, but
+ * non-int/string keys are not accepted by PHP for arrays anyway, so that should result
+ * in PHP warnings/errors anyway and as this is an internal class, I'm not too concerned
+ * about that kind of mistake being made.
+ *
+ * @dataProvider dataSetAcceptsIntAndStringIdKeys
+ *
+ * @param int|string $id ID for the cache.
+ *
+ * @return void
+ */
+ public function testSetAcceptsIntAndStringIdKeys($id)
+ {
+ $value = 'value' . $id;
+
+ Cache::set(self::$phpcsFile, __METHOD__, $id, $value);
+
+ $this->assertTrue(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $id),
+ 'Cache::isCached() could not find the cached value'
+ );
+
+ $this->assertSame(
+ $value,
+ Cache::get(self::$phpcsFile, __METHOD__, $id),
+ 'Value retrieved via Cache::get() did not match expectations'
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function dataSetAcceptsIntAndStringIdKeys()
+ {
+ return [
+ 'ID: int zero' => [
+ 'id' => 0,
+ ],
+ 'ID: positive int' => [
+ 'id' => 12832,
+ ],
+ 'ID: negative int' => [
+ 'id' => -274,
+ ],
+ 'ID: string' => [
+ 'id' => 'string ID',
+ ],
+ ];
+ }
+
+ /**
+ * Verify that a previously set cached value will be overwritten when set() is called again
+ * with the same file, ID and key.
+ *
+ * @return void
+ */
+ public function testSetWillOverwriteExistingValue()
+ {
+ $id = 'my key';
+ $origValue = 'original value';
+
+ Cache::set(self::$phpcsFile, __METHOD__, $id, $origValue);
+
+ // Verify that the original value was set correctly.
+ $this->assertTrue(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $id),
+ 'Cache::isCached() could not find the originally cached value'
+ );
+ $this->assertSame(
+ $origValue,
+ Cache::get(self::$phpcsFile, __METHOD__, $id),
+ 'Original value retrieved via Cache::get() did not match expectations'
+ );
+
+ $newValue = 'new value';
+ Cache::set(self::$phpcsFile, __METHOD__, $id, $newValue);
+
+ // Verify the overwrite happened.
+ $this->assertTrue(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $id),
+ 'Cache::isCached() could not find the newly cached value'
+ );
+ $this->assertSame(
+ $newValue,
+ Cache::get(self::$phpcsFile, __METHOD__, $id),
+ 'New value retrieved via Cache::get() did not match expectations'
+ );
+ }
+
+ /**
+ * Verify that disabling the cache will short-circuit caching (and not eat memory).
+ *
+ * @return void
+ */
+ public function testSetWillNotSaveDataWhenCachingIsDisabled()
+ {
+ $id = 'id';
+ $value = 'value';
+
+ $wasEnabled = Cache::$enabled;
+ Cache::$enabled = false;
+
+ Cache::set(self::$phpcsFile, __METHOD__, $id, $value);
+
+ Cache::$enabled = $wasEnabled;
+
+ $this->assertFalse(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $id),
+ 'Cache::isCached() found a cache which was set while caching was disabled'
+ );
+
+ $this->assertNull(
+ Cache::get(self::$phpcsFile, __METHOD__, $id),
+ 'Value retrieved via Cache::get() did not match expectations'
+ );
+ }
+
+ /**
+ * Test that previously cached data is no longer available if the fixer has moved on to the next loop.
+ *
+ * @return void
+ */
+ public function testSetDoesNotClearCacheWhenFixerDisabled()
+ {
+ $idA = 50;
+ $idB = 52;
+
+ // Set an initial cache value and verify it is available.
+ Cache::set(self::$phpcsFile, __METHOD__, $idA, 'Test value');
+
+ $this->assertTrue(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $idA),
+ 'Cache::isCached() could not find the originally cached value'
+ );
+
+ // Changing loops without the fixer being available should have no effect.
+ self::$phpcsFile->fixer->loops = 5;
+ Cache::set(self::$phpcsFile, 'Another method', $idB, 'Test value');
+
+ // Verify the original cache is still available.
+ $this->assertTrue(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $idA),
+ 'Cache::isCached() could not find the originally cached value'
+ );
+ // ... as well as the newly cached value
+ $this->assertTrue(
+ Cache::isCached(self::$phpcsFile, 'Another method', $idB),
+ 'Cache::isCached() could not find the newly cached value'
+ );
+ }
+
+ /**
+ * Test that previously cached data is no longer available if the fixer has moved on to the next loop.
+ *
+ * @return void
+ */
+ public function testSetClearsCacheOnDifferentLoop()
+ {
+ $idA = 123;
+ $idB = 276;
+
+ // Set an initial cache value and verify it is available.
+ Cache::set(self::$phpcsFile, __METHOD__, $idA, 'Test value');
+
+ $this->assertTrue(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $idA),
+ 'Cache::isCached() could not find the originally cached value'
+ );
+
+ // Set a different cache on a different loop, which should clear the original cache.
+ self::$phpcsFile->fixer->enabled = true;
+ self::$phpcsFile->fixer->loops = 5;
+ Cache::set(self::$phpcsFile, 'Another method', $idB, 'Test value');
+
+ // Verify the original cache is no longer available.
+ $this->assertFalse(
+ Cache::isCached(self::$phpcsFile, __METHOD__, $idA),
+ 'Cache::isCached() still found the originally cached value'
+ );
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrList/ConstructorTest.inc b/Tests/Internal/IsShortArrayOrList/ConstructorTest.inc
new file mode 100644
index 00000000..01bca02d
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/ConstructorTest.inc
@@ -0,0 +1,20 @@
+expectPhpcsException(
+ 'The IsShortArrayOrList class expects to be passed a T_OPEN_SHORT_ARRAY or T_OPEN_SQUARE_BRACKET token.'
+ );
+
+ new IsShortArrayOrList(self::$phpcsFile, 100000);
+ }
+
+ /**
+ * Test receiving an exception when a non-bracket token is passed.
+ *
+ * @dataProvider dataNotOpenBracket
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int|string|array $targetType The token type(s) to look for.
+ *
+ * @return void
+ */
+ public function testNotOpenBracket($testMarker, $targetType)
+ {
+ $this->expectPhpcsException(
+ 'The IsShortArrayOrList class expects to be passed a T_OPEN_SHORT_ARRAY or T_OPEN_SQUARE_BRACKET token.'
+ );
+
+ $target = $this->getTargetToken($testMarker, $targetType);
+ new IsShortArrayOrList(self::$phpcsFile, $target);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testNotBracket() For the array format.
+ *
+ * @return array
+ */
+ public function dataNotOpenBracket()
+ {
+ return [
+ 'long-array' => [
+ 'testMarker' => '/* testLongArray */',
+ 'targetType' => \T_ARRAY,
+ ],
+ 'long-list' => [
+ 'testMarker' => '/* testLongList */',
+ 'targetType' => \T_LIST,
+ ],
+ 'short-array-close-bracket' => [
+ 'testMarker' => '/* testShortArray */',
+ 'targetType' => \T_CLOSE_SHORT_ARRAY,
+ ],
+ 'short-list-close-bracket' => [
+ 'testMarker' => '/* testShortList */',
+ 'targetType' => \T_CLOSE_SHORT_ARRAY,
+ ],
+ 'square-brackets-close-bracket' => [
+ 'testMarker' => '/* testSquareBrackets */',
+ 'targetType' => \T_CLOSE_SQUARE_BRACKET,
+ ],
+ ];
+ }
+
+ /**
+ * Test the constructor accepts all supported token types which are allowed to be passed to it.
+ *
+ * @dataProvider dataSupportedBrackets
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int|string|array $targetType The token type(s) to look for.
+ *
+ * @return void
+ */
+ public function testSupportedBrackets($testMarker, $targetType)
+ {
+ $target = $this->getTargetToken($testMarker, $targetType);
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $target);
+
+ $this->assertInstanceof('\PHPCSUtils\Internal\IsShortArrayOrList', $solver);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testSupportedBrackets() For the array format.
+ *
+ * @return array
+ */
+ public function dataSupportedBrackets()
+ {
+ return [
+ 'short-array-open-bracket' => [
+ 'testMarker' => '/* testShortArray */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ ],
+ 'short-list-open-bracket' => [
+ 'testMarker' => '/* testShortList */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ ],
+ 'square-brackets-open-bracket' => [
+ 'testMarker' => '/* testSquareBrackets */',
+ 'targetType' => \T_OPEN_SQUARE_BRACKET,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrList/IsInForeachTest.inc b/Tests/Internal/IsShortArrayOrList/IsInForeachTest.inc
new file mode 100644
index 00000000..e8c5a71d
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsInForeachTest.inc
@@ -0,0 +1,62 @@
+ [$id, $name, $info]) {}
+
+/* testShortListInForeachWithListKeys */
+foreach ($data as ["id" => $id, "name" => $name]) {}
+
+/* testShortlistInForeachWithReference */
+foreach ($array as [&$a, $b]) {}
+
+
+/* ===== Tests involving brackets within a foreach condition INDIRECTLY handled by isInForeach(). ===== */
+// Handled by the function for the outer set of brackets via walkOutside().
+
+foreach ([/* testShortArrayInForeachNestedAtStart */ [$b, $c], $d] as $k => $v) {}
+foreach ([$a, /* testShortArrayInForeachNestedInMiddle */ [$b, $c], $d] as $k => $v) {}
+foreach ([$a, /* testShortArrayInForeachNestedAtEnd */ [$b, $c]] as $k => $v) {}
+
+foreach ([$a, /* testShortArrayEmptyInForeachNestedInMiddle */ 'a' => [], $d] as $k => $v) {}
+
+foreach ($array as [/* testShortListInForeachNestedAtStart */ [$b, $c], $d]) {}
+foreach ($array as [$a, /* testShortListInForeachNestedInMiddle */ [$b, $c], $d]) {}
+foreach ($array as [$a, /* testShortListInForeachNestedAtEnd */ [$b, $c]]) {}
+
+
+/* ===== Tests involving brackets within a foreach condition NOT handled by isInForeach(). ===== */
+
+foreach ($array as $key => $value[$this->get_key(/* testShortArrayInFunctionCallInForeach */ [$b])]) {}
+
+foreach ($array as [/* testShortArrayAsKeyInShortList1 */[1,2,3][$a] => $b, /* testShortArrayAsKeyInShortList2 */ [$d, $e][$a] => $c]) {}
+
+foreach([$a, $b, /* testShortListNestedInShortArrayInForeach */ [$d, $g, /* testNestedShortListNestedInShortArrayInForeach */ [$h]] = $array] as $c) {}
+
+/* testShortArrayAsKeyAfterAs */
+// Fatal error. Cannot use temporary expression in write context.
+foreach ($array as [1,2,3][$a] => [$b, $c]) {}
+
+/* testParseError */
+// Parse error: missing close square bracket.
+foreach ($array as [$a => [$b, $c], $d) {}
+
+/* testForeachWithoutAs */
+// Parse error.
+foreach([1,2,3]) {}
diff --git a/Tests/Internal/IsShortArrayOrList/IsInForeachTest.php b/Tests/Internal/IsShortArrayOrList/IsInForeachTest.php
new file mode 100644
index 00000000..d28e9117
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsInForeachTest.php
@@ -0,0 +1,204 @@
+getTargetToken('/* testNotInForeach */', \T_OPEN_SHORT_ARRAY);
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr);
+ $type = $solver->solve();
+
+ $this->assertSame(IsShortArrayOrList::SHORT_ARRAY, $type);
+ }
+
+ /**
+ * Test that brackets inside foreach conditions are recognized correctly as short array/short lists.
+ *
+ * @dataProvider dataIsInForeachResolved
+ * @dataProvider dataIsInForeachNestedResolvedViaOuter
+ * @dataProvider dataIsInForeachUndetermined
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param string $expected The expected function output.
+ *
+ * @return void
+ */
+ public function testIsInForeach($testMarker, $expected)
+ {
+ $stackPtr = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY]);
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider 1.
+ *
+ * These test cases should get resolved DIRECTLY via the `isInForeach()` method.
+ *
+ * @see testIsInForeach() For the array format.
+ *
+ * @return array
+ */
+ public function dataIsInForeachResolved()
+ {
+ return [
+ 'resolved: short array in foreach' => [
+ 'testMarker' => '/* testShortArrayInForeach */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'resolved: short array in foreach with nested shortlist' => [
+ 'testMarker' => '/* testShortArrayInForeachWithNestedShortList */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'resolved: short array in foreach with assignment' => [
+ 'testMarker' => '/* testShortArrayInForeachWithAssignment */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'resolved: short list in foreach' => [
+ 'testMarker' => '/* testShortListInForeach */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'resolved: short list in foreach with key' => [
+ 'testMarker' => '/* testShortListInForeachWithKey */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'resolved: short list in foreach with list keys' => [
+ 'testMarker' => '/* testShortListInForeachWithListKeys */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'resolved: short list in foreach with reference' => [
+ 'testMarker' => '/* testShortlistInForeachWithReference */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ ];
+ }
+
+ /**
+ * Data provider 2.
+ *
+ * These test cases should get resolved INDIRECTLY once the `isInForeach()` method
+ * is called for the OUTER set of brackets.
+ *
+ * @see testIsInForeach() For the array format.
+ *
+ * @return array
+ */
+ public function dataIsInForeachNestedResolvedViaOuter()
+ {
+ return [
+ 'resolved-on-outer: short array in foreach nested at start' => [
+ 'testMarker' => '/* testShortArrayInForeachNestedAtStart */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'resolved-on-outer: short array in foreach nested in middle' => [
+ 'testMarker' => '/* testShortArrayInForeachNestedInMiddle */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'resolved-on-outer: short array in foreach nested at end' => [
+ 'testMarker' => '/* testShortArrayInForeachNestedAtEnd */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'resolved-on-outer: short array empty in foreach nested in middle' => [
+ 'testMarker' => '/* testShortArrayEmptyInForeachNestedInMiddle */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'resolved-on-outer: short list in foreach nested at start' => [
+ 'testMarker' => '/* testShortListInForeachNestedAtStart */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'resolved-on-outer: short list in foreach nested in middle' => [
+ 'testMarker' => '/* testShortListInForeachNestedInMiddle */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'resolved-on-outer: short list in foreach nested at end' => [
+ 'testMarker' => '/* testShortListInForeachNestedAtEnd */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ ];
+ }
+
+ /**
+ * Data provider 3.
+ *
+ * These are test cases, which do involve a `foreach`, but will not get resolved via the `isInForeach()` method.
+ *
+ * @see testIsInForeach() For the array format.
+ *
+ * @return array
+ */
+ public function dataIsInForeachUndetermined()
+ {
+ return [
+ 'undetermined: short array in function call in foreach' => [
+ 'testMarker' => '/* testShortArrayInFunctionCallInForeach */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'undetermined: short array in foreach as key in shortlist 1' => [
+ 'testMarker' => '/* testShortArrayAsKeyInShortList1 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'undetermined: short array in foreach as key in shortlist 2' => [
+ 'testMarker' => '/* testShortArrayAsKeyInShortList2 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'undetermined: short list nested in short array in foreach' => [
+ 'testMarker' => '/* testShortListNestedInShortArrayInForeach */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'undetermined: nested short list nested in short array in foreach' => [
+ 'testMarker' => '/* testNestedShortListNestedInShortArrayInForeach */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+
+ 'undetermined: short array in foreach as key after as' => [
+ 'testMarker' => '/* testShortArrayAsKeyAfterAs */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'undetermined: parse error missing bracket' => [
+ 'testMarker' => '/* testParseError */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'undetermined: parse error foreach without as' => [
+ 'testMarker' => '/* testForeachWithoutAs */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/Lists/IsShortListTokenizerBC1Test.inc b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC1Test.inc
similarity index 64%
rename from Tests/Utils/Lists/IsShortListTokenizerBC1Test.inc
rename to Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC1Test.inc
index 2f8a7dbe..c8174700 100644
--- a/Tests/Utils/Lists/IsShortListTokenizerBC1Test.inc
+++ b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC1Test.inc
@@ -29,3 +29,21 @@ $foo = ${$bar}['key'];
/* testTokenizerIssue1284PHPCSlt280D */
$c->{$var}[ ] = 2;
+
+/* testTokenizerIssue3013PHPCSlt356 */
+$var = __FILE__[0];
+
+/* testTokenizerIssuePHPCS28xA */
+__NAMESPACE__[] = 'x';
+
+/* testTokenizerIssuePHPCS28xB */
+__method__[0]/* testTokenizerIssuePHPCS28xC */[1]/* testTokenizerIssuePHPCS28xD */[2] *= 'x';
+
+/* testTokenizerIssue3172PHPCSlt360A */
+$var = "PHP{$rocks}"[1]/* testTokenizerIssue3172PHPCSlt360B */[0];
+
+if ( true )
+ /* testTokenizerIssue3632PHPCSlt372 */
+ [ $a ] = [ 'hi' ];
+
+return $a ?? '';
diff --git a/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC1Test.php b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC1Test.php
new file mode 100644
index 00000000..0eec5c4d
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC1Test.php
@@ -0,0 +1,140 @@
+getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testIsShortArrayBracket() For the array format.
+ *
+ * @return array
+ */
+ public function dataIsShortArrayBracket()
+ {
+ return [
+ 'issue-1971-list-first-in-file' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271A */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'issue-1971-list-first-in-file-nested' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271B */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'issue-1381-array-dereferencing-1-array' => [
+ 'testMarker' => '/* testTokenizerIssue1381PHPCSlt290A1 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'issue-1381-array-dereferencing-1-deref' => [
+ 'testMarker' => '/* testTokenizerIssue1381PHPCSlt290A2 */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-1381-array-dereferencing-2' => [
+ 'testMarker' => '/* testTokenizerIssue1381PHPCSlt290B */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-1381-array-dereferencing-3' => [
+ 'testMarker' => '/* testTokenizerIssue1381PHPCSlt290C */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-1381-array-dereferencing-4' => [
+ 'testMarker' => '/* testTokenizerIssue1381PHPCSlt290D1 */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-1381-array-dereferencing-4-deref-deref' => [
+ 'testMarker' => '/* testTokenizerIssue1381PHPCSlt290D2 */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-1284-short-list-directly-after-close-curly-control-structure' => [
+ 'testMarker' => '/* testTokenizerIssue1284PHPCSlt280A */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'issue-1284-short-array-directly-after-close-curly-control-structure' => [
+ 'testMarker' => '/* testTokenizerIssue1284PHPCSlt280B */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'issue-1284-array-access-variable-variable' => [
+ 'testMarker' => '/* testTokenizerIssue1284PHPCSlt290C */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-1284-array-access-variable-property' => [
+ 'testMarker' => '/* testTokenizerIssue1284PHPCSlt280D */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-3013-magic-constant-dereferencing' => [
+ 'testMarker' => '/* testTokenizerIssue3013PHPCSlt356 */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-more-magic-constant-dereferencing-1' => [
+ 'testMarker' => '/* testTokenizerIssuePHPCS28xA */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-nested-magic-constant-dereferencing-2' => [
+ 'testMarker' => '/* testTokenizerIssuePHPCS28xB */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-nested-magic-constant-dereferencing-3' => [
+ 'testMarker' => '/* testTokenizerIssuePHPCS28xC */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-nested-magic-constant-dereferencing-4' => [
+ 'testMarker' => '/* testTokenizerIssuePHPCS28xD */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-interpolated-string-dereferencing' => [
+ 'testMarker' => '/* testTokenizerIssue3172PHPCSlt360A */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-interpolated-string-dereferencing-nested' => [
+ 'testMarker' => '/* testTokenizerIssue3172PHPCSlt360B */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'issue-3632-short-list-in-non-braced-control-structure' => [
+ 'testMarker' => '/* testTokenizerIssue3632PHPCSlt372 */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/Lists/IsShortListTokenizerBC2Test.inc b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC2Test.inc
similarity index 67%
rename from Tests/Utils/Lists/IsShortListTokenizerBC2Test.inc
rename to Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC2Test.inc
index 56db4b44..059f736e 100644
--- a/Tests/Utils/Lists/IsShortListTokenizerBC2Test.inc
+++ b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC2Test.inc
@@ -2,4 +2,4 @@
/* testTokenizerIssue1971PHPCSlt330gt271C */
// Valid PHP, though not useful. Declaring an array without assigning it to anything.
-[1, 2, /* testTokenizerIssue1971PHPCSlt330gt271D */ [3]];
+[$a, $b, /* testTokenizerIssue1971PHPCSlt330gt271D */ [$c], $d];
diff --git a/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC2Test.php b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC2Test.php
new file mode 100644
index 00000000..39c0348d
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC2Test.php
@@ -0,0 +1,69 @@
+getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testIsShortArrayBracket() For the array format.
+ *
+ * @return array
+ */
+ public function dataIsShortArrayBracket()
+ {
+ return [
+ // Make sure the utility method does not throw false positives for a short array at the start of a file.
+ 'issue-1971-short-array-first-in-file' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271C */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'issue-1971-short-array-first-in-file-nested' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271D */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC3Test.inc b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC3Test.inc
new file mode 100644
index 00000000..a95f3a43
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC3Test.inc
@@ -0,0 +1,5 @@
+getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testIsShortArrayBracket() For the array format.
+ *
+ * @return array
+ */
+ public function dataIsShortArrayBracket()
+ {
+ return [
+ 'issue-1971-short-array-first-in-file' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271E */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'issue-1971-short-array-first-in-file-nested' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271F */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC4Test.inc b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC4Test.inc
new file mode 100644
index 00000000..8a0c82c6
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC4Test.inc
@@ -0,0 +1,5 @@
+getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testIsShortArrayBracket() For the array format.
+ *
+ * @return array
+ */
+ public function dataIsShortArrayBracket()
+ {
+ return [
+ 'issue-1971-short-list-first-in-file' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271G */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'issue-1971-short-list-first-in-file-nested' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271H */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC5Test.inc b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC5Test.inc
new file mode 100644
index 00000000..40b15dea
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC5Test.inc
@@ -0,0 +1,4 @@
+getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testIsShortArrayBracket() For the array format.
+ *
+ * @return array
+ */
+ public function dataIsShortArrayBracket()
+ {
+ return [
+ 'issue-1971-short-list-first-in-file' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271I */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'issue-1971-short-list-first-in-file-nested' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271J */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC6Test.inc b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC6Test.inc
new file mode 100644
index 00000000..afc27cd2
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsShortArrayBracketBC6Test.inc
@@ -0,0 +1,4 @@
+getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testIsShortArrayBracket() For the array format.
+ *
+ * @return array
+ */
+ public function dataIsShortArrayBracket()
+ {
+ return [
+ 'issue-1971-short-list-first-in-file' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271K */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'issue-1971-short-list-first-in-file-nested' => [
+ 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271L */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrList/IsShortArrayOrListTest.inc b/Tests/Internal/IsShortArrayOrList/IsShortArrayOrListTest.inc
new file mode 100644
index 00000000..d6198ac9
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsShortArrayOrListTest.inc
@@ -0,0 +1,211 @@
+ /* testShortArrayNotEqualBracketsSecond */ [3, 4]) {}
+
+/* testShortArrayNonIdenticalFirst */
+if([1, 2] !== /* testShortArrayNonIdenticalSecond */ [3, 4]) {}
+
+/* testShortListMultiItem */
+[$a, $b] = $c;
+
+/* testShortListWithKeys */
+["id" => $id1, "name" => $name1] = $data[0];
+
+/* testShortListWithNesting */
+[$a, /* testShortListNested */ [$b]] = array(new stdclass, array(new stdclass));
+
+/* testShortlistMultiAssign */
+$foo = [$baz, $bat] = /* testShortArrayMultiAssign */ [$a, $b] + [$c, $d];
+
+/* testShortArrayWithNestingAndKeys */
+$array = [
+ /* testNestedShortArrayWithKeys_1 */
+ ["x" => $x1, "y" => $y1],
+ /* testNestedShortArrayWithKeys_2 */
+ 1 => ["x" => $x2, "y" => $y2],
+ /* testNestedShortArrayWithKeys_3 */
+ 'key' => ["x" => $x3, "y" => $y3],
+ /* testNestedShortArrayPHP74UnpackingWithoutKeys */
+ ...[$x3, $y3],
+ /* testNestedShortArrayPHP81UnpackingWithKeys */
+ ...["x" => $x3, "y" => $y3],
+];
+
+/* testShortListWithNestingAndKeys */
+[
+ /* testNestedShortListWithKeys_1 */
+ ["x" => $x1, "y" => $y1],
+ /* testNestedShortListWithKeys_2 */
+ ["x" => $x2, "y" => $y2],
+ /* testNestedShortListWithKeys_3 */
+ ["x" => $x3, "y" => $y3],
+] = $points;
+
+[$x, [ $y, /* testDeeplyNestedShortList */ [$z]], $q] = $a;
+
+if ( true ) {
+ /* testShortListInBracedControlStructure */
+ [ $a ] = [ 'hi' ];
+}
+
+if ( true ) :
+ /* testShortListInAlternativeControlStructure */
+ [ $a ] = [ 'hi' ];
+endif;
+
+return $a ?? '';
+
+/* testShortListWithShortArrayAsKey */
+[/* testShortArrayAsKeyForShortList */[1,2,3][$a] => /* testShortListWithShortArrayAsKeyNested */ [$a, $b]] = $array;
+
+/* testShortListWithShortArrayInKey */
+// Please sack anyone who writes code like this.
+[
+ /* testShortArrayInKeyForShortListA */
+ (function($a = [1,2,3]) {
+ return $a[$b];
+ })(/* testShortArrayInKeyForShortListB */[1,2,3]) => /* testShortListWithShortArrayInKeyNested */ [$a, $b]
+] = $array;
+
+[/* testNestedShortListWithEmpties */[,,$a]] = $array;
+
+$array = [
+ 'key1' => function($a, $b) {
+ /* testShortListInClosureInShortArrayValue */
+ ['a' => $a, $key['b'] => /* testNestedShortListInClosureInShortArrayValue */ [$b]] =
+ /* testShortArrayInClosureInShortArrayValue */
+ [$a, /* testNestedShortArrayInClosureInShortArrayValue */ [$b]];
+ return $a;
+ },
+ /* testShortArrayInFunctionCallInShortArrayValue */
+ 'key2' => function_call([$a, $b]),
+ /* testPlainShortListInShortArrayValue */
+ 'key3' => [$a, $b] = $foo,
+ /* testPlainShortListInShortArrayValueNoKey */
+ [$a, $b] = $foo,
+ /* testKeyedShortListInShortArrayValue1 */
+ 'key4' => [ /* testShortArrayInShortListAsKey */['a', 'b'] [0] => $a] = $foo,
+ /* testKeyedShortListInShortArrayValue2 */
+ 'key5' => [ get_key( /* testShortArrayInFunctionCallInShortListKey */ ['a', 'b']) => $a] = $foo,
+ 'key6' => [ $a, /* testEmptyShortListInShortListInShortArrayValue */ [], $b ] = $foo,
+];
+
+$keys[ /* testOuterShortArrayStopAtBrackets */ [$a, $b, $c]['index'] ] = 'value';
+
+$array = [
+ $keys[ /* testShortArrayInShortArrayKeyStopAtBrackets */ [$a, $b, $c]['index'] ] => 'value',
+];
+
+[
+ $keys[ /* testShortArrayInShortListKeyStopAtBrackets */ [$a, $b, $c]['index'] ] => $a,
+] = $array;
+
+/* testRiskySyntaxCombiButNonNested-FunctionCall */
+$var = function_call($arg, [$arg], $arg);
+
+/* testRiskySyntaxCombiButNonNested-ClosureCall */
+$var = $closure($arg, [$arg], $arg);
+
+/* testRiskySyntaxCombiButNonNested-FnCall */
+$var = $fn($arg, [$arg], $arg);
+
+/* testRiskySyntaxCombiButNonNested-Echo */
+echo $arg, [$arg], $arg;
+
+$array = [
+ /* testShortArrayInShortArrowFunction */
+ 'key' => fn($p) : array => [$p],
+
+ // Prevent going straight to outer brackets for last item.
+ 'skip' => [$b],
+];
+
+$match = match($foo) {
+ /* testShortArrayConditionInMatchExpression */
+ [$bar] => 10,
+ default => 20,
+};
+
+$match = match($foo) {
+ [$bar, /* testNestedShortArrayConditionInMatchExpression */ [$baz], $bal] => 10,
+ default => 20,
+};
+
+$match = match($foo) {
+ /* testShortArrayReturnedFromMatchExpression */
+ 10 => [$bar],
+ default => 20,
+};
+
+$match = match($foo) {
+ 10 => [$bar, /* testNestedShortArrayReturnedFromMatchExpression */ [$baz], $bal],
+ default => 20,
+};
+
+$match = match($foo) {
+ /* testShortListConditionInMatchExpression */
+ [$bar] = $array => 10,
+ default => 20,
+};
+
+$match = match($foo) {
+ [$bar, /* testNestedShortListConditionInMatchExpression */ [$baz], $bal] = $array => 10,
+ default => 20,
+};
+
+$match = match($foo) {
+ /* testShortListReturnedFromMatchExpression */
+ 10 => [$bar] = $array,
+ default => 20,
+};
+
+$match = match($foo) {
+ 10 => [$bar, /* testNestedShortListReturnedFromMatchExpression */ [$baz], $bal] = $array,
+ default => 20,
+};
+
+
+/* ===== Tests involving various illegal syntaxes/parse errors. ===== */
+
+// Invalid as empty lists are not allowed, but it is short list syntax.
+[$x, /* testNestedShortListEmpty */ [], $y] = $a;
+
+/* testShortListWithoutVars */
+// Invalid list as it doesn't contain variables, but it is short list syntax.
+[42] = [1];
+
+/* testShortListNestedLongList */
+// Invalid list as mixing short list syntax with list() is not allowed, but it is short list syntax.
+[list($a, $b), list($c, $d)] = [[1, 2], [3, 4]];
+
+/* testNestedAnonClassWithTraitUseAs */
+// Parse error, but not our concern, it is short array syntax.
+array_map(function($a) {
+ return new class() {
+ use MyTrait {
+ MyTrait::functionName as [];
+ }
+ };
+}, $array);
+
+/* testParseError */
+// Parse error, but not our concern, it is short array syntax.
+use Something as [$a];
diff --git a/Tests/Internal/IsShortArrayOrList/IsShortArrayOrListTest.php b/Tests/Internal/IsShortArrayOrList/IsShortArrayOrListTest.php
new file mode 100644
index 00000000..e12cc60d
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsShortArrayOrListTest.php
@@ -0,0 +1,365 @@
+getTargetToken($testMarker, \T_OPEN_SHORT_ARRAY);
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testIsShortArrayOrList() For the array format.
+ *
+ * @return array
+ */
+ public function dataIsShortArrayOrList()
+ {
+ return [
+ 'short-array-comparison-no-assignment' => [
+ 'testMarker' => '/* testShortArrayInComparison */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-comparison-no-assignment-nested' => [
+ 'testMarker' => '/* testShortArrayNestedInComparison */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-union-before' => [
+ 'testMarker' => '/* testShortArrayUnionFirst */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-union-after' => [
+ 'testMarker' => '/* testShortArrayUnionSecond */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-equal-before' => [
+ 'testMarker' => '/* testShortArrayEqualFirst */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-equal-after' => [
+ 'testMarker' => '/* testShortArrayEqualSecond */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-identical-before' => [
+ 'testMarker' => '/* testShortArrayIdenticalFirst */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-identical-after' => [
+ 'testMarker' => '/* testShortArrayIdenticalSecond */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-not-equal-before' => [
+ 'testMarker' => '/* testShortArrayNotEqualFirst */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-not-equal-after' => [
+ 'testMarker' => '/* testShortArrayNotEqualSecond */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-not-equal-brackets-before' => [
+ 'testMarker' => '/* testShortArrayNotEqualBracketsFirst */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-not-equal-brackets-after' => [
+ 'testMarker' => '/* testShortArrayNotEqualBracketsSecond */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-not-identical-before' => [
+ 'testMarker' => '/* testShortArrayNonIdenticalFirst */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-not-identical-after' => [
+ 'testMarker' => '/* testShortArrayNonIdenticalSecond */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-list-multi-item' => [
+ 'testMarker' => '/* testShortListMultiItem */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-with-keys' => [
+ 'testMarker' => '/* testShortListWithKeys */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-with-nesting' => [
+ 'testMarker' => '/* testShortListWithNesting */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-nested' => [
+ 'testMarker' => '/* testShortListNested */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-in-chained-assignment' => [
+ 'testMarker' => '/* testShortlistMultiAssign */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-array-in-chained-assignment' => [
+ 'testMarker' => '/* testShortArrayMultiAssign */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-with-nesting-and-keys' => [
+ 'testMarker' => '/* testShortArrayWithNestingAndKeys */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-nested-with-keys-1' => [
+ 'testMarker' => '/* testNestedShortArrayWithKeys_1 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-nested-with-keys-2' => [
+ 'testMarker' => '/* testNestedShortArrayWithKeys_2 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-nested-with-keys-3' => [
+ 'testMarker' => '/* testNestedShortArrayWithKeys_3 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-nested-unpacking-without-keys-php74' => [
+ 'testMarker' => '/* testNestedShortArrayPHP74UnpackingWithoutKeys */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-nested-unpacking-with-keys-php81' => [
+ 'testMarker' => '/* testNestedShortArrayPHP81UnpackingWithKeys */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-list-with-nesting-and-keys' => [
+ 'testMarker' => '/* testShortListWithNestingAndKeys */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-nested-with-keys-1' => [
+ 'testMarker' => '/* testNestedShortListWithKeys_1 */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-nested-with-keys-2' => [
+ 'testMarker' => '/* testNestedShortListWithKeys_2 */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-nested-with-keys-3' => [
+ 'testMarker' => '/* testNestedShortListWithKeys_3 */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-deeply-nested' => [
+ 'testMarker' => '/* testDeeplyNestedShortList */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-in-braced-control-structure' => [
+ 'testMarker' => '/* testShortListInBracedControlStructure */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-in-alternative-control-structure' => [
+ 'testMarker' => '/* testShortListInAlternativeControlStructure */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-containing-short-array-as-key' => [
+ 'testMarker' => '/* testShortListWithShortArrayAsKey */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-array-as-key-for-nested-short-list' => [
+ 'testMarker' => '/* testShortArrayAsKeyForShortList */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-list-nested-with-array-key' => [
+ 'testMarker' => '/* testShortListWithShortArrayAsKeyNested */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-containing-short-array-in-key' => [
+ 'testMarker' => '/* testShortListWithShortArrayInKey */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-array-in-key-for-short-list-closure-default' => [
+ 'testMarker' => '/* testShortArrayInKeyForShortListA */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-in-key-for-short-list-closure-call-param' => [
+ 'testMarker' => '/* testShortArrayInKeyForShortListB */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-list-nested-with-array-in-key' => [
+ 'testMarker' => '/* testShortListWithShortArrayInKeyNested */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-nested-with-empties' => [
+ 'testMarker' => '/* testNestedShortListWithEmpties */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+
+ 'short-list-in-closure-in-short-array-value' => [
+ 'testMarker' => '/* testShortListInClosureInShortArrayValue */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-nested-in-closure-in-short-array-value' => [
+ 'testMarker' => '/* testNestedShortListInClosureInShortArrayValue */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-array-in-closure-in-short-array-value' => [
+ 'testMarker' => '/* testShortArrayInClosureInShortArrayValue */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-nested-in-closure-in-short-array-value' => [
+ 'testMarker' => '/* testNestedShortArrayInClosureInShortArrayValue */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-in-function-call-in-short-array-value' => [
+ 'testMarker' => '/* testShortArrayInFunctionCallInShortArrayValue */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-list-in-short-array-value' => [
+ 'testMarker' => '/* testPlainShortListInShortArrayValue */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-in-short-array-value-no-key' => [
+ 'testMarker' => '/* testPlainShortListInShortArrayValueNoKey */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-keyed-in-short-array-value-1' => [
+ 'testMarker' => '/* testKeyedShortListInShortArrayValue1 */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-array-as-key-for-short-list-in-array-value' => [
+ 'testMarker' => '/* testShortArrayInShortListAsKey */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-list-keyed-in-short-array-value-2' => [
+ 'testMarker' => '/* testKeyedShortListInShortArrayValue2 */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-array-in-function-call-as-key-for-short-list-in-array-value' => [
+ 'testMarker' => '/* testShortArrayInFunctionCallInShortListKey */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-list-nested-and-empty-in-short-array-value' => [
+ 'testMarker' => '/* testEmptyShortListInShortListInShortArrayValue */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+
+ 'outer-short-array-stop-test-square-open' => [
+ 'testMarker' => '/* testOuterShortArrayStopAtBrackets */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'inner-short-array-stop-test-square-open-1' => [
+ 'testMarker' => '/* testShortArrayInShortArrayKeyStopAtBrackets */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'inner-short-array-stop-test-square-open-2' => [
+ 'testMarker' => '/* testShortArrayInShortListKeyStopAtBrackets */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'short-array-comma-before-after-in-function-call' => [
+ 'testMarker' => '/* testRiskySyntaxCombiButNonNested-FunctionCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-comma-before-after-in-closure-call' => [
+ 'testMarker' => '/* testRiskySyntaxCombiButNonNested-ClosureCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-comma-before-after-in-fn-call' => [
+ 'testMarker' => '/* testRiskySyntaxCombiButNonNested-FnCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-comma-before-after-in-echo-statement' => [
+ 'testMarker' => '/* testRiskySyntaxCombiButNonNested-Echo */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'short-array-in-arrow-fn-return-expression' => [
+ 'testMarker' => '/* testShortArrayInShortArrowFunction */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'short-array-in-match-condition' => [
+ 'testMarker' => '/* testShortArrayConditionInMatchExpression */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-nested-in-match-condition' => [
+ 'testMarker' => '/* testNestedShortArrayConditionInMatchExpression */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-in-match-return-expression' => [
+ 'testMarker' => '/* testShortArrayReturnedFromMatchExpression */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-array-nested-in-match-return-expression' => [
+ 'testMarker' => '/* testNestedShortArrayReturnedFromMatchExpression */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short-list-in-match-condition' => [
+ 'testMarker' => '/* testShortListConditionInMatchExpression */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-nested-in-match-condition' => [
+ 'testMarker' => '/* testNestedShortListConditionInMatchExpression */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-in-match-return-expression' => [
+ 'testMarker' => '/* testShortListReturnedFromMatchExpression */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-nested-in-match-return-expression' => [
+ 'testMarker' => '/* testNestedShortListReturnedFromMatchExpression */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+
+ // Invalid syntaxes.
+ 'short-list-nested-empty' => [
+ 'testMarker' => '/* testNestedShortListEmpty */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-without-vars' => [
+ 'testMarker' => '/* testShortListWithoutVars */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short-list-nested-long-list' => [
+ 'testMarker' => '/* testShortListNestedLongList */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'parse-error-anon-class-trait-use-as' => [
+ 'testMarker' => '/* testNestedAnonClassWithTraitUseAs */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'parse-error-use-as' => [
+ 'testMarker' => '/* testParseError */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrList/IsSquareBracketTest.inc b/Tests/Internal/IsShortArrayOrList/IsSquareBracketTest.inc
new file mode 100644
index 00000000..59a6208b
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsSquareBracketTest.inc
@@ -0,0 +1,53 @@
+function_call()[$x];
+
+$array = [
+ 'key1' => function($a, $b) {
+ ['a' => $a, /* testArrayAccessForShortListKey */ $key['b'] => [$b]] = [$a, [$b]];
+ return $a;
+ },
+ 'key2' => [/* testListAssignmentToArrayStringKey */ $a['key'], /* testListAssignmentToArrayEmptyKey */ $a[], $c] = [$a, [$b]];
+ return $a;
+ },
+ 'key3' => [ ['a', 'b'] /* testArrayDerefOfShortArrayInShortListAsKey */[0] => $a] = $foo,
+];
+
+/* testLiveCoding */
+// Intentional parse error. This has to be the last test in the file.
+[$a,
diff --git a/Tests/Internal/IsShortArrayOrList/IsSquareBracketTest.php b/Tests/Internal/IsShortArrayOrList/IsSquareBracketTest.php
new file mode 100644
index 00000000..cd10578d
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/IsSquareBracketTest.php
@@ -0,0 +1,120 @@
+getTargetToken('/* testShortArray */', \T_OPEN_SHORT_ARRAY);
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr);
+ $type = $solver->solve();
+
+ $this->assertNotSame(IsShortArrayOrList::SQUARE_BRACKETS, $type);
+ }
+
+ /**
+ * Test that real square brackets are recognized as such.
+ *
+ * @dataProvider dataSquareBrackets
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ *
+ * @return void
+ */
+ public function testSquareBrackets($testMarker)
+ {
+ $stackPtr = $this->getTargetToken($testMarker, \T_OPEN_SQUARE_BRACKET);
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr);
+ $type = $solver->solve();
+
+ $this->assertSame(IsShortArrayOrList::SQUARE_BRACKETS, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testSquareBrackets() For the array format.
+ *
+ * @return array
+ */
+ public function dataSquareBrackets()
+ {
+ return [
+ 'array-assignment-no-key' => [
+ 'testMarker' => '/* testArrayAssignmentEmpty */',
+ ],
+ 'array-assignment-string-key' => [
+ 'testMarker' => '/* testArrayAssignmentStringKey */',
+ ],
+ 'array-assignment-int-key' => [
+ 'testMarker' => '/* testArrayAssignmentIntKey */',
+ ],
+ 'array-assignment-var-key' => [
+ 'testMarker' => '/* testArrayAssignmentVarKey */',
+ ],
+ 'array-access-string-key' => [
+ 'testMarker' => '/* testArrayAccessStringKey */',
+ ],
+ 'array-access-int-key-1' => [
+ 'testMarker' => '/* testArrayAccessIntKey1 */',
+ ],
+ 'array-access-int-key-2' => [
+ 'testMarker' => '/* testArrayAccessIntKey2 */',
+ ],
+ 'array-access-function-call' => [
+ 'testMarker' => '/* testArrayAccessFunctionCall */',
+ ],
+ 'array-access-constant' => [
+ 'testMarker' => '/* testArrayAccessConstant */',
+ ],
+ 'array-access-magic-constant' => [
+ 'testMarker' => '/* testArrayAccessMagicConstant */',
+ ],
+ 'array-access-nullsafe-method-call' => [
+ 'testMarker' => '/* testNullsafeMethodCallDereferencing */',
+ ],
+ 'array-access-for-short-list-key' => [
+ 'testMarker' => '/* testArrayAccessForShortListKey */',
+ ],
+ 'list-assignment-to-array-with-string-key' => [
+ 'testMarker' => '/* testListAssignmentToArrayStringKey */',
+ ],
+ 'list-assignment-to-array-without-key' => [
+ 'testMarker' => '/* testListAssignmentToArrayEmptyKey */',
+ ],
+ 'array-access-for-short-list-key-with-hardcoded-array' => [
+ 'testMarker' => '/* testArrayDerefOfShortArrayInShortListAsKey */',
+ ],
+
+ 'live-coding' => [
+ 'testMarker' => '/* testLiveCoding */',
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrList/SolveTest.inc b/Tests/Internal/IsShortArrayOrList/SolveTest.inc
new file mode 100644
index 00000000..29157588
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/SolveTest.inc
@@ -0,0 +1,57 @@
+ $something;
+
+/* testShortArrayInForeach */
+foreach ([1, 2, 3] as /* testShortListInForeach */ [$id, $name, $info]) {}
+
+/* testShortArray */
+$array = [$a];
+
+$array = [/* testNestedShortArrayParentBracketBefore */[$b], [$a]];
+[$a, /* testNestedShortListParentBracketAfter */ [$a, $b]] = $array;
+[$a, /* testNestedShortListParentBracketAfterWithTrailingComma */ [$a, $b],] = $array;
+
+$array = [
+ // Prevent going straight to outer brackets for first item.
+ [$a, $b],
+
+ /* testNestedShortArrayContentNonAmbiguous */
+ [ 1, 2, ],
+
+ // Prevent going straight to outer brackets for last item.
+ [$a, $b],
+];
+
+[
+ // Prevent going straight to outer brackets for first item.
+ [$a, $b],
+
+ /* testNestedShortListContentNonAmbiguous */
+ [$a,, $b],
+
+ // Prevent going straight to outer brackets for last item.
+ [$a, $b],
+] = $array;
+
+/* testOuterShortArray */
+echo 'previous-semicolon';
+echo $arg, [$arg], $arg;
+
+
+/* ===== Tests involving various illegal syntaxes/parse errors. ===== */
+
+// Intentional parse error. This has to be the last test in the file.
+[$a, /* testLiveCodingNested */ [$b]
diff --git a/Tests/Internal/IsShortArrayOrList/SolveTest.php b/Tests/Internal/IsShortArrayOrList/SolveTest.php
new file mode 100644
index 00000000..ec188307
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/SolveTest.php
@@ -0,0 +1,110 @@
+getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr, []);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testSolve() For the array format.
+ *
+ * @return array
+ */
+ public function dataSolve()
+ {
+ return [
+ 'real square brackets' => [
+ 'testMarker' => '/* testSquareBrackets */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'unambiguous short list' => [
+ 'testMarker' => '/* testShortList */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short array in attribute' => [
+ 'testMarker' => '/* testShortArrayInAttribute */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short array in foreach' => [
+ 'testMarker' => '/* testShortArrayInForeach */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short list in foreach' => [
+ 'testMarker' => '/* testShortListInForeach */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'unambiguous short array' => [
+ 'testMarker' => '/* testShortArray */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested short array, first item in parent' => [
+ 'testMarker' => '/* testNestedShortArrayParentBracketBefore */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested short list, last item in parent' => [
+ 'testMarker' => '/* testNestedShortListParentBracketAfter */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'nested short list, last item in parent, trailing comma' => [
+ 'testMarker' => '/* testNestedShortListParentBracketAfterWithTrailingComma */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'nested short array, content unambiguous' => [
+ 'testMarker' => '/* testNestedShortArrayContentNonAmbiguous */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested short list, content unambiguous' => [
+ 'testMarker' => '/* testNestedShortListContentNonAmbiguous */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'nested short array via outer brackets' => [
+ 'testMarker' => '/* testOuterShortArray */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short array, parse error' => [
+ 'testMarker' => '/* testLiveCodingNested */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrList/WalkInsideTest.inc b/Tests/Internal/IsShortArrayOrList/WalkInsideTest.inc
new file mode 100644
index 00000000..c33c7857
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/WalkInsideTest.inc
@@ -0,0 +1,239 @@
+ $a, 'b' => $b->prop, 'c' => self::$staticProp, 'd' => static::$staticProp, 'e' => parent::$staticProp],
+ /* testNestedShortArrayWithReferenceUndetermined */
+ [&Foo::$a, &$b[++$i], $c[$i . '1'], $d['key']->prop,],
+
+ // Prevent going straight to outer brackets for last item.
+ [$a, $b],
+];
+
+[
+ // Prevent going straight to outer brackets for first item.
+ [$a, $b],
+
+ /* testNestedShortListEmpty */
+ [],
+
+ /* testNestedShortListUndetermined */
+ [$a, $b->prop, Sub\ClassName::$staticProp, namespace\ClassName::$staticProp, $c[$i . '1'],],
+ /* testNestedShortListWithKeysUndetermined */
+ ['a' => $a['key'], 'b' => $b[1]['text'],],
+ /* testNestedShortListWithReferenceUndetermined */
+ [&$a, &Bar::$b, $d['key']->prop],
+
+ // Prevent going straight to outer brackets for last item.
+ [$a, $b],
+] = $array;
+
+
+// Complex variables at start of item. Undetermined for now.
+$array = [
+ // Prevent going straight to outer brackets for first item.
+ [$a, $b],
+
+ /* testNestedShortArrayValueHasContentAfterVar1 */
+ ['arithmetic' => $c[1]['text'] + $d,],
+ /* testNestedShortArrayValueHasContentAfterVar2 */
+ ['concat' => $c->prop . 'text'],
+ /* testNestedShortArrayValueHasContentAfterVar3 */
+ ['compare' => $c->prop?->deeperProp === true,],
+ /* testNestedShortArrayValueHasContentAfterVar4 */
+ ['ternary' => $c[$key]::CONST_NAME ? 10 : 20],
+
+ // Prevent going straight to outer brackets for last item.
+ [$a, $b],
+];
+
+
+/* ===== Tests where the nature of a set of (nested) brackets CAN be determined by their content. ===== */
+
+$array = [
+ // Prevent going straight to outer brackets for first item.
+ [$a, $b],
+
+ /* testNestedShortArrayNoVarsOrNestedNull */
+ [null],
+ /* testNestedShortArrayNoVarsOrNestedInts */
+ [1, 2, 3,],
+ /* testNestedShortArrayWithKeysNoVarsOrNestedTextStrings */
+ [1 => 'text', 2 => 'more text'],
+ /* testNestedShortArrayWithKeysNoVarsOrNestedBools */
+ [1 => true, 2 => false,],
+ /* testNestedShortArrayNoVarsOrNestedFloats */
+ [1.5, 3.7],
+ /* testNestedShortArrayNoVarsOrNestedLongArray */
+ [array(1, 2, 3),],
+ /* testNestedShortArrayNoVarsOrNestedObject */
+ [new stdClass()],
+
+ /* testNestedShortArrayFuncCall */
+ [$b->prop, functionCall(),],
+ /* testNestedShortArrayNamespacedConstant */
+ [$a, namespace\CONSTANT_NAME],
+ /* testNestedShortArrayClassConstant1 */
+ [$b, PartiallyQ\ClassName::CONSTANT_NAME,],
+ /* testNestedShortArrayClassConstant2 */
+ [$b, static::CONSTANT_NAME,],
+ /* testNestedShortArrayMethodCall */
+ [$b, \FullyQ\ClassName::functionCall(),],
+ /* testNestedShortArrayMixedContent */
+ [$a, $b, [$c], 1,],
+
+ /* testNestedShortArrayValueHasContentAfterShortArray1 */
+ ['union' => [$c] + [$d]],
+ /* testNestedShortArrayValueHasContentAfterShortArray2 */
+ ['compare' => [$c] === [1],],
+ /* testNestedShortArrayValueHasContentAfterShortArray3 */
+ ['list' => [$c] = $array,],
+
+ /* testNestedShortArrayRecursion1 */
+ [$a, $b, ['text'], $c],
+
+ /* testNestedShortArrayRecursion2 */
+ [
+ $a,
+ [
+ $b,
+ [
+ 10,
+ ],
+ ],
+ ],
+
+ /* testNestedShortArrayRecursion3 */
+ [
+ $a,
+ [
+ $b,
+ [
+ $c,
+ [
+ 10,
+ ],
+ ],
+ ],
+ ],
+
+ // Prevent going straight to outer brackets for last item.
+ [$a, $b],
+];
+
+[
+ // Prevent going straight to outer brackets for first item.
+ [$a, $b],
+
+ /* testNestedShortListEmptyEntryAtStart */
+ [, $a, $b],
+ /* testNestedShortListEmptyEntryInMiddle */
+ [$a,, $b],
+ /* testNestedShortListEmptyEntryAtEnd */
+ [$a, $b, , ],
+
+ // Prevent going straight to outer brackets for last item.
+ [$a, $b],
+] = $array;
+
+
+/* ===== Test where the nature of a set of (nested) brackets COULD be determined by their content,
+ but the amount of parameters retrieved is too small. ===== */
+
+$array = [
+ // Prevent going straight to outer brackets for first item.
+ [$a, $b],
+
+ /* testNestedShortArraySampleTooSmall */
+ [$a, $b, $c, [$d], $e, 10],
+
+ // Prevent going straight to outer brackets for last item.
+ [$a, $b],
+];
+
+
+/* ===== Tests where the nature of a set of (nested) brackets CAN be determined by their content, but the recursion limit prevent this. ===== */
+
+$array = [
+ // Prevent going straight to outer brackets for first item.
+ [$a, $b],
+
+ /* testNestedShortArrayRecursion4 */
+ [
+ $a,
+ [
+ $b,
+ [
+ $c,
+ [
+ $d,
+ [
+ 20.5,
+ ],
+ ],
+ ],
+ ],
+ ],
+
+ /* testNestedShortArrayRecursion6 */
+ [
+ $a,
+ [
+ $b,
+ [
+ $c,
+ [
+ $d,
+ [
+ $e,
+ [
+ $f,
+ [
+ 10
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+
+ // Prevent going straight to outer brackets for last item.
+ [$a, $b],
+];
+
+[
+ // Prevent going straight to outer brackets for first item.
+ [$a, $b],
+
+ /* testNestedShortListRecursion4 */
+ [
+ $a,
+ [
+ $b,
+ [
+ $c,
+ [
+ $d,
+ [
+ $e,
+ $f,
+ ],
+ ],
+ ],
+ ],
+ ],
+
+ // Prevent going straight to outer brackets for last item.
+ [$a, $b],
+] = $array;
diff --git a/Tests/Internal/IsShortArrayOrList/WalkInsideTest.php b/Tests/Internal/IsShortArrayOrList/WalkInsideTest.php
new file mode 100644
index 00000000..a4388675
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/WalkInsideTest.php
@@ -0,0 +1,293 @@
+getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY]);
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr, []);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testWalkInsideUndetermined() For the array format.
+ *
+ * @return array
+ */
+ public function dataWalkInsideUndetermined()
+ {
+ return [
+ 'nested-short-array-empty' => [
+ 'testMarker' => '/* testNestedShortArrayEmpty */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'nested-short-array' => [
+ 'testMarker' => '/* testNestedShortArrayUndetermined */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-with-keys' => [
+ 'testMarker' => '/* testNestedShortArrayWithKeysUndetermined */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-with-reference' => [
+ 'testMarker' => '/* testNestedShortArrayWithReferenceUndetermined */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'nested-short-list-empty' => [
+ 'testMarker' => '/* testNestedShortListEmpty */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+
+ 'nested-short-list' => [
+ 'testMarker' => '/* testNestedShortListUndetermined */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'nested-short-list-with-keys' => [
+ 'testMarker' => '/* testNestedShortListWithKeysUndetermined */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'nested-short-list-with-reference' => [
+ 'testMarker' => '/* testNestedShortListWithReferenceUndetermined */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+
+ 'nested-short-array-operator-after-var-1' => [
+ 'testMarker' => '/* testNestedShortArrayValueHasContentAfterVar1 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-operator-after-var-2' => [
+ 'testMarker' => '/* testNestedShortArrayValueHasContentAfterVar2 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-operator-after-var-3' => [
+ 'testMarker' => '/* testNestedShortArrayValueHasContentAfterVar3 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-operator-after-var-4' => [
+ 'testMarker' => '/* testNestedShortArrayValueHasContentAfterVar4 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ ];
+ }
+
+ /**
+ * Test that nested brackets are recognized as a short array when based on the contents
+ * it can't be a short list.
+ *
+ * @dataProvider dataWalkInsideResolved
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param string $expected The expected function output.
+ *
+ * @return void
+ */
+ public function testWalkInsideResolved($testMarker, $expected)
+ {
+ $stackPtr = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY]);
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr, []);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testWalkInsideResolved() For the array format.
+ *
+ * @return array
+ */
+ public function dataWalkInsideResolved()
+ {
+ return [
+ 'nested-short-array-no-vars-or-nested-null' => [
+ 'testMarker' => '/* testNestedShortArrayNoVarsOrNestedNull */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-no-vars-or-nested-ints' => [
+ 'testMarker' => '/* testNestedShortArrayNoVarsOrNestedInts */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-with-keys-no-vars-or-nested-text-strings' => [
+ 'testMarker' => '/* testNestedShortArrayWithKeysNoVarsOrNestedTextStrings */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-with-keys-no-vars-or-nested-bools' => [
+ 'testMarker' => '/* testNestedShortArrayWithKeysNoVarsOrNestedBools */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-no-vars-or-nested-floats' => [
+ 'testMarker' => '/* testNestedShortArrayNoVarsOrNestedFloats */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-no-vars-or-nested-long-array' => [
+ 'testMarker' => '/* testNestedShortArrayNoVarsOrNestedLongArray */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-no-vars-or-nested-object' => [
+ 'testMarker' => '/* testNestedShortArrayNoVarsOrNestedObject */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'nested-short-array-function-call' => [
+ 'testMarker' => '/* testNestedShortArrayFuncCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-namespaced-constant' => [
+ 'testMarker' => '/* testNestedShortArrayNamespacedConstant */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-class-constant' => [
+ 'testMarker' => '/* testNestedShortArrayClassConstant1 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-class-constant-with-hierarchy-keyword' => [
+ 'testMarker' => '/* testNestedShortArrayClassConstant2 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-fqn-method-call' => [
+ 'testMarker' => '/* testNestedShortArrayMethodCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-mixed-content' => [
+ 'testMarker' => '/* testNestedShortArrayMixedContent */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'nested-short-array-content-after-short-array-1' => [
+ 'testMarker' => '/* testNestedShortArrayValueHasContentAfterShortArray1 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-content-after-short-array-2' => [
+ 'testMarker' => '/* testNestedShortArrayValueHasContentAfterShortArray2 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-content-after-short-array-3' => [
+ 'testMarker' => '/* testNestedShortArrayValueHasContentAfterShortArray3 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'nested-short-array-with-nested-short-array-recursion-1' => [
+ 'testMarker' => '/* testNestedShortArrayRecursion1 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-with-nested-short-array-recursion-2' => [
+ 'testMarker' => '/* testNestedShortArrayRecursion2 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-with-nested-short-array-recursion-3' => [
+ 'testMarker' => '/* testNestedShortArrayRecursion3 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'nested-short-list-empty-entry-at-start' => [
+ 'testMarker' => '/* testNestedShortListEmptyEntryAtStart */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'nested-short-list-empty-entry-in-middle' => [
+ 'testMarker' => '/* testNestedShortListEmptyEntryInMiddle */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'nested-short-list-empty-entry-at-end' => [
+ 'testMarker' => '/* testNestedShortListEmptyEntryAtEnd */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ ];
+ }
+
+ /**
+ * Ensure the "cannot be determined based on the array entry sample size" condition gets hit.
+ *
+ * @return void
+ */
+ public function testSampleTooSmall()
+ {
+ $stackPtr = $this->getTargetToken('/* testNestedShortArraySampleTooSmall */', \T_OPEN_SHORT_ARRAY);
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr, []);
+ $type = $solver->solve();
+
+ $this->assertSame(IsShortArrayOrList::SHORT_ARRAY, $type);
+ }
+
+ /**
+ * Ensure the "cannot be determined due to the recursion limit" condition gets hit.
+ *
+ * @dataProvider dataRecursionLimit
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param string $expected The expected function output.
+ *
+ * @return void
+ */
+ public function testRecursionLimit($testMarker, $expected)
+ {
+ $stackPtr = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY]);
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr, []);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testRecursionLimit() For the array format.
+ *
+ * @return array
+ */
+ public function dataRecursionLimit()
+ {
+ return [
+ 'nested-short-array-with-nested-short-array-recursion-4' => [
+ 'testMarker' => '/* testNestedShortArrayRecursion4 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-array-with-nested-short-array-recursion-6' => [
+ 'testMarker' => '/* testNestedShortArrayRecursion6 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'nested-short-list-with-nested-short-list-recursion-4' => [
+ 'testMarker' => '/* testNestedShortListRecursion4 */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrList/WalkOutsideTest.inc b/Tests/Internal/IsShortArrayOrList/WalkOutsideTest.inc
new file mode 100644
index 00000000..9a7aee9b
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/WalkOutsideTest.inc
@@ -0,0 +1,182 @@
+ 'text',
+ 'jump over non-cached short array' => [$a],
+ 'jump over short list' => [$a] = $array,
+ 'jump over parenthesis' => function_call($param, $param, $param),
+ 'jump over parenthesis to owner' => array($var, $var, $var),
+ 'jump over scope curlies 1' => match($a) {
+ 1 => true,
+ 2 => false,
+ },
+ 'jump over scope curlies 2' => function($a) {
+ return $something,
+ },
+ 'jump over non-scope curlies' => ${'var_name'},
+ 'jump over heredoc' => << <<<'EOD'
+text
+EOD
+ ,
+ 'jump over square brackets' => $a['key'],
+
+ 'jump over attributes' => #[MyAttribute([1, 2, 3])] fn($a) => $something,
+
+ /* testShortArrayJumpingOver */
+ 'array under investigation' => [$a],
+
+ // Prevent going straight to outer brackets for last item.
+ [$b],
+];
+
+[
+ /**
+ * Docblock.
+ */
+ 'key' => $a['jump over docblock'],
+ [1,2,3]['index'] => $a['jump over short array'],
+ function_call($param, $param, $param) => $a['jump over parenthesis'],
+ ${'var_name'} => $a['jump over non-scope curlies'],
+ << $a['jump over heredoc'],
+ <<<'EOD'
+key
+EOD
+ => $a['jump over nowdoc'],
+ $a['key'] => $a['jump over square brackets'],
+
+ /* testShortListJumpingOver */
+ 'list under investigation' => [$a],
+
+ // Prevent going straight to outer brackets for last item.
+ 'skip' => [$b],
+
+] = $array;
+
+
+/* ===== Tests verifying that the loop stops as quickly as possible for OUTER brackets. ===== */
+
+/* testOuterShortArrayStopAtSemicolon */
+echo 'previous-semicolon';
+echo $arg, [$arg], $arg;
+
+?>
+
+ function() {
+ /* testShortArrayInShortArrayStopAtCurly */
+ echo $arg, [$arg], $arg;
+ },
+];
+
+[
+ 'key' => $a,
+ (function() {
+ ob_start();
+ /* testShortArrayInShortListStopAtSemicolon */
+ echo $arg, [$arg], $arg;
+ return ob_get_flush();
+ })() => $b,
+ 'key' => $c,
+] = $array;
+
+
+$array = [
+ /* testShortArrayInShortArrayStopAtParensFuncCall */
+ 'func'. 'Call' => function_call($arg, [$arg], $arg),
+
+ /* testShortArrayInShortArrayStopAtParensClosureCall */
+ 'closureCall' => $closure($arg, [$arg], $arg),
+
+ /* testShortArrayInShortArrayStopAtParensFnCall */
+ 'fnCall' => $fn($arg, [$arg], $arg),
+];
+
+[
+ /* testShortArrayInShortListStopAtParensFuncCall */
+ function_call($arg, [$arg], $arg) => $a,
+
+ /* testShortArrayInShortListStopAtParensClosureCall */
+ $closure($arg, [$arg], $arg) => $b,
+
+ /* testShortArrayInShortListStopAtParensFnCall */
+ $fn($arg, [$arg], $arg) => $c,
+] = $array;
+
+
+/* ===== Tests verifying that the loop stops as quickly as possible when an adjacent bracket set is found for which the type is known. ===== */
+
+$array = [
+ /* testShortArrayAdjacent1 */
+ 'adjacent with same code pattern' => [$a],
+
+ /* testShortArrayAdjacent2 */
+ [$a], // Adjacent not same code pattern.
+
+ /* testShortArrayReuseTypeOfAdjacent */
+ 'array under investigation' => [$a],
+
+ // Prevent going straight to outer brackets for last item.
+ [$b],
+];
+
+[
+ /* testShortListAdjacent1 */
+ 'adjacent with same code pattern' => [$a],
+
+ /* testShortListAdjacent2 */
+ [$a], // Adjacent not same code pattern.
+
+ /* testShortListReuseTypeOfAdjacent */
+ 'list under investigation' => [$a],
+
+ // Prevent going straight to outer brackets for last item.
+ 'skip' => [$b],
+
+] = $array;
+
+
+/* ===== Tests handling unclosed open brackets. ===== */
+
+// Intentional parse error. This has to be the last test in the file.
+[$a, /* testLiveCodingNested */ [$b],
diff --git a/Tests/Internal/IsShortArrayOrList/WalkOutsideTest.php b/Tests/Internal/IsShortArrayOrList/WalkOutsideTest.php
new file mode 100644
index 00000000..c95c098a
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrList/WalkOutsideTest.php
@@ -0,0 +1,205 @@
+getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY]);
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $stackPtr, []);
+ $type = $solver->solve();
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testWalkOutside() For the array format.
+ *
+ * @return array
+ */
+ public function dataWalkOutside()
+ {
+ return [
+ 'nested-short-array-start-of-file' => [
+ 'testMarker' => '/* testShortArrayStopAtStartOfFile */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'nested-short-array-jump-test' => [
+ 'testMarker' => '/* testShortArrayJumpingOver */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'nested-short-list-jump-test' => [
+ 'testMarker' => '/* testShortListJumpingOver */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+
+ 'outer-short-array-stop-test-semicolon' => [
+ 'testMarker' => '/* testOuterShortArrayStopAtSemicolon */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'outer-short-array-stop-test-open-tag' => [
+ 'testMarker' => '/* testOuterShortArrayStopAtOpenTag */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'outer-short-array-stop-test-short-open-echo' => [
+ 'testMarker' => '/* testOuterShortArrayStopAtOpenEchoTag */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'outer-short-array-stop-test-curly-open' => [
+ 'testMarker' => '/* testOuterShortArrayStopAtCurly */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'outer-short-array-stop-test-parens-open-1' => [
+ 'testMarker' => '/* testOuterShortArrayStopAtParensFuncCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'outer-short-array-stop-test-parens-open-2' => [
+ 'testMarker' => '/* testOuterShortArrayStopAtParensClosureCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'outer-short-array-stop-test-parens-open-3' => [
+ 'testMarker' => '/* testOuterShortArrayStopAtParensFnCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'inner-short-array-stop-test-curly-open' => [
+ 'testMarker' => '/* testShortArrayInShortArrayStopAtCurly */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'inner-short-list-stop-test-semicolon' => [
+ 'testMarker' => '/* testShortArrayInShortListStopAtSemicolon */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'inner-short-array-stop-test-parens-open-1' => [
+ 'testMarker' => '/* testShortArrayInShortArrayStopAtParensFuncCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'inner-short-array-stop-test-parens-open-2' => [
+ 'testMarker' => '/* testShortArrayInShortArrayStopAtParensClosureCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'inner-short-array-stop-test-parens-open-3' => [
+ 'testMarker' => '/* testShortArrayInShortArrayStopAtParensFnCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'inner-short-array-stop-test-parens-open-4' => [
+ 'testMarker' => '/* testShortArrayInShortListStopAtParensFuncCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'inner-short-array-stop-test-parens-open-5' => [
+ 'testMarker' => '/* testShortArrayInShortListStopAtParensClosureCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'inner-short-array-stop-test-parens-open-6' => [
+ 'testMarker' => '/* testShortArrayInShortListStopAtParensFnCall */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'parse-error-live-coding' => [
+ 'testMarker' => '/* testLiveCodingNested */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ ];
+ }
+
+ /**
+ * Test that the method correctly re-uses cached information for adjacent sets of brackets.
+ *
+ * @dataProvider dataReuseCacheFromAdjacent
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param string $adjacent1 The comment which prefaces the matching adjacent bracket set in the test file.
+ * @param string $adjacent2 The comment which prefaces the non-matching adjacent bracket set in the test file.
+ * @param string $expected The expected function output.
+ *
+ * @return void
+ */
+ public function testReuseCacheFromAdjacent($testMarker, $adjacent1, $adjacent2, $expected)
+ {
+ $adjacentPtr1 = $this->getTargetToken($adjacent1, \T_OPEN_SHORT_ARRAY);
+ $adjacentPtr2 = $this->getTargetToken($adjacent2, \T_OPEN_SHORT_ARRAY);
+ $target = $this->getTargetToken($testMarker, \T_OPEN_SHORT_ARRAY);
+
+ // Verify the cache of the adjacent bracket set is re-used.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ // Make sure the type of the adjacent bracket sets is cached.
+ IsShortArrayOrListWithCache::getType(self::$phpcsFile, $adjacentPtr1); // Same code pattern.
+ IsShortArrayOrListWithCache::getType(self::$phpcsFile, $adjacentPtr2); // Not the same code pattern.
+
+ // Check the type of the current target set of brackets.
+ $solver = new IsShortArrayOrList(self::$phpcsFile, $target);
+ $type = $solver->solve();
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertSame($expected, $type);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testReuseCacheFromAdjacent() For the array format.
+ *
+ * @return array
+ */
+ public function dataReuseCacheFromAdjacent()
+ {
+ return [
+ 'nested-short-array' => [
+ 'testMarker' => '/* testShortArrayReuseTypeOfAdjacent */',
+ 'adjacent1' => '/* testShortArrayAdjacent1 */',
+ 'adjacent2' => '/* testShortArrayAdjacent2 */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+
+ 'nested-short-list' => [
+ 'testMarker' => '/* testShortListReuseTypeOfAdjacent */',
+ 'adjacent1' => '/* testShortListAdjacent1 */',
+ 'adjacent2' => '/* testShortListAdjacent2 */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrListWithCache/CachingTest.php b/Tests/Internal/IsShortArrayOrListWithCache/CachingTest.php
new file mode 100644
index 00000000..2005af44
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrListWithCache/CachingTest.php
@@ -0,0 +1,116 @@
+getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
+ $closer = $this->getTargetToken($testMarker, [\T_CLOSE_SHORT_ARRAY, \T_CLOSE_SQUARE_BRACKET]);
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = IsShortArrayOrListWithCache::getType(self::$phpcsFile, $closer);
+ $isCachedOpener = Cache::isCached(self::$phpcsFile, IsShortArrayOrListWithCache::CACHE_KEY, $opener);
+ $isCachedCloser = Cache::isCached(self::$phpcsFile, IsShortArrayOrListWithCache::CACHE_KEY, $closer);
+ $resultSecondRun = IsShortArrayOrListWithCache::getType(self::$phpcsFile, $opener);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertSame($expected, $resultFirstRun, 'First result did not match expectation');
+ $this->assertTrue($isCachedOpener, 'Cache::isCached() could not find the cached value');
+ $this->assertFalse($isCachedCloser, 'Cache::isCached() erroneously found a cached value for the closer');
+ $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function dataResultIsCached()
+ {
+ return [
+ 'short array' => [
+ 'testMarker' => '/* testShortArray */',
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short list' => [
+ 'testMarker' => '/* testShortList */',
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'square bracket' => [
+ 'testMarker' => '/* testSquareBrackets */',
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ ];
+ }
+
+ /**
+ * Verify that the result is not cached when an invalid token is passed.
+ *
+ * @return void
+ */
+ public function testInvalidTokenResultIsNotCached()
+ {
+ $stackPtr = $this->getTargetToken('/* testLongArray */', \T_ARRAY);
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = IsShortArrayOrListWithCache::getType(self::$phpcsFile, $stackPtr);
+ $isCached = Cache::isCached(self::$phpcsFile, IsShortArrayOrListWithCache::CACHE_KEY, $stackPtr);
+ $resultSecondRun = IsShortArrayOrListWithCache::getType(self::$phpcsFile, $stackPtr);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertFalse($resultFirstRun, 'First result did not match expectation');
+ $this->assertFalse($isCached, 'Cache::isCached() erroneously found a cached value');
+ $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrListWithCache/EntryPointsTest.php b/Tests/Internal/IsShortArrayOrListWithCache/EntryPointsTest.php
new file mode 100644
index 00000000..b70cb39d
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrListWithCache/EntryPointsTest.php
@@ -0,0 +1,162 @@
+getTargetToken($testMarker, $targetType);
+ $this->assertIsBool(Arrays::isShortArray(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Validate that the `Lists::isShortList()` method is accessible and always returns a boolean value.
+ *
+ * @dataProvider dataEntryPoints
+ *
+ * @covers \PHPCSUtils\Utils\Lists::isShortList
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int|string|array $targetType The token type(s) to look for.
+ *
+ * @return void
+ */
+ public function testIsShortListApi($testMarker, $targetType)
+ {
+ $target = $this->getTargetToken($testMarker, $targetType);
+ $this->assertIsBool(Lists::isShortList(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Validate that the `IsShortArrayOrListWithCache::isShortArray()` method is accessible
+ * and always returns a boolean value.
+ *
+ * @dataProvider dataEntryPoints
+ *
+ * @covers \PHPCSUtils\Internal\IsShortArrayOrListWithCache::isShortArray
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int|string|array $targetType The token type(s) to look for.
+ *
+ * @return void
+ */
+ public function testIsShortArrayInternal($testMarker, $targetType)
+ {
+ $target = $this->getTargetToken($testMarker, $targetType);
+ $this->assertIsBool(IsShortArrayOrListWithCache::isShortArray(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Validate that the `IsShortArrayOrListWithCache::isShortList()` method is accessible
+ * and always returns a boolean value.
+ *
+ * @dataProvider dataEntryPoints
+ *
+ * @covers \PHPCSUtils\Internal\IsShortArrayOrListWithCache::isShortList
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int|string|array $targetType The token type(s) to look for.
+ *
+ * @return void
+ */
+ public function testIsShortListInternal($testMarker, $targetType)
+ {
+ $target = $this->getTargetToken($testMarker, $targetType);
+ $this->assertIsBool(IsShortArrayOrListWithCache::isShortList(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Validate that the `IsShortArrayOrListWithCache::getType()` method is accessible
+ * and always returns a boolean value.
+ *
+ * @dataProvider dataEntryPoints
+ *
+ * @covers \PHPCSUtils\Internal\IsShortArrayOrListWithCache::getType
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int|string|array $targetType The token type(s) to look for.
+ *
+ * @return void
+ */
+ public function testGetTypeInternal($testMarker, $targetType)
+ {
+ $target = $this->getTargetToken($testMarker, $targetType);
+ $this->assertContains(IsShortArrayOrListWithCache::getType(self::$phpcsFile, $target), $this->validValues);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function dataEntryPoints()
+ {
+ $defaultTargets = Collections::shortArrayListOpenTokensBC();
+
+ return [
+ 'not a square bracket' => [
+ 'testMarker' => '/* testLongArray */',
+ 'targetType' => \T_ARRAY,
+ ],
+ 'short array' => [
+ 'testMarker' => '/* testShortArray */',
+ 'targetType' => $defaultTargets,
+ ],
+ 'short list' => [
+ 'testMarker' => '/* testShortList */',
+ 'targetType' => $defaultTargets,
+ ],
+ 'square bracket' => [
+ 'testMarker' => '/* testSquareBrackets */',
+ 'targetType' => $defaultTargets,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrListWithCache/IsShortArrayOrListWithCacheTest.inc b/Tests/Internal/IsShortArrayOrListWithCache/IsShortArrayOrListWithCacheTest.inc
new file mode 100644
index 00000000..b422081f
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrListWithCache/IsShortArrayOrListWithCacheTest.inc
@@ -0,0 +1,23 @@
+assertFalse(IsShortArrayOrListWithCache::getType(self::$phpcsFile, 100000));
+ }
+
+ /**
+ * Test that false is returned when a non-bracket token is passed.
+ *
+ * @dataProvider dataNotBracket
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int|string|array $targetType The token type(s) to look for.
+ *
+ * @return void
+ */
+ public function testNotBracket($testMarker, $targetType)
+ {
+ $target = $this->getTargetToken($testMarker, $targetType);
+ $this->assertFalse(IsShortArrayOrListWithCache::getType(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testNotBracket() For the array format.
+ *
+ * @return array
+ */
+ public function dataNotBracket()
+ {
+ return [
+ 'long-array' => [
+ 'testMarker' => '/* testLongArray */',
+ 'targetType' => \T_ARRAY,
+ ],
+ 'long-list' => [
+ 'testMarker' => '/* testLongList */',
+ 'targetType' => \T_LIST,
+ ],
+ ];
+ }
+
+ /**
+ * Test that the returned type is one of the valid values when a valid bracket token is passed.
+ *
+ * This test also safeguards that the class supports both open, as well as close brackets.
+ *
+ * @dataProvider dataValidBracket
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int|string|array $targetType The token type(s) to look for.
+ *
+ * @return void
+ */
+ public function testValidBracket($testMarker, $targetType)
+ {
+ $target = $this->getTargetToken($testMarker, $targetType);
+ $result = IsShortArrayOrListWithCache::getType(self::$phpcsFile, $target);
+
+ $this->assertContains($result, $this->validValues);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testNotBracket() For the array format.
+ *
+ * @return array
+ */
+ public function dataValidBracket()
+ {
+ return [
+ 'open square bracket' => [
+ 'testMarker' => '/* testSquareBrackets */',
+ 'targetType' => \T_OPEN_SQUARE_BRACKET,
+ ],
+ 'close square bracket' => [
+ 'testMarker' => '/* testSquareBrackets */',
+ 'targetType' => \T_CLOSE_SQUARE_BRACKET,
+ ],
+ 'open short array token' => [
+ 'testMarker' => '/* testShortArray */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ ],
+ 'close short list token' => [
+ 'testMarker' => '/* testShortList */',
+ 'targetType' => \T_CLOSE_SHORT_ARRAY,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/IsShortArrayOrListWithCache/ProcessTest.php b/Tests/Internal/IsShortArrayOrListWithCache/ProcessTest.php
new file mode 100644
index 00000000..7a651867
--- /dev/null
+++ b/Tests/Internal/IsShortArrayOrListWithCache/ProcessTest.php
@@ -0,0 +1,104 @@
+getTargetToken('/* testLongArray */', \T_ARRAY);
+ $this->assertFalse(IsShortArrayOrListWithCache::getType(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Test the process method works for all supported token types which are allowed to be passed to it.
+ *
+ * @dataProvider dataSupportedBrackets
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int|string|array $targetType The token type(s) to look for.
+ * @param string|false $expected The expected function return value.
+ *
+ * @return void
+ */
+ public function testSupportedBrackets($testMarker, $targetType, $expected)
+ {
+ $target = $this->getTargetToken($testMarker, $targetType);
+ $this->assertSame($expected, IsShortArrayOrListWithCache::getType(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testSupportedBrackets() For the array format.
+ *
+ * @return array
+ */
+ public function dataSupportedBrackets()
+ {
+ return [
+ 'short array open bracket' => [
+ 'testMarker' => '/* testShortArray */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short array close bracket' => [
+ 'testMarker' => '/* testShortArray */',
+ 'targetType' => \T_CLOSE_SHORT_ARRAY,
+ 'expected' => IsShortArrayOrList::SHORT_ARRAY,
+ ],
+ 'short list openbracket' => [
+ 'testMarker' => '/* testShortList */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'short list close bracket' => [
+ 'testMarker' => '/* testShortList */',
+ 'targetType' => \T_CLOSE_SHORT_ARRAY,
+ 'expected' => IsShortArrayOrList::SHORT_LIST,
+ ],
+ 'square brackets open bracket' => [
+ 'testMarker' => '/* testSquareBrackets */',
+ 'targetType' => \T_OPEN_SQUARE_BRACKET,
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'square brackets close-bracket' => [
+ 'testMarker' => '/* testSquareBrackets */',
+ 'targetType' => \T_CLOSE_SQUARE_BRACKET,
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ 'parse error close bracket' => [
+ 'testMarker' => '/* testParseError */',
+ 'targetType' => \T_CLOSE_SQUARE_BRACKET,
+ 'expected' => IsShortArrayOrList::SQUARE_BRACKETS,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Internal/NoFileCache/GetClearTest.php b/Tests/Internal/NoFileCache/GetClearTest.php
new file mode 100644
index 00000000..e00ca447
--- /dev/null
+++ b/Tests/Internal/NoFileCache/GetClearTest.php
@@ -0,0 +1,283 @@
+ $dataset) {
+ NoFileCache::set('Utility1', $id, $dataset['input']);
+ NoFileCache::set('Utility2', $id, $dataset['input']);
+ }
+ }
+
+ /**
+ * Clear the cache between tests.
+ *
+ * @after
+ *
+ * @return void
+ */
+ protected function clearCache()
+ {
+ NoFileCache::clear();
+ }
+
+ /**
+ * Reset the caching status.
+ *
+ * @afterClass
+ *
+ * @return void
+ */
+ public static function resetCachingStatus()
+ {
+ NoFileCache::$enabled = self::$origCacheEnabled;
+ }
+
+ /**
+ * Test that a cache key which has not been set is identified correctly as such.
+ *
+ * @covers ::isCached
+ *
+ * @return void
+ */
+ public function testIsCachedWillReturnFalseForUnavailableKey()
+ {
+ $this->assertFalse(NoFileCache::isCached('Utility3', 'numeric string'));
+ }
+
+ /**
+ * Test that a cache id which has not been set is identified correctly as such.
+ *
+ * @covers ::isCached
+ *
+ * @return void
+ */
+ public function testIsCachedWillReturnFalseForUnavailableId()
+ {
+ $this->assertFalse(NoFileCache::isCached('Utility1', 'this ID does not exist'));
+ }
+
+ /**
+ * Test that disabling the cache will short-circuit cache checking.
+ *
+ * @covers ::isCached
+ *
+ * @return void
+ */
+ public function testIsCachedWillReturnFalseWhenCachingDisabled()
+ {
+ $wasEnabled = NoFileCache::$enabled;
+ NoFileCache::$enabled = false;
+
+ $isCached = NoFileCache::isCached('Utility1', 'numeric string');
+
+ NoFileCache::$enabled = $wasEnabled;
+
+ $this->assertFalse($isCached);
+ }
+
+ /**
+ * Test that retrieving a cache key which has not been set, yields null.
+ *
+ * @covers ::get
+ *
+ * @return void
+ */
+ public function testGetWillReturnNullForUnavailableKey()
+ {
+ $this->assertNull(NoFileCache::get('Utility3', 'numeric string'));
+ }
+
+ /**
+ * Test that retrieving a cache id which has not been set, yields null.
+ *
+ * @covers ::get
+ *
+ * @return void
+ */
+ public function testGetWillReturnNullForUnavailableId()
+ {
+ $this->assertNull(NoFileCache::get('Utility1', 'this ID does not exist'));
+ }
+
+ /**
+ * Test that disabling the cache will short-circuit cache retrieval.
+ *
+ * @covers ::get
+ *
+ * @return void
+ */
+ public function testGetWillReturnNullWhenCachingDisabled()
+ {
+ $wasEnabled = NoFileCache::$enabled;
+ NoFileCache::$enabled = false;
+
+ $retrieved = NoFileCache::get('Utility1', 'numeric string');
+
+ NoFileCache::$enabled = $wasEnabled;
+
+ $this->assertNull($retrieved);
+ }
+
+ /**
+ * Test that retrieving a cache set for a cache key which has not been set, yields an empty array.
+ *
+ * @covers ::getForKey
+ *
+ * @return void
+ */
+ public function testGetForKeyWillReturnEmptyArrayForUnavailableData()
+ {
+ $this->assertSame([], NoFileCache::getForKey('Utility3'));
+ }
+
+ /**
+ * Test that disabling the cache will short-circuit cache for key retrieval.
+ *
+ * @covers ::getForKey
+ *
+ * @return void
+ */
+ public function testGetForKeyWillReturnEmptyArrayWhenCachingDisabled()
+ {
+ $wasEnabled = NoFileCache::$enabled;
+ NoFileCache::$enabled = false;
+
+ $retrieved = NoFileCache::getForKey('Utility1');
+
+ NoFileCache::$enabled = $wasEnabled;
+
+ $this->assertSame([], $retrieved);
+ }
+
+ /**
+ * Test that previously cached data can be retrieved correctly.
+ *
+ * @dataProvider dataEveryTypeOfInput
+ *
+ * @covers ::get
+ *
+ * @param int|string $id The ID of the cached value to retrieve.
+ * @param mixed $expected The expected cached value.
+ *
+ * @return void
+ */
+ public function testGetWillRetrievedPreviouslySetValue($id, $expected)
+ {
+ if (\is_object($expected)) {
+ $this->assertEquals($expected, NoFileCache::get('Utility1', $id));
+ } else {
+ $this->assertSame($expected, NoFileCache::get('Utility1', $id));
+ }
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function dataEveryTypeOfInput()
+ {
+ $allTypes = TypeProviderHelper::getAll();
+ $data = [];
+ foreach ($allTypes as $key => $dataset) {
+ $data[$key] = [
+ 'id' => $key,
+ 'expected' => $dataset['input'],
+ ];
+ }
+
+ return $data;
+ }
+
+ /**
+ * Test that the `getForKey()` method correctly retrieves a subset of the cached data.
+ *
+ * @covers ::getForKey
+ *
+ * @return void
+ */
+ public function testGetForKey()
+ {
+ $dataSet1 = NoFileCache::getForKey('Utility1');
+ $dataSet2 = NoFileCache::getForKey('Utility2');
+ $this->assertSame($dataSet1, $dataSet2);
+ }
+
+ /**
+ * Test that previously cached data is no longer available when the cache has been cleared.
+ *
+ * @dataProvider dataEveryTypeOfInput
+ *
+ * @covers ::clear
+ *
+ * @param int|string $id The ID of the cached value to retrieve.
+ *
+ * @return void
+ */
+ public function testClearCache($id)
+ {
+ NoFileCache::clear();
+
+ $this->assertFalse(NoFileCache::isCached('Utility1', $id));
+ $this->assertFalse(NoFileCache::isCached('Utility2', $id));
+ }
+}
diff --git a/Tests/Internal/NoFileCache/SetTest.php b/Tests/Internal/NoFileCache/SetTest.php
new file mode 100644
index 00000000..916f53f0
--- /dev/null
+++ b/Tests/Internal/NoFileCache/SetTest.php
@@ -0,0 +1,238 @@
+getName();
+ NoFileCache::set(__METHOD__, $id, $input);
+
+ $this->assertTrue(
+ NoFileCache::isCached(__METHOD__, $id),
+ 'NoFileCache::isCached() could not find the cached value'
+ );
+
+ $this->assertSame(
+ $input,
+ NoFileCache::get(__METHOD__, $id),
+ 'Value retrieved via NoFileCache::get() did not match expectations'
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function dataEveryTypeOfInput()
+ {
+ return TypeProviderHelper::getAll();
+ }
+
+ /**
+ * Verify that all supported types of IDs are accepted.
+ *
+ * Note: this doesn't test the unhappy path of passing an unsupported type of key, but
+ * non-int/string keys are not accepted by PHP for arrays anyway, so that should result
+ * in PHP warnings/errors anyway and as this is an internal class, I'm not too concerned
+ * about that kind of mistake being made.
+ *
+ * @dataProvider dataSetAcceptsIntAndStringIdKeys
+ *
+ * @param int|string $id ID for the cache.
+ *
+ * @return void
+ */
+ public function testSetAcceptsIntAndStringIdKeys($id)
+ {
+ $value = 'value' . $id;
+
+ NoFileCache::set(__METHOD__, $id, $value);
+
+ $this->assertTrue(
+ NoFileCache::isCached(__METHOD__, $id),
+ 'NoFileCache::isCached() could not find the cached value'
+ );
+
+ $this->assertSame(
+ $value,
+ NoFileCache::get(__METHOD__, $id),
+ 'Value retrieved via NoFileCache::get() did not match expectations'
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function dataSetAcceptsIntAndStringIdKeys()
+ {
+ return [
+ 'ID: int zero' => [
+ 'id' => 0,
+ ],
+ 'ID: positive int' => [
+ 'id' => 12832,
+ ],
+ 'ID: negative int' => [
+ 'id' => -274,
+ ],
+ 'ID: string' => [
+ 'id' => 'string ID',
+ ],
+ ];
+ }
+
+ /**
+ * Verify that a previously set cached value will be overwritten when set() is called again
+ * with the same file, ID and key.
+ *
+ * @return void
+ */
+ public function testSetWillOverwriteExistingValue()
+ {
+ $id = 'my key';
+ $origValue = 'original value';
+
+ NoFileCache::set(__METHOD__, $id, $origValue);
+
+ // Verify that the original value was set correctly.
+ $this->assertTrue(
+ NoFileCache::isCached(__METHOD__, $id),
+ 'NoFileCache::isCached() could not find the originally cached value'
+ );
+ $this->assertSame(
+ $origValue,
+ NoFileCache::get(__METHOD__, $id),
+ 'Original value retrieved via NoFileCache::get() did not match expectations'
+ );
+
+ $newValue = 'new value';
+ NoFileCache::set(__METHOD__, $id, $newValue);
+
+ // Verify the overwrite happened.
+ $this->assertTrue(
+ NoFileCache::isCached(__METHOD__, $id),
+ 'NoFileCache::isCached() could not find the newly cached value'
+ );
+ $this->assertSame(
+ $newValue,
+ NoFileCache::get(__METHOD__, $id),
+ 'New value retrieved via NoFileCache::get() did not match expectations'
+ );
+ }
+
+ /**
+ * Verify that disabling the cache will short-circuit caching (and not eat memory).
+ *
+ * @return void
+ */
+ public function testSetWillNotSaveDataWhenCachingIsDisabled()
+ {
+ $id = 'id';
+ $value = 'value';
+
+ $wasEnabled = NoFileCache::$enabled;
+ NoFileCache::$enabled = false;
+
+ NoFileCache::set(__METHOD__, $id, $value);
+
+ NoFileCache::$enabled = $wasEnabled;
+
+ $this->assertFalse(
+ NoFileCache::isCached(__METHOD__, $id),
+ 'NoFileCache::isCached() found a cache which was set while caching was disabled'
+ );
+
+ $this->assertNull(
+ NoFileCache::get(__METHOD__, $id),
+ 'Value retrieved via NoFileCache::get() did not match expectations'
+ );
+ }
+}
diff --git a/Tests/PolyfilledTestCase.php b/Tests/PolyfilledTestCase.php
new file mode 100644
index 00000000..58af5e3d
--- /dev/null
+++ b/Tests/PolyfilledTestCase.php
@@ -0,0 +1,65 @@
+expectPhpcsException('testing-1-2-3');
+ throw new RuntimeException('testing-1-2-3');
+ }
+
+ /**
+ * Test that the helper method to handle cross-version testing of exceptions in PHPUnit
+ * works correctly.
+ *
+ * @return void
+ */
+ public function testExpectPhpcsTokenizerException()
+ {
+ $this->expectPhpcsException('testing-1-2-3', 'tokenizer');
+ throw new TokenizerException('testing-1-2-3');
+ }
+}
diff --git a/Tests/TestUtils/UtilityMethodTestCase/FailedToTokenizeTest.php b/Tests/TestUtils/UtilityMethodTestCase/FailedToTokenizeTest.php
index 39a2af03..988d89b3 100644
--- a/Tests/TestUtils/UtilityMethodTestCase/FailedToTokenizeTest.php
+++ b/Tests/TestUtils/UtilityMethodTestCase/FailedToTokenizeTest.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\TestUtils\UtilityMethodTestCase;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tests\PolyfilledTestCase;
/**
* Tests for the \PHPCSUtils\TestUtils\UtilityMethodTestCase class.
@@ -21,7 +21,7 @@
*
* @since 1.0.0
*/
-class FailedToTokenizeTest extends UtilityMethodTestCase
+final class FailedToTokenizeTest extends PolyfilledTestCase
{
/**
@@ -50,14 +50,8 @@ public function testMissingCaseFile()
$exception = 'PHPUnit_Framework_AssertionFailedError';
}
- if (\method_exists($this, 'expectException')) {
- // PHPUnit 5+.
- $this->expectException($exception);
- $this->expectExceptionMessage($msg);
- } else {
- // PHPUnit 4.
- $this->setExpectedException($exception, $msg);
- }
+ $this->expectException($exception);
+ $this->expectExceptionMessage($msg);
parent::setUpTestFile();
}
diff --git a/Tests/TestUtils/UtilityMethodTestCase/GetTargetTokenFileNotFoundTest.php b/Tests/TestUtils/UtilityMethodTestCase/GetTargetTokenFileNotFoundTest.php
new file mode 100644
index 00000000..1990b7b6
--- /dev/null
+++ b/Tests/TestUtils/UtilityMethodTestCase/GetTargetTokenFileNotFoundTest.php
@@ -0,0 +1,54 @@
+expectException('PHPCSUtils\Exceptions\TestFileNotFound');
+ $this->expectExceptionMessage(
+ 'Failed to find a tokenized test case file.' . \PHP_EOL
+ . 'Make sure the UtilityMethodTestCase::setUpTestFile() method has run'
+ );
+
+ $this->getTargetToken('/* testSomething */', [\T_VARIABLE], '$a');
+ }
+}
diff --git a/Tests/TestUtils/UtilityMethodTestCase/GetTargetTokenTest.php b/Tests/TestUtils/UtilityMethodTestCase/GetTargetTokenTest.php
new file mode 100644
index 00000000..162da8f5
--- /dev/null
+++ b/Tests/TestUtils/UtilityMethodTestCase/GetTargetTokenTest.php
@@ -0,0 +1,152 @@
+getTargetToken($commentString, $tokenType, $tokenContent);
+ } else {
+ $result = self::getTargetToken($commentString, $tokenType);
+ }
+
+ $this->assertSame($expected, $result);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testGetTargetToken() For the array format.
+ *
+ * @return array
+ */
+ public function dataGetTargetToken()
+ {
+ return [
+ 'single-token-type' => [
+ 'expected' => 6,
+ 'commentString' => '/* testFindingTarget */',
+ 'tokenType' => \T_VARIABLE,
+ ],
+ 'multi-token-type-1' => [
+ 'expected' => 6,
+ 'commentString' => '/* testFindingTarget */',
+ 'tokenType' => [\T_VARIABLE, \T_FALSE],
+ ],
+ 'multi-token-type-2' => [
+ 'expected' => 11,
+ 'commentString' => '/* testFindingTarget */',
+ 'tokenType' => [\T_FALSE, \T_LNUMBER],
+ ],
+ 'content-method' => [
+ 'expected' => 23,
+ 'commentString' => '/* testFindingTargetWithContent */',
+ 'tokenType' => \T_STRING,
+ 'tokenContent' => 'method',
+ ],
+ 'content-otherMethod' => [
+ 'expected' => 33,
+ 'commentString' => '/* testFindingTargetWithContent */',
+ 'tokenType' => \T_STRING,
+ 'tokenContent' => 'otherMethod',
+ ],
+ 'content-$a' => [
+ 'expected' => 21,
+ 'commentString' => '/* testFindingTargetWithContent */',
+ 'tokenType' => \T_VARIABLE,
+ 'tokenContent' => '$a',
+ ],
+ 'content-$b' => [
+ 'expected' => 31,
+ 'commentString' => '/* testFindingTargetWithContent */',
+ 'tokenType' => \T_VARIABLE,
+ 'tokenContent' => '$b',
+ ],
+ 'content-foo' => [
+ 'expected' => 26,
+ 'commentString' => '/* testFindingTargetWithContent */',
+ 'tokenType' => [\T_CONSTANT_ENCAPSED_STRING, \T_DOUBLE_QUOTED_STRING],
+ 'tokenContent' => "'foo'",
+ ],
+ 'content-bar' => [
+ 'expected' => 36,
+ 'commentString' => '/* testFindingTargetWithContent */',
+ 'tokenType' => [\T_CONSTANT_ENCAPSED_STRING, \T_DOUBLE_QUOTED_STRING],
+ 'tokenContent' => "'bar'",
+ ],
+ ];
+ }
+
+ /**
+ * Test the behaviour of the getTargetToken() method when the test marker comment is not found.
+ *
+ * @return void
+ */
+ public function testGetTargetTokenCommentNotFound()
+ {
+ $this->expectException('PHPCSUtils\Exceptions\TestMarkerNotFound');
+ $this->expectExceptionMessage('Failed to find the test marker: ');
+
+ $this->getTargetToken('/* testCommentDoesNotExist */', [\T_VARIABLE], '$a');
+ }
+
+ /**
+ * Test the behaviour of the getTargetToken() method when the target is not found.
+ *
+ * @return void
+ */
+ public function testGetTargetTokenNotFoundException()
+ {
+ $this->expectException('PHPCSUtils\Exceptions\TestTargetNotFound');
+ $this->expectExceptionMessage('Failed to find test target token for comment string: ');
+
+ self::getTargetToken('/* testNotFindingTarget */', [\T_VARIABLE], '$a');
+ }
+}
diff --git a/Tests/TestUtils/UtilityMethodTestCase/MissingCaseFileTest.php b/Tests/TestUtils/UtilityMethodTestCase/MissingCaseFileTest.php
index f53d4c87..ead82dfa 100644
--- a/Tests/TestUtils/UtilityMethodTestCase/MissingCaseFileTest.php
+++ b/Tests/TestUtils/UtilityMethodTestCase/MissingCaseFileTest.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\TestUtils\UtilityMethodTestCase;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tests\PolyfilledTestCase;
/**
* Tests for the \PHPCSUtils\TestUtils\UtilityMethodTestCase class.
@@ -21,7 +21,7 @@
*
* @since 1.0.0
*/
-class MissingCaseFileTest extends UtilityMethodTestCase
+final class MissingCaseFileTest extends PolyfilledTestCase
{
/**
@@ -50,14 +50,8 @@ public function testMissingCaseFile()
$exception = 'PHPUnit_Framework_AssertionFailedError';
}
- if (\method_exists($this, 'expectException')) {
- // PHPUnit 5+.
- $this->expectException($exception);
- $this->expectExceptionMessage($msg);
- } else {
- // PHPUnit 4.
- $this->setExpectedException($exception, $msg);
- }
+ $this->expectException($exception);
+ $this->expectExceptionMessage($msg);
parent::setUpTestFile();
}
diff --git a/Tests/TestUtils/UtilityMethodTestCase/SkipCSJSTest.js b/Tests/TestUtils/UtilityMethodTestCase/SkipJSCSSTestsOnPHPCS4Test.js
similarity index 100%
rename from Tests/TestUtils/UtilityMethodTestCase/SkipCSJSTest.js
rename to Tests/TestUtils/UtilityMethodTestCase/SkipJSCSSTestsOnPHPCS4Test.js
diff --git a/Tests/TestUtils/UtilityMethodTestCase/SkipCSJSTest.php b/Tests/TestUtils/UtilityMethodTestCase/SkipJSCSSTestsOnPHPCS4Test.php
similarity index 73%
rename from Tests/TestUtils/UtilityMethodTestCase/SkipCSJSTest.php
rename to Tests/TestUtils/UtilityMethodTestCase/SkipJSCSSTestsOnPHPCS4Test.php
index 0831bc34..76064d2c 100644
--- a/Tests/TestUtils/UtilityMethodTestCase/SkipCSJSTest.php
+++ b/Tests/TestUtils/UtilityMethodTestCase/SkipJSCSSTestsOnPHPCS4Test.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\TestUtils\UtilityMethodTestCase;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tests\PolyfilledTestCase;
/**
* Tests for the \PHPCSUtils\TestUtils\UtilityMethodTestCase class.
@@ -21,7 +21,7 @@
*
* @since 1.0.0
*/
-class SkipJSCSSTest extends UtilityMethodTestCase
+final class SkipJSCSSTestsOnPHPCS4Test extends PolyfilledTestCase
{
/**
@@ -46,13 +46,11 @@ public function skipJSCSSTestsOnPHPCS4()
/**
* Test that the skipJSCSSTestsOnPHPCS4() skips JS/CSS file tests on PHPCS 4.x.
*
- * @doesNotPerformAssertions
- *
* @return void
*/
public function testSkipJsCss()
{
- if (\version_compare(static::$phpcsVersion, '3.99.99', '>') === true) {
+ if (\version_compare(parent::$phpcsVersion, '3.99.99', '>') === true) {
$msg = 'JS and CSS support has been removed in PHPCS 4.';
$exception = 'PHPUnit\Framework\SkippedTestError';
if (\class_exists('PHPUnit_Framework_SkippedTestError')) {
@@ -60,14 +58,11 @@ public function testSkipJsCss()
$exception = 'PHPUnit_Framework_SkippedTestError';
}
- if (\method_exists($this, 'expectException')) {
- // PHPUnit 5+.
- $this->expectException($exception);
- $this->expectExceptionMessage($msg);
- } else {
- // PHPUnit 4.
- $this->setExpectedException($exception, $msg);
- }
+ $this->expectException($exception);
+ $this->expectExceptionMessage($msg);
+ } else {
+ // Get rid of the "does not perform assertions" warning when run with PHPCS 3.x.
+ $this->assertTrue(true);
}
parent::skipJSCSSTestsOnPHPCS4();
diff --git a/Tests/TestUtils/UtilityMethodTestCase/UtilityMethodTestCaseTest.php b/Tests/TestUtils/UtilityMethodTestCase/UtilityMethodTestCaseTest.php
index 9a0ba793..6247c17f 100644
--- a/Tests/TestUtils/UtilityMethodTestCase/UtilityMethodTestCaseTest.php
+++ b/Tests/TestUtils/UtilityMethodTestCase/UtilityMethodTestCaseTest.php
@@ -10,9 +10,7 @@
namespace PHPCSUtils\Tests\TestUtils\UtilityMethodTestCase;
-use PHP_CodeSniffer\Exceptions\RuntimeException;
-use PHP_CodeSniffer\Exceptions\TokenizerException;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tests\PolyfilledTestCase;
/**
* Tests for the \PHPCSUtils\TestUtils\UtilityMethodTestCase class.
@@ -23,7 +21,7 @@
*
* @since 1.0.0
*/
-class UtilityMethodTestCaseTest extends UtilityMethodTestCase
+final class UtilityMethodTestCaseTest extends PolyfilledTestCase
{
/**
@@ -51,160 +49,24 @@ public function testSetUp()
$this->assertSame(57, self::$phpcsFile->numTokens);
$tokens = self::$phpcsFile->getTokens();
- if (\method_exists($this, 'assertIsArray')) {
- // PHPUnit 7+.
- $this->assertIsArray($tokens);
- } else {
- // PHPUnit 4/5/6.
- $this->assertInternalType('array', $tokens);
- }
- }
-
- /**
- * Test the getTargetToken() method.
- *
- * @dataProvider dataGetTargetToken
- *
- * @param int|false $expected Expected function output.
- * @param string $commentString The delimiter comment to look for.
- * @param int|string|array $tokenType The type of token(s) to look for.
- * @param string $tokenContent Optional. The token content for the target token.
- *
- * @return void
- */
- public function testGetTargetToken($expected, $commentString, $tokenType, $tokenContent = null)
- {
- if (isset($tokenContent)) {
- $result = $this->getTargetToken($commentString, $tokenType, $tokenContent);
- } else {
- $result = $this->getTargetToken($commentString, $tokenType);
- }
-
- $this->assertSame($expected, $result);
- }
-
- /**
- * Data provider.
- *
- * @see testGetTargetToken() For the array format.
- *
- * @return array
- */
- public function dataGetTargetToken()
- {
- return [
- 'single-token-type' => [
- 6,
- '/* testFindingTarget */',
- \T_VARIABLE,
- ],
- 'multi-token-type-1' => [
- 6,
- '/* testFindingTarget */',
- [\T_VARIABLE, \T_FALSE],
- ],
- 'multi-token-type-2' => [
- 11,
- '/* testFindingTarget */',
- [\T_FALSE, \T_LNUMBER],
- ],
- 'content-method' => [
- 23,
- '/* testFindingTargetWithContent */',
- \T_STRING,
- 'method',
- ],
- 'content-otherMethod' => [
- 33,
- '/* testFindingTargetWithContent */',
- \T_STRING,
- 'otherMethod',
- ],
- 'content-$a' => [
- 21,
- '/* testFindingTargetWithContent */',
- \T_VARIABLE,
- '$a',
- ],
- 'content-$b' => [
- 31,
- '/* testFindingTargetWithContent */',
- \T_VARIABLE,
- '$b',
- ],
- 'content-foo' => [
- 26,
- '/* testFindingTargetWithContent */',
- [\T_CONSTANT_ENCAPSED_STRING, \T_DOUBLE_QUOTED_STRING],
- "'foo'",
- ],
- 'content-bar' => [
- 36,
- '/* testFindingTargetWithContent */',
- [\T_CONSTANT_ENCAPSED_STRING, \T_DOUBLE_QUOTED_STRING],
- "'bar'",
- ],
- ];
- }
-
- /**
- * Test the behaviour of the getTargetToken() method when the target is not found.
- *
- * @return void
- */
- public function testGetTargetTokenNotFound()
- {
- $msg = 'Failed to find test target token for comment string: ';
- $exception = 'PHPUnit\Framework\AssertionFailedError';
- if (\class_exists('PHPUnit_Framework_AssertionFailedError')) {
- // PHPUnit < 6.
- $exception = 'PHPUnit_Framework_AssertionFailedError';
- }
-
- if (\method_exists($this, 'expectException')) {
- // PHPUnit 5+.
- $this->expectException($exception);
- $this->expectExceptionMessage($msg);
- } else {
- // PHPUnit 4.
- $this->setExpectedException($exception, $msg);
- }
-
- $this->getTargetToken('/* testNotFindingTarget */', [\T_VARIABLE], '$a');
- }
-
- /**
- * Test that the helper method to handle cross-version testing of exceptions in PHPUnit
- * works correctly.
- *
- * @return void
- */
- public function testExpectPhpcsRuntimeException()
- {
- $this->expectPhpcsException('testing-1-2-3');
- throw new RuntimeException('testing-1-2-3');
- }
-
- /**
- * Test that the helper method to handle cross-version testing of exceptions in PHPUnit
- * works correctly.
- *
- * @return void
- */
- public function testExpectPhpcsTokenizerException()
- {
- $this->expectPhpcsException('testing-1-2-3', 'tokenizer');
- throw new TokenizerException('testing-1-2-3');
+ $this->assertIsArray($tokens);
}
/**
* Test that the class is correct reset.
*
+ * @depends testSetUp
+ *
* @return void
*/
public function testTearDown()
{
parent::resetTestFile();
- $this->assertNull(self::$phpcsFile);
+ $this->assertSame('0', self::$phpcsVersion, 'phpcsVersion was not reset');
+ $this->assertSame('inc', self::$fileExtension, 'fileExtension was not reset');
+ $this->assertSame('', self::$caseFile, 'caseFile was not reset');
+ $this->assertSame(4, self::$tabWidth, 'tabWidth was not reset');
+ $this->assertNull(self::$phpcsFile, 'phpcsFile was not reset');
+ $this->assertSame(['Dummy.Dummy.Dummy'], self::$selectedSniff, 'selectedSniff was not reset');
}
}
diff --git a/Tests/Tokens/Collections/AlternativeControlStructureSyntaxClosersTest.php b/Tests/Tokens/Collections/AlternativeControlStructureSyntaxClosersTest.php
new file mode 100644
index 00000000..6b6fec78
--- /dev/null
+++ b/Tests/Tokens/Collections/AlternativeControlStructureSyntaxClosersTest.php
@@ -0,0 +1,40 @@
+assertSame(
+ Collections::$alternativeControlStructureSyntaxCloserTokens,
+ Collections::alternativeControlStructureSyntaxClosers()
+ );
+ }
+}
diff --git a/Tests/Tokens/Collections/AlternativeControlStructureSyntaxesTest.php b/Tests/Tokens/Collections/AlternativeControlStructureSyntaxesTest.php
new file mode 100644
index 00000000..af3b3707
--- /dev/null
+++ b/Tests/Tokens/Collections/AlternativeControlStructureSyntaxesTest.php
@@ -0,0 +1,40 @@
+assertSame(
+ Collections::$alternativeControlStructureSyntaxTokens,
+ Collections::alternativeControlStructureSyntaxes()
+ );
+ }
+}
diff --git a/Tests/Tokens/Collections/ArrowFunctionTokensBCTest.php b/Tests/Tokens/Collections/ArrowFunctionTokensBCTest.php
index 2d45f09c..f7b205ad 100644
--- a/Tests/Tokens/Collections/ArrowFunctionTokensBCTest.php
+++ b/Tests/Tokens/Collections/ArrowFunctionTokensBCTest.php
@@ -10,20 +10,20 @@
namespace PHPCSUtils\Tests\Tokens\Collections;
-use PHPCSUtils\BackCompat\Helper;
use PHPCSUtils\Tokens\Collections;
-use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
/**
* Test class.
*
* @covers \PHPCSUtils\Tokens\Collections::arrowFunctionTokensBC
+ * @covers \PHPCSUtils\Tokens\Collections::triggerDeprecation
*
* @group collections
*
* @since 1.0.0
*/
-class ArrowFunctionTokensBCTest extends TestCase
+final class ArrowFunctionTokensBCTest extends TestCase
{
/**
@@ -33,17 +33,16 @@ class ArrowFunctionTokensBCTest extends TestCase
*/
public function testArrowFunctionTokensBC()
{
- $version = Helper::getVersion();
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'Collections::arrowFunctionTokensBC() method is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the `T_FN` token instead.'
+ );
+
$expected = [
- \T_STRING => \T_STRING,
+ \T_FN => \T_FN,
];
- if (\version_compare($version, '3.5.3', '>=') === true
- || \version_compare(\PHP_VERSION_ID, '70399', '>=') === true
- ) {
- $expected[\T_FN] = \T_FN;
- }
-
$this->assertSame($expected, Collections::arrowFunctionTokensBC());
}
}
diff --git a/Tests/Tokens/Collections/FunctionCallTokensTest.php b/Tests/Tokens/Collections/FunctionCallTokensTest.php
new file mode 100644
index 00000000..2c7b0fb3
--- /dev/null
+++ b/Tests/Tokens/Collections/FunctionCallTokensTest.php
@@ -0,0 +1,49 @@
+ \T_STRING,
+ \T_NAME_QUALIFIED => \T_NAME_QUALIFIED,
+ \T_NAME_FULLY_QUALIFIED => \T_NAME_FULLY_QUALIFIED,
+ \T_NAME_RELATIVE => \T_NAME_RELATIVE,
+ \T_VARIABLE => \T_VARIABLE,
+ \T_ANON_CLASS => \T_ANON_CLASS,
+ \T_PARENT => \T_PARENT,
+ \T_SELF => \T_SELF,
+ \T_STATIC => \T_STATIC,
+ ];
+
+ $this->assertSame($expected, Collections::functionCallTokens());
+ }
+}
diff --git a/Tests/Tokens/Collections/FunctionDeclarationTokensBCTest.php b/Tests/Tokens/Collections/FunctionDeclarationTokensBCTest.php
index 4a40ecfc..067a2ac4 100644
--- a/Tests/Tokens/Collections/FunctionDeclarationTokensBCTest.php
+++ b/Tests/Tokens/Collections/FunctionDeclarationTokensBCTest.php
@@ -10,20 +10,20 @@
namespace PHPCSUtils\Tests\Tokens\Collections;
-use PHPCSUtils\BackCompat\Helper;
use PHPCSUtils\Tokens\Collections;
-use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
/**
* Test class.
*
* @covers \PHPCSUtils\Tokens\Collections::functionDeclarationTokensBC
+ * @covers \PHPCSUtils\Tokens\Collections::triggerDeprecation
*
* @group collections
*
* @since 1.0.0
*/
-class FunctionDeclarationTokensBCTest extends TestCase
+final class FunctionDeclarationTokensBCTest extends TestCase
{
/**
@@ -33,19 +33,18 @@ class FunctionDeclarationTokensBCTest extends TestCase
*/
public function testFunctionDeclarationTokensBC()
{
- $version = Helper::getVersion();
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'Collections::functionDeclarationTokensBC() method is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the PHPCSUtils\Tokens\Collections::functionDeclarationTokens() method instead.'
+ );
+
$expected = [
\T_FUNCTION => \T_FUNCTION,
\T_CLOSURE => \T_CLOSURE,
- \T_STRING => \T_STRING,
+ \T_FN => \T_FN,
];
- if (\version_compare($version, '3.5.3', '>=') === true
- || \version_compare(\PHP_VERSION_ID, '70399', '>=') === true
- ) {
- $expected[\T_FN] = \T_FN;
- }
-
$this->assertSame($expected, Collections::functionDeclarationTokensBC());
}
}
diff --git a/Tests/Tokens/Collections/FunctionDeclarationTokensTest.php b/Tests/Tokens/Collections/FunctionDeclarationTokensTest.php
deleted file mode 100644
index e5e2c3cd..00000000
--- a/Tests/Tokens/Collections/FunctionDeclarationTokensTest.php
+++ /dev/null
@@ -1,50 +0,0 @@
- \T_FUNCTION,
- \T_CLOSURE => \T_CLOSURE,
- ];
-
- if (\version_compare($version, '3.5.3', '>=') === true
- || \version_compare(\PHP_VERSION_ID, '70399', '>=') === true
- ) {
- $expected[\T_FN] = \T_FN;
- }
-
- $this->assertSame($expected, Collections::functionDeclarationTokens());
- }
-}
diff --git a/Tests/Tokens/Collections/NamespacedNameTokensTest.php b/Tests/Tokens/Collections/NamespacedNameTokensTest.php
new file mode 100644
index 00000000..9fb3d4c1
--- /dev/null
+++ b/Tests/Tokens/Collections/NamespacedNameTokensTest.php
@@ -0,0 +1,46 @@
+ \T_NS_SEPARATOR,
+ \T_NAMESPACE => \T_NAMESPACE,
+ \T_STRING => \T_STRING,
+ \T_NAME_QUALIFIED => \T_NAME_QUALIFIED,
+ \T_NAME_FULLY_QUALIFIED => \T_NAME_FULLY_QUALIFIED,
+ \T_NAME_RELATIVE => \T_NAME_RELATIVE,
+ ];
+
+ $this->assertSame($expected, Collections::namespacedNameTokens());
+ }
+}
diff --git a/Tests/Tokens/Collections/OoCanExtendTest.php b/Tests/Tokens/Collections/OoCanExtendTest.php
new file mode 100644
index 00000000..17d8e842
--- /dev/null
+++ b/Tests/Tokens/Collections/OoCanExtendTest.php
@@ -0,0 +1,37 @@
+assertSame(Collections::$OOCanExtend, Collections::ooCanExtend());
+ }
+}
diff --git a/Tests/Tokens/Collections/OoCanImplementTest.php b/Tests/Tokens/Collections/OoCanImplementTest.php
new file mode 100644
index 00000000..cdbd7178
--- /dev/null
+++ b/Tests/Tokens/Collections/OoCanImplementTest.php
@@ -0,0 +1,37 @@
+assertSame(Collections::$OOCanImplement, Collections::ooCanImplement());
+ }
+}
diff --git a/Tests/Tokens/Collections/OoConstantScopesTest.php b/Tests/Tokens/Collections/OoConstantScopesTest.php
new file mode 100644
index 00000000..e0f7a605
--- /dev/null
+++ b/Tests/Tokens/Collections/OoConstantScopesTest.php
@@ -0,0 +1,37 @@
+assertSame(Collections::$OOConstantScopes, Collections::ooConstantScopes());
+ }
+}
diff --git a/Tests/Tokens/Collections/OoHierarchyKeywordsTest.php b/Tests/Tokens/Collections/OoHierarchyKeywordsTest.php
new file mode 100644
index 00000000..52e3a689
--- /dev/null
+++ b/Tests/Tokens/Collections/OoHierarchyKeywordsTest.php
@@ -0,0 +1,37 @@
+assertSame(Collections::$OOHierarchyKeywords, Collections::ooHierarchyKeywords());
+ }
+}
diff --git a/Tests/Tokens/Collections/OoPropertyScopesTest.php b/Tests/Tokens/Collections/OoPropertyScopesTest.php
new file mode 100644
index 00000000..957479fd
--- /dev/null
+++ b/Tests/Tokens/Collections/OoPropertyScopesTest.php
@@ -0,0 +1,37 @@
+assertSame(Collections::$OOPropertyScopes, Collections::ooPropertyScopes());
+ }
+}
diff --git a/Tests/Tokens/Collections/ParameterPassingTokensTest.php b/Tests/Tokens/Collections/ParameterPassingTokensTest.php
new file mode 100644
index 00000000..db07e640
--- /dev/null
+++ b/Tests/Tokens/Collections/ParameterPassingTokensTest.php
@@ -0,0 +1,54 @@
+ \T_STRING,
+ \T_NAME_QUALIFIED => \T_NAME_QUALIFIED,
+ \T_NAME_FULLY_QUALIFIED => \T_NAME_FULLY_QUALIFIED,
+ \T_NAME_RELATIVE => \T_NAME_RELATIVE,
+ \T_VARIABLE => \T_VARIABLE,
+ \T_ANON_CLASS => \T_ANON_CLASS,
+ \T_PARENT => \T_PARENT,
+ \T_SELF => \T_SELF,
+ \T_STATIC => \T_STATIC,
+ \T_ISSET => \T_ISSET,
+ \T_UNSET => \T_UNSET,
+ \T_ARRAY => \T_ARRAY,
+ \T_OPEN_SHORT_ARRAY => \T_OPEN_SHORT_ARRAY,
+ \T_OPEN_SQUARE_BRACKET => \T_OPEN_SQUARE_BRACKET,
+ ];
+
+ $this->assertSame($expected, Collections::parameterPassingTokens());
+ }
+}
diff --git a/Tests/Tokens/Collections/ParameterTypeTokensBCTest.php b/Tests/Tokens/Collections/ParameterTypeTokensBCTest.php
index 0fcb7cf1..abab2b11 100644
--- a/Tests/Tokens/Collections/ParameterTypeTokensBCTest.php
+++ b/Tests/Tokens/Collections/ParameterTypeTokensBCTest.php
@@ -10,20 +10,20 @@
namespace PHPCSUtils\Tests\Tokens\Collections;
-use PHPCSUtils\BackCompat\Helper;
use PHPCSUtils\Tokens\Collections;
-use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
/**
* Test class.
*
* @covers \PHPCSUtils\Tokens\Collections::parameterTypeTokensBC
+ * @covers \PHPCSUtils\Tokens\Collections::triggerDeprecation
*
* @group collections
*
* @since 1.0.0
*/
-class ParameterTypeTokensBCTest extends TestCase
+final class ParameterTypeTokensBCTest extends TestCase
{
/**
@@ -33,13 +33,12 @@ class ParameterTypeTokensBCTest extends TestCase
*/
public function testParameterTypeTokensBC()
{
- $version = Helper::getVersion();
- $expected = Collections::$parameterTypeTokens;
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'Collections::parameterTypeTokensBC() method is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the PHPCSUtils\Tokens\Collections::parameterTypeTokens() method instead.'
+ );
- if (\version_compare($version, '3.99.99', '<=') === true) {
- $expected[\T_ARRAY_HINT] = \T_ARRAY_HINT;
- }
-
- $this->assertSame($expected, Collections::parameterTypeTokensBC());
+ $this->assertSame(Collections::parameterTypeTokens(), Collections::parameterTypeTokensBC());
}
}
diff --git a/Tests/Tokens/Collections/ParameterTypeTokensTest.php b/Tests/Tokens/Collections/ParameterTypeTokensTest.php
new file mode 100644
index 00000000..bf62dbfe
--- /dev/null
+++ b/Tests/Tokens/Collections/ParameterTypeTokensTest.php
@@ -0,0 +1,54 @@
+ \T_CALLABLE,
+ \T_SELF => \T_SELF,
+ \T_PARENT => \T_PARENT,
+ \T_FALSE => \T_FALSE,
+ \T_TRUE => \T_TRUE,
+ \T_NULL => \T_NULL,
+ \T_STRING => \T_STRING,
+ \T_NS_SEPARATOR => \T_NS_SEPARATOR,
+ \T_TYPE_UNION => \T_TYPE_UNION,
+ \T_TYPE_INTERSECTION => \T_TYPE_INTERSECTION,
+ \T_NAMESPACE => \T_NAMESPACE,
+ \T_NAME_QUALIFIED => \T_NAME_QUALIFIED,
+ \T_NAME_FULLY_QUALIFIED => \T_NAME_FULLY_QUALIFIED,
+ \T_NAME_RELATIVE => \T_NAME_RELATIVE,
+ ];
+
+ $this->assertSame($expected, Collections::parameterTypeTokens());
+ }
+}
diff --git a/Tests/Tokens/Collections/PropertyBasedTokenArraysTest.php b/Tests/Tokens/Collections/PropertyBasedTokenArraysTest.php
new file mode 100644
index 00000000..d71354ce
--- /dev/null
+++ b/Tests/Tokens/Collections/PropertyBasedTokenArraysTest.php
@@ -0,0 +1,105 @@
+setAccessible(true);
+ $expected = $reflProp->getValue();
+ $reflProp->setAccessible(false);
+
+ $this->assertSame($expected, Collections::$name());
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testPropertyBasedTokenArrays() For the array format.
+ *
+ * @return array
+ */
+ public function dataPropertyBasedTokenArrays()
+ {
+ $names = [
+ 'arrayOpenTokensBC',
+ 'arrayTokens',
+ 'arrayTokensBC',
+ 'classModifierKeywords',
+ 'closedScopes',
+ 'controlStructureTokens',
+ 'functionDeclarationTokens',
+ 'incrementDecrementOperators',
+ 'listTokens',
+ 'listTokensBC',
+ 'namespaceDeclarationClosers',
+ 'nameTokens',
+ 'objectOperators',
+ 'phpOpenTags',
+ 'propertyModifierKeywords',
+ 'shortArrayListOpenTokensBC',
+ 'shortArrayTokens',
+ 'shortArrayTokensBC',
+ 'shortListTokens',
+ 'shortListTokensBC',
+ ];
+
+ $data = [];
+ foreach ($names as $name) {
+ $data[$name] = [$name];
+ }
+
+ return $data;
+ }
+
+ /**
+ * Test calling a token property method for a token array which doesn't exist.
+ *
+ * @return void
+ */
+ public function testUndeclaredTokenArray()
+ {
+ $this->expectException('PHPCSUtils\Exceptions\InvalidTokenArray');
+ $this->expectExceptionMessage('Call to undefined method PHPCSUtils\Tokens\Collections::notATokenArray()');
+
+ Collections::notATokenArray();
+ }
+}
diff --git a/Tests/Tokens/Collections/PropertyTypeTokensBCTest.php b/Tests/Tokens/Collections/PropertyTypeTokensBCTest.php
index b743eaad..ff492c35 100644
--- a/Tests/Tokens/Collections/PropertyTypeTokensBCTest.php
+++ b/Tests/Tokens/Collections/PropertyTypeTokensBCTest.php
@@ -10,20 +10,20 @@
namespace PHPCSUtils\Tests\Tokens\Collections;
-use PHPCSUtils\BackCompat\Helper;
use PHPCSUtils\Tokens\Collections;
-use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
/**
* Test class.
*
* @covers \PHPCSUtils\Tokens\Collections::propertyTypeTokensBC
+ * @covers \PHPCSUtils\Tokens\Collections::triggerDeprecation
*
* @group collections
*
* @since 1.0.0
*/
-class PropertyTypeTokensBCTest extends TestCase
+final class PropertyTypeTokensBCTest extends TestCase
{
/**
@@ -33,13 +33,12 @@ class PropertyTypeTokensBCTest extends TestCase
*/
public function testPropertyTypeTokensBC()
{
- $version = Helper::getVersion();
- $expected = Collections::$propertyTypeTokens;
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'Collections::propertyTypeTokensBC() method is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the PHPCSUtils\Tokens\Collections::propertyTypeTokens() method instead.'
+ );
- if (\version_compare($version, '3.99.99', '<=') === true) {
- $expected[\T_ARRAY_HINT] = \T_ARRAY_HINT;
- }
-
- $this->assertSame($expected, Collections::propertyTypeTokensBC());
+ $this->assertSame(Collections::propertyTypeTokens(), Collections::propertyTypeTokensBC());
}
}
diff --git a/Tests/Tokens/Collections/PropertyTypeTokensTest.php b/Tests/Tokens/Collections/PropertyTypeTokensTest.php
new file mode 100644
index 00000000..0f8e2b17
--- /dev/null
+++ b/Tests/Tokens/Collections/PropertyTypeTokensTest.php
@@ -0,0 +1,54 @@
+ \T_CALLABLE,
+ \T_SELF => \T_SELF,
+ \T_PARENT => \T_PARENT,
+ \T_FALSE => \T_FALSE,
+ \T_TRUE => \T_TRUE,
+ \T_NULL => \T_NULL,
+ \T_STRING => \T_STRING,
+ \T_NS_SEPARATOR => \T_NS_SEPARATOR,
+ \T_TYPE_UNION => \T_TYPE_UNION,
+ \T_TYPE_INTERSECTION => \T_TYPE_INTERSECTION,
+ \T_NAMESPACE => \T_NAMESPACE,
+ \T_NAME_QUALIFIED => \T_NAME_QUALIFIED,
+ \T_NAME_FULLY_QUALIFIED => \T_NAME_FULLY_QUALIFIED,
+ \T_NAME_RELATIVE => \T_NAME_RELATIVE,
+ ];
+
+ $this->assertSame($expected, Collections::propertyTypeTokens());
+ }
+}
diff --git a/Tests/Tokens/Collections/ReturnTypeTokensBCTest.php b/Tests/Tokens/Collections/ReturnTypeTokensBCTest.php
index 347ca673..a3b6b9d9 100644
--- a/Tests/Tokens/Collections/ReturnTypeTokensBCTest.php
+++ b/Tests/Tokens/Collections/ReturnTypeTokensBCTest.php
@@ -10,20 +10,20 @@
namespace PHPCSUtils\Tests\Tokens\Collections;
-use PHPCSUtils\BackCompat\Helper;
use PHPCSUtils\Tokens\Collections;
-use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
/**
* Test class.
*
* @covers \PHPCSUtils\Tokens\Collections::returnTypeTokensBC
+ * @covers \PHPCSUtils\Tokens\Collections::triggerDeprecation
*
* @group collections
*
* @since 1.0.0
*/
-class ReturnTypeTokensBCTest extends TestCase
+final class ReturnTypeTokensBCTest extends TestCase
{
/**
@@ -33,18 +33,12 @@ class ReturnTypeTokensBCTest extends TestCase
*/
public function testReturnTypeTokensBC()
{
- $version = Helper::getVersion();
- $expected = Collections::$returnTypeTokens;
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'Collections::returnTypeTokensBC() method is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the PHPCSUtils\Tokens\Collections::returnTypeTokens() method instead.'
+ );
- if (\version_compare($version, '3.99.99', '<=') === true) {
- $expected[\T_RETURN_TYPE] = \T_RETURN_TYPE;
- $expected[\T_ARRAY_HINT] = \T_ARRAY_HINT;
- }
-
- if (\version_compare($version, '3.5.3', '<=') === true) {
- $expected[\T_ARRAY] = \T_ARRAY;
- }
-
- $this->assertSame($expected, Collections::returnTypeTokensBC());
+ $this->assertSame(Collections::returnTypeTokens(), Collections::returnTypeTokensBC());
}
}
diff --git a/Tests/Tokens/Collections/ReturnTypeTokensTest.php b/Tests/Tokens/Collections/ReturnTypeTokensTest.php
new file mode 100644
index 00000000..513a8f1d
--- /dev/null
+++ b/Tests/Tokens/Collections/ReturnTypeTokensTest.php
@@ -0,0 +1,55 @@
+ \T_CALLABLE,
+ \T_SELF => \T_SELF,
+ \T_PARENT => \T_PARENT,
+ \T_STATIC => \T_STATIC,
+ \T_FALSE => \T_FALSE,
+ \T_TRUE => \T_TRUE,
+ \T_NULL => \T_NULL,
+ \T_STRING => \T_STRING,
+ \T_NS_SEPARATOR => \T_NS_SEPARATOR,
+ \T_TYPE_UNION => \T_TYPE_UNION,
+ \T_TYPE_INTERSECTION => \T_TYPE_INTERSECTION,
+ \T_NAMESPACE => \T_NAMESPACE,
+ \T_NAME_QUALIFIED => \T_NAME_QUALIFIED,
+ \T_NAME_FULLY_QUALIFIED => \T_NAME_FULLY_QUALIFIED,
+ \T_NAME_RELATIVE => \T_NAME_RELATIVE,
+ ];
+
+ $this->assertSame($expected, Collections::returnTypeTokens());
+ }
+}
diff --git a/Tests/Tokens/Collections/TextStringStartTokensTest.php b/Tests/Tokens/Collections/TextStringStartTokensTest.php
new file mode 100644
index 00000000..89b89b9b
--- /dev/null
+++ b/Tests/Tokens/Collections/TextStringStartTokensTest.php
@@ -0,0 +1,37 @@
+assertSame(Collections::$textStingStartTokens, Collections::textStringStartTokens());
+ }
+}
diff --git a/Tests/Tokens/TokenHelper/TokenExistsTest.php b/Tests/Tokens/TokenHelper/TokenExistsTest.php
new file mode 100644
index 00000000..96f23266
--- /dev/null
+++ b/Tests/Tokens/TokenHelper/TokenExistsTest.php
@@ -0,0 +1,86 @@
+assertSame($expected, TokenHelper::tokenExists($name));
+ }
+
+ /**
+ * Data provider.
+ *
+ * {@internal This dataprovider does not currently contain any tests for
+ * PHP native tokens which may not exist (depending on the PHPCS version).
+ * These tests are not relevant at this time with the current minimum
+ * PHPCS version of 3.7.1, but this may change again in the future.}
+ *
+ * @return array
+ */
+ public function dataTokenExists()
+ {
+ return [
+ 'Token which doesn\'t exist either way' => [
+ 'name' => 'T_DOESNOTEXIST',
+ 'expected' => false,
+ ],
+ 'PHP native token which always exists' => [
+ 'name' => 'T_FUNCTION',
+ 'expected' => true,
+ ],
+ 'PHPCS native token which always exists (in the PHPCS versions supported)' => [
+ 'name' => 'T_CLOSURE',
+ 'expected' => true,
+ ],
+ 'Mocked polyfilled token' => [
+ 'name' => 'T_FAKETOKEN',
+ 'expected' => false,
+ ],
+ ];
+ }
+}
diff --git a/Tests/TypeProviderHelper.php b/Tests/TypeProviderHelper.php
new file mode 100644
index 00000000..ca2ae22e
--- /dev/null
+++ b/Tests/TypeProviderHelper.php
@@ -0,0 +1,92 @@
+>
+ */
+ public static function getAll()
+ {
+ return [
+ 'null' => [
+ 'input' => null,
+ ],
+ 'boolean false' => [
+ 'input' => false,
+ ],
+ 'boolean true' => [
+ 'input' => true,
+ ],
+ 'integer 0' => [
+ 'input' => 0,
+ ],
+ 'negative integer' => [
+ 'input' => -123,
+ ],
+ 'positive integer' => [
+ 'input' => 786687,
+ ],
+ 'float 0.0' => [
+ 'input' => 0.0,
+ ],
+ 'negative float' => [
+ 'input' => 5.600e-3,
+ ],
+ 'positive float' => [
+ 'input' => 124.7,
+ ],
+ 'empty string' => [
+ 'input' => '',
+ ],
+ 'numeric string' => [
+ 'input' => '123',
+ ],
+ 'textual string' => [
+ 'input' => 'foobar',
+ ],
+ 'textual string starting with numbers' => [
+ 'input' => '123 My Street',
+ ],
+ 'empty array' => [
+ 'input' => [],
+ ],
+ 'array with values, no keys' => [
+ 'input' => [1, 2, 3],
+ ],
+ 'array with values, string keys' => [
+ 'input' => ['a' => 1, 'b' => 2],
+ ],
+ 'plain object' => [
+ 'input' => new stdClass(),
+ ],
+ 'ArrayIterator object' => [
+ 'input' => new ArrayIterator([1, 2, 3]),
+ ],
+ 'Iterator object, no array access' => [
+ 'input' => new EmptyIterator(),
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/Arrays/GetDoubleArrowPtrTest.inc b/Tests/Utils/Arrays/GetDoubleArrowPtrTest.inc
index 0d1b31d4..c0e6a866 100644
--- a/Tests/Utils/Arrays/GetDoubleArrowPtrTest.inc
+++ b/Tests/Utils/Arrays/GetDoubleArrowPtrTest.inc
@@ -67,10 +67,10 @@ $array = [
},
/* testNoArrowValueClosureYieldWithKey */
- function() { yield 'k' => $x },
+ function() { yield 'k' => $x; },
/* testArrowKeyClosureYieldWithKey */
- function() { yield 'k' => $x }() => 'value',
+ function() { yield 'k' => $x; }() => 'value',
/* testFnFunctionWithKey */
'fn' => fn ($x) => yield 'k' => $x,
@@ -87,6 +87,30 @@ $array = [
/* testDoubleArrowTokenizedAsTstring-PHPCS2865 */
$obj->fn => 'value',
+ /* testNoArrowValueMatchExpr */
+ match($a) {
+ FOO => BAR,
+ default => [0 => BAZ],
+ },
+
+ /* testArrowValueMatchExpr */
+ 'key' => match($a) {
+ [0 => 10] => BAR,
+ default => BAZ,
+ },
+
+ /* testArrowKeyMatchExpr */
+ match($a) {
+ FOO => BAR,
+ default => [0 => 10],
+ } => 'value',
+
+ /* testNoArrowValueClosureWithAttribute */
+ #[MyAttribute([0 => 'value'])] function() { /* do something */ }(),
+
+ /* testArrowKeyClosureWithAttribute */
+ #[MyAttribute([0 => 'value'])] function() { /* do something */ }() => 'value',
+
/* testEmptyArrayItem */
// Intentional parse error.
,
diff --git a/Tests/Utils/Arrays/GetDoubleArrowPtrTest.php b/Tests/Utils/Arrays/GetDoubleArrowPtrTest.php
index c1f44113..8ff7fa75 100644
--- a/Tests/Utils/Arrays/GetDoubleArrowPtrTest.php
+++ b/Tests/Utils/Arrays/GetDoubleArrowPtrTest.php
@@ -10,6 +10,7 @@
namespace PHPCSUtils\Tests\Utils\Arrays;
+use PHPCSUtils\Internal\Cache;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
use PHPCSUtils\Utils\Arrays;
use PHPCSUtils\Utils\PassedParameters;
@@ -23,7 +24,7 @@
*
* @since 1.0.0
*/
-class GetDoubleArrowPtrTest extends UtilityMethodTestCase
+final class GetDoubleArrowPtrTest extends UtilityMethodTestCase
{
/**
@@ -49,7 +50,7 @@ protected function setUpCache()
$target = $this->getTargetToken('/* testGetDoubleArrowPtr */', [\T_OPEN_SHORT_ARRAY]);
$parameters = PassedParameters::getParameters(self::$phpcsFile, $target);
- foreach ($parameters as $index => $values) {
+ foreach ($parameters as $values) {
\preg_match('`^(/\* test[^*]+ \*/)`', $values['raw'], $matches);
if (empty($matches[1]) === false) {
self::$parameters[$matches[1]] = $values;
@@ -141,86 +142,154 @@ public function dataGetDoubleArrowPtr()
{
return [
'test-no-arrow' => [
- '/* testValueNoArrow */',
- false,
+ 'testMarker' => '/* testValueNoArrow */',
+ 'expected' => false,
],
'test-arrow-numeric-index' => [
- '/* testArrowNumericIndex */',
- 8,
+ 'testMarker' => '/* testArrowNumericIndex */',
+ 'expected' => 8,
],
'test-arrow-string-index' => [
- '/* testArrowStringIndex */',
- 8,
+ 'testMarker' => '/* testArrowStringIndex */',
+ 'expected' => 8,
],
'test-arrow-multi-token-index' => [
- '/* testArrowMultiTokenIndex */',
- 12,
+ 'testMarker' => '/* testArrowMultiTokenIndex */',
+ 'expected' => 12,
],
'test-no-arrow-value-short-array' => [
- '/* testNoArrowValueShortArray */',
- false,
+ 'testMarker' => '/* testNoArrowValueShortArray */',
+ 'expected' => false,
],
'test-no-arrow-value-long-array' => [
- '/* testNoArrowValueLongArray */',
- false,
+ 'testMarker' => '/* testNoArrowValueLongArray */',
+ 'expected' => false,
],
'test-no-arrow-value-nested-arrays' => [
- '/* testNoArrowValueNestedArrays */',
- false,
+ 'testMarker' => '/* testNoArrowValueNestedArrays */',
+ 'expected' => false,
],
'test-no-arrow-value-closure' => [
- '/* testNoArrowValueClosure */',
- false,
+ 'testMarker' => '/* testNoArrowValueClosure */',
+ 'expected' => false,
],
'test-arrow-value-short-array' => [
- '/* testArrowValueShortArray */',
- 8,
+ 'testMarker' => '/* testArrowValueShortArray */',
+ 'expected' => 8,
],
'test-arrow-value-long-array' => [
- '/* testArrowValueLongArray */',
- 8,
+ 'testMarker' => '/* testArrowValueLongArray */',
+ 'expected' => 8,
],
'test-arrow-value-closure' => [
- '/* testArrowValueClosure */',
- 8,
+ 'testMarker' => '/* testArrowValueClosure */',
+ 'expected' => 8,
],
'test-no-arrow-value-anon-class-with-foreach' => [
- '/* testNoArrowValueAnonClassForeach */',
- false,
+ 'testMarker' => '/* testNoArrowValueAnonClassForeach */',
+ 'expected' => false,
],
'test-no-arrow-value-closure-with-keyed-yield' => [
- '/* testNoArrowValueClosureYieldWithKey */',
- false,
+ 'testMarker' => '/* testNoArrowValueClosureYieldWithKey */',
+ 'expected' => false,
],
'test-arrow-key-closure-with-keyed-yield' => [
- '/* testArrowKeyClosureYieldWithKey */',
- 24,
+ 'testMarker' => '/* testArrowKeyClosureYieldWithKey */',
+ 'expected' => 25,
],
'test-arrow-value-fn-function' => [
- '/* testFnFunctionWithKey */',
- 8,
+ 'testMarker' => '/* testFnFunctionWithKey */',
+ 'expected' => 8,
],
'test-no-arrow-value-fn-function' => [
- '/* testNoArrowValueFnFunction */',
- false,
+ 'testMarker' => '/* testNoArrowValueFnFunction */',
+ 'expected' => false,
],
'test-arrow-tstring-key-not-fn-function' => [
- '/* testTstringKeyNotFnFunction */',
- 8,
+ 'testMarker' => '/* testTstringKeyNotFnFunction */',
+ 'expected' => 8,
],
// Test specifically for PHPCS 3.5.3 and 3.5.4 in which all "fn" tokens were tokenized as T_FN.
+ // While PHPCS < 3.7.1 is no longer supported, the test remains to safeguard against tokenizer regressions.
'test-arrow-access-to-property-named-fn-as-key-phpcs-3.5.3-3.5.4' => [
- '/* testKeyPropertyAccessFnPHPCS353-354 */',
- 12,
+ 'testMarker' => '/* testKeyPropertyAccessFnPHPCS353-354 */',
+ 'expected' => 12,
],
'test-double-arrow-incorrectly-tokenized-phpcs-issue-2865' => [
- '/* testDoubleArrowTokenizedAsTstring-PHPCS2865 */',
- 10,
+ 'testMarker' => '/* testDoubleArrowTokenizedAsTstring-PHPCS2865 */',
+ 'expected' => 10,
],
+
+ // Safeguard that PHP 8.0 match expressions are handled correctly.
+ 'test-no-arrow-value-match-expression' => [
+ 'testMarker' => '/* testNoArrowValueMatchExpr */',
+ 'expected' => false,
+ ],
+ 'test-double-arrow-value-match-expression' => [
+ 'testMarker' => '/* testArrowValueMatchExpr */',
+ 'expected' => 8,
+ ],
+ 'test-double-arrow-key-match-expression' => [
+ 'testMarker' => '/* testArrowKeyMatchExpr */',
+ 'expected' => 38,
+ ],
+
+ // Safeguard that double arrows in PHP 8.0 attributes are disregarded.
+ 'test-no-arrow-value-closure-with-attached-attribute-containing-arrow' => [
+ 'testMarker' => '/* testNoArrowValueClosureWithAttribute */',
+ 'expected' => false,
+ ],
+ 'test-double-arrow-key-closure-with-attached-attribute-containing-arrow' => [
+ 'testMarker' => '/* testArrowKeyClosureWithAttribute */',
+ 'expected' => 31,
+ ],
+
'test-empty-array-item' => [
- '/* testEmptyArrayItem */',
- false,
+ 'testMarker' => '/* testEmptyArrayItem */',
+ 'expected' => false,
],
];
}
+
+ /**
+ * Verify that the build-in caching is used when caching is enabled.
+ *
+ * @return void
+ */
+ public function testResultIsCached()
+ {
+ $methodName = 'PHPCSUtils\\Utils\\Arrays::getDoubleArrowPtr';
+ $cases = $this->dataGetDoubleArrowPtr();
+ $testMarker = $cases['test-arrow-value-short-array']['testMarker'];
+ $expected = $cases['test-arrow-value-short-array']['expected'];
+
+ if (isset(self::$parameters[$testMarker]) === false) {
+ $this->fail('Test case not found for ' . $testMarker);
+ }
+
+ $start = self::$parameters[$testMarker]['start'];
+ $end = self::$parameters[$testMarker]['end'];
+
+ // Change double arrow position from offset to exact position.
+ if ($expected !== false) {
+ $expected += $start;
+ }
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = Arrays::getDoubleArrowPtr(self::$phpcsFile, $start, $end);
+ $isCached = Cache::isCached(self::$phpcsFile, $methodName, "$start-$end");
+ $resultSecondRun = Arrays::getDoubleArrowPtr(self::$phpcsFile, $start, $end);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertSame($expected, $resultFirstRun, 'First result did not match expectation');
+ $this->assertTrue($isCached, 'Cache::isCached() could not find the cached value');
+ $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+ }
}
diff --git a/Tests/Utils/Arrays/GetOpenCloseTest.php b/Tests/Utils/Arrays/GetOpenCloseTest.php
index 99445bb2..456bbb55 100644
--- a/Tests/Utils/Arrays/GetOpenCloseTest.php
+++ b/Tests/Utils/Arrays/GetOpenCloseTest.php
@@ -11,6 +11,7 @@
namespace PHPCSUtils\Tests\Utils\Arrays;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
use PHPCSUtils\Utils\Arrays;
/**
@@ -22,7 +23,7 @@
*
* @since 1.0.0
*/
-class GetOpenCloseTest extends UtilityMethodTestCase
+final class GetOpenCloseTest extends UtilityMethodTestCase
{
/**
@@ -46,7 +47,7 @@ public function testNonExistentToken()
*/
public function testNotArrayToken($testMarker)
{
- $target = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+ $target = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
$this->assertFalse(Arrays::getOpenClose(self::$phpcsFile, $target));
}
@@ -103,49 +104,49 @@ public function dataGetOpenClose()
{
return [
'long-array' => [
- '/* testLongArray */',
- \T_ARRAY,
- [
+ 'testMarker' => '/* testLongArray */',
+ 'targetToken' => \T_ARRAY,
+ 'expected' => [
'opener' => 1,
'closer' => 14,
],
],
'long-array-nested' => [
- '/* testNestedLongArray */',
- \T_ARRAY,
- [
+ 'testMarker' => '/* testNestedLongArray */',
+ 'targetToken' => \T_ARRAY,
+ 'expected' => [
'opener' => 2,
'closer' => 6,
],
],
'short-array' => [
- '/* testShortArray */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testShortArray */',
+ 'targetToken' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
'opener' => 0,
'closer' => 9,
],
],
'short-array-nested' => [
- '/* testNestedShortArray */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testNestedShortArray */',
+ 'targetToken' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
'opener' => 0,
'closer' => 2,
],
],
'long-array-with-comments-and-annotations' => [
- '/* testArrayWithCommentsAndAnnotations */',
- \T_ARRAY,
- [
+ 'testMarker' => '/* testArrayWithCommentsAndAnnotations */',
+ 'targetToken' => \T_ARRAY,
+ 'expected' => [
'opener' => 4,
'closer' => 26,
],
],
'parse-error' => [
- '/* testParseError */',
- \T_ARRAY,
- false,
+ 'testMarker' => '/* testParseError */',
+ 'targetToken' => \T_ARRAY,
+ 'expected' => false,
],
];
}
diff --git a/Tests/Utils/Arrays/IsShortArrayTest.inc b/Tests/Utils/Arrays/IsShortArrayTest.inc
deleted file mode 100644
index f900264c..00000000
--- a/Tests/Utils/Arrays/IsShortArrayTest.inc
+++ /dev/null
@@ -1,68 +0,0 @@
- $x1, "y" => $y1],
- /* testNestedShortArrayWithKeys_2 */
- 1 => ["x" => $x2, "y" => $y2],
- /* testNestedShortArrayWithKeys_3 */
- 'key' => ["x" => $x3, "y" => $y3],
-];
-
-/* testNestedAnonClassWithTraitUseAs */
-// Parse error, but not our concern, it is short array syntax.
-array_map(function($a) {
- return new class() {
- use MyTrait {
- MyTrait::functionName as [];
- }
- };
-}, $array);
-
-/* testParseError */
-// Parse error, but not our concern, it is short array syntax.
-use Something as [$a];
-
-/* testLiveCoding */
-// This has to be the last test in the file.
-[$a, /* testLiveCodingNested */ [$b]
diff --git a/Tests/Utils/Arrays/IsShortArrayTest.php b/Tests/Utils/Arrays/IsShortArrayTest.php
deleted file mode 100644
index fb9b3041..00000000
--- a/Tests/Utils/Arrays/IsShortArrayTest.php
+++ /dev/null
@@ -1,199 +0,0 @@
-assertFalse(Arrays::isShortArray(self::$phpcsFile, 100000));
- }
-
- /**
- * Test that false is returned when a non-short array token is passed.
- *
- * @dataProvider dataNotShortArrayToken
- *
- * @param string $testMarker The comment which prefaces the target token in the test file.
- * @param int|string|array $targetToken The token type(s) to look for.
- *
- * @return void
- */
- public function testNotShortArrayToken($testMarker, $targetToken)
- {
- $target = $this->getTargetToken($testMarker, $targetToken);
- $this->assertFalse(Arrays::isShortArray(self::$phpcsFile, $target));
- }
-
- /**
- * Data provider.
- *
- * @see testNotShortArrayToken() For the array format.
- *
- * @return array
- */
- public function dataNotShortArrayToken()
- {
- return [
- 'long-array' => [
- '/* testLongArray */',
- \T_ARRAY,
- ],
- 'array-assignment-no-key' => [
- '/* testArrayAssignmentEmpty */',
- \T_OPEN_SQUARE_BRACKET,
- ],
- 'array-assignment-string-key' => [
- '/* testArrayAssignmentStringKey */',
- \T_OPEN_SQUARE_BRACKET,
- ],
- 'array-assignment-int-key' => [
- '/* testArrayAssignmentIntKey */',
- \T_OPEN_SQUARE_BRACKET,
- ],
- 'array-assignment-var-key' => [
- '/* testArrayAssignmentVarKey */',
- \T_OPEN_SQUARE_BRACKET,
- ],
- 'array-access-string-key' => [
- '/* testArrayAccessStringKey */',
- \T_CLOSE_SQUARE_BRACKET,
- ],
- 'array-access-int-key-1' => [
- '/* testArrayAccessIntKey1 */',
- \T_OPEN_SQUARE_BRACKET,
- ],
- 'array-access-int-key-2' => [
- '/* testArrayAccessIntKey2 */',
- \T_OPEN_SQUARE_BRACKET,
- ],
- 'array-access-function-call' => [
- '/* testArrayAccessFunctionCall */',
- \T_OPEN_SQUARE_BRACKET,
- ],
- 'array-access-constant' => [
- '/* testArrayAccessConstant */',
- \T_OPEN_SQUARE_BRACKET,
- ],
- 'live-coding' => [
- '/* testLiveCoding */',
- \T_OPEN_SQUARE_BRACKET,
- ],
- ];
- }
-
- /**
- * Test whether a T_OPEN_SHORT_ARRAY token is a short array.
- *
- * @dataProvider dataIsShortArray
- *
- * @param string $testMarker The comment which prefaces the target token in the test file.
- * @param bool $expected The expected boolean return value.
- * @param int|string|array $targetToken The token type(s) to test. Defaults to T_OPEN_SHORT_ARRAY.
- *
- * @return void
- */
- public function testIsShortArray($testMarker, $expected, $targetToken = \T_OPEN_SHORT_ARRAY)
- {
- $stackPtr = $this->getTargetToken($testMarker, $targetToken);
- $result = Arrays::isShortArray(self::$phpcsFile, $stackPtr);
-
- $this->assertSame($expected, $result);
- }
-
- /**
- * Data provider.
- *
- * @see testIsShortArray() For the array format.
- *
- * @return array
- */
- public function dataIsShortArray()
- {
- return [
- 'short-array-not-nested' => [
- '/* testNonNestedShortArray */',
- true,
- ],
- 'comparison-no-assignment' => [
- '/* testInComparison */',
- true,
- ],
- 'comparison-no-assignment-nested' => [
- '/* testNestedInComparison */',
- true,
- ],
- 'short-array-in-foreach' => [
- '/* testShortArrayInForeach */',
- true,
- ],
- 'short-list-in-foreach' => [
- '/* testShortListInForeach */',
- false,
- ],
- 'chained-assignment-short-list' => [
- '/* testMultiAssignShortlist */',
- false,
- ],
- 'chained-assignment-short-array' => [
- '/* testMultiAssignShortArray */',
- true,
- \T_CLOSE_SHORT_ARRAY,
- ],
- 'short-array-with-nesting-and-keys' => [
- '/* testShortArrayWithNestingAndKeys */',
- true,
- ],
- 'short-array-nested-with-keys-1' => [
- '/* testNestedShortArrayWithKeys_1 */',
- true,
- ],
- 'short-array-nested-with-keys-2' => [
- '/* testNestedShortArrayWithKeys_2 */',
- true,
- ],
- 'short-array-nested-with-keys-3' => [
- '/* testNestedShortArrayWithKeys_3 */',
- true,
- ],
- 'parse-error-anon-class-trait-use-as' => [
- '/* testNestedAnonClassWithTraitUseAs */',
- true,
- ],
- 'parse-error-use-as' => [
- '/* testParseError */',
- true,
- ],
- 'parse-error-live-coding' => [
- '/* testLiveCodingNested */',
- true,
- ],
- ];
- }
-}
diff --git a/Tests/Utils/Arrays/IsShortArrayTokenizerBC1Test.php b/Tests/Utils/Arrays/IsShortArrayTokenizerBC1Test.php
deleted file mode 100644
index 4a649b94..00000000
--- a/Tests/Utils/Arrays/IsShortArrayTokenizerBC1Test.php
+++ /dev/null
@@ -1,129 +0,0 @@
-getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
- $result = Arrays::isShortArray(self::$phpcsFile, $stackPtr);
-
- $this->assertSame($expected, $result);
- }
-
- /**
- * Data provider.
- *
- * @see testIsShortArray() For the array format.
- *
- * @return array
- */
- public function dataIsShortArray()
- {
- return [
- 'issue-1971-list-first-in-file' => [
- '/* testTokenizerIssue1971PHPCSlt330gt271A */',
- false,
- ],
- 'issue-1971-list-first-in-file-nested' => [
- '/* testTokenizerIssue1971PHPCSlt330gt271B */',
- false,
- ],
- 'issue-1381-array-dereferencing-1-array' => [
- '/* testTokenizerIssue1381PHPCSlt290A1 */',
- true,
- ],
- 'issue-1381-array-dereferencing-1-deref' => [
- '/* testTokenizerIssue1381PHPCSlt290A2 */',
- false,
- ],
- 'issue-1381-array-dereferencing-2' => [
- '/* testTokenizerIssue1381PHPCSlt290B */',
- false,
- ],
- 'issue-1381-array-dereferencing-3' => [
- '/* testTokenizerIssue1381PHPCSlt290C */',
- false,
- ],
- 'issue-1381-array-dereferencing-4' => [
- '/* testTokenizerIssue1381PHPCSlt290D1 */',
- false,
- ],
- 'issue-1381-array-dereferencing-4-deref-deref' => [
- '/* testTokenizerIssue1381PHPCSlt290D2 */',
- false,
- ],
- 'issue-1284-short-list-directly-after-close-curly-control-structure' => [
- '/* testTokenizerIssue1284PHPCSlt280A */',
- false,
- ],
- 'issue-1284-short-array-directly-after-close-curly-control-structure' => [
- '/* testTokenizerIssue1284PHPCSlt280B */',
- true,
- ],
- 'issue-1284-array-access-variable-variable' => [
- '/* testTokenizerIssue1284PHPCSlt290C */',
- false,
- ],
- 'issue-1284-array-access-variable-property' => [
- '/* testTokenizerIssue1284PHPCSlt280D */',
- false,
- ],
- ];
- }
-}
diff --git a/Tests/Utils/Arrays/IsShortArrayTokenizerBC2Test.php b/Tests/Utils/Arrays/IsShortArrayTokenizerBC2Test.php
deleted file mode 100644
index 4b975324..00000000
--- a/Tests/Utils/Arrays/IsShortArrayTokenizerBC2Test.php
+++ /dev/null
@@ -1,90 +0,0 @@
-getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
- $result = Arrays::isShortArray(self::$phpcsFile, $stackPtr);
-
- $this->assertSame($expected, $result);
- }
-
- /**
- * Data provider.
- *
- * @see testIsShortArray() For the array format.
- *
- * @return array
- */
- public function dataIsShortArray()
- {
- return [
- // Make sure the utility method does not throw false positives for short array at start of file.
- 'issue-1971-short-array-first-in-file' => [
- '/* testTokenizerIssue1971PHPCSlt330gt271C */',
- true,
- ],
- 'issue-1971-short-array-first-in-file-nested' => [
- '/* testTokenizerIssue1971PHPCSlt330gt271D */',
- true,
- ],
- ];
- }
-}
diff --git a/Tests/Utils/Arrays/README-IsShortArrayTests.md b/Tests/Utils/Arrays/README-IsShortArrayTests.md
new file mode 100644
index 00000000..a76e8c56
--- /dev/null
+++ b/Tests/Utils/Arrays/README-IsShortArrayTests.md
@@ -0,0 +1,4 @@
+# Regarding tests for `Arrays::isShortArray()`
+
+The `Arrays::isShortArray()` method is tested together with the `Lists::isShortList()` method.
+The tests for this can be found in the `Tests/Internal/IsShortArrayOrList` folder.
diff --git a/Tests/Utils/Conditions/GetConditionTest.php b/Tests/Utils/Conditions/GetConditionTest.php
index a3e6cb6b..e2dcc63c 100644
--- a/Tests/Utils/Conditions/GetConditionTest.php
+++ b/Tests/Utils/Conditions/GetConditionTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetConditionTest extends BCFile_GetConditionTest
+final class GetConditionTest extends BCFile_GetConditionTest
{
/**
@@ -103,7 +103,12 @@ public function testGetConditionMultipleTypes()
*/
public function testNonConditionalTokenGetFirstLast()
{
- $stackPtr = $this->getTargetToken('/* testStartPoint */', \T_STRING);
+ $targetType = \T_STRING;
+ if (parent::usesPhp8NameTokens() === true) {
+ $targetType = \T_NAME_QUALIFIED;
+ }
+
+ $stackPtr = $this->getTargetToken('/* testStartPoint */', $targetType);
$result = Conditions::getFirstCondition(self::$phpcsFile, $stackPtr);
$this->assertFalse($result, 'Failed asserting that getFirstCondition() on non conditional token returns false');
@@ -194,32 +199,32 @@ public function dataGetLastCondition()
{
return [
'testSeriouslyNestedMethod' => [
- '/* testSeriouslyNestedMethod */',
- [
+ 'testMarker' => '/* testSeriouslyNestedMethod */',
+ 'expected' => [
'no type' => '/* condition 5: nested class */',
'T_IF' => '/* condition 4: if */',
'OO tokens' => '/* condition 5: nested class */',
],
],
'testDeepestNested' => [
- '/* testDeepestNested */',
- [
+ 'testMarker' => '/* testDeepestNested */',
+ 'expected' => [
'no type' => '/* condition 13: closure */',
'T_IF' => '/* condition 10-1: if */',
'OO tokens' => '/* condition 11-1: nested anonymous class */',
],
],
'testInException' => [
- '/* testInException */',
- [
+ 'testMarker' => '/* testInException */',
+ 'expected' => [
'no type' => '/* condition 11-3: catch */',
'T_IF' => '/* condition 4: if */',
'OO tokens' => '/* condition 5: nested class */',
],
],
'testInDefault' => [
- '/* testInDefault */',
- [
+ 'testMarker' => '/* testInDefault */',
+ 'expected' => [
'no type' => '/* condition 8b: default */',
'T_IF' => '/* condition 4: if */',
'OO tokens' => '/* condition 5: nested class */',
diff --git a/Tests/Utils/Context/InAttributeTest.inc b/Tests/Utils/Context/InAttributeTest.inc
new file mode 100644
index 00000000..75298e9e
--- /dev/null
+++ b/Tests/Utils/Context/InAttributeTest.inc
@@ -0,0 +1,18 @@
+ $something;
+
+/* testMultiLineAttributeWithVars */
+// Illegal syntax, vars not allowed in attribute, but not our concern.
+#[
+ MyAttribute([$a, $b])
+]
+function foo() {}
+
+/* testParseError */
+#[
+ UnClosedAttribute()
diff --git a/Tests/Utils/Context/InAttributeTest.php b/Tests/Utils/Context/InAttributeTest.php
new file mode 100644
index 00000000..95333014
--- /dev/null
+++ b/Tests/Utils/Context/InAttributeTest.php
@@ -0,0 +1,167 @@
+assertFalse(Context::inAttribute(self::$phpcsFile, 10000));
+ }
+
+ /**
+ * Test correctly identifying that an arbitrary token is NOT within an attribute.
+ *
+ * @dataProvider dataNotInAttribute
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int|string|array $targetType The token type(s) to look for.
+ *
+ * @return void
+ */
+ public function testNotInAttribute($testMarker, $targetType)
+ {
+ $target = $this->getTargetToken($testMarker, $targetType);
+ $this->assertFalse(Context::inAttribute(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testInAttribute()
+ *
+ * @return array
+ */
+ public function dataNotInAttribute()
+ {
+ return [
+ 'code nowhere near an attribute [1]' => [
+ 'testMarker' => '/* testNotAttribute */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ ],
+ 'code nowhere near an attribute [2]' => [
+ 'testMarker' => '/* testNotAttribute */',
+ 'targetType' => \T_SELF,
+ ],
+
+ 'code directly before an attribute (same line)' => [
+ 'testMarker' => '/* testAttribute */',
+ 'targetType' => \T_VARIABLE,
+ ],
+ 'attribute opener' => [
+ 'testMarker' => '/* testAttribute */',
+ 'targetType' => \T_ATTRIBUTE,
+ ],
+ 'attribute closer' => [
+ 'testMarker' => '/* testAttribute */',
+ 'targetType' => \T_ATTRIBUTE_END,
+ ],
+ 'code directly after an attribute (same line)' => [
+ 'testMarker' => '/* testAttribute */',
+ 'targetType' => \T_FN,
+ ],
+
+ 'code directly after an attribute (different line)' => [
+ 'testMarker' => '/* testMultiLineAttributeWithVars */',
+ 'targetType' => \T_FUNCTION,
+ ],
+
+ 'code in an unclosed attribute (parse error)' => [
+ 'testMarker' => '/* testParseError */',
+ 'targetType' => \T_STRING,
+ ],
+ ];
+ }
+
+ /**
+ * Test correctly identifying that an arbitrary token IS within an attribute.
+ *
+ * @dataProvider dataInAttribute
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int|string|array $targetType The token type(s) to look for.
+ *
+ * @return void
+ */
+ public function testInAttribute($testMarker, $targetType)
+ {
+ $target = $this->getTargetToken($testMarker, $targetType);
+ $this->assertTrue(Context::inAttribute(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testInAttribute()
+ *
+ * @return array
+ */
+ public function dataInAttribute()
+ {
+ return [
+ 'single line attribute - attribute name' => [
+ 'testMarker' => '/* testAttribute */',
+ 'targetType' => \T_STRING,
+ ],
+ 'single line attribute - attribute param [1]' => [
+ 'testMarker' => '/* testAttribute */',
+ 'targetType' => \T_LNUMBER,
+ ],
+ 'single line attribute - comma in attribute param sequence' => [
+ 'testMarker' => '/* testAttribute */',
+ 'targetType' => \T_COMMA,
+ ],
+ 'single line attribute - attribute param [2]' => [
+ 'testMarker' => '/* testAttribute */',
+ 'targetType' => \T_SELF,
+ ],
+ 'single line attribute - close parenthesis' => [
+ 'testMarker' => '/* testAttribute */',
+ 'targetType' => \T_CLOSE_PARENTHESIS,
+ ],
+
+ 'multi line attribute - attribute name' => [
+ 'testMarker' => '/* testMultiLineAttributeWithVars */',
+ 'targetType' => \T_STRING,
+ ],
+ 'multi line attribute - attribute param [1]' => [
+ 'testMarker' => '/* testMultiLineAttributeWithVars */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ ],
+ 'multi line attribute - attribute param [2]' => [
+ 'testMarker' => '/* testMultiLineAttributeWithVars */',
+ 'targetType' => \T_VARIABLE,
+ ],
+ 'multi line attribute - close parenthesis' => [
+ 'testMarker' => '/* testMultiLineAttributeWithVars */',
+ 'targetType' => \T_CLOSE_PARENTHESIS,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/Context/InEmptyTest.inc b/Tests/Utils/Context/InEmptyTest.inc
new file mode 100644
index 00000000..bc93b6e6
--- /dev/null
+++ b/Tests/Utils/Context/InEmptyTest.inc
@@ -0,0 +1,17 @@
+empty($target);
+
+/* testOwnerNotEmpty */
+if ($target + 1 > 10) {}
+
+/* testInEmpty */
+$a = empty($target);
+
+/* testInEmptynested */
+if ((Empty($obj->methodCall($target->prop)) || $somethingElse)) {}
+
+/* testParseError */
+// This has to be the last test in the file.
+empty($target
diff --git a/Tests/Utils/Context/InEmptyTest.php b/Tests/Utils/Context/InEmptyTest.php
new file mode 100644
index 00000000..0a49654a
--- /dev/null
+++ b/Tests/Utils/Context/InEmptyTest.php
@@ -0,0 +1,86 @@
+assertFalse(Context::inEmpty(self::$phpcsFile, 10000));
+ }
+
+ /**
+ * Test correctly identifying that an arbitrary token is within an empty().
+ *
+ * @dataProvider dataInEmpty
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param bool $expected The expected function return value.
+ *
+ * @return void
+ */
+ public function testInEmpty($testMarker, $expected)
+ {
+ $target = $this->getTargetToken($testMarker, \T_VARIABLE, '$target');
+ $this->assertSame($expected, Context::inEmpty(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testInEmpty()
+ *
+ * @return array
+ */
+ public function dataInEmpty()
+ {
+ return [
+ 'method-called-empty' => [
+ 'testMarker' => '/* testNotEmptyMethodCall */',
+ 'expected' => false,
+ ],
+ 'owner-not-empty' => [
+ 'testMarker' => '/* testOwnerNotEmpty */',
+ 'expected' => false,
+ ],
+ 'in-empty' => [
+ 'testMarker' => '/* testInEmpty */',
+ 'expected' => true,
+ ],
+ 'in-empty-nested' => [
+ 'testMarker' => '/* testInEmptynested */',
+ 'expected' => true,
+ ],
+ 'parse-error' => [
+ 'testMarker' => '/* testParseError */',
+ 'expected' => false,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/Context/InForConditionTest.inc b/Tests/Utils/Context/InForConditionTest.inc
new file mode 100644
index 00000000..9352d86e
--- /dev/null
+++ b/Tests/Utils/Context/InForConditionTest.inc
@@ -0,0 +1,64 @@
+ 10) {}
+
+/* testOwnerNotForNestedParentheses */
+foreach (function_call(array($target)) as $value) {}
+
+/* testNotForMethodCall */
+$obj->for ($target) {}
+
+/* testForParseErrorTwoExpressions */
+for ($i = $target; $i < 10) {} // Intentional parse error.
+
+/* testForParseErrorFourExpressions */
+for ($i = $target; $i < 10; $i++; $nonsense) {} // Intentional parse error.
+
+/* testFor */
+for ($i = 0; $i < 10; $target++) :
+ // Do something.
+endfor;
+
+/* testForMultipleStatementsInExpr */
+for ($i = 0, $c = namespace\sizeof($target); $i < $c /* testForSecondSemicolon */ ; $j += $i, print $i, ++$i) {}
+
+/* testForEmptyExpr1 */
+For (; $i < 10; $target + $i) {}
+
+/* testForEmptyExpr2 */
+for ($target = 0; ; ++$i) {}
+
+/* testForEmptyExpr3 */
+for ($i = 0; $target > $i;) {}
+
+/* testForEmptyExpr12 */
+for (;; $next = find($target)) {}
+
+/* testForEmptyExpr13 */
+for (; $target->valid();) {}
+
+/* testForEmptyExpr23 */
+for ($i = $target; ; /* Deliberately empty */) {}
+
+/* testForEmptyExpr123 */
+for (;;) {}
+
+/* testForWithNestedSemiColon */
+for ($closure = function($a, $b) { return $a * $b; }, $i = 10; $closure($a, $b) < 10; $i++) {}
+
+/* testNestedFor */
+add_action('something', function($array) {
+ for($a = call(); $obj->valid($a); $obj->next($a)) {}
+ return;
+});
+
+// Intentional parse error. This has to be the last test in the file.
+/* testParseError */
+for ($i = $target; $i < 10
diff --git a/Tests/Utils/Context/InForConditionTest.php b/Tests/Utils/Context/InForConditionTest.php
new file mode 100644
index 00000000..57531278
--- /dev/null
+++ b/Tests/Utils/Context/InForConditionTest.php
@@ -0,0 +1,222 @@
+assertFalse(Context::inForCondition(self::$phpcsFile, 10000));
+ }
+
+ /**
+ * Test receiving `false` when the token passed is not in a for condition.
+ *
+ * @dataProvider dataNotInFor
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ *
+ * @return void
+ */
+ public function testNotInFor($testMarker)
+ {
+ $target = $this->getTargetToken($testMarker, \T_VARIABLE, '$target');
+ $this->assertFalse(Context::inForCondition(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testNotInFor()
+ *
+ * @return array
+ */
+ public function dataNotInFor()
+ {
+ return [
+ 'no-parenthesis' => ['/* testNoParentheses */'],
+ 'no-parenthesis-owner' => ['/* testNoParenthesisOwner */'],
+ 'owner-not-for' => ['/* testOwnerNotFor */'],
+ 'owner-not-for-nested-parentheses' => ['/* testOwnerNotForNestedParentheses */'],
+ 'method-called-for' => ['/* testNotForMethodCall */'],
+ 'for-two-expressions' => ['/* testForParseErrorTwoExpressions */'],
+ 'for-four-expressions' => ['/* testForParseErrorFourExpressions */'],
+ 'parse-error' => ['/* testParseError */'],
+ ];
+ }
+
+ /**
+ * Test correctly identifying the position of a token in a for condition.
+ *
+ * @dataProvider dataInForCondition
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param string $expected The expected function return value.
+ * @param int|string|array $targetType Optional. The token type of the target token.
+ * Defaults to T_VARIABLE.
+ * @param string $targetContent Optional. The token content of the target token.
+ * Defaults to `$target` for `T_VARIABLE`.
+ *
+ * @return void
+ */
+ public function testInForCondition($testMarker, $expected, $targetType = \T_VARIABLE, $targetContent = null)
+ {
+ if ($targetType === \T_VARIABLE && $targetContent === null) {
+ $targetContent = '$target';
+ }
+
+ $stackPtr = $this->getTargetToken($testMarker, $targetType, $targetContent);
+ $result = Context::inForCondition(self::$phpcsFile, $stackPtr);
+ $this->assertSame($expected, $result);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testInForCondition()
+ *
+ * @return array
+ */
+ public function dataInForCondition()
+ {
+ return [
+ 'expr1' => [
+ 'testMarker' => '/* testFor */',
+ 'expected' => 'expr1',
+ 'targetType' => \T_EQUAL,
+ ],
+ 'expr1-semicolon' => [
+ 'testMarker' => '/* testFor */',
+ 'expected' => 'expr1',
+ 'targetType' => \T_SEMICOLON,
+ ],
+ 'expr2' => [
+ 'testMarker' => '/* testFor */',
+ 'expected' => 'expr2',
+ 'targetType' => \T_LNUMBER,
+ 'targetContent' => '10',
+ ],
+ 'expr3' => [
+ 'testMarker' => '/* testFor */',
+ 'expected' => 'expr3',
+ ],
+ 'multi-expression-expr1' => [
+ 'testMarker' => '/* testForMultipleStatementsInExpr */',
+ 'expected' => 'expr1',
+ ],
+ 'multi-expression-expr2' => [
+ 'testMarker' => '/* testForMultipleStatementsInExpr */',
+ 'expected' => 'expr2',
+ 'targetType' => \T_LESS_THAN,
+ ],
+ 'multi-expression-expr2-semicolon' => [
+ 'testMarker' => '/* testForSecondSemicolon */',
+ 'expected' => 'expr2',
+ 'targetType' => \T_SEMICOLON,
+ ],
+ 'multi-expression-expr3' => [
+ 'testMarker' => '/* testForSecondSemicolon */',
+ 'expected' => 'expr3',
+ 'targetType' => \T_PRINT,
+ ],
+ 'empty-1-expr2' => [
+ 'testMarker' => '/* testForEmptyExpr1 */',
+ 'expected' => 'expr2',
+ 'targetType' => \T_LNUMBER,
+ 'targetContent' => '10',
+ ],
+ 'empty-1-expr3' => [
+ 'testMarker' => '/* testForEmptyExpr1 */',
+ 'expected' => 'expr3',
+ ],
+ 'empty-2-expr1' => [
+ 'testMarker' => '/* testForEmptyExpr2 */',
+ 'expected' => 'expr1',
+ ],
+ 'empty-2-expr3' => [
+ 'testMarker' => '/* testForEmptyExpr2 */',
+ 'expected' => 'expr3',
+ 'targetType' => \T_INC,
+ ],
+ 'empty-3-expr1' => [
+ 'testMarker' => '/* testForEmptyExpr3 */',
+ 'expected' => 'expr1',
+ 'targetType' => \T_VARIABLE,
+ 'targetContent' => '$i',
+ ],
+ 'empty-3-expr2' => [
+ 'testMarker' => '/* testForEmptyExpr3 */',
+ 'expected' => 'expr2',
+ ],
+ 'empty-12-expr3' => [
+ 'testMarker' => '/* testForEmptyExpr12 */',
+ 'expected' => 'expr3',
+ ],
+ 'empty-13-expr2' => [
+ 'testMarker' => '/* testForEmptyExpr13 */',
+ 'expected' => 'expr2',
+ ],
+ 'empty-23-expr1' => [
+ 'testMarker' => '/* testForEmptyExpr23 */',
+ 'expected' => 'expr1',
+ ],
+ 'empty-23-expr3' => [
+ 'testMarker' => '/* testForEmptyExpr23 */',
+ 'expected' => 'expr3',
+ 'targetType' => \T_COMMENT,
+ ],
+ 'empty-123-expr1' => [
+ 'testMarker' => '/* testForEmptyExpr123 */',
+ 'expected' => 'expr1',
+ 'targetType' => \T_SEMICOLON,
+ ],
+ 'nested-semicolon-expr1' => [
+ 'testMarker' => '/* testForWithNestedSemiColon */',
+ 'expected' => 'expr1',
+ 'targetType' => \T_RETURN,
+ ],
+ 'nested-semicolon-expr2' => [
+ 'testMarker' => '/* testForWithNestedSemiColon */',
+ 'expected' => 'expr2',
+ 'targetType' => \T_LESS_THAN,
+ ],
+ 'nested-semicolon-expr3' => [
+ 'testMarker' => '/* testForWithNestedSemiColon */',
+ 'expected' => 'expr3',
+ 'targetType' => \T_INC,
+ ],
+ 'nested-for-expr2' => [
+ 'testMarker' => '/* testNestedFor */',
+ 'expected' => 'expr2',
+ 'targetType' => \T_STRING,
+ 'targetContent' => 'valid',
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/Context/InForeachConditionTest.inc b/Tests/Utils/Context/InForeachConditionTest.inc
new file mode 100644
index 00000000..f5ba6946
--- /dev/null
+++ b/Tests/Utils/Context/InForeachConditionTest.inc
@@ -0,0 +1,52 @@
+ 10) {}
+
+/* testOwnerNotForeachNestedParentheses */
+for ($i = 1; function_call(array($target)) < 10; $i++) {}
+
+/* testNotForeachMethodCall */
+$obj->foreach ($target) {}
+
+/* testForeachWithoutAs */
+foreach ($target) {} // Intentional parse error.
+
+/* testForeachValue */
+foreach ($array as $value) {}
+
+/* testForeachKeyValue */
+foreach ($iterator AS $key => $value) {}
+
+/* testForeachBeforeLongArrayMinimalWhiteSpace */
+foreach (array('a' => 1, 'b' => 2, 3)as$key => $value) {}
+
+/* testForeachBeforeFunctionCall */
+Foreach (callMe(array($target)) As $key => $value) {}
+
+/* testForeachVarAfterAsList */
+foreach($array as list($target, $else)) {}
+
+/* testForeachVarAfterAsShortList */
+foreach($array as [$something, $target]) {}
+
+/* testForeachVarAfterAsKeyedList */
+foreach ($array as list('id' => $id, 'name' => $target)):
+ // Do something.
+endforeach;
+
+/* testNestedForeach */
+add_action('something', function($array) {
+ foreach($array as $target) {}
+ return;
+});
+
+// Intentional parse error. This has to be the last test in the file.
+/* testParseError */
+foreach ($array as $target {}
diff --git a/Tests/Utils/Context/InForeachConditionTest.php b/Tests/Utils/Context/InForeachConditionTest.php
new file mode 100644
index 00000000..4ce9f86c
--- /dev/null
+++ b/Tests/Utils/Context/InForeachConditionTest.php
@@ -0,0 +1,185 @@
+assertFalse(Context::inForeachCondition(self::$phpcsFile, 10000));
+ }
+
+ /**
+ * Test receiving `false` when the token passed is not in a foreach condition.
+ *
+ * @dataProvider dataNotInForeach
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ *
+ * @return void
+ */
+ public function testNotInForeach($testMarker)
+ {
+ $target = $this->getTargetToken($testMarker, \T_VARIABLE, '$target');
+ $this->assertFalse(Context::inForeachCondition(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testNotInForeach()
+ *
+ * @return array
+ */
+ public function dataNotInForeach()
+ {
+ return [
+ 'no-parenthesis' => ['/* testNoParentheses */'],
+ 'no-parenthesis-owner' => ['/* testNoParenthesisOwner */'],
+ 'owner-not-foreach' => ['/* testOwnerNotForeach */'],
+ 'owner-not-foreach-nested-parentheses' => ['/* testOwnerNotForeachNestedParentheses */'],
+ 'method-called-foreach' => ['/* testNotForeachMethodCall */'],
+ 'foreach-without-as' => ['/* testForeachWithoutAs */'],
+ 'parse-error' => ['/* testParseError */'],
+ ];
+ }
+
+ /**
+ * Test correctly identifying the position of a token in a foreach condition.
+ *
+ * @dataProvider dataInForeachCondition
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param string $expected The expected function return value.
+ * @param int|string|array $targetType Optional. The token type of the target token.
+ * Defaults to T_VARIABLE.
+ * @param string $targetContent Optional. The token content of the target token.
+ * Defaults to `$target` for `T_VARIABLE`.
+ *
+ * @return void
+ */
+ public function testInForeachCondition($testMarker, $expected, $targetType = \T_VARIABLE, $targetContent = null)
+ {
+ if ($targetType === \T_VARIABLE && $targetContent === null) {
+ $targetContent = '$target';
+ }
+
+ $stackPtr = $this->getTargetToken($testMarker, $targetType, $targetContent);
+ $result = Context::inForeachCondition(self::$phpcsFile, $stackPtr);
+ $this->assertSame($expected, $result);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testInForeachCondition()
+ *
+ * @return array
+ */
+ public function dataInForeachCondition()
+ {
+ return [
+ 'before' => [
+ 'testMarker' => '/* testForeachValue */',
+ 'expected' => 'beforeAs',
+ 'targetType' => \T_VARIABLE,
+ 'targetContent' => '$array',
+ ],
+ 'as' => [
+ 'testMarker' => '/* testForeachValue */',
+ 'expected' => 'as',
+ 'targetType' => \T_AS,
+ ],
+ 'after' => [
+ 'testMarker' => '/* testForeachValue */',
+ 'expected' => 'afterAs',
+ 'targetType' => \T_VARIABLE,
+ 'targetContent' => '$value',
+ ],
+ 'as-caps' => [
+ 'testMarker' => '/* testForeachKeyValue */',
+ 'expected' => 'as',
+ 'targetType' => \T_AS,
+ ],
+ 'after-key' => [
+ 'testMarker' => '/* testForeachKeyValue */',
+ 'expected' => 'afterAs',
+ 'targetType' => \T_VARIABLE,
+ 'targetContent' => '$key',
+ ],
+ 'before-in-long-array' => [
+ 'testMarker' => '/* testForeachBeforeLongArrayMinimalWhiteSpace */',
+ 'expected' => 'beforeAs',
+ 'targetType' => \T_LNUMBER,
+ 'targetContent' => '2',
+ ],
+ 'before-function-call' => [
+ 'testMarker' => '/* testForeachBeforeFunctionCall */',
+ 'expected' => 'beforeAs',
+ 'targetType' => \T_STRING,
+ ],
+ 'before-array-nested-in-function-call' => [
+ 'testMarker' => '/* testForeachBeforeFunctionCall */',
+ 'expected' => 'beforeAs',
+ 'targetType' => \T_ARRAY,
+ ],
+ 'before-var-nested-in-array-nested-in-function-call' => [
+ 'testMarker' => '/* testForeachBeforeFunctionCall */',
+ 'expected' => 'beforeAs',
+ ],
+ 'after-list' => [
+ 'testMarker' => '/* testForeachVarAfterAsList */',
+ 'expected' => 'afterAs',
+ 'targetType' => \T_LIST,
+ ],
+ 'after-variable-in-list' => [
+ 'testMarker' => '/* testForeachVarAfterAsList */',
+ 'expected' => 'afterAs',
+ ],
+ 'after-variable-in-short-list' => [
+ 'testMarker' => '/* testForeachVarAfterAsList */',
+ 'expected' => 'afterAs',
+ ],
+ 'after-variable-in-list-value' => [
+ 'testMarker' => '/* testForeachVarAfterAsKeyedList */',
+ 'expected' => 'afterAs',
+ ],
+ 'after-variable-in-list-key' => [
+ 'testMarker' => '/* testForeachVarAfterAsKeyedList */',
+ 'expected' => 'afterAs',
+ 'targetType' => \T_CONSTANT_ENCAPSED_STRING,
+ 'targetContent' => "'name'",
+ ],
+ 'after-foreach-nested-in-closure' => [
+ 'testMarker' => '/* testNestedForeach */',
+ 'expected' => 'afterAs',
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/Context/InIssetTest.inc b/Tests/Utils/Context/InIssetTest.inc
new file mode 100644
index 00000000..a3a87d2f
--- /dev/null
+++ b/Tests/Utils/Context/InIssetTest.inc
@@ -0,0 +1,17 @@
+isset($target);
+
+/* testOwnerNotIsset */
+if ($target + 1 > 10) {}
+
+/* testInIsset */
+$a = isset($target);
+
+/* testInIssetnested */
+if ((Isset($something, $target, $else) || $somethingElse)) {}
+
+/* testParseError */
+// This has to be the last test in the file.
+isset($target
diff --git a/Tests/Utils/Context/InIssetTest.php b/Tests/Utils/Context/InIssetTest.php
new file mode 100644
index 00000000..e332e75b
--- /dev/null
+++ b/Tests/Utils/Context/InIssetTest.php
@@ -0,0 +1,86 @@
+assertFalse(Context::inIsset(self::$phpcsFile, 10000));
+ }
+
+ /**
+ * Test correctly identifying that an arbitrary token is within an isset().
+ *
+ * @dataProvider dataInIsset
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param bool $expected The expected function return value.
+ *
+ * @return void
+ */
+ public function testInIsset($testMarker, $expected)
+ {
+ $target = $this->getTargetToken($testMarker, \T_VARIABLE, '$target');
+ $this->assertSame($expected, Context::inIsset(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testInIsset()
+ *
+ * @return array
+ */
+ public function dataInIsset()
+ {
+ return [
+ 'method-called-isset' => [
+ 'testMarker' => '/* testNotIssetMethodCall */',
+ 'expected' => false,
+ ],
+ 'owner-not-isset' => [
+ 'testMarker' => '/* testOwnerNotIsset */',
+ 'expected' => false,
+ ],
+ 'in-isset' => [
+ 'testMarker' => '/* testInIsset */',
+ 'expected' => true,
+ ],
+ 'in-isset-nested' => [
+ 'testMarker' => '/* testInIssetnested */',
+ 'expected' => true,
+ ],
+ 'parse-error' => [
+ 'testMarker' => '/* testParseError */',
+ 'expected' => false,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/Context/InUnsetTest.inc b/Tests/Utils/Context/InUnsetTest.inc
new file mode 100644
index 00000000..46d9d5ea
--- /dev/null
+++ b/Tests/Utils/Context/InUnsetTest.inc
@@ -0,0 +1,16 @@
+unset($target);
+
+function foo() {
+ /* testOwnerNotUnset */
+ if (isset($target) && $target + 1 > 10) {
+ /* testInUnset */
+ Unset($something['a'], $target->prop, $else);
+ }
+}
+
+/* testParseError */
+// This has to be the last test in the file.
+unset($target
diff --git a/Tests/Utils/Context/InUnsetTest.php b/Tests/Utils/Context/InUnsetTest.php
new file mode 100644
index 00000000..b0b65cae
--- /dev/null
+++ b/Tests/Utils/Context/InUnsetTest.php
@@ -0,0 +1,82 @@
+assertFalse(Context::inUnset(self::$phpcsFile, 10000));
+ }
+
+ /**
+ * Test correctly identifying that an arbitrary token is within an unset().
+ *
+ * @dataProvider dataInUnset
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param bool $expected The expected function return value.
+ *
+ * @return void
+ */
+ public function testInUnset($testMarker, $expected)
+ {
+ $target = $this->getTargetToken($testMarker, \T_VARIABLE, '$target');
+ $this->assertSame($expected, Context::inUnset(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testInUnset()
+ *
+ * @return array
+ */
+ public function dataInUnset()
+ {
+ return [
+ 'method-called-unset' => [
+ 'testMarker' => '/* testNotUnsetMethodCall */',
+ 'expected' => false,
+ ],
+ 'owner-not-unset' => [
+ 'testMarker' => '/* testOwnerNotUnset */',
+ 'expected' => false,
+ ],
+ 'in-unset' => [
+ 'testMarker' => '/* testInUnset */',
+ 'expected' => true,
+ ],
+ 'parse-error' => [
+ 'testMarker' => '/* testParseError */',
+ 'expected' => false,
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/ControlStructures/GetCaughtExceptionsTest.php b/Tests/Utils/ControlStructures/GetCaughtExceptionsTest.php
index 0c7811a5..0b0b3702 100644
--- a/Tests/Utils/ControlStructures/GetCaughtExceptionsTest.php
+++ b/Tests/Utils/ControlStructures/GetCaughtExceptionsTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetCaughtExceptionsTest extends UtilityMethodTestCase
+final class GetCaughtExceptionsTest extends UtilityMethodTestCase
{
/**
@@ -95,9 +95,11 @@ public function testGetCaughtExceptions($testMarker, $expected)
*/
public function dataGetCaughtExceptions()
{
+ $php8Names = parent::usesPhp8NameTokens();
+
return [
'single-name-only' => [
- 'target' => '/* testSingleCatchNameOnly */',
+ 'testMarker' => '/* testSingleCatchNameOnly */',
'expected' => [
[
'type' => 'RuntimeException',
@@ -107,57 +109,57 @@ public function dataGetCaughtExceptions()
],
],
'single-name-leading-backslash' => [
- 'target' => '/* testSingleCatchNameLeadingBackslash */',
+ 'testMarker' => '/* testSingleCatchNameLeadingBackslash */',
'expected' => [
[
'type' => '\RuntimeException',
'type_token' => 3,
- 'type_end_token' => 4,
+ 'type_end_token' => ($php8Names === true) ? 3 : 4,
],
],
],
'single-partially-qualified' => [
- 'target' => '/* testSingleCatchPartiallyQualified */',
+ 'testMarker' => '/* testSingleCatchPartiallyQualified */',
'expected' => [
[
'type' => 'MyNS\RuntimeException',
'type_token' => 4,
- 'type_end_token' => 6,
+ 'type_end_token' => ($php8Names === true) ? 4 : 6,
],
],
],
'single-fully-qualified' => [
- 'target' => '/* testSingleCatchFullyQualified */',
+ 'testMarker' => '/* testSingleCatchFullyQualified */',
'expected' => [
[
'type' => '\MyNS\RuntimeException',
'type_token' => 4,
- 'type_end_token' => 7,
+ 'type_end_token' => ($php8Names === true) ? 4 : 7,
],
],
],
'single-name-with-comments-whitespace' => [
- 'target' => '/* testSingleCatchPartiallyQualifiedWithCommentAndWhitespace */',
+ 'testMarker' => '/* testSingleCatchPartiallyQualifiedWithCommentAndWhitespace */',
'expected' => [
[
'type' => 'My\NS\Sub\RuntimeException',
'type_token' => 4,
- 'type_end_token' => 15,
+ 'type_end_token' => ($php8Names === true) ? 13 : 15,
],
],
],
'single-namespace-operator' => [
- 'target' => '/* testSingleCatchNamespaceOperator */',
+ 'testMarker' => '/* testSingleCatchNamespaceOperator */',
'expected' => [
[
'type' => 'namespace\RuntimeException',
'type_token' => 4,
- 'type_end_token' => 6,
+ 'type_end_token' => ($php8Names === true) ? 4 : 6,
],
],
],
'multi-unqualified-names' => [
- 'target' => '/* testMultiCatchSingleNames */',
+ 'testMarker' => '/* testMultiCatchSingleNames */',
'expected' => [
[
'type' => 'RuntimeException',
@@ -178,27 +180,27 @@ public function dataGetCaughtExceptions()
],
'multi-qualified-names' => [
- 'target' => '/* testMultiCatchCompoundNames */',
+ 'testMarker' => '/* testMultiCatchCompoundNames */',
'expected' => [
[
'type' => '\NS\RuntimeException',
'type_token' => 3,
- 'type_end_token' => 6,
+ 'type_end_token' => ($php8Names === true) ? 3 : 6,
],
[
'type' => 'My\ParseErrorException',
- 'type_token' => 10,
- 'type_end_token' => 12,
+ 'type_token' => ($php8Names === true) ? 7 : 10,
+ 'type_end_token' => ($php8Names === true) ? 7 : 12,
],
[
'type' => 'namespace\AnotherException',
- 'type_token' => 16,
- 'type_end_token' => 20,
+ 'type_token' => ($php8Names === true) ? 11 : 16,
+ 'type_end_token' => ($php8Names === true) ? 15 : 20,
],
],
],
'non-capturing-catch' => [
- 'target' => '/* testPHP8NonCapturingCatch */',
+ 'testMarker' => '/* testPHP8NonCapturingCatch */',
'expected' => [
[
'type' => 'RuntimeException',
diff --git a/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError1Test.php b/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError1Test.php
index fb299040..7b86f993 100644
--- a/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError1Test.php
+++ b/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError1Test.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\Utils\ControlStructures;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tests\PolyfilledTestCase;
use PHPCSUtils\Utils\ControlStructures;
/**
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetDeclareScopeOpenCloseParseError1Test extends UtilityMethodTestCase
+final class GetDeclareScopeOpenCloseParseError1Test extends PolyfilledTestCase
{
/**
@@ -32,6 +32,12 @@ class GetDeclareScopeOpenCloseParseError1Test extends UtilityMethodTestCase
*/
public function testGetDeclareScopeOpenCloseParseError()
{
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'ControlStructures::getDeclareScopeOpenClose() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Check for the "scope_opener"/"scope_closer" keys instead.'
+ );
+
$stackPtr = $this->getTargetToken('/* testNoCloseParenthesis */', \T_DECLARE);
$result = ControlStructures::getDeclareScopeOpenClose(self::$phpcsFile, $stackPtr);
$this->assertFalse($result);
diff --git a/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError2Test.php b/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError2Test.php
index 791654c1..85adcda2 100644
--- a/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError2Test.php
+++ b/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError2Test.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\Utils\ControlStructures;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tests\PolyfilledTestCase;
use PHPCSUtils\Utils\ControlStructures;
/**
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetDeclareScopeOpenCloseParseError2Test extends UtilityMethodTestCase
+final class GetDeclareScopeOpenCloseParseError2Test extends PolyfilledTestCase
{
/**
@@ -32,6 +32,12 @@ class GetDeclareScopeOpenCloseParseError2Test extends UtilityMethodTestCase
*/
public function testGetDeclareScopeOpenCloseParseError()
{
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'ControlStructures::getDeclareScopeOpenClose() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Check for the "scope_opener"/"scope_closer" keys instead.'
+ );
+
$stackPtr = $this->getTargetToken('/* testNoScopeOpener */', \T_DECLARE);
$result = ControlStructures::getDeclareScopeOpenClose(self::$phpcsFile, $stackPtr);
$this->assertFalse($result);
diff --git a/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError3Test.php b/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError3Test.php
index 9c87aee0..e4207e43 100644
--- a/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError3Test.php
+++ b/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError3Test.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\Utils\ControlStructures;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tests\PolyfilledTestCase;
use PHPCSUtils\Utils\ControlStructures;
/**
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetDeclareScopeOpenCloseParseError3Test extends UtilityMethodTestCase
+final class GetDeclareScopeOpenCloseParseError3Test extends PolyfilledTestCase
{
/**
@@ -32,6 +32,12 @@ class GetDeclareScopeOpenCloseParseError3Test extends UtilityMethodTestCase
*/
public function testGetDeclareScopeOpenCloseParseError()
{
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'ControlStructures::getDeclareScopeOpenClose() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Check for the "scope_opener"/"scope_closer" keys instead.'
+ );
+
$stackPtr = $this->getTargetToken('/* testNoScopeCloser */', \T_DECLARE);
$result = ControlStructures::getDeclareScopeOpenClose(self::$phpcsFile, $stackPtr);
$this->assertFalse($result);
diff --git a/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError4Test.php b/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError4Test.php
index e72c1b3b..7e1aa7c5 100644
--- a/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError4Test.php
+++ b/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseParseError4Test.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\Utils\ControlStructures;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tests\PolyfilledTestCase;
use PHPCSUtils\Utils\ControlStructures;
/**
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetDeclareScopeOpenCloseParseError4Test extends UtilityMethodTestCase
+final class GetDeclareScopeOpenCloseParseError4Test extends PolyfilledTestCase
{
/**
@@ -32,6 +32,12 @@ class GetDeclareScopeOpenCloseParseError4Test extends UtilityMethodTestCase
*/
public function testGetDeclareScopeOpenCloseParseError()
{
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'ControlStructures::getDeclareScopeOpenClose() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Check for the "scope_opener"/"scope_closer" keys instead.'
+ );
+
$stackPtr = $this->getTargetToken('/* testUnexpectedToken */', \T_DECLARE);
$result = ControlStructures::getDeclareScopeOpenClose(self::$phpcsFile, $stackPtr);
$this->assertFalse($result);
diff --git a/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseTest.inc b/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseTest.inc
index 964e9b21..057e07ba 100644
--- a/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseTest.inc
+++ b/Tests/Utils/ControlStructures/GetDeclareScopeOpenCloseTest.inc
@@ -48,6 +48,24 @@ declare(ticks=1) :
}
enddeclare;
+/* testMultiDirectiveFileScope */
+declare(strict_types=1, encoding='UTF-8');
+
+/* testMultiDirectiveBraces */
+declare(strict_types=1, encoding='UTF-8') {
+ // entire script here
+}
+
+/* testMultiDirectiveAltSyntax */
+declare(strict_types=1, encoding='UTF-8'):
+ // entire script here
+enddeclare;
+
+/* testPHPCloseTag */
+?>
+
+expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'ControlStructures::getDeclareScopeOpenClose() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Check for the "scope_opener"/"scope_closer" keys instead.'
+ );
+
$this->assertFalse(ControlStructures::getDeclareScopeOpenClose(self::$phpcsFile, 10000));
}
@@ -42,6 +48,12 @@ public function testNonExistentToken()
*/
public function testNotDeclare()
{
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'ControlStructures::getDeclareScopeOpenClose() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Check for the "scope_opener"/"scope_closer" keys instead.'
+ );
+
$target = $this->getTargetToken('/* testNotDeclare */', \T_ECHO);
$this->assertFalse(ControlStructures::getDeclareScopeOpenClose(self::$phpcsFile, $target));
}
@@ -58,6 +70,12 @@ public function testNotDeclare()
*/
public function testGetDeclareScopeOpenClose($testMarker, $expected)
{
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'ControlStructures::getDeclareScopeOpenClose() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Check for the "scope_opener"/"scope_closer" keys instead.'
+ );
+
$stackPtr = $this->getTargetToken($testMarker, \T_DECLARE);
// Translate offsets to absolute token positions.
@@ -81,90 +99,114 @@ public function dataGetDeclareScopeOpenClose()
{
return [
'file-scope' => [
- '/* testFileScope */',
- false,
+ 'testMarker' => '/* testFileScope */',
+ 'expected' => false,
],
'curlies' => [
- '/* testCurlies */',
- [
+ 'testMarker' => '/* testCurlies */',
+ 'expected' => [
'opener' => 7,
'closer' => 11,
],
],
'nested-curlies-outside' => [
- '/* testNestedCurliesOutside */',
- [
+ 'testMarker' => '/* testNestedCurliesOutside */',
+ 'expected' => [
'opener' => 7,
'closer' => 32,
],
],
'nested-curlies-inside' => [
- '/* testNestedCurliesInside */',
- [
+ 'testMarker' => '/* testNestedCurliesInside */',
+ 'expected' => [
'opener' => 12,
'closer' => 17,
],
],
'alternative-syntax' => [
- '/* testAlternativeSyntax */',
- [
+ 'testMarker' => '/* testAlternativeSyntax */',
+ 'expected' => [
'opener' => 7,
'closer' => 11,
],
],
'alternative-syntax-nested-level-1' => [
- '/* testAlternativeSyntaxNestedLevel1 */',
- [
+ 'testMarker' => '/* testAlternativeSyntaxNestedLevel1 */',
+ 'expected' => [
'opener' => 7,
'closer' => 50,
],
],
'alternative-syntax-nested-level-2' => [
- '/* testAlternativeSyntaxNestedLevel2 */',
- [
+ 'testMarker' => '/* testAlternativeSyntaxNestedLevel2 */',
+ 'expected' => [
'opener' => 12,
'closer' => 34,
],
],
'alternative-syntax-nested-level-3' => [
- '/* testAlternativeSyntaxNestedLevel3 */',
- [
+ 'testMarker' => '/* testAlternativeSyntaxNestedLevel3 */',
+ 'expected' => [
'opener' => 7,
'closer' => 12,
],
],
'mixed-nested-level-1' => [
- '/* testMixedNestedLevel1 */',
- [
+ 'testMarker' => '/* testMixedNestedLevel1 */',
+ 'expected' => [
'opener' => 7,
'closer' => 61,
],
],
'mixed-nested-level-2' => [
- '/* testMixedNestedLevel2 */',
- [
+ 'testMarker' => '/* testMixedNestedLevel2 */',
+ 'expected' => [
'opener' => 12,
'closer' => 46,
],
],
'mixed-nested-level-3' => [
- '/* testMixedNestedLevel3 */',
- [
+ 'testMarker' => '/* testMixedNestedLevel3 */',
+ 'expected' => [
'opener' => 7,
'closer' => 24,
],
],
'mixed-nested-level-4' => [
- '/* testMixedNestedLevel4 */',
- false,
+ 'testMarker' => '/* testMixedNestedLevel4 */',
+ 'expected' => false,
+ ],
+
+ 'multi-directive-file-scoped' => [
+ 'testMarker' => '/* testMultiDirectiveFileScope */',
+ 'expected' => false,
+ ],
+ 'multi-directive-brace-scoped' => [
+ 'testMarker' => '/* testMultiDirectiveBraces */',
+ 'expected' => [
+ 'opener' => 12,
+ 'closer' => 16,
+ ],
+ ],
+ 'multi-directive-alt-syntax' => [
+ 'testMarker' => '/* testMultiDirectiveAltSyntax */',
+ 'expected' => [
+ 'opener' => 11,
+ 'closer' => 15,
+ ],
+ ],
+
+ 'php-close-tag' => [
+ 'testMarker' => '/* testPHPCloseTag */',
+ 'expected' => false,
],
'live-coding' => [
- '/* testLiveCoding */',
- false,
+ 'testMarker' => '/* testLiveCoding */',
+ 'expected' => false,
],
];
}
diff --git a/Tests/Utils/ControlStructures/HasBodyParseError1Test.php b/Tests/Utils/ControlStructures/HasBodyParseError1Test.php
index 225343d0..3869f40a 100644
--- a/Tests/Utils/ControlStructures/HasBodyParseError1Test.php
+++ b/Tests/Utils/ControlStructures/HasBodyParseError1Test.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class HasBodyParseError1Test extends UtilityMethodTestCase
+final class HasBodyParseError1Test extends UtilityMethodTestCase
{
/**
diff --git a/Tests/Utils/ControlStructures/HasBodyParseError2Test.php b/Tests/Utils/ControlStructures/HasBodyParseError2Test.php
index 1f8f4953..83072b75 100644
--- a/Tests/Utils/ControlStructures/HasBodyParseError2Test.php
+++ b/Tests/Utils/ControlStructures/HasBodyParseError2Test.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class HasBodyParseError2Test extends UtilityMethodTestCase
+final class HasBodyParseError2Test extends UtilityMethodTestCase
{
/**
diff --git a/Tests/Utils/ControlStructures/HasBodyTest.inc b/Tests/Utils/ControlStructures/HasBodyTest.inc
index e0363bb0..d68d3b7d 100644
--- a/Tests/Utils/ControlStructures/HasBodyTest.inc
+++ b/Tests/Utils/ControlStructures/HasBodyTest.inc
@@ -217,6 +217,28 @@ do
echo $i;
while (++$i <= 10);
+
+/*
+ * PHP 8.0 match expressions.
+ */
+
+/* testMatchEmptyBody */
+// Intentional fatal error, "unhandled match case", but not the concern of this method.
+$match = match($a) {};
+
+/* testMatchEmptyBodyWithComment */
+// Intentional fatal error, "unhandled match case", but not the concern of this method.
+$match = match($a) {
+ // Deliberately empty.
+};
+
+/* testMatchWithCode */
+$match = match ($a) {
+ 0 => 'Foo',
+ 1 => 'Bar',
+ 2 => 'Baz',
+};
+
// Live coding.
// Intentional parse error. This test has to be the last in the file.
if ($a) {
diff --git a/Tests/Utils/ControlStructures/HasBodyTest.php b/Tests/Utils/ControlStructures/HasBodyTest.php
index 7182cc47..896ca8e3 100644
--- a/Tests/Utils/ControlStructures/HasBodyTest.php
+++ b/Tests/Utils/ControlStructures/HasBodyTest.php
@@ -23,7 +23,7 @@
*
* @since 1.0.0
*/
-class HasBodyTest extends UtilityMethodTestCase
+final class HasBodyTest extends UtilityMethodTestCase
{
/**
@@ -62,7 +62,7 @@ public function testNotControlStructure()
*/
public function testHasBody($testMarker, $hasBody, $hasNonEmptyBody)
{
- $stackPtr = $this->getTargetToken($testMarker, Collections::$controlStructureTokens);
+ $stackPtr = $this->getTargetToken($testMarker, Collections::controlStructureTokens());
$result = ControlStructures::hasBody(self::$phpcsFile, $stackPtr);
$this->assertSame($hasBody, $result, 'Failed hasBody check with $allowEmpty = true');
@@ -82,239 +82,262 @@ public function dataHasBody()
{
return [
'if-without-body' => [
- '/* testIfWithoutBody */',
- false,
- false,
+ 'testMarker' => '/* testIfWithoutBody */',
+ 'hasBody' => false,
+ 'hasNonEmptyBody' => false,
],
'if-empty-body' => [
- '/* testIfEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testIfEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'elseif-empty-body' => [
- '/* testElseIfEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testElseIfEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'else-if-empty-body' => [
- '/* testElseSpaceIfEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testElseSpaceIfEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'else-empty-body' => [
- '/* testElseEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testElseEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'if-with-code' => [
- '/* testIfWithCode */',
- true,
- true,
+ 'testMarker' => '/* testIfWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'elseif-with-code' => [
- '/* testElseIfWithCode */',
- true,
- true,
+ 'testMarker' => '/* testElseIfWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'else-if-with-code' => [
- '/* testElseSpaceIfWithCode */',
- true,
- true,
+ 'testMarker' => '/* testElseSpaceIfWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'else-with-code' => [
- '/* testElseWithCode */',
- true,
- true,
+ 'testMarker' => '/* testElseWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'for-without-body' => [
- '/* testForWithoutBody */',
- false,
- false,
+ 'testMarker' => '/* testForWithoutBody */',
+ 'hasBody' => false,
+ 'hasNonEmptyBody' => false,
],
'for-empty-body' => [
- '/* testForEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testForEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'for-with-code' => [
- '/* testForWithCode */',
- true,
- true,
+ 'testMarker' => '/* testForWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'foreach-without-body' => [
- '/* testForEachWithoutBody */',
- false,
- false,
+ 'testMarker' => '/* testForEachWithoutBody */',
+ 'hasBody' => false,
+ 'hasNonEmptyBody' => false,
],
'foreach-empty-body' => [
- '/* testForEachEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testForEachEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'foreach-with-code' => [
- '/* testForEachWithCode */',
- true,
- true,
+ 'testMarker' => '/* testForEachWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'while-without-body' => [
- '/* testWhileWithoutBody */',
- false,
- false,
+ 'testMarker' => '/* testWhileWithoutBody */',
+ 'hasBody' => false,
+ 'hasNonEmptyBody' => false,
],
'while-empty-body' => [
- '/* testWhileEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testWhileEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'while-with-code' => [
- '/* testWhileWithCode */',
- true,
- true,
+ 'testMarker' => '/* testWhileWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'do-while-empty-body' => [
- '/* testDoWhileEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testDoWhileEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'do-while-with-code' => [
- '/* testDoWhileWithCode */',
- true,
- true,
+ 'testMarker' => '/* testDoWhileWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'switch-without-body' => [
- '/* testSwitchWithoutBody */',
- false,
- false,
+ 'testMarker' => '/* testSwitchWithoutBody */',
+ 'hasBody' => false,
+ 'hasNonEmptyBody' => false,
],
'switch-empty-body' => [
- '/* testSwitchEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testSwitchEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'switch-with-code' => [
- '/* testSwitchWithCode */',
- true,
- true,
+ 'testMarker' => '/* testSwitchWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'declare-without-body' => [
- '/* testDeclareWithoutBody */',
- false,
- false,
+ 'testMarker' => '/* testDeclareWithoutBody */',
+ 'hasBody' => false,
+ 'hasNonEmptyBody' => false,
],
'declare-empty-body' => [
- '/* testDeclareEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testDeclareEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'declare-with-code' => [
- '/* testDeclareWithCode */',
- true,
- true,
+ 'testMarker' => '/* testDeclareWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'alternative-syntax-if-empty-body' => [
- '/* testAlternativeIfEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testAlternativeIfEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'alternative-syntax-elseif-with-code' => [
- '/* testAlternativeElseIfWithCode */',
- true,
- true,
+ 'testMarker' => '/* testAlternativeElseIfWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'alternative-syntax-else-with-code' => [
- '/* testAlternativeElseWithCode */',
- true,
- true,
+ 'testMarker' => '/* testAlternativeElseWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'alternative-syntax-for-empty-body' => [
- '/* testAlternativeForEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testAlternativeForEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'alternative-syntax-for-with-code' => [
- '/* testAlternativeForWithCode */',
- true,
- true,
+ 'testMarker' => '/* testAlternativeForWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'alternative-syntax-foreach-empty-body' => [
- '/* testAlternativeForeachEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testAlternativeForeachEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'alternative-syntax-foreach-with-code' => [
- '/* testAlternativeForeachWithCode */',
- true,
- true,
+ 'testMarker' => '/* testAlternativeForeachWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'alternative-syntax-while-empty-body' => [
- '/* testAlternativeWhileEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testAlternativeWhileEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'alternative-syntax-while-with-code' => [
- '/* testAlternativeWhileWithCode */',
- true,
- true,
+ 'testMarker' => '/* testAlternativeWhileWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'alternative-syntax-switch-empty-body' => [
- '/* testAlternativeSwitchEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testAlternativeSwitchEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'alternative-syntax-switch-with-code' => [
- '/* testAlternativeSwitchWithCode */',
- true,
- true,
+ 'testMarker' => '/* testAlternativeSwitchWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'alternative-syntax-declare-empty-body' => [
- '/* testAlternativeDeclareEmptyBody */',
- true,
- false,
+ 'testMarker' => '/* testAlternativeDeclareEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
'alternative-syntax-declare-with-code' => [
- '/* testAlternativeDeclareWithCode */',
- true,
- true,
+ 'testMarker' => '/* testAlternativeDeclareWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'inline-if-with-code' => [
- '/* testInlineIfWithCode */',
- true,
- true,
+ 'testMarker' => '/* testInlineIfWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'inline-elseif-with-code' => [
- '/* testInlineElseIfWithCode */',
- true,
- true,
+ 'testMarker' => '/* testInlineElseIfWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'inline-else-with-code' => [
- '/* testInlineElseWithCode */',
- true,
- true,
+ 'testMarker' => '/* testInlineElseWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'inline-for-with-code' => [
- '/* testInlineForWithCode */',
- true,
- true,
+ 'testMarker' => '/* testInlineForWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'inline-foreach-with-code' => [
- '/* testInlineForEachWithCode */',
- true,
- true,
+ 'testMarker' => '/* testInlineForEachWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'inline-while-with-code' => [
- '/* testInlineWhileWithCode */',
- true,
- true,
+ 'testMarker' => '/* testInlineWhileWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
'inline-do-while-with-code' => [
- '/* testInlineDoWhileWithCode */',
- true,
- true,
+ 'testMarker' => '/* testInlineDoWhileWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
],
+
+ /*
+ * Match without body cannot be tested as, in that case, `match` will tokenize as `T_STRING`.
+ * Without body (`match();`), match will either yield a parse error
+ * or be interpreted as a function call (`\match();` or `self::match()` etc).
+ */
+
+ 'match-empty-body' => [
+ 'testMarker' => '/* testMatchEmptyBody */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
+ ],
+ 'match-empty-body-comment-only' => [
+ 'testMarker' => '/* testMatchEmptyBodyWithComment */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
+ ],
+ 'match-with-code' => [
+ 'testMarker' => '/* testMatchWithCode */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => true,
+ ],
+
'else-live-coding' => [
- '/* testElseLiveCoding */',
- true,
- false,
+ 'testMarker' => '/* testElseLiveCoding */',
+ 'hasBody' => true,
+ 'hasNonEmptyBody' => false,
],
];
}
diff --git a/Tests/Utils/ControlStructures/IsElseIfTest.php b/Tests/Utils/ControlStructures/IsElseIfTest.php
index d25dfb2a..cc63b327 100644
--- a/Tests/Utils/ControlStructures/IsElseIfTest.php
+++ b/Tests/Utils/ControlStructures/IsElseIfTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class IsElseIfTest extends UtilityMethodTestCase
+final class IsElseIfTest extends UtilityMethodTestCase
{
/**
@@ -74,59 +74,59 @@ public function dataIsElseIf()
{
return [
'if' => [
- '/* testIf */',
- false,
+ 'testMarker' => '/* testIf */',
+ 'expected' => false,
],
'elseif' => [
- '/* testElseIf */',
- true,
+ 'testMarker' => '/* testElseIf */',
+ 'expected' => true,
],
'else-if' => [
- '/* testElseSpaceIf */',
- true,
+ 'testMarker' => '/* testElseSpaceIf */',
+ 'expected' => true,
],
'else-if-with-comment-else' => [
- '/* testElseCommentIfElse */',
- true,
+ 'testMarker' => '/* testElseCommentIfElse */',
+ 'expected' => true,
],
'else-if-with-comment-if' => [
- '/* testElseCommentIfIf */',
- true,
+ 'testMarker' => '/* testElseCommentIfIf */',
+ 'expected' => true,
],
'else' => [
- '/* testElse */',
- false,
+ 'testMarker' => '/* testElse */',
+ 'expected' => false,
],
'alternative-syntax-if' => [
- '/* testAlternativeIf */',
- false,
+ 'testMarker' => '/* testAlternativeIf */',
+ 'expected' => false,
],
'alternative-syntax-elseif' => [
- '/* testAlternativeElseIf */',
- true,
+ 'testMarker' => '/* testAlternativeElseIf */',
+ 'expected' => true,
],
'alternative-syntax-else' => [
- '/* testAlternativeElse */',
- false,
+ 'testMarker' => '/* testAlternativeElse */',
+ 'expected' => false,
],
'inline-if' => [
- '/* testInlineIf */',
- false,
+ 'testMarker' => '/* testInlineIf */',
+ 'expected' => false,
],
'inline-elseif' => [
- '/* testInlineElseIf */',
- true,
+ 'testMarker' => '/* testInlineElseIf */',
+ 'expected' => true,
],
'inline-else' => [
- '/* testInlineElse */',
- false,
+ 'testMarker' => '/* testInlineElse */',
+ 'expected' => false,
],
'live-coding' => [
- '/* testLiveCoding */',
- false,
+ 'testMarker' => '/* testLiveCoding */',
+ 'expected' => false,
],
];
}
diff --git a/Tests/Utils/FunctionDeclarations/GetParametersDiffTest.inc b/Tests/Utils/FunctionDeclarations/GetParametersDiffTest.inc
index 0b8c0af4..d9f8c995 100644
--- a/Tests/Utils/FunctionDeclarations/GetParametersDiffTest.inc
+++ b/Tests/Utils/FunctionDeclarations/GetParametersDiffTest.inc
@@ -1,3 +1,8 @@
7, // Offset from the T_FUNCTION token.
+ 'name' => '$var',
+ 'content' => '?true $var = true',
+ 'default' => 'true',
+ 'default_token' => 11, // Offset from the T_FUNCTION token.
+ 'default_equal_token' => 9, // Offset from the T_FUNCTION token.
+ 'has_attributes' => false,
+ 'pass_by_reference' => false,
+ 'reference_token' => false,
+ 'variable_length' => false,
+ 'variadic_token' => false,
+ 'type_hint' => '?true',
+ 'type_hint_token' => 5, // Offset from the T_FUNCTION token.
+ 'type_hint_end_token' => 5, // Offset from the T_FUNCTION token.
+ 'nullable_type' => true,
+ 'comma_token' => false,
+ ];
+
+ $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected);
+ }
+
+ /**
+ * Verify recognition of PHP 8.2 type declaration with (illegal) type false combined with type true.
+ *
+ * @return void
+ */
+ public function testPHP82PseudoTypeFalseAndTrue()
+ {
+ $expected = [];
+ $expected[0] = [
+ 'token' => 8, // Offset from the T_FUNCTION token.
+ 'name' => '$var',
+ 'content' => 'true|false $var = true',
+ 'default' => 'true',
+ 'default_token' => 12, // Offset from the T_FUNCTION token.
+ 'default_equal_token' => 10, // Offset from the T_FUNCTION token.
+ 'has_attributes' => false,
+ 'pass_by_reference' => false,
+ 'reference_token' => false,
+ 'variable_length' => false,
+ 'variadic_token' => false,
+ 'type_hint' => 'true|false',
+ 'type_hint_token' => 4, // Offset from the T_FUNCTION token.
+ 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token.
+ 'nullable_type' => false,
+ 'comma_token' => false,
+ ];
+
+ $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected);
+ }
+
+ /**
+ * Test helper.
+ *
+ * @param string $marker The comment which preceeds the test.
+ * @param array $expected The expected function output.
+ * @param array $targetType Optional. The token type to search for after $marker.
+ * Defaults to the function/closure/arrow tokens.
+ *
+ * @return void
+ */
+ protected function getMethodParametersTestHelper($marker, $expected, $targetType = [\T_FUNCTION, \T_CLOSURE, \T_FN])
+ {
+ $target = $this->getTargetToken($marker, $targetType);
+ $found = FunctionDeclarations::getParameters(self::$phpcsFile, $target);
+ $expected = $this->updateExpectedTokenPositions($target, $expected);
+
+ $this->assertSame($expected, $found);
+ }
+
+ /**
+ * Test helper to translate token offsets to absolute positions in an "expected" array.
+ *
+ * @param string $targetPtr The token pointer to the target token from which the offset is calculated.
+ * @param array $expected The expected function output containing offsets.
+ *
+ * @return array
+ */
+ private function updateExpectedTokenPositions($targetPtr, $expected)
+ {
+ foreach ($expected as $key => $param) {
+ $expected[$key]['token'] += $targetPtr;
+
+ if ($param['reference_token'] !== false) {
+ $expected[$key]['reference_token'] += $targetPtr;
+ }
+ if ($param['variadic_token'] !== false) {
+ $expected[$key]['variadic_token'] += $targetPtr;
+ }
+ if ($param['type_hint_token'] !== false) {
+ $expected[$key]['type_hint_token'] += $targetPtr;
+ }
+ if ($param['type_hint_end_token'] !== false) {
+ $expected[$key]['type_hint_end_token'] += $targetPtr;
+ }
+ if ($param['comma_token'] !== false) {
+ $expected[$key]['comma_token'] += $targetPtr;
+ }
+ if (isset($param['default_token'])) {
+ $expected[$key]['default_token'] += $targetPtr;
+ }
+ if (isset($param['default_equal_token'])) {
+ $expected[$key]['default_equal_token'] += $targetPtr;
+ }
+ if (isset($param['visibility_token'])) {
+ $expected[$key]['visibility_token'] += $targetPtr;
+ }
+ if (isset($param['readonly_token'])) {
+ $expected[$key]['readonly_token'] += $targetPtr;
+ }
+ }
+
+ return $expected;
+ }
+
+ /**
+ * Verify that the build-in caching is used when caching is enabled.
+ *
+ * @return void
+ */
+ public function testResultIsCached()
+ {
+ // The test case used is specifically selected to be one which will always reach the cache check.
+ $methodName = 'PHPCSUtils\\Utils\\FunctionDeclarations::getParameters';
+ $testMarker = '/* testPHP82PseudoTypeTrue */';
+ $expected = [
+ 0 => [
+ 'token' => 7, // Offset from the T_FUNCTION token.
+ 'name' => '$var',
+ 'content' => '?true $var = true',
+ 'default' => 'true',
+ 'default_token' => 11, // Offset from the T_FUNCTION token.
+ 'default_equal_token' => 9, // Offset from the T_FUNCTION token.
+ 'has_attributes' => false,
+ 'pass_by_reference' => false,
+ 'reference_token' => false,
+ 'variable_length' => false,
+ 'variadic_token' => false,
+ 'type_hint' => '?true',
+ 'type_hint_token' => 5, // Offset from the T_FUNCTION token.
+ 'type_hint_end_token' => 5, // Offset from the T_FUNCTION token.
+ 'nullable_type' => true,
+ 'comma_token' => false,
+ ],
+ ];
+
+ $stackPtr = $this->getTargetToken($testMarker, Collections::functionDeclarationTokens());
+ $expected = $this->updateExpectedTokenPositions($stackPtr, $expected);
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = FunctionDeclarations::getParameters(self::$phpcsFile, $stackPtr);
+ $isCached = Cache::isCached(self::$phpcsFile, $methodName, $stackPtr);
+ $resultSecondRun = FunctionDeclarations::getParameters(self::$phpcsFile, $stackPtr);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertSame($expected, $resultFirstRun, 'First result did not match expectation');
+ $this->assertTrue($isCached, 'Cache::isCached() could not find the cached value');
+ $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+ }
}
diff --git a/Tests/Utils/FunctionDeclarations/GetParametersParseError1Test.php b/Tests/Utils/FunctionDeclarations/GetParametersParseError1Test.php
index 2efd50cc..e914a62b 100644
--- a/Tests/Utils/FunctionDeclarations/GetParametersParseError1Test.php
+++ b/Tests/Utils/FunctionDeclarations/GetParametersParseError1Test.php
@@ -11,6 +11,7 @@
namespace PHPCSUtils\Tests\Utils\FunctionDeclarations;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
use PHPCSUtils\Utils\FunctionDeclarations;
/**
@@ -22,7 +23,7 @@
*
* @since 1.0.0
*/
-class GetParametersParseError1Test extends UtilityMethodTestCase
+final class GetParametersParseError1Test extends UtilityMethodTestCase
{
/**
@@ -54,7 +55,7 @@ public static function setUpTestFile()
*/
public function testParseError()
{
- $target = $this->getTargetToken('/* testParseError */', [\T_FUNCTION, \T_CLOSURE]);
+ $target = $this->getTargetToken('/* testParseError */', Collections::functionDeclarationTokens());
$result = FunctionDeclarations::getParameters(self::$phpcsFile, $target);
$this->assertSame([], $result);
diff --git a/Tests/Utils/FunctionDeclarations/GetParametersParseError2Test.php b/Tests/Utils/FunctionDeclarations/GetParametersParseError2Test.php
index ebefed1d..edc7335b 100644
--- a/Tests/Utils/FunctionDeclarations/GetParametersParseError2Test.php
+++ b/Tests/Utils/FunctionDeclarations/GetParametersParseError2Test.php
@@ -11,6 +11,7 @@
namespace PHPCSUtils\Tests\Utils\FunctionDeclarations;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
use PHPCSUtils\Utils\FunctionDeclarations;
/**
@@ -22,7 +23,7 @@
*
* @since 1.0.0
*/
-class GetParametersParseError2Test extends UtilityMethodTestCase
+final class GetParametersParseError2Test extends UtilityMethodTestCase
{
/**
@@ -54,7 +55,7 @@ public static function setUpTestFile()
*/
public function testParseError()
{
- $target = $this->getTargetToken('/* testParseError */', [\T_FUNCTION, \T_CLOSURE]);
+ $target = $this->getTargetToken('/* testParseError */', Collections::functionDeclarationTokens());
$result = FunctionDeclarations::getParameters(self::$phpcsFile, $target);
$this->assertSame([], $result);
diff --git a/Tests/Utils/FunctionDeclarations/GetParametersTest.php b/Tests/Utils/FunctionDeclarations/GetParametersTest.php
index ff5e7b8d..43e779f1 100644
--- a/Tests/Utils/FunctionDeclarations/GetParametersTest.php
+++ b/Tests/Utils/FunctionDeclarations/GetParametersTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetParametersTest extends BCFile_GetMethodParametersTest
+final class GetParametersTest extends BCFile_GetMethodParametersTest
{
/**
@@ -89,11 +89,11 @@ public function testInvalidUse($identifier)
*
* @param string $commentString The comment which preceeds the test.
* @param array $targetTokenType Optional. The token type to search for after $commentString.
- * Defaults to the function/closure tokens.
+ * Defaults to the function/closure/arrow tokens.
*
* @return void
*/
- public function testNoParams($commentString, $targetTokenType = [\T_FUNCTION, \T_CLOSURE])
+ public function testNoParams($commentString, $targetTokenType = [\T_FUNCTION, \T_CLOSURE, \T_FN])
{
$target = $this->getTargetToken($commentString, $targetTokenType);
$result = FunctionDeclarations::getParameters(self::$phpcsFile, $target);
@@ -104,16 +104,16 @@ public function testNoParams($commentString, $targetTokenType = [\T_FUNCTION, \T
/**
* Test helper.
*
- * @param string $commentString The comment which preceeds the test.
- * @param array $expected The expected function output.
- * @param array $targetType Optional. The token type to search for after $commentString.
- * Defaults to the function/closure tokens.
+ * @param string $marker The comment which preceeds the test.
+ * @param array $expected The expected function output.
+ * @param array $targetType Optional. The token type to search for after $marker.
+ * Defaults to the function/closure/arrow tokens.
*
* @return void
*/
- protected function getMethodParametersTestHelper($commentString, $expected, $targetType = [\T_FUNCTION, \T_CLOSURE])
+ protected function getMethodParametersTestHelper($marker, $expected, $targetType = [\T_FUNCTION, \T_CLOSURE, \T_FN])
{
- $target = $this->getTargetToken($commentString, $targetType);
+ $target = $this->getTargetToken($marker, $targetType);
$found = FunctionDeclarations::getParameters(self::$phpcsFile, $target);
foreach ($expected as $key => $param) {
@@ -140,6 +140,12 @@ protected function getMethodParametersTestHelper($commentString, $expected, $tar
if (isset($param['default_equal_token'])) {
$expected[$key]['default_equal_token'] += $target;
}
+ if (isset($param['visibility_token'])) {
+ $expected[$key]['visibility_token'] += $target;
+ }
+ if (isset($param['readonly_token'])) {
+ $expected[$key]['readonly_token'] += $target;
+ }
}
$this->assertSame($expected, $found);
diff --git a/Tests/Utils/FunctionDeclarations/GetPropertiesDiffTest.inc b/Tests/Utils/FunctionDeclarations/GetPropertiesDiffTest.inc
index 34138d72..e78b70e9 100644
--- a/Tests/Utils/FunctionDeclarations/GetPropertiesDiffTest.inc
+++ b/Tests/Utils/FunctionDeclarations/GetPropertiesDiffTest.inc
@@ -18,7 +18,9 @@ trait FooTrait {
}
}
-/* testReturnTypeEndTokenIndex */
-function myFunction(): ?\MyNamespace /* comment */
- \MyClass // comment
- \Foo {}
+/* testPHP82PseudoTypeTrue */
+function pseudoTypeTrue(): ?true {}
+
+/* testPHP82PseudoTypeFalseAndTrue */
+// Intentional fatal error - Type contains both true and false, bool should be used instead, but that's not the concern of the method.
+function pseudoTypeFalseAndTrue(): true|false {}
diff --git a/Tests/Utils/FunctionDeclarations/GetPropertiesDiffTest.php b/Tests/Utils/FunctionDeclarations/GetPropertiesDiffTest.php
index 8fee9566..1a0755a6 100644
--- a/Tests/Utils/FunctionDeclarations/GetPropertiesDiffTest.php
+++ b/Tests/Utils/FunctionDeclarations/GetPropertiesDiffTest.php
@@ -25,7 +25,7 @@
*
* @since 1.0.0
*/
-class GetPropertiesDiffTest extends UtilityMethodTestCase
+final class GetPropertiesDiffTest extends UtilityMethodTestCase
{
/**
@@ -87,18 +87,18 @@ public function testMessyPhpcsAnnotationsStaticClosure()
}
/**
- * Test that the new "return_type_end_token" index is set correctly.
+ * Verify recognition of PHP 8.2 stand-alone `true` type.
*
* @return void
*/
- public function testReturnTypeEndTokenIndex()
+ public function testPHP82PseudoTypeTrue()
{
$expected = [
'scope' => 'public',
'scope_specified' => false,
- 'return_type' => '?\MyNamespace\MyClass\Foo',
+ 'return_type' => '?true',
'return_type_token' => 8, // Offset from the T_FUNCTION token.
- 'return_type_end_token' => 20, // Offset from the T_FUNCTION token.
+ 'return_type_end_token' => 8, // Offset from the T_FUNCTION token.
'nullable_return_type' => true,
'is_abstract' => false,
'is_final' => false,
@@ -109,17 +109,45 @@ public function testReturnTypeEndTokenIndex()
$this->getPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected);
}
+ /**
+ * Verify recognition of PHP 8.2 type declaration with (illegal) type false combined with type true.
+ *
+ * @return void
+ */
+ public function testPHP82PseudoTypeFalseAndTrue()
+ {
+ $expected = [
+ 'scope' => 'public',
+ 'scope_specified' => false,
+ 'return_type' => 'true|false',
+ 'return_type_token' => 7, // Offset from the T_FUNCTION token.
+ 'return_type_end_token' => 9, // Offset from the T_FUNCTION token.
+ 'nullable_return_type' => false,
+ 'is_abstract' => false,
+ 'is_final' => false,
+ 'is_static' => false,
+ 'has_body' => true,
+ ];
+
+ $this->getPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected);
+ }
+
/**
* Test helper.
*
* @param string $commentString The comment which preceeds the test.
* @param array $expected The expected function output.
+ * @param array $targetType Optional. The token type to search for after $commentString.
+ * Defaults to the function/closure tokens.
*
* @return void
*/
- protected function getPropertiesTestHelper($commentString, $expected)
- {
- $function = $this->getTargetToken($commentString, [\T_FUNCTION, \T_CLOSURE]);
+ protected function getPropertiesTestHelper(
+ $commentString,
+ $expected,
+ $targetType = [\T_FUNCTION, \T_CLOSURE, \T_FN]
+ ) {
+ $function = $this->getTargetToken($commentString, $targetType);
$found = FunctionDeclarations::getProperties(self::$phpcsFile, $function);
if ($expected['return_type_token'] !== false) {
diff --git a/Tests/Utils/FunctionDeclarations/GetPropertiesTest.php b/Tests/Utils/FunctionDeclarations/GetPropertiesTest.php
index 83bafbad..aa0f172e 100644
--- a/Tests/Utils/FunctionDeclarations/GetPropertiesTest.php
+++ b/Tests/Utils/FunctionDeclarations/GetPropertiesTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetPropertiesTest extends BCFile_GetMethodPropertiesTest
+final class GetPropertiesTest extends BCFile_GetMethodPropertiesTest
{
/**
@@ -75,23 +75,20 @@ public function testNotAFunctionException($commentString, $targetTokenType)
*
* @return void
*/
- protected function getMethodPropertiesTestHelper($commentString, $expected, $targetType = [\T_FUNCTION, \T_CLOSURE])
- {
+ protected function getMethodPropertiesTestHelper(
+ $commentString,
+ $expected,
+ $targetType = [\T_FUNCTION, \T_CLOSURE, \T_FN]
+ ) {
$function = $this->getTargetToken($commentString, $targetType);
$found = FunctionDeclarations::getProperties(self::$phpcsFile, $function);
if ($expected['return_type_token'] !== false) {
$expected['return_type_token'] += $function;
}
-
- /*
- * Test the new `return_type_end_token` key which is not in the original datasets.
- */
- $this->assertArrayHasKey('return_type_end_token', $found);
- $this->assertTrue($found['return_type_end_token'] === false || \is_int($found['return_type_end_token']));
-
- // Remove the array key before doing the compare against the original dataset.
- unset($found['return_type_end_token']);
+ if ($expected['return_type_end_token'] !== false) {
+ $expected['return_type_end_token'] += $function;
+ }
$this->assertSame($expected, $found);
}
diff --git a/Tests/Utils/FunctionDeclarations/IsArrowFunction2926Test.php b/Tests/Utils/FunctionDeclarations/IsArrowFunction2926Test.php
index ca2431fd..17ced8a2 100644
--- a/Tests/Utils/FunctionDeclarations/IsArrowFunction2926Test.php
+++ b/Tests/Utils/FunctionDeclarations/IsArrowFunction2926Test.php
@@ -11,8 +11,7 @@
namespace PHPCSUtils\Tests\Utils\FunctionDeclarations;
use PHPCSUtils\BackCompat\Helper;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
-use PHPCSUtils\Tokens\Collections;
+use PHPCSUtils\Tests\PolyfilledTestCase;
use PHPCSUtils\Utils\FunctionDeclarations;
/**
@@ -22,7 +21,7 @@
*
* These tests are based on the `Tokenizer/BackfillFnTokenTest` file in PHPCS itself.
*
- * @link https://github.com/squizlabs/php_codesniffer/issues/2926
+ * @link https://github.com/squizlabs/PHP_CodeSniffer/issues/2926
*
* @covers \PHPCSUtils\Utils\FunctionDeclarations::isArrowFunction
* @covers \PHPCSUtils\Utils\FunctionDeclarations::getArrowFunctionOpenClose
@@ -31,7 +30,7 @@
*
* @since 1.0.0
*/
-class IsArrowFunction2926Test extends UtilityMethodTestCase
+final class IsArrowFunction2926Test extends PolyfilledTestCase
{
/**
@@ -94,6 +93,18 @@ public function setUpTestFileForReal()
}
}
+ /**
+ * Reset static properties to their default value after the tests have finished.
+ *
+ * @afterClass
+ *
+ * @return void
+ */
+ public static function resetProperties()
+ {
+ self::$tokenized = false;
+ }
+
/**
* Test correctly detecting arrow functions.
*
@@ -108,7 +119,13 @@ public function setUpTestFileForReal()
*/
public function testIsArrowFunction($testMarker, $expected, $targetContent = null)
{
- $targets = Collections::arrowFunctionTokensBC();
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'FunctionDeclarations::isArrowFunction() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the `T_FN` token instead.'
+ );
+
+ $targets = [\T_FN, \T_STRING];
$stackPtr = $this->getTargetToken($testMarker, $targets, $targetContent);
$result = FunctionDeclarations::isArrowFunction(self::$phpcsFile, $stackPtr);
$this->assertSame($expected['is'], $result);
@@ -128,11 +145,17 @@ public function testIsArrowFunction($testMarker, $expected, $targetContent = nul
*/
public function testGetArrowFunctionOpenClose($testMarker, $expected, $targetContent = 'fn')
{
- $targets = Collections::arrowFunctionTokensBC();
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'FunctionDeclarations::getArrowFunctionOpenClose() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the `T_FN` token instead.'
+ );
+
+ $targets = [\T_FN, \T_STRING];
$stackPtr = $this->getTargetToken($testMarker, $targets, $targetContent);
// Change from offsets to absolute token positions.
- if ($expected['get'] != false) {
+ if ($expected['get'] !== false) {
foreach ($expected['get'] as $key => $value) {
$expected['get'][$key] += $stackPtr;
}
@@ -154,8 +177,8 @@ public function dataArrowFunction()
{
return [
'arrow-function-returning-heredoc' => [
- '/* testHeredoc */',
- [
+ 'testMarker' => '/* testHeredoc */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -166,8 +189,8 @@ public function dataArrowFunction()
],
],
'arrow-function-returning-nowdoc' => [
- '/* testNowdoc */',
- [
+ 'testMarker' => '/* testNowdoc */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
diff --git a/Tests/Utils/FunctionDeclarations/IsArrowFunctionTest.inc b/Tests/Utils/FunctionDeclarations/IsArrowFunctionTest.inc
index 37b96680..733cb236 100644
--- a/Tests/Utils/FunctionDeclarations/IsArrowFunctionTest.inc
+++ b/Tests/Utils/FunctionDeclarations/IsArrowFunctionTest.inc
@@ -61,9 +61,15 @@ $a = fn($x) => yield 'k' => $x;
/* testReturnTypeNamespacedClass */
$fn = fn($x) : ?\My\NS\ClassName => $x;
+/* testReturnTypePartiallyQualifiedClass */
+$fn = fn($x) : ?NS\ClassName => $x;
+
/* testReturnTypeNullableFQNClass */
$a = fn(?\DateTime $x) : ?\DateTime => $x;
+/* testNamespaceOperatorInTypes */
+$fn = fn(namespace\Foo $a) : ?namespace\Foo => $a;
+
/* testReturnTypeSelf */
$fn = fn(self $a) : ?self => $a;
@@ -76,6 +82,15 @@ $fn = fn(callable $a) : callable => $a;
/* testReturnTypeArray */
$fn = fn(array $a) : array => $a;
+/* testReturnTypeStatic */
+$fn = fn(array $a) : static => $a;
+
+/* testUnionParamType */
+$arrowWithUnionParam = fn(int|float $param) : SomeClass => new SomeClass($param);
+
+/* testUnionReturnType */
+$arrowWithUnionReturn = fn($param) : int|float => $param | 10;
+
/* testReturnTypeArrayBug2773 */
$fn = fn(): array => [a($a, $b)];
@@ -144,6 +159,9 @@ $a = MyNS\Sub\Fn($param);
/* testNonArrowNamespaceOperatorFunctionCall */
$a = namespace\fn($param);
+/* testNonArrowFunctionNameWithUnionTypes */
+function &fn(int|float $param) : string|null {}
+
/* testLiveCoding */
// Intentional parse error. This has to be the last test in the file.
$fn = fn
diff --git a/Tests/Utils/FunctionDeclarations/IsArrowFunctionTest.php b/Tests/Utils/FunctionDeclarations/IsArrowFunctionTest.php
index 06ee6265..6c4cb85a 100644
--- a/Tests/Utils/FunctionDeclarations/IsArrowFunctionTest.php
+++ b/Tests/Utils/FunctionDeclarations/IsArrowFunctionTest.php
@@ -10,8 +10,7 @@
namespace PHPCSUtils\Tests\Utils\FunctionDeclarations;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
-use PHPCSUtils\Tokens\Collections;
+use PHPCSUtils\Tests\PolyfilledTestCase;
use PHPCSUtils\Utils\FunctionDeclarations;
/**
@@ -27,7 +26,7 @@
*
* @since 1.0.0
*/
-class IsArrowFunctionTest extends UtilityMethodTestCase
+final class IsArrowFunctionTest extends PolyfilledTestCase
{
/**
@@ -37,6 +36,12 @@ class IsArrowFunctionTest extends UtilityMethodTestCase
*/
public function testNonExistentToken()
{
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'FunctionDeclarations::isArrowFunction() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the `T_FN` token instead.'
+ );
+
$result = FunctionDeclarations::isArrowFunction(self::$phpcsFile, 10000);
$this->assertFalse($result, 'Failed isArrowFunction() test');
@@ -51,6 +56,12 @@ public function testNonExistentToken()
*/
public function testUnsupportedToken()
{
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'FunctionDeclarations::isArrowFunction() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the `T_FN` token instead.'
+ );
+
$stackPtr = $this->getTargetToken('/* testConstantDeclaration */', \T_CONST);
$result = FunctionDeclarations::isArrowFunction(self::$phpcsFile, $stackPtr);
@@ -67,6 +78,12 @@ public function testUnsupportedToken()
*/
public function testTStringNotFn()
{
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'FunctionDeclarations::isArrowFunction() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the `T_FN` token instead.'
+ );
+
$stackPtr = $this->getTargetToken('/* testNotTheRightContent */', \T_STRING);
$result = FunctionDeclarations::isArrowFunction(self::$phpcsFile, $stackPtr);
@@ -85,12 +102,25 @@ public function testTStringNotFn()
* @param array $expected The expected return value for the respective functions.
* @param array $targetContent The content for the target token to look for in case there could
* be confusion.
+ * @param bool $skipOnPHP8 Optional. Whether the test should be skipped when the PHP 8 identifier
+ * name tokenization is used (as the target token won't exist).
+ * Defaults to `false`.
*
* @return void
*/
- public function testIsArrowFunction($testMarker, $expected, $targetContent = null)
+ public function testIsArrowFunction($testMarker, $expected, $targetContent = null, $skipOnPHP8 = false)
{
- $targets = Collections::arrowFunctionTokensBC();
+ if ($skipOnPHP8 === true && parent::usesPhp8NameTokens() === true) {
+ $this->markTestSkipped("PHP 8.0 identifier name tokenization used. Target token won't exist.");
+ }
+
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'FunctionDeclarations::isArrowFunction() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the `T_FN` token instead.'
+ );
+
+ $targets = [\T_FN, \T_STRING];
$stackPtr = $this->getTargetToken($testMarker, $targets, $targetContent);
$result = FunctionDeclarations::isArrowFunction(self::$phpcsFile, $stackPtr);
$this->assertSame($expected['is'], $result);
@@ -105,16 +135,29 @@ public function testIsArrowFunction($testMarker, $expected, $targetContent = nul
* @param array $expected The expected return value for the respective functions.
* @param string $targetContent The content for the target token to look for in case there could
* be confusion.
+ * @param bool $skipOnPHP8 Optional. Whether the test should be skipped when the PHP 8 identifier
+ * name tokenization is used (as the target token won't exist).
+ * Defaults to `false`.
*
* @return void
*/
- public function testGetArrowFunctionOpenClose($testMarker, $expected, $targetContent = 'fn')
+ public function testGetArrowFunctionOpenClose($testMarker, $expected, $targetContent = 'fn', $skipOnPHP8 = false)
{
- $targets = Collections::arrowFunctionTokensBC();
+ if ($skipOnPHP8 === true && parent::usesPhp8NameTokens() === true) {
+ $this->markTestSkipped("PHP 8.0 identifier name tokenization used. Target token won't exist.");
+ }
+
+ $this->expectDeprecation();
+ $this->expectDeprecationMessage(
+ 'FunctionDeclarations::getArrowFunctionOpenClose() function is deprecated since PHPCSUtils 1.0.0-alpha4.'
+ . ' Use the `T_FN` token instead.'
+ );
+
+ $targets = [\T_FN, \T_STRING];
$stackPtr = $this->getTargetToken($testMarker, $targets, $targetContent);
// Change from offsets to absolute token positions.
- if ($expected['get'] != false) {
+ if ($expected['get'] !== false) {
foreach ($expected['get'] as $key => $value) {
$expected['get'][$key] += $stackPtr;
}
@@ -134,10 +177,12 @@ public function testGetArrowFunctionOpenClose($testMarker, $expected, $targetCon
*/
public function dataArrowFunction()
{
+ $php8Names = parent::usesPhp8NameTokens();
+
return [
'arrow-function-standard' => [
- '/* testStandard */',
- [
+ 'testMarker' => '/* testStandard */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -148,8 +193,8 @@ public function dataArrowFunction()
],
],
'arrow-function-mixed-case' => [
- '/* testMixedCase */',
- [
+ 'testMarker' => '/* testMixedCase */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -158,11 +203,11 @@ public function dataArrowFunction()
'scope_closer' => 12,
],
],
- 'Fn',
+ 'targetContent' => 'Fn',
],
'arrow-function-with-whitespace' => [
- '/* testWhitespace */',
- [
+ 'testMarker' => '/* testWhitespace */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 2,
@@ -173,8 +218,8 @@ public function dataArrowFunction()
],
],
'arrow-function-with-comment' => [
- '/* testComment */',
- [
+ 'testMarker' => '/* testComment */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 4,
@@ -185,15 +230,15 @@ public function dataArrowFunction()
],
],
'non-arrow-function-global-function-declaration' => [
- '/* testFunctionName */',
- [
+ 'testMarker' => '/* testFunctionName */',
+ 'expected' => [
'is' => false,
'get' => false,
],
],
'arrow-function-nested-outer' => [
- '/* testNestedOuter */',
- [
+ 'testMarker' => '/* testNestedOuter */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -204,8 +249,8 @@ public function dataArrowFunction()
],
],
'arrow-function-nested-inner' => [
- '/* testNestedInner */',
- [
+ 'testMarker' => '/* testNestedInner */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -216,8 +261,8 @@ public function dataArrowFunction()
],
],
'arrow-function-function-call' => [
- '/* testFunctionCall */',
- [
+ 'testMarker' => '/* testFunctionCall */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -228,8 +273,8 @@ public function dataArrowFunction()
],
],
'arrow-function-chained-function-call' => [
- '/* testChainedFunctionCall */',
- [
+ 'testMarker' => '/* testChainedFunctionCall */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -238,11 +283,11 @@ public function dataArrowFunction()
'scope_closer' => 12,
],
],
- 'fn',
+ 'targetContent' => 'fn',
],
'arrow-function-as-function-argument' => [
- '/* testFunctionArgument */',
- [
+ 'testMarker' => '/* testFunctionArgument */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -253,8 +298,8 @@ public function dataArrowFunction()
],
],
'arrow-function-nested-closure' => [
- '/* testClosure */',
- [
+ 'testMarker' => '/* testClosure */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -265,8 +310,8 @@ public function dataArrowFunction()
],
],
'arrow-function-with-return-type-nullable-int' => [
- '/* testReturnTypeNullableInt */',
- [
+ 'testMarker' => '/* testReturnTypeNullableInt */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -277,8 +322,8 @@ public function dataArrowFunction()
],
],
'arrow-function-with-reference' => [
- '/* testReference */',
- [
+ 'testMarker' => '/* testReference */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 2,
@@ -289,8 +334,8 @@ public function dataArrowFunction()
],
],
'arrow-function-grouped-within-parenthesis' => [
- '/* testGrouped */',
- [
+ 'testMarker' => '/* testGrouped */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -301,8 +346,8 @@ public function dataArrowFunction()
],
],
'arrow-function-as-array-value' => [
- '/* testArrayValue */',
- [
+ 'testMarker' => '/* testArrayValue */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -313,8 +358,8 @@ public function dataArrowFunction()
],
],
'arrow-function-with-yield-in-value' => [
- '/* testYield */',
- [
+ 'testMarker' => '/* testYield */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -325,32 +370,56 @@ public function dataArrowFunction()
],
],
'arrow-function-with-return-type-nullable-namespaced-class' => [
- '/* testReturnTypeNamespacedClass */',
- [
+ 'testMarker' => '/* testReturnTypeNamespacedClass */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
'parenthesis_closer' => 3,
- 'scope_opener' => 15,
- 'scope_closer' => 18,
+ 'scope_opener' => ($php8Names === true) ? 10 : 15,
+ 'scope_closer' => ($php8Names === true) ? 13 : 18,
+ ],
+ ],
+ ],
+ 'arrow-function-with-return-type-nullable-partially-qualified-class' => [
+ 'testMarker' => '/* testReturnTypePartiallyQualifiedClass */',
+ 'expected' => [
+ 'is' => true,
+ 'get' => [
+ 'parenthesis_opener' => 1,
+ 'parenthesis_closer' => 3,
+ 'scope_opener' => ($php8Names === true) ? 10 : 12,
+ 'scope_closer' => ($php8Names === true) ? 13 : 15,
],
],
],
'arrow-function-with-fqn-class' => [
- '/* testReturnTypeNullableFQNClass */',
- [
+ 'testMarker' => '/* testReturnTypeNullableFQNClass */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
- 'parenthesis_closer' => 7,
- 'scope_opener' => 15,
- 'scope_closer' => 18,
+ 'parenthesis_closer' => ($php8Names === true) ? 6 : 7,
+ 'scope_opener' => ($php8Names === true) ? 13 : 15,
+ 'scope_closer' => ($php8Names === true) ? 16 : 18,
+ ],
+ ],
+ ],
+ 'arrow-function-with-namespace-operator-in-types' => [
+ 'testMarker' => '/* testNamespaceOperatorInTypes */',
+ 'expected' => [
+ 'is' => true,
+ 'get' => [
+ 'parenthesis_opener' => 1,
+ 'parenthesis_closer' => ($php8Names === true) ? 5 : 7,
+ 'scope_opener' => ($php8Names === true) ? 12 : 16,
+ 'scope_closer' => ($php8Names === true) ? 15 : 19,
],
],
],
'arrow-function-with-return-type-nullable-self' => [
- '/* testReturnTypeSelf */',
- [
+ 'testMarker' => '/* testReturnTypeSelf */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -361,8 +430,8 @@ public function dataArrowFunction()
],
],
'arrow-function-with-return-type-parent' => [
- '/* testReturnTypeParent */',
- [
+ 'testMarker' => '/* testReturnTypeParent */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -373,8 +442,8 @@ public function dataArrowFunction()
],
],
'arrow-function-with-return-type-callable' => [
- '/* testReturnTypeCallable */',
- [
+ 'testMarker' => '/* testReturnTypeCallable */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -385,8 +454,20 @@ public function dataArrowFunction()
],
],
'arrow-function-with-return-type-array' => [
- '/* testReturnTypeArray */',
- [
+ 'testMarker' => '/* testReturnTypeArray */',
+ 'expected' => [
+ 'is' => true,
+ 'get' => [
+ 'parenthesis_opener' => 1,
+ 'parenthesis_closer' => 5,
+ 'scope_opener' => 11,
+ 'scope_closer' => 14,
+ ],
+ ],
+ ],
+ 'arrow-function-with-return-type-static' => [
+ 'testMarker' => '/* testReturnTypeStatic */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -396,9 +477,34 @@ public function dataArrowFunction()
],
],
],
+
+ 'arrow-function-with-union-param-type' => [
+ 'testMarker' => '/* testUnionParamType */',
+ 'expected' => [
+ 'is' => true,
+ 'get' => [
+ 'parenthesis_opener' => 1,
+ 'parenthesis_closer' => 7,
+ 'scope_opener' => 13,
+ 'scope_closer' => 21,
+ ],
+ ],
+ ],
+ 'arrow-function-with-union-return-type' => [
+ 'testMarker' => '/* testUnionReturnType */',
+ 'expected' => [
+ 'is' => true,
+ 'get' => [
+ 'parenthesis_opener' => 1,
+ 'parenthesis_closer' => 3,
+ 'scope_opener' => 11,
+ 'scope_closer' => 18,
+ ],
+ ],
+ ],
'arrow-function-with-return-type-array-bug-2773' => [
- '/* testReturnTypeArrayBug2773 */',
- [
+ 'testMarker' => '/* testReturnTypeArrayBug2773 */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -409,8 +515,8 @@ public function dataArrowFunction()
],
],
'arrow-function-with-array-param-and-return-type' => [
- '/* testMoreArrayTypeDeclarations */',
- [
+ 'testMarker' => '/* testMoreArrayTypeDeclarations */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 2,
@@ -421,8 +527,8 @@ public function dataArrowFunction()
],
],
'arrow-function-with-ternary-content' => [
- '/* testTernary */',
- [
+ 'testMarker' => '/* testTernary */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -433,8 +539,8 @@ public function dataArrowFunction()
],
],
'arrow-function-with-ternary-content-after-then' => [
- '/* testTernaryThen */',
- [
+ 'testMarker' => '/* testTernaryThen */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -445,8 +551,8 @@ public function dataArrowFunction()
],
],
'arrow-function-with-ternary-content-after-else' => [
- '/* testTernaryElse */',
- [
+ 'testMarker' => '/* testTernaryElse */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -457,8 +563,8 @@ public function dataArrowFunction()
],
],
'arrow-function-as-function-call-argument' => [
- '/* testArrowFunctionAsArgument */',
- [
+ 'testMarker' => '/* testArrowFunctionAsArgument */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -469,8 +575,8 @@ public function dataArrowFunction()
],
],
'arrow-function-as-function-call-argument-with-array-return' => [
- '/* testArrowFunctionWithArrayAsArgument */',
- [
+ 'testMarker' => '/* testArrowFunctionWithArrayAsArgument */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -481,8 +587,8 @@ public function dataArrowFunction()
],
],
'arrow-function-nested-in-method' => [
- '/* testNestedInMethod */',
- [
+ 'testMarker' => '/* testNestedInMethod */',
+ 'expected' => [
'is' => true,
'get' => [
'parenthesis_opener' => 1,
@@ -497,99 +603,109 @@ public function dataArrowFunction()
* Use of the "fn" keyword when not an arrow function.
*/
'non-arrow-function-const-declaration' => [
- '/* testConstantDeclaration */',
- [
+ 'testMarker' => '/* testConstantDeclaration */',
+ 'expected' => [
'is' => false,
'get' => false,
],
- 'FN',
+ 'targetContent' => 'FN',
],
'non-arrow-function-const-declaration-lowercase' => [
- '/* testConstantDeclarationLower */',
- [
+ 'testMarker' => '/* testConstantDeclarationLower */',
+ 'expected' => [
'is' => false,
'get' => false,
],
],
'non-arrow-function-static-method-declaration' => [
- '/* testStaticMethodName */',
- [
+ 'testMarker' => '/* testStaticMethodName */',
+ 'expected' => [
'is' => false,
'get' => false,
],
],
'non-arrow-function-assignment-to-property' => [
- '/* testPropertyAssignment */',
- [
+ 'testMarker' => '/* testPropertyAssignment */',
+ 'expected' => [
'is' => false,
'get' => false,
],
],
'non-arrow-function-anon-class-method-declaration' => [
- '/* testAnonClassMethodName */',
- [
+ 'testMarker' => '/* testAnonClassMethodName */',
+ 'expected' => [
'is' => false,
'get' => false,
],
- 'fN',
+ 'targetContent' => 'fN',
],
'non-arrow-function-call-to-static-method' => [
- '/* testNonArrowStaticMethodCall */',
- [
+ 'testMarker' => '/* testNonArrowStaticMethodCall */',
+ 'expected' => [
'is' => false,
'get' => false,
],
],
'non-arrow-function-class-constant-access' => [
- '/* testNonArrowConstantAccess */',
- [
+ 'testMarker' => '/* testNonArrowConstantAccess */',
+ 'expected' => [
'is' => false,
'get' => false,
],
- 'FN',
+ 'targetContent' => 'FN',
],
'non-arrow-function-class-constant-access-with-deref' => [
- '/* testNonArrowConstantAccessDeref */',
- [
+ 'testMarker' => '/* testNonArrowConstantAccessDeref */',
+ 'expected' => [
'is' => false,
'get' => false,
],
- 'Fn',
+ 'targetContent' => 'Fn',
],
'non-arrow-function-call-to-object-method' => [
- '/* testNonArrowObjectMethodCall */',
- [
+ 'testMarker' => '/* testNonArrowObjectMethodCall */',
+ 'expected' => [
'is' => false,
'get' => false,
],
],
'non-arrow-function-call-to-object-method-uppercase' => [
- '/* testNonArrowObjectMethodCallUpper */',
- [
+ 'testMarker' => '/* testNonArrowObjectMethodCallUpper */',
+ 'expected' => [
'is' => false,
'get' => false,
],
- 'FN',
+ 'targetContent' => 'FN',
],
'non-arrow-function-call-to-namespaced-function' => [
- '/* testNonArrowNamespacedFunctionCall */',
- [
+ 'testMarker' => '/* testNonArrowNamespacedFunctionCall */',
+ 'expected' => [
'is' => false,
'get' => false,
],
- 'Fn',
+ 'targetContent' => 'Fn',
+ 'skipOnPHP8' => true,
],
'non-arrow-function-call-to-namespaced-function-using-namespace-operator' => [
- '/* testNonArrowNamespaceOperatorFunctionCall */',
- [
+ 'testMarker' => '/* testNonArrowNamespaceOperatorFunctionCall */',
+ 'expected' => [
+ 'is' => false,
+ 'get' => false,
+ ],
+ 'targetContent' => 'fn',
+ 'skipOnPHP8' => true,
+ ],
+ 'non-arrow-function-declaration-with-union-types' => [
+ 'testMarker' => '/* testNonArrowFunctionNameWithUnionTypes */',
+ 'expected' => [
'is' => false,
'get' => false,
],
],
'live-coding' => [
- '/* testLiveCoding */',
- [
+ 'testMarker' => '/* testLiveCoding */',
+ 'expected' => [
'is' => false,
'get' => false,
],
diff --git a/Tests/Utils/FunctionDeclarations/IsMagicFunctionNameTest.php b/Tests/Utils/FunctionDeclarations/IsMagicFunctionNameTest.php
index 03c267d0..0b81a56f 100644
--- a/Tests/Utils/FunctionDeclarations/IsMagicFunctionNameTest.php
+++ b/Tests/Utils/FunctionDeclarations/IsMagicFunctionNameTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class IsMagicFunctionNameTest extends TestCase
+final class IsMagicFunctionNameTest extends TestCase
{
/**
diff --git a/Tests/Utils/FunctionDeclarations/IsMagicMethodNameTest.php b/Tests/Utils/FunctionDeclarations/IsMagicMethodNameTest.php
index 82a48a4b..1ad5f01c 100644
--- a/Tests/Utils/FunctionDeclarations/IsMagicMethodNameTest.php
+++ b/Tests/Utils/FunctionDeclarations/IsMagicMethodNameTest.php
@@ -16,18 +16,20 @@
/**
* Tests for the \PHPCSUtils\Utils\FunctionDeclarations::isMagicMethodName() method.
*
+ * @coversDefaultClass \PHPCSUtils\Utils\FunctionDeclarations
+ *
* @group functiondeclarations
*
* @since 1.0.0
*/
-class IsMagicMethodNameTest extends TestCase
+final class IsMagicMethodNameTest extends TestCase
{
/**
* Test valid PHP magic method names.
*
* @dataProvider dataIsMagicMethodName
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isMagicMethodName
+ * @covers ::isMagicMethodName
*
* @param string $name The function name to test.
*
@@ -42,7 +44,7 @@ public function testIsMagicMethodName($name)
* Test valid PHP magic method names.
*
* @dataProvider dataIsMagicMethodName
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isSpecialMethodName
+ * @covers ::isSpecialMethodName
*
* @param string $name The function name to test.
*
@@ -108,7 +110,7 @@ public function dataIsMagicMethodName()
* Test non-magic method names.
*
* @dataProvider dataIsNotMagicMethodName
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isMagicMethodName
+ * @covers ::isMagicMethodName
*
* @param string $name The function name to test.
*
@@ -123,7 +125,7 @@ public function testIsNotMagicMethodName($name)
* Test non-magic method names.
*
* @dataProvider dataIsNotMagicMethodName
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isSpecialMethodName
+ * @covers ::isSpecialMethodName
*
* @param string $name The function name to test.
*
diff --git a/Tests/Utils/FunctionDeclarations/IsPHPDoubleUnderscoreMethodNameTest.php b/Tests/Utils/FunctionDeclarations/IsPHPDoubleUnderscoreMethodNameTest.php
index 2feb771a..f5735666 100644
--- a/Tests/Utils/FunctionDeclarations/IsPHPDoubleUnderscoreMethodNameTest.php
+++ b/Tests/Utils/FunctionDeclarations/IsPHPDoubleUnderscoreMethodNameTest.php
@@ -14,20 +14,23 @@
use PHPUnit\Framework\TestCase;
/**
- * Tests for the \PHPCSUtils\Utils\FunctionDeclarations::isPHPDoubleUnderscoreMethodName() method.
+ * Tests for the \PHPCSUtils\Utils\FunctionDeclarations::isPHPDoubleUnderscoreMethodName()
+ * and the \PHPCSUtils\Utils\FunctionDeclarations::isSpecialMethodName() method.
+ *
+ * @coversDefaultClass \PHPCSUtils\Utils\FunctionDeclarations
*
* @group functiondeclarations
*
* @since 1.0.0
*/
-class IsPHPDoubleUnderscoreMethodNameTest extends TestCase
+final class IsPHPDoubleUnderscoreMethodNameTest extends TestCase
{
/**
* Test valid PHP native double underscore method names.
*
* @dataProvider dataIsPHPDoubleUnderscoreMethodName
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isPHPDoubleUnderscoreMethodName
+ * @covers ::isPHPDoubleUnderscoreMethodName
*
* @param string $name The function name to test.
*
@@ -42,7 +45,7 @@ public function testIsPHPDoubleUnderscoreMethodName($name)
* Test valid PHP native double underscore method names.
*
* @dataProvider dataIsPHPDoubleUnderscoreMethodName
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isSpecialMethodName
+ * @covers ::isSpecialMethodName
*
* @param string $name The function name to test.
*
@@ -98,7 +101,7 @@ public function dataIsPHPDoubleUnderscoreMethodName()
* Test function names which are not valid PHP native double underscore methods.
*
* @dataProvider dataIsNotPHPDoubleUnderscoreMethodName
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isPHPDoubleUnderscoreMethodName
+ * @covers ::isPHPDoubleUnderscoreMethodName
*
* @param string $name The function name to test.
*
@@ -113,7 +116,7 @@ public function testIsNotPHPDoubleUnderscoreMethodName($name)
* Test function names which are not valid PHP native double underscore methods.
*
* @dataProvider dataIsNotPHPDoubleUnderscoreMethodName
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isSpecialMethodName
+ * @covers ::isSpecialMethodName
*
* @param string $name The function name to test.
*
diff --git a/Tests/Utils/FunctionDeclarations/SpecialFunctionsTest.inc b/Tests/Utils/FunctionDeclarations/SpecialFunctionsTest.inc
index ffc59a77..6ff48133 100644
--- a/Tests/Utils/FunctionDeclarations/SpecialFunctionsTest.inc
+++ b/Tests/Utils/FunctionDeclarations/SpecialFunctionsTest.inc
@@ -49,9 +49,9 @@ $a = new class {
function __myFunction() {}
};
-class MySoapImplementation extends \SoapClient {
+abstract class MySoapImplementation extends \SoapClient {
/* testDoubleUnderscoreMethodInClass */
- public function __getCookies() {}
+ abstract public function __getCookies();
/* testDoubleUnderscoreMethodInClassMixedcase */
public function __getLASTRequestHeaders() {}
@@ -86,7 +86,7 @@ interface MagicInterface
function __set_state($name, $args);
/* testDoubleUnderscoreMethodInInterface */
- public function __setLocation() {}
+ public function __setLocation();
/* testMagicFunctionInInterfaceNotGlobal */
function __autoload();
diff --git a/Tests/Utils/FunctionDeclarations/SpecialFunctionsTest.php b/Tests/Utils/FunctionDeclarations/SpecialFunctionsTest.php
index ae747601..499c64c3 100644
--- a/Tests/Utils/FunctionDeclarations/SpecialFunctionsTest.php
+++ b/Tests/Utils/FunctionDeclarations/SpecialFunctionsTest.php
@@ -19,20 +19,22 @@
* \PHPCSUtils\Utils\FunctionDeclarations::isPHPDoubleUnderscoreMethod() and the
* \PHPCSUtils\Utils\FunctionDeclarations::isSpecialMethod() methods.
*
+ * @coversDefaultClass \PHPCSUtils\Utils\FunctionDeclarations
+ *
* @group functiondeclarations
*
* @since 1.0.0
*/
-class SpecialFunctionsTest extends UtilityMethodTestCase
+final class SpecialFunctionsTest extends UtilityMethodTestCase
{
/**
* Test that the special function methods return false when passed a non-existent token.
*
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isMagicFunction
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isMagicMethod
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isPHPDoubleUnderscoreMethod
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isSpecialMethod
+ * @covers ::isMagicFunction
+ * @covers ::isMagicMethod
+ * @covers ::isPHPDoubleUnderscoreMethod
+ * @covers ::isSpecialMethod
*
* @return void
*/
@@ -54,10 +56,10 @@ public function testNonExistentToken()
/**
* Test that the special function methods return false when passed a non-function token.
*
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isMagicFunction
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isMagicMethod
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isPHPDoubleUnderscoreMethod
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isSpecialMethod
+ * @covers ::isMagicFunction
+ * @covers ::isMagicMethod
+ * @covers ::isPHPDoubleUnderscoreMethod
+ * @covers ::isSpecialMethod
*
* @return void
*/
@@ -82,7 +84,7 @@ public function testNotAFunctionToken()
* Test correctly detecting magic functions.
*
* @dataProvider dataItsAKindOfMagic
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isMagicFunction
+ * @covers ::isMagicFunction
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param array $expected The expected return values for the various functions.
@@ -100,7 +102,7 @@ public function testIsMagicFunction($testMarker, $expected)
* Test correctly detecting magic methods.
*
* @dataProvider dataItsAKindOfMagic
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isMagicMethod
+ * @covers ::isMagicMethod
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param array $expected The expected return values for the various functions.
@@ -118,7 +120,7 @@ public function testIsMagicMethod($testMarker, $expected)
* Test correctly detecting PHP native double underscore methods.
*
* @dataProvider dataItsAKindOfMagic
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isPHPDoubleUnderscoreMethod
+ * @covers ::isPHPDoubleUnderscoreMethod
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param array $expected The expected return values for the various functions.
@@ -136,7 +138,7 @@ public function testIsPHPDoubleUnderscoreMethod($testMarker, $expected)
* Test correctly detecting magic methods and double underscore methods.
*
* @dataProvider dataItsAKindOfMagic
- * @covers \PHPCSUtils\Utils\FunctionDeclarations::isSpecialMethod
+ * @covers ::isSpecialMethod
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param array $expected The expected return values for the various functions.
@@ -164,8 +166,8 @@ public function dataItsAKindOfMagic()
{
return [
'MagicMethodInClass' => [
- '/* testMagicMethodInClass */',
- [
+ 'testMarker' => '/* testMagicMethodInClass */',
+ 'expected' => [
'function' => false,
'method' => true,
'double' => false,
@@ -173,8 +175,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicMethodInClassUppercase' => [
- '/* testMagicMethodInClassUppercase */',
- [
+ 'testMarker' => '/* testMagicMethodInClassUppercase */',
+ 'expected' => [
'function' => false,
'method' => true,
'double' => false,
@@ -182,8 +184,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicMethodInClassMixedCase' => [
- '/* testMagicMethodInClassMixedCase */',
- [
+ 'testMarker' => '/* testMagicMethodInClassMixedCase */',
+ 'expected' => [
'function' => false,
'method' => true,
'double' => false,
@@ -191,8 +193,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicFunctionInClassNotGlobal' => [
- '/* testMagicFunctionInClassNotGlobal */',
- [
+ 'testMarker' => '/* testMagicFunctionInClassNotGlobal */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -200,8 +202,8 @@ public function dataItsAKindOfMagic()
],
],
'MethodInClassNotMagicName' => [
- '/* testMethodInClassNotMagicName */',
- [
+ 'testMarker' => '/* testMethodInClassNotMagicName */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -209,8 +211,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicMethodNotInClass' => [
- '/* testMagicMethodNotInClass */',
- [
+ 'testMarker' => '/* testMagicMethodNotInClass */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -218,8 +220,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicFunction' => [
- '/* testMagicFunction */',
- [
+ 'testMarker' => '/* testMagicFunction */',
+ 'expected' => [
'function' => true,
'method' => false,
'double' => false,
@@ -227,8 +229,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicFunctionInConditionMixedCase' => [
- '/* testMagicFunctionInConditionMixedCase */',
- [
+ 'testMarker' => '/* testMagicFunctionInConditionMixedCase */',
+ 'expected' => [
'function' => true,
'method' => false,
'double' => false,
@@ -236,8 +238,8 @@ public function dataItsAKindOfMagic()
],
],
'FunctionNotMagicName' => [
- '/* testFunctionNotMagicName */',
- [
+ 'testMarker' => '/* testFunctionNotMagicName */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -245,8 +247,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicMethodInAnonClass' => [
- '/* testMagicMethodInAnonClass */',
- [
+ 'testMarker' => '/* testMagicMethodInAnonClass */',
+ 'expected' => [
'function' => false,
'method' => true,
'double' => false,
@@ -254,8 +256,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicMethodInAnonClassUppercase' => [
- '/* testMagicMethodInAnonClassUppercase */',
- [
+ 'testMarker' => '/* testMagicMethodInAnonClassUppercase */',
+ 'expected' => [
'function' => false,
'method' => true,
'double' => false,
@@ -263,8 +265,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicFunctionInAnonClassNotGlobal' => [
- '/* testMagicFunctionInAnonClassNotGlobal */',
- [
+ 'testMarker' => '/* testMagicFunctionInAnonClassNotGlobal */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -272,8 +274,8 @@ public function dataItsAKindOfMagic()
],
],
'MethodInAnonClassNotMagicName' => [
- '/* testMethodInAnonClassNotMagicName */',
- [
+ 'testMarker' => '/* testMethodInAnonClassNotMagicName */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -281,8 +283,8 @@ public function dataItsAKindOfMagic()
],
],
'DoubleUnderscoreMethodInClass' => [
- '/* testDoubleUnderscoreMethodInClass */',
- [
+ 'testMarker' => '/* testDoubleUnderscoreMethodInClass */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => true,
@@ -290,8 +292,8 @@ public function dataItsAKindOfMagic()
],
],
'DoubleUnderscoreMethodInClassMixedcase' => [
- '/* testDoubleUnderscoreMethodInClassMixedcase */',
- [
+ 'testMarker' => '/* testDoubleUnderscoreMethodInClassMixedcase */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => true,
@@ -300,8 +302,8 @@ public function dataItsAKindOfMagic()
],
'DoubleUnderscoreMethodInClassNotExtended' => [
- '/* testDoubleUnderscoreMethodInClassNotExtended */',
- [
+ 'testMarker' => '/* testDoubleUnderscoreMethodInClassNotExtended */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -309,8 +311,8 @@ public function dataItsAKindOfMagic()
],
],
'DoubleUnderscoreMethodNotInClass' => [
- '/* testDoubleUnderscoreMethodNotInClass */',
- [
+ 'testMarker' => '/* testDoubleUnderscoreMethodNotInClass */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -318,8 +320,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicMethodInTrait' => [
- '/* testMagicMethodInTrait */',
- [
+ 'testMarker' => '/* testMagicMethodInTrait */',
+ 'expected' => [
'function' => false,
'method' => true,
'double' => false,
@@ -328,8 +330,8 @@ public function dataItsAKindOfMagic()
],
'DoubleUnderscoreMethodInTrait' => [
- '/* testDoubleUnderscoreMethodInTrait */',
- [
+ 'testMarker' => '/* testDoubleUnderscoreMethodInTrait */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => true,
@@ -337,8 +339,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicFunctionInTraitNotGloba' => [
- '/* testMagicFunctionInTraitNotGlobal */',
- [
+ 'testMarker' => '/* testMagicFunctionInTraitNotGlobal */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -346,8 +348,8 @@ public function dataItsAKindOfMagic()
],
],
'MethodInTraitNotMagicName' => [
- '/* testMethodInTraitNotMagicName */',
- [
+ 'testMarker' => '/* testMethodInTraitNotMagicName */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -355,8 +357,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicMethodInInterface' => [
- '/* testMagicMethodInInterface */',
- [
+ 'testMarker' => '/* testMagicMethodInInterface */',
+ 'expected' => [
'function' => false,
'method' => true,
'double' => false,
@@ -365,8 +367,8 @@ public function dataItsAKindOfMagic()
],
'DoubleUnderscoreMethodInInterface' => [
- '/* testDoubleUnderscoreMethodInInterface */',
- [
+ 'testMarker' => '/* testDoubleUnderscoreMethodInInterface */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => true,
@@ -374,8 +376,8 @@ public function dataItsAKindOfMagic()
],
],
'MagicFunctionInInterfaceNotGlobal' => [
- '/* testMagicFunctionInInterfaceNotGlobal */',
- [
+ 'testMarker' => '/* testMagicFunctionInInterfaceNotGlobal */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -383,8 +385,8 @@ public function dataItsAKindOfMagic()
],
],
'MethodInInterfaceNotMagicName' => [
- '/* testMethodInInterfaceNotMagicName */',
- [
+ 'testMarker' => '/* testMethodInInterfaceNotMagicName */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -393,8 +395,8 @@ public function dataItsAKindOfMagic()
],
'NonMagicMethod' => [
- '/* testNonMagicMethod */',
- [
+ 'testMarker' => '/* testNonMagicMethod */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -402,8 +404,8 @@ public function dataItsAKindOfMagic()
],
],
'NestedFunctionDeclarationMagicFunction' => [
- '/* testNestedFunctionDeclarationMagicFunction */',
- [
+ 'testMarker' => '/* testNestedFunctionDeclarationMagicFunction */',
+ 'expected' => [
'function' => true,
'method' => false,
'double' => false,
@@ -411,8 +413,8 @@ public function dataItsAKindOfMagic()
],
],
'NestedFunctionDeclarationNonMagicFunction' => [
- '/* testNestedFunctionDeclarationNonMagicFunction */',
- [
+ 'testMarker' => '/* testNestedFunctionDeclarationNonMagicFunction */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
@@ -420,8 +422,8 @@ public function dataItsAKindOfMagic()
],
],
'NestedFunctionDeclarationNonSpecialFunction' => [
- '/* testNestedFunctionDeclarationNonSpecialFunction */',
- [
+ 'testMarker' => '/* testNestedFunctionDeclarationNonSpecialFunction */',
+ 'expected' => [
'function' => false,
'method' => false,
'double' => false,
diff --git a/Tests/Utils/GetTokensAsString/GetTokensAsStringTest.php b/Tests/Utils/GetTokensAsString/GetTokensAsStringTest.php
index d08560d4..30f6b6fb 100644
--- a/Tests/Utils/GetTokensAsString/GetTokensAsStringTest.php
+++ b/Tests/Utils/GetTokensAsString/GetTokensAsStringTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetTokensAsStringTest extends UtilityMethodTestCase
+final class GetTokensAsStringTest extends UtilityMethodTestCase
{
/**
@@ -125,8 +125,8 @@ public function testNormal($testMarker, $startTokenType, $expected)
$start = $this->getTargetToken($testMarker, $startTokenType);
$end = $this->getTargetToken($testMarker, \T_SEMICOLON);
- $result = GetTokensAsString::normal(self::$phpcsFile, $start, $end);
- $this->assertSame($expected['normal'], $result);
+ $result = GetTokensAsString::tabReplaced(self::$phpcsFile, $start, $end);
+ $this->assertSame($expected['tab_replaced'], $result);
}
/**
@@ -248,60 +248,81 @@ public function dataGetTokensAsString()
'marker' => '/* testNamespace */',
'type' => \T_NAMESPACE,
'expected' => [
- 'normal' => 'namespace Foo\Bar\Baz;',
- 'orig' => 'namespace Foo\Bar\Baz;',
- 'no_comments' => 'namespace Foo\Bar\Baz;',
- 'no_empties' => 'namespaceFoo\Bar\Baz;',
- 'compact' => 'namespace Foo\Bar\Baz;',
- 'compact_nc' => 'namespace Foo\Bar\Baz;',
+ 'tab_replaced' => 'namespace Foo\Bar\Baz;',
+ 'orig' => 'namespace Foo\Bar\Baz;',
+ 'no_comments' => 'namespace Foo\Bar\Baz;',
+ 'no_empties' => 'namespaceFoo\Bar\Baz;',
+ 'compact' => 'namespace Foo\Bar\Baz;',
+ 'compact_nc' => 'namespace Foo\Bar\Baz;',
],
],
'use-with-comments' => [
'marker' => '/* testUseWithComments */',
'type' => \T_STRING,
'expected' => [
- 'normal' => 'Foo /*comment*/ \ Bar
+ 'tab_replaced' => 'Foo /*comment*/ \ Bar
// phpcs:ignore Stnd.Cat.Sniff -- For reasons.
\ Bah;',
- 'orig' => 'Foo /*comment*/ \ Bar
+ 'orig' => 'Foo /*comment*/ \ Bar
// phpcs:ignore Stnd.Cat.Sniff -- For reasons.
\ Bah;',
- 'no_comments' => 'Foo \ Bar
+ 'no_comments' => 'Foo \ Bar
\ Bah;',
- 'no_empties' => 'Foo\Bar\Bah;',
- 'compact' => 'Foo /*comment*/ \ Bar // phpcs:ignore Stnd.Cat.Sniff -- For reasons.
+ 'no_empties' => 'Foo\Bar\Bah;',
+ 'compact' => 'Foo /*comment*/ \ Bar // phpcs:ignore Stnd.Cat.Sniff -- For reasons.
\ Bah;',
- 'compact_nc' => 'Foo \ Bar \ Bah;',
+ 'compact_nc' => 'Foo \ Bar \ Bah;',
+ ],
+ ],
+ 'calculation' => [
+ 'marker' => '/* testCalculation */',
+ 'type' => \T_LNUMBER,
+ 'expected' => [
+ 'tab_replaced' => '1 + 2 +
+ // Comment.
+ 3 + 4
+ + 5 + 6 + 7 > 20;',
+ 'orig' => '1 + 2 +
+ // Comment.
+ 3 + 4
+ + 5 + 6 + 7 > 20;',
+ 'no_comments' => '1 + 2 +
+ 3 + 4
+ + 5 + 6 + 7 > 20;',
+ 'no_empties' => '1+2+3+4+5+6+7>20;',
+ 'compact' => '1 + 2 + // Comment.
+ 3 + 4 + 5 + 6 + 7 > 20;',
+ 'compact_nc' => '1 + 2 + 3 + 4 + 5 + 6 + 7 > 20;',
],
],
'echo-with-tabs' => [
'marker' => '/* testEchoWithTabs */',
'type' => \T_ECHO,
'expected' => [
- 'normal' => 'echo \'foo\',
+ 'tab_replaced' => 'echo \'foo\',
\'bar\' ,
\'baz\';',
- 'orig' => 'echo \'foo\',
+ 'orig' => 'echo \'foo\',
\'bar\' ,
\'baz\';',
- 'no_comments' => 'echo \'foo\',
+ 'no_comments' => 'echo \'foo\',
\'bar\' ,
\'baz\';',
- 'no_empties' => 'echo\'foo\',\'bar\',\'baz\';',
- 'compact' => 'echo \'foo\', \'bar\' , \'baz\';',
- 'compact_nc' => 'echo \'foo\', \'bar\' , \'baz\';',
+ 'no_empties' => 'echo\'foo\',\'bar\',\'baz\';',
+ 'compact' => 'echo \'foo\', \'bar\' , \'baz\';',
+ 'compact_nc' => 'echo \'foo\', \'bar\' , \'baz\';',
],
],
'end-of-file' => [
'marker' => '/* testEndOfFile */',
'type' => \T_ECHO,
'expected' => [
- 'normal' => 'echo $foo;',
- 'orig' => 'echo $foo;',
- 'no_comments' => 'echo $foo;',
- 'no_empties' => 'echo$foo;',
- 'compact' => 'echo $foo;',
- 'compact_nc' => 'echo $foo;',
+ 'tab_replaced' => 'echo $foo;',
+ 'orig' => 'echo $foo;',
+ 'no_comments' => 'echo $foo;',
+ 'no_empties' => 'echo$foo;',
+ 'compact' => 'echo $foo;',
+ 'compact_nc' => 'echo $foo;',
],
],
];
diff --git a/Tests/Utils/Lists/GetAssignmentsTest.php b/Tests/Utils/Lists/GetAssignmentsTest.php
index 7876d464..7ab9cbaa 100644
--- a/Tests/Utils/Lists/GetAssignmentsTest.php
+++ b/Tests/Utils/Lists/GetAssignmentsTest.php
@@ -10,7 +10,9 @@
namespace PHPCSUtils\Tests\Utils\Lists;
+use PHPCSUtils\Internal\Cache;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
use PHPCSUtils\Utils\Lists;
/**
@@ -22,7 +24,7 @@
*
* @since 1.0.0
*/
-class GetAssignmentsTest extends UtilityMethodTestCase
+final class GetAssignmentsTest extends UtilityMethodTestCase
{
/**
@@ -66,12 +68,12 @@ public function dataNotListToken()
{
return [
'not-a-list' => [
- '/* testNotAList */',
- \T_OPEN_SHORT_ARRAY,
+ 'testMarker' => '/* testNotAList */',
+ 'targetToken' => \T_OPEN_SHORT_ARRAY,
],
'live-coding' => [
- '/* testLiveCoding */',
- \T_LIST,
+ 'testMarker' => '/* testLiveCoding */',
+ 'targetToken' => \T_LIST,
],
];
}
@@ -130,19 +132,19 @@ public function dataGetAssignments()
{
return [
'long-list-empty' => [
- '/* testEmptyLongList */',
- \T_LIST,
- [],
+ 'testMarker' => '/* testEmptyLongList */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [],
],
'short-list-empty' => [
- '/* testEmptyShortList */',
- \T_OPEN_SHORT_ARRAY,
- [],
+ 'testMarker' => '/* testEmptyShortList */',
+ 'targetToken' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [],
],
'long-list-all-empty' => [
- '/* testLongListOnlyEmpties */',
- \T_LIST,
- [
+ 'testMarker' => '/* testLongListOnlyEmpties */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
0 => [
'raw' => '',
'assignment' => '',
@@ -190,14 +192,14 @@ public function dataGetAssignments()
],
],
'short-list-all-empty-with-comment' => [
- '/* testShortListOnlyEmpties */',
- \T_OPEN_SHORT_ARRAY,
- [],
+ 'testMarker' => '/* testShortListOnlyEmpties */',
+ 'targetToken' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [],
],
'long-list-basic' => [
- '/* testSimpleLongList */',
- \T_LIST,
- [
+ 'testMarker' => '/* testSimpleLongList */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
0 => [
'raw' => '$id',
'assignment' => '$id',
@@ -223,9 +225,9 @@ public function dataGetAssignments()
],
],
'short-list-basic' => [
- '/* testSimpleShortList */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testSimpleShortList */',
+ 'targetToken' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
0 => [
'raw' => '$this->propA',
'assignment' => '$this->propA',
@@ -251,9 +253,9 @@ public function dataGetAssignments()
],
],
'short-list-in-foreach-keyed-with-ref' => [
- '/* testShortListInForeachKeyedWithRef */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testShortListInForeachKeyedWithRef */',
+ 'targetToken' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
0 => [
'raw' => '\'id\' => & $id',
'assignment' => '$id',
@@ -287,9 +289,9 @@ public function dataGetAssignments()
],
],
'long-list-nested' => [
- '/* testNestedLongList */',
- \T_LIST,
- [
+ 'testMarker' => '/* testNestedLongList */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
0 => [
'raw' => '$a',
'assignment' => '$a',
@@ -315,9 +317,9 @@ public function dataGetAssignments()
],
],
'long-list-with-keys' => [
- '/* testLongListWithKeys */',
- \T_LIST,
- [
+ 'testMarker' => '/* testLongListWithKeys */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
0 => [
'raw' => '\'name\' => $a',
'assignment' => '$a',
@@ -366,9 +368,9 @@ public function dataGetAssignments()
],
],
'long-list-with-empties' => [
- '/* testLongListWithEmptyEntries */',
- \T_LIST,
- [
+ 'testMarker' => '/* testLongListWithEmptyEntries */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
0 => [
'raw' => '',
'assignment' => '',
@@ -460,9 +462,9 @@ public function dataGetAssignments()
],
],
'long-list-multi-line-keyed' => [
- '/* testLongListMultiLineKeyedWithTrailingComma */',
- \T_LIST,
- [
+ 'testMarker' => '/* testLongListMultiLineKeyedWithTrailingComma */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
0 => [
'raw' => '"name" => $this->name',
'assignment' => '$this->name',
@@ -537,9 +539,9 @@ public function dataGetAssignments()
],
],
'short-list-with-keys-nested-lists' => [
- '/* testShortListWithKeysNestedLists */',
- [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET],
- [
+ 'testMarker' => '/* testShortListWithKeysNestedLists */',
+ 'targetToken' => Collections::shortArrayListOpenTokensBC(),
+ 'expected' => [
0 => [
'raw' => '\'a\' => [&$a, $b]',
'assignment' => '[&$a, $b]',
@@ -573,9 +575,9 @@ public function dataGetAssignments()
],
],
'long-list-with-array-vars' => [
- '/* testLongListWithArrayVars */',
- \T_LIST,
- [
+ 'testMarker' => '/* testLongListWithArrayVars */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
0 => [
'raw' => '$a[]',
'assignment' => '$a[]',
@@ -612,9 +614,9 @@ public function dataGetAssignments()
],
],
'short-list-multi-line-with-variable-keys' => [
- '/* testShortListMultiLineWithVariableKeys */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testShortListMultiLineWithVariableKeys */',
+ 'targetToken' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
0 => [
'raw' => '\'a\' . \'b\' => $a',
'assignment' => '$a',
@@ -750,9 +752,9 @@ public function dataGetAssignments()
],
],
'long-list-with-close-parens-in-key' => [
- '/* testLongListWithCloseParensInKey */',
- \T_LIST,
- [
+ 'testMarker' => '/* testLongListWithCloseParensInKey */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
0 => [
'raw' => 'get_key()[1] => &$e',
'assignment' => '$e',
@@ -771,9 +773,9 @@ public function dataGetAssignments()
],
],
'long-list-variable-vars' => [
- '/* testLongListVariableVar */',
- \T_LIST,
- [
+ 'testMarker' => '/* testLongListVariableVar */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
0 => [
'raw' => '${$drink}',
'assignment' => '${$drink}',
@@ -799,9 +801,9 @@ public function dataGetAssignments()
],
],
'long-list-keyed-with-nested-lists' => [
- '/* testLongListKeyedNestedLists */',
- \T_LIST,
- [
+ 'testMarker' => '/* testLongListKeyedNestedLists */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
0 => [
'raw' => '\'a\' =>
list("x" => $x1, "y" => $y1)',
@@ -837,9 +839,9 @@ public function dataGetAssignments()
],
],
'parse-error-long-list-mixed-keyed-unkeyed' => [
- '/* testLongListMixedKeyedUnkeyed */',
- \T_LIST,
- [
+ 'testMarker' => '/* testLongListMixedKeyedUnkeyed */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
0 => [
'raw' => '$unkeyed',
'assignment' => '$unkeyed',
@@ -869,9 +871,9 @@ public function dataGetAssignments()
],
],
'parse-error-short-list-empties-and-key' => [
- '/* testShortListWithEmptiesAndKey */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testShortListWithEmptiesAndKey */',
+ 'targetToken' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
0 => [
'raw' => '',
'assignment' => '',
@@ -935,4 +937,59 @@ public function dataGetAssignments()
],
];
}
+
+ /**
+ * Verify that the build-in caching is used when caching is enabled.
+ *
+ * @return void
+ */
+ public function testResultIsCached()
+ {
+ $methodName = 'PHPCSUtils\\Utils\\Lists::getAssignments';
+ $cases = $this->dataGetAssignments();
+ $testMarker = $cases['short-list-with-keys-nested-lists']['testMarker'];
+ $targetToken = $cases['short-list-with-keys-nested-lists']['targetToken'];
+ $expected = $cases['short-list-with-keys-nested-lists']['expected'];
+
+ $stackPtr = $this->getTargetToken($testMarker, $targetToken);
+
+ // Convert offsets to absolute positions.
+ foreach ($expected as $index => $subset) {
+ if (isset($subset['key_token'])) {
+ $expected[$index]['key_token'] += $stackPtr;
+ }
+ if (isset($subset['key_end_token'])) {
+ $expected[$index]['key_end_token'] += $stackPtr;
+ }
+ if (isset($subset['double_arrow_token'])) {
+ $expected[$index]['double_arrow_token'] += $stackPtr;
+ }
+ if (isset($subset['reference_token']) && $subset['reference_token'] !== false) {
+ $expected[$index]['reference_token'] += $stackPtr;
+ }
+ if (isset($subset['assignment_token']) && $subset['assignment_token'] !== false) {
+ $expected[$index]['assignment_token'] += $stackPtr;
+ }
+ if (isset($subset['assignment_end_token']) && $subset['assignment_end_token'] !== false) {
+ $expected[$index]['assignment_end_token'] += $stackPtr;
+ }
+ }
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = Lists::getAssignments(self::$phpcsFile, $stackPtr);
+ $isCached = Cache::isCached(self::$phpcsFile, $methodName, $stackPtr);
+ $resultSecondRun = Lists::getAssignments(self::$phpcsFile, $stackPtr);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertSame($expected, $resultFirstRun, 'First result did not match expectation');
+ $this->assertTrue($isCached, 'Cache::isCached() could not find the cached value');
+ $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+ }
}
diff --git a/Tests/Utils/Lists/GetOpenCloseTest.php b/Tests/Utils/Lists/GetOpenCloseTest.php
index e085dc0c..0d1f8476 100644
--- a/Tests/Utils/Lists/GetOpenCloseTest.php
+++ b/Tests/Utils/Lists/GetOpenCloseTest.php
@@ -11,6 +11,7 @@
namespace PHPCSUtils\Tests\Utils\Lists;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
use PHPCSUtils\Utils\Lists;
/**
@@ -22,7 +23,7 @@
*
* @since 1.0.0
*/
-class GetOpenCloseTest extends UtilityMethodTestCase
+final class GetOpenCloseTest extends UtilityMethodTestCase
{
/**
@@ -46,7 +47,7 @@ public function testNonExistentToken()
*/
public function testNotListToken($testMarker)
{
- $target = $this->getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
+ $target = $this->getTargetToken($testMarker, Collections::shortArrayListOpenTokensBC());
$this->assertFalse(Lists::getOpenClose(self::$phpcsFile, $target));
}
@@ -103,49 +104,49 @@ public function dataGetOpenClose()
{
return [
'long-list' => [
- '/* testLongList */',
- \T_LIST,
- [
+ 'testMarker' => '/* testLongList */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
'opener' => 1,
'closer' => 14,
],
],
'long-list-nested' => [
- '/* testNestedLongList */',
- \T_LIST,
- [
+ 'testMarker' => '/* testNestedLongList */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
'opener' => 2,
'closer' => 6,
],
],
'short-list' => [
- '/* testShortList */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testShortList */',
+ 'targetToken' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
'opener' => 0,
'closer' => 9,
],
],
'short-list-nested' => [
- '/* testNestedShortList */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testNestedShortList */',
+ 'targetToken' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
'opener' => 0,
'closer' => 2,
],
],
'long-list-with-comments-and-annotations' => [
- '/* testListWithCommentsAndAnnotations */',
- \T_LIST,
- [
+ 'testMarker' => '/* testListWithCommentsAndAnnotations */',
+ 'targetToken' => \T_LIST,
+ 'expected' => [
'opener' => 7,
'closer' => 18,
],
],
'parse-error' => [
- '/* testParseError */',
- \T_LIST,
- false,
+ 'testMarker' => '/* testParseError */',
+ 'targetToken' => \T_LIST,
+ 'expected' => false,
],
];
}
diff --git a/Tests/Utils/Lists/IsShortListTest.inc b/Tests/Utils/Lists/IsShortListTest.inc
deleted file mode 100644
index 9c41956e..00000000
--- a/Tests/Utils/Lists/IsShortListTest.inc
+++ /dev/null
@@ -1,87 +0,0 @@
- [$id, $name, $info]) {}
-
-foreach ($array as [$a, /* testShortListInForeachNested */ [$b, $c]]) {}
-
-/* testMultiAssignShortlist */
-$foo = [$baz, $bat] = [$a, $b];
-
-/* testShortListWithKeys */
-["id" => $id1, "name" => $name1] = $data[0];
-
-/* testShortListInForeachWithKeysDetectOnCloseBracket */
-foreach ($data as ["id" => $id, "name" => $name]) {}
-
-echo 'just here to prevent the below test running into a tokenizer issue tested separately';
-
-// Invalid as empty lists are not allowed, but it is short list syntax.
-[$x, /* testNestedShortListEmpty */ [], $y] = $a;
-
-[$x, [ $y, /* testDeeplyNestedShortList */ [$z]], $q] = $a;
-
-/* testShortListWithNestingAndKeys */
-[
- /* testNestedShortListWithKeys_1 */
- ["x" => $x1, "y" => $y1],
- /* testNestedShortListWithKeys_2 */
- ["x" => $x2, "y" => $y2],
- /* testNestedShortListWithKeys_3 */
- ["x" => $x3, "y" => $y3],
-] = $points;
-
-/* testShortListWithoutVars */
-// Invalid list as it doesn't contain variables, but it is short list syntax.
-[42] = [1];
-
-/* testShortListNestedLongList */
-// Invalid list as mixing short list syntax with list() is not allowed, but it is short list syntax.
-[list($a, $b), list($c, $d)] = [[1, 2], [3, 4]];
-
-/* testNestedAnonClassWithTraitUseAs */
-// Parse error, but not short list syntax.
-array_map(function($a) {
- return new class() {
- use MyTrait {
- MyTrait::functionName as [];
- }
- };
-}, $array);
-
-/* testParseError */
-// Parse error, but not short list syntax.
-use Something as [$a];
-
-/* testLiveCoding */
-// Intentional parse error. This has to be the last test in the file.
-[$a, [$b]
diff --git a/Tests/Utils/Lists/IsShortListTest.php b/Tests/Utils/Lists/IsShortListTest.php
deleted file mode 100644
index 4b74cecb..00000000
--- a/Tests/Utils/Lists/IsShortListTest.php
+++ /dev/null
@@ -1,208 +0,0 @@
-assertFalse(Lists::isShortList(self::$phpcsFile, 100000));
- }
-
- /**
- * Test that false is returned when a non-short array token is passed.
- *
- * @dataProvider dataNotShortArrayToken
- *
- * @param string $testMarker The comment which prefaces the target token in the test file.
- * @param int|string|array $targetToken The token type(s) to look for.
- *
- * @return void
- */
- public function testNotShortArrayToken($testMarker, $targetToken)
- {
- $target = $this->getTargetToken($testMarker, $targetToken);
- $this->assertFalse(Lists::isShortList(self::$phpcsFile, $target));
- }
-
- /**
- * Data provider.
- *
- * @see testNotShortArrayToken() For the array format.
- *
- * @return array
- */
- public function dataNotShortArrayToken()
- {
- return [
- 'long-list' => [
- '/* testLongList */',
- \T_LIST,
- ],
- 'array-assignment' => [
- '/* testArrayAssignment */',
- \T_CLOSE_SQUARE_BRACKET,
- ],
- 'live-coding' => [
- '/* testLiveCoding */',
- \T_OPEN_SQUARE_BRACKET,
- ],
- ];
- }
-
- /**
- * Test whether a T_OPEN_SHORT_ARRAY token is a short list.
- *
- * @dataProvider dataIsShortList
- *
- * @param string $testMarker The comment which prefaces the target token in the test file.
- * @param bool $expected The expected boolean return value.
- * @param int|string|array $targetToken The token type(s) to test. Defaults to T_OPEN_SHORT_ARRAY.
- *
- * @return void
- */
- public function testIsShortList($testMarker, $expected, $targetToken = \T_OPEN_SHORT_ARRAY)
- {
- $stackPtr = $this->getTargetToken($testMarker, $targetToken);
- $result = Lists::isShortList(self::$phpcsFile, $stackPtr);
-
- $this->assertSame($expected, $result);
- }
-
- /**
- * Data provider.
- *
- * @see testIsShortList() For the array format.
- *
- * @return array
- */
- public function dataIsShortList()
- {
- return [
- 'short-array-not-nested' => [
- '/* testNonNestedShortArray */',
- false,
- ],
- 'comparison-no-assignment' => [
- '/* testNoAssignment */',
- false,
- ],
- 'comparison-no-assignment-nested' => [
- '/* testNestedNoAssignment */',
- false,
- ],
- 'short-array-in-foreach' => [
- '/* testShortArrayInForeach */',
- false,
- ],
- 'short-list' => [
- '/* testShortList */',
- true,
- ],
- 'short-list-detect-on-close-bracket' => [
- '/* testShortListDetectOnCloseBracket */',
- true,
- \T_CLOSE_SHORT_ARRAY,
- ],
- 'short-list-with-nesting' => [
- '/* testShortListWithNesting */',
- true,
- ],
- 'short-list-nested' => [
- '/* testNestedShortList */',
- true,
- ],
- 'short-list-in-foreach' => [
- '/* testShortListInForeach */',
- true,
- ],
- 'short-list-in-foreach-with-key' => [
- '/* testShortListInForeachWithKey */',
- true,
- ],
- 'short-list-in-foreach-nested' => [
- '/* testShortListInForeachNested */',
- true,
- ],
- 'short-list-chained-assignment' => [
- '/* testMultiAssignShortlist */',
- true,
- ],
- 'short-list-with-keys' => [
- '/* testShortListWithKeys */',
- true,
- ],
- 'short-list-in-foreach-with-keys-detect-on-close-bracket' => [
- '/* testShortListInForeachWithKeysDetectOnCloseBracket */',
- true,
- \T_CLOSE_SHORT_ARRAY,
- ],
- 'short-list-nested-empty' => [
- '/* testNestedShortListEmpty */',
- true,
- ],
- 'short-list-deeply-nested' => [
- '/* testDeeplyNestedShortList */',
- true,
- ],
- 'short-list-with-nesting-and-keys' => [
- '/* testShortListWithNestingAndKeys */',
- true,
- ],
- 'short-list-nested-with-keys-1' => [
- '/* testNestedShortListWithKeys_1 */',
- true,
- ],
- 'short-list-nested-with-keys-2' => [
- '/* testNestedShortListWithKeys_2 */',
- true,
- ],
- 'short-list-nested-with-keys-3' => [
- '/* testNestedShortListWithKeys_3 */',
- true,
- ],
- 'short-list-without-vars' => [
- '/* testShortListWithoutVars */',
- true,
- ],
- 'short-list-nested-long-list' => [
- '/* testShortListNestedLongList */',
- true,
- ],
- 'parse-error-anon-class-trait-use-as' => [
- '/* testNestedAnonClassWithTraitUseAs */',
- false,
- ],
- 'parse-error-use-as' => [
- '/* testParseError */',
- false,
- ],
- ];
- }
-}
diff --git a/Tests/Utils/Lists/IsShortListTokenizerBC1Test.php b/Tests/Utils/Lists/IsShortListTokenizerBC1Test.php
deleted file mode 100644
index 2df3b7b8..00000000
--- a/Tests/Utils/Lists/IsShortListTokenizerBC1Test.php
+++ /dev/null
@@ -1,107 +0,0 @@
-getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
- $result = Lists::isShortList(self::$phpcsFile, $stackPtr);
-
- $this->assertSame($expected, $result);
- }
-
- /**
- * Data provider.
- *
- * @see testIsShortList() For the array format.
- *
- * @return array
- */
- public function dataIsShortList()
- {
- return [
- 'issue-1971-list-first-in-file' => [
- '/* testTokenizerIssue1971PHPCSlt330gt271A */',
- true,
- ],
- 'issue-1971-list-first-in-file-nested' => [
- '/* testTokenizerIssue1971PHPCSlt330gt271B */',
- true,
- ],
- 'issue-1381-array-dereferencing-1' => [
- '/* testTokenizerIssue1381PHPCSlt290A1 */',
- false,
- ],
- 'issue-1381-array-dereferencing-1-deref' => [
- '/* testTokenizerIssue1381PHPCSlt290A2 */',
- false,
- ],
- 'issue-1381-array-dereferencing-2' => [
- '/* testTokenizerIssue1381PHPCSlt290B */',
- false,
- ],
- 'issue-1381-array-dereferencing-3' => [
- '/* testTokenizerIssue1381PHPCSlt290C */',
- false,
- ],
- 'issue-1381-array-dereferencing-4' => [
- '/* testTokenizerIssue1381PHPCSlt290D1 */',
- false,
- ],
- 'issue-1381-array-dereferencing-4-deref-deref' => [
- '/* testTokenizerIssue1381PHPCSlt290D2 */',
- false,
- ],
- 'issue-1284-short-list-directly-after-close-curly-control-structure' => [
- '/* testTokenizerIssue1284PHPCSlt280A */',
- true,
- ],
- 'issue-1284-short-array-directly-after-close-curly-control-structure' => [
- '/* testTokenizerIssue1284PHPCSlt280B */',
- false,
- ],
- 'issue-1284-array-access-variable-variable' => [
- '/* testTokenizerIssue1284PHPCSlt290C */',
- false,
- ],
- 'issue-1284-array-access-variable-property' => [
- '/* testTokenizerIssue1284PHPCSlt280D */',
- false,
- ],
- ];
- }
-}
diff --git a/Tests/Utils/Lists/IsShortListTokenizerBC2Test.php b/Tests/Utils/Lists/IsShortListTokenizerBC2Test.php
deleted file mode 100644
index 47b6840b..00000000
--- a/Tests/Utils/Lists/IsShortListTokenizerBC2Test.php
+++ /dev/null
@@ -1,68 +0,0 @@
-getTargetToken($testMarker, [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]);
- $result = Lists::isShortList(self::$phpcsFile, $stackPtr);
-
- $this->assertSame($expected, $result);
- }
-
- /**
- * Data provider.
- *
- * @see testIsShortList() For the array format.
- *
- * @return array
- */
- public function dataIsShortList()
- {
- return [
- // Make sure the utility method does not throw false positives for a short array at the start of a file.
- 'issue-1971-short-array-first-in-file' => [
- '/* testTokenizerIssue1971PHPCSlt330gt271C */',
- false,
- ],
- 'issue-1971-short-array-first-in-file-nested' => [
- '/* testTokenizerIssue1971PHPCSlt330gt271D */',
- false,
- ],
- ];
- }
-}
diff --git a/Tests/Utils/Lists/README-IsShortListTests.md b/Tests/Utils/Lists/README-IsShortListTests.md
new file mode 100644
index 00000000..4f30ed64
--- /dev/null
+++ b/Tests/Utils/Lists/README-IsShortListTests.md
@@ -0,0 +1,4 @@
+# Regarding tests for `Lists::isShortList()`
+
+The `Lists::isShortList()` method is tested together with the `Arrays::isShortArray()` method.
+The tests for this can be found in the `Tests/Internal/IsShortArrayOrList` folder.
diff --git a/Tests/Utils/MessageHelper/AddMessageTest.inc b/Tests/Utils/MessageHelper/AddMessageTest.inc
new file mode 100644
index 00000000..ce27ac26
--- /dev/null
+++ b/Tests/Utils/MessageHelper/AddMessageTest.inc
@@ -0,0 +1,13 @@
+getTokens();
+ $stackPtr = $this->getTargetToken($testMarker, \T_CONSTANT_ENCAPSED_STRING);
+ $severity = \mt_rand(5, 10);
+ $expected['severity'] = $severity;
+
+ $return = MessageHelper::addMessage(
+ self::$phpcsFile,
+ 'Message added. Text: %s',
+ $stackPtr,
+ $isError,
+ self::CODE,
+ [$tokens[$stackPtr]['content']],
+ $severity
+ );
+
+ $this->assertTrue($return);
+
+ $this->verifyRecordedMessages($stackPtr, $isError, $expected);
+ }
+
+ /**
+ * Data Provider.
+ *
+ * @see testAddMessage() For the array format.
+ *
+ * @return array
+ */
+ public function dataAddMessage()
+ {
+ return [
+ 'add-error' => [
+ 'testMarker' => '/* testAddErrorMessage */',
+ 'isError' => true,
+ 'expected' => [
+ 'message' => "Message added. Text: 'test 1'",
+ 'source' => self::CODE,
+ 'fixable' => false,
+ ],
+ ],
+ 'add-warning' => [
+ 'testMarker' => '/* testAddWarningMessage */',
+ 'isError' => false,
+ 'expected' => [
+ 'message' => "Message added. Text: 'test 2'",
+ 'source' => self::CODE,
+ 'fixable' => false,
+ ],
+ ],
+ ];
+ }
+
+ /**
+ * Test the addFixableMessage wrapper.
+ *
+ * @dataProvider dataAddFixableMessage
+ * @covers ::addFixableMessage
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param bool $isError Whether to test adding an error or a warning.
+ * @param array $expected Expected error details.
+ *
+ * @return void
+ */
+ public function testAddFixableMessage($testMarker, $isError, $expected)
+ {
+ $tokens = self::$phpcsFile->getTokens();
+ $stackPtr = $this->getTargetToken($testMarker, \T_CONSTANT_ENCAPSED_STRING);
+ $severity = \mt_rand(5, 10);
+ $expected['severity'] = $severity;
+
+ $return = MessageHelper::addFixableMessage(
+ self::$phpcsFile,
+ 'Message added. Text: %s',
+ $stackPtr,
+ $isError,
+ self::CODE,
+ [$tokens[$stackPtr]['content']],
+ $severity
+ );
+
+ // Fixable message recording only returns true when the fixer is enabled (=phpcbf).
+ $this->assertFalse($return);
+
+ $this->verifyRecordedMessages($stackPtr, $isError, $expected);
+ }
+
+ /**
+ * Data Provider.
+ *
+ * @see testAddFixableMessage() For the array format.
+ *
+ * @return array
+ */
+ public function dataAddFixableMessage()
+ {
+ return [
+ 'add-fixable-error' => [
+ 'testMarker' => '/* testAddFixableErrorMessage */',
+ 'isError' => true,
+ 'expected' => [
+ 'message' => "Message added. Text: 'test 3'",
+ 'source' => self::CODE,
+ 'fixable' => true,
+ ],
+ ],
+ 'add-fixable-warning' => [
+ 'testMarker' => '/* testAddFixableWarningMessage */',
+ 'isError' => false,
+ 'expected' => [
+ 'message' => "Message added. Text: 'test 4'",
+ 'source' => self::CODE,
+ 'fixable' => true,
+ ],
+ ],
+ ];
+ }
+
+ /**
+ * Helper method to verify the expected message details.
+ *
+ * @param int $stackPtr The stack pointer on which the error/warning is expected.
+ * @param bool $isError Whether to test adding an error or a warning.
+ * @param array $expected Expected error details.
+ *
+ * @return void
+ */
+ protected function verifyRecordedMessages($stackPtr, $isError, $expected)
+ {
+ $tokens = self::$phpcsFile->getTokens();
+ $errors = self::$phpcsFile->getErrors();
+ $warnings = self::$phpcsFile->getWarnings();
+ $result = ($isError === true) ? $errors : $warnings;
+
+ /*
+ * Make sure that no errors/warnings were recorded when the other type is set to be expected.
+ */
+ if ($isError === true) {
+ $this->assertArrayNotHasKey(
+ $tokens[$stackPtr]['line'],
+ $warnings,
+ 'Expected no warnings on line ' . $tokens[$stackPtr]['line'] . '. At least one found.'
+ );
+ } else {
+ $this->assertArrayNotHasKey(
+ $tokens[$stackPtr]['line'],
+ $errors,
+ 'Expected no errors on line ' . $tokens[$stackPtr]['line'] . '. At least one found.'
+ );
+ }
+
+ /*
+ * Make sure the expected array keys for the errors/warnings are available.
+ */
+ $this->assertArrayHasKey(
+ $tokens[$stackPtr]['line'],
+ $result,
+ 'Expected a violation on line ' . $tokens[$stackPtr]['line'] . '. None found.'
+ );
+
+ $this->assertArrayHasKey(
+ $tokens[$stackPtr]['column'],
+ $result[$tokens[$stackPtr]['line']],
+ 'Expected a violation on line ' . $tokens[$stackPtr]['line'] . ', column '
+ . $tokens[$stackPtr]['column'] . '. None found.'
+ );
+
+ $messages = $result[$tokens[$stackPtr]['line']][$tokens[$stackPtr]['column']];
+
+ // Expect one violation.
+ $this->assertCount(1, $messages, 'Expected 1 violation, found: ' . \count($messages));
+
+ $violation = $messages[0];
+
+ // PHPCS 2.x places `unknownSniff.` before the actual error code for utility tests with a dummy error code.
+ $violation['source'] = \str_replace('unknownSniff.', '', $violation['source']);
+
+ /*
+ * Test the violation details.
+ */
+ foreach ($expected as $key => $value) {
+ $this->assertSame($value, $violation[$key], \ucfirst($key) . ' comparison failed');
+ }
+ }
+}
diff --git a/Tests/Utils/MessageHelper/ShowEscapeCharsTest.php b/Tests/Utils/MessageHelper/ShowEscapeCharsTest.php
new file mode 100644
index 00000000..a2240cb6
--- /dev/null
+++ b/Tests/Utils/MessageHelper/ShowEscapeCharsTest.php
@@ -0,0 +1,90 @@
+assertSame($expected, MessageHelper::showEscapeChars($input));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testShowEscapeChars() For the array format.
+ *
+ * @return array
+ */
+ public function dataShowEscapeChars()
+ {
+ return [
+ 'no-escape-chars' => [
+ 'input' => 'if ($var === true) {',
+ 'expected' => 'if ($var === true) {',
+ ],
+ 'has-escape-chars-in-single-quoted-string' => [
+ 'input' => 'if ($var === true) {\r\n\t// Do something.\r\n}',
+ 'expected' => 'if ($var === true) {\r\n\t// Do something.\r\n}',
+ ],
+ 'has-real-tabs' => [
+ 'input' => '$var = 123;',
+ 'expected' => '$var\t\t= 123;',
+ ],
+ 'has-tab-escape-chars-in-double-quoted-string' => [
+ 'input' => "\$var\t\t= 123;",
+ 'expected' => '$var\t\t= 123;',
+ ],
+ 'has-real-new-line' => [
+ 'input' => '$foo = 123;
+$bar = 456;',
+ 'expected' => '$foo = 123;\n$bar = 456;',
+ ],
+ 'has-new-line-escape-char-in-double-quoted-string' => [
+ 'input' => "\$foo = 123;\n\$bar = 456;",
+ 'expected' => '$foo = 123;\n$bar = 456;',
+ ],
+ 'has-real-tab-and-new-lines' => [
+ 'input' => 'if ($var === true) {
+ // Do something.
+}',
+ 'expected' => 'if ($var === true) {\n\t// Do something.\n}',
+ ],
+ 'has-tab-and-new-lines-escape-chars-in-double-quoted-string' => [
+ 'input' => "if (\$var === true) {\r\n\t// Do something.\r\n}",
+ 'expected' => 'if ($var === true) {\r\n\t// Do something.\r\n}',
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/MessageHelper/StringToErrorcodeTest.php b/Tests/Utils/MessageHelper/StringToErrorcodeTest.php
new file mode 100644
index 00000000..f45f46b1
--- /dev/null
+++ b/Tests/Utils/MessageHelper/StringToErrorcodeTest.php
@@ -0,0 +1,127 @@
+assertSame($expected, MessageHelper::stringToErrorCode($input));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testStringToErrorCode() For the array format.
+ *
+ * @return array
+ */
+ public function dataStringToErrorCode()
+ {
+ return [
+ 'no-special-chars' => [
+ 'input' => 'dir_name',
+ 'expected' => 'dir_name',
+ ],
+ 'full-stop' => [
+ 'input' => 'soap.wsdl_cache',
+ 'expected' => 'soap_wsdl_cache',
+ ],
+ 'dash-and-space' => [
+ 'input' => 'arbitrary-string with space',
+ 'expected' => 'arbitrary_string_with_space',
+ ],
+ 'no-alphanum-chars' => [
+ 'input' => '^%*&%*ۈ?',
+ 'expected' => '____________',
+ ],
+ 'mixed-case-chars' => [
+ 'input' => 'MyArbitraryName',
+ 'expected' => 'MyArbitraryName',
+ ],
+ 'mixed-case-chars-with-special-chars' => [
+ 'input' => 'My-Arb#tr$ryN@me',
+ 'expected' => 'My_Arb_tr_ryN_me',
+ ],
+ ];
+ }
+
+ /**
+ * Test the stringToErrorcode() method.
+ *
+ * @dataProvider dataStringToErrorCodeWithCaseChange
+ *
+ * @param string $input The input string.
+ * @param string $expected The expected function output.
+ *
+ * @return void
+ */
+ public function testStringToErrorCodeWithCaseChange($input, $expected)
+ {
+ $this->assertSame($expected, MessageHelper::stringToErrorCode($input, true));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testStringToErrorCode() For the array format.
+ *
+ * @return array
+ */
+ public function dataStringToErrorCodeWithCaseChange()
+ {
+ return [
+ 'no-special-chars' => [
+ 'input' => 'dir_name',
+ 'expected' => 'dir_name',
+ ],
+ 'no-alphanum-chars' => [
+ 'input' => '^%*&%*ۈ?',
+ 'expected' => '____________',
+ ],
+ 'mixed-case-chars' => [
+ 'input' => 'MyArbitraryName',
+ 'expected' => 'myarbitraryname',
+ ],
+ 'mixed-case-chars-with-special-chars' => [
+ 'input' => 'My-Arb#tr$ryN@me',
+ 'expected' => 'my_arb_tr_ryn_me',
+ ],
+ 'mixed-case-chars-non-alpha' => [
+ 'input' => 'MyÄrbÌtraryNãme',
+ 'expected' => 'my__rb__traryn__me',
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/Namespaces/DetermineNamespaceTest.inc b/Tests/Utils/Namespaces/DetermineNamespaceTest.inc
index 911813af..e99c5561 100644
--- a/Tests/Utils/Namespaces/DetermineNamespaceTest.inc
+++ b/Tests/Utils/Namespaces/DetermineNamespaceTest.inc
@@ -114,7 +114,12 @@ echo 0;
/**
* Docblock to skip over.
*/
+#[
+ AttributeToSkipOver,
+ AnotherAttribute,
+]
class Foo {
+ #[AttributeToSkipOver()] #[AnotherAttribute]
function test() {
/* testNonScopedNamedNamespace2Nested */
echo 0;
diff --git a/Tests/Utils/Namespaces/DetermineNamespaceTest.php b/Tests/Utils/Namespaces/DetermineNamespaceTest.php
index 774b9e16..3256217a 100644
--- a/Tests/Utils/Namespaces/DetermineNamespaceTest.php
+++ b/Tests/Utils/Namespaces/DetermineNamespaceTest.php
@@ -10,6 +10,7 @@
namespace PHPCSUtils\Tests\Utils\Namespaces;
+use PHPCSUtils\Internal\Cache;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
use PHPCSUtils\Utils\Namespaces;
@@ -24,7 +25,7 @@
*
* @since 1.0.0
*/
-class DetermineNamespaceTest extends UtilityMethodTestCase
+final class DetermineNamespaceTest extends UtilityMethodTestCase
{
/**
@@ -89,99 +90,99 @@ public function dataDetermineNamespace()
{
return [
'no-namespace' => [
- '/* testNoNamespace */',
- [
+ 'testMarker' => '/* testNoNamespace */',
+ 'expected' => [
'ptr' => false,
'name' => '',
],
],
'no-namespace-nested' => [
- '/* testNoNamespaceNested */',
- [
+ 'testMarker' => '/* testNoNamespaceNested */',
+ 'expected' => [
'ptr' => false,
'name' => '',
],
],
'non-scoped-namespace-1' => [
- '/* testNonScopedNamedNamespace1 */',
- [
+ 'testMarker' => '/* testNonScopedNamedNamespace1 */',
+ 'expected' => [
'ptr' => '/* Non-scoped named namespace 1 */',
'name' => 'Vendor\Package\Baz',
],
],
'non-scoped-namespace-1-nested' => [
- '/* testNonScopedNamedNamespace1Nested */',
- [
+ 'testMarker' => '/* testNonScopedNamedNamespace1Nested */',
+ 'expected' => [
'ptr' => '/* Non-scoped named namespace 1 */',
'name' => 'Vendor\Package\Baz',
],
],
'global-namespace-scoped' => [
- '/* testGlobalNamespaceScoped */',
- [
+ 'testMarker' => '/* testGlobalNamespaceScoped */',
+ 'expected' => [
'ptr' => '/* Scoped global namespace */',
'name' => '',
],
],
'global-namespace-scoped-nested' => [
- '/* testGlobalNamespaceScopedNested */',
- [
+ 'testMarker' => '/* testGlobalNamespaceScopedNested */',
+ 'expected' => [
'ptr' => '/* Scoped global namespace */',
'name' => '',
],
],
'no-namespace-after-unnamed-scoped' => [
- '/* testNoNamespaceAfterUnnamedScoped */',
- [
+ 'testMarker' => '/* testNoNamespaceAfterUnnamedScoped */',
+ 'expected' => [
'ptr' => false,
'name' => '',
],
],
'no-namespace-nested-after-unnamed-scoped' => [
- '/* testNoNamespaceNestedAfterUnnamedScoped */',
- [
+ 'testMarker' => '/* testNoNamespaceNestedAfterUnnamedScoped */',
+ 'expected' => [
'ptr' => false,
'name' => '',
],
],
'named-namespace-scoped' => [
- '/* testNamedNamespaceScoped */',
- [
+ 'testMarker' => '/* testNamedNamespaceScoped */',
+ 'expected' => [
'ptr' => '/* Scoped named namespace */',
'name' => 'Vendor\Package\Foo',
],
],
'named-namespace-scoped-nested' => [
- '/* testNamedNamespaceScopedNested */',
- [
+ 'testMarker' => '/* testNamedNamespaceScopedNested */',
+ 'expected' => [
'ptr' => '/* Scoped named namespace */',
'name' => 'Vendor\Package\Foo',
],
],
'no-namespace-after-named-scoped' => [
- '/* testNoNamespaceAfterNamedScoped */',
- [
+ 'testMarker' => '/* testNoNamespaceAfterNamedScoped */',
+ 'expected' => [
'ptr' => false,
'name' => '',
],
],
'no-namespace-nested-after-named-scoped' => [
- '/* testNoNamespaceNestedAfterNamedScoped */',
- [
+ 'testMarker' => '/* testNoNamespaceNestedAfterNamedScoped */',
+ 'expected' => [
'ptr' => false,
'name' => '',
],
],
'non-scoped-namespace-2' => [
- '/* testNonScopedNamedNamespace2 */',
- [
+ 'testMarker' => '/* testNonScopedNamedNamespace2 */',
+ 'expected' => [
'ptr' => '/* Non-scoped named namespace 2 */',
'name' => 'Vendor\Package\Foz',
],
],
'non-scoped-namespace-2-nested' => [
- '/* testNonScopedNamedNamespace2Nested */',
- [
+ 'testMarker' => '/* testNonScopedNamedNamespace2Nested */',
+ 'expected' => [
'ptr' => '/* Non-scoped named namespace 2 */',
'name' => 'Vendor\Package\Foz',
],
@@ -189,6 +190,40 @@ public function dataDetermineNamespace()
];
}
+ /**
+ * Verify that the build-in caching is used when caching is enabled.
+ *
+ * @return void
+ */
+ public function testFindNamespacePtrResultIsCached()
+ {
+ // The test case used is specifically selected to be one which will always reach the cache check.
+ $methodName = 'PHPCSUtils\\Utils\\Namespaces::findNamespacePtr';
+ $cases = $this->dataDetermineNamespace();
+ $testMarker = $cases['non-scoped-namespace-2']['testMarker'];
+ $expected = $cases['non-scoped-namespace-2']['expected']['ptr'];
+
+ $stackPtr = $this->getTargetToken($testMarker, \T_ECHO);
+ $expected = $this->getTargetToken($expected, \T_NAMESPACE);
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = Namespaces::findNamespacePtr(self::$phpcsFile, $stackPtr);
+ $isCached = Cache::isCached(self::$phpcsFile, $methodName, $stackPtr);
+ $resultSecondRun = Namespaces::findNamespacePtr(self::$phpcsFile, $stackPtr);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertSame($expected, $resultFirstRun, 'First result did not match expectation');
+ $this->assertTrue($isCached, 'Cache::isCached() could not find the cached value');
+ $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+ }
+
/**
* Test that the namespace declaration itself is not regarded as being namespaced.
*
@@ -200,7 +235,14 @@ public function testNamespaceDeclarationIsNotNamespaced()
$result = Namespaces::findNamespacePtr(self::$phpcsFile, $stackPtr);
$this->assertFalse($result, 'Failed checking that namespace declaration token is not regarded as namespaced');
- $stackPtr = $this->getTargetToken('/* Non-scoped named namespace 2 */', \T_STRING, 'Package');
+ $targetType = \T_STRING;
+ $targetContent = 'Package';
+ if (parent::usesPhp8NameTokens() === true) {
+ $targetType = \T_NAME_QUALIFIED;
+ $targetContent = 'Vendor\Package\Foz';
+ }
+
+ $stackPtr = $this->getTargetToken('/* Non-scoped named namespace 2 */', $targetType, $targetContent);
$result = Namespaces::findNamespacePtr(self::$phpcsFile, $stackPtr);
$this->assertFalse($result, 'Failed checking that a token in the namespace name is not regarded as namespaced');
}
diff --git a/Tests/Utils/Namespaces/GetDeclaredNameTest.php b/Tests/Utils/Namespaces/GetDeclaredNameTest.php
index fe8c3c40..bfbfc518 100644
--- a/Tests/Utils/Namespaces/GetDeclaredNameTest.php
+++ b/Tests/Utils/Namespaces/GetDeclaredNameTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetDeclaredNameTest extends UtilityMethodTestCase
+final class GetDeclaredNameTest extends UtilityMethodTestCase
{
/**
@@ -46,11 +46,18 @@ public function testInvalidTokenPassed()
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param array $expected The expected output for the function.
+ * @param bool $skipOnPHP8 Optional. Whether the test should be skipped when the PHP 8 identifier
+ * name tokenization is used (as the target token won't exist).
+ * Defaults to `false`.
*
* @return void
*/
- public function testGetDeclaredNameClean($testMarker, $expected)
+ public function testGetDeclaredNameClean($testMarker, $expected, $skipOnPHP8 = false)
{
+ if ($skipOnPHP8 === true && parent::usesPhp8NameTokens() === true) {
+ $this->markTestSkipped("PHP 8.0 identifier name tokenization used. Target token won't exist.");
+ }
+
$stackPtr = $this->getTargetToken($testMarker, \T_NAMESPACE);
$result = Namespaces::getDeclaredName(self::$phpcsFile, $stackPtr, true);
@@ -64,11 +71,18 @@ public function testGetDeclaredNameClean($testMarker, $expected)
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param array $expected The expected output for the function.
+ * @param bool $skipOnPHP8 Optional. Whether the test should be skipped when the PHP 8 identifier
+ * name tokenization is used (as the target token won't exist).
+ * Defaults to `false`.
*
* @return void
*/
- public function testGetDeclaredNameDirty($testMarker, $expected)
+ public function testGetDeclaredNameDirty($testMarker, $expected, $skipOnPHP8 = false)
{
+ if ($skipOnPHP8 === true && parent::usesPhp8NameTokens() === true) {
+ $this->markTestSkipped("PHP 8.0 identifier name tokenization used. Target token won't exist.");
+ }
+
$stackPtr = $this->getTargetToken($testMarker, \T_NAMESPACE);
$result = Namespaces::getDeclaredName(self::$phpcsFile, $stackPtr, false);
@@ -86,50 +100,50 @@ public function dataGetDeclaredName()
{
return [
'global-namespace-curlies' => [
- '/* testGlobalNamespaceCurlies */',
- [
+ 'testMarker' => '/* testGlobalNamespaceCurlies */',
+ 'expected' => [
'clean' => '',
'dirty' => '',
],
],
'namespace-semicolon' => [
- '/* testNamespaceSemiColon */',
- [
+ 'testMarker' => '/* testNamespaceSemiColon */',
+ 'expected' => [
'clean' => 'Vendor',
'dirty' => 'Vendor',
],
],
'namespace-curlies' => [
- '/* testNamespaceCurlies */',
- [
+ 'testMarker' => '/* testNamespaceCurlies */',
+ 'expected' => [
'clean' => 'Vendor\Package\Sublevel\End',
'dirty' => 'Vendor\Package\Sublevel\End',
],
],
'namespace-curlies-no-space-at-end' => [
- '/* testNamespaceCurliesNoSpaceAtEnd */',
- [
+ 'testMarker' => '/* testNamespaceCurliesNoSpaceAtEnd */',
+ 'expected' => [
'clean' => 'Vendor\Package\Sublevel\Deeperlevel\End',
'dirty' => 'Vendor\Package\Sublevel\Deeperlevel\End',
],
],
'namespace-close-tag' => [
- '/* testNamespaceCloseTag */',
- [
+ 'testMarker' => '/* testNamespaceCloseTag */',
+ 'expected' => [
'clean' => 'My\Name',
'dirty' => 'My\Name',
],
],
'namespace-close-tag-no-space-at-end' => [
- '/* testNamespaceCloseTagNoSpaceAtEnd */',
- [
+ 'testMarker' => '/* testNamespaceCloseTagNoSpaceAtEnd */',
+ 'expected' => [
'clean' => 'My\Other\Name',
'dirty' => 'My\Other\Name',
],
],
'namespace-whitespace-tolerance' => [
- '/* testNamespaceLotsOfWhitespace */',
- [
+ 'testMarker' => '/* testNamespaceLotsOfWhitespace */',
+ 'expected' => [
'clean' => 'Vendor\Package\Sub\Deeperlevel\End',
'dirty' => 'Vendor \
Package\
@@ -139,8 +153,8 @@ public function dataGetDeclaredName()
],
],
'namespace-with-comments-and-annotations' => [
- '/* testNamespaceWithCommentsWhitespaceAndAnnotations */',
- [
+ 'testMarker' => '/* testNamespaceWithCommentsWhitespaceAndAnnotations */',
+ 'expected' => [
'clean' => 'Vendor\Package\Sublevel\Deeper\End',
'dirty' => 'Vendor\/*comment*/
Package\Sublevel \ //phpcs:ignore Standard.Category.Sniff -- for reasons.
@@ -149,29 +163,30 @@ public function dataGetDeclaredName()
],
],
'namespace-operator' => [
- '/* testNamespaceOperator */',
- [
+ 'testMarker' => '/* testNamespaceOperator */',
+ 'expected' => [
'clean' => false,
'dirty' => false,
],
+ 'skipOnPHP8' => true,
],
'parse-error-reserved-keywords' => [
- '/* testParseErrorReservedKeywords */',
- [
+ 'testMarker' => '/* testParseErrorReservedKeywords */',
+ 'expected' => [
'clean' => 'Vendor\while\Package\protected\name\try\this',
'dirty' => 'Vendor\while\Package\protected\name\try\this',
],
],
'parse-error-semicolon' => [
- '/* testParseErrorSemiColon */',
- [
+ 'testMarker' => '/* testParseErrorSemiColon */',
+ 'expected' => [
'clean' => false,
'dirty' => false,
],
],
'live-coding' => [
- '/* testLiveCoding */',
- [
+ 'testMarker' => '/* testLiveCoding */',
+ 'expected' => [
'clean' => false,
'dirty' => false,
],
diff --git a/Tests/Utils/Namespaces/NamespaceTypeTest.inc b/Tests/Utils/Namespaces/NamespaceTypeTest.inc
index 99e13c1a..7b9c31ab 100644
--- a/Tests/Utils/Namespaces/NamespaceTypeTest.inc
+++ b/Tests/Utils/Namespaces/NamespaceTypeTest.inc
@@ -45,6 +45,9 @@ namespace\ClassName::$property++;
/* testNamespaceOperatorGlobalNamespaceStartOfStatementCombiWithNonConfusingToken3 */
namespace\CONSTANT['key'];
+/* testNamespaceOperatorGlobalNamespaceStartOfStatementCombiWithNonConfusingToken4 */
+namespace\functionReturningObj()?->chained();
+
/* testParseErrorScopedNamespaceDeclaration */
function testScope() {
diff --git a/Tests/Utils/Namespaces/NamespaceTypeTest.php b/Tests/Utils/Namespaces/NamespaceTypeTest.php
index 5eb39394..320eae61 100644
--- a/Tests/Utils/Namespaces/NamespaceTypeTest.php
+++ b/Tests/Utils/Namespaces/NamespaceTypeTest.php
@@ -26,7 +26,7 @@
*
* @since 1.0.0
*/
-class NamespaceTypeTest extends UtilityMethodTestCase
+final class NamespaceTypeTest extends UtilityMethodTestCase
{
/**
@@ -60,11 +60,18 @@ public function testNonNamespaceToken()
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param array $expected The expected output for the functions.
+ * @param bool $skipOnPHP8 Optional. Whether the test should be skipped when the PHP 8 identifier
+ * name tokenization is used (as the target token won't exist).
+ * Defaults to `false`.
*
* @return void
*/
- public function testIsDeclaration($testMarker, $expected)
+ public function testIsDeclaration($testMarker, $expected, $skipOnPHP8 = false)
{
+ if ($skipOnPHP8 === true && parent::usesPhp8NameTokens() === true) {
+ $this->markTestSkipped("PHP 8.0 identifier name tokenization used. Target token won't exist.");
+ }
+
$stackPtr = $this->getTargetToken($testMarker, \T_NAMESPACE);
$result = Namespaces::isDeclaration(self::$phpcsFile, $stackPtr);
@@ -78,11 +85,18 @@ public function testIsDeclaration($testMarker, $expected)
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param array $expected The expected output for the functions.
+ * @param bool $skipOnPHP8 Optional. Whether the test should be skipped when the PHP 8 identifier
+ * name tokenization is used (as the target token won't exist).
+ * Defaults to `false`.
*
* @return void
*/
- public function testIsOperator($testMarker, $expected)
+ public function testIsOperator($testMarker, $expected, $skipOnPHP8 = false)
{
+ if ($skipOnPHP8 === true && parent::usesPhp8NameTokens() === true) {
+ $this->markTestSkipped("PHP 8.0 identifier name tokenization used. Target token won't exist.");
+ }
+
$stackPtr = $this->getTargetToken($testMarker, \T_NAMESPACE);
$result = Namespaces::isOperator(self::$phpcsFile, $stackPtr);
@@ -101,128 +115,144 @@ public function dataNamespaceType()
{
return [
'namespace-declaration' => [
- '/* testNamespaceDeclaration */',
- [
+ 'testMarker' => '/* testNamespaceDeclaration */',
+ 'expected' => [
'declaration' => true,
'operator' => false,
],
],
'namespace-declaration-with-comment' => [
- '/* testNamespaceDeclarationWithComment */',
- [
+ 'testMarker' => '/* testNamespaceDeclarationWithComment */',
+ 'expected' => [
'declaration' => true,
'operator' => false,
],
],
'namespace-declaration-scoped' => [
- '/* testNamespaceDeclarationScoped */',
- [
+ 'testMarker' => '/* testNamespaceDeclarationScoped */',
+ 'expected' => [
'declaration' => true,
'operator' => false,
],
],
'namespace-operator' => [
- '/* testNamespaceOperator */',
- [
+ 'testMarker' => '/* testNamespaceOperator */',
+ 'expected' => [
'declaration' => false,
'operator' => true,
],
+ 'skipOnPHP8' => true,
],
'namespace-operator-with-annotation' => [
- '/* testNamespaceOperatorWithAnnotation */',
- [
+ 'testMarker' => '/* testNamespaceOperatorWithAnnotation */',
+ 'expected' => [
'declaration' => false,
'operator' => true,
],
],
'namespace-operator-in-conditional' => [
- '/* testNamespaceOperatorInConditional */',
- [
+ 'testMarker' => '/* testNamespaceOperatorInConditional */',
+ 'expected' => [
'declaration' => false,
'operator' => true,
],
+ 'skipOnPHP8' => true,
],
'namespace-operator-in-closed-scope' => [
- '/* testNamespaceOperatorInClosedScope */',
- [
+ 'testMarker' => '/* testNamespaceOperatorInClosedScope */',
+ 'expected' => [
'declaration' => false,
'operator' => true,
],
+ 'skipOnPHP8' => true,
],
'namespace-operator-in-parentheses' => [
- '/* testNamespaceOperatorInParentheses */',
- [
+ 'testMarker' => '/* testNamespaceOperatorInParentheses */',
+ 'expected' => [
'declaration' => false,
'operator' => true,
],
+ 'skipOnPHP8' => true,
],
'namespace-operator-global-namespace-start-of-statement-function-call' => [
- '/* testNamespaceOperatorGlobalNamespaceStartOfStatementFunctionCall */',
- [
+ 'testMarker' => '/* testNamespaceOperatorGlobalNamespaceStartOfStatementFunctionCall */',
+ 'expected' => [
'declaration' => false,
'operator' => true,
],
+ 'skipOnPHP8' => true,
],
'namespace-operator-global-namespace-start-of-statement-with-non-confusing-token-1' => [
- '/* testNamespaceOperatorGlobalNamespaceStartOfStatementCombiWithNonConfusingToken1 */',
- [
+ 'testMarker' => '/* testNamespaceOperatorGlobalNamespaceStartOfStatementCombiWithNonConfusingToken1 */',
+ 'expected' => [
'declaration' => false,
'operator' => true,
],
+ 'skipOnPHP8' => true,
],
'namespace-operator-global-namespace-start-of-statement-with-non-confusing-token-2' => [
- '/* testNamespaceOperatorGlobalNamespaceStartOfStatementCombiWithNonConfusingToken2 */',
- [
+ 'testMarker' => '/* testNamespaceOperatorGlobalNamespaceStartOfStatementCombiWithNonConfusingToken2 */',
+ 'expected' => [
'declaration' => false,
'operator' => true,
],
+ 'skipOnPHP8' => true,
],
'namespace-operator-global-namespace-start-of-statement-with-non-confusing-token-3' => [
- '/* testNamespaceOperatorGlobalNamespaceStartOfStatementCombiWithNonConfusingToken3 */',
- [
+ 'testMarker' => '/* testNamespaceOperatorGlobalNamespaceStartOfStatementCombiWithNonConfusingToken3 */',
+ 'expected' => [
+ 'declaration' => false,
+ 'operator' => true,
+ ],
+ 'skipOnPHP8' => true,
+ ],
+ 'namespace-operator-global-namespace-start-of-statement-with-non-confusing-token-4' => [
+ 'testMarker' => '/* testNamespaceOperatorGlobalNamespaceStartOfStatementCombiWithNonConfusingToken4 */',
+ 'expected' => [
'declaration' => false,
'operator' => true,
],
+ 'skipOnPHP8' => true,
],
'parse-error-scoped-namespace-declaration' => [
- '/* testParseErrorScopedNamespaceDeclaration */',
- [
+ 'testMarker' => '/* testParseErrorScopedNamespaceDeclaration */',
+ 'expected' => [
'declaration' => false,
'operator' => false,
],
],
'parse-error-conditional-namespace' => [
- '/* testParseErrorConditionalNamespace */',
- [
+ 'testMarker' => '/* testParseErrorConditionalNamespace */',
+ 'expected' => [
'declaration' => false,
'operator' => false,
],
],
'fatal-error-declaration-leading-slash' => [
- '/* testFatalErrorDeclarationLeadingSlash */',
- [
+ 'testMarker' => '/* testFatalErrorDeclarationLeadingSlash */',
+ 'expected' => [
'declaration' => false,
'operator' => false,
],
],
'parse-error-double-colon' => [
- '/* testParseErrorDoubleColon */',
- [
+ 'testMarker' => '/* testParseErrorDoubleColon */',
+ 'expected' => [
'declaration' => false,
'operator' => false,
],
],
'parse-error-semicolon' => [
- '/* testParseErrorSemiColon */',
- [
+ 'testMarker' => '/* testParseErrorSemiColon */',
+ 'expected' => [
'declaration' => false,
'operator' => false,
],
],
'live-coding' => [
- '/* testLiveCoding */',
- [
+ 'testMarker' => '/* testLiveCoding */',
+ 'expected' => [
'declaration' => false,
'operator' => false,
],
diff --git a/Tests/Utils/NamingConventions/IsEqualTest.php b/Tests/Utils/NamingConventions/IsEqualTest.php
index 2f084b4a..85104ce9 100644
--- a/Tests/Utils/NamingConventions/IsEqualTest.php
+++ b/Tests/Utils/NamingConventions/IsEqualTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class IsEqualTest extends TestCase
+final class IsEqualTest extends TestCase
{
/**
@@ -52,49 +52,49 @@ public function dataIsEqual()
{
return [
'a-z-0-9-only-same-case' => [
- 'abcdefghijklmnopqrstuvwxyz_0123456789',
- 'abcdefghijklmnopqrstuvwxyz_0123456789',
- true,
+ 'inputA' => 'abcdefghijklmnopqrstuvwxyz_0123456789',
+ 'inputB' => 'abcdefghijklmnopqrstuvwxyz_0123456789',
+ 'expected' => true,
],
'a-z-0-9-only-different-case' => [
- 'ABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789',
- 'abcdefghijklmnopqrstuvwxyz_0123456789',
- true,
+ 'inputA' => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789',
+ 'inputB' => 'abcdefghijklmnopqrstuvwxyz_0123456789',
+ 'expected' => true,
],
'extended-ascii-same-case' => [
- 'ÇüéâäàåçêëèïîìÄÅÉæÆôöòûùÿÖÜ¢áíóúñÑ',
- 'ÇüéâäàåçêëèïîìÄÅÉæÆôöòûùÿÖÜ¢áíóúñÑ',
- true,
+ 'inputA' => 'ÇüéâäàåçêëèïîìÄÅÉæÆôöòûùÿÖÜ¢áíóúñÑ',
+ 'inputB' => 'ÇüéâäàåçêëèïîìÄÅÉæÆôöòûùÿÖÜ¢áíóúñÑ',
+ 'expected' => true,
],
'extended-ascii-different-case' => [
- 'ÇüéâäàåçêëèïîìÄÅÉæÆôöòûùÿÖÜ¢áíóúñÑ',
- 'çÜÉÂÄÀÅÇÊËÈÏÎÌäåéÆæÔÖÒÛÙŸöü¢ÁÍÓÚÑñ',
- false,
+ 'inputA' => 'ÇüéâäàåçêëèïîìÄÅÉæÆôöòûùÿÖÜ¢áíóúñÑ',
+ 'inputB' => 'çÜÉÂÄÀÅÇÊËÈÏÎÌäåéÆæÔÖÒÛÙŸöü¢ÁÍÓÚÑñ',
+ 'expected' => false,
],
'mixed-ascii-extended-ascii-same-case' => [
- 'Déjàvü',
- 'Déjàvü',
- true,
+ 'inputA' => 'Déjàvü',
+ 'inputB' => 'Déjàvü',
+ 'expected' => true,
],
'mixed-ascii-extended-ascii-different-case-only-for-ascii' => [
- 'Déjàvü',
- 'déJàVü',
- true,
+ 'inputA' => 'Déjàvü',
+ 'inputB' => 'déJàVü',
+ 'expected' => true,
],
'mixed-ascii-extended-ascii-different-case' => [
- 'Déjàvü',
- 'DÉJÀVÜ',
- false,
+ 'inputA' => 'Déjàvü',
+ 'inputB' => 'DÉJÀVÜ',
+ 'expected' => false,
],
'emoji-name' => [
- '💩💩💩',
- '💩💩💩',
- true,
+ 'inputA' => '💩💩💩',
+ 'inputB' => '💩💩💩',
+ 'expected' => true,
],
'invalid-input-but-not-relevant' => [
- true,
- true,
- true,
+ 'inputA' => true,
+ 'inputB' => true,
+ 'expected' => true,
],
];
}
diff --git a/Tests/Utils/NamingConventions/IsValidIdentifierNameTest.php b/Tests/Utils/NamingConventions/IsValidIdentifierNameTest.php
index 316a0283..d3b6b195 100644
--- a/Tests/Utils/NamingConventions/IsValidIdentifierNameTest.php
+++ b/Tests/Utils/NamingConventions/IsValidIdentifierNameTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class IsValidIdentifierNameTest extends TestCase
+final class IsValidIdentifierNameTest extends TestCase
{
/**
@@ -52,78 +52,78 @@ public function dataIsValidIdentifierName()
return [
// Valid names.
'a-z-only' => [
- 'valid_name',
- true,
+ 'input' => 'valid_name',
+ 'expected' => true,
],
'a-z-uppercase' => [
- 'VALID_NAME',
- true,
+ 'input' => 'VALID_NAME',
+ 'expected' => true,
],
'a-z-camel-caps' => [
- 'Valid_Name',
- true,
+ 'input' => 'Valid_Name',
+ 'expected' => true,
],
'alphanum-mixed-case' => [
- 'VaLiD128NaMe',
- true,
+ 'input' => 'VaLiD128NaMe',
+ 'expected' => true,
],
'underscore-prefix' => [
- '_valid_name',
- true,
+ 'input' => '_valid_name',
+ 'expected' => true,
],
'double-underscore-prefix' => [
- '__valid_name',
- true,
+ 'input' => '__valid_name',
+ 'expected' => true,
],
'extended-ascii-lowercase' => [
- 'пасха',
- true,
+ 'input' => 'пасха',
+ 'expected' => true,
],
'extended-ascii-mixed-case' => [
- 'Пасха',
- true,
+ 'input' => 'Пасха',
+ 'expected' => true,
],
'extended-ascii-non-letter' => [
- '¢£¥ƒ¿½¼«»±÷˜°²',
- true,
+ 'input' => '¢£¥ƒ¿½¼«»±÷˜°²',
+ 'expected' => true,
],
'emoji-name-1' => [
- '💩💩💩',
- true,
+ 'input' => '💩💩💩',
+ 'expected' => true,
],
'emoji-name-2' => [
- '😎',
- true,
+ 'input' => '😎',
+ 'expected' => true,
],
// Invalid names.
'not-a-string' => [
- 12345,
- false,
+ 'input' => 12345,
+ 'expected' => false,
],
'empty-string' => [
- '',
- false,
+ 'input' => '',
+ 'expected' => false,
],
'name-with-whitespace' => [
- 'aa bb',
- false,
+ 'input' => 'aa bb',
+ 'expected' => false,
],
'starts-with-number' => [
- '2beornot2be',
- false,
+ 'input' => '2beornot2be',
+ 'expected' => false,
],
'name-with-quotes-in-it' => [
- "aa'1'",
- false,
+ 'input' => "aa'1'",
+ 'expected' => false,
],
'name-with-dash' => [
- 'some-thing',
- false,
+ 'input' => 'some-thing',
+ 'expected' => false,
],
'name-with-punctuation-chars' => [
- '!@#$%&*(){}[]',
- false,
+ 'input' => '!@#$%&*(){}[]',
+ 'expected' => false,
],
];
}
diff --git a/Tests/Utils/Numbers/GetCompleteNumberTest.inc b/Tests/Utils/Numbers/GetCompleteNumberTest.inc
index 475b68ac..bf808e58 100644
--- a/Tests/Utils/Numbers/GetCompleteNumberTest.inc
+++ b/Tests/Utils/Numbers/GetCompleteNumberTest.inc
@@ -1,7 +1,7 @@
');
- self::$usableBackfill = \version_compare(self::$phpcsVersion, Numbers::UNSUPPORTED_PHPCS_VERSION, '>');
- }
-
/**
* Test receiving an exception when a non-numeric token is passed to the method.
*
@@ -76,25 +38,6 @@ public function testNotANumberException()
Numbers::getCompleteNumber(self::$phpcsFile, $stackPtr);
}
- /**
- * Test receiving an exception when PHPCS is run on PHP < 7.4 in combination with PHPCS 3.5.3.
- *
- * @return void
- */
- public function testUnsupportedPhpcsException()
- {
- if (\version_compare(static::$phpcsVersion, Numbers::UNSUPPORTED_PHPCS_VERSION, '!=') === true) {
- $this->markTestSkipped('Test specific to a limited set of PHPCS versions');
- }
-
- $this->expectPhpcsException(
- 'The PHPCSUtils\Utils\Numbers::getCompleteNumber() method does not support PHPCS '
- );
-
- $stackPtr = $this->getTargetToken('/* testPHP74IntDecimalMultiUnderscore */', \T_LNUMBER);
- Numbers::getCompleteNumber(self::$phpcsFile, $stackPtr);
- }
-
/**
* Test correctly identifying all tokens belonging to a numeric literal.
*
@@ -107,13 +50,6 @@ public function testUnsupportedPhpcsException()
*/
public function testGetCompleteNumber($testMarker, $expected)
{
- // Skip the test(s) on unsupported PHPCS versions.
- if (\version_compare(static::$phpcsVersion, Numbers::UNSUPPORTED_PHPCS_VERSION, '==') === true) {
- $this->markTestSkipped(
- 'PHPCS ' . static::$phpcsVersion . ' is not supported due to buggy numeric string literal backfill.'
- );
- }
-
$stackPtr = $this->getTargetToken($testMarker, [\T_LNUMBER, \T_DNUMBER]);
$expected['last_token'] += $stackPtr;
@@ -136,12 +72,6 @@ public function testGetCompleteNumber($testMarker, $expected)
*/
public function dataGetCompleteNumber()
{
- self::setUpStaticProperties();
- $multiToken = true;
- if (self::$php74OrHigher === true || self::$usableBackfill === true) {
- $multiToken = false;
- }
-
/*
* Disabling the hexnumeric string detection for the rest of the file.
* These are only strings within the context of PHPCS and need to be tested as such.
@@ -152,8 +82,8 @@ public function dataGetCompleteNumber()
return [
// Ordinary numbers.
'normal-integer-decimal' => [
- '/* testIntDecimal */',
- [
+ 'testMarker' => '/* testIntDecimal */',
+ 'expected' => [
'orig_content' => '1000000000',
'content' => '1000000000',
'code' => \T_LNUMBER,
@@ -162,9 +92,20 @@ public function dataGetCompleteNumber()
'last_token' => 0, // Offset from $stackPtr.
],
],
+ 'normal-integer-larger-than-intmax-is-float' => [
+ 'testMarker' => '/* testIntLargerThanIntMaxIsFloat */',
+ 'expected' => [
+ 'orig_content' => '10223372036854775810',
+ 'content' => '10223372036854775810',
+ 'code' => \T_DNUMBER,
+ 'type' => 'T_DNUMBER',
+ 'decimal' => '10223372036854775810',
+ 'last_token' => 0, // Offset from $stackPtr.
+ ],
+ ],
'normal-float' => [
- '/* testFloat */',
- [
+ 'testMarker' => '/* testFloat */',
+ 'expected' => [
'orig_content' => '107925284.88',
'content' => '107925284.88',
'code' => \T_DNUMBER,
@@ -174,8 +115,8 @@ public function dataGetCompleteNumber()
],
],
'normal-float-negative' => [
- '/* testFloatNegative */',
- [
+ 'testMarker' => '/* testFloatNegative */',
+ 'expected' => [
'orig_content' => '58987.789',
'content' => '58987.789',
'code' => \T_DNUMBER,
@@ -185,8 +126,8 @@ public function dataGetCompleteNumber()
],
],
'normal-integer-binary' => [
- '/* testIntBinary */',
- [
+ 'testMarker' => '/* testIntBinary */',
+ 'expected' => [
'orig_content' => '0b1',
'content' => '0b1',
'code' => \T_LNUMBER,
@@ -196,8 +137,8 @@ public function dataGetCompleteNumber()
],
],
'normal-integer-hex' => [
- '/* testIntHex */',
- [
+ 'testMarker' => '/* testIntHex */',
+ 'expected' => [
'orig_content' => '0xA',
'content' => '0xA',
'code' => \T_LNUMBER,
@@ -207,8 +148,8 @@ public function dataGetCompleteNumber()
],
],
'normal-integer-octal' => [
- '/* testIntOctal */',
- [
+ 'testMarker' => '/* testIntOctal */',
+ 'expected' => [
'orig_content' => '052',
'content' => '052',
'code' => \T_LNUMBER,
@@ -220,8 +161,8 @@ public function dataGetCompleteNumber()
// Parse error.
'parse-error' => [
- '/* testParseError */',
- [
+ 'testMarker' => '/* testParseError */',
+ 'expected' => [
'orig_content' => '100',
'content' => '100',
'code' => \T_LNUMBER,
@@ -233,188 +174,199 @@ public function dataGetCompleteNumber()
// Numeric literal with underscore.
'php-7.4-integer-decimal-multi-underscore' => [
- '/* testPHP74IntDecimalMultiUnderscore */',
- [
+ 'testMarker' => '/* testPHP74IntDecimalMultiUnderscore */',
+ 'expected' => [
'orig_content' => '1_000_000_000',
'content' => '1000000000',
'code' => \T_LNUMBER,
'type' => 'T_LNUMBER',
'decimal' => '1000000000',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
+ ],
+ ],
+ 'php-7.4-integer-larger-than-intmax-is-float' => [
+ 'testMarker' => '/* testPHP74IntLargerThanIntMaxIsFloat */',
+ 'expected' => [
+ 'orig_content' => '10_223_372_036_854_775_810',
+ 'content' => '10223372036854775810',
+ 'code' => \T_DNUMBER,
+ 'type' => 'T_DNUMBER',
+ 'decimal' => '10223372036854775810',
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-float' => [
- '/* testPHP74Float */',
- [
+ 'testMarker' => '/* testPHP74Float */',
+ 'expected' => [
'orig_content' => '107_925_284.88',
'content' => '107925284.88',
'code' => \T_DNUMBER,
'type' => 'T_DNUMBER',
'decimal' => '107925284.88',
- 'last_token' => $multiToken ? 2 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-integer-decimal-single-underscore' => [
- '/* testPHP74IntDecimalSingleUnderscore */',
- [
+ 'testMarker' => '/* testPHP74IntDecimalSingleUnderscore */',
+ 'expected' => [
'orig_content' => '135_00',
'content' => '13500',
'code' => \T_LNUMBER,
'type' => 'T_LNUMBER',
'decimal' => '13500',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-float-exponent-negative' => [
- '/* testPHP74FloatExponentNegative */',
- [
+ 'testMarker' => '/* testPHP74FloatExponentNegative */',
+ 'expected' => [
'orig_content' => '6.674_083e-11',
'content' => '6.674083e-11',
'code' => \T_DNUMBER,
'type' => 'T_DNUMBER',
'decimal' => '6.674083e-11',
- 'last_token' => $multiToken ? 3 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-float-exponent-positive' => [
- '/* testPHP74FloatExponentPositive */',
- [
+ 'testMarker' => '/* testPHP74FloatExponentPositive */',
+ 'expected' => [
'orig_content' => '6.674_083e+11',
'content' => '6.674083e+11',
'code' => \T_DNUMBER,
'type' => 'T_DNUMBER',
'decimal' => '6.674083e+11',
- 'last_token' => $multiToken ? 3 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-integer-decimal-multi-underscore-2' => [
- '/* testPHP74IntDecimalMultiUnderscore2 */',
- [
+ 'testMarker' => '/* testPHP74IntDecimalMultiUnderscore2 */',
+ 'expected' => [
'orig_content' => '299_792_458',
'content' => '299792458',
'code' => \T_LNUMBER,
'type' => 'T_LNUMBER',
'decimal' => '299792458',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-integer-hex' => [
- '/* testPHP74IntHex */',
- [
+ 'testMarker' => '/* testPHP74IntHex */',
+ 'expected' => [
'orig_content' => '0xCAFE_F00D',
'content' => '0xCAFEF00D',
'code' => \T_LNUMBER,
'type' => 'T_LNUMBER',
'decimal' => '3405705229',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-integer-binary' => [
- '/* testPHP74IntBinary */',
- [
+ 'testMarker' => '/* testPHP74IntBinary */',
+ 'expected' => [
'orig_content' => '0b0101_1111',
'content' => '0b01011111',
'code' => \T_LNUMBER,
'type' => 'T_LNUMBER',
'decimal' => '95',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-integer-octal' => [
- '/* testPHP74IntOctal */',
- [
+ 'testMarker' => '/* testPHP74IntOctal */',
+ 'expected' => [
'orig_content' => '0137_041',
'content' => '0137041',
'code' => \T_LNUMBER,
'type' => 'T_LNUMBER',
'decimal' => '48673',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-float-exponent-multi-underscore' => [
- '/* testPHP74FloatExponentMultiUnderscore */',
- [
+ 'testMarker' => '/* testPHP74FloatExponentMultiUnderscore */',
+ 'expected' => [
'orig_content' => '1_2.3_4e1_23',
'content' => '12.34e123',
'code' => \T_DNUMBER,
'type' => 'T_DNUMBER',
'decimal' => '12.34e123',
- 'last_token' => $multiToken ? 3 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
// Make sure the backfill doesn't do more than it should.
'php-7.4-integer-calculation-1' => [
- '/* testPHP74IntCalc1 */',
- [
+ 'testMarker' => '/* testPHP74IntCalc1 */',
+ 'expected' => [
'orig_content' => '667_083',
'content' => '667083',
'code' => \T_LNUMBER,
'type' => 'T_LNUMBER',
'decimal' => '667083',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-integer-calculation-2' => [
- '/* testPHP74IntCalc2 */',
- [
+ 'testMarker' => '/* testPHP74IntCalc2 */',
+ 'expected' => [
'orig_content' => '74_083',
'content' => '74083',
'code' => \T_LNUMBER,
'type' => 'T_LNUMBER',
'decimal' => '74083',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-float-calculation-1' => [
- '/* testPHP74FloatCalc1 */',
- [
+ 'testMarker' => '/* testPHP74FloatCalc1 */',
+ 'expected' => [
'orig_content' => '6.674_08e3',
'content' => '6.67408e3',
'code' => \T_DNUMBER,
'type' => 'T_DNUMBER',
'decimal' => '6.67408e3',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-float-calculation-2' => [
- '/* testPHP74FloatCalc2 */',
- [
+ 'testMarker' => '/* testPHP74FloatCalc2 */',
+ 'expected' => [
'orig_content' => '6.674_08e3',
'content' => '6.67408e3',
'code' => \T_DNUMBER,
'type' => 'T_DNUMBER',
'decimal' => '6.67408e3',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-integer-whitespace' => [
- '/* testPHP74IntWhitespace */',
- [
+ 'testMarker' => '/* testPHP74IntWhitespace */',
+ 'expected' => [
'orig_content' => '107_925_284',
'content' => '107925284',
'code' => \T_LNUMBER,
'type' => 'T_LNUMBER',
'decimal' => '107925284',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
'php-7.4-float-comments' => [
- '/* testPHP74FloatComments */',
- [
+ 'testMarker' => '/* testPHP74FloatComments */',
+ 'expected' => [
'orig_content' => '107_925_284',
'content' => '107925284',
'code' => \T_LNUMBER,
'type' => 'T_LNUMBER',
'decimal' => '107925284',
- 'last_token' => $multiToken ? 1 : 0, // Offset from $stackPtr.
+ 'last_token' => 0, // Offset from $stackPtr.
],
],
// Invalid numeric literal with underscore.
'php-7.4-invalid-1' => [
- '/* testPHP74Invalid1 */',
- [
+ 'testMarker' => '/* testPHP74Invalid1 */',
+ 'expected' => [
'orig_content' => '100',
'content' => '100',
'code' => \T_LNUMBER,
@@ -424,8 +376,8 @@ public function dataGetCompleteNumber()
],
],
'php-7.4-invalid-2' => [
- '/* testPHP74Invalid2 */',
- [
+ 'testMarker' => '/* testPHP74Invalid2 */',
+ 'expected' => [
'orig_content' => '1',
'content' => '1',
'code' => \T_LNUMBER,
@@ -435,8 +387,8 @@ public function dataGetCompleteNumber()
],
],
'php-7.4-invalid-3' => [
- '/* testPHP74Invalid3 */',
- [
+ 'testMarker' => '/* testPHP74Invalid3 */',
+ 'expected' => [
'orig_content' => '1',
'content' => '1',
'code' => \T_LNUMBER,
@@ -446,8 +398,8 @@ public function dataGetCompleteNumber()
],
],
'php-7.4-invalid-4' => [
- '/* testPHP74Invalid4 */',
- [
+ 'testMarker' => '/* testPHP74Invalid4 */',
+ 'expected' => [
'orig_content' => '1.',
'content' => '1.',
'code' => \T_DNUMBER,
@@ -457,8 +409,8 @@ public function dataGetCompleteNumber()
],
],
'php-7.4-invalid-5' => [
- '/* testPHP74Invalid5 */',
- [
+ 'testMarker' => '/* testPHP74Invalid5 */',
+ 'expected' => [
'orig_content' => '0',
'content' => '0',
'code' => \T_LNUMBER,
@@ -468,8 +420,8 @@ public function dataGetCompleteNumber()
],
],
'php-7.4-invalid-6' => [
- '/* testPHP74Invalid6 */',
- [
+ 'testMarker' => '/* testPHP74Invalid6 */',
+ 'expected' => [
'orig_content' => '0',
'content' => '0',
'code' => \T_LNUMBER,
@@ -479,8 +431,8 @@ public function dataGetCompleteNumber()
],
],
'php-7.4-invalid-7' => [
- '/* testPHP74Invalid7 */',
- [
+ 'testMarker' => '/* testPHP74Invalid7 */',
+ 'expected' => [
'orig_content' => '1',
'content' => '1',
'code' => \T_LNUMBER,
@@ -490,8 +442,8 @@ public function dataGetCompleteNumber()
],
],
'php-7.4-invalid-8' => [
- '/* testPHP74Invalid8 */',
- [
+ 'testMarker' => '/* testPHP74Invalid8 */',
+ 'expected' => [
'orig_content' => '1',
'content' => '1',
'code' => \T_LNUMBER,
@@ -500,9 +452,100 @@ public function dataGetCompleteNumber()
'last_token' => 0, // Offset from $stackPtr.
],
],
+
+ // PHP 8.1 explicit octal notation.
+ 'php-8.1-explicit-octal-lowercase' => [
+ 'testMarker' => '/* testPHP81ExplicitOctal */',
+ 'expected' => [
+ 'orig_content' => '0o137041',
+ 'content' => '0o137041',
+ 'code' => \T_LNUMBER,
+ 'type' => 'T_LNUMBER',
+ 'decimal' => '48673',
+ 'last_token' => 0, // Offset from $stackPtr.
+ ],
+ ],
+ 'php-8.1-explicit-octal-uppercase' => [
+ 'testMarker' => '/* testPHP81ExplicitOctalUppercase */',
+ 'expected' => [
+ 'orig_content' => '0O137041',
+ 'content' => '0O137041',
+ 'code' => \T_LNUMBER,
+ 'type' => 'T_LNUMBER',
+ 'decimal' => '48673',
+ 'last_token' => 0, // Offset from $stackPtr.
+ ],
+ ],
+ 'php-8.1-explicit-octal-with-separator' => [
+ 'testMarker' => '/* testPHP81ExplicitOctalWithSeparator */',
+ 'expected' => [
+ 'orig_content' => '0o137_041',
+ 'content' => '0o137041',
+ 'code' => \T_LNUMBER,
+ 'type' => 'T_LNUMBER',
+ 'decimal' => '48673',
+ 'last_token' => 0, // Offset from $stackPtr.
+ ],
+ ],
+ 'php-8.1-invalid-octal-1' => [
+ 'testMarker' => '/* testPHP81InvalidExplicitOctal1 */',
+ 'expected' => [
+ 'orig_content' => '0',
+ 'content' => '0',
+ 'code' => \T_LNUMBER,
+ 'type' => 'T_LNUMBER',
+ 'decimal' => '0',
+ 'last_token' => 0, // Offset from $stackPtr.
+ ],
+ ],
+ 'php-8.1-invalid-octal-2' => [
+ 'testMarker' => '/* testPHP81InvalidExplicitOctal2 */',
+ 'expected' => [
+ 'orig_content' => '0O2',
+ 'content' => '0O2',
+ 'code' => \T_LNUMBER,
+ 'type' => 'T_LNUMBER',
+ 'decimal' => '2',
+ 'last_token' => 0, // Offset from $stackPtr.
+ ],
+ ],
+ 'php-8.1-invalid-octal-3' => [
+ 'testMarker' => '/* testPHP81InvalidExplicitOctal3 */',
+ 'expected' => [
+ 'orig_content' => '0o2',
+ 'content' => '0o2',
+ 'code' => \T_LNUMBER,
+ 'type' => 'T_LNUMBER',
+ 'decimal' => '2',
+ 'last_token' => 0, // Offset from $stackPtr.
+ ],
+ ],
+ 'php-8.1-invalid-octal-4' => [
+ 'testMarker' => '/* testPHP81InvalidExplicitOctal4 */',
+ 'expected' => [
+ 'orig_content' => '0o2',
+ 'content' => '0o2',
+ 'code' => \T_LNUMBER,
+ 'type' => 'T_LNUMBER',
+ 'decimal' => '2',
+ 'last_token' => 0, // Offset from $stackPtr.
+ ],
+ ],
+ 'php-7.4-8.1-invalid-explicit-octal' => [
+ 'testMarker' => '/* testPHP74PHP81InvalidExplicitOctal */',
+ 'expected' => [
+ 'orig_content' => '0',
+ 'content' => '0',
+ 'code' => \T_LNUMBER,
+ 'type' => 'T_LNUMBER',
+ 'decimal' => '0',
+ 'last_token' => 0, // Offset from $stackPtr.
+ ],
+ ],
+
'live-coding' => [
- '/* testLiveCoding */',
- [
+ 'testMarker' => '/* testLiveCoding */',
+ 'expected' => [
'orig_content' => '100',
'content' => '100',
'code' => \T_LNUMBER,
diff --git a/Tests/Utils/Numbers/GetDecimalValueTest.php b/Tests/Utils/Numbers/GetDecimalValueTest.php
index f404a6ae..0dd2fec8 100644
--- a/Tests/Utils/Numbers/GetDecimalValueTest.php
+++ b/Tests/Utils/Numbers/GetDecimalValueTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetDecimalValueTest extends TestCase
+final class GetDecimalValueTest extends TestCase
{
/**
@@ -80,6 +80,11 @@ public function dataGetDecimalValue()
'octal-int-10' => ['012', '10'],
'octal-int-1024' => ['02000', '1024'],
'octal-int-1024-php-7.4' => ['020_00', '1024'],
+
+ // Octal PHP 8.1 explicit notation.
+ 'explicit-octal-int-10' => ['0o12', '10'],
+ 'explicit-octal-int-1024' => ['0O2000', '1024'],
+ 'explicit-octal-int-1024-php-7.4' => ['0o20_00', '1024'],
];
}
@@ -119,6 +124,7 @@ public function dataGetDecimalValueInvalid()
'invalid-hex' => ['0xZBHI28'],
'invalid-binary' => ['0b121457182'],
'invalid-octal' => ['0289'],
+ 'invalid-octal-explicit-notation' => ['0o289'],
];
}
}
diff --git a/Tests/Utils/Numbers/NumberTypesTest.php b/Tests/Utils/Numbers/NumberTypesTest.php
index 242c8155..60cffb6b 100644
--- a/Tests/Utils/Numbers/NumberTypesTest.php
+++ b/Tests/Utils/Numbers/NumberTypesTest.php
@@ -20,18 +20,20 @@
* \PHPCSUtils\Utils\Numbers::isOctalInt() and the
* \PHPCSUtils\Utils\Numbers::isFloat() method.
*
+ * @coversDefaultClass \PHPCSUtils\Utils\Numbers
+ *
* @group numbers
*
* @since 1.0.0
*/
-class NumberTypesTest extends TestCase
+final class NumberTypesTest extends TestCase
{
/**
* Test correctly recognizing an arbitrary string representing a decimal integer.
*
* @dataProvider dataNumbers
- * @covers \PHPCSUtils\Utils\Numbers::isDecimalInt
+ * @covers ::isDecimalInt
*
* @param string $input The input string.
* @param string $expected The expected output for the various functions.
@@ -47,7 +49,7 @@ public function testIsDecimalInt($input, $expected)
* Test correctly recognizing an arbitrary string representing a hexidecimal integer.
*
* @dataProvider dataNumbers
- * @covers \PHPCSUtils\Utils\Numbers::isHexidecimalInt
+ * @covers ::isHexidecimalInt
*
* @param string $input The input string.
* @param string $expected The expected output for the various functions.
@@ -63,7 +65,7 @@ public function testIsHexidecimalInt($input, $expected)
* Test correctly recognizing an arbitrary string representing a binary integer.
*
* @dataProvider dataNumbers
- * @covers \PHPCSUtils\Utils\Numbers::isBinaryInt
+ * @covers ::isBinaryInt
*
* @param string $input The input string.
* @param string $expected The expected output for the various functions.
@@ -79,7 +81,7 @@ public function testIsBinaryInt($input, $expected)
* Test correctly recognizing an arbitrary string representing an octal integer.
*
* @dataProvider dataNumbers
- * @covers \PHPCSUtils\Utils\Numbers::isOctalInt
+ * @covers ::isOctalInt
*
* @param string $input The input string.
* @param string $expected The expected output for the various functions.
@@ -95,7 +97,7 @@ public function testIsOctalInt($input, $expected)
* Test correctly recognizing an arbitrary string representing a decimal float.
*
* @dataProvider dataNumbers
- * @covers \PHPCSUtils\Utils\Numbers::isFloat
+ * @covers ::isFloat
*
* @param string $input The input string.
* @param string $expected The expected output for the various functions.
@@ -123,8 +125,8 @@ public static function dataNumbers()
return [
// Not strings.
'not-a-string-bool' => [
- true,
- [
+ 'input' => true,
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -133,8 +135,8 @@ public static function dataNumbers()
],
],
'not-a-string-int' => [
- 10,
- [
+ 'input' => 10,
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -145,8 +147,8 @@ public static function dataNumbers()
// Not numeric strings.
'empty-string' => [
- '',
- [
+ 'input' => '',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -155,8 +157,8 @@ public static function dataNumbers()
],
],
'string-not-a-number' => [
- 'foobar',
- [
+ 'input' => 'foobar',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -165,8 +167,8 @@ public static function dataNumbers()
],
],
'string-not-a-number-with-full-stop' => [
- 'foo. bar',
- [
+ 'input' => 'foo. bar',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -175,8 +177,8 @@ public static function dataNumbers()
],
],
'invalid-hex' => [
- '0xZBHI28',
- [
+ 'input' => '0xZBHI28',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -185,8 +187,8 @@ public static function dataNumbers()
],
],
'invalid-binary' => [
- '0b121457182',
- [
+ 'input' => '0b121457182',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -196,8 +198,18 @@ public static function dataNumbers()
],
'invalid-octal' => [
// Note: in PHP 5.x this would still be accepted, though not interpreted correctly.
- '0289',
- [
+ 'input' => '0289',
+ 'expected' => [
+ 'decimal' => false,
+ 'hex' => false,
+ 'binary' => false,
+ 'octal' => false,
+ 'float' => false,
+ ],
+ ],
+ 'invalid-explicit-octal' => [
+ 'input' => '0o289',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -206,8 +218,8 @@ public static function dataNumbers()
],
],
'invalid-float-two-decimal-points' => [
- '1.287.2763',
- [
+ 'input' => '1.287.2763',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -216,8 +228,8 @@ public static function dataNumbers()
],
],
'invalid-float-plus-no-exponent' => [
- '1.287+2763',
- [
+ 'input' => '1.287+2763',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -226,8 +238,8 @@ public static function dataNumbers()
],
],
'invalid-float-minus-no-exponent' => [
- '1287-2763',
- [
+ 'input' => '1287-2763',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -236,8 +248,8 @@ public static function dataNumbers()
],
],
'invalid-float-exponent-no-multiplier' => [
- '2872e',
- [
+ 'input' => '2872e',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -246,8 +258,8 @@ public static function dataNumbers()
],
],
'invalid-float-exponent-plus-no-multiplier' => [
- '1.2872e+',
- [
+ 'input' => '1.2872e+',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -256,8 +268,8 @@ public static function dataNumbers()
],
],
'invalid-float-exponent-minus-no-multiplier' => [
- '1.2872e-',
- [
+ 'input' => '1.2872e-',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -266,8 +278,8 @@ public static function dataNumbers()
],
],
'invalid-float-exponent-multiplier-float' => [
- '376e2.3',
- [
+ 'input' => '376e2.3',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -276,8 +288,8 @@ public static function dataNumbers()
],
],
'invalid-float-exponent-plus-multiplier-float' => [
- '3.76e+2.3',
- [
+ 'input' => '3.76e+2.3',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -286,8 +298,8 @@ public static function dataNumbers()
],
],
'invalid-float-exponent-minus-multiplier-float' => [
- '37.6e-2.3',
- [
+ 'input' => '37.6e-2.3',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -296,8 +308,8 @@ public static function dataNumbers()
],
],
'invalid-float-exponent-plus-minus-multiplier' => [
- '37.6e+-2',
- [
+ 'input' => '37.6e+-2',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -306,8 +318,8 @@ public static function dataNumbers()
],
],
'invalid-float-double-exponent' => [
- '37.6e2e6',
- [
+ 'input' => '37.6e2e6',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -318,8 +330,8 @@ public static function dataNumbers()
// Decimal numeric strings.
'decimal-single-digit-zero' => [
- '0',
- [
+ 'input' => '0',
+ 'expected' => [
'decimal' => true,
'hex' => false,
'binary' => false,
@@ -328,8 +340,8 @@ public static function dataNumbers()
],
],
'decimal-single-digit' => [
- '9',
- [
+ 'input' => '9',
+ 'expected' => [
'decimal' => true,
'hex' => false,
'binary' => false,
@@ -338,8 +350,8 @@ public static function dataNumbers()
],
],
'decimal-multi-digit' => [
- '123456',
- [
+ 'input' => '123456',
+ 'expected' => [
'decimal' => true,
'hex' => false,
'binary' => false,
@@ -348,8 +360,8 @@ public static function dataNumbers()
],
],
'decimal-multi-digit-php-7.4' => [
- '12_34_56',
- [
+ 'input' => '12_34_56',
+ 'expected' => [
'decimal' => true,
'hex' => false,
'binary' => false,
@@ -361,8 +373,8 @@ public static function dataNumbers()
// Hexidecimal numeric strings.
// phpcs:disable PHPCompatibility.Miscellaneous.ValidIntegers.HexNumericStringFound
'hexidecimal-single-digit-zero' => [
- '0x0',
- [
+ 'input' => '0x0',
+ 'expected' => [
'decimal' => false,
'hex' => true,
'binary' => false,
@@ -371,8 +383,8 @@ public static function dataNumbers()
],
],
'hexidecimal-single-digit' => [
- '0xA',
- [
+ 'input' => '0xA',
+ 'expected' => [
'decimal' => false,
'hex' => true,
'binary' => false,
@@ -381,8 +393,8 @@ public static function dataNumbers()
],
],
'hexidecimal-multi-digit-all-numbers' => [
- '0x123456',
- [
+ 'input' => '0x123456',
+ 'expected' => [
'decimal' => false,
'hex' => true,
'binary' => false,
@@ -391,8 +403,8 @@ public static function dataNumbers()
],
],
'hexidecimal-multi-digit-no-numbers' => [
- '0xABCDEF',
- [
+ 'input' => '0xABCDEF',
+ 'expected' => [
'decimal' => false,
'hex' => true,
'binary' => false,
@@ -401,8 +413,8 @@ public static function dataNumbers()
],
],
'hexidecimal-multi-digit-mixed' => [
- '0xAB02F6',
- [
+ 'input' => '0xAB02F6',
+ 'expected' => [
'decimal' => false,
'hex' => true,
'binary' => false,
@@ -411,8 +423,8 @@ public static function dataNumbers()
],
],
'hexidecimal-multi-digit-mixed-uppercase-x' => [
- '0XAB953C',
- [
+ 'input' => '0XAB953C',
+ 'expected' => [
'decimal' => false,
'hex' => true,
'binary' => false,
@@ -421,8 +433,8 @@ public static function dataNumbers()
],
],
'hexidecimal-multi-digit-php-7.4' => [
- '0x23_6A_3C',
- [
+ 'input' => '0x23_6A_3C',
+ 'expected' => [
'decimal' => false,
'hex' => true,
'binary' => false,
@@ -434,8 +446,8 @@ public static function dataNumbers()
// Binary numeric strings.
'binary-single-digit-zero' => [
- '0b0',
- [
+ 'input' => '0b0',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => true,
@@ -444,8 +456,8 @@ public static function dataNumbers()
],
],
'binary-single-digit-one' => [
- '0b1',
- [
+ 'input' => '0b1',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => true,
@@ -454,8 +466,8 @@ public static function dataNumbers()
],
],
'binary-multi-digit' => [
- '0b1010',
- [
+ 'input' => '0b1010',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => true,
@@ -464,8 +476,8 @@ public static function dataNumbers()
],
],
'binary-multi-digit-uppercase-b' => [
- '0B1000100100000',
- [
+ 'input' => '0B1000100100000',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => true,
@@ -474,8 +486,8 @@ public static function dataNumbers()
],
],
'binary-multi-digit-php-7.4' => [
- '0b100_000_000_00',
- [
+ 'input' => '0b100_000_000_00',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => true,
@@ -486,8 +498,8 @@ public static function dataNumbers()
// Octal numeric strings.
'octal-single-digit-zero' => [
- '00',
- [
+ 'input' => '00',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -496,8 +508,8 @@ public static function dataNumbers()
],
],
'octal-single-digit' => [
- '07',
- [
+ 'input' => '07',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -506,8 +518,8 @@ public static function dataNumbers()
],
],
'octal-multi-digit' => [
- '076543210',
- [
+ 'input' => '076543210',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -516,8 +528,50 @@ public static function dataNumbers()
],
],
'octal-multi-digit-php-7.4' => [
- '020_631_542',
- [
+ 'input' => '020_631_542',
+ 'expected' => [
+ 'decimal' => false,
+ 'hex' => false,
+ 'binary' => false,
+ 'octal' => true,
+ 'float' => false,
+ ],
+ ],
+
+ // Octal numeric strings using PHP 8.1 explicit octal notation.
+ 'explicit-octal-single-digit-zero' => [
+ 'input' => '0o0',
+ 'expected' => [
+ 'decimal' => false,
+ 'hex' => false,
+ 'binary' => false,
+ 'octal' => true,
+ 'float' => false,
+ ],
+ ],
+ 'explicit-octal-single-digit' => [
+ 'input' => '0O7',
+ 'expected' => [
+ 'decimal' => false,
+ 'hex' => false,
+ 'binary' => false,
+ 'octal' => true,
+ 'float' => false,
+ ],
+ ],
+ 'explicit-octal-multi-digit' => [
+ 'input' => '0o76543210',
+ 'expected' => [
+ 'decimal' => false,
+ 'hex' => false,
+ 'binary' => false,
+ 'octal' => true,
+ 'float' => false,
+ ],
+ ],
+ 'explicit-octal-multi-digit-php-7.4' => [
+ 'input' => '0O20_631_542',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -528,8 +582,8 @@ public static function dataNumbers()
// Floating point numeric strings. Also see: decimal numeric strings.
'float-single-digit-dot-zero' => [
- '0.',
- [
+ 'input' => '0.',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -538,8 +592,8 @@ public static function dataNumbers()
],
],
'float-single-digit-dot' => [
- '1.',
- [
+ 'input' => '1.',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -548,8 +602,8 @@ public static function dataNumbers()
],
],
'float-multi-digit-dot' => [
- '56458.',
- [
+ 'input' => '56458.',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -558,8 +612,8 @@ public static function dataNumbers()
],
],
'float-multi-digit-dot-leading-zero' => [
- '0023.',
- [
+ 'input' => '0023.',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -568,8 +622,8 @@ public static function dataNumbers()
],
],
'float-multi-digit-dot-php-7.4' => [
- '521_879.',
- [
+ 'input' => '521_879.',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -579,8 +633,8 @@ public static function dataNumbers()
],
'float-dot-single-digit-zero' => [
- '.0',
- [
+ 'input' => '.0',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -589,8 +643,8 @@ public static function dataNumbers()
],
],
'float-dot-single-digit' => [
- '.2',
- [
+ 'input' => '.2',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -599,8 +653,8 @@ public static function dataNumbers()
],
],
'float-dot-multi-digit' => [
- '.232746',
- [
+ 'input' => '.232746',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -609,8 +663,8 @@ public static function dataNumbers()
],
],
'float-dot-multi-digit-trailing-zero' => [
- '.345300',
- [
+ 'input' => '.345300',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -619,8 +673,8 @@ public static function dataNumbers()
],
],
'float-dot-multi-digit-php-7.4' => [
- '.421_789_8',
- [
+ 'input' => '.421_789_8',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -630,8 +684,8 @@ public static function dataNumbers()
],
'float-digit-dot-digit-single-zero' => [
- '0.0',
- [
+ 'input' => '0.0',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -640,8 +694,8 @@ public static function dataNumbers()
],
],
'float-digit-dot-digit-single' => [
- '9.1',
- [
+ 'input' => '9.1',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -650,8 +704,8 @@ public static function dataNumbers()
],
],
'float-digit-dot-digit-multi' => [
- '7483.2182',
- [
+ 'input' => '7483.2182',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -660,8 +714,8 @@ public static function dataNumbers()
],
],
'float-digit-dot-digit-multi-leading-zero' => [
- '002781.21928173',
- [
+ 'input' => '002781.21928173',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -670,8 +724,8 @@ public static function dataNumbers()
],
],
'float-digit-dot-digit-multi-trailing-zero' => [
- '213.2987000',
- [
+ 'input' => '213.2987000',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -680,8 +734,8 @@ public static function dataNumbers()
],
],
'float-digit-dot-digit-multi-leading-zero-trailing-zero' => [
- '07262.2760',
- [
+ 'input' => '07262.2760',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -690,8 +744,8 @@ public static function dataNumbers()
],
],
'float-digit-dot-digit-multi--php-7.4' => [
- '07_262.276_720',
- [
+ 'input' => '07_262.276_720',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -701,8 +755,8 @@ public static function dataNumbers()
],
'float-exponent-digit-dot-digit-zero-exp-single-digit' => [
- '0.0e1',
- [
+ 'input' => '0.0e1',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -711,8 +765,8 @@ public static function dataNumbers()
],
],
'float-exponent-single-digit-dot-exp-double-digit' => [
- '1.e28',
- [
+ 'input' => '1.e28',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -721,8 +775,8 @@ public static function dataNumbers()
],
],
'float-exponent-multi-digit-dot-exp-plus-digit' => [
- '56458.e+2',
- [
+ 'input' => '56458.e+2',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -731,8 +785,8 @@ public static function dataNumbers()
],
],
'float-exponent-multi-digit-dot-leading-zero-exp-minus-digit' => [
- '0023.e-44',
- [
+ 'input' => '0023.e-44',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -742,8 +796,8 @@ public static function dataNumbers()
],
'float-exponent-dot-single-digit-zero-exp-minus-digit' => [
- '.0e-1',
- [
+ 'input' => '.0e-1',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -752,8 +806,8 @@ public static function dataNumbers()
],
],
'float-exponent-dot-single-digit-exp-plus-digit-zero' => [
- '.2e+0',
- [
+ 'input' => '.2e+0',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -762,8 +816,8 @@ public static function dataNumbers()
],
],
'float-exponent-dot-multi-digit-exp-multi-digit' => [
- '.232746e41',
- [
+ 'input' => '.232746e41',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -772,8 +826,8 @@ public static function dataNumbers()
],
],
'float-exponent-dot-multi-digit-trailing-zero-exp-multi-digit' => [
- '.345300e87',
- [
+ 'input' => '.345300e87',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -783,8 +837,8 @@ public static function dataNumbers()
],
'float-exponent-digit-dot-digit-single-zero-exp-uppercase' => [
- '0.0E2',
- [
+ 'input' => '0.0E2',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -793,8 +847,8 @@ public static function dataNumbers()
],
],
'float-exponent-digit-dot-digit-single-exp-uppercase' => [
- '9.1E47',
- [
+ 'input' => '9.1E47',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -803,8 +857,8 @@ public static function dataNumbers()
],
],
'float-exponent-digit-dot-digit-multi-exp-minus-digit' => [
- '7483.2182e-3',
- [
+ 'input' => '7483.2182e-3',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -813,8 +867,8 @@ public static function dataNumbers()
],
],
'float-exponent-digit-dot-digit-multi-leading-zero-exp-uppercase' => [
- '002781.21928173E+56',
- [
+ 'input' => '002781.21928173E+56',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -823,8 +877,8 @@ public static function dataNumbers()
],
],
'float-exponent-digit-dot-digit-multi-trailing-zero-exp-plus-digit' => [
- '213.2987000e+2',
- [
+ 'input' => '213.2987000e+2',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -833,8 +887,8 @@ public static function dataNumbers()
],
],
'float-exponent-digit-dot-digit-multi-leading-zero-trailing-zero-exp-digit' => [
- '07262.2760e4',
- [
+ 'input' => '07262.2760e4',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
@@ -843,8 +897,8 @@ public static function dataNumbers()
],
],
'float-exponent-digit-dot-digit-exp-digit-php-7.4' => [
- '6.674_083e+1_1',
- [
+ 'input' => '6.674_083e+1_1',
+ 'expected' => [
'decimal' => false,
'hex' => false,
'binary' => false,
diff --git a/Tests/Utils/ObjectDeclarations/FindExtendedClassNameDiffTest.inc b/Tests/Utils/ObjectDeclarations/FindExtendedClassNameDiffTest.inc
index c03aee8d..60220f03 100644
--- a/Tests/Utils/ObjectDeclarations/FindExtendedClassNameDiffTest.inc
+++ b/Tests/Utils/ObjectDeclarations/FindExtendedClassNameDiffTest.inc
@@ -6,5 +6,8 @@ class testDeclarationWithComments
// phpcs:ignore Stnd.Cat.Sniff -- For reasons.
\Package\SubDir /* comment */ \ /* comment */ SomeClass /* comment */ {}
+/* testExtendedClassUsingNamespaceOperator */
+class testWithNSOperator extends namespace\Bar {}
+
/* testExtendedClassStrayComma */
class testExtendedClassStrayComma extends , testClass {} // Intentional parse error.
diff --git a/Tests/Utils/ObjectDeclarations/FindExtendedClassNameDiffTest.php b/Tests/Utils/ObjectDeclarations/FindExtendedClassNameDiffTest.php
index d07ddd92..5da5a50e 100644
--- a/Tests/Utils/ObjectDeclarations/FindExtendedClassNameDiffTest.php
+++ b/Tests/Utils/ObjectDeclarations/FindExtendedClassNameDiffTest.php
@@ -26,7 +26,7 @@
*
* @since 1.0.0
*/
-class FindExtendedClassNameDiffTest extends UtilityMethodTestCase
+final class FindExtendedClassNameDiffTest extends UtilityMethodTestCase
{
/**
@@ -57,12 +57,16 @@ public function dataFindExtendedClassName()
{
return [
'phpcs-annotation-and-comments' => [
- '/* testDeclarationWithComments */',
- '\Package\SubDir\SomeClass',
+ 'testMarker' => '/* testDeclarationWithComments */',
+ 'expected' => '\Package\SubDir\SomeClass',
+ ],
+ 'namespace-operator' => [
+ 'testMarker' => '/* testExtendedClassUsingNamespaceOperator */',
+ 'expected' => 'namespace\Bar',
],
'parse-error-stray-comma' => [
- '/* testExtendedClassStrayComma */',
- 'testClass',
+ 'testMarker' => '/* testExtendedClassStrayComma */',
+ 'expected' => 'testClass',
],
];
}
diff --git a/Tests/Utils/ObjectDeclarations/FindExtendedClassNameTest.php b/Tests/Utils/ObjectDeclarations/FindExtendedClassNameTest.php
index 04bb95e0..396ff5dd 100644
--- a/Tests/Utils/ObjectDeclarations/FindExtendedClassNameTest.php
+++ b/Tests/Utils/ObjectDeclarations/FindExtendedClassNameTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class FindExtendedClassNameTest extends BCFile_FindExtendedClassNameTest
+final class FindExtendedClassNameTest extends BCFile_FindExtendedClassNameTest
{
/**
diff --git a/Tests/Utils/ObjectDeclarations/FindExtendedInterfaceNamesTest.inc b/Tests/Utils/ObjectDeclarations/FindExtendedInterfaceNamesTest.inc
index 420ead9d..cbc06538 100644
--- a/Tests/Utils/ObjectDeclarations/FindExtendedInterfaceNamesTest.inc
+++ b/Tests/Utils/ObjectDeclarations/FindExtendedInterfaceNamesTest.inc
@@ -28,6 +28,12 @@ interface testMultiExtendedInterfaceWithComments
{
}
+/* testNamespaceRelativeQualifiedInterface */
+interface testQualifiedInterfaces extends Core\File\RelativeInterface, Another\RelativeInterface {}
+
+/* testExtendsUsingNamespaceOperator */
+interface testWithNSOperator extends namespace\BarInterface, namespace\Sub\SomeOther {}
+
// Intentional parse error. Has to be the last test in the file.
/* testParseError */
interface testParseError extends testInterface
diff --git a/Tests/Utils/ObjectDeclarations/FindExtendedInterfaceNamesTest.php b/Tests/Utils/ObjectDeclarations/FindExtendedInterfaceNamesTest.php
index e4d57b12..3da86aaa 100644
--- a/Tests/Utils/ObjectDeclarations/FindExtendedInterfaceNamesTest.php
+++ b/Tests/Utils/ObjectDeclarations/FindExtendedInterfaceNamesTest.php
@@ -23,7 +23,7 @@
*
* @since 1.0.0
*/
-class FindExtendedInterfaceNamesTest extends UtilityMethodTestCase
+final class FindExtendedInterfaceNamesTest extends UtilityMethodTestCase
{
/**
@@ -77,42 +77,56 @@ public function dataFindExtendedInterfaceNames()
{
return [
'not-extended' => [
- '/* testInterface */',
- false,
+ 'testMarker' => '/* testInterface */',
+ 'expected' => false,
],
'extends-one' => [
- '/* testExtendedInterface */',
- ['testInterface'],
+ 'testMarker' => '/* testExtendedInterface */',
+ 'expected' => ['testInterface'],
],
'extends-two' => [
- '/* testMultiExtendedInterface */',
- [
+ 'testMarker' => '/* testMultiExtendedInterface */',
+ 'expected' => [
'testInterfaceA',
'testInterfaceB',
],
],
'extends-one-namespaced' => [
- '/* testExtendedNamespacedInterface */',
- ['\PHPCSUtils\Tests\ObjectDeclarations\testInterface'],
+ 'testMarker' => '/* testExtendedNamespacedInterface */',
+ 'expected' => ['\PHPCSUtils\Tests\ObjectDeclarations\testInterface'],
],
'extends-two-namespaced' => [
- '/* testMultiExtendedNamespacedInterface */',
- [
+ 'testMarker' => '/* testMultiExtendedNamespacedInterface */',
+ 'expected' => [
'\PHPCSUtils\Tests\ObjectDeclarations\testInterfaceA',
'\PHPCSUtils\Tests\ObjectDeclarations\testFEINInterfaceB',
],
],
'extends-with-comments' => [
- '/* testMultiExtendedInterfaceWithComments */',
- [
+ 'testMarker' => '/* testMultiExtendedInterfaceWithComments */',
+ 'expected' => [
'testInterfaceA',
'\PHPCSUtils\Tests\Some\Declarations\testInterfaceB',
'\testInterfaceC',
],
],
+ 'extends-partially-qualified-names' => [
+ 'testMarker' => '/* testNamespaceRelativeQualifiedInterface */',
+ 'expected' => [
+ 'Core\File\RelativeInterface',
+ 'Another\RelativeInterface',
+ ],
+ ],
+ 'extends-using-namespace-operator' => [
+ 'testMarker' => '/* testExtendsUsingNamespaceOperator */',
+ 'expected' => [
+ 'namespace\BarInterface',
+ 'namespace\Sub\SomeOther',
+ ],
+ ],
'parse-error' => [
- '/* testParseError */',
- false,
+ 'testMarker' => '/* testParseError */',
+ 'expected' => false,
],
];
}
diff --git a/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesDiffTest.inc b/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesDiffTest.inc
index 0cd35a9d..46069654 100644
--- a/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesDiffTest.inc
+++ b/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesDiffTest.inc
@@ -13,5 +13,8 @@ class testDeclarationWithComments
// comment
InterfaceB {}
+/* testDeclarationMultiImplementedNamespaceOperator */
+class testMultiImplementedNSOperator implements namespace\testInterfaceA, namespace\testInterfaceB {}
+
/* testMultiImplementedStrayComma */
class testMultiImplementedStrayComma implements testInterfaceA, , testInterfaceB {} // Intentional parse error.
diff --git a/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesDiffTest.php b/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesDiffTest.php
index 1f8f07b8..34706c96 100644
--- a/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesDiffTest.php
+++ b/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesDiffTest.php
@@ -26,7 +26,7 @@
*
* @since 1.0.0
*/
-class FindImplementedInterfaceNamesDiffTest extends UtilityMethodTestCase
+final class FindImplementedInterfaceNamesDiffTest extends UtilityMethodTestCase
{
/**
@@ -41,7 +41,7 @@ class FindImplementedInterfaceNamesDiffTest extends UtilityMethodTestCase
*/
public function testFindImplementedInterfaceNames($testMarker, $expected)
{
- $OOToken = $this->getTargetToken($testMarker, [\T_CLASS, \T_ANON_CLASS, \T_INTERFACE]);
+ $OOToken = $this->getTargetToken($testMarker, [\T_CLASS, \T_ANON_CLASS, \T_INTERFACE, \T_ENUM]);
$result = ObjectDeclarations::findImplementedInterfaceNames(self::$phpcsFile, $OOToken);
$this->assertSame($expected, $result);
}
@@ -57,15 +57,22 @@ public function dataFindImplementedInterfaceNames()
{
return [
'phpcs-annotation-and-comments' => [
- '/* testDeclarationWithComments */',
- [
+ 'testMarker' => '/* testDeclarationWithComments */',
+ 'expected' => [
'\Vendor\Package\Core\SubDir\SomeInterface',
'InterfaceB',
],
],
+ 'namespace-operator' => [
+ 'testMarker' => '/* testDeclarationMultiImplementedNamespaceOperator */',
+ 'expected' => [
+ 'namespace\testInterfaceA',
+ 'namespace\testInterfaceB',
+ ],
+ ],
'parse-error-stray-comma' => [
- '/* testMultiImplementedStrayComma */',
- [
+ 'testMarker' => '/* testMultiImplementedStrayComma */',
+ 'expected' => [
0 => 'testInterfaceA',
1 => 'testInterfaceB',
],
diff --git a/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesTest.php b/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesTest.php
index fe6bc029..5bcfe651 100644
--- a/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesTest.php
+++ b/Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class FindImplementedInterfaceNamesTest extends BCFile_FindImplInterfaceNamesTest
+final class FindImplementedInterfaceNamesTest extends BCFile_FindImplInterfaceNamesTest
{
/**
diff --git a/Tests/Utils/ObjectDeclarations/GetClassPropertiesDiffTest.inc b/Tests/Utils/ObjectDeclarations/GetClassPropertiesDiffTest.inc
index 2d771907..2abe6a38 100644
--- a/Tests/Utils/ObjectDeclarations/GetClassPropertiesDiffTest.inc
+++ b/Tests/Utils/ObjectDeclarations/GetClassPropertiesDiffTest.inc
@@ -5,7 +5,7 @@ final
// phpcs:ignore Standard.Cat.SniffName -- Just because.
class PHPCSAnnotation {}
-/* testWithDocblockWithWeirdlyPlacedProperty */
+/* testWithDocblockWithWeirdlyPlacedModifier */
final
/**
@@ -15,11 +15,21 @@ final
*
* @phpcs:disable Standard.Cat.SniffName -- Just because.
*/
-class ClassWithPropertyBeforeDocblock {}
+class ClassWithModifierBeforeDocblock {}
-/* testParseErrorAbstractFinal */
-final /* comment */
+/* testReadonlyClass */
+readonly class ReadOnlyClass {}
- abstract // Intentional parse error, class cannot both be final and abstract.
+/* testFinalReadonlyClass */
+final readonly class FinalReadOnlyClass extends Foo {}
- class AbstractFinal {}
+/* testReadonlyFinalClass */
+readonly /*comment*/ final class ReadOnlyFinalClass {}
+
+/* testAbstractReadonlyClass */
+abstract readonly class AbstractReadOnlyClass {}
+
+/* testReadonlyAbstractClass */
+readonly
+abstract
+class ReadOnlyAbstractClass {}
diff --git a/Tests/Utils/ObjectDeclarations/GetClassPropertiesDiffTest.php b/Tests/Utils/ObjectDeclarations/GetClassPropertiesDiffTest.php
index 3ff4fcbb..95fa8e02 100644
--- a/Tests/Utils/ObjectDeclarations/GetClassPropertiesDiffTest.php
+++ b/Tests/Utils/ObjectDeclarations/GetClassPropertiesDiffTest.php
@@ -25,7 +25,7 @@
*
* @since 1.0.0
*/
-class GetClassPropertiesDiffTest extends UtilityMethodTestCase
+final class GetClassPropertiesDiffTest extends UtilityMethodTestCase
{
/**
@@ -68,24 +68,59 @@ public function dataGetClassProperties()
{
return [
'phpcs-annotation' => [
- '/* testPHPCSAnnotations */',
- [
+ 'testMarker' => '/* testPHPCSAnnotations */',
+ 'expected' => [
'is_abstract' => false,
'is_final' => true,
+ 'is_readonly' => false,
],
],
'unorthodox-docblock-placement' => [
- '/* testWithDocblockWithWeirdlyPlacedProperty */',
+ 'testMarker' => '/* testWithDocblockWithWeirdlyPlacedModifier */',
+ 'expected' => [
+ 'is_abstract' => false,
+ 'is_final' => true,
+ 'is_readonly' => false,
+ ],
+ ],
+ 'readonly' => [
+ '/* testReadonlyClass */',
+ [
+ 'is_abstract' => false,
+ 'is_final' => false,
+ 'is_readonly' => true,
+ ],
+ ],
+ 'final-readonly' => [
+ '/* testFinalReadonlyClass */',
[
'is_abstract' => false,
'is_final' => true,
+ 'is_readonly' => true,
+ ],
+ ],
+ 'readonly-final' => [
+ '/* testReadonlyFinalClass */',
+ [
+ 'is_abstract' => false,
+ 'is_final' => true,
+ 'is_readonly' => true,
+ ],
+ ],
+ 'abstract-readonly' => [
+ '/* testAbstractReadonlyClass */',
+ [
+ 'is_abstract' => true,
+ 'is_final' => false,
+ 'is_readonly' => true,
],
],
- 'abstract-final-parse-error' => [
- '/* testParseErrorAbstractFinal */',
+ 'readonly-abstract' => [
+ '/* testReadonlyAbstractClass */',
[
'is_abstract' => true,
'is_final' => false,
+ 'is_readonly' => true,
],
],
];
diff --git a/Tests/Utils/ObjectDeclarations/GetClassPropertiesTest.php b/Tests/Utils/ObjectDeclarations/GetClassPropertiesTest.php
index 05f271f5..82f7cb19 100644
--- a/Tests/Utils/ObjectDeclarations/GetClassPropertiesTest.php
+++ b/Tests/Utils/ObjectDeclarations/GetClassPropertiesTest.php
@@ -21,7 +21,7 @@
*
* @since 1.0.0
*/
-class GetClassPropertiesTest extends BCFile_GetClassPropertiesTest
+final class GetClassPropertiesTest extends BCFile_GetClassPropertiesTest
{
/**
@@ -55,4 +55,21 @@ public static function setUpTestFile()
self::$caseFile = \dirname(\dirname(__DIR__)) . '/BackCompat/BCFile/GetClassPropertiesTest.inc';
parent::setUpTestFile();
}
+
+ /**
+ * Data provider.
+ *
+ * @see testGetClassProperties() For the array format.
+ *
+ * @return array
+ */
+ public function dataGetClassProperties()
+ {
+ $data = parent::dataGetClassProperties();
+ foreach ($data as $name => $dataset) {
+ $data[$name][1]['is_readonly'] = false;
+ }
+
+ return $data;
+ }
}
diff --git a/Tests/Utils/ObjectDeclarations/GetNameDiffTest.php b/Tests/Utils/ObjectDeclarations/GetNameDiffTest.php
index e29d9b9d..c23a2b01 100644
--- a/Tests/Utils/ObjectDeclarations/GetNameDiffTest.php
+++ b/Tests/Utils/ObjectDeclarations/GetNameDiffTest.php
@@ -25,7 +25,7 @@
*
* @since 1.0.0
*/
-class GetNameDiffTest extends UtilityMethodTestCase
+final class GetNameDiffTest extends UtilityMethodTestCase
{
/**
@@ -67,8 +67,8 @@ public function dataGetNameNull()
{
return [
'live-coding' => [
- '/* testLiveCoding */',
- \T_CLASS,
+ 'testMarker' => '/* testLiveCoding */',
+ 'targetType' => \T_CLASS,
],
];
}
@@ -87,7 +87,7 @@ public function dataGetNameNull()
public function testGetName($testMarker, $expected, $targetType = null)
{
if (isset($targetType) === false) {
- $targetType = [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_FUNCTION];
+ $targetType = [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_ENUM, \T_FUNCTION];
}
$target = $this->getTargetToken($testMarker, $targetType);
@@ -106,16 +106,16 @@ public function dataGetName()
{
return [
'trait-name-starts-with-number' => [
- '/* testTraitStartingWithNumber */',
- '5InvalidNameStartingWithNumber',
+ 'testMarker' => '/* testTraitStartingWithNumber */',
+ 'expected' => '5InvalidNameStartingWithNumber',
],
'interface-fully-numeric-name' => [
- '/* testInterfaceFullyNumeric */',
- '12345',
+ 'testMarker' => '/* testInterfaceFullyNumeric */',
+ 'expected' => '12345',
],
'using-reserved-keyword-as-name' => [
- '/* testInvalidInterfaceName */',
- 'switch',
+ 'testMarker' => '/* testInvalidInterfaceName */',
+ 'expected' => 'switch',
],
];
}
diff --git a/Tests/Utils/ObjectDeclarations/GetNameJSTest.php b/Tests/Utils/ObjectDeclarations/GetNameJSTest.php
index c9835127..875761bd 100644
--- a/Tests/Utils/ObjectDeclarations/GetNameJSTest.php
+++ b/Tests/Utils/ObjectDeclarations/GetNameJSTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetNameJSTest extends BCFile_GetDeclarationNameJSTest
+final class GetNameJSTest extends BCFile_GetDeclarationNameJSTest
{
/**
@@ -54,7 +54,7 @@ public static function setUpTestFile()
*/
public function testInvalidTokenPassed()
{
- $this->expectPhpcsException('Token type "T_STRING" is not T_FUNCTION, T_CLASS, T_INTERFACE or T_TRAIT');
+ $this->expectPhpcsException('Token type "T_STRING" is not T_FUNCTION, T_CLASS, T_INTERFACE, T_TRAIT or T_ENUM');
$target = $this->getTargetToken('/* testInvalidTokenPassed */', \T_STRING);
ObjectDeclarations::getName(self::$phpcsFile, $target);
@@ -95,7 +95,7 @@ public function testGetDeclarationNameNull($testMarker, $targetType)
public function testGetDeclarationName($testMarker, $expected, $targetType = null)
{
if (isset($targetType) === false) {
- $targetType = [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_FUNCTION];
+ $targetType = [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_ENUM, \T_FUNCTION];
}
$target = $this->getTargetToken($testMarker, $targetType);
@@ -112,10 +112,6 @@ public function testGetDeclarationName($testMarker, $expected, $targetType = nul
*/
public function testGetDeclarationNameES6Method()
{
- if (\version_compare(static::$phpcsVersion, '3.0.0', '<') === true) {
- $this->markTestSkipped('Support for JS ES6 method has not been backfilled for PHPCS 2.x (yet)');
- }
-
$target = $this->getTargetToken('/* testMethod */', [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_FUNCTION]);
$result = ObjectDeclarations::getName(self::$phpcsFile, $target);
$this->assertSame('methodName', $result);
diff --git a/Tests/Utils/ObjectDeclarations/GetNameTest.php b/Tests/Utils/ObjectDeclarations/GetNameTest.php
index b41e849f..eb1e1509 100644
--- a/Tests/Utils/ObjectDeclarations/GetNameTest.php
+++ b/Tests/Utils/ObjectDeclarations/GetNameTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class GetNameTest extends BCFile_GetDeclarationNameTest
+final class GetNameTest extends BCFile_GetDeclarationNameTest
{
/**
@@ -54,7 +54,7 @@ public static function setUpTestFile()
*/
public function testInvalidTokenPassed()
{
- $this->expectPhpcsException('Token type "T_STRING" is not T_FUNCTION, T_CLASS, T_INTERFACE or T_TRAIT');
+ $this->expectPhpcsException('Token type "T_STRING" is not T_FUNCTION, T_CLASS, T_INTERFACE, T_TRAIT or T_ENUM');
$target = $this->getTargetToken('/* testInvalidTokenPassed */', \T_STRING);
ObjectDeclarations::getName(self::$phpcsFile, $target);
@@ -95,7 +95,7 @@ public function testGetDeclarationNameNull($testMarker, $targetType)
public function testGetDeclarationName($testMarker, $expected, $targetType = null)
{
if (isset($targetType) === false) {
- $targetType = [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_FUNCTION];
+ $targetType = [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_ENUM, \T_FUNCTION];
}
$target = $this->getTargetToken($testMarker, $targetType);
diff --git a/Tests/Utils/Operators/IsReferenceDiffTest.inc b/Tests/Utils/Operators/IsReferenceDiffTest.inc
deleted file mode 100644
index 2f9f0e04..00000000
--- a/Tests/Utils/Operators/IsReferenceDiffTest.inc
+++ /dev/null
@@ -1,13 +0,0 @@
-assertFalse(Operators::isReference(self::$phpcsFile, 10000));
- }
-
- /**
- * Test correctly identifying that whether a "bitwise and" token is a reference or not.
+ * Initialize PHPCS & tokenize the test case file.
*
- * @dataProvider dataIsReference
- *
- * @param string $identifier Comment which precedes the test case.
- * @param bool $expected Expected function output.
+ * @beforeClass
*
* @return void
*/
- public function testIsReference($identifier, $expected)
+ public static function setUpTestFile()
{
- $bitwiseAnd = $this->getTargetToken($identifier, \T_BITWISE_AND);
- $result = Operators::isReference(self::$phpcsFile, $bitwiseAnd);
- $this->assertSame($expected, $result);
+ self::$caseFile = \dirname(\dirname(__DIR__)) . '/DummyFile.inc';
+ parent::setUpTestFile();
}
/**
- * Data provider.
- *
- * @see testIsReference()
+ * Test passing a non-existent token pointer.
*
- * @return array
+ * @return void
*/
- public function dataIsReference()
+ public function testNonExistentToken()
{
- return [
- 'issue-1971-list-first-in-file' => [
- '/* testTokenizerIssue1971PHPCSlt330gt271A */',
- true,
- ],
- 'issue-1971-list-first-in-file-nested' => [
- '/* testTokenizerIssue1971PHPCSlt330gt271B */',
- true,
- ],
- 'issue-1284-short-list-directly-after-close-curly-control-structure' => [
- '/* testTokenizerIssue1284PHPCSlt280A */',
- true,
- ],
- 'issue-1284-short-list-directly-after-close-curly-control-structure-second-item' => [
- '/* testTokenizerIssue1284PHPCSlt280B */',
- true,
- ],
- 'issue-1284-short-array-directly-after-close-curly-control-structure' => [
- '/* testTokenizerIssue1284PHPCSlt280C */',
- true,
- ],
- ];
+ $this->assertFalse(Operators::isReference(self::$phpcsFile, 10000));
}
}
diff --git a/Tests/Utils/Operators/IsReferenceTest.php b/Tests/Utils/Operators/IsReferenceTest.php
index fbbce68a..76b04f72 100644
--- a/Tests/Utils/Operators/IsReferenceTest.php
+++ b/Tests/Utils/Operators/IsReferenceTest.php
@@ -21,7 +21,7 @@
*
* @since 1.0.0
*/
-class IsReferenceTest extends BCFile_IsReferenceTest
+final class IsReferenceTest extends BCFile_IsReferenceTest
{
/**
diff --git a/Tests/Utils/Operators/IsShortTernaryTest.inc b/Tests/Utils/Operators/IsShortTernaryTest.inc
index 8561039c..a8b2436e 100644
--- a/Tests/Utils/Operators/IsShortTernaryTest.inc
+++ b/Tests/Utils/Operators/IsShortTernaryTest.inc
@@ -19,24 +19,6 @@ $foo = $foo ? /* deliberately left empty */
// phpcs:ignore Stnd.Cat.Sniff -- For reasons.
: 'bar';
-/* testDontConfuseWithNullCoalesce */
-$foo = $foo ?? 0;
-
-/* testDontConfuseWithNullCoalesceEquals */
-$foo ??= 0;
-
-class Foo {
- /* testDontConfuseWithNullable1 */
- protected ?int $property = 1;
-
- public function bar(
- /* testDontConfuseWithNullable2 */
- ?bool $param
- /* testDontConfuseWithNullable3 */
- ) : ?\My\ClassName {
- }
-}
-
/* testParseError */
// Intentional parse error. This has to be the last test in the file.
$foo = $foo ?
diff --git a/Tests/Utils/Operators/IsShortTernaryTest.php b/Tests/Utils/Operators/IsShortTernaryTest.php
index c5a66c60..9539f3b6 100644
--- a/Tests/Utils/Operators/IsShortTernaryTest.php
+++ b/Tests/Utils/Operators/IsShortTernaryTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class IsShortTernaryTest extends UtilityMethodTestCase
+final class IsShortTernaryTest extends UtilityMethodTestCase
{
/**
@@ -78,91 +78,20 @@ public function dataIsShortTernary()
{
return [
'long-ternary' => [
- '/* testLongTernary */',
- false,
+ 'testMarker' => '/* testLongTernary */',
+ 'expected' => false,
],
'short-ternary-no-space' => [
- '/* testShortTernaryNoSpace */',
- true,
+ 'testMarker' => '/* testShortTernaryNoSpace */',
+ 'expected' => true,
],
'short-ternary-long-space' => [
- '/* testShortTernaryLongSpace */',
- true,
+ 'testMarker' => '/* testShortTernaryLongSpace */',
+ 'expected' => true,
],
'short-ternary-comments-annotations' => [
- '/* testShortTernaryWithCommentAndAnnotations */',
- true,
- ],
- ];
- }
-
- /**
- * Safeguard that incorrectly tokenized T_INLINE_THEN or T_INLINE_ELSE tokens are correctly
- * rejected as not short ternary.
- *
- * {@internal None of these are really problematic, but better to be safe than sorry.}
- *
- * @dataProvider dataIsShortTernaryTokenizerIssues
- *
- * @param string $testMarker The comment which prefaces the target token in the test file.
- * @param int|string $tokenType The token code to look for.
- *
- * @return void
- */
- public function testIsShortTernaryTokenizerIssues($testMarker, $tokenType = \T_INLINE_THEN)
- {
- $stackPtr = $this->getTargetToken($testMarker, $tokenType);
- $result = Operators::isShortTernary(self::$phpcsFile, $stackPtr);
- $this->assertFalse($result);
- }
-
- /**
- * Data provider.
- *
- * @see testIsShortTernaryTokenizerIssues() For the array format.
- *
- * @return array
- */
- public function dataIsShortTernaryTokenizerIssues()
- {
- $targetCoalesce = [\T_INLINE_THEN];
- if (\defined('T_COALESCE')) {
- $targetCoalesce[] = \T_COALESCE;
- }
-
- $targetCoalesceAndEquals = $targetCoalesce;
- if (\defined('T_COALESCE_EQUAL')) {
- $targetCoalesceAndEquals[] = \T_COALESCE_EQUAL;
- }
-
- $targetNullable = [\T_INLINE_THEN];
- if (\defined('T_NULLABLE')) {
- $targetNullable[] = \T_NULLABLE;
- }
-
- return [
- 'null-coalesce' => [
- '/* testDontConfuseWithNullCoalesce */',
- $targetCoalesce,
- ],
- 'null-coalesce-equals' => [
- '/* testDontConfuseWithNullCoalesceEquals */',
- $targetCoalesceAndEquals,
- ],
- 'nullable-property' => [
- '/* testDontConfuseWithNullable1 */',
- $targetNullable,
- ],
- 'nullable-param-type' => [
- '/* testDontConfuseWithNullable2 */',
- $targetNullable,
- ],
- 'nullable-return-type' => [
- '/* testDontConfuseWithNullable3 */',
- $targetNullable,
- ],
- 'parse-error' => [
- '/* testParseError */',
+ 'testMarker' => '/* testShortTernaryWithCommentAndAnnotations */',
+ 'expected' => true,
],
];
}
diff --git a/Tests/Utils/Operators/IsUnaryPlusMinusJSTest.php b/Tests/Utils/Operators/IsUnaryPlusMinusJSTest.php
index 86c0af65..ef47170d 100644
--- a/Tests/Utils/Operators/IsUnaryPlusMinusJSTest.php
+++ b/Tests/Utils/Operators/IsUnaryPlusMinusJSTest.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\Utils\Operators;
-use PHPCSUtils\Tests\Utils\Operators\IsUnaryPlusMinusTest;
+use PHPCSUtils\Tests\Utils\Operators\IsUnaryPlusMinusTestCase;
/**
* Tests for the \PHPCSUtils\Utils\Operators::isUnaryPlusMinus() method.
@@ -21,7 +21,7 @@
*
* @since 1.0.0
*/
-class IsUnaryPlusMinusJSTest extends IsUnaryPlusMinusTest
+final class IsUnaryPlusMinusJSTest extends IsUnaryPlusMinusTestCase
{
/**
@@ -42,32 +42,32 @@ public function dataIsUnaryPlusMinus()
{
return [
'non-unary-plus' => [
- '/* testNonUnaryPlus */',
- false,
+ 'testMarker' => '/* testNonUnaryPlus */',
+ 'expected' => false,
],
'non-unary-minus' => [
- '/* testNonUnaryMinus */',
- false,
+ 'testMarker' => '/* testNonUnaryMinus */',
+ 'expected' => false,
],
'unary-minus-colon' => [
- '/* testUnaryMinusColon */',
- true,
+ 'testMarker' => '/* testUnaryMinusColon */',
+ 'expected' => true,
],
'unary-minus-switch-case' => [
- '/* testUnaryMinusCase */',
- true,
+ 'testMarker' => '/* testUnaryMinusCase */',
+ 'expected' => true,
],
'unary-minus-ternary-then' => [
- '/* testUnaryMinusTernaryThen */',
- true,
+ 'testMarker' => '/* testUnaryMinusTernaryThen */',
+ 'expected' => true,
],
'unary-minus-ternary-else' => [
- '/* testUnaryPlusTernaryElse */',
- true,
+ 'testMarker' => '/* testUnaryPlusTernaryElse */',
+ 'expected' => true,
],
'unary-minus-if-condition' => [
- '/* testUnaryMinusIfCondition */',
- true,
+ 'testMarker' => '/* testUnaryMinusIfCondition */',
+ 'expected' => true,
],
];
}
diff --git a/Tests/Utils/Operators/IsUnaryPlusMinusTest.inc b/Tests/Utils/Operators/IsUnaryPlusMinusTest.inc
index fb9f9eee..0ab78a6b 100644
--- a/Tests/Utils/Operators/IsUnaryPlusMinusTest.inc
+++ b/Tests/Utils/Operators/IsUnaryPlusMinusTest.inc
@@ -71,7 +71,7 @@ $a = $a ? -1 :
+ 10;
/* testUnaryMinusCoalesce */
-$a = $a ?? -1 :
+$a = $a ?? -1 ;
/* testUnaryPlusIntReturn */
return +1;
@@ -79,6 +79,9 @@ return +1;
/* testUnaryMinusFloatReturn */
return -1.1;
+/* testUnaryPlusIntExit */
+exit -1;
+
/* testUnaryPlusPrint */
print +$b;
@@ -126,15 +129,27 @@ declare( ticks = +10 );
switch ($a) {
/* testUnaryPlusCase */
case +20:
- // Something.
- break;
+ /* testUnaryPlusContinue */
+ continue +2;
/* testUnaryMinusCase */
case -1.23:
- // Something.
- break;
+ /* testUnaryPlusBreak */
+ break +1;
}
+/* testUnaryMinusArrowFunction */
+$fn = static fn(DateTime $a, DateTime $b): int => -($a->getTimestamp() <=> $b->getTimestamp());
+
+$matcher = match ($a) {
+ /* testUnaryPlusMatchArrow */
+ 'a' => +1,
+ /* testUnaryMinusMatchArrow */
+ 'b', 'c', 'd' => -2,
+ /* testUnaryMinusMatchDefault */
+ default => -3,
+};
+
// Testing `$a = -+-+10`;
$a =
/* testSequenceNonUnary1 */
@@ -146,12 +161,6 @@ $a =
/* testSequenceUnaryEnd */
+ /*comment*/ 10;
-/* testPHP74NumericLiteralFloatContainingPlus */
-$a = 6.674_083e+11;
-
-/* testPHP74NumericLiteralFloatContainingMinus */
-$a = 6.674_083e-1_1;
-
/* testPHP74NumericLiteralIntCalc1 */
$a = 667_083 - 11;
diff --git a/Tests/Utils/Operators/IsUnaryPlusMinusTest.php b/Tests/Utils/Operators/IsUnaryPlusMinusTest.php
index 68c0c75a..93514299 100644
--- a/Tests/Utils/Operators/IsUnaryPlusMinusTest.php
+++ b/Tests/Utils/Operators/IsUnaryPlusMinusTest.php
@@ -10,9 +10,7 @@
namespace PHPCSUtils\Tests\Utils\Operators;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
-use PHPCSUtils\Utils\Numbers;
-use PHPCSUtils\Utils\Operators;
+use PHPCSUtils\Tests\Utils\Operators\IsUnaryPlusMinusTestCase;
/**
* Tests for the \PHPCSUtils\Utils\Operators::isUnaryPlusMinus() method.
@@ -23,65 +21,9 @@
*
* @since 1.0.0
*/
-class IsUnaryPlusMinusTest extends UtilityMethodTestCase
+final class IsUnaryPlusMinusTest extends IsUnaryPlusMinusTestCase
{
- /**
- * Test that false is returned when a non-existent token is passed.
- *
- * @return void
- */
- public function testNonExistentToken()
- {
- $this->assertFalse(Operators::isUnaryPlusMinus(self::$phpcsFile, 10000));
- }
-
- /**
- * Test that false is returned when a non-plus/minus token is passed.
- *
- * @return void
- */
- public function testNotPlusMinusToken()
- {
- $target = $this->getTargetToken('/* testNonUnaryPlus */', \T_LNUMBER);
- $this->assertFalse(Operators::isUnaryPlusMinus(self::$phpcsFile, $target));
- }
-
- /**
- * Test whether a T_PLUS or T_MINUS token is a unary operator.
- *
- * @dataProvider dataIsUnaryPlusMinus
- *
- * @param string $testMarker The comment which prefaces the target token in the test file.
- * @param bool $expected The expected boolean return value.
- * @param bool $maybeSkip Whether the "should this test be skipped" check should be executed.
- * Defaults to false.
- *
- * @return void
- */
- public function testIsUnaryPlusMinus($testMarker, $expected, $maybeSkip = false)
- {
- if ($maybeSkip === true) {
- /*
- * Skip the test if this is PHP 7.4 or a PHPCS version which backfills the token sequence
- * to one token as in that case, the plus/minus token won't exist
- */
- $skipMessage = 'Test irrelevant as the target token won\'t exist';
- if (\version_compare(\PHP_VERSION_ID, '70399', '>') === true) {
- $this->markTestSkipped($skipMessage);
- }
-
- if (\version_compare(static::$phpcsVersion, Numbers::UNSUPPORTED_PHPCS_VERSION, '>=') === true) {
- $this->markTestSkipped($skipMessage);
- }
- }
-
- $stackPtr = $this->getTargetToken($testMarker, [\T_PLUS, \T_MINUS]);
- $result = Operators::isUnaryPlusMinus(self::$phpcsFile, $stackPtr);
-
- $this->assertSame($expected, $result);
- }
-
/**
* Data provider.
*
@@ -93,219 +35,237 @@ public function dataIsUnaryPlusMinus()
{
return [
'non-unary-plus' => [
- '/* testNonUnaryPlus */',
- false,
+ 'testMarker' => '/* testNonUnaryPlus */',
+ 'expected' => false,
],
'non-unary-minus' => [
- '/* testNonUnaryMinus */',
- false,
+ 'testMarker' => '/* testNonUnaryMinus */',
+ 'expected' => false,
],
'non-unary-plus-arrays' => [
- '/* testNonUnaryPlusArrays */',
- false,
+ 'testMarker' => '/* testNonUnaryPlusArrays */',
+ 'expected' => false,
],
'unary-minus-arithmetic' => [
- '/* testUnaryMinusArithmetic */',
- true,
+ 'testMarker' => '/* testUnaryMinusArithmetic */',
+ 'expected' => true,
],
'unary-plus-arithmetic' => [
- '/* testUnaryPlusArithmetic */',
- true,
+ 'testMarker' => '/* testUnaryPlusArithmetic */',
+ 'expected' => true,
],
'unary-minus-concatenation' => [
- '/* testUnaryMinusConcatenation */',
- true,
+ 'testMarker' => '/* testUnaryMinusConcatenation */',
+ 'expected' => true,
],
'unary-plus-int-assignment' => [
- '/* testUnaryPlusIntAssignment */',
- true,
+ 'testMarker' => '/* testUnaryPlusIntAssignment */',
+ 'expected' => true,
],
'unary-minus-variable-assignment' => [
- '/* testUnaryMinusVariableAssignment */',
- true,
+ 'testMarker' => '/* testUnaryMinusVariableAssignment */',
+ 'expected' => true,
],
'unary-plus-float-assignment' => [
- '/* testUnaryPlusFloatAssignment */',
- true,
+ 'testMarker' => '/* testUnaryPlusFloatAssignment */',
+ 'expected' => true,
],
'unary-minus-bool-assignment' => [
- '/* testUnaryMinusBoolAssignment */',
- true,
+ 'testMarker' => '/* testUnaryMinusBoolAssignment */',
+ 'expected' => true,
],
'unary-plus-string-assignment-with-comment' => [
- '/* testUnaryPlusStringAssignmentWithComment */',
- true,
+ 'testMarker' => '/* testUnaryPlusStringAssignmentWithComment */',
+ 'expected' => true,
],
'unary-minus-string-assignment' => [
- '/* testUnaryMinusStringAssignment */',
- true,
+ 'testMarker' => '/* testUnaryMinusStringAssignment */',
+ 'expected' => true,
],
'unary-plus-plus-null-assignment' => [
- '/* testUnaryPlusNullAssignment */',
- true,
+ 'testMarker' => '/* testUnaryPlusNullAssignment */',
+ 'expected' => true,
],
'unary-minus-variable-variable-assignment' => [
- '/* testUnaryMinusVariableVariableAssignment */',
- true,
+ 'testMarker' => '/* testUnaryMinusVariableVariableAssignment */',
+ 'expected' => true,
],
'unary-plus-int-comparison' => [
- '/* testUnaryPlusIntComparison */',
- true,
+ 'testMarker' => '/* testUnaryPlusIntComparison */',
+ 'expected' => true,
],
'unary-plus-int-comparison-yoda' => [
- '/* testUnaryPlusIntComparisonYoda */',
- true,
+ 'testMarker' => '/* testUnaryPlusIntComparisonYoda */',
+ 'expected' => true,
],
'unary-minus-float-comparison' => [
- '/* testUnaryMinusFloatComparison */',
- true,
+ 'testMarker' => '/* testUnaryMinusFloatComparison */',
+ 'expected' => true,
],
'unary-minus-string-comparison-yoda' => [
- '/* testUnaryMinusStringComparisonYoda */',
- true,
+ 'testMarker' => '/* testUnaryMinusStringComparisonYoda */',
+ 'expected' => true,
],
'unary-plus-variable-boolean' => [
- '/* testUnaryPlusVariableBoolean */',
- true,
+ 'testMarker' => '/* testUnaryPlusVariableBoolean */',
+ 'expected' => true,
],
'unary-minus-variable-boolean' => [
- '/* testUnaryMinusVariableBoolean */',
- true,
+ 'testMarker' => '/* testUnaryMinusVariableBoolean */',
+ 'expected' => true,
],
'unary-plus-logical-xor' => [
- '/* testUnaryPlusLogicalXor */',
- true,
+ 'testMarker' => '/* testUnaryPlusLogicalXor */',
+ 'expected' => true,
],
'unary-minus-ternary-then' => [
- '/* testUnaryMinusTernaryThen */',
- true,
+ 'testMarker' => '/* testUnaryMinusTernaryThen */',
+ 'expected' => true,
],
'unary-plus-ternary-else' => [
- '/* testUnaryPlusTernaryElse */',
- true,
+ 'testMarker' => '/* testUnaryPlusTernaryElse */',
+ 'expected' => true,
],
'unary-minus-coalesce' => [
- '/* testUnaryMinusCoalesce */',
- true,
+ 'testMarker' => '/* testUnaryMinusCoalesce */',
+ 'expected' => true,
],
'unary-plus-int-return' => [
- '/* testUnaryPlusIntReturn */',
- true,
+ 'testMarker' => '/* testUnaryPlusIntReturn */',
+ 'expected' => true,
],
'unary-minus-float-return' => [
- '/* testUnaryMinusFloatReturn */',
- true,
+ 'testMarker' => '/* testUnaryMinusFloatReturn */',
+ 'expected' => true,
+ ],
+ 'unary-minus-int-exit' => [
+ 'testMarker' => '/* testUnaryPlusIntExit */',
+ 'expected' => true,
],
'unary-plus-print' => [
- '/* testUnaryPlusPrint */',
- true,
+ 'testMarker' => '/* testUnaryPlusPrint */',
+ 'expected' => true,
],
'unary-minus-echo' => [
- '/* testUnaryMinusEcho */',
- true,
+ 'testMarker' => '/* testUnaryMinusEcho */',
+ 'expected' => true,
],
'unary-plus-yield' => [
- '/* testUnaryPlusYield */',
- true,
+ 'testMarker' => '/* testUnaryPlusYield */',
+ 'expected' => true,
],
'unary-plus-array-access' => [
- '/* testUnaryPlusArrayAccess */',
- true,
+ 'testMarker' => '/* testUnaryPlusArrayAccess */',
+ 'expected' => true,
],
'unary-minus-string-array-access' => [
- '/* testUnaryMinusStringArrayAccess */',
- true,
+ 'testMarker' => '/* testUnaryMinusStringArrayAccess */',
+ 'expected' => true,
],
'unary-plus-long-array-assignment' => [
- '/* testUnaryPlusLongArrayAssignment */',
- true,
+ 'testMarker' => '/* testUnaryPlusLongArrayAssignment */',
+ 'expected' => true,
],
'unary-minus-long-array-assignment-key' => [
- '/* testUnaryMinusLongArrayAssignmentKey */',
- true,
+ 'testMarker' => '/* testUnaryMinusLongArrayAssignmentKey */',
+ 'expected' => true,
],
'unary-plus-long-array-assignment-value' => [
- '/* testUnaryPlusLongArrayAssignmentValue */',
- true,
+ 'testMarker' => '/* testUnaryPlusLongArrayAssignmentValue */',
+ 'expected' => true,
],
'unary-plus-short-array-assignment' => [
- '/* testUnaryPlusShortArrayAssignment */',
- true,
+ 'testMarker' => '/* testUnaryPlusShortArrayAssignment */',
+ 'expected' => true,
],
'non-unary-minus-short-array-assignment' => [
- '/* testNonUnaryMinusShortArrayAssignment */',
- false,
+ 'testMarker' => '/* testNonUnaryMinusShortArrayAssignment */',
+ 'expected' => false,
],
'unary-minus-casts' => [
- '/* testUnaryMinusCast */',
- true,
+ 'testMarker' => '/* testUnaryMinusCast */',
+ 'expected' => true,
],
'unary-plus-function-call-param' => [
- '/* testUnaryPlusFunctionCallParam */',
- true,
+ 'testMarker' => '/* testUnaryPlusFunctionCallParam */',
+ 'expected' => true,
],
'unary-minus-function-call-param' => [
- '/* testUnaryMinusFunctionCallParam */',
- true,
+ 'testMarker' => '/* testUnaryMinusFunctionCallParam */',
+ 'expected' => true,
],
'unary-plus-declare' => [
- '/* testUnaryPlusDeclare */',
- true,
+ 'testMarker' => '/* testUnaryPlusDeclare */',
+ 'expected' => true,
],
'unary-plus-switch-case' => [
- '/* testUnaryPlusCase */',
- true,
+ 'testMarker' => '/* testUnaryPlusCase */',
+ 'expected' => true,
+ ],
+ 'unary-plus-continue' => [
+ 'testMarker' => '/* testUnaryPlusContinue */',
+ 'expected' => true,
],
'unary-minus-switch-case' => [
- '/* testUnaryMinusCase */',
- true,
+ 'testMarker' => '/* testUnaryMinusCase */',
+ 'expected' => true,
+ ],
+ 'unary-plus-break' => [
+ 'testMarker' => '/* testUnaryPlusBreak */',
+ 'expected' => true,
+ ],
+ 'unary-minus-arrow-function' => [
+ 'testMarker' => '/* testUnaryMinusArrowFunction */',
+ 'expected' => true,
+ ],
+ 'unary-plus-match-arrow' => [
+ 'testMarker' => '/* testUnaryPlusMatchArrow */',
+ 'expected' => true,
+ ],
+ 'unary-minus-match-arrow' => [
+ 'testMarker' => '/* testUnaryMinusMatchArrow */',
+ 'expected' => true,
+ ],
+ 'unary-minus-match-default' => [
+ 'testMarker' => '/* testUnaryMinusMatchDefault */',
+ 'expected' => true,
],
'operator-sequence-non-unary-1' => [
- '/* testSequenceNonUnary1 */',
- false,
+ 'testMarker' => '/* testSequenceNonUnary1 */',
+ 'expected' => false,
],
'operator-sequence-non-unary-2' => [
- '/* testSequenceNonUnary2 */',
- false,
+ 'testMarker' => '/* testSequenceNonUnary2 */',
+ 'expected' => false,
],
'operator-sequence-non-unary-3' => [
- '/* testSequenceNonUnary3 */',
- false,
+ 'testMarker' => '/* testSequenceNonUnary3 */',
+ 'expected' => false,
],
'operator-sequence-unary-end' => [
- '/* testSequenceUnaryEnd */',
- true,
- ],
- 'php-7.4-underscore-float-containing-plus' => [
- '/* testPHP74NumericLiteralFloatContainingPlus */',
- false,
- true, // Skip for PHP 7.4 & PHPCS 3.5.3+.
- ],
- 'php-7.4-underscore-float-containing-minus' => [
- '/* testPHP74NumericLiteralFloatContainingMinus */',
- false,
- true, // Skip for PHP 7.4 & PHPCS 3.5.3+.
+ 'testMarker' => '/* testSequenceUnaryEnd */',
+ 'expected' => true,
],
'php-7.4-underscore-int-calculation-1' => [
- '/* testPHP74NumericLiteralIntCalc1 */',
- false,
+ 'testMarker' => '/* testPHP74NumericLiteralIntCalc1 */',
+ 'expected' => false,
],
'php-7.4-underscore-int-calculation-2' => [
- '/* testPHP74NumericLiteralIntCalc2 */',
- false,
+ 'testMarker' => '/* testPHP74NumericLiteralIntCalc2 */',
+ 'expected' => false,
],
'php-7.4-underscore-float-calculation-1' => [
- '/* testPHP74NumericLiteralFloatCalc1 */',
- false,
+ 'testMarker' => '/* testPHP74NumericLiteralFloatCalc1 */',
+ 'expected' => false,
],
'php-7.4-underscore-float-calculation-2' => [
- '/* testPHP74NumericLiteralFloatCalc2 */',
- false,
+ 'testMarker' => '/* testPHP74NumericLiteralFloatCalc2 */',
+ 'expected' => false,
],
'parse-error' => [
- '/* testParseError */',
- false,
+ 'testMarker' => '/* testParseError */',
+ 'expected' => false,
],
];
}
diff --git a/Tests/Utils/Operators/IsUnaryPlusMinusTestCase.php b/Tests/Utils/Operators/IsUnaryPlusMinusTestCase.php
new file mode 100644
index 00000000..cb441f01
--- /dev/null
+++ b/Tests/Utils/Operators/IsUnaryPlusMinusTestCase.php
@@ -0,0 +1,77 @@
+assertFalse(Operators::isUnaryPlusMinus(self::$phpcsFile, 10000));
+ }
+
+ /**
+ * Test that false is returned when a non-plus/minus token is passed.
+ *
+ * @covers \PHPCSUtils\Utils\Operators::isUnaryPlusMinus
+ *
+ * @return void
+ */
+ public function testNotPlusMinusToken()
+ {
+ $target = $this->getTargetToken('/* testNonUnaryPlus */', \T_LNUMBER);
+ $this->assertFalse(Operators::isUnaryPlusMinus(self::$phpcsFile, $target));
+ }
+
+ /**
+ * Test whether a T_PLUS or T_MINUS token is a unary operator.
+ *
+ * @covers \PHPCSUtils\Utils\Operators::isUnaryPlusMinus
+ *
+ * @dataProvider dataIsUnaryPlusMinus
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param bool $expected The expected boolean return value.
+ *
+ * @return void
+ */
+ public function testIsUnaryPlusMinus($testMarker, $expected)
+ {
+ $stackPtr = $this->getTargetToken($testMarker, [\T_PLUS, \T_MINUS]);
+ $result = Operators::isUnaryPlusMinus(self::$phpcsFile, $stackPtr);
+
+ $this->assertSame($expected, $result);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testIsUnaryPlusMinus() For the array format.
+ *
+ * @return array
+ */
+ abstract public function dataIsUnaryPlusMinus();
+}
diff --git a/Tests/Utils/Orthography/FirstCharTest.php b/Tests/Utils/Orthography/FirstCharTest.php
index 53f00584..b474ac4e 100644
--- a/Tests/Utils/Orthography/FirstCharTest.php
+++ b/Tests/Utils/Orthography/FirstCharTest.php
@@ -24,7 +24,7 @@
*
* @since 1.0.0
*/
-class FirstCharTest extends TestCase
+final class FirstCharTest extends TestCase
{
/**
@@ -70,15 +70,15 @@ public function dataFirstChar()
$data = [
// Quotes should be stripped before passing the string.
'double-quoted' => [
- '"This is a test"',
- [
+ 'input' => '"This is a test"',
+ 'expected' => [
'capitalized' => false,
'lowercase' => false,
],
],
'single-quoted' => [
- "'This is a test'",
- [
+ 'input' => "'This is a test'",
+ 'expected' => [
'capitalized' => false,
'lowercase' => false,
],
@@ -86,15 +86,15 @@ public function dataFirstChar()
// Not starting with a letter.
'start-numeric' => [
- '12 Foostreet',
- [
+ 'input' => '12 Foostreet',
+ 'expected' => [
'capitalized' => false,
'lowercase' => false,
],
],
'start-bracket' => [
- '[Optional]',
- [
+ 'input' => '[Optional]',
+ 'expected' => [
'capitalized' => false,
'lowercase' => false,
],
@@ -102,17 +102,17 @@ public function dataFirstChar()
// Leading whitespace.
'english-lowercase-leading-whitespace' => [
- '
+ 'input' => '
this is a test',
- [
+ 'expected' => [
'capitalized' => false,
'lowercase' => true,
],
],
'english-propercase-leading-whitespace' => [
- '
+ 'input' => '
This is a test',
- [
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
@@ -120,43 +120,43 @@ public function dataFirstChar()
// First character lowercase.
'english-lowercase' => [
- 'this is a test',
- [
+ 'input' => 'this is a test',
+ 'expected' => [
'capitalized' => false,
'lowercase' => true,
],
],
'russian-lowercase' => [
- 'предназначена для',
- [
+ 'input' => 'предназначена для',
+ 'expected' => [
'capitalized' => false,
'lowercase' => true,
],
],
'latvian-lowercase' => [
- 'ir domāta',
- [
+ 'input' => 'ir domāta',
+ 'expected' => [
'capitalized' => false,
'lowercase' => true,
],
],
'armenian-lowercase' => [
- 'սա թեստ է',
- [
+ 'input' => 'սա թեստ է',
+ 'expected' => [
'capitalized' => false,
'lowercase' => true,
],
],
'mandinka-lowercase' => [
- 'ŋanniya',
- [
+ 'input' => 'ŋanniya',
+ 'expected' => [
'capitalized' => false,
'lowercase' => true,
],
],
'greek-lowercase' => [
- 'δημιουργήθηκε από',
- [
+ 'input' => 'δημιουργήθηκε από',
+ 'expected' => [
'capitalized' => false,
'lowercase' => true,
],
@@ -164,43 +164,43 @@ public function dataFirstChar()
// First character capitalized.
'english-propercase' => [
- 'This is a test',
- [
+ 'input' => 'This is a test',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
],
'russian-propercase' => [
- 'Дата написания этой книги',
- [
+ 'input' => 'Дата написания этой книги',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
],
'latvian-propercase' => [
- 'Šodienas datums',
- [
+ 'input' => 'Šodienas datums',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
],
'armenian-propercase' => [
- 'Սա թեստ է',
- [
+ 'input' => 'Սա թեստ է',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
],
'igbo-propercase' => [
- 'Ụbọchị tata bụ',
- [
+ 'input' => 'Ụbọchị tata bụ',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
],
'greek-propercase' => [
- 'Η σημερινή ημερομηνία',
- [
+ 'input' => 'Η σημερινή ημερομηνία',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
@@ -208,36 +208,36 @@ public function dataFirstChar()
// No concept of "case", but starting with a letter.
'arabic' => [
- 'هذا اختبار',
- [
+ 'input' => 'هذا اختبار',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
],
'pashto' => [
- 'دا یوه آزموینه ده',
- [
+ 'input' => 'دا یوه آزموینه ده',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
],
'hebrew' => [
- 'זה מבחן',
- [
+ 'input' => 'זה מבחן',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
],
'chinese-traditional' => [
- '這是一個測試',
- [
+ 'input' => '這是一個測試',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
],
'urdu' => [
- 'کا منشاء برائے',
- [
+ 'input' => 'کا منشاء برائے',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
@@ -257,16 +257,16 @@ public function dataFirstChar()
if (\PCRE_VERSION >= 10) {
$data['georgian'] = [
- 'ეს ტესტია',
- [
+ 'input' => 'ეს ტესტია',
+ 'expected' => [
'capitalized' => false,
'lowercase' => true,
],
];
} else {
$data['georgian'] = [
- 'ეს ტესტია',
- [
+ 'input' => 'ეს ტესტია',
+ 'expected' => [
'capitalized' => true,
'lowercase' => false,
],
diff --git a/Tests/Utils/Orthography/IsLastCharPunctuationTest.php b/Tests/Utils/Orthography/IsLastCharPunctuationTest.php
index 55b74f60..d177e252 100644
--- a/Tests/Utils/Orthography/IsLastCharPunctuationTest.php
+++ b/Tests/Utils/Orthography/IsLastCharPunctuationTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class IsLastCharPunctuationTest extends TestCase
+final class IsLastCharPunctuationTest extends TestCase
{
/**
@@ -59,71 +59,71 @@ public function dataIsLastCharPunctuation()
return [
// Quotes should be stripped before passing the string.
'double-quoted' => [
- '"This is a test."',
- false,
+ 'input' => '"This is a test."',
+ 'expected' => false,
],
'single-quoted' => [
- "'This is a test?'",
- false,
+ 'input' => "'This is a test?'",
+ 'expected' => false,
],
// Invalid end char.
'no-punctuation' => [
- 'This is a test',
- false,
+ 'input' => 'This is a test',
+ 'expected' => false,
],
'invalid-punctuation' => [
- 'This is a test;',
- false,
+ 'input' => 'This is a test;',
+ 'expected' => false,
],
'invalid-punctuationtrailing-whitespace' => [
- 'This is a test; ',
- false,
+ 'input' => 'This is a test; ',
+ 'expected' => false,
],
// Valid end char, default charset.
'valid' => [
- 'This is a test.',
- true,
+ 'input' => 'This is a test.',
+ 'expected' => true,
],
'valid-trailing-whitespace' => [
- 'This is a test.
+ 'input' => 'This is a test.
',
- true,
+ 'expected' => true,
],
// Invalid end char, custom charset.
'invalid-custom' => [
- 'This is a test.',
- false,
- '!?,;#',
+ 'input' => 'This is a test.',
+ 'expected' => false,
+ 'allowedChars' => '!?,;#',
],
// Valid end char, custom charset.
'valid-custom-1' => [
- 'This is a test;',
- true,
- '!?,;#',
+ 'input' => 'This is a test;',
+ 'expected' => true,
+ 'allowedChars' => '!?,;#',
],
'valid-custom-2' => [
- 'This is a test!',
- true,
- '!?,;#',
+ 'input' => 'This is a test!',
+ 'expected' => true,
+ 'allowedChars' => '!?,;#',
],
'valid-custom-3' => [
- 'Is this is a test?',
- true,
- '!?,;#',
+ 'input' => 'Is this is a test?',
+ 'expected' => true,
+ 'allowedChars' => '!?,;#',
],
'valid-custom-4' => [
- 'This is a test,',
- true,
- '!?,;#',
+ 'input' => 'This is a test,',
+ 'expected' => true,
+ 'allowedChars' => '!?,;#',
],
'valid-custom-5' => [
- 'This is a test#',
- true,
- '!?,;#',
+ 'input' => 'This is a test#',
+ 'expected' => true,
+ 'allowedChars' => '!?,;#',
],
];
}
diff --git a/Tests/Utils/Parentheses/ParenthesesTest.inc b/Tests/Utils/Parentheses/ParenthesesTest.inc
index 62522c4d..60d5599e 100644
--- a/Tests/Utils/Parentheses/ParenthesesTest.inc
+++ b/Tests/Utils/Parentheses/ParenthesesTest.inc
@@ -50,6 +50,21 @@ $a = ($b + $c);
/* testFunctionCallFnPHPCS353-354 */
$value = $obj->fn(true);
+/* testArrowFunctionByReference */
+$fn = fn &($x) => $x;
+
+/* testIfWithIssetEmpty */
+if ( isset( $a, $b ) && ! empty ($c) ) {
+ /* testUnset */
+ unset($a[1], $b->prop);
+}
+
+/* testEval */
+eval($a . $b . $c );
+
+/* testExit */
+if (defined('FOO') || die('message')) {}
+
// Intentional parse error. This has to be the last test in the file.
/* testParseError */
declare(ticks=1
diff --git a/Tests/Utils/Parentheses/ParenthesesTest.php b/Tests/Utils/Parentheses/ParenthesesTest.php
index 6cbd3efb..76b365a3 100644
--- a/Tests/Utils/Parentheses/ParenthesesTest.php
+++ b/Tests/Utils/Parentheses/ParenthesesTest.php
@@ -12,7 +12,6 @@
use PHPCSUtils\BackCompat\BCTokens;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
-use PHPCSUtils\Tokens\Collections;
use PHPCSUtils\Utils\Parentheses;
/**
@@ -24,7 +23,7 @@
*
* @since 1.0.0
*/
-class ParenthesesTest extends UtilityMethodTestCase
+final class ParenthesesTest extends UtilityMethodTestCase
{
/**
@@ -149,6 +148,42 @@ class ParenthesesTest extends UtilityMethodTestCase
'marker' => '/* testFunctionCallFnPHPCS353-354 */',
'code' => \T_TRUE,
],
+ 'testArrowFunctionReturnByRef' => [
+ 'marker' => '/* testArrowFunctionByReference */',
+ 'code' => \T_VARIABLE,
+ 'content' => '$x',
+ ],
+ 'testIfIsset-$b' => [
+ 'marker' => '/* testIfWithIssetEmpty */',
+ 'code' => \T_VARIABLE,
+ 'content' => '$b',
+ ],
+ 'testIfEmpty-$c' => [
+ 'marker' => '/* testIfWithIssetEmpty */',
+ 'code' => \T_VARIABLE,
+ 'content' => '$c',
+ ],
+ 'testUnset-->' => [
+ 'marker' => '/* testUnset */',
+ 'code' => \T_OBJECT_OPERATOR,
+ ],
+ 'testUnsetParenthesis' => [
+ 'marker' => '/* testUnset */',
+ 'code' => \T_OPEN_PARENTHESIS,
+ ],
+ 'testEval-concat' => [
+ 'marker' => '/* testEval */',
+ 'code' => \T_STRING_CONCAT,
+ ],
+ 'testIfExitDie-boolean-or' => [
+ 'marker' => '/* testExit */',
+ 'code' => \T_BOOLEAN_OR,
+ ],
+ 'testIfExitDie-message' => [
+ 'marker' => '/* testExit */',
+ 'code' => \T_CONSTANT_ENCAPSED_STRING,
+ 'content' => "'message'",
+ ],
'testParseError-1' => [
'marker' => '/* testParseError */',
'code' => \T_LNUMBER,
@@ -169,7 +204,9 @@ class ParenthesesTest extends UtilityMethodTestCase
* This array is merged with expected result arrays for various unit tests
* to make sure all possible parentheses owners are tested.
*
- * This array should be kept in sync with the Tokens::$parenthesisOpeners array.
+ * This array should be kept in sync with the Tokens::$parenthesisOpeners array
+ * + the extra tokens the Parentheses class allows for.
+ *
* This array isn't auto-generated based on the array in Tokens as for these
* tests we want to have access to the token constant names, not just their values.
*
@@ -190,6 +227,13 @@ class ParenthesesTest extends UtilityMethodTestCase
'T_CATCH' => false,
'T_DECLARE' => false,
'T_FN' => false,
+
+ // Extra tokens.
+ 'T_ISSET' => false,
+ 'T_UNSET' => false,
+ 'T_EMPTY' => false,
+ 'T_EXIT' => false,
+ 'T_EVAL' => false,
];
/**
@@ -343,7 +387,7 @@ public function testPassingParenthesisTokenToMethodsWhichExpectParenthesisClose(
*
* @return void
*/
- public function testPassingParenthesisCloseHandlinginBCLayer()
+ public function testPassingParenthesisCloseHandlingInBCLayer()
{
$stackPtr = $this->getTargetToken('/* testListOnCloseParens */', \T_CLOSE_PARENTHESIS);
@@ -368,8 +412,6 @@ public function testPassingParenthesisCloseHandlinginBCLayer()
/**
* Test that a function named fn sees the T_FUNCTION token as owner, not the T_FN token.
*
- * This specifically tests the BC-layer for arrow functions.
- *
* @return void
*/
public function testFunctionNamedFnKeywordNotParenthesesOwner()
@@ -582,8 +624,8 @@ public function dataWalkParentheses()
{
$data = [
'testIfWithArray-$a' => [
- 'testIfWithArray-$a',
- [
+ 'testName' => 'testIfWithArray-$a',
+ 'expectedResults' => [
'firstOpener' => -2,
'firstCloser' => 19,
'firstOwner' => -4,
@@ -599,8 +641,8 @@ public function dataWalkParentheses()
],
],
'testIfWithArray-array' => [
- 'testIfWithArray-array',
- [
+ 'testName' => 'testIfWithArray-array',
+ 'expectedResults' => [
'firstOpener' => -13,
'firstCloser' => 8,
'firstOwner' => -15,
@@ -616,8 +658,8 @@ public function dataWalkParentheses()
],
],
'testIfWithArray-$c' => [
- 'testIfWithArray-$c',
- [
+ 'testName' => 'testIfWithArray-$c',
+ 'expectedResults' => [
'firstOpener' => -15,
'firstCloser' => 6,
'firstOwner' => -17,
@@ -633,8 +675,8 @@ public function dataWalkParentheses()
],
],
'testWhileWithClosure-$a' => [
- 'testWhileWithClosure-$a',
- [
+ 'testName' => 'testWhileWithClosure-$a',
+ 'expectedResults' => [
'firstOpener' => -9,
'firstCloser' => 30,
'firstOwner' => -11,
@@ -650,8 +692,8 @@ public function dataWalkParentheses()
],
],
'testWhileWithClosure-$p' => [
- 'testWhileWithClosure-$p',
- [
+ 'testName' => 'testWhileWithClosure-$p',
+ 'expectedResults' => [
'firstOpener' => -24,
'firstCloser' => 15,
'firstOwner' => -26,
@@ -667,8 +709,8 @@ public function dataWalkParentheses()
],
],
'testWhileWithClosure-$result' => [
- 'testWhileWithClosure-$result',
- [
+ 'testName' => 'testWhileWithClosure-$result',
+ 'expectedResults' => [
'firstOpener' => -2,
'firstCloser' => 37,
'firstOwner' => -4,
@@ -684,8 +726,8 @@ public function dataWalkParentheses()
],
],
'testArrowFunction-$param' => [
- 'testArrowFunction-$param',
- [
+ 'testName' => 'testArrowFunction-$param',
+ 'expectedResults' => [
'firstOpener' => -10,
'firstCloser' => 11,
'firstOwner' => -11,
@@ -701,8 +743,8 @@ public function dataWalkParentheses()
],
],
'testArrowFunction-get' => [
- 'testArrowFunction-get',
- [
+ 'testName' => 'testArrowFunction-get',
+ 'expectedResults' => [
'firstOpener' => -17,
'firstCloser' => 4,
'firstOwner' => -18,
@@ -718,8 +760,8 @@ public function dataWalkParentheses()
],
],
'testMethodCalledFn-true' => [
- 'testMethodCalledFn-true',
- [
+ 'testName' => 'testMethodCalledFn-true',
+ 'expectedResults' => [
'firstOpener' => -1,
'firstCloser' => 1,
'firstOwner' => false,
@@ -734,9 +776,145 @@ public function dataWalkParentheses()
'lastIfElseOwner' => false,
],
],
+ 'testArrowFunctionReturnByRef' => [
+ 'testName' => 'testArrowFunctionReturnByRef',
+ 'expectedResults' => [
+ 'firstOpener' => -1,
+ 'firstCloser' => 1,
+ 'firstOwner' => -4,
+ 'firstScopeOwnerOpener' => false,
+ 'firstScopeOwnerCloser' => false,
+ 'firstScopeOwnerOwner' => false,
+ 'lastOpener' => -1,
+ 'lastCloser' => 1,
+ 'lastOwner' => -4,
+ 'lastArrayOpener' => false,
+ 'lastFunctionCloser' => false,
+ 'lastIfElseOwner' => false,
+ ],
+ ],
+ 'testIfIsset-$b' => [
+ 'testName' => 'testIfIsset-$b',
+ 'expectedResults' => [
+ 'firstOpener' => -8,
+ 'firstCloser' => 14,
+ 'firstOwner' => -10,
+ 'firstScopeOwnerOpener' => -8,
+ 'firstScopeOwnerCloser' => 14,
+ 'firstScopeOwnerOwner' => -10,
+ 'lastOpener' => -5,
+ 'lastCloser' => 2,
+ 'lastOwner' => -6,
+ 'lastArrayOpener' => false,
+ 'lastFunctionCloser' => false,
+ 'lastIfElseOwner' => -10,
+ ],
+ ],
+ 'testIfEmpty-$c' => [
+ 'testName' => 'testIfEmpty-$c',
+ 'expectedResults' => [
+ 'firstOpener' => -19,
+ 'firstCloser' => 3,
+ 'firstOwner' => -21,
+ 'firstScopeOwnerOpener' => -19,
+ 'firstScopeOwnerCloser' => 3,
+ 'firstScopeOwnerOwner' => -21,
+ 'lastOpener' => -1,
+ 'lastCloser' => 1,
+ 'lastOwner' => -3,
+ 'lastArrayOpener' => false,
+ 'lastFunctionCloser' => false,
+ 'lastIfElseOwner' => -21,
+ ],
+ ],
+ 'testUnset-->' => [
+ 'testName' => 'testUnset-->',
+ 'expectedResults' => [
+ 'firstOpener' => -8,
+ 'firstCloser' => 2,
+ 'firstOwner' => -9,
+ 'firstScopeOwnerOpener' => false,
+ 'firstScopeOwnerCloser' => false,
+ 'firstScopeOwnerOwner' => false,
+ 'lastOpener' => -8,
+ 'lastCloser' => 2,
+ 'lastOwner' => -9,
+ 'lastArrayOpener' => false,
+ 'lastFunctionCloser' => false,
+ 'lastIfElseOwner' => false,
+ ],
+ ],
+ 'testUnsetParenthesis' => [
+ 'testName' => 'testUnsetParenthesis',
+ 'expectedResults' => [
+ 'firstOpener' => false,
+ 'firstCloser' => false,
+ 'firstOwner' => false,
+ 'firstScopeOwnerOpener' => false,
+ 'firstScopeOwnerCloser' => false,
+ 'firstScopeOwnerOwner' => false,
+ 'lastOpener' => false,
+ 'lastCloser' => false,
+ 'lastOwner' => false,
+ 'lastArrayOpener' => false,
+ 'lastFunctionCloser' => false,
+ 'lastIfElseOwner' => false,
+ ],
+ ],
+ 'testEval-concat' => [
+ 'testName' => 'testEval-concat',
+ 'expectedResults' => [
+ 'firstOpener' => -3,
+ 'firstCloser' => 8,
+ 'firstOwner' => -4,
+ 'firstScopeOwnerOpener' => false,
+ 'firstScopeOwnerCloser' => false,
+ 'firstScopeOwnerOwner' => false,
+ 'lastOpener' => -3,
+ 'lastCloser' => 8,
+ 'lastOwner' => -4,
+ 'lastArrayOpener' => false,
+ 'lastFunctionCloser' => false,
+ 'lastIfElseOwner' => false,
+ ],
+ ],
+ 'testIfExitDie-boolean-or' => [
+ 'testName' => 'testIfExitDie-boolean-or',
+ 'expectedResults' => [
+ 'firstOpener' => -6,
+ 'firstCloser' => 6,
+ 'firstOwner' => -8,
+ 'firstScopeOwnerOpener' => -6,
+ 'firstScopeOwnerCloser' => 6,
+ 'firstScopeOwnerOwner' => -8,
+ 'lastOpener' => -6,
+ 'lastCloser' => 6,
+ 'lastOwner' => -8,
+ 'lastArrayOpener' => false,
+ 'lastFunctionCloser' => false,
+ 'lastIfElseOwner' => -8,
+ ],
+ ],
+ 'testIfExitDie-message' => [
+ 'testName' => 'testIfExitDie-message',
+ 'expectedResults' => [
+ 'firstOpener' => -10,
+ 'firstCloser' => 2,
+ 'firstOwner' => -12,
+ 'firstScopeOwnerOpener' => -10,
+ 'firstScopeOwnerCloser' => 2,
+ 'firstScopeOwnerOwner' => -12,
+ 'lastOpener' => -1,
+ 'lastCloser' => 1,
+ 'lastOwner' => -2,
+ 'lastArrayOpener' => false,
+ 'lastFunctionCloser' => false,
+ 'lastIfElseOwner' => -12,
+ ],
+ ],
'testParseError-1' => [
- 'testParseError-1',
- [
+ 'testName' => 'testParseError-1',
+ 'expectedResults' => [
'firstOpener' => false,
'firstCloser' => false,
'firstOwner' => false,
@@ -774,11 +952,6 @@ public function testHasOwner($testName, $expectedResults)
// Add expected results for all owner types not listed in the data provider.
$expectedResults += $this->ownerDefaults;
- if (\defined('T_FN') === false) {
- $expectedResults['T_STRING'] = $expectedResults['T_FN'];
- unset($expectedResults['T_FN']);
- }
-
foreach ($expectedResults as $ownerType => $expected) {
$result = Parentheses::hasOwner(self::$phpcsFile, $stackPtr, \constant($ownerType));
$this->assertSame(
@@ -804,134 +977,175 @@ public function dataHasOwner()
{
return [
'testIfWithArray-$a' => [
- 'testIfWithArray-$a',
- ['T_IF' => true],
+ 'testName' => 'testIfWithArray-$a',
+ 'expectedResults' => ['T_IF' => true],
],
'testIfWithArray-array' => [
- 'testIfWithArray-array',
- ['T_IF' => true],
+ 'testName' => 'testIfWithArray-array',
+ 'expectedResults' => ['T_IF' => true],
],
'testIfWithArray-$c' => [
- 'testIfWithArray-$c',
- [
+ 'testName' => 'testIfWithArray-$c',
+ 'expectedResults' => [
'T_ARRAY' => true,
'T_IF' => true,
],
],
'testElseIfWithClosure-$a' => [
- 'testElseIfWithClosure-$a',
- [
+ 'testName' => 'testElseIfWithClosure-$a',
+ 'expectedResults' => [
'T_CLOSURE' => true,
'T_ELSEIF' => true,
],
],
'testElseIfWithClosure-closure' => [
- 'testElseIfWithClosure-closure',
- ['T_ELSEIF' => true],
+ 'testName' => 'testElseIfWithClosure-closure',
+ 'expectedResults' => ['T_ELSEIF' => true],
],
'testElseIfWithClosure-$array' => [
- 'testElseIfWithClosure-$array',
- ['T_ELSEIF' => true],
+ 'testName' => 'testElseIfWithClosure-$array',
+ 'expectedResults' => ['T_ELSEIF' => true],
],
'testForeach-45' => [
- 'testForeach-45',
- [
+ 'testName' => 'testForeach-45',
+ 'expectedResults' => [
'T_ARRAY' => true,
'T_FOREACH' => true,
],
],
'testForeach-$a' => [
- 'testForeach-$a',
- [
+ 'testName' => 'testForeach-$a',
+ 'expectedResults' => [
'T_LIST' => true,
'T_FOREACH' => true,
],
],
'testForeach-$c' => [
- 'testForeach-$c',
- [
+ 'testName' => 'testForeach-$c',
+ 'expectedResults' => [
'T_LIST' => true,
'T_FOREACH' => true,
],
],
'testFunctionwithArray-$param' => [
- 'testFunctionwithArray-$param',
- ['T_FUNCTION' => true],
+ 'testName' => 'testFunctionwithArray-$param',
+ 'expectedResults' => ['T_FUNCTION' => true],
],
'testFunctionwithArray-2' => [
- 'testFunctionwithArray-2',
- [
+ 'testName' => 'testFunctionwithArray-2',
+ 'expectedResults' => [
'T_ARRAY' => true,
'T_FUNCTION' => true,
],
],
'testForWithTernary-$a' => [
- 'testForWithTernary-$a',
- ['T_FOR' => true],
+ 'testName' => 'testForWithTernary-$a',
+ 'expectedResults' => ['T_FOR' => true],
],
'testForWithTernary-$c' => [
- 'testForWithTernary-$c',
- ['T_FOR' => true],
+ 'testName' => 'testForWithTernary-$c',
+ 'expectedResults' => ['T_FOR' => true],
],
'testForWithTernary-$array' => [
- 'testForWithTernary-$array',
- ['T_FOR' => true],
+ 'testName' => 'testForWithTernary-$array',
+ 'expectedResults' => ['T_FOR' => true],
],
'testWhileWithClosure-$a' => [
- 'testWhileWithClosure-$a',
- ['T_WHILE' => true],
+ 'testName' => 'testWhileWithClosure-$a',
+ 'expectedResults' => ['T_WHILE' => true],
],
'testWhileWithClosure-$p' => [
- 'testWhileWithClosure-$p',
- [
+ 'testName' => 'testWhileWithClosure-$p',
+ 'expectedResults' => [
'T_CLOSURE' => true,
'T_WHILE' => true,
],
],
'testWhileWithClosure-$result' => [
- 'testWhileWithClosure-$result',
- ['T_WHILE' => true],
+ 'testName' => 'testWhileWithClosure-$result',
+ 'expectedResults' => ['T_WHILE' => true],
],
'testAnonClass-implements' => [
- 'testAnonClass-implements',
- ['T_ANON_CLASS' => true],
+ 'testName' => 'testAnonClass-implements',
+ 'expectedResults' => ['T_ANON_CLASS' => true],
],
'testAnonClass-$param' => [
- 'testAnonClass-$param',
- [
+ 'testName' => 'testAnonClass-$param',
+ 'expectedResults' => [
'T_ANON_CLASS' => true,
'T_FUNCTION' => true,
],
],
'testAnonClass-$e' => [
- 'testAnonClass-$e',
- [
+ 'testName' => 'testAnonClass-$e',
+ 'expectedResults' => [
'T_ANON_CLASS' => true,
'T_CATCH' => true,
],
],
'testAnonClass-$a' => [
- 'testAnonClass-$a',
- [
+ 'testName' => 'testAnonClass-$a',
+ 'expectedResults' => [
'T_ANON_CLASS' => true,
'T_WHILE' => true,
],
],
'testArrowFunction-$param' => [
- 'testArrowFunction-$param',
- [
+ 'testName' => 'testArrowFunction-$param',
+ 'expectedResults' => [
'T_ARRAY' => true,
'T_FN' => true,
],
],
'testMethodCalledFn-true' => [
- 'testMethodCalledFn-true',
- [],
+ 'testName' => 'testMethodCalledFn-true',
+ 'expectedResults' => [],
+ ],
+ 'testArrowFunctionReturnByRef' => [
+ 'testName' => 'testArrowFunctionReturnByRef',
+ 'expectedResults' => ['T_FN' => true],
+ ],
+ 'testIfIsset-$b' => [
+ 'testName' => 'testIfIsset-$b',
+ 'expectedResults' => [
+ 'T_IF' => true,
+ 'T_ISSET' => true,
+ ],
+ ],
+ 'testIfEmpty-$c' => [
+ 'testName' => 'testIfEmpty-$c',
+ 'expectedResults' => [
+ 'T_IF' => true,
+ 'T_EMPTY' => true,
+ ],
+ ],
+ 'testUnset-->' => [
+ 'testName' => 'testUnset-->',
+ 'expectedResults' => ['T_UNSET' => true],
+ ],
+ 'testUnsetParenthesis' => [
+ 'testName' => 'testUnsetParenthesis',
+ 'expectedResults' => [],
+ ],
+ 'testEval-concat' => [
+ 'testName' => 'testEval-concat',
+ 'expectedResults' => ['T_EVAL' => true],
+ ],
+ 'testIfExitDie-boolean-or' => [
+ 'testName' => 'testIfExitDie-boolean-or',
+ 'expectedResults' => ['T_IF' => true],
+ ],
+ 'testIfExitDie-message' => [
+ 'testName' => 'testIfExitDie-message',
+ 'expectedResults' => [
+ 'T_IF' => true,
+ 'T_EXIT' => true,
+ ],
],
'testParseError-1' => [
- 'testParseError-1',
- [],
+ 'testName' => 'testParseError-1',
+ 'expectedResults' => [],
],
];
}
@@ -1007,59 +1221,59 @@ public function dataFirstOwnerIn()
{
return [
'testElseIfWithClosure-$a-elseif' => [
- 'testElseIfWithClosure-$a',
- [\T_ELSEIF],
- -10,
+ 'testName' => 'testElseIfWithClosure-$a',
+ 'validOwners' => [\T_ELSEIF],
+ 'expected' => -10,
],
'testElseIfWithClosure-$a-array' => [
- 'testElseIfWithClosure-$a',
- [\T_ARRAY],
- false,
+ 'testName' => 'testElseIfWithClosure-$a',
+ 'validOwners' => [\T_ARRAY],
+ 'expected' => false,
],
'testForeach-45-foreach-for' => [
- 'testForeach-45',
- [\T_FOREACH, \T_FOR],
- -27,
+ 'testName' => 'testForeach-45',
+ 'validOwners' => [\T_FOREACH, \T_FOR],
+ 'expected' => -27,
],
'testForeach-45-array' => [
- 'testForeach-45',
- [\T_ARRAY],
- false,
+ 'testName' => 'testForeach-45',
+ 'validOwners' => [\T_ARRAY],
+ 'expected' => false,
],
'testForeach-$a-foreach-for' => [
- 'testForeach-$a',
- [\T_FOREACH, \T_FOR],
- -43,
+ 'testName' => 'testForeach-$a',
+ 'validOwners' => [\T_FOREACH, \T_FOR],
+ 'expected' => -43,
],
'testForeach-$a-list' => [
- 'testForeach-$a',
- [\T_LIST],
- false,
+ 'testName' => 'testForeach-$a',
+ 'validOwners' => [\T_LIST],
+ 'expected' => false,
],
'testFunctionwithArray-$param-function-closure' => [
- 'testFunctionwithArray-$param',
- [\T_FUNCTION, \T_CLOSURE],
- -4,
+ 'testName' => 'testFunctionwithArray-$param',
+ 'validOwners' => [\T_FUNCTION, \T_CLOSURE],
+ 'expected' => -4,
],
'testFunctionwithArray-$param-if-elseif-else' => [
- 'testFunctionwithArray-$param',
- [\T_IF, \T_ELSEIF, \T_ELSE],
- false,
+ 'testName' => 'testFunctionwithArray-$param',
+ 'validOwners' => [\T_IF, \T_ELSEIF, \T_ELSE],
+ 'expected' => false,
],
'testAnonClass-implements-anon-class' => [
- 'testAnonClass-implements',
- [\T_ANON_CLASS],
- -8,
+ 'testName' => 'testAnonClass-implements',
+ 'validOwners' => [\T_ANON_CLASS],
+ 'expected' => -8,
],
'testAnonClass-$e-function' => [
- 'testAnonClass-$e',
- [\T_FUNCTION],
- false,
+ 'testName' => 'testAnonClass-$e',
+ 'validOwners' => [\T_FUNCTION],
+ 'expected' => false,
],
'testAnonClass-$e-catch' => [
- 'testAnonClass-$e',
- [\T_CATCH],
- false,
+ 'testName' => 'testAnonClass-$e',
+ 'validOwners' => [\T_CATCH],
+ 'expected' => false,
],
];
}
@@ -1096,69 +1310,82 @@ public function testLastOwnerIn($testName, $validOwners, $expected)
*/
public function dataLastOwnerIn()
{
- $arrowFunctionOwners = Collections::arrowFunctionTokensBC();
-
return [
'testElseIfWithClosure-$a-closure' => [
- 'testElseIfWithClosure-$a',
- [\T_CLOSURE],
- -3,
+ 'testName' => 'testElseIfWithClosure-$a',
+ 'validOwners' => [\T_CLOSURE],
+ 'expected' => -3,
],
'testElseIfWithClosure-$a-array' => [
- 'testElseIfWithClosure-$a',
- [\T_ARRAY],
- false,
+ 'testName' => 'testElseIfWithClosure-$a',
+ 'validOwners' => [\T_ARRAY],
+ 'expected' => false,
],
'testForeach-45-array' => [
- 'testForeach-45',
- [\T_ARRAY],
- -2,
+ 'testName' => 'testForeach-45',
+ 'validOwners' => [\T_ARRAY],
+ 'expected' => -2,
],
'testForeach-45-foreach-for' => [
- 'testForeach-45',
- [\T_FOREACH, \T_FOR],
- false,
+ 'testName' => 'testForeach-45',
+ 'validOwners' => [\T_FOREACH, \T_FOR],
+ 'expected' => false,
],
'testForeach-$a-foreach-for' => [
- 'testForeach-$a',
- [\T_FOREACH, \T_FOR],
- false,
+ 'testName' => 'testForeach-$a',
+ 'validOwners' => [\T_FOREACH, \T_FOR],
+ 'expected' => false,
],
'testForeach-$a-list' => [
- 'testForeach-$a',
- [\T_LIST],
- -6,
+ 'testName' => 'testForeach-$a',
+ 'validOwners' => [\T_LIST],
+ 'expected' => -6,
],
'testFunctionwithArray-$param-function-closure' => [
- 'testFunctionwithArray-$param',
- [\T_FUNCTION, \T_CLOSURE],
- -4,
+ 'testName' => 'testFunctionwithArray-$param',
+ 'validOwners' => [\T_FUNCTION, \T_CLOSURE],
+ 'expected' => -4,
],
'testFunctionwithArray-$param-if-elseif-else' => [
- 'testFunctionwithArray-$param',
- [\T_IF, \T_ELSEIF, \T_ELSE],
- false,
+ 'testName' => 'testFunctionwithArray-$param',
+ 'validOwners' => [\T_IF, \T_ELSEIF, \T_ELSE],
+ 'expected' => false,
],
'testAnonClass-implements-anon-class' => [
- 'testAnonClass-implements',
- [\T_ANON_CLASS],
- -8,
+ 'testName' => 'testAnonClass-implements',
+ 'validOwners' => [\T_ANON_CLASS],
+ 'expected' => -8,
],
'testAnonClass-$e-function' => [
- 'testAnonClass-$e',
- [\T_FUNCTION],
- false,
+ 'testName' => 'testAnonClass-$e',
+ 'validOwners' => [\T_FUNCTION],
+ 'expected' => false,
],
'testArrowFunction-$param' => [
- 'testArrowFunction-$param',
- $arrowFunctionOwners,
- -2,
+ 'testName' => 'testArrowFunction-$param',
+ 'validOwners' => [\T_FN],
+ 'expected' => -2,
],
'testAnonClass-$e-catch' => [
- 'testAnonClass-$e',
- [\T_CATCH],
- -5,
+ 'testName' => 'testAnonClass-$e',
+ 'validOwners' => [\T_CATCH],
+ 'expected' => -5,
+ ],
+ 'testArrowFunctionReturnByRef' => [
+ 'testName' => 'testArrowFunctionReturnByRef',
+ 'validOwners' => [\T_FN],
+ 'expected' => -4,
+ ],
+ 'testIfEmpty-$c-unset' => [
+ 'testName' => 'testIfEmpty-$c',
+ 'validOwners' => [\T_UNSET],
+ 'expected' => false,
+ ],
+ 'testIfEmpty-$c-isset-empty' => [
+ 'testName' => 'testIfEmpty-$c',
+ 'validOwners' => [\T_ISSET, \T_EMPTY],
+ 'expected' => -3,
],
];
}
diff --git a/Tests/Utils/PassedParameters/GetParameterCountTest.inc b/Tests/Utils/PassedParameters/GetParameterCountTest.inc
index 63c66a72..490a579e 100644
--- a/Tests/Utils/PassedParameters/GetParameterCountTest.inc
+++ b/Tests/Utils/PassedParameters/GetParameterCountTest.inc
@@ -150,6 +150,22 @@ json_encode(['a' => $a, 'b' => $b, 'c' => $c]);
/* testFunctionCall47 */
json_encode(['a' => $a, 'b' => $b, 'c' => $c,] + ['c' => $c, 'd' => $d,]);
+/* testFunctionCallFullyQualified */
+\myfunction( $a );
+
+/* testFunctionCallFullyQualifiedWithNamespace */
+\My\Named\myfunction( $a );
+
+/* testFunctionCallPartiallyQualified */
+Partially\Qualified\myfunction( $a );
+
+/* testFunctionCallNamespaceOperator */
+namespace\myfunction( $a );
+
+/* testFunctionCallNamedParamsDuplicateName */
+// Error Exception, but not the concern of PHPCSUtils. Should still be handled.
+test(param: 1, param: 2);
+
/* testLongArray1 */
$foo = array( 1, 2, 3, 4, 5, 6, true );
@@ -198,6 +214,11 @@ $bar = ['a' => $a, 'b' => $b, 'c' => (isset($c) ? $c : null)];
/* testShortArray8 */
$bar = [0 => $a, 2 => $b, 6 => (isset($c) ? $c : null)];
+/* testAnonClass */
+$anon = new class( $param1, $param2 ) {
+ public function __construct($param1, $param2) {}
+};
+
/* testArrayWithEmptyItem */
// Intentional parse error.
$bar = [0 => $a,, 2 => $b];
diff --git a/Tests/Utils/PassedParameters/GetParameterCountTest.php b/Tests/Utils/PassedParameters/GetParameterCountTest.php
index 82d57ed2..49d85db4 100644
--- a/Tests/Utils/PassedParameters/GetParameterCountTest.php
+++ b/Tests/Utils/PassedParameters/GetParameterCountTest.php
@@ -11,6 +11,7 @@
namespace PHPCSUtils\Tests\Utils\PassedParameters;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
use PHPCSUtils\Utils\PassedParameters;
/**
@@ -24,7 +25,7 @@
*
* @since 1.0.0
*/
-class GetParameterCountTest extends UtilityMethodTestCase
+final class GetParameterCountTest extends UtilityMethodTestCase
{
/**
@@ -32,17 +33,22 @@ class GetParameterCountTest extends UtilityMethodTestCase
*
* @dataProvider dataGetParameterCount
*
- * @param string $testMarker The comment which prefaces the target token in the test file.
- * @param int $expected The expected parameter count.
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param int $expected The expected parameter count.
+ * @param string $targetContent Optional. The content of the target token to find.
+ * Defaults to null (ignore content).
*
* @return void
*/
- public function testGetParameterCount($testMarker, $expected)
+ public function testGetParameterCount($testMarker, $expected, $targetContent = null)
{
- $stackPtr = $this->getTargetToken(
- $testMarker,
- [\T_STRING, \T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_ISSET, \T_UNSET]
- );
+ $targetTypes = Collections::nameTokens();
+ $targetTypes[\T_ARRAY] = \T_ARRAY;
+ $targetTypes[\T_OPEN_SHORT_ARRAY] = \T_OPEN_SHORT_ARRAY;
+ $targetTypes[\T_ISSET] = \T_ISSET;
+ $targetTypes[\T_UNSET] = \T_UNSET;
+
+ $stackPtr = $this->getTargetToken($testMarker, $targetTypes, $targetContent);
$result = PassedParameters::getParameterCount(self::$phpcsFile, $stackPtr);
$this->assertSame($expected, $result);
}
@@ -56,271 +62,302 @@ public function testGetParameterCount($testMarker, $expected)
*/
public function dataGetParameterCount()
{
+ $php8Names = parent::usesPhp8NameTokens();
+
return [
'function-call-0' => [
- '/* testFunctionCall0 */',
- 0,
+ 'testMarker' => '/* testFunctionCall0 */',
+ 'expected' => 0,
],
'function-call-1' => [
- '/* testFunctionCall1 */',
- 1,
+ 'testMarker' => '/* testFunctionCall1 */',
+ 'expected' => 1,
],
'function-call-2' => [
- '/* testFunctionCall2 */',
- 2,
+ 'testMarker' => '/* testFunctionCall2 */',
+ 'expected' => 2,
],
'function-call-3' => [
- '/* testFunctionCall3 */',
- 3,
+ 'testMarker' => '/* testFunctionCall3 */',
+ 'expected' => 3,
],
'function-call-4' => [
- '/* testFunctionCall4 */',
- 4,
+ 'testMarker' => '/* testFunctionCall4 */',
+ 'expected' => 4,
],
'function-call-5' => [
- '/* testFunctionCall5 */',
- 5,
+ 'testMarker' => '/* testFunctionCall5 */',
+ 'expected' => 5,
],
'function-call-6' => [
- '/* testFunctionCall6 */',
- 6,
+ 'testMarker' => '/* testFunctionCall6 */',
+ 'expected' => 6,
],
'function-call-7' => [
- '/* testFunctionCall7 */',
- 7,
+ 'testMarker' => '/* testFunctionCall7 */',
+ 'expected' => 7,
],
'function-call-8' => [
- '/* testFunctionCall8 */',
- 1,
+ 'testMarker' => '/* testFunctionCall8 */',
+ 'expected' => 1,
],
'function-call-9' => [
- '/* testFunctionCall9 */',
- 1,
+ 'testMarker' => '/* testFunctionCall9 */',
+ 'expected' => 1,
],
'function-call-10' => [
- '/* testFunctionCall10 */',
- 1,
+ 'testMarker' => '/* testFunctionCall10 */',
+ 'expected' => 1,
],
'function-call-11' => [
- '/* testFunctionCall11 */',
- 2,
+ 'testMarker' => '/* testFunctionCall11 */',
+ 'expected' => 2,
],
'function-call-12' => [
- '/* testFunctionCall12 */',
- 1,
+ 'testMarker' => '/* testFunctionCall12 */',
+ 'expected' => 1,
],
'function-call-13' => [
- '/* testFunctionCall13 */',
- 1,
+ 'testMarker' => '/* testFunctionCall13 */',
+ 'expected' => 1,
],
'function-call-14' => [
- '/* testFunctionCall14 */',
- 1,
+ 'testMarker' => '/* testFunctionCall14 */',
+ 'expected' => 1,
],
'function-call-15' => [
- '/* testFunctionCall15 */',
- 2,
+ 'testMarker' => '/* testFunctionCall15 */',
+ 'expected' => 2,
],
'function-call-16' => [
- '/* testFunctionCall16 */',
- 6,
+ 'testMarker' => '/* testFunctionCall16 */',
+ 'expected' => 6,
],
'function-call-17' => [
- '/* testFunctionCall17 */',
- 6,
+ 'testMarker' => '/* testFunctionCall17 */',
+ 'expected' => 6,
],
'function-call-18' => [
- '/* testFunctionCall18 */',
- 6,
+ 'testMarker' => '/* testFunctionCall18 */',
+ 'expected' => 6,
],
'function-call-19' => [
- '/* testFunctionCall19 */',
- 6,
+ 'testMarker' => '/* testFunctionCall19 */',
+ 'expected' => 6,
],
'function-call-20' => [
- '/* testFunctionCall20 */',
- 6,
+ 'testMarker' => '/* testFunctionCall20 */',
+ 'expected' => 6,
],
'function-call-21' => [
- '/* testFunctionCall21 */',
- 6,
+ 'testMarker' => '/* testFunctionCall21 */',
+ 'expected' => 6,
],
'function-call-22' => [
- '/* testFunctionCall22 */',
- 6,
+ 'testMarker' => '/* testFunctionCall22 */',
+ 'expected' => 6,
],
'function-call-23' => [
- '/* testFunctionCall23 */',
- 3,
+ 'testMarker' => '/* testFunctionCall23 */',
+ 'expected' => 3,
],
'function-call-24' => [
- '/* testFunctionCall24 */',
- 1,
+ 'testMarker' => '/* testFunctionCall24 */',
+ 'expected' => 1,
],
'function-call-25' => [
- '/* testFunctionCall25 */',
- 1,
+ 'testMarker' => '/* testFunctionCall25 */',
+ 'expected' => 1,
],
'function-call-26' => [
- '/* testFunctionCall26 */',
- 1,
+ 'testMarker' => '/* testFunctionCall26 */',
+ 'expected' => 1,
],
'function-call-27' => [
- '/* testFunctionCall27 */',
- 1,
+ 'testMarker' => '/* testFunctionCall27 */',
+ 'expected' => 1,
],
'function-call-28' => [
- '/* testFunctionCall28 */',
- 1,
+ 'testMarker' => '/* testFunctionCall28 */',
+ 'expected' => 1,
],
'function-call-29' => [
- '/* testFunctionCall29 */',
- 1,
+ 'testMarker' => '/* testFunctionCall29 */',
+ 'expected' => 1,
],
'function-call-30' => [
- '/* testFunctionCall30 */',
- 1,
+ 'testMarker' => '/* testFunctionCall30 */',
+ 'expected' => 1,
],
'function-call-31' => [
- '/* testFunctionCall31 */',
- 1,
+ 'testMarker' => '/* testFunctionCall31 */',
+ 'expected' => 1,
],
'function-call-32' => [
- '/* testFunctionCall32 */',
- 1,
+ 'testMarker' => '/* testFunctionCall32 */',
+ 'expected' => 1,
],
'function-call-33' => [
- '/* testFunctionCall33 */',
- 1,
+ 'testMarker' => '/* testFunctionCall33 */',
+ 'expected' => 1,
],
'function-call-34' => [
- '/* testFunctionCall34 */',
- 1,
+ 'testMarker' => '/* testFunctionCall34 */',
+ 'expected' => 1,
],
'function-call-35' => [
- '/* testFunctionCall35 */',
- 1,
+ 'testMarker' => '/* testFunctionCall35 */',
+ 'expected' => 1,
],
'function-call-36' => [
- '/* testFunctionCall36 */',
- 1,
+ 'testMarker' => '/* testFunctionCall36 */',
+ 'expected' => 1,
],
'function-call-37' => [
- '/* testFunctionCall37 */',
- 1,
+ 'testMarker' => '/* testFunctionCall37 */',
+ 'expected' => 1,
],
'function-call-38' => [
- '/* testFunctionCall38 */',
- 1,
+ 'testMarker' => '/* testFunctionCall38 */',
+ 'expected' => 1,
],
'function-call-39' => [
- '/* testFunctionCall39 */',
- 1,
+ 'testMarker' => '/* testFunctionCall39 */',
+ 'expected' => 1,
],
'function-call-40' => [
- '/* testFunctionCall40 */',
- 1,
+ 'testMarker' => '/* testFunctionCall40 */',
+ 'expected' => 1,
],
'function-call-41' => [
- '/* testFunctionCall41 */',
- 1,
+ 'testMarker' => '/* testFunctionCall41 */',
+ 'expected' => 1,
],
'function-call-42' => [
- '/* testFunctionCall42 */',
- 1,
+ 'testMarker' => '/* testFunctionCall42 */',
+ 'expected' => 1,
],
'function-call-43' => [
- '/* testFunctionCall43 */',
- 1,
+ 'testMarker' => '/* testFunctionCall43 */',
+ 'expected' => 1,
],
'function-call-44' => [
- '/* testFunctionCall44 */',
- 1,
+ 'testMarker' => '/* testFunctionCall44 */',
+ 'expected' => 1,
],
'function-call-45' => [
- '/* testFunctionCall45 */',
- 1,
+ 'testMarker' => '/* testFunctionCall45 */',
+ 'expected' => 1,
],
'function-call-46' => [
- '/* testFunctionCall46 */',
- 1,
+ 'testMarker' => '/* testFunctionCall46 */',
+ 'expected' => 1,
],
'function-call-47' => [
- '/* testFunctionCall47 */',
- 1,
+ 'testMarker' => '/* testFunctionCall47 */',
+ 'expected' => 1,
+ ],
+ 'function-call-fully-qualified' => [
+ 'testMarker' => '/* testFunctionCallFullyQualified */',
+ 'expected' => 1,
+ 'targetContent' => ($php8Names === true) ? null : 'myfunction',
+ ],
+ 'function-call-fully-qualified-with-namespace' => [
+ 'testMarker' => '/* testFunctionCallFullyQualifiedWithNamespace */',
+ 'expected' => 1,
+ 'targetContent' => ($php8Names === true) ? null : 'myfunction',
+ ],
+ 'function-call-partially-qualified' => [
+ 'testMarker' => '/* testFunctionCallPartiallyQualified */',
+ 'expected' => 1,
+ 'targetContent' => ($php8Names === true) ? null : 'myfunction',
+ ],
+ 'function-call-namespace-operator' => [
+ 'testMarker' => '/* testFunctionCallNamespaceOperator */',
+ 'expected' => 1,
+ 'targetContent' => ($php8Names === true) ? null : 'myfunction',
+ ],
+ 'function-call-named-params-duplicate-name' => [
+ 'testMarker' => '/* testFunctionCallNamedParamsDuplicateName */',
+ 'expected' => 2,
],
// Long arrays.
'long-array-1' => [
- '/* testLongArray1 */',
- 7,
+ 'testMarker' => '/* testLongArray1 */',
+ 'expected' => 7,
],
'long-array-2' => [
- '/* testLongArray2 */',
- 1,
+ 'testMarker' => '/* testLongArray2 */',
+ 'expected' => 1,
],
'long-array-3' => [
- '/* testLongArray3 */',
- 6,
+ 'testMarker' => '/* testLongArray3 */',
+ 'expected' => 6,
],
'long-array-4' => [
- '/* testLongArray4 */',
- 6,
+ 'testMarker' => '/* testLongArray4 */',
+ 'expected' => 6,
],
'long-array-5' => [
- '/* testLongArray5 */',
- 6,
+ 'testMarker' => '/* testLongArray5 */',
+ 'expected' => 6,
],
'long-array-6' => [
- '/* testLongArray6 */',
- 3,
+ 'testMarker' => '/* testLongArray6 */',
+ 'expected' => 3,
],
'long-array-7' => [
- '/* testLongArray7 */',
- 3,
+ 'testMarker' => '/* testLongArray7 */',
+ 'expected' => 3,
],
'long-array-8' => [
- '/* testLongArray8 */',
- 3,
+ 'testMarker' => '/* testLongArray8 */',
+ 'expected' => 3,
],
// Short arrays.
'short-array-1' => [
- '/* testShortArray1 */',
- 7,
+ 'testMarker' => '/* testShortArray1 */',
+ 'expected' => 7,
],
'short-array-2' => [
- '/* testShortArray2 */',
- 1,
+ 'testMarker' => '/* testShortArray2 */',
+ 'expected' => 1,
],
'short-array-3' => [
- '/* testShortArray3 */',
- 6,
+ 'testMarker' => '/* testShortArray3 */',
+ 'expected' => 6,
],
'short-array-4' => [
- '/* testShortArray4 */',
- 6,
+ 'testMarker' => '/* testShortArray4 */',
+ 'expected' => 6,
],
'short-array-5' => [
- '/* testShortArray5 */',
- 6,
+ 'testMarker' => '/* testShortArray5 */',
+ 'expected' => 6,
],
'short-array-6' => [
- '/* testShortArray6 */',
- 3,
+ 'testMarker' => '/* testShortArray6 */',
+ 'expected' => 3,
],
'short-array-7' => [
- '/* testShortArray7 */',
- 3,
+ 'testMarker' => '/* testShortArray7 */',
+ 'expected' => 3,
],
'short-array-8' => [
- '/* testShortArray8 */',
- 3,
+ 'testMarker' => '/* testShortArray8 */',
+ 'expected' => 3,
+ ],
+
+ 'anon-class' => [
+ 'testMarker' => '/* testAnonClass */',
+ 'expected' => 2,
],
'array-with-empty-item' => [
- '/* testArrayWithEmptyItem */',
- 3,
+ 'testMarker' => '/* testArrayWithEmptyItem */',
+ 'expected' => 3,
],
];
}
diff --git a/Tests/Utils/PassedParameters/GetParameterFromStackTest.inc b/Tests/Utils/PassedParameters/GetParameterFromStackTest.inc
new file mode 100644
index 00000000..a7587ab3
--- /dev/null
+++ b/Tests/Utils/PassedParameters/GetParameterFromStackTest.inc
@@ -0,0 +1,63 @@
+getTargetToken('/* testNoParams */', \T_STRING);
+
+ $result = PassedParameters::getParameter(self::$phpcsFile, $stackPtr, 2, 'value');
+ $this->assertFalse($result);
+ }
+
+ /**
+ * Test retrieving the parameter details from a non-function call without passing a valid name
+ * to make sure that no exception is thrown for the missing parameter name.
+ *
+ * @dataProvider dataGetParameterNonFunctionCallNoParamName
+ *
+ * @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.
+ *
+ * @return void
+ */
+ public function testGetParameterNonFunctionCallNoParamName($testMarker, $targetType)
+ {
+ $stackPtr = $this->getTargetToken($testMarker, $targetType);
+ $expected = [
+ 'start' => ($stackPtr + 5),
+ 'end' => ($stackPtr + 6),
+ 'raw' => '$var2',
+ 'clean' => '$var2',
+ ];
+
+ $result = PassedParameters::getParameter(self::$phpcsFile, $stackPtr, 2);
+ $this->assertSame($expected, $result);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testGetParameterNonFunctionCallNoParamName() For the array format.
+ *
+ * @return array
+ */
+ public function dataGetParameterNonFunctionCallNoParamName()
+ {
+ return [
+ 'isset' => [
+ 'testMarker' => '/* testIsset */',
+ 'targetType' => \T_ISSET,
+ ],
+ 'array' => [
+ 'testMarker' => '/* testArray */',
+ 'targetType' => \T_ARRAY,
+ ],
+ ];
+ }
+
+ /**
+ * Test retrieving the parameter details from a function call with only positional parameters
+ * without passing a valid name to make sure no exception is thrown.
+ *
+ * @return void
+ */
+ public function testGetParameterFunctionCallPositionalNoParamName()
+ {
+ $stackPtr = $this->getTargetToken('/* testAllParamsPositional */', \T_STRING);
+ $expected = [
+ 'start' => ($stackPtr + 5),
+ 'end' => ($stackPtr + 6),
+ 'raw' => "'value'",
+ 'clean' => "'value'",
+ ];
+
+ $result = PassedParameters::getParameter(self::$phpcsFile, $stackPtr, 2);
+ $this->assertSame($expected, $result);
+ }
+
+ /**
+ * Test receiving an expected exception when trying to retrieve the parameter details
+ * from a function call with only named parameters without passing a valid name.
+ *
+ * @return void
+ */
+ public function testGetParameterFunctionCallMissingParamName()
+ {
+ $this->expectPhpcsException(
+ 'To allow for support for PHP 8 named parameters, the $paramNames parameter must be passed.'
+ );
+
+ $stackPtr = $this->getTargetToken('/* testAllParamsNamedStandardOrder */', \T_STRING);
+
+ PassedParameters::getParameter(self::$phpcsFile, $stackPtr, 2);
+ }
+
+ /**
+ * Test receiving an expected exception when trying to retrieve the parameter details
+ * from a function call with only positional parameters without passing a valid name with
+ * the requested parameter offset not being set.
+ *
+ * @return void
+ */
+ public function testGetParameterFunctionCallPositionalMissingParamNameNonExistentParam()
+ {
+ $this->expectPhpcsException(
+ 'To allow for support for PHP 8 named parameters, the $paramNames parameter must be passed.'
+ );
+
+ $stackPtr = $this->getTargetToken('/* testAllParamsPositional */', \T_STRING);
+
+ PassedParameters::getParameter(self::$phpcsFile, $stackPtr, 10);
+ }
+
+ /**
+ * Verify that the $limit parameter used with `PassedParameters::getParameters()` from within the
+ * `PassedParameters::getParameter()` function call does not interfer with the handling of named parameters.
+ *
+ * @dataProvider dataGetParameterFunctionCallWithParamName
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param array $expected The expected function output.
+ *
+ * @return void
+ */
+ public function testGetParameterFunctionCallWithParamName($testMarker, $expected)
+ {
+ $stackPtr = $this->getTargetToken($testMarker, \T_STRING);
+
+ $expected['start'] += $stackPtr;
+ $expected['end'] += $stackPtr;
+ if (isset($expected['name_token'])) {
+ $expected['name_token'] += $stackPtr;
+ }
+ $expected['clean'] = $expected['raw'];
+
+ $result = PassedParameters::getParameter(self::$phpcsFile, $stackPtr, 2, 'value');
+ $this->assertSame($expected, $result);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testGetParameterFunctionCallWithParamName() For the array format.
+ *
+ * @return array
+ */
+ public function dataGetParameterFunctionCallWithParamName()
+ {
+ return [
+ 'all-named-non-standard-order' => [
+ 'testMarker' => '/* testAllParamsNamedNonStandardOrder */',
+ 'expected' => [
+ 'name' => 'value',
+ 'name_token' => 48,
+ 'start' => 50,
+ 'end' => 51,
+ 'raw' => "'value'",
+ ],
+ ],
+ 'mixed-positional-and-named-target-non-named' => [
+ 'testMarker' => '/* testMixedPositionalAndNamedParams */',
+ 'expected' => [
+ 'start' => 6,
+ 'end' => 8,
+ 'raw' => "'value'",
+ ],
+ ],
+ ];
+ }
+
+ /**
+ * Test retrieving the details for a specific parameter from a function call or construct.
+ *
+ * @dataProvider dataGetParameterFromStack
+ *
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param array $expectedName The expected result array for the $name parameter.
+ * @param array|false $expectedExpires The expected result array for the $expires_or_options parameter.
+ * @param array|false $expectedHttpOnly The expected result array for the $httponly parameter.
+ *
+ * @return void
+ */
+ public function testGetParameterFromStack($testMarker, $expectedName, $expectedExpires, $expectedHttpOnly)
+ {
+ $stackPtr = $this->getTargetToken($testMarker, \T_STRING);
+ $parameters = PassedParameters::getParameters(self::$phpcsFile, $stackPtr);
+
+ /*
+ * Test $name parameter. Param name passed as string.
+ */
+ $expected = false;
+ if ($expectedName !== false) {
+ // 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.
+ $expected = $expectedName;
+ $expected['start'] += $stackPtr;
+ $expected['end'] += $stackPtr;
+ if (isset($expected['name_token'])) {
+ $expected['name_token'] += $stackPtr;
+ }
+ $expected['clean'] = $expected['raw'];
+ }
+
+ $result = PassedParameters::getParameterFromStack($parameters, 1, 'name');
+ $this->assertSame($expected, $result, 'Expected output for parameter 1 ("name") did not match');
+
+ /*
+ * Test $expires_or_options parameter. Param name passed as array with alternative names.
+ */
+ $expected = false;
+ if ($expectedExpires !== false) {
+ // 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.
+ $expected = $expectedExpires;
+ $expected['start'] += $stackPtr;
+ $expected['end'] += $stackPtr;
+ if (isset($expected['name_token'])) {
+ $expected['name_token'] += $stackPtr;
+ }
+ $expected['clean'] = $expected['raw'];
+ }
+
+ $result = PassedParameters::getParameterFromStack($parameters, 3, ['expires_or_options', 'expires', 'options']);
+ $this->assertSame($expected, $result, 'Expected output for parameter 3 ("expires_or_options") did not match');
+
+ /*
+ * Test $httponly parameter. Param name passed as array.
+ */
+ $expected = false;
+ if ($expectedHttpOnly !== false) {
+ // 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.
+ $expected = $expectedHttpOnly;
+ $expected['start'] += $stackPtr;
+ $expected['end'] += $stackPtr;
+ if (isset($expected['name_token'])) {
+ $expected['name_token'] += $stackPtr;
+ }
+ $expected['clean'] = $expected['raw'];
+ }
+
+ $result = PassedParameters::getParameterFromStack($parameters, 7, ['httponly']);
+ $this->assertSame($expected, $result, 'Expected output for parameter 7 ("httponly") did not match');
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testGetParameterFromStack() For the array format.
+ *
+ * @return array
+ */
+ public function dataGetParameterFromStack()
+ {
+ return [
+ 'all-params-all-positional' => [
+ 'testMarker' => '/* testAllParamsPositional */',
+ 'expectedName' => [
+ 'start' => 2,
+ 'end' => 3,
+ 'raw' => "'name'",
+ ],
+ 'expectedExpires' => [
+ 'start' => 8,
+ 'end' => 25,
+ 'raw' => 'time() + (60 * 60 * 24)',
+ ],
+ 'expectedHttpOnly' => [
+ 'start' => 36,
+ 'end' => 38,
+ 'raw' => 'false',
+ ],
+ ],
+ 'all-params-all-named-standard-order' => [
+ 'testMarker' => '/* testAllParamsNamedStandardOrder */',
+ 'expectedName' => [
+ 'name' => 'name',
+ 'name_token' => 4,
+ 'start' => 6,
+ 'end' => 7,
+ 'raw' => "'name'",
+ ],
+ 'expectedExpires' => [
+ 'name' => 'expires_or_options',
+ 'name_token' => 18,
+ 'start' => 20,
+ 'end' => 37,
+ 'raw' => 'time() + (60 * 60 * 24)',
+ ],
+ 'expectedHttpOnly' => [
+ 'name' => 'httponly',
+ 'name_token' => 62,
+ 'start' => 64,
+ 'end' => 66,
+ 'raw' => 'false',
+ ],
+ ],
+ 'all-params-all-named-random-order' => [
+ 'testMarker' => '/* testAllParamsNamedNonStandardOrder */',
+ 'expectedName' => [
+ 'name' => 'name',
+ 'name_token' => 34,
+ 'start' => 36,
+ 'end' => 37,
+ 'raw' => "'name'",
+ ],
+ 'expectedExpires' => [
+ 'name' => 'expires_or_options',
+ 'name_token' => 4,
+ 'start' => 6,
+ 'end' => 23,
+ 'raw' => 'time() + (60 * 60 * 24)',
+ ],
+ 'expectedHttpOnly' => [
+ 'name' => 'httponly',
+ 'name_token' => 55,
+ 'start' => 57,
+ 'end' => 58,
+ 'raw' => 'false',
+ ],
+ ],
+ 'all-params-mixed-positional-and-named' => [
+ 'testMarker' => '/* testMixedPositionalAndNamedParams */',
+ 'expectedName' => [
+ 'start' => 2,
+ 'end' => 4,
+ 'raw' => "'name'",
+ ],
+ 'expectedExpires' => [
+ 'start' => 10,
+ 'end' => 28,
+ 'raw' => 'time() + (60 * 60 * 24)',
+ ],
+ 'expectedHttpOnly' => [
+ 'name' => 'httponly',
+ 'name_token' => 46,
+ 'start' => 48,
+ 'end' => 49,
+ 'raw' => 'false',
+ ],
+ ],
+ 'select-params-mixed-positional-and-named' => [
+ 'testMarker' => '/* testMixedPositionalAndNamedParamsNotAllOptionalSet */',
+ 'expectedName' => [
+ 'start' => 2,
+ 'end' => 4,
+ 'raw' => "'name'",
+ ],
+ 'expectedExpires' => [
+ 'name' => 'expires_or_options',
+ 'name_token' => 8,
+ 'start' => 10,
+ 'end' => 27,
+ 'raw' => 'time() + (60 * 60 * 24)',
+ ],
+ 'expectedHttpOnly' => false,
+ ],
+ 'select-params-mixed-positional-and-named-old-name' => [
+ 'testMarker' => '/* testMixedPositionalAndNamedParamsOldName */',
+ 'expectedName' => [
+ 'start' => 2,
+ 'end' => 4,
+ 'raw' => "'name'",
+ ],
+ 'expectedExpires' => [
+ 'name' => 'expires',
+ 'name_token' => 8,
+ 'start' => 10,
+ 'end' => 27,
+ 'raw' => 'time() + (60 * 60 * 24)',
+ ],
+ 'expectedHttpOnly' => false,
+ ],
+ ];
+ }
+
+ /**
+ * Test retrieving the parameter details from a function call with a named parameter after a variadic one.
+ *
+ * This is supported since PHP 8.1.
+ *
+ * @dataProvider dataGetParameterFromStackNamedAfterVariadic
+ *
+ * @param string $offset The positional offfset to pass.
+ * @param array $names The parameter names to pass.
+ * @param array|false $expected The expected result array for the parameter.
+ *
+ * @return void
+ */
+ public function testGetParameterFromStackNamedAfterVariadic($offset, $names, $expected)
+ {
+ $stackPtr = $this->getTargetToken('/* testPHP81NamedParamAfterVariadic */', \T_STRING);
+
+ if ($expected !== false) {
+ // 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.
+ $expected['start'] += $stackPtr;
+ $expected['end'] += $stackPtr;
+ if (isset($expected['name_token'])) {
+ $expected['name_token'] += $stackPtr;
+ }
+ $expected['clean'] = $expected['raw'];
+ }
+
+ $parameters = PassedParameters::getParameters(self::$phpcsFile, $stackPtr);
+ $result = PassedParameters::getParameterFromStack($parameters, $offset, $names);
+
+ $this->assertSame($expected, $result);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testGetParameterFromStackNamedAfterVariadic() For the array format.
+ *
+ * @return array
+ */
+ public function dataGetParameterFromStackNamedAfterVariadic()
+ {
+ return [
+ 'first param, positional' => [
+ 'offset' => 1,
+ 'names' => ['none'],
+ 'expected' => [
+ 'start' => 2,
+ 'end' => 2,
+ 'raw' => '$positional',
+ ],
+ ],
+ 'second param, positional, variadic' => [
+ 'offset' => 2,
+ 'names' => ['none'],
+ 'expected' => [
+ 'start' => 4,
+ 'end' => 6,
+ 'raw' => '...$variadic',
+ ],
+ ],
+ 'named param "namedA"' => [
+ 'offset' => 5,
+ 'names' => ['alternative', 'namedA'],
+ 'expected' => [
+ 'name' => 'namedA',
+ 'name_token' => 9,
+ 'start' => 11,
+ 'end' => 12,
+ 'raw' => '$valueA',
+ ],
+ ],
+ 'named param "namedB"' => [
+ // Position intentionally set to 2 to collide with the variadic param (which may contain named params).
+ 'offset' => 2,
+ 'names' => ['namedB'],
+ 'expected' => [
+ 'name' => 'namedB',
+ 'name_token' => 15,
+ 'start' => 17,
+ 'end' => 18,
+ 'raw' => '$valueB',
+ ],
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/PassedParameters/GetParametersNamedTest.inc b/Tests/Utils/PassedParameters/GetParametersNamedTest.inc
new file mode 100644
index 00000000..61cb163a
--- /dev/null
+++ b/Tests/Utils/PassedParameters/GetParametersNamedTest.inc
@@ -0,0 +1,92 @@
+getPos(skip: false),
+ count: /* testNestedFunctionCallInner2 */ count(array_or_countable: $array),
+ value: 50
+);
+
+/* testNamespacedFQNFunction */
+\Fully\Qualified\function_name(label: $string, more:false);
+
+/* testVariableFunction */
+$fn(label: $string, more:false);
+
+/* testClassInstantiationStatic */
+$obj = new static(label: $string, more:false);
+
+/* testAnonClass */
+$anon = new class(label: $string, more: false) {
+ public function __construct($label, $more) {}
+};
+
+function myfoo( $💩💩💩, $Пасха, $_valid) {}
+/* testNonAsciiNames */
+foo(💩💩💩: [], Пасха: 'text', _valid: 123);
+
+/* testMixedPositionalAndNamedArgsWithTernary */
+foo( $cond ? true : false, name: $value2 );
+
+/* testNamedArgWithTernary */
+foo( label: $cond ? true : false, more: $cond ? CONSTANT_A : CONSTANT_B );
+
+/* testTernaryWithFunctionCallsInThenElse */
+echo $cond ? foo( label: $something ) : /* testTernaryWithFunctionCallsInElse */ bar( more: $something_else );
+
+/* testCompileErrorNamedBeforePositional */
+// Not the concern of PHPCSUtils. Should still be handled.
+test(param: $bar, $foo);
+
+/* testDuplicateName */
+// Error Exception, but not the concern of PHPCSUtils. Should still be handled.
+test(param: 1, param: 2);
+
+/* testIncorrectOrderWithVariadic */
+// Error Exception, but not the concern of PHPCSUtils. Should still be handled.
+array_fill(start_index: 0, ...[100, 50]);
+
+/* testPHP81NamedParamAfterVariadic */
+// Prior to PHP 8.1, this was a compile error, but this is now supported.
+test(...$values, param: $value);
+
+/* testParseErrorNoValue */
+// Not the concern of PHPCSUtils. Should still be handled (but currently isn't).
+//test(param1:, param2:);
+
+/* testParseErrorDynamicName */
+// Parse error. Ignore.
+function_name($variableStoringParamName: $value);
+
+/* testReservedKeywordAsName */
+// Note: do not remove any of these - some are testing very specific cross-version tokenizer issues.
+foobar(
+ abstract: $value,
+ class: $value,
+ const: $value,
+ function: $value,
+ iterable: $value,
+ match: $value,
+ protected: $value,
+ object: $value,
+ parent: $value,
+);
diff --git a/Tests/Utils/PassedParameters/GetParametersNamedTest.php b/Tests/Utils/PassedParameters/GetParametersNamedTest.php
new file mode 100644
index 00000000..75c446dc
--- /dev/null
+++ b/Tests/Utils/PassedParameters/GetParametersNamedTest.php
@@ -0,0 +1,587 @@
+getTargetToken($testMarker, [$targetType], $targetContent);
+
+ // 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;
+ $expected[$key]['end'] += $stackPtr;
+
+ if (isset($value['name_token'])) {
+ $expected[$key]['name_token'] += $stackPtr;
+ }
+ }
+
+ $result = PassedParameters::getParameters(self::$phpcsFile, $stackPtr);
+
+ foreach ($result as $key => $value) {
+ $this->assertArrayHasKey('clean', $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 testGetParameters() For the array format.
+ *
+ * @return array
+ */
+ public function dataGetParameters()
+ {
+ $php8Names = parent::usesPhp8NameTokens();
+
+ return [
+ 'only-positional-args' => [
+ 'testMarker' => '/* testPositionalArgs */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 1 => [
+ 'start' => 2,
+ 'end' => 2,
+ 'raw' => 'START_INDEX',
+ ],
+ 2 => [
+ 'start' => 4,
+ 'end' => ($php8Names === true) ? 5 : 6,
+ 'raw' => '\COUNT',
+ ],
+ 3 => [
+ 'start' => ($php8Names === true) ? 7 : 8,
+ 'end' => ($php8Names === true) ? 8 : 11,
+ 'raw' => 'MyNS\VALUE',
+ ],
+ ],
+ ],
+ 'named-args' => [
+ 'testMarker' => '/* testNamedArgs */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'start_index' => [
+ 'name' => 'start_index',
+ 'name_token' => 2,
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => '0',
+ ],
+ 'count' => [
+ 'name' => 'count',
+ 'name_token' => 8,
+ 'start' => 10,
+ 'end' => 11,
+ 'raw' => '100',
+ ],
+ 'value' => [
+ 'name' => 'value',
+ 'name_token' => 14,
+ 'start' => 16,
+ 'end' => 17,
+ 'raw' => '50',
+ ],
+ ],
+ ],
+ 'named-args-multiline' => [
+ 'testMarker' => '/* testNamedArgsMultiline */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'start_index' => [
+ 'name' => 'start_index',
+ 'name_token' => 4,
+ 'start' => 7,
+ 'end' => 8,
+ 'raw' => '0',
+ ],
+ 'count' => [
+ 'name' => 'count',
+ 'name_token' => 12,
+ 'start' => 15,
+ 'end' => 16,
+ 'raw' => '100',
+ ],
+ 'value' => [
+ 'name' => 'value',
+ 'name_token' => 20,
+ 'start' => 23,
+ 'end' => 24,
+ 'raw' => '50',
+ ],
+ ],
+ ],
+ 'named-args-whitespace-comments' => [
+ 'testMarker' => '/* testNamedArgsWithWhitespaceAndComments */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'start_index' => [
+ 'name' => 'start_index',
+ 'name_token' => 4,
+ 'start' => 7,
+ 'end' => 8,
+ 'raw' => '0',
+ ],
+ 'count' => [
+ 'name' => 'count',
+ 'name_token' => 13,
+ 'start' => 18,
+ 'end' => 19,
+ 'raw' => '100',
+ ],
+ 'value' => [
+ 'name' => 'value',
+ 'name_token' => 22,
+ 'start' => 24,
+ 'end' => 25,
+ 'raw' => '50',
+ ],
+ ],
+ ],
+ 'mixed-positional-and-named-args' => [
+ 'testMarker' => '/* testMixedPositionalAndNamedArgs */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 1 => [
+ 'start' => 2,
+ 'end' => 2,
+ 'raw' => '$string',
+ ],
+ 'double_encode' => [
+ 'name' => 'double_encode',
+ 'name_token' => 5,
+ 'start' => 7,
+ 'end' => 8,
+ 'raw' => 'false',
+ ],
+ ],
+ ],
+ 'named-args-nested-function-call-outer' => [
+ 'testMarker' => '/* testNestedFunctionCallOuter */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'start_index' => [
+ 'name' => 'start_index',
+ 'name_token' => 4,
+ 'start' => 6,
+ 'end' => 17,
+ 'raw' => '/* testNestedFunctionCallInner1 */ $obj->getPos(skip: false)',
+ ],
+ 'count' => [
+ 'name' => 'count',
+ 'name_token' => 21,
+ 'start' => 23,
+ 'end' => 32,
+ 'raw' => '/* testNestedFunctionCallInner2 */ count(array_or_countable: $array)',
+ ],
+ 'value' => [
+ 'name' => 'value',
+ 'name_token' => 36,
+ 'start' => 38,
+ 'end' => 40,
+ 'raw' => '50',
+ ],
+ ],
+ ],
+ 'named-args-nested-function-call-inner-1' => [
+ 'testMarker' => '/* testNestedFunctionCallInner1 */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'skip' => [
+ 'name' => 'skip',
+ 'name_token' => 2,
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => 'false',
+ ],
+ ],
+ ],
+ 'named-args-nested-function-call-inner-2' => [
+ 'testMarker' => '/* testNestedFunctionCallInner2 */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'array_or_countable' => [
+ 'name' => 'array_or_countable',
+ 'name_token' => 2,
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => '$array',
+ ],
+ ],
+ ],
+ 'named-args-in-fqn-function-call' => [
+ 'testMarker' => '/* testNamespacedFQNFunction */',
+ 'targetType' => ($php8Names === true) ? \T_NAME_FULLY_QUALIFIED : \T_STRING,
+ 'expected' => [
+ 'label' => [
+ 'name' => 'label',
+ 'name_token' => 2,
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => '$string',
+ ],
+ 'more' => [
+ 'name' => 'more',
+ 'name_token' => 8,
+ 'start' => 10,
+ 'end' => 10,
+ 'raw' => 'false',
+ ],
+ ],
+ 'targetContent' => ($php8Names === true) ? null : 'function_name',
+ ],
+ 'named-args-in-variable-function-call' => [
+ 'testMarker' => '/* testVariableFunction */',
+ 'targetType' => \T_VARIABLE,
+ 'expected' => [
+ 'label' => [
+ 'name' => 'label',
+ 'name_token' => 2,
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => '$string',
+ ],
+ 'more' => [
+ 'name' => 'more',
+ 'name_token' => 8,
+ 'start' => 10,
+ 'end' => 10,
+ 'raw' => 'false',
+ ],
+ ],
+ ],
+ 'named-args-in-class-instantiation-with-static' => [
+ 'testMarker' => '/* testClassInstantiationStatic */',
+ 'targetType' => \T_STATIC,
+ 'expected' => [
+ 'label' => [
+ 'name' => 'label',
+ 'name_token' => 2,
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => '$string',
+ ],
+ 'more' => [
+ 'name' => 'more',
+ 'name_token' => 8,
+ 'start' => 10,
+ 'end' => 10,
+ 'raw' => 'false',
+ ],
+ ],
+ ],
+ 'named-args-in-anon-class-instantiation' => [
+ 'testMarker' => '/* testAnonClass */',
+ 'targetType' => \T_ANON_CLASS,
+ 'expected' => [
+ 'label' => [
+ 'name' => 'label',
+ 'name_token' => 2,
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => '$string',
+ ],
+ 'more' => [
+ 'name' => 'more',
+ 'name_token' => 8,
+ 'start' => 10,
+ 'end' => 11,
+ 'raw' => 'false',
+ ],
+ ],
+ ],
+ 'named-args-non-ascii-names' => [
+ 'testMarker' => '/* testNonAsciiNames */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ '💩💩💩' => [
+ 'name' => '💩💩💩',
+ 'name_token' => 2,
+ 'start' => 4,
+ 'end' => 6,
+ 'raw' => '[]',
+ ],
+ 'Пасха' => [
+ 'name' => 'Пасха',
+ 'name_token' => 9,
+ 'start' => 11,
+ 'end' => 12,
+ 'raw' => "'text'",
+ ],
+ '_valid' => [
+ 'name' => '_valid',
+ 'name_token' => 15,
+ 'start' => 17,
+ 'end' => 18,
+ 'raw' => '123',
+ ],
+ ],
+ ],
+ 'mixed-positional-and-named-args-with-ternary' => [
+ 'testMarker' => '/* testMixedPositionalAndNamedArgsWithTernary */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 1 => [
+ 'start' => 2,
+ 'end' => 11,
+ 'raw' => '$cond ? true : false',
+ ],
+ 'name' => [
+ 'name' => 'name',
+ 'name_token' => 14,
+ 'start' => 16,
+ 'end' => 18,
+ 'raw' => '$value2',
+ ],
+ ],
+ ],
+ 'named-args-with-ternary' => [
+ 'testMarker' => '/* testNamedArgWithTernary */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'label' => [
+ 'name' => 'label',
+ 'name_token' => 3,
+ 'start' => 5,
+ 'end' => 14,
+ 'raw' => '$cond ? true : false',
+ ],
+ 'more' => [
+ 'name' => 'more',
+ 'name_token' => 17,
+ 'start' => 19,
+ 'end' => 29,
+ 'raw' => '$cond ? CONSTANT_A : CONSTANT_B',
+ ],
+ ],
+ ],
+ 'ternary-with-function-call-in-then' => [
+ 'testMarker' => '/* testTernaryWithFunctionCallsInThenElse */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'label' => [
+ 'name' => 'label',
+ 'name_token' => 3,
+ 'start' => 5,
+ 'end' => 7,
+ 'raw' => '$something',
+ ],
+ ],
+ ],
+ 'ternary-with-function-call-in-else' => [
+ 'testMarker' => '/* testTernaryWithFunctionCallsInElse */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'more' => [
+ 'name' => 'more',
+ 'name_token' => 3,
+ 'start' => 5,
+ 'end' => 7,
+ 'raw' => '$something_else',
+ ],
+ ],
+ ],
+ 'named-args-compile-error-named-before-positional' => [
+ 'testMarker' => '/* testCompileErrorNamedBeforePositional */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'param' => [
+ 'name' => 'param',
+ 'name_token' => 2,
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => '$bar',
+ ],
+ 2 => [
+ 'start' => 7,
+ 'end' => 8,
+ 'raw' => '$foo',
+ ],
+ ],
+ ],
+ 'named-args-error-exception-duplicate-name' => [
+ 'testMarker' => '/* testDuplicateName */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'param' => [
+ 'name' => 'param',
+ 'name_token' => 2,
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => '1',
+ ],
+ 2 => [
+ 'name' => 'param',
+ 'name_token' => 8,
+ 'start' => 10,
+ 'end' => 11,
+ 'raw' => '2',
+ ],
+ ],
+ ],
+ 'named-args-error-exception-incorrect-order-variadic' => [
+ 'testMarker' => '/* testIncorrectOrderWithVariadic */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'start_index' => [
+ 'name' => 'start_index',
+ 'name_token' => 2,
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => '0',
+ ],
+ 2 => [
+ 'start' => 7,
+ 'end' => 14,
+ 'raw' => '...[100, 50]',
+ ],
+ ],
+ ],
+ // Prior to PHP 8.1, this was a compile error, but this is now supported.
+ 'named-args-after-variadic' => [
+ 'testMarker' => '/* testPHP81NamedParamAfterVariadic */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 1 => [
+ 'start' => 2,
+ 'end' => 3,
+ 'raw' => '...$values',
+ ],
+ 'param' => [
+ 'name' => 'param',
+ 'name_token' => 6,
+ 'start' => 8,
+ 'end' => 9,
+ 'raw' => '$value',
+ ],
+ ],
+ ],
+ 'named-args-parse-error-dynamic-name' => [
+ 'testMarker' => '/* testParseErrorDynamicName */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 1 => [
+ 'start' => 2,
+ 'end' => 5,
+ 'raw' => '$variableStoringParamName: $value',
+ ],
+ ],
+ ],
+ 'named-args-using-reserved-keywords' => [
+ 'testMarker' => '/* testReservedKeywordAsName */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 'abstract' => [
+ 'name' => 'abstract',
+ 'name_token' => 4,
+ 'start' => 6,
+ 'end' => 7,
+ 'raw' => '$value',
+ ],
+ 'class' => [
+ 'name' => 'class',
+ 'name_token' => 11,
+ 'start' => 13,
+ 'end' => 14,
+ 'raw' => '$value',
+ ],
+ 'const' => [
+ 'name' => 'const',
+ 'name_token' => 18,
+ 'start' => 20,
+ 'end' => 21,
+ 'raw' => '$value',
+ ],
+ 'function' => [
+ 'name' => 'function',
+ 'name_token' => 25,
+ 'start' => 27,
+ 'end' => 28,
+ 'raw' => '$value',
+ ],
+ 'iterable' => [
+ 'name' => 'iterable',
+ 'name_token' => 32,
+ 'start' => 34,
+ 'end' => 35,
+ 'raw' => '$value',
+ ],
+ 'match' => [
+ 'name' => 'match',
+ 'name_token' => 39,
+ 'start' => 41,
+ 'end' => 42,
+ 'raw' => '$value',
+ ],
+ 'protected' => [
+ 'name' => 'protected',
+ 'name_token' => 46,
+ 'start' => 48,
+ 'end' => 49,
+ 'raw' => '$value',
+ ],
+ 'object' => [
+ 'name' => 'object',
+ 'name_token' => 53,
+ 'start' => 55,
+ 'end' => 56,
+ 'raw' => '$value',
+ ],
+ 'parent' => [
+ 'name' => 'parent',
+ 'name_token' => 60,
+ 'start' => 62,
+ 'end' => 63,
+ 'raw' => '$value',
+ ],
+ ],
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/PassedParameters/GetParametersSkipShortArrayCheckTest.inc b/Tests/Utils/PassedParameters/GetParametersSkipShortArrayCheckTest.inc
new file mode 100644
index 00000000..876260d4
--- /dev/null
+++ b/Tests/Utils/PassedParameters/GetParametersSkipShortArrayCheckTest.inc
@@ -0,0 +1,29 @@
+ 1, 'b' => 2 ];
+
+/* testShortList */
+[ 'a' => $a, 'b' => $b ] = $array;
+
+/* testArrayAssign */
+$array[] = 'foo';
+
+/* testArrayAccess */
+$foo = $array[$keys['key']];
+
+/* testShortListWithEmptyItemsBefore */
+[, , $a] = $array;
+
+/* testShortListWithEmptyItemsAfter */
+[$a,,] = $array;
+
+/* testShortListWithAllEmptyItems */
+// Not allowed, but not our concern.
+[,,] = $array;
diff --git a/Tests/Utils/PassedParameters/GetParametersSkipShortArrayCheckTest.php b/Tests/Utils/PassedParameters/GetParametersSkipShortArrayCheckTest.php
new file mode 100644
index 00000000..cc90aaf6
--- /dev/null
+++ b/Tests/Utils/PassedParameters/GetParametersSkipShortArrayCheckTest.php
@@ -0,0 +1,241 @@
+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) {
+ $this->assertIsBool($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);
+
+ $this->assertIsArray($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' => [
+ 'testMarker' => '/* testNoParams */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'ignore' => false,
+ 'expected' => [],
+ ],
+ 'long-array' => [
+ 'testMarker' => '/* testLongArray */',
+ 'targetType' => \T_ARRAY,
+ 'ignore' => false,
+ 'expected' => [
+ 1 => [
+ 'start' => 2,
+ 'end' => 3,
+ 'raw' => '1',
+ ],
+ 2 => [
+ 'start' => 5,
+ 'end' => 7,
+ 'raw' => '2',
+ ],
+ ],
+ ],
+ 'short-array' => [
+ 'testMarker' => '/* testShortArray */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'ignore' => false,
+ 'expected' => [
+ 1 => [
+ 'start' => 1,
+ 'end' => 6,
+ 'raw' => "'a' => 1",
+ ],
+ 2 => [
+ 'start' => 8,
+ 'end' => 14,
+ 'raw' => "'b' => 2",
+ ],
+ ],
+ ],
+ 'short-list' => [
+ 'testMarker' => '/* testShortList */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'ignore' => true,
+ 'expected' => [
+ 1 => [
+ 'start' => 1,
+ 'end' => 6,
+ 'raw' => '\'a\' => $a',
+ ],
+ 2 => [
+ 'start' => 8,
+ 'end' => 14,
+ 'raw' => '\'b\' => $b',
+ ],
+ ],
+ ],
+ 'array-assign' => [
+ 'testMarker' => '/* testArrayAssign */',
+ 'targetType' => \T_OPEN_SQUARE_BRACKET,
+ 'ignore' => true,
+ 'expected' => [],
+ ],
+ 'array-access' => [
+ 'testMarker' => '/* testArrayAccess */',
+ 'targetType' => \T_OPEN_SQUARE_BRACKET,
+ 'ignore' => true,
+ 'expected' => [
+ 1 => [
+ 'start' => 1,
+ 'end' => 4,
+ 'raw' => '$keys[\'key\']',
+ ],
+ ],
+ ],
+ 'short-list-with-empties-before' => [
+ 'testMarker' => '/* testShortListWithEmptyItemsBefore */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'ignore' => true,
+ 'expected' => [
+ 1 => [
+ 'start' => 1,
+ 'end' => 0,
+ 'raw' => '',
+ ],
+ 2 => [
+ 'start' => 2,
+ 'end' => 2,
+ 'raw' => '',
+ ],
+ 3 => [
+ 'start' => 4,
+ 'end' => 5,
+ 'raw' => '$a',
+ ],
+ ],
+ ],
+ 'short-list-with-empties-after' => [
+ 'testMarker' => '/* testShortListWithEmptyItemsAfter */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'ignore' => true,
+ 'expected' => [
+ 1 => [
+ 'start' => 1,
+ 'end' => 1,
+ 'raw' => '$a',
+ ],
+ 2 => [
+ 'start' => 3,
+ 'end' => 2,
+ 'raw' => '',
+ ],
+ ],
+ ],
+ 'short-list-with-all-empties' => [
+ 'testMarker' => '/* testShortListWithAllEmptyItems */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'ignore' => true,
+ 'expected' => [
+ 1 => [
+ 'start' => 1,
+ 'end' => 0,
+ 'raw' => '',
+ ],
+ 2 => [
+ 'start' => 2,
+ 'end' => 1,
+ 'raw' => '',
+ ],
+ ],
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/PassedParameters/GetParametersTest.inc b/Tests/Utils/PassedParameters/GetParametersTest.inc
index 594156fa..593dd19f 100644
--- a/Tests/Utils/PassedParameters/GetParametersTest.inc
+++ b/Tests/Utils/PassedParameters/GetParametersTest.inc
@@ -119,3 +119,27 @@ if ( isset(
/* testUnset */
unset( $variable, $object->property, static::$property, $array[$name], );
+
+/* testAnonClass */
+$anon = new class( $param1, $param2 ) {
+ public function __construct($param1, $param2) {}
+};
+
+/* testPHP74UnpackingInLongArrayExpression */
+$arr4 = array(...$arr1, ...arrGen(), ...new ArrayIterator(['a', 'b', 'c']));
+
+/* testPHP74UnpackingInShortArrayExpression */
+// Also includes code sample for PHP 8.1 unpacking with string keys.
+$fruits = ['banana', ...$parts, 'watermelon', ...["a" => 2],];
+
+/* testPHP80FunctionCallInAttribute */
+#[AttributeAttachedToClosure([1, 2, 3])]
+$closure = function() {};
+
+/* testPHP80SkippingOverAttributes */
+$result = function_call(
+ $value,
+ #[MyAttribute()]
+ #[AnotherAttribute([1, 2, 3])]
+ function() { /* do something */}
+);
diff --git a/Tests/Utils/PassedParameters/GetParametersTest.php b/Tests/Utils/PassedParameters/GetParametersTest.php
index 15c67af1..a3187514 100644
--- a/Tests/Utils/PassedParameters/GetParametersTest.php
+++ b/Tests/Utils/PassedParameters/GetParametersTest.php
@@ -10,7 +10,7 @@
namespace PHPCSUtils\Tests\Utils\PassedParameters;
-use PHPCSUtils\BackCompat\Helper;
+use PHPCSUtils\Internal\Cache;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
use PHPCSUtils\Utils\PassedParameters;
@@ -20,13 +20,14 @@
*
* @covers \PHPCSUtils\Utils\PassedParameters::getParameters
* @covers \PHPCSUtils\Utils\PassedParameters::getParameter
+ * @covers \PHPCSUtils\Utils\PassedParameters::getParameterFromStack
* @covers \PHPCSUtils\Utils\PassedParameters::hasParameters
*
* @group passedparameters
*
* @since 1.0.0
*/
-class GetParametersTest extends UtilityMethodTestCase
+final class GetParametersTest extends UtilityMethodTestCase
{
/**
@@ -91,9 +92,9 @@ public function dataGetParameters()
{
return [
'function-call' => [
- '/* testFunctionCall */',
- \T_STRING,
- [
+ 'testMarker' => '/* testFunctionCall */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 3,
@@ -132,9 +133,9 @@ public function dataGetParameters()
],
],
'function-call-nested' => [
- '/* testFunctionCallNestedFunctionCall */',
- \T_STRING,
- [
+ 'testMarker' => '/* testFunctionCallNestedFunctionCall */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 9,
@@ -143,9 +144,9 @@ public function dataGetParameters()
],
],
'another-function-call' => [
- '/* testAnotherFunctionCall */',
- \T_STRING,
- [
+ 'testMarker' => '/* testAnotherFunctionCall */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 2,
@@ -180,9 +181,9 @@ public function dataGetParameters()
],
'function-call-trailing-comma' => [
- '/* testFunctionCallTrailingComma */',
- \T_STRING,
- [
+ 'testMarker' => '/* testFunctionCallTrailingComma */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 5,
@@ -191,9 +192,9 @@ public function dataGetParameters()
],
],
'function-call-nested-short-array' => [
- '/* testFunctionCallNestedShortArray */',
- \T_STRING,
- [
+ 'testMarker' => '/* testFunctionCallNestedShortArray */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 34,
@@ -202,9 +203,9 @@ public function dataGetParameters()
],
],
'function-call-nested-array-nested-closure-with-commas' => [
- '/* testFunctionCallNestedArrayNestedClosureWithCommas */',
- \T_STRING,
- [
+ 'testMarker' => '/* testFunctionCallNestedArrayNestedClosureWithCommas */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 90,
@@ -228,9 +229,9 @@ public function dataGetParameters()
// Long array.
'long-array' => [
- '/* testLongArrayNestedFunctionCalls */',
- \T_ARRAY,
- [
+ 'testMarker' => '/* testLongArrayNestedFunctionCalls */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 8,
@@ -266,9 +267,9 @@ public function dataGetParameters()
// Short array.
'short-array' => [
- '/* testShortArrayNestedFunctionCalls */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testShortArrayNestedFunctionCalls */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
1 => [
'start' => 1,
'end' => 1,
@@ -302,9 +303,9 @@ public function dataGetParameters()
],
],
'short-array-with-keys-ternary-and-null-coalesce' => [
- '/* testShortArrayWithKeysTernaryAndNullCoalesce */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testShortArrayWithKeysTernaryAndNullCoalesce */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
1 => [
'start' => 1,
'end' => 7,
@@ -319,10 +320,7 @@ public function dataGetParameters()
],
3 => [
'start' => 31,
- // Account for null coalesce tokenization difference.
- 'end' => (Helper::getVersion() === '2.6.0' && \PHP_VERSION_ID < 59999)
- ? 53
- : 51,
+ 'end' => 51,
'raw' => '\'hey\' => $baz ??
[\'one\'] ??
[\'two\']',
@@ -332,9 +330,9 @@ public function dataGetParameters()
// Nested arrays.
'nested-arrays-top-level' => [
- '/* testNestedArraysToplevel */',
- \T_ARRAY,
- [
+ 'testMarker' => '/* testNestedArraysToplevel */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 38,
@@ -358,9 +356,9 @@ public function dataGetParameters()
// Array containing closure.
'short-array-nested-closure-with-commas' => [
- '/* testShortArrayNestedClosureWithCommas */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testShortArrayNestedClosureWithCommas */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
1 => [
'start' => 1,
'end' => 38,
@@ -380,9 +378,9 @@ public function dataGetParameters()
// Array containing anonymous class.
'short-array-nested-anon-class' => [
- '/* testShortArrayNestedAnonClass */',
- \T_OPEN_SHORT_ARRAY,
- [
+ 'testMarker' => '/* testShortArrayNestedAnonClass */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
1 => [
'start' => 1,
'end' => 72,
@@ -413,9 +411,9 @@ public function test( $foo, $bar ) {
// Array arrow function and yield.
'long-array-nested-arrow-function-with-yield' => [
- '/* testLongArrayArrowFunctionWithYield */',
- \T_ARRAY,
- [
+ 'testMarker' => '/* testLongArrayArrowFunctionWithYield */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 8,
@@ -436,9 +434,9 @@ public function test( $foo, $bar ) {
// Function calling closure in variable.
'variable-function-call' => [
- '/* testVariableFunctionCall */',
- \T_VARIABLE,
- [
+ 'testMarker' => '/* testVariableFunctionCall */',
+ 'targetType' => \T_VARIABLE,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 2,
@@ -457,9 +455,9 @@ public function test( $foo, $bar ) {
],
],
'static-variable-function-call' => [
- '/* testStaticVariableFunctionCall */',
- \T_VARIABLE,
- [
+ 'testMarker' => '/* testStaticVariableFunctionCall */',
+ 'targetType' => \T_VARIABLE,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 4,
@@ -473,9 +471,9 @@ public function test( $foo, $bar ) {
],
],
'isset' => [
- '/* testIsset */',
- \T_ISSET,
- [
+ 'testMarker' => '/* testIsset */',
+ 'targetType' => \T_ISSET,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 4,
@@ -499,9 +497,9 @@ public function test( $foo, $bar ) {
],
],
'unset' => [
- '/* testUnset */',
- \T_UNSET,
- [
+ 'testMarker' => '/* testUnset */',
+ 'targetType' => \T_UNSET,
+ 'expected' => [
1 => [
'start' => 2,
'end' => 3,
@@ -524,9 +522,148 @@ public function test( $foo, $bar ) {
],
],
],
+ 'anon-class' => [
+ 'testMarker' => '/* testAnonClass */',
+ 'targetType' => \T_ANON_CLASS,
+ 'expected' => [
+ 1 => [
+ 'start' => 2,
+ 'end' => 3,
+ 'raw' => '$param1',
+ ],
+ 2 => [
+ 'start' => 5,
+ 'end' => 7,
+ 'raw' => '$param2',
+ ],
+ ],
+ ],
+
+ // PHP 7.4 argument unpacking array expressions.
+ 'long-array-with-argument-unpacking-via-spread-operator' => [
+ 'testMarker' => '/* testPHP74UnpackingInLongArrayExpression */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => [
+ 1 => [
+ 'start' => 2,
+ 'end' => 3,
+ 'raw' => '...$arr1',
+ ],
+ 2 => [
+ 'start' => 5,
+ 'end' => 9,
+ 'raw' => '...arrGen()',
+ ],
+ 3 => [
+ 'start' => 11,
+ 'end' => 26,
+ 'raw' => "...new ArrayIterator(['a', 'b', 'c'])",
+ ],
+ ],
+ ],
+ 'short-array-with-argument-unpacking-via-spread-operator' => [
+ 'testMarker' => '/* testPHP74UnpackingInShortArrayExpression */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => [
+ 1 => [
+ 'start' => 1,
+ 'end' => 1,
+ 'raw' => "'banana'",
+ ],
+ 2 => [
+ 'start' => 3,
+ 'end' => 5,
+ 'raw' => '...$parts',
+ ],
+ 3 => [
+ 'start' => 7,
+ 'end' => 8,
+ 'raw' => "'watermelon'",
+ ],
+ 4 => [
+ 'start' => 10,
+ 'end' => 18,
+ 'raw' => '...["a" => 2]',
+ ],
+ ],
+ ],
+
+ // PHP 8.0: function calls in attributes.
+ 'function-call-within-an-attribute' => [
+ 'testMarker' => '/* testPHP80FunctionCallInAttribute */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 1 => [
+ 'start' => 2,
+ 'end' => 10,
+ 'raw' => '[1, 2, 3]',
+ ],
+ ],
+ ],
+
+ // PHP 8.0: skipping over attributes.
+ 'function-call-with-attributes-attached-to-passed-closure' => [
+ 'testMarker' => '/* testPHP80SkippingOverAttributes */',
+ 'targetType' => \T_STRING,
+ 'expected' => [
+ 1 => [
+ 'start' => 2,
+ 'end' => 4,
+ 'raw' => '$value',
+ ],
+ 2 => [
+ 'start' => 6,
+ 'end' => 39,
+ 'raw' => '#[MyAttribute()]
+ #[AnotherAttribute([1, 2, 3])]
+ function() { /* do something */}',
+ ],
+ ],
+ ],
];
}
+ /**
+ * Verify that the build-in caching is used when caching is enabled.
+ *
+ * @return void
+ */
+ public function testGetParametersResultIsCached()
+ {
+ // The test case used is specifically selected as the raw and the clean param values will be the same.
+ $methodName = 'PHPCSUtils\\Utils\\PassedParameters::getParameters';
+ $cases = $this->dataGetParameters();
+ $testMarker = $cases['isset']['testMarker'];
+ $targetType = $cases['isset']['targetType'];
+ $expected = $cases['isset']['expected'];
+
+ $stackPtr = $this->getTargetToken($testMarker, [$targetType]);
+
+ // Translate offsets to exact token positions and set the "clean" key.
+ foreach ($expected as $key => $value) {
+ $expected[$key]['start'] = ($stackPtr + $value['start']);
+ $expected[$key]['end'] = ($stackPtr + $value['end']);
+ $expected[$key]['clean'] = $value['raw'];
+ }
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr);
+ $isCached = Cache::isCached(self::$phpcsFile, $methodName, "$stackPtr-0");
+ $resultSecondRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertSame($expected, $resultFirstRun, 'First result did not match expectation');
+ $this->assertTrue($isCached, 'Cache::isCached() could not find the cached value');
+ $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+ }
+
/**
* Test retrieving the details for a specific parameter from a function call or construct.
*
@@ -570,120 +707,120 @@ public function dataGetParameter()
{
return [
'function-call-param-4' => [
- '/* testFunctionCall */',
- \T_STRING,
- 4,
- [
+ 'testMarker' => '/* testFunctionCall */',
+ 'targetType' => \T_STRING,
+ 'paramPosition' => 4,
+ 'expected' => [
'start' => 11,
'end' => 12,
'raw' => '4',
],
],
'function-call-nested-param-1' => [
- '/* testFunctionCallNestedFunctionCall */',
- \T_STRING,
- 1,
- [
+ 'testMarker' => '/* testFunctionCallNestedFunctionCall */',
+ 'targetType' => \T_STRING,
+ 'paramPosition' => 1,
+ 'expected' => [
'start' => 2,
'end' => 9,
'raw' => 'dirname( __FILE__ )',
],
],
'another-function-call-param-1' => [
- '/* testAnotherFunctionCall */',
- \T_STRING,
- 1,
- [
+ 'testMarker' => '/* testAnotherFunctionCall */',
+ 'targetType' => \T_STRING,
+ 'paramPosition' => 1,
+ 'expected' => [
'start' => 2,
'end' => 2,
'raw' => '$stHour',
],
],
'another-function-call-param-6' => [
- '/* testAnotherFunctionCall */',
- \T_STRING,
- 6,
- [
+ 'testMarker' => '/* testAnotherFunctionCall */',
+ 'targetType' => \T_STRING,
+ 'paramPosition' => 6,
+ 'expected' => [
'start' => 22,
'end' => 26,
'raw' => '$arrStDt[2]',
],
],
'long-array-nested-function-calls-param-3' => [
- '/* testLongArrayNestedFunctionCalls */',
- \T_ARRAY,
- 3,
- [
+ 'testMarker' => '/* testLongArrayNestedFunctionCalls */',
+ 'targetType' => \T_ARRAY,
+ 'paramPosition' => 3,
+ 'expected' => [
'start' => 16,
'end' => 26,
'raw' => 'why(5, 1, 2)',
],
],
'simple-long-array-param-1' => [
- '/* testSimpleLongArray */',
- \T_ARRAY,
- 1,
- [
+ 'testMarker' => '/* testSimpleLongArray */',
+ 'targetType' => \T_ARRAY,
+ 'paramPosition' => 1,
+ 'expected' => [
'start' => 2,
'end' => 3,
'raw' => '1',
],
],
'simple-long-array-param-7' => [
- '/* testSimpleLongArray */',
- \T_ARRAY,
- 7,
- [
+ 'testMarker' => '/* testSimpleLongArray */',
+ 'targetType' => \T_ARRAY,
+ 'paramPosition' => 7,
+ 'expected' => [
'start' => 20,
'end' => 22,
'raw' => 'true',
],
],
'long-array-with-keys-param-' => [
- '/* testLongArrayWithKeys */',
- \T_ARRAY,
- 2,
- [
+ 'testMarker' => '/* testLongArrayWithKeys */',
+ 'targetType' => \T_ARRAY,
+ 'paramPosition' => 2,
+ 'expected' => [
'start' => 8,
'end' => 13,
'raw' => '\'b\' => $b',
],
],
'short-array-more-nested-function-calls-param-1' => [
- '/* testShortArrayMoreNestedFunctionCalls */',
- \T_OPEN_SHORT_ARRAY,
- 1,
- [
+ 'testMarker' => '/* testShortArrayMoreNestedFunctionCalls */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'paramPosition' => 1,
+ 'expected' => [
'start' => 1,
'end' => 13,
'raw' => 'str_replace("../", "/", trim($value))',
],
],
'short-array-with-keys-and-ternary-param-3' => [
- '/* testShortArrayWithKeysAndTernary */',
- \T_OPEN_SHORT_ARRAY,
- 3,
- [
+ 'testMarker' => '/* testShortArrayWithKeysAndTernary */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'paramPosition' => 3,
+ 'expected' => [
'start' => 14,
'end' => 32,
'raw' => '6 => (isset($c) ? $c : null)',
],
],
'nested-arrays-level-2-param-1' => [
- '/* testNestedArraysLevel2 */',
- \T_ARRAY,
- 1,
- [
+ 'testMarker' => '/* testNestedArraysLevel2 */',
+ 'targetType' => \T_ARRAY,
+ 'paramPosition' => 1,
+ 'expected' => [
'start' => 2,
'end' => 2,
'raw' => '1',
],
],
'nested-arrays-level-1-param-2' => [
- '/* testNestedArraysLevel1 */',
- \T_OPEN_SHORT_ARRAY,
- 2,
- [
+ 'testMarker' => '/* testNestedArraysLevel1 */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'paramPosition' => 2,
+ 'expected' => [
'start' => 9,
'end' => 21,
'raw' => '1 => [1,2,3]',
diff --git a/Tests/Utils/PassedParameters/GetParametersWithLimitTest.inc b/Tests/Utils/PassedParameters/GetParametersWithLimitTest.inc
new file mode 100644
index 00000000..aa0e5880
--- /dev/null
+++ b/Tests/Utils/PassedParameters/GetParametersWithLimitTest.inc
@@ -0,0 +1,55 @@
+ 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5, 'f' => 6, 'g' => true );
+
+/* testShortArrayWithKeys */
+$foo = [
+ 'a' => 1,
+ 'b' => 2,
+ 'c' => 3,
+ 'd' => 4,
+ 'e' => 5,
+ 'f' => 6,
+ 'g' => true,
+];
+
+/*
+ * NOTE: the below test code is duplicate, but the cache tests need unique $stackPtrs to
+ * prevent the result of earlier tests poluting the results of the caching tests.
+ */
+
+/* testCachedWithLimit */
+$foo = array( 1, 2, 3, 4, 5, 6, true );
+
+/* testCachedWithoutLimitWhenTotalItemsLessThanLimit */
+$foo = array( 'a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5, 'f' => 6, 'g' => true )
+
+/* testCachedWithoutLimitWhenTotalItemsEqualsLimit */
+$foo = [
+ 'a' => 1,
+ 'b' => 2,
+ 'c' => 3,
+ 'd' => 4,
+ 'e' => 5,
+ 'f' => 6,
+ 'g' => true,
+];
+
+/* testRetrievedFromCacheWhenCachePreviouslySetWithoutLimit */
+myfunction( 1, 2, 3, 4, 5, 6, true );
+
+/* testRetrievedFromScratchIfNoSuitableCacheFound */
+myfunction( 1, 2, 3, 4, 5, 6, true );
diff --git a/Tests/Utils/PassedParameters/GetParametersWithLimitTest.php b/Tests/Utils/PassedParameters/GetParametersWithLimitTest.php
new file mode 100644
index 00000000..bfcb271b
--- /dev/null
+++ b/Tests/Utils/PassedParameters/GetParametersWithLimitTest.php
@@ -0,0 +1,370 @@
+getTargetToken('/* testNoParams */', \T_ARRAY);
+
+ $result = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, 3);
+ $this->assertSame([], $result);
+ $this->assertCount(0, $result);
+
+ // Limit is automatically applied to getParameter().
+ $result = PassedParameters::getParameter(self::$phpcsFile, $stackPtr, 3);
+ $this->assertFalse($result);
+ }
+
+ /**
+ * Test passing an invalid limit.
+ *
+ * @dataProvider dataGetParametersWithIneffectiveLimit
+ *
+ * @param mixed $limit Parameter value for the $limit parameter.
+ *
+ * @return void
+ */
+ public function testGetParametersWithIneffectiveLimit($limit)
+ {
+ $stackPtr = $this->getTargetToken('/* testFunctionCall */', \T_STRING);
+
+ $result = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, $limit);
+ $this->assertNotEmpty($result);
+ $this->assertCount(7, $result);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testGetParametersWithIneffectiveLimit() For the array format.
+ *
+ * @return array
+ */
+ public function dataGetParametersWithIneffectiveLimit()
+ {
+ return [
+ 'invalid-limit-wrong-type-null' => [null],
+ 'invalid-limit-wrong-type-bool' => [true],
+ 'invalid-limit-wrong-type-string' => ['10'],
+ 'invalid-limit-negative-int' => [-10],
+ 'valid-limit-set-to-0 = no-limit' => [0],
+ 'valid-limit-higher-than-param-count' => [10],
+ ];
+ }
+
+ /**
+ * Test retrieving the parameter details from a function call or construct.
+ *
+ * @dataProvider dataGetParametersWithLimit
+ *
+ * @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 array $limit The number of parameters to limit this call to.
+ * Should match the expected count.
+ * @param array $expected Optional. The expected return value. Only tested when not empty.
+ *
+ * @return void
+ */
+ public function testGetParametersWithLimit($testMarker, $targetType, $limit, $expected = [])
+ {
+ $stackPtr = $this->getTargetToken($testMarker, [$targetType]);
+
+ $result = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, $limit);
+ $this->assertNotEmpty($result);
+ $this->assertCount($limit, $result);
+
+ if (empty($expected) === true) {
+ return;
+ }
+
+ // 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 testGetParametersWithLimit() For the array format.
+ *
+ * @return array
+ */
+ public function dataGetParametersWithLimit()
+ {
+ return [
+ 'function-call' => [
+ 'testMarker' => '/* testFunctionCall */',
+ 'targetType' => \T_STRING,
+ 'limit' => 2,
+ ],
+ 'long-array-no-keys' => [
+ 'testMarker' => '/* testSimpleLongArray */',
+ 'targetType' => \T_ARRAY,
+ 'limit' => 1,
+ 'expected' => [
+ 1 => [
+ 'start' => 2,
+ 'end' => 3,
+ 'raw' => '1',
+ ],
+ ],
+ ],
+ 'short-array-no-keys' => [
+ 'testMarker' => '/* testSimpleShortArray */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'limit' => 5,
+ ],
+ 'long-array-with-keys' => [
+ 'testMarker' => '/* testLongArrayWithKeys */',
+ 'targetType' => \T_ARRAY,
+ 'limit' => 7,
+ ],
+ 'short-array-with-keys' => [
+ 'testMarker' => '/* testShortArrayWithKeys */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'limit' => 4,
+ ],
+ ];
+ }
+
+ /**
+ * Verify that the build-in caching is used when caching is enabled and that the caching keeps track
+ * of the used limit.
+ *
+ * @return void
+ */
+ public function testResultIsCachedWithLimit()
+ {
+ // Can't re-use test cases for these tests, as in that case, the cache _may_ already be set (for 0 limit).
+ $methodName = 'PHPCSUtils\\Utils\\PassedParameters::getParameters';
+ $testMarker = '/* testCachedWithLimit */';
+ $stackPtr = $this->getTargetToken($testMarker, \T_ARRAY);
+ $limit = 1;
+ $expected = [
+ 1 => [
+ 'start' => 2 + $stackPtr,
+ 'end' => 3 + $stackPtr,
+ 'raw' => '1',
+ 'clean' => '1',
+ ],
+ ];
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, $limit);
+ $isCached = Cache::isCached(self::$phpcsFile, $methodName, "$stackPtr-$limit");
+ $resultSecondRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, $limit);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertSame($expected, $resultFirstRun, 'First result did not match expectation');
+ $this->assertTrue($isCached, 'Cache::isCached() could not find the cached value');
+ $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+ }
+
+ /**
+ * Verify that when a previous query for the same token was made with a limit which was more than
+ * the item count, the result was cached as if no limit was set.
+ *
+ * @return void
+ */
+ public function testResultIsCachedWithoutLimitWhenTotalItemsLessThanLimit()
+ {
+ // Can't re-use test cases for these tests, as in that case, the cache _may_ already be set (for 0 limit).
+ $methodName = 'PHPCSUtils\\Utils\\PassedParameters::getParameters';
+ $testMarker = '/* testCachedWithoutLimitWhenTotalItemsLessThanLimit */';
+ $stackPtr = $this->getTargetToken($testMarker, \T_ARRAY);
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, 10);
+ $isCachedWithLimit = Cache::isCached(self::$phpcsFile, $methodName, "$stackPtr-10");
+ $isCachedWithoutLimit = Cache::isCached(self::$phpcsFile, $methodName, "$stackPtr-0");
+ $resultSecondRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, 10);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertCount(7, $resultFirstRun, 'Count of first result did not match expectation');
+ $this->assertFalse($isCachedWithLimit, 'Cache::isCached() found a cached value with key "ptr-10"');
+ $this->assertTrue($isCachedWithoutLimit, 'Cache::isCached() did not find a cached value with key "ptr-0"');
+ $this->assertCount(7, $resultSecondRun, 'Count of second result did not match expectation');
+ }
+
+ /**
+ * Verify that when a previous query for the same token was made with a limit which matched the item count,
+ * the result was cached as if no limit was set.
+ *
+ * @return void
+ */
+ public function testResultIsCachedWithoutLimitWhenTotalItemsEqualsLimit()
+ {
+ // Can't re-use test cases for these tests, as in that case, the cache _may_ already be set (for 0 limit).
+ $methodName = 'PHPCSUtils\\Utils\\PassedParameters::getParameters';
+ $testMarker = '/* testCachedWithoutLimitWhenTotalItemsEqualsLimit */';
+ $stackPtr = $this->getTargetToken($testMarker, \T_OPEN_SHORT_ARRAY);
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, 7);
+ $isCachedWithLimit = Cache::isCached(self::$phpcsFile, $methodName, "$stackPtr-7");
+ $isCachedWithoutLimit = Cache::isCached(self::$phpcsFile, $methodName, "$stackPtr-0");
+ $resultSecondRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, 7);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertCount(7, $resultFirstRun, 'Count of first result did not match expectation');
+ $this->assertFalse($isCachedWithLimit, 'Cache::isCached() found a cached value with key "ptr-7"');
+ $this->assertTrue($isCachedWithoutLimit, 'Cache::isCached() did not find a cached value with key "ptr-0"');
+ $this->assertCount(7, $resultSecondRun, 'Count of second result did not match expectation');
+ }
+
+ /**
+ * Verify that when a previous query for the same token without limit was made, the result
+ * cache is used to retrieve the limited result.
+ *
+ * @return void
+ */
+ public function testResultIsRetrievedFromCacheWhenCachePreviouslySetWithoutLimit()
+ {
+ // Can't re-use test cases for these tests, as in that case, the cache _may_ already be set (for 0 limit).
+ $methodName = 'PHPCSUtils\\Utils\\PassedParameters::getParameters';
+ $testMarker = '/* testRetrievedFromCacheWhenCachePreviouslySetWithoutLimit */';
+ $stackPtr = $this->getTargetToken($testMarker, \T_STRING);
+ $limit = 2;
+ $expected = [
+ 1 => [
+ 'start' => 2 + $stackPtr,
+ 'end' => 3 + $stackPtr,
+ 'raw' => '1',
+ 'clean' => '1',
+ ],
+ 2 => [
+ 'start' => 5 + $stackPtr,
+ 'end' => 6 + $stackPtr,
+ 'raw' => '2',
+ 'clean' => '2',
+ ],
+ ];
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr);
+ $isCached = Cache::isCached(self::$phpcsFile, $methodName, "$stackPtr-0");
+ $resultSecondRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, $limit);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertCount(7, $resultFirstRun, 'Count of first result did not match expectation');
+ $this->assertTrue($isCached, 'Cache::isCached() did not find a cached value with key "ptr-0"');
+ $this->assertSame($expected, $resultSecondRun, 'Second result did not match the expected result');
+ }
+
+ /**
+ * Verify that when a previous query for the same token was made with a limit which was less than the total
+ * number of items and the current limit does not match, the function will not use the cache.
+ *
+ * @return void
+ */
+ public function testResultIsRetrievedFromScratchIfNoSuitableCacheFound()
+ {
+ static $firstRun = true;
+
+ // Can't re-use test cases for this test, as in that case, the cache _may_ already be set (for 0 limit).
+ $methodName = 'PHPCSUtils\\Utils\\PassedParameters::getParameters';
+ $testMarker = '/* testRetrievedFromScratchIfNoSuitableCacheFound */';
+ $stackPtr = $this->getTargetToken($testMarker, \T_STRING);
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, 2);
+ $isCachedWithLimit2 = Cache::isCached(self::$phpcsFile, $methodName, "$stackPtr-2");
+ $isCachedWithLimit4pre = Cache::isCached(self::$phpcsFile, $methodName, "$stackPtr-4");
+ $isCachedWithoutLimit = Cache::isCached(self::$phpcsFile, $methodName, "$stackPtr-0");
+ $resultSecondRun = PassedParameters::getParameters(self::$phpcsFile, $stackPtr, 4);
+ $isCachedWithLimit4post = Cache::isCached(self::$phpcsFile, $methodName, "$stackPtr-4");
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertCount(2, $resultFirstRun, 'Count of first result did not match expectation');
+ $this->assertTrue($isCachedWithLimit2, 'Cache::isCached() did not find a cached value with key "ptr-2"');
+ if ($firstRun === true) {
+ $this->assertFalse($isCachedWithLimit4pre, 'Cache::isCached() found a cached value with key "ptr-4"');
+ } else {
+ $this->assertTrue($isCachedWithLimit4pre, 'Cache::isCached() did not find a cached value with key "ptr-4"');
+ }
+ $this->assertFalse($isCachedWithoutLimit, 'Cache::isCached() found a cached value with key "ptr-0"');
+ $this->assertCount(4, $resultSecondRun, 'Count of second result did not match expectation');
+ $this->assertTrue($isCachedWithLimit4post, 'Cache::isCached() did not find a cached value with key "ptr-4"');
+
+ $firstRun = false;
+ }
+}
diff --git a/Tests/Utils/PassedParameters/HasParametersTest.inc b/Tests/Utils/PassedParameters/HasParametersTest.inc
index 3c05a5c7..cf69b775 100644
--- a/Tests/Utils/PassedParameters/HasParametersTest.inc
+++ b/Tests/Utils/PassedParameters/HasParametersTest.inc
@@ -5,8 +5,14 @@ interface NotAFunctionCallOrArray {}
class Foo {
public function Bar() {
- /* testNotACallToConstructor */
- $a = self::some_method();
+ /* testNotACallToConstructor1 */
+ $a = parent::SOME_CONSTANT;
+
+ /* testNotACallToConstructor2 */
+ $a = static::some_method();
+
+ /* testNotACallToConstructor3 */
+ $a = $obj instanceof self;
}
}
@@ -27,6 +33,17 @@ some_function( /*nothing here*/ );
/* testNoParamsFunctionCall4 */
$closure(/*nothing here*/);
+class HierarchyKeywordsNoParens {
+ public static function getInstance() {
+ /* testNoParamsFunctionCall5 */
+ $a = new self;
+ /* testNoParamsFunctionCall6 */
+ $a = new static;
+ /* testNoParamsFunctionCall7 */
+ $a = new parent;
+ }
+}
+
// Function calls: has parameters.
/* testHasParamsFunctionCall1 */
@@ -35,13 +52,43 @@ some_function( 1 );
/* testHasParamsFunctionCall2 */
$closure(1,2,3);
-class Bar {
+class HierarchyKeywordsWithParam {
public static function getInstance() {
/* testHasParamsFunctionCall3 */
- return new self(true);
+ $a = new self(true);
+ /* testHasParamsFunctionCall4 */
+ $a = new static(true);
+ /* testHasParamsFunctionCall5 */
+ $a = new parent(true);
}
}
+class HierarchyKeywordsAsMethodNames {
+ public function self() {}
+ public function static() {}
+ public function parent() {
+ /* testHasParamsFunctionCall6 */
+ $a = self::self(true);
+ /* testHasParamsFunctionCall7 */
+ $a = $this->static(true);
+ /* testHasParamsFunctionCall8 */
+ $a = $this->parent(true);
+ }
+}
+
+/* testNoParamsFunctionCallFullyQualified */
+\myfunction( );
+
+/* testHasParamsFunctionCallFullyQualifiedWithNamespace */
+\My\Named\myfunction( $a );
+
+/* testNoParamsFunctionCallPartiallyQualified */
+Partially\Qualified\myfunction();
+
+/* testHasParamsFunctionCallNamespaceOperator */
+namespace\myfunction( $a );
+
+
// Arrays: no parameters.
/* testNoParamsLongArray1 */
@@ -107,6 +154,26 @@ unset(
);
+/* testNoParamsNoParensAnonClass */
+$anon = new class extends FooBar {};
+
+/* testNoParamsWithParensAnonClass */
+$anon = new class() {};
+
+/* testHasParamsAnonClass */
+$anon = new class( $param1, $param2 ) {};
+
+/* testPHP81FirstClassCallableNotFunctionCallGlobalFunction */
+$fn = strlen(...);
+
+/* testPHP81FirstClassCallableNotFunctionCallOOMethod */
+$fn = $this->method(
+ ...
+);
+
+/* testPHP81FirstClassCallableNotFunctionCallVariableStaticOOMethod */
+$fn = $name1::$name2( /*comment*/ ...);
+
// Intentional parse error.
/* testNoCloseParenthesis */
$array = array(1, 2, 3
diff --git a/Tests/Utils/PassedParameters/HasParametersTest.php b/Tests/Utils/PassedParameters/HasParametersTest.php
index 36290a5e..8e25394c 100644
--- a/Tests/Utils/PassedParameters/HasParametersTest.php
+++ b/Tests/Utils/PassedParameters/HasParametersTest.php
@@ -8,9 +8,10 @@
* @link https://github.com/PHPCSStandards/PHPCSUtils
*/
-namespace PHPCSUtils\Tests\Utils\Operators;
+namespace PHPCSUtils\Tests\Utils\PassedParameters;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tokens\Collections;
use PHPCSUtils\Utils\PassedParameters;
/**
@@ -22,7 +23,7 @@
*
* @since 1.0.0
*/
-class HasParametersTest extends UtilityMethodTestCase
+final class HasParametersTest extends UtilityMethodTestCase
{
/**
@@ -58,18 +59,48 @@ public function testNotAnAcceptedTokenException()
/**
* Test receiving an expected exception when T_SELF is passed not preceeded by `new`.
*
+ * @dataProvider dataNotACallToConstructor
+ *
+ * @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.
+ *
* @return void
*/
- public function testNotACallToConstructor()
+ public function testNotACallToConstructor($testMarker, $targetType)
{
$this->expectPhpcsException(
'The hasParameters() method expects a function call, array, isset or unset token to be passed.'
);
- $self = $this->getTargetToken('/* testNotACallToConstructor */', \T_SELF);
+ $self = $this->getTargetToken($testMarker, $targetType);
PassedParameters::hasParameters(self::$phpcsFile, $self);
}
+ /**
+ * Data provider.
+ *
+ * @see testNotACallToConstructor() For the array format.
+ *
+ * @return array
+ */
+ public function dataNotACallToConstructor()
+ {
+ return [
+ 'parent' => [
+ 'testMarker' => '/* testNotACallToConstructor1 */',
+ 'targetType' => \T_PARENT,
+ ],
+ 'static' => [
+ 'testMarker' => '/* testNotACallToConstructor2 */',
+ 'targetType' => \T_STATIC,
+ ],
+ 'self' => [
+ 'testMarker' => '/* testNotACallToConstructor3 */',
+ 'targetType' => \T_SELF,
+ ],
+ ];
+ }
+
/**
* Test receiving an expected exception when T_OPEN_SHORT_ARRAY is passed but represents a short list.
*
@@ -83,7 +114,7 @@ public function testNotAShortArray()
$self = $this->getTargetToken(
'/* testShortListNotShortArray */',
- [\T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
+ Collections::shortArrayListOpenTokensBC()
);
PassedParameters::hasParameters(self::$phpcsFile, $self);
}
@@ -93,15 +124,17 @@ public function testNotAShortArray()
*
* @dataProvider dataHasParameters
*
- * @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 $expected Whether or not the function/array has parameters/values.
+ * @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 $expected Whether or not the function/array has parameters/values.
+ * @param string $targetContent Optional. The content of the target token to find.
+ * Defaults to null (ignore content).
*
* @return void
*/
- public function testHasParameters($testMarker, $targetType, $expected)
+ public function testHasParameters($testMarker, $targetType, $expected, $targetContent = null)
{
- $stackPtr = $this->getTargetToken($testMarker, $targetType);
+ $stackPtr = $this->getTargetToken($testMarker, $targetType, $targetContent);
$result = PassedParameters::hasParameters(self::$phpcsFile, $stackPtr);
$this->assertSame($expected, $result);
}
@@ -115,156 +148,261 @@ public function testHasParameters($testMarker, $targetType, $expected)
*/
public function dataHasParameters()
{
+ $php8Names = parent::usesPhp8NameTokens();
+
return [
// Function calls.
'no-params-function-call-1' => [
- '/* testNoParamsFunctionCall1 */',
- \T_STRING,
- false,
+ 'testMarker' => '/* testNoParamsFunctionCall1 */',
+ 'targetType' => \T_STRING,
+ 'expected' => false,
],
'no-params-function-call-2' => [
- '/* testNoParamsFunctionCall2 */',
- \T_STRING,
- false,
+ 'testMarker' => '/* testNoParamsFunctionCall2 */',
+ 'targetType' => \T_STRING,
+ 'expected' => false,
],
'no-params-function-call-3' => [
- '/* testNoParamsFunctionCall3 */',
- \T_STRING,
- false,
+ 'testMarker' => '/* testNoParamsFunctionCall3 */',
+ 'targetType' => \T_STRING,
+ 'expected' => false,
],
'no-params-function-call-4' => [
- '/* testNoParamsFunctionCall4 */',
- \T_VARIABLE,
- false,
+ 'testMarker' => '/* testNoParamsFunctionCall4 */',
+ 'targetType' => \T_VARIABLE,
+ 'expected' => false,
+ ],
+ 'no-params-function-call-5-new-self' => [
+ 'testMarker' => '/* testNoParamsFunctionCall5 */',
+ 'targetType' => \T_SELF,
+ 'expected' => false,
],
+ 'no-params-function-call-6-new-static' => [
+ 'testMarker' => '/* testNoParamsFunctionCall6 */',
+ 'targetType' => \T_STATIC,
+ 'expected' => false,
+ ],
+ 'no-params-function-call-7-new-parent' => [
+ 'testMarker' => '/* testNoParamsFunctionCall7 */',
+ 'targetType' => \T_PARENT,
+ 'expected' => false,
+ ],
+
'has-params-function-call-1' => [
- '/* testHasParamsFunctionCall1 */',
- \T_STRING,
- true,
+ 'testMarker' => '/* testHasParamsFunctionCall1 */',
+ 'targetType' => \T_STRING,
+ 'expected' => true,
],
'has-params-function-call-2' => [
- '/* testHasParamsFunctionCall2 */',
- \T_VARIABLE,
- true,
+ 'testMarker' => '/* testHasParamsFunctionCall2 */',
+ 'targetType' => \T_VARIABLE,
+ 'expected' => true,
+ ],
+ 'has-params-function-call-3-new-self' => [
+ 'testMarker' => '/* testHasParamsFunctionCall3 */',
+ 'targetType' => \T_SELF,
+ 'expected' => true,
+ ],
+ 'has-params-function-call-4-new-static' => [
+ 'testMarker' => '/* testHasParamsFunctionCall4 */',
+ 'targetType' => \T_STATIC,
+ 'expected' => true,
+ ],
+ 'has-params-function-call-5-new-parent' => [
+ 'testMarker' => '/* testHasParamsFunctionCall5 */',
+ 'targetType' => \T_PARENT,
+ 'expected' => true,
],
- 'has-params-function-call-3' => [
- '/* testHasParamsFunctionCall3 */',
- // In PHPCS < 2.8.0, self in "new self" is tokenized as T_STRING.
- [\T_SELF, \T_STRING],
- true,
+ 'has-params-function-call-6-self-as-method-name' => [
+ 'testMarker' => '/* testHasParamsFunctionCall6 */',
+ 'targetType' => \T_STRING,
+ 'expected' => true,
+ 'targetContent' => 'self',
+ ],
+ 'has-params-function-call-7-static-as-method-name' => [
+ 'testMarker' => '/* testHasParamsFunctionCall7 */',
+ 'targetType' => \T_STRING,
+ 'expected' => true,
+ 'targetContent' => 'static',
+ ],
+ 'has-params-function-call-8-parent-as-method-name' => [
+ 'testMarker' => '/* testHasParamsFunctionCall8 */',
+ 'targetType' => \T_STRING,
+ 'expected' => true,
+ 'targetContent' => 'parent',
+ ],
+
+ 'no-params-function-call-fully-qualified' => [
+ 'testMarker' => '/* testNoParamsFunctionCallFullyQualified */',
+ 'targetType' => ($php8Names === true) ? \T_NAME_FULLY_QUALIFIED : \T_STRING,
+ 'expected' => false,
+ 'targetContent' => ($php8Names === true) ? null : 'myfunction',
+ ],
+ 'has-params-function-call-fully-qualified-with-namespace' => [
+ 'testMarker' => '/* testHasParamsFunctionCallFullyQualifiedWithNamespace */',
+ 'targetType' => ($php8Names === true) ? \T_NAME_FULLY_QUALIFIED : \T_STRING,
+ 'expected' => true,
+ 'targetContent' => ($php8Names === true) ? null : 'myfunction',
+ ],
+ 'no-params-function-call-partially-qualified' => [
+ 'testMarker' => '/* testNoParamsFunctionCallPartiallyQualified */',
+ 'targetType' => ($php8Names === true) ? \T_NAME_QUALIFIED : \T_STRING,
+ 'expected' => false,
+ 'targetContent' => ($php8Names === true) ? null : 'myfunction',
+ ],
+ 'has-params-function-call-namespace-operator-relative' => [
+ 'testMarker' => '/* testHasParamsFunctionCallNamespaceOperator */',
+ 'targetType' => ($php8Names === true) ? \T_NAME_RELATIVE : \T_STRING,
+ 'expected' => true,
+ 'targetContent' => ($php8Names === true) ? null : 'myfunction',
],
// Arrays.
'no-params-long-array-1' => [
- '/* testNoParamsLongArray1 */',
- \T_ARRAY,
- false,
+ 'testMarker' => '/* testNoParamsLongArray1 */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => false,
],
'no-params-long-array-2' => [
- '/* testNoParamsLongArray2 */',
- \T_ARRAY,
- false,
+ 'testMarker' => '/* testNoParamsLongArray2 */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => false,
],
'no-params-long-array-3' => [
- '/* testNoParamsLongArray3 */',
- \T_ARRAY,
- false,
+ 'testMarker' => '/* testNoParamsLongArray3 */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => false,
],
'no-params-long-array-4' => [
- '/* testNoParamsLongArray4 */',
- \T_ARRAY,
- false,
+ 'testMarker' => '/* testNoParamsLongArray4 */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => false,
],
'no-params-short-array-1' => [
- '/* testNoParamsShortArray1 */',
- \T_OPEN_SHORT_ARRAY,
- false,
+ 'testMarker' => '/* testNoParamsShortArray1 */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => false,
],
'no-params-short-array-2' => [
- '/* testNoParamsShortArray2 */',
- \T_OPEN_SHORT_ARRAY,
- false,
+ 'testMarker' => '/* testNoParamsShortArray2 */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => false,
],
'no-params-short-array-3' => [
- '/* testNoParamsShortArray3 */',
- \T_OPEN_SHORT_ARRAY,
- false,
+ 'testMarker' => '/* testNoParamsShortArray3 */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => false,
],
'no-params-short-array-4' => [
- '/* testNoParamsShortArray4 */',
- \T_OPEN_SHORT_ARRAY,
- false,
+ 'testMarker' => '/* testNoParamsShortArray4 */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => false,
],
'has-params-long-array-1' => [
- '/* testHasParamsLongArray1 */',
- \T_ARRAY,
- true,
+ 'testMarker' => '/* testHasParamsLongArray1 */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => true,
],
'has-params-long-array-2' => [
- '/* testHasParamsLongArray2 */',
- \T_ARRAY,
- true,
+ 'testMarker' => '/* testHasParamsLongArray2 */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => true,
],
'has-params-long-array-3' => [
- '/* testHasParamsLongArray3 */',
- \T_ARRAY,
- true,
+ 'testMarker' => '/* testHasParamsLongArray3 */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => true,
],
'has-params-short-array-1' => [
- '/* testHasParamsShortArray1 */',
- \T_OPEN_SHORT_ARRAY,
- true,
+ 'testMarker' => '/* testHasParamsShortArray1 */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => true,
],
'has-params-short-array-2' => [
- '/* testHasParamsShortArray2 */',
- \T_OPEN_SHORT_ARRAY,
- true,
+ 'testMarker' => '/* testHasParamsShortArray2 */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => true,
],
'has-params-short-array-3' => [
- '/* testHasParamsShortArray3 */',
- \T_OPEN_SHORT_ARRAY,
- true,
+ 'testMarker' => '/* testHasParamsShortArray3 */',
+ 'targetType' => \T_OPEN_SHORT_ARRAY,
+ 'expected' => true,
],
// Isset.
'no-params-isset' => [
- '/* testNoParamsIsset */',
- \T_ISSET,
- false,
+ 'testMarker' => '/* testNoParamsIsset */',
+ 'targetType' => \T_ISSET,
+ 'expected' => false,
],
'has-params-isset' => [
- '/* testHasParamsIsset */',
- \T_ISSET,
- true,
+ 'testMarker' => '/* testHasParamsIsset */',
+ 'targetType' => \T_ISSET,
+ 'expected' => true,
],
// Unset.
'no-params-unset' => [
- '/* testNoParamsUnset */',
- \T_UNSET,
- false,
+ 'testMarker' => '/* testNoParamsUnset */',
+ 'targetType' => \T_UNSET,
+ 'expected' => false,
],
'has-params-unset' => [
- '/* testHasParamsUnset */',
- \T_UNSET,
- true,
+ 'testMarker' => '/* testHasParamsUnset */',
+ 'targetType' => \T_UNSET,
+ 'expected' => true,
+ ],
+
+ // Anonymous class instantiation.
+ 'no-params-no-parens-anon-class' => [
+ 'testMarker' => '/* testNoParamsNoParensAnonClass */',
+ 'targetType' => \T_ANON_CLASS,
+ 'expected' => false,
+ ],
+ 'no-params-with-parens-anon-class' => [
+ 'testMarker' => '/* testNoParamsWithParensAnonClass */',
+ 'targetType' => \T_ANON_CLASS,
+ 'expected' => false,
+ ],
+ 'has-params-anon-class' => [
+ 'testMarker' => '/* testHasParamsAnonClass */',
+ 'targetType' => \T_ANON_CLASS,
+ 'expected' => true,
+ ],
+
+ // PHP 8.1 first class callables are callbacks, not function calls.
+ 'no-params-php81-first-class-callable-global-function' => [
+ 'testMarker' => '/* testPHP81FirstClassCallableNotFunctionCallGlobalFunction */',
+ 'targetType' => \T_STRING,
+ 'expected' => false,
+ ],
+ 'no-params-php81-first-class-callable-oo-method' => [
+ 'testMarker' => '/* testPHP81FirstClassCallableNotFunctionCallOOMethod */',
+ 'targetType' => \T_STRING,
+ 'expected' => false,
+ ],
+ 'no-params-php81-first-class-callable-variable-static-oo-method' => [
+ 'testMarker' => '/* testPHP81FirstClassCallableNotFunctionCallVariableStaticOOMethod */',
+ 'targetType' => \T_VARIABLE,
+ 'expected' => false,
+ 'targetContent' => '$name2',
],
// Defensive coding against parse errors and live coding.
'defense-in-depth-no-close-parens' => [
- '/* testNoCloseParenthesis */',
- \T_ARRAY,
- false,
+ 'testMarker' => '/* testNoCloseParenthesis */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => false,
],
'defense-in-depth-no-open-parens' => [
- '/* testNoOpenParenthesis */',
- \T_STRING,
- false,
+ 'testMarker' => '/* testNoOpenParenthesis */',
+ 'targetType' => \T_STRING,
+ 'expected' => false,
],
'defense-in-depth-live-coding' => [
- '/* testLiveCoding */',
- \T_ARRAY,
- false,
+ 'testMarker' => '/* testLiveCoding */',
+ 'targetType' => \T_ARRAY,
+ 'expected' => false,
],
];
}
diff --git a/Tests/Utils/Scopes/IsOOConstantTest.inc b/Tests/Utils/Scopes/IsOOConstantTest.inc
index 3654d886..31259737 100644
--- a/Tests/Utils/Scopes/IsOOConstantTest.inc
+++ b/Tests/Utils/Scopes/IsOOConstantTest.inc
@@ -33,7 +33,18 @@ interface MyInterface {
}
trait MyTrait {
- // Intentional parse error. Constants are not allowed in traits.
+ // Prior to PHP 8.2, this was a parse error. Since PHP 8.2, constants are allowed in traits.
/* testTraitConst */
const BAR = false;
}
+
+enum Suit: string
+{
+ /* testEnumConst */
+ const FOO = 'bar';
+
+ case Hearts = 'H';
+ case Diamonds = 'D';
+ case Clubs = 'C';
+ case Spades = 'S';
+}
diff --git a/Tests/Utils/Scopes/IsOOConstantTest.php b/Tests/Utils/Scopes/IsOOConstantTest.php
index 4f898b40..911514d0 100644
--- a/Tests/Utils/Scopes/IsOOConstantTest.php
+++ b/Tests/Utils/Scopes/IsOOConstantTest.php
@@ -16,17 +16,19 @@
/**
* Tests for the \PHPCSUtils\Utils\Scopes::isOOConstant() method.
*
+ * @coversDefaultClass \PHPCSUtils\Utils\Scopes
+ *
* @group scopes
*
* @since 1.0.0
*/
-class IsOOConstantTest extends UtilityMethodTestCase
+final class IsOOConstantTest extends UtilityMethodTestCase
{
/**
* Test passing a non-existent token pointer.
*
- * @covers \PHPCSUtils\Utils\Scopes::isOOConstant
+ * @covers ::isOOConstant
*
* @return void
*/
@@ -39,7 +41,7 @@ public function testNonExistentToken()
/**
* Test passing a non const token.
*
- * @covers \PHPCSUtils\Utils\Scopes::isOOConstant
+ * @covers ::isOOConstant
*
* @return void
*/
@@ -54,8 +56,8 @@ public function testNonConstToken()
*
* @dataProvider dataIsOOConstant
*
- * @covers \PHPCSUtils\Utils\Scopes::isOOConstant
- * @covers \PHPCSUtils\Utils\Scopes::validDirectScope
+ * @covers ::isOOConstant
+ * @covers ::validDirectScope
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param bool $expected The expected function return value.
@@ -80,32 +82,36 @@ public function dataIsOOConstant()
{
return [
'global-const' => [
- '/* testGlobalConst */',
- false,
+ 'testMarker' => '/* testGlobalConst */',
+ 'expected' => false,
],
'function-const' => [
- '/* testFunctionConst */',
- false,
+ 'testMarker' => '/* testFunctionConst */',
+ 'expected' => false,
],
'class-const' => [
- '/* testClassConst */',
- true,
+ 'testMarker' => '/* testClassConst */',
+ 'expected' => true,
],
'method-const' => [
- '/* testClassMethodConst */',
- false,
+ 'testMarker' => '/* testClassMethodConst */',
+ 'expected' => false,
],
'anon-class-const' => [
- '/* testAnonClassConst */',
- true,
+ 'testMarker' => '/* testAnonClassConst */',
+ 'expected' => true,
],
'interface-const' => [
- '/* testInterfaceConst */',
- true,
+ 'testMarker' => '/* testInterfaceConst */',
+ 'expected' => true,
],
'trait-const' => [
- '/* testTraitConst */',
- false,
+ 'testMarker' => '/* testTraitConst */',
+ 'expected' => true,
+ ],
+ 'enum-const' => [
+ 'testMarker' => '/* testEnumConst */',
+ 'expected' => true,
],
];
}
diff --git a/Tests/Utils/Scopes/IsOOMethodTest.inc b/Tests/Utils/Scopes/IsOOMethodTest.inc
index d4e0c2ec..2da0bfbe 100644
--- a/Tests/Utils/Scopes/IsOOMethodTest.inc
+++ b/Tests/Utils/Scopes/IsOOMethodTest.inc
@@ -38,3 +38,17 @@ trait MyTrait {
/* testTraitMethod */
public function something() {}
}
+
+enum Suit implements Colorful
+{
+ case Hearts;
+
+ /* testEnumMethod */
+ public function color(): string {
+ /* testEnumNestedFunction */
+ function nested() {}
+
+ /* testEnumNestedClosure */
+ $c = function() {};
+ }
+}
diff --git a/Tests/Utils/Scopes/IsOOMethodTest.php b/Tests/Utils/Scopes/IsOOMethodTest.php
index 877bdf4f..540cdb93 100644
--- a/Tests/Utils/Scopes/IsOOMethodTest.php
+++ b/Tests/Utils/Scopes/IsOOMethodTest.php
@@ -16,17 +16,19 @@
/**
* Tests for the \PHPCSUtils\Utils\Scopes::isOOMethod() method.
*
+ * @coversDefaultClass \PHPCSUtils\Utils\Scopes
+ *
* @group scopes
*
* @since 1.0.0
*/
-class IsOOMethodTest extends UtilityMethodTestCase
+final class IsOOMethodTest extends UtilityMethodTestCase
{
/**
* Test passing a non-existent token pointer.
*
- * @covers \PHPCSUtils\Utils\Scopes::isOOMethod
+ * @covers ::isOOMethod
*
* @return void
*/
@@ -39,7 +41,7 @@ public function testNonExistentToken()
/**
* Test passing a non function token.
*
- * @covers \PHPCSUtils\Utils\Scopes::isOOMethod
+ * @covers ::isOOMethod
*
* @return void
*/
@@ -54,8 +56,8 @@ public function testNonFunctionToken()
*
* @dataProvider dataIsOOMethod
*
- * @covers \PHPCSUtils\Utils\Scopes::isOOMethod
- * @covers \PHPCSUtils\Utils\Scopes::validDirectScope
+ * @covers ::isOOMethod
+ * @covers ::validDirectScope
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param bool $expected The expected function return value.
@@ -80,44 +82,56 @@ public function dataIsOOMethod()
{
return [
'global-function' => [
- '/* testGlobalFunction */',
- false,
+ 'testMarker' => '/* testGlobalFunction */',
+ 'expected' => false,
],
'nested-function' => [
- '/* testNestedFunction */',
- false,
+ 'testMarker' => '/* testNestedFunction */',
+ 'expected' => false,
],
'nested-closure' => [
- '/* testNestedClosure */',
- false,
+ 'testMarker' => '/* testNestedClosure */',
+ 'expected' => false,
],
'class-method' => [
- '/* testClassMethod */',
- true,
+ 'testMarker' => '/* testClassMethod */',
+ 'expected' => true,
],
'class-nested-function' => [
- '/* testClassNestedFunction */',
- false,
+ 'testMarker' => '/* testClassNestedFunction */',
+ 'expected' => false,
],
'class-nested-closure' => [
- '/* testClassNestedClosure */',
- false,
+ 'testMarker' => '/* testClassNestedClosure */',
+ 'expected' => false,
],
'class-abstract-method' => [
- '/* testClassAbstractMethod */',
- true,
+ 'testMarker' => '/* testClassAbstractMethod */',
+ 'expected' => true,
],
'anon-class-method' => [
- '/* testAnonClassMethod */',
- true,
+ 'testMarker' => '/* testAnonClassMethod */',
+ 'expected' => true,
],
'interface-method' => [
- '/* testInterfaceMethod */',
- true,
+ 'testMarker' => '/* testInterfaceMethod */',
+ 'expected' => true,
],
'trait-method' => [
- '/* testTraitMethod */',
- true,
+ 'testMarker' => '/* testTraitMethod */',
+ 'expected' => true,
+ ],
+ 'enum-method' => [
+ 'testMarker' => '/* testEnumMethod */',
+ 'expected' => true,
+ ],
+ 'enum-nested-function' => [
+ 'testMarker' => '/* testEnumNestedFunction */',
+ 'expected' => false,
+ ],
+ 'enum-nested-closure' => [
+ 'testMarker' => '/* testEnumNestedClosure */',
+ 'expected' => false,
],
];
}
diff --git a/Tests/Utils/Scopes/IsOOPropertyTest.inc b/Tests/Utils/Scopes/IsOOPropertyTest.inc
index 9385111a..d765c0c5 100644
--- a/Tests/Utils/Scopes/IsOOPropertyTest.inc
+++ b/Tests/Utils/Scopes/IsOOPropertyTest.inc
@@ -87,3 +87,12 @@ if ( has_filter( 'comments_open' ) === false ) {
/* testFunctionCallParameter */
}, $priority, 2 );
}
+
+enum MyEnum {
+ // Intentional parse error. Properties are not allowed in enums.
+ /* testEnumProp */
+ public $enumProp = false;
+
+ /* testEnumMethodParameter */
+ public function something($param = false);
+}
diff --git a/Tests/Utils/Scopes/IsOOPropertyTest.php b/Tests/Utils/Scopes/IsOOPropertyTest.php
index 566d6640..5e3f9c04 100644
--- a/Tests/Utils/Scopes/IsOOPropertyTest.php
+++ b/Tests/Utils/Scopes/IsOOPropertyTest.php
@@ -16,17 +16,19 @@
/**
* Tests for the \PHPCSUtils\Utils\Scopes::isOOProperty method.
*
+ * @coversDefaultClass \PHPCSUtils\Utils\Scopes
+ *
* @group scopes
*
* @since 1.0.0
*/
-class IsOOPropertyTest extends UtilityMethodTestCase
+final class IsOOPropertyTest extends UtilityMethodTestCase
{
/**
* Test passing a non-existent token pointer.
*
- * @covers \PHPCSUtils\Utils\Scopes::isOOProperty
+ * @covers ::isOOProperty
*
* @return void
*/
@@ -39,7 +41,7 @@ public function testNonExistentToken()
/**
* Test passing a non variable token.
*
- * @covers \PHPCSUtils\Utils\Scopes::isOOProperty
+ * @covers ::isOOProperty
*
* @return void
*/
@@ -54,8 +56,8 @@ public function testNonVariableToken()
*
* @dataProvider dataIsOOProperty
*
- * @covers \PHPCSUtils\Utils\Scopes::isOOProperty
- * @covers \PHPCSUtils\Utils\Scopes::validDirectScope
+ * @covers ::isOOProperty
+ * @covers ::validDirectScope
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param bool $expected The expected function return value.
@@ -80,100 +82,108 @@ public function dataIsOOProperty()
{
return [
'global-var' => [
- '/* testGlobalVar */',
- false,
+ 'testMarker' => '/* testGlobalVar */',
+ 'expected' => false,
],
'function-param' => [
- '/* testFunctionParameter */',
- false,
+ 'testMarker' => '/* testFunctionParameter */',
+ 'expected' => false,
],
'function-local-var' => [
- '/* testFunctionLocalVar */',
- false,
+ 'testMarker' => '/* testFunctionLocalVar */',
+ 'expected' => false,
],
'class-property-public' => [
- '/* testClassPropPublic */',
- true,
+ 'testMarker' => '/* testClassPropPublic */',
+ 'expected' => true,
],
'class-property-var' => [
- '/* testClassPropVar */',
- true,
+ 'testMarker' => '/* testClassPropVar */',
+ 'expected' => true,
],
'class-property-static-protected' => [
- '/* testClassPropStaticProtected */',
- true,
+ 'testMarker' => '/* testClassPropStaticProtected */',
+ 'expected' => true,
],
'method-param' => [
- '/* testMethodParameter */',
- false,
+ 'testMarker' => '/* testMethodParameter */',
+ 'expected' => false,
],
'method-local-var' => [
- '/* testMethodLocalVar */',
- false,
+ 'testMarker' => '/* testMethodLocalVar */',
+ 'expected' => false,
],
'anon-class-property-private' => [
- '/* testAnonClassPropPrivate */',
- true,
+ 'testMarker' => '/* testAnonClassPropPrivate */',
+ 'expected' => true,
],
'anon-class-method-param' => [
- '/* testAnonMethodParameter */',
- false,
+ 'testMarker' => '/* testAnonMethodParameter */',
+ 'expected' => false,
],
'anon-class-method-local-var' => [
- '/* testAnonMethodLocalVar */',
- false,
+ 'testMarker' => '/* testAnonMethodLocalVar */',
+ 'expected' => false,
],
'interface-property' => [
- '/* testInterfaceProp */',
- false,
+ 'testMarker' => '/* testInterfaceProp */',
+ 'expected' => false,
],
'interface-method-param' => [
- '/* testInterfaceMethodParameter */',
- false,
+ 'testMarker' => '/* testInterfaceMethodParameter */',
+ 'expected' => false,
],
'trait-property' => [
- '/* testTraitProp */',
- true,
+ 'testMarker' => '/* testTraitProp */',
+ 'expected' => true,
],
'trait-method-param' => [
- '/* testTraitMethodParameter */',
- false,
+ 'testMarker' => '/* testTraitMethodParameter */',
+ 'expected' => false,
],
'class-multi-property-1' => [
- '/* testClassMultiProp1 */',
- true,
+ 'testMarker' => '/* testClassMultiProp1 */',
+ 'expected' => true,
],
'class-multi-property-2' => [
- '/* testClassMultiProp2 */',
- true,
+ 'testMarker' => '/* testClassMultiProp2 */',
+ 'expected' => true,
],
'class-multi-property-3' => [
- '/* testClassMultiProp3 */',
- true,
+ 'testMarker' => '/* testClassMultiProp3 */',
+ 'expected' => true,
],
'global-var-obj-access' => [
- '/* testGlobalVarObj */',
- false,
+ 'testMarker' => '/* testGlobalVarObj */',
+ 'expected' => false,
],
'nested-anon-class-property' => [
- '/* testNestedAnonClassProp */',
- true,
+ 'testMarker' => '/* testNestedAnonClassProp */',
+ 'expected' => true,
],
'double-nested-anon-class-property' => [
- '/* testDoubleNestedAnonClassProp */',
- true,
+ 'testMarker' => '/* testDoubleNestedAnonClassProp */',
+ 'expected' => true,
],
'double-nested-anon-class-method-param' => [
- '/* testDoubleNestedAnonClassMethodParameter */',
- false,
+ 'testMarker' => '/* testDoubleNestedAnonClassMethodParameter */',
+ 'expected' => false,
],
'double-nested-anon-class-method-local-var' => [
- '/* testDoubleNestedAnonClassMethodLocalVar */',
- false,
+ 'testMarker' => '/* testDoubleNestedAnonClassMethodLocalVar */',
+ 'expected' => false,
],
'function-call-param' => [
- '/* testFunctionCallParameter */',
- false,
+ 'testMarker' => '/* testFunctionCallParameter */',
+ 'expected' => false,
+ ],
+ 'enum-property' => [
+ 'testMarker' => '/* testEnumProp */',
+ 'expected' => false,
+ ],
+ 'enum-method-param' => [
+ 'testMarker' => '/* testEnumMethodParameter */',
+ 'expected' => false,
],
];
}
diff --git a/Tests/Utils/TextStrings/GetCompleteTextStringTest.inc b/Tests/Utils/TextStrings/GetCompleteTextStringTest.inc
index a425ac4e..1fd52e64 100644
--- a/Tests/Utils/TextStrings/GetCompleteTextStringTest.inc
+++ b/Tests/Utils/TextStrings/GetCompleteTextStringTest.inc
@@ -43,6 +43,18 @@ third line
fourth line
EOD;
+/* testMultipleProblemEmbedsInSingleLineDoubleQuotedString */
+echo "My ${foo["${bar}"]} and ${foo["${bar['baz']}"]} and also ${foo->{"${'a'}"}}";
+
+/* testProblemEmbedAtEndOfLineInMultiLineDoubleQuotedString */
+echo "Testing ${foo["${bar['baz']}"]}
+and more ${foo["${bar}"]} testing";
+
+/* testMultilineProblemEmbedInMultiLineDoubleQuotedString */
+echo "Testing ${foo["${bar
+ ['baz']
+}"]} and more testing";
+
/* testTextStringAtEndOfFile */
// This has to be the last test in the file without a new line after it.
echo 'first line
diff --git a/Tests/Utils/TextStrings/GetCompleteTextStringTest.php b/Tests/Utils/TextStrings/GetCompleteTextStringTest.php
index 0a8bc022..5a80ee38 100644
--- a/Tests/Utils/TextStrings/GetCompleteTextStringTest.php
+++ b/Tests/Utils/TextStrings/GetCompleteTextStringTest.php
@@ -10,19 +10,22 @@
namespace PHPCSUtils\Tests\Utils\TextStrings;
+use PHPCSUtils\Internal\Cache;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
use PHPCSUtils\Utils\TextStrings;
/**
- * Tests for the \PHPCSUtils\Utils\TextStrings::getCompleteTextString() method.
+ * Tests for the \PHPCSUtils\Utils\TextStrings::getCompleteTextString() and
+ * \PHPCSUtils\Utils\TextStrings::getEndOfCompleteTextString() methods.
*
* @covers \PHPCSUtils\Utils\TextStrings::getCompleteTextString
+ * @covers \PHPCSUtils\Utils\TextStrings::getEndOfCompleteTextString
*
* @group textstrings
*
* @since 1.0.0
*/
-class GetCompleteTextStringTest extends UtilityMethodTestCase
+final class GetCompleteTextStringTest extends UtilityMethodTestCase
{
/**
@@ -40,24 +43,32 @@ class GetCompleteTextStringTest extends UtilityMethodTestCase
/**
* Test passing a non-existent token pointer.
*
+ * @dataProvider dataExceptions
+ *
+ * @param string $method The name of the method to test the exception for.
+ *
* @return void
*/
- public function testNonExistentToken()
+ public function testNonExistentToken($method)
{
$this->expectPhpcsException(
'$stackPtr must be of type T_START_HEREDOC, T_START_NOWDOC, T_CONSTANT_ENCAPSED_STRING'
. ' or T_DOUBLE_QUOTED_STRING'
);
- TextStrings::getCompleteTextString(self::$phpcsFile, 100000);
+ TextStrings::$method(self::$phpcsFile, 100000);
}
/**
* Test receiving an expected exception when a non text string is passed.
*
+ * @dataProvider dataExceptions
+ *
+ * @param string $method The name of the method to test the exception for.
+ *
* @return void
*/
- public function testNotATextStringException()
+ public function testNotATextStringException($method)
{
$this->expectPhpcsException(
'$stackPtr must be of type T_START_HEREDOC, T_START_NOWDOC, T_CONSTANT_ENCAPSED_STRING'
@@ -65,16 +76,20 @@ public function testNotATextStringException()
);
$next = $this->getTargetToken('/* testNotATextString */', \T_RETURN);
- TextStrings::getCompleteTextString(self::$phpcsFile, $next);
+ TextStrings::$method(self::$phpcsFile, $next);
}
/**
* Test receiving an expected exception when a text string token is not the first token
* of a multi-line text string.
*
+ * @dataProvider dataExceptions
+ *
+ * @param string $method The name of the method to test the exception for.
+ *
* @return void
*/
- public function testNotFirstTextStringException()
+ public function testNotFirstTextStringException($method)
{
$this->expectPhpcsException('$stackPtr must be the start of the text string');
@@ -84,7 +99,20 @@ public function testNotFirstTextStringException()
'second line
'
);
- TextStrings::getCompleteTextString(self::$phpcsFile, $next);
+ TextStrings::$method(self::$phpcsFile, $next);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function dataExceptions()
+ {
+ return [
+ 'getCompleteTextString' => ['getCompleteTextString'],
+ 'getEndOfCompleteTextString' => ['getEndOfCompleteTextString'],
+ ];
}
/**
@@ -120,66 +148,120 @@ public function dataGetCompleteTextString()
{
return [
'single-line-constant-encapsed-string' => [
- '/* testSingleLineConstantEncapsedString */',
- 'single line text string',
- "'single line text string'",
+ 'testMarker' => '/* testSingleLineConstantEncapsedString */',
+ 'expected' => 'single line text string',
+ 'expectedWithQuotes' => "'single line text string'",
],
'multi-line-constant-encapsed-string' => [
- '/* testMultiLineConstantEncapsedString */',
- 'first line
+ 'testMarker' => '/* testMultiLineConstantEncapsedString */',
+ 'expected' => 'first line
second line
third line
fourth line',
- '"first line
+ 'expectedWithQuotes' => '"first line
second line
third line
fourth line"',
],
'single-line-double-quoted-string' => [
- '/* testSingleLineDoubleQuotedString */',
- 'single $line text string',
- '"single $line text string"',
+ 'testMarker' => '/* testSingleLineDoubleQuotedString */',
+ 'expected' => 'single $line text string',
+ 'expectedWithQuotes' => '"single $line text string"',
],
'multi-line-double-quoted-string' => [
- '/* testMultiLineDoubleQuotedString */',
- 'first line
+ 'testMarker' => '/* testMultiLineDoubleQuotedString */',
+ 'expected' => 'first line
second $line
third line
fourth line',
- '"first line
+ 'expectedWithQuotes' => '"first line
second $line
third line
fourth line"',
],
'heredoc' => [
- '/* testHeredocString */',
- 'first line
+ 'testMarker' => '/* testHeredocString */',
+ 'expected' => 'first line
second $line
third line
fourth line',
- 'first line
+ 'expectedWithQuotes' => 'first line
second $line
third line
fourth line',
],
'nowdoc' => [
- '/* testNowdocString */',
- 'first line
+ 'testMarker' => '/* testNowdocString */',
+ 'expected' => 'first line
second line
third line
fourth line',
- 'first line
+ 'expectedWithQuotes' => 'first line
second line
third line
fourth line',
],
+
+ 'Single line double quoted string containing problem embeds' => [
+ 'testMarker' => '/* testMultipleProblemEmbedsInSingleLineDoubleQuotedString */',
+ 'expected' =>
+ 'My ${foo["${bar}"]} and ${foo["${bar[\'baz\']}"]} and also ${foo->{"${\'a\'}"}}',
+ 'expectedWithQuotes' =>
+ '"My ${foo["${bar}"]} and ${foo["${bar[\'baz\']}"]} and also ${foo->{"${\'a\'}"}}"',
+ ],
+ 'Multi-line double quoted string containing problem embeds' => [
+ 'testMarker' => '/* testProblemEmbedAtEndOfLineInMultiLineDoubleQuotedString */',
+ 'expected' => 'Testing ${foo["${bar[\'baz\']}"]}
+and more ${foo["${bar}"]} testing',
+ 'expectedWithQuotes' => '"Testing ${foo["${bar[\'baz\']}"]}
+and more ${foo["${bar}"]} testing"',
+ ],
+ 'Multi-line double quoted string containing multi-line problem embed' => [
+ 'testMarker' => '/* testMultilineProblemEmbedInMultiLineDoubleQuotedString */',
+ 'expected' => 'Testing ${foo["${bar
+ [\'baz\']
+}"]} and more testing',
+ 'expectedWithQuotes' => '"Testing ${foo["${bar
+ [\'baz\']
+}"]} and more testing"',
+ ],
+
'text-string-at-end-of-file' => [
- '/* testTextStringAtEndOfFile */',
- 'first line
+ 'testMarker' => '/* testTextStringAtEndOfFile */',
+ 'expected' => 'first line
last line',
- "'first line
+ 'expectedWithQuotes' => "'first line
last line'",
],
];
}
+
+ /**
+ * Verify that the build-in caching is used when caching is enabled.
+ *
+ * @return void
+ */
+ public function testResultIsCached()
+ {
+ $methodName = 'PHPCSUtils\\Utils\\TextStrings::getEndOfCompleteTextString';
+ $stackPtr = $this->getTargetToken('/* testMultiLineDoubleQuotedString */', $this->targets);
+ $expected = $stackPtr + 3;
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = TextStrings::getEndOfCompleteTextString(self::$phpcsFile, $stackPtr);
+ $isCached = Cache::isCached(self::$phpcsFile, $methodName, $stackPtr);
+ $resultSecondRun = TextStrings::getEndOfCompleteTextString(self::$phpcsFile, $stackPtr);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertSame($expected, $resultFirstRun, 'First result did not match expectation');
+ $this->assertTrue($isCached, 'Cache::isCached() could not find the cached value');
+ $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+ }
}
diff --git a/Tests/Utils/TextStrings/GetEndOfCompleteTextStringTest.inc b/Tests/Utils/TextStrings/GetEndOfCompleteTextStringTest.inc
new file mode 100644
index 00000000..b9890ed8
--- /dev/null
+++ b/Tests/Utils/TextStrings/GetEndOfCompleteTextStringTest.inc
@@ -0,0 +1,68 @@
+bar";
+/* testProperty2 */
+"{$foo->bar}";
+
+/* testMethod1 */
+"{$foo->bar()}";
+
+/* testClosure1 */
+"{$foo()}";
+
+/* testChain1 */
+"{$foo['bar']->baz()()}";
+
+/* testVariableVar1 */
+"${$bar}";
+/* testVariableVar2 */
+"${(foo)}";
+/* testVariableVar3 */
+"${foo->bar}";
+
+/* testNested1 */
+"${foo["${bar}"]}";
+/* testNested2 */
+"${foo["${bar['baz']}"]}";
+/* testNested3 */
+"${foo->{$baz}}";
+/* testNested4 */
+"${foo->{${'a'}}}";
+/* testNested5 */
+"${foo->{"${'a'}"}}";
+
+/* testNestedWithCurliesWithinPlainTokens */
+"${foo["${bar['b{a}z']}"]}";
+
+/* testMultipleProblemEmbedsInSingleLineString */
+"My ${foo["${bar}"]} and ${foo["${bar['baz']}"]} and ${foo->{"${'a'}"}}";
+
+/* testProblemEmbedAtEndOfLineInMultiLineString */
+"Testing ${foo["${bar['baz']}"]}
+and more testing";
+
+/* testMultilineProblemEmbedInMultiLineString */
+"Testing ${foo["${bar
+ ['baz']
+}"]} and more testing";
+
+/* testParseError */
+"${foo["${bar
diff --git a/Tests/Utils/TextStrings/GetEndOfCompleteTextStringTest.php b/Tests/Utils/TextStrings/GetEndOfCompleteTextStringTest.php
new file mode 100644
index 00000000..f16d3053
--- /dev/null
+++ b/Tests/Utils/TextStrings/GetEndOfCompleteTextStringTest.php
@@ -0,0 +1,164 @@
+getTargetToken($testMarker, \T_DOUBLE_QUOTED_STRING);
+ $result = TextStrings::getEndOfCompleteTextString(self::$phpcsFile, $stackPtr);
+
+ $this->assertSame($expectedContent, GetTokensAsString::normal(self::$phpcsFile, $stackPtr, $result));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testGetEndOfDoubleQuotedString() For the array format.
+ *
+ * @return array
+ */
+ public function dataGetEndOfDoubleQuotedString()
+ {
+ return [
+ 'Simple embedded variable 1' => [
+ 'testMarker' => '/* testSimple1 */',
+ 'expectedContent' => '"$foo"',
+ ],
+ 'Simple embedded variable 2' => [
+ 'testMarker' => '/* testSimple2 */',
+ 'expectedContent' => '"{$foo}"',
+ ],
+ 'Simple embedded variable 3' => [
+ 'testMarker' => '/* testSimple3 */',
+ 'expectedContent' => '"${foo}"',
+ ],
+ 'Embedded array access 1' => [
+ 'testMarker' => '/* testDIM1 */',
+ 'expectedContent' => '"$foo[bar]"',
+ ],
+ 'Embedded array access 2' => [
+ 'testMarker' => '/* testDIM2 */',
+ 'expectedContent' => '"{$foo[\'bar\']}"',
+ ],
+ 'Embedded array access 3' => [
+ 'testMarker' => '/* testDIM3 */',
+ 'expectedContent' => '"${foo[\'bar\']}"',
+ ],
+ 'Embedded property access 1' => [
+ 'testMarker' => '/* testProperty1 */',
+ 'expectedContent' => '"$foo->bar"',
+ ],
+ 'Embedded property access 2' => [
+ 'testMarker' => '/* testProperty2 */',
+ 'expectedContent' => '"{$foo->bar}"',
+ ],
+ 'Embedded method call 1' => [
+ 'testMarker' => '/* testMethod1 */',
+ 'expectedContent' => '"{$foo->bar()}"',
+ ],
+ 'Embedded closure call 1' => [
+ 'testMarker' => '/* testClosure1 */',
+ 'expectedContent' => '"{$foo()}"',
+ ],
+ 'Embedded chained array access -> method call -> call' => [
+ 'testMarker' => '/* testChain1 */',
+ 'expectedContent' => '"{$foo[\'bar\']->baz()()}"',
+ ],
+ 'Embedded variable variable 1' => [
+ 'testMarker' => '/* testVariableVar1 */',
+ 'expectedContent' => '"${$bar}"',
+ ],
+ 'Embedded variable variable 2' => [
+ 'testMarker' => '/* testVariableVar2 */',
+ 'expectedContent' => '"${(foo)}"',
+ ],
+ 'Embedded variable variable 3' => [
+ 'testMarker' => '/* testVariableVar3 */',
+ 'expectedContent' => '"${foo->bar}"',
+ ],
+ 'Embedded nested variable variable 1' => [
+ 'testMarker' => '/* testNested1 */',
+ 'expectedContent' => '"${foo["${bar}"]}"',
+ ],
+ 'Embedded nested variable variable 2' => [
+ 'testMarker' => '/* testNested2 */',
+ 'expectedContent' => '"${foo["${bar[\'baz\']}"]}"',
+ ],
+ 'Embedded nested variable variable 3' => [
+ 'testMarker' => '/* testNested3 */',
+ 'expectedContent' => '"${foo->{$baz}}"',
+ ],
+ 'Embedded nested variable variable 4' => [
+ 'testMarker' => '/* testNested4 */',
+ 'expectedContent' => '"${foo->{${\'a\'}}}"',
+ ],
+ 'Embedded nested variable variable 5' => [
+ 'testMarker' => '/* testNested5 */',
+ 'expectedContent' => '"${foo->{"${\'a\'}"}}"',
+ ],
+ 'Embedded nested variable variable 2 with curlies within plain token' => [
+ 'testMarker' => '/* testNestedWithCurliesWithinPlainTokens */',
+ 'expectedContent' => '"${foo["${bar[\'b{a}z\']}"]}"',
+ ],
+ 'Multiple problem embeds in single line text string' => [
+ 'testMarker' => '/* testMultipleProblemEmbedsInSingleLineString */',
+ 'expectedContent' => '"My ${foo["${bar}"]} and ${foo["${bar[\'baz\']}"]} and ${foo->{"${\'a\'}"}}"',
+ ],
+ 'Problem embed at end of line in multi-line text string' => [
+ 'testMarker' => '/* testProblemEmbedAtEndOfLineInMultiLineString */',
+ 'expectedContent' => '"Testing ${foo["${bar[\'baz\']}"]}
+and more testing"',
+ ],
+ 'Multi-line problem embed in multi-line text string' => [
+ 'testMarker' => '/* testMultilineProblemEmbedInMultiLineString */',
+ 'expectedContent' => '"Testing ${foo["${bar
+ [\'baz\']
+}"]} and more testing"',
+ ],
+
+ 'Parse error at end of file' => [
+ 'testMarker' => '/* testParseError */',
+ 'expectedContent' => '"${foo["${bar
+',
+ ],
+ ];
+ }
+}
diff --git a/Tests/Utils/TextStrings/InterpolatedVariablesTest.php b/Tests/Utils/TextStrings/InterpolatedVariablesTest.php
new file mode 100644
index 00000000..5e590f62
--- /dev/null
+++ b/Tests/Utils/TextStrings/InterpolatedVariablesTest.php
@@ -0,0 +1,617 @@
+
+ */
+ private $embeds = [
+ // Simple.
+ '$foo',
+ '{$foo}',
+ '${foo}',
+
+ // DIM.
+ '$foo[2]',
+ '$foo[-12]',
+ '{$foo[0]}',
+ '${foo[132]}',
+ '$foo[bar]',
+ '{$foo[\'bar\']}',
+ '${foo[\'bar\']}',
+ '{$foo[8][35]}',
+ '{$foo[10][\'bar\']}',
+ '{$foo[\'bar\'][\'baz\']}',
+ '{$foo[\'bar\'][12]}',
+
+ // Property.
+ '$foo->bar',
+ '{$foo->bar}',
+ '$foo?->bar',
+ '{$foo?->bar}',
+ '{${beers::$ale}}',
+ '${beers::$ale}',
+
+ // Class constant.
+ '{${beers::softdrink}}',
+ '${beers::softdrink}',
+
+ // Method.
+ '{$foo->bar()}',
+ '{$foo?->bar()}',
+ '{${$object->getName()}}',
+ '{${$object?->getName()}}',
+
+ // Closure/Function call.
+ '{$foo()}',
+ '{${getName()}}',
+ '{${getName( $test )}}',
+ '{${getName( \'abc\' )}}',
+ '${substr(\'laruence\', 0, 2)}',
+
+ // Chain.
+ '{$foo[42]->baz()()}',
+ '{$foo[\'bar\']->baz()()}',
+ '{$foo[42]?->baz()()}',
+ '{$foo[\'bar\']?->baz()()}',
+ '{$obj->values[3]->name}',
+ '{$obj->values[5]?->name}',
+
+ // Variable variables.
+ '${$bar}',
+ '{$$bar}',
+ '${(foo)}',
+ '${foo->bar}',
+ '{$foo->$bar}',
+ '{$foo?->$bar}',
+
+ // Nested.
+ '${foo["${bar}"]}',
+ '${foo["${ba23}"]}',
+ '${foo["${bar[3]}"]}',
+ '${foo["${bar[\'baz\']}"]}',
+ '${foo->{$baz}}',
+ '${foo->{${\'a\'}}}',
+ '${foo->{"${\'a\'}"}}',
+ '${foo?->{$baz}}',
+ '${foo?->{${\'a\'}}}',
+ '${foo?->{"${\'a\'}"}}',
+ '{$foo->{$baz[1]}}',
+
+ // Using non-ascii UTF8 variable names.
+ '$IÑTËRNÂTÎÔNÀLÍŽÆTIØN',
+ '${IÑTËRNÂTÎÔNÀLÍŽÆTIØN}',
+ '$Iñtërnâtîônàlížætiøn[nât]',
+ '$Iñtërnâtîônàlížætiøn?->îôn',
+ '$МояРабота',
+ '${$МояРабота}',
+ '$💟',
+ '$💟[◾]',
+ '$😝->🤞',
+ ];
+
+ /**
+ * Collections of phrases to use during the test.
+ *
+ * Phrases used will be selected at random.
+ *
+ * @var array
+ */
+ private $phrases = [
+ 'single line' => "%s this is nonsense %s\tbut that's not the point %s",
+ 'single line, embed followed by non-space 1' => '%s- dash %s+ plus %s',
+ 'single line, embed followed by non-space 2' => '%s. dash %s= plus %s',
+ 'single line, embed followed by non-space 3' => '%s` dash %s%% plus %s',
+ 'single line, embed followed by non-space 4' => '%s\\ dash %s) plus %s',
+ 'single line, embed followed by non-space 5' => '%s] dash %s} plus %s',
+ 'single line, embed followed by non-space 6' => '%s\' dash %s# plus %s',
+ 'single line, contains escaped non-embed 1' => '%s this {\$name} foo %s but that\'s \$mane[not] the point %s',
+ 'single line, contains escaped non-embed 2' => '%s this $\{name} foo %s but that\'s \$mane->not the point %s',
+ 'multi line' => "%s this is\nnonsense %s but\nthat's not the point %s",
+ 'multi line, empty first line' => "\n%s this is\nnonsense %s but\nthat's not the point %s",
+ 'multi line, empty last line' => "%s this is\nnonsense %s but\nthat's not the point %s\n",
+ ];
+
+ /**
+ * Test getting embedded variables and expressions from an arbitrary text string.
+ *
+ * @dataProvider dataEmbedsInPhrases
+ *
+ * @param string $input The input string.
+ * @param array $expected The expected function output of the respective functions.
+ *
+ * @return void
+ */
+ public function testGetEmbeds($input, $expected)
+ {
+ $this->assertSame($expected['get'], \array_values(TextStrings::getEmbeds($input)));
+ }
+
+ /**
+ * Test getting embedded variables and expressions from an arbitrary text string and verify the offset
+ * at which the embed was found is correctly set as well.
+ *
+ * @dataProvider dataEscaping
+ * @dataProvider dataSpecificCases
+ *
+ * @param string $input The input string.
+ * @param array $expected The expected function output of the respective functions.
+ *
+ * @return void
+ */
+ public function testGetEmbedsAndCheckOffset($input, $expected)
+ {
+ $this->assertSame($expected['get'], TextStrings::getEmbeds($input));
+ }
+
+ /**
+ * Test stripping embedded variables and expressions from an arbitrary text string.
+ *
+ * @dataProvider dataEmbedsInPhrases
+ * @dataProvider dataEscaping
+ * @dataProvider dataSpecificCases
+ *
+ * @param string $input The input string.
+ * @param array $expected The expected function output of the respective functions.
+ *
+ * @return void
+ */
+ public function testStripEmbeds($input, $expected)
+ {
+ $this->assertSame($expected['stripped'], TextStrings::stripEmbeds($input));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testGetEmbeds() For the array format.
+ * @see testStripEmbeds() For the array format.
+ *
+ * @return array
+ */
+ public function dataEmbedsInPhrases()
+ {
+ $data = [];
+ foreach ($this->embeds as $embed) {
+ $data[$embed . '| Plain embed (heredoc)'] = [
+ 'input' => $embed,
+ 'expected' => [
+ 'get' => [$embed],
+ 'stripped' => '',
+ ],
+ ];
+ $data[$embed . '| Double quoted embed'] = [
+ 'input' => '"' . $embed . '"',
+ 'expected' => [
+ 'get' => [$embed],
+ 'stripped' => '""',
+ ],
+ ];
+
+ // Plain, no double quotes (heredoc).
+ $phraseKey = \array_rand($this->phrases);
+ $dataKey = $embed . '| Embed at start of plain phrase in: ' . $phraseKey;
+ $data[$dataKey] = [
+ 'input' => \sprintf($this->phrases[$phraseKey], $embed, '', ''),
+ 'expected' => [
+ 'get' => [$embed],
+ 'stripped' => \sprintf($this->phrases[$phraseKey], '', '', ''),
+ ],
+ ];
+
+ $phraseKey = \array_rand($this->phrases);
+ $dataKey = $embed . '| Embed in middle of plain phrase in: ' . $phraseKey;
+ $data[$dataKey] = [
+ 'input' => \sprintf($this->phrases[$phraseKey], '', $embed, ''),
+ 'expected' => [
+ 'get' => [$embed],
+ 'stripped' => \sprintf($this->phrases[$phraseKey], '', '', ''),
+ ],
+ ];
+
+ $phraseKey = \array_rand($this->phrases);
+ $dataKey = $embed . '| Embed at end of plain phrase in: ' . $phraseKey;
+ $data[$dataKey] = [
+ 'input' => \sprintf($this->phrases[$phraseKey], '', '', $embed),
+ 'expected' => [
+ 'get' => [$embed],
+ 'stripped' => \sprintf($this->phrases[$phraseKey], '', '', ''),
+ ],
+ ];
+
+ // Phrase in double quotes.
+ $phraseKey = \array_rand($this->phrases);
+ $dataKey = $embed . '| Embed at start of quoted phrase in: ' . $phraseKey;
+ $data[$dataKey] = [
+ 'input' => '"' . \sprintf($this->phrases[$phraseKey], $embed, '', '') . '"',
+ 'expected' => [
+ 'get' => [$embed],
+ 'stripped' => '"' . \sprintf($this->phrases[$phraseKey], '', '', '') . '"',
+ ],
+ ];
+
+ $phraseKey = \array_rand($this->phrases);
+ $dataKey = $embed . '| Embed in middle of quoted phrase in: ' . $phraseKey;
+ $data[$dataKey] = [
+ 'input' => '"' . \sprintf($this->phrases[$phraseKey], '', $embed, '') . '"',
+ 'expected' => [
+ 'get' => [$embed],
+ 'stripped' => '"' . \sprintf($this->phrases[$phraseKey], '', '', '') . '"',
+ ],
+ ];
+
+ $phraseKey = \array_rand($this->phrases);
+ $dataKey = $embed . '| Embed at end of quoted phrase in: ' . $phraseKey;
+ $data[$dataKey] = [
+ 'input' => '"' . \sprintf($this->phrases[$phraseKey], '', '', $embed) . '"',
+ 'expected' => [
+ 'get' => [$embed],
+ 'stripped' => '"' . \sprintf($this->phrases[$phraseKey], '', '', '') . '"',
+ ],
+ ];
+ }
+
+ return $data;
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testGetEmbedsAndCheckOffset() For the array format.
+ * @see testStripEmbeds() For the array format.
+ *
+ * @return array
+ */
+ public function dataEscaping()
+ {
+ $embedAtEnd = '"Foo: %s%s"';
+ $embedAtStart = '%s%s Foo'; // Not, no double quotes!
+ $data = [];
+
+ for ($i = 0; $i < 10; $i++) {
+ $escaped = (($i % 2) !== 0);
+ $slashes = \str_repeat('\\', $i);
+ $offset = 6 + $i;
+
+ $dataKey = "Escaping handling test, embed at start: slashes before \$ - $i slashes = ";
+ $dataKey .= ($escaped === true) ? 'escaped' : 'not escaped';
+ $data[$dataKey] = [
+ 'input' => \sprintf($embedAtStart, $slashes, '$foo'),
+ 'expected' => [
+ 'get' => ($escaped === true) ? [] : [$i => '$foo'],
+ 'stripped' => ($escaped === true)
+ ? \sprintf($embedAtStart, $slashes, '$foo')
+ : \sprintf($embedAtStart, $slashes, ''),
+ ],
+ ];
+
+ $dataKey = "Escaping handling test, embed at start: slashes before { - $i slashes = ";
+ $dataKey .= ($escaped === true) ? 'escaped' : 'not escaped';
+ $data[$dataKey] = [
+ 'input' => \sprintf($embedAtStart, $slashes, '{$foo}'),
+ 'expected' => [
+ 'get' => ($escaped === true) ? [($i + 1) => '$foo'] : [$i => '{$foo}'],
+ 'stripped' => ($escaped === true)
+ ? \sprintf($embedAtStart, $slashes, '{}')
+ : \sprintf($embedAtStart, $slashes, ''),
+ ],
+ ];
+
+ $dataKey = "Escaping handling test, embed at end: slashes before \$ - $i slashes = ";
+ $dataKey .= ($escaped === true) ? 'escaped' : 'not escaped';
+ $data[$dataKey] = [
+ 'input' => \sprintf($embedAtEnd, $slashes, '$foo'),
+ 'expected' => [
+ 'get' => ($escaped === true) ? [] : [$offset => '$foo'],
+ 'stripped' => ($escaped === true)
+ ? \sprintf($embedAtEnd, $slashes, '$foo')
+ : \sprintf($embedAtEnd, $slashes, ''),
+ ],
+ ];
+
+ $dataKey = "Escaping handling test, embed at end: slashes before { - $i slashes = ";
+ $dataKey .= ($escaped === true) ? 'escaped' : 'not escaped';
+ $data[$dataKey] = [
+ 'input' => \sprintf($embedAtEnd, $slashes, '{$foo}'),
+ 'expected' => [
+ 'get' => ($escaped === true) ? [($offset + 1) => '$foo'] : [$offset => '{$foo}'],
+ 'stripped' => ($escaped === true)
+ ? \sprintf($embedAtEnd, $slashes, '{}')
+ : \sprintf($embedAtEnd, $slashes, ''),
+ ],
+ ];
+ }
+
+ return $data;
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testGetEmbedsAndCheckOffset() For the array format.
+ * @see testStripEmbeds() For the array format.
+ *
+ * @return array
+ */
+ public function dataSpecificCases()
+ {
+ return [
+ // No embeds.
+ 'Text string without any embeds' => [
+ 'input' => '"He drank some orange juice."',
+ 'expected' => [
+ 'get' => [],
+ 'stripped' => '"He drank some orange juice."',
+ ],
+ ],
+ 'Text string without any valid embeds - not a valid variable name 1' => [
+ 'input' => '"He drank some orange $--."',
+ 'expected' => [
+ 'get' => [],
+ 'stripped' => '"He drank some orange $--."',
+ ],
+ ],
+ 'Text string without any valid embeds - not a valid variable name 2' => [
+ 'input' => '"He drank some orange $\name."',
+ 'expected' => [
+ 'get' => [],
+ 'stripped' => '"He drank some orange $\name."',
+ ],
+ ],
+
+ // Variations on embeds not tested via the above generated test cases.
+ 'No braces, one character variable name' => [
+ 'input' => '"This is $g"',
+ 'expected' => [
+ 'get' => [
+ 9 => '$g',
+ ],
+ 'stripped' => '"This is "',
+ ],
+ ],
+ 'Wrappped in outer braces with space between brace and dollar' => [
+ 'input' => '"This is { $great}"',
+ 'expected' => [
+ 'get' => [
+ 11 => '$great',
+ ],
+ 'stripped' => '"This is { }"',
+ ],
+ ],
+
+ 'Text string containing multiple embeds 1' => [
+ 'input' => '"$people->john drank some $juices[0] juice."',
+ 'expected' => [
+ 'get' => [
+ 1 => '$people->john',
+ 26 => '$juices[0]',
+ ],
+ 'stripped' => '" drank some juice."',
+ ],
+ ],
+ 'Text string containing multiple embeds 2' => [
+ 'input' => '"$people->john then said hello to $people->jane."',
+ 'expected' => [
+ 'get' => [
+ 1 => '$people->john',
+ 34 => '$people->jane',
+ ],
+ 'stripped' => '" then said hello to ."',
+ ],
+ ],
+ 'Text string containing multiple embeds 3' => [
+ 'input' => '"$people->john\'s wife greeted $people->robert."',
+ 'expected' => [
+ 'get' => [
+ 1 => '$people->john',
+ // Note: the backslash escaping the ' will be removed, so doesn't count for offset.
+ 30 => '$people->robert',
+ ],
+ 'stripped' => '"\'s wife greeted ."',
+ ],
+ ],
+ 'Text string containing multiple embeds 4' => [
+ 'input' => '"This is the value of the var named $name: {${$name}}"',
+ 'expected' => [
+ 'get' => [
+ 36 => '$name',
+ 43 => '{${$name}}',
+ ],
+ 'stripped' => '"This is the value of the var named : "',
+ ],
+ ],
+ 'Text string containing multiple embeds 5 (nothing between embeds, plain)' => [
+ 'input' => '"This is the value of the var named $name$name"',
+ 'expected' => [
+ 'get' => [
+ 36 => '$name',
+ 41 => '$name',
+ ],
+ 'stripped' => '"This is the value of the var named "',
+ ],
+ ],
+ 'Text string containing multiple embeds 6 (nothing between embeds, outer braces)' => [
+ 'input' => '"This is the value of the var named {$name}{$name}"',
+ 'expected' => [
+ 'get' => [
+ 36 => '{$name}',
+ 43 => '{$name}',
+ ],
+ 'stripped' => '"This is the value of the var named "',
+ ],
+ ],
+ 'Text string containing multiple embeds 7 (nothing between embeds, inner braces)' => [
+ 'input' => '"This is the value of the var named ${name}${name}"',
+ 'expected' => [
+ 'get' => [
+ 36 => '${name}',
+ 43 => '${name}',
+ ],
+ 'stripped' => '"This is the value of the var named "',
+ ],
+ ],
+ 'Text string containing multiple embeds 8 (nothing between embeds, mixed)' => [
+ 'input' => '"This is the value of the var named $name${name}{$name}"',
+ 'expected' => [
+ 'get' => [
+ 36 => '$name',
+ 41 => '${name}',
+ 48 => '{$name}',
+ ],
+ 'stripped' => '"This is the value of the var named "',
+ ],
+ ],
+
+ // These can't be tested via the generated code as it won't work without braces.
+ 'Embed without braces, variable variable will not work' => [
+ 'input' => '"$$bar"',
+ 'expected' => [
+ 'get' => [
+ 2 => '$bar',
+ ],
+ 'stripped' => '"$"',
+ ],
+ ],
+ 'Embed in outer braces followed by number' => [
+ 'input' => '"This square is {$square->width}00 centimeters broad."',
+ 'expected' => [
+ 'get' => [
+ 16 => '{$square->width}',
+ ],
+ 'stripped' => '"This square is 00 centimeters broad."',
+ ],
+ ],
+ 'Embed in inner braces followed by number' => [
+ 'input' => '"This square is ${square->width}00 centimeters broad."',
+ 'expected' => [
+ 'get' => [
+ 16 => '${square->width}',
+ ],
+ 'stripped' => '"This square is 00 centimeters broad."',
+ ],
+ ],
+ 'Without braces, multi-level array access does not work' => [
+ 'input' => '"This works: {$arr[4][3]}, but this doesn\'t: $arr[3][4]"',
+ 'expected' => [
+ 'get' => [
+ 13 => '{$arr[4][3]}',
+ // Note: the backslash escaping the ' will be removed, so doesn't count for offset.
+ 45 => '$arr[3]',
+ ],
+ 'stripped' => '"This works: , but this doesn\'t: [4]"',
+ ],
+ ],
+ 'Without braces, multi-level property access does not work' => [
+ 'input' => '"This works: {$obj->prop->key}, but this doesn\'t: $obj->prop->key"',
+ 'expected' => [
+ 'get' => [
+ 13 => '{$obj->prop->key}',
+ // Note: the backslash escaping the ' will be removed, so doesn't count for offset.
+ 50 => '$obj->prop',
+ ],
+ 'stripped' => '"This works: , but this doesn\'t: ->key"',
+ ],
+ ],
+ 'Embed in braces, multi-level array access, string key missing quotes' => [
+ 'input' => '"This interprets the key foo as a constant: {$arr[foo][3]}"',
+ 'expected' => [
+ 'get' => [
+ 44 => '{$arr[foo][3]}',
+ ],
+ 'stripped' => '"This interprets the key foo as a constant: "',
+ ],
+ ],
+
+ // Multi-line expressions.
+ 'Embed in dollar brace, multi-line expression' => [
+ 'input' => '"Testing ${foo["${bar
+ [\'baz\']
+}"]} and more testing"',
+ 'expected' => [
+ 'get' => [
+ 9 => '${foo["${bar
+ [\'baz\']
+}"]}',
+ ],
+ 'stripped' => '"Testing and more testing"',
+ ],
+ ],
+ 'Embed in braces, multi-line expression' => [
+ 'input' => '"Testing {${foo["${bar
+ [\'baz\']
+}"]}} and more testing"',
+ 'expected' => [
+ 'get' => [
+ 9 => '{${foo["${bar
+ [\'baz\']
+}"]}}',
+ ],
+ 'stripped' => '"Testing and more testing"',
+ ],
+ ],
+ ];
+ }
+
+ /**
+ * Verify that the build-in caching is used when caching is enabled.
+ *
+ * @return void
+ */
+ public function testResultIsCached()
+ {
+ $methodName = 'PHPCSUtils\\Utils\\TextStrings::getStripEmbeds';
+ $input = '"This is the $value of {$name}"';
+ $expected = [
+ 'embeds' => [
+ 13 => '$value',
+ 23 => '{$name}',
+ ],
+ 'remaining' => '"This is the of "',
+ ];
+
+ // Verify the caching works.
+ $origStatus = NoFileCache::$enabled;
+ NoFileCache::$enabled = true;
+
+ $resultFirstRun = TextStrings::getStripEmbeds($input);
+ $isCached = NoFileCache::isCached($methodName, \md5($input));
+ $resultSecondRun = TextStrings::getStripEmbeds($input);
+
+ if ($origStatus === false) {
+ NoFileCache::clear();
+ }
+ NoFileCache::$enabled = $origStatus;
+
+ $this->assertSame($expected, $resultFirstRun, 'First result did not match expectation');
+ $this->assertTrue($isCached, 'NoFileCache::isCached() could not find the cached value');
+ $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+ }
+}
diff --git a/Tests/Utils/TextStrings/StripQuotesTest.php b/Tests/Utils/TextStrings/StripQuotesTest.php
index 51c34d28..56faac11 100644
--- a/Tests/Utils/TextStrings/StripQuotesTest.php
+++ b/Tests/Utils/TextStrings/StripQuotesTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class StripQuotesTest extends TestCase
+final class StripQuotesTest extends TestCase
{
/**
@@ -51,43 +51,43 @@ public function dataStripQuotes()
{
return [
'simple-string-double-quotes' => [
- '"dir_name"',
- 'dir_name',
+ 'input' => '"dir_name"',
+ 'expected' => 'dir_name',
],
'simple-string-single-quotes' => [
- "'soap.wsdl_cache'",
- 'soap.wsdl_cache',
+ 'input' => "'soap.wsdl_cache'",
+ 'expected' => 'soap.wsdl_cache',
],
'string-with-escaped-quotes-within-1' => [
- '"arbitrary-\'string\" with\' quotes within"',
- 'arbitrary-\'string\" with\' quotes within',
+ 'input' => '"arbitrary-\'string\" with\' quotes within"',
+ 'expected' => 'arbitrary-\'string\" with\' quotes within',
],
'string-with-escaped-quotes-within-2' => [
- '"\'quoted_name\'"',
- '\'quoted_name\'',
+ 'input' => '"\'quoted_name\'"',
+ 'expected' => '\'quoted_name\'',
],
'string-with-different-quotes-at-start-of-string' => [
- "'\"quoted\" start of string'",
- '"quoted" start of string',
+ 'input' => "'\"quoted\" start of string'",
+ 'expected' => '"quoted" start of string',
],
'incomplete-quote-set-only-start-quote' => [
- "'no stripping when there is only a start quote",
- "'no stripping when there is only a start quote",
+ 'input' => "'no stripping when there is only a start quote",
+ 'expected' => "'no stripping when there is only a start quote",
],
'incomplete-quote-set-only-end-quote' => [
- 'no stripping when there is only an end quote"',
- 'no stripping when there is only an end quote"',
+ 'input' => 'no stripping when there is only an end quote"',
+ 'expected' => 'no stripping when there is only an end quote"',
],
'start-end-quote-mismatch' => [
- "'no stripping when quotes at start/end are mismatched\"",
- "'no stripping when quotes at start/end are mismatched\"",
+ 'input' => "'no stripping when quotes at start/end are mismatched\"",
+ 'expected' => "'no stripping when quotes at start/end are mismatched\"",
],
'multi-line-string-single-quotes' => [
- "'some
+ 'input' => "'some
text
and
more'",
- 'some
+ 'expected' => 'some
text
and
more',
diff --git a/Tests/Utils/UseStatements/SplitAndMergeImportUseStatementTest.php b/Tests/Utils/UseStatements/SplitAndMergeImportUseStatementTest.php
index 35c94af1..b550bce2 100644
--- a/Tests/Utils/UseStatements/SplitAndMergeImportUseStatementTest.php
+++ b/Tests/Utils/UseStatements/SplitAndMergeImportUseStatementTest.php
@@ -14,15 +14,17 @@
use PHPCSUtils\Utils\UseStatements;
/**
- * Tests for the \PHPCSUtils\Utils\UseStatements::splitAndMergeImportUseStatement() method.
+ * Tests for the \PHPCSUtils\Utils\UseStatements::splitAndMergeImportUseStatement()
+ * and the \PHPCSUtils\Utils\UseStatements::mergeImportUseStatements() method.
*
* @covers \PHPCSUtils\Utils\UseStatements::splitAndMergeImportUseStatement
+ * @covers \PHPCSUtils\Utils\UseStatements::mergeImportUseStatements
*
* @group usestatements
*
* @since 1.0.0
*/
-class SplitAndMergeImportUseStatementTest extends UtilityMethodTestCase
+final class SplitAndMergeImportUseStatementTest extends UtilityMethodTestCase
{
/**
@@ -54,32 +56,32 @@ public function dataSplitAndMergeImportUseStatement()
{
$data = [
'name-plain' => [
- '/* testUseNamePlainAliased */',
- [
+ 'testMarker' => '/* testUseNamePlainAliased */',
+ 'expected' => [
'name' => ['ClassAlias' => 'MyNamespace\YourClass'],
'function' => [],
'const' => [],
],
],
'function-plain' => [
- '/* testUseFunctionPlain */',
- [
+ 'testMarker' => '/* testUseFunctionPlain */',
+ 'expected' => [
'name' => ['ClassAlias' => 'MyNamespace\YourClass'],
'function' => ['myFunction' => 'MyNamespace\myFunction'],
'const' => [],
],
],
'const-plain' => [
- '/* testUseConstPlain */',
- [
+ 'testMarker' => '/* testUseConstPlain */',
+ 'expected' => [
'name' => ['ClassAlias' => 'MyNamespace\YourClass'],
'function' => ['myFunction' => 'MyNamespace\myFunction'],
'const' => ['MY_CONST' => 'MyNamespace\MY_CONST'],
],
],
'group-mixed' => [
- '/* testGroupUseMixed */',
- [
+ 'testMarker' => '/* testGroupUseMixed */',
+ 'expected' => [
'name' => [
'ClassAlias' => 'MyNamespace\YourClass',
'ClassName' => 'Some\NS\ClassName',
@@ -97,9 +99,9 @@ public function dataSplitAndMergeImportUseStatement()
],
],
'trait-use' => [
- '/* testTraitUse */',
+ 'testMarker' => '/* testTraitUse */',
// Same as previous.
- [
+ 'expected' => [
'name' => [
'ClassAlias' => 'MyNamespace\YourClass',
'ClassName' => 'Some\NS\ClassName',
@@ -120,8 +122,8 @@ public function dataSplitAndMergeImportUseStatement()
$previousUse = [];
foreach ($data as $key => $value) {
- $data[$key][] = $previousUse;
- $previousUse = $value[1];
+ $data[$key]['previousUse'] = $previousUse;
+ $previousUse = $value['expected'];
}
return $data;
diff --git a/Tests/Utils/UseStatements/SplitImportUseStatementTest.inc b/Tests/Utils/UseStatements/SplitImportUseStatementTest.inc
index 29e01e6a..e9daecf2 100644
--- a/Tests/Utils/UseStatements/SplitImportUseStatementTest.inc
+++ b/Tests/Utils/UseStatements/SplitImportUseStatementTest.inc
@@ -29,7 +29,7 @@ use function MyNamespace\myFunction ?>
use function Vendor\YourNamespace\yourFunction as FunctionAlias;
/* testUseFunctionMultiple */
-use /* comment */ function foo\math\sin, foo\math\cos as FooCos, foo\math\cosh;
+use /* comment */ function foo\math\sin,foo\math\cos as FooCos,foo\math\cosh;
/* testUseConstPlainUppercaseConstKeyword */
use CONST MyNamespace\MY_CONST;
@@ -69,6 +69,10 @@ use Some\NS\ {
AnotherLevel,
};
+/* testUsePlainReservedKeyword */
+// Intentional parse error - use of reserved keyword in namespace.
+use Vendor\break\ClassName;
+
/* testUseFunctionPlainReservedKeyword */
// Intentional parse error - use of reserved keyword in namespace.
use function Vendor\YourNamespace\switch\yourFunction;
diff --git a/Tests/Utils/UseStatements/SplitImportUseStatementTest.php b/Tests/Utils/UseStatements/SplitImportUseStatementTest.php
index 28f7edf6..bbc99642 100644
--- a/Tests/Utils/UseStatements/SplitImportUseStatementTest.php
+++ b/Tests/Utils/UseStatements/SplitImportUseStatementTest.php
@@ -10,6 +10,7 @@
namespace PHPCSUtils\Tests\Utils\UseStatements;
+use PHPCSUtils\Internal\Cache;
use PHPCSUtils\TestUtils\UtilityMethodTestCase;
use PHPCSUtils\Utils\UseStatements;
@@ -22,7 +23,7 @@
*
* @since 1.0.0
*/
-class SplitImportUseStatementTest extends UtilityMethodTestCase
+final class SplitImportUseStatementTest extends UtilityMethodTestCase
{
/**
@@ -110,24 +111,24 @@ public function dataSplitImportUseStatement()
{
return [
'plain' => [
- '/* testUsePlain */',
- [
+ 'testMarker' => '/* testUsePlain */',
+ 'expected' => [
'name' => ['MyClass' => 'MyNamespace\MyClass'],
'function' => [],
'const' => [],
],
],
'plain-aliased' => [
- '/* testUsePlainAliased */',
- [
+ 'testMarker' => '/* testUsePlainAliased */',
+ 'expected' => [
'name' => ['ClassAlias' => 'MyNamespace\YourClass'],
'function' => [],
'const' => [],
],
],
'multiple-with-comments' => [
- '/* testUseMultipleWithComments */',
- [
+ 'testMarker' => '/* testUseMultipleWithComments */',
+ 'expected' => [
'name' => [
'ClassABC' => 'Vendor\Foo\ClassA',
'InterfaceB' => 'Vendor\Bar\InterfaceB',
@@ -138,24 +139,24 @@ public function dataSplitImportUseStatement()
],
],
'function-plain-ends-on-close-tag' => [
- '/* testUseFunctionPlainEndsOnCloseTag */',
- [
+ 'testMarker' => '/* testUseFunctionPlainEndsOnCloseTag */',
+ 'expected' => [
'name' => [],
'function' => ['myFunction' => 'MyNamespace\myFunction'],
'const' => [],
],
],
'function-plain-aliased' => [
- '/* testUseFunctionPlainAliased */',
- [
+ 'testMarker' => '/* testUseFunctionPlainAliased */',
+ 'expected' => [
'name' => [],
'function' => ['FunctionAlias' => 'Vendor\YourNamespace\yourFunction'],
'const' => [],
],
],
'function-multiple' => [
- '/* testUseFunctionMultiple */',
- [
+ 'testMarker' => '/* testUseFunctionMultiple */',
+ 'expected' => [
'name' => [],
'function' => [
'sin' => 'foo\math\sin',
@@ -166,24 +167,24 @@ public function dataSplitImportUseStatement()
],
],
'const-plain-uppercase-const-keyword' => [
- '/* testUseConstPlainUppercaseConstKeyword */',
- [
+ 'testMarker' => '/* testUseConstPlainUppercaseConstKeyword */',
+ 'expected' => [
'name' => [],
'function' => [],
'const' => ['MY_CONST' => 'MyNamespace\MY_CONST'],
],
],
'const-plain-aliased' => [
- '/* testUseConstPlainAliased */',
- [
+ 'testMarker' => '/* testUseConstPlainAliased */',
+ 'expected' => [
'name' => [],
'function' => [],
'const' => ['CONST_ALIAS' => 'MyNamespace\YOUR_CONST'],
],
],
'const-multiple' => [
- '/* testUseConstMultiple */',
- [
+ 'testMarker' => '/* testUseConstMultiple */',
+ 'expected' => [
'name' => [],
'function' => [],
'const' => [
@@ -193,8 +194,8 @@ public function dataSplitImportUseStatement()
],
],
'group' => [
- '/* testGroupUse */',
- [
+ 'testMarker' => '/* testGroupUse */',
+ 'expected' => [
'name' => [
'SomeClassA' => 'some\namespacing\SomeClassA',
'SomeClassB' => 'some\namespacing\deeper\level\SomeClassB',
@@ -205,8 +206,8 @@ public function dataSplitImportUseStatement()
],
],
'group-function-trailing-comma' => [
- '/* testGroupUseFunctionTrailingComma */',
- [
+ 'testMarker' => '/* testGroupUseFunctionTrailingComma */',
+ 'expected' => [
'name' => [],
'function' => [
'Msin' => 'bar\math\Msin',
@@ -217,8 +218,8 @@ public function dataSplitImportUseStatement()
],
],
'group-const' => [
- '/* testGroupUseConst */',
- [
+ 'testMarker' => '/* testGroupUseConst */',
+ 'expected' => [
'name' => [],
'function' => [],
'const' => [
@@ -228,8 +229,8 @@ public function dataSplitImportUseStatement()
],
],
'group-mixed' => [
- '/* testGroupUseMixed */',
- [
+ 'testMarker' => '/* testGroupUseMixed */',
+ 'expected' => [
'name' => [
'ClassName' => 'Some\NS\ClassName',
'AnotherLevel' => 'Some\NS\AnotherLevel',
@@ -241,49 +242,58 @@ public function dataSplitImportUseStatement()
'const' => ['SOME_CONSTANT' => 'Some\NS\Constants\CONSTANT_NAME'],
],
],
+
+ 'parse-error-plain-reserved-keyword' => [
+ 'testMarker' => '/* testUsePlainReservedKeyword */',
+ 'expected' => [
+ 'name' => ['ClassName' => 'Vendor\break\ClassName'],
+ 'function' => [],
+ 'const' => [],
+ ],
+ ],
'parse-error-function-plain-reserved-keyword' => [
- '/* testUseFunctionPlainReservedKeyword */',
- [
+ 'testMarker' => '/* testUseFunctionPlainReservedKeyword */',
+ 'expected' => [
'name' => [],
'function' => ['yourFunction' => 'Vendor\YourNamespace\switch\yourFunction'],
'const' => [],
],
],
'parse-error-const-plain-reserved-keyword' => [
- '/* testUseConstPlainReservedKeyword */',
- [
+ 'testMarker' => '/* testUseConstPlainReservedKeyword */',
+ 'expected' => [
'name' => [],
'function' => [],
'const' => ['yourConst' => 'Vendor\YourNamespace\function\yourConst'],
],
],
'parse-error-plain-alias-reserved-keyword' => [
- '/* testUsePlainAliasReservedKeyword */',
- [
+ 'testMarker' => '/* testUsePlainAliasReservedKeyword */',
+ 'expected' => [
'name' => ['class' => 'Vendor\YourNamespace\ClassName'],
'function' => [],
'const' => [],
],
],
'parse-error-plain-alias-reserved-keyword-function' => [
- '/* testUsePlainAliasReservedKeywordFunction */',
- [
+ 'testMarker' => '/* testUsePlainAliasReservedKeywordFunction */',
+ 'expected' => [
'name' => ['function' => 'Vendor\YourNamespace\ClassName'],
'function' => [],
'const' => [],
],
],
'parse-error-plain-alias-reserved-keyword-const' => [
- '/* testUsePlainAliasReservedKeywordConst */',
- [
- 'name' => [],
+ 'testMarker' => '/* testUsePlainAliasReservedKeywordConst */',
+ 'expected' => [
+ 'name' => ['const' => 'Vendor\YourNamespace\ClassName'],
'function' => [],
'const' => [],
],
],
'parse-error' => [
- '/* testParseError */',
- [
+ 'testMarker' => '/* testParseError */',
+ 'expected' => [
'name' => [],
'function' => [],
'const' => [],
@@ -291,4 +301,36 @@ public function dataSplitImportUseStatement()
],
];
}
+
+ /**
+ * Verify that the build-in caching is used when caching is enabled.
+ *
+ * @return void
+ */
+ public function testResultIsCached()
+ {
+ $methodName = 'PHPCSUtils\\Utils\\UseStatements::splitImportUseStatement';
+ $cases = $this->dataSplitImportUseStatement();
+ $testMarker = $cases['multiple-with-comments']['testMarker'];
+ $expected = $cases['multiple-with-comments']['expected'];
+
+ $stackPtr = $this->getTargetToken($testMarker, \T_USE);
+
+ // Verify the caching works.
+ $origStatus = Cache::$enabled;
+ Cache::$enabled = true;
+
+ $resultFirstRun = UseStatements::splitImportUseStatement(self::$phpcsFile, $stackPtr);
+ $isCached = Cache::isCached(self::$phpcsFile, $methodName, $stackPtr);
+ $resultSecondRun = UseStatements::splitImportUseStatement(self::$phpcsFile, $stackPtr);
+
+ if ($origStatus === false) {
+ Cache::clear();
+ }
+ Cache::$enabled = $origStatus;
+
+ $this->assertSame($expected, $resultFirstRun, 'First result did not match expectation');
+ $this->assertTrue($isCached, 'Cache::isCached() could not find the cached value');
+ $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+ }
}
diff --git a/Tests/Utils/UseStatements/UseTypeTest.inc b/Tests/Utils/UseStatements/UseTypeTest.inc
index cd0582ed..883beeb5 100644
--- a/Tests/Utils/UseStatements/UseTypeTest.inc
+++ b/Tests/Utils/UseStatements/UseTypeTest.inc
@@ -48,6 +48,28 @@ interface InterfaceUsingTrait {
use SomeTrait;
}
+/*
+ * Test specific issue with PHPCS < 3 where the case/default parse errors below would cause them
+ * to have a case/default condition, though without a switch.
+ */
+use FoobarA as Case;
+/* testUseImportPHPCS2CaseNoSwitchA */
+use FoobarB as Foo;
+/* testUseImportPHPCS2CaseNoSwitchB */
+use FoobarC as Default;
+/* testUseImportPHPCS2DefaultNoSwitchA */
+use FoobarD as Bar;
+
+class PHPCS2ScopeConditionIssue {
+ use TraitA { oldfunction as case; }
+ /* testUseImportPHPCS2CaseNoSwitchC */
+ use TraitB { oldfunction as Baz; }
+ /* testUseImportPHPCS2CaseNoSwitchD */
+ use TraitC { oldfunction as default; }
+ /* testUseImportPHPCS2DefaultNoSwitchB */
+ use TraitD { oldfunction as Fool; }
+}
+
// Intentional parse error. Live coding. This has to be the last test in the file.
/* testLiveCoding */
use
\ No newline at end of file
diff --git a/Tests/Utils/UseStatements/UseTypeTest.php b/Tests/Utils/UseStatements/UseTypeTest.php
index 4faef85f..81faabb9 100644
--- a/Tests/Utils/UseStatements/UseTypeTest.php
+++ b/Tests/Utils/UseStatements/UseTypeTest.php
@@ -28,7 +28,7 @@
*
* @since 1.0.0
*/
-class UseTypeTest extends UtilityMethodTestCase
+final class UseTypeTest extends UtilityMethodTestCase
{
/**
@@ -122,96 +122,147 @@ public function dataUseType()
{
return [
'import-1' => [
- '/* testUseImport1 */',
- [
+ 'testMarker' => '/* testUseImport1 */',
+ 'expected' => [
'closure' => false,
'import' => true,
'trait' => false,
],
],
'import-2' => [
- '/* testUseImport2 */',
- [
+ 'testMarker' => '/* testUseImport2 */',
+ 'expected' => [
'closure' => false,
'import' => true,
'trait' => false,
],
],
'import-3' => [
- '/* testUseImport3 */',
- [
+ 'testMarker' => '/* testUseImport3 */',
+ 'expected' => [
'closure' => false,
'import' => true,
'trait' => false,
],
],
'import-4' => [
- '/* testUseImport4 */',
- [
+ 'testMarker' => '/* testUseImport4 */',
+ 'expected' => [
'closure' => false,
'import' => true,
'trait' => false,
],
],
'closure' => [
- '/* testClosureUse */',
- [
+ 'testMarker' => '/* testClosureUse */',
+ 'expected' => [
'closure' => true,
'import' => false,
'trait' => false,
],
],
'trait' => [
- '/* testUseTrait */',
- [
+ 'testMarker' => '/* testUseTrait */',
+ 'expected' => [
'closure' => false,
'import' => false,
'trait' => true,
],
],
'closure-in-nested-class' => [
- '/* testClosureUseNestedInClass */',
- [
+ 'testMarker' => '/* testClosureUseNestedInClass */',
+ 'expected' => [
'closure' => true,
'import' => false,
'trait' => false,
],
],
'trait-in-nested-anon-class' => [
- '/* testUseTraitInNestedAnonClass */',
- [
+ 'testMarker' => '/* testUseTraitInNestedAnonClass */',
+ 'expected' => [
'closure' => false,
'import' => false,
'trait' => true,
],
],
'trait-in-trait' => [
- '/* testUseTraitInTrait */',
- [
+ 'testMarker' => '/* testUseTraitInTrait */',
+ 'expected' => [
'closure' => false,
'import' => false,
'trait' => true,
],
],
'closure-nested-in-trait' => [
- '/* testClosureUseNestedInTrait */',
- [
+ 'testMarker' => '/* testClosureUseNestedInTrait */',
+ 'expected' => [
'closure' => true,
'import' => false,
'trait' => false,
],
],
'trait-in-interface' => [
- '/* testUseTraitInInterface */',
- [
+ 'testMarker' => '/* testUseTraitInInterface */',
+ 'expected' => [
'closure' => false,
'import' => false,
'trait' => false,
],
],
+
+ // Tests related to a specific issue with scope setting in PHPCS 2.x.
+ 'parse-error-import-use-case-no-switch-1' => [
+ 'testMarker' => '/* testUseImportPHPCS2CaseNoSwitchA */',
+ 'expected' => [
+ 'closure' => false,
+ 'import' => true,
+ 'trait' => false,
+ ],
+ ],
+ 'parse-error-import-use-case-no-switch-2' => [
+ 'testMarker' => '/* testUseImportPHPCS2CaseNoSwitchB */',
+ 'expected' => [
+ 'closure' => false,
+ 'import' => true,
+ 'trait' => false,
+ ],
+ ],
+ 'parse-error-import-use-default-no-switch' => [
+ 'testMarker' => '/* testUseImportPHPCS2DefaultNoSwitchA */',
+ 'expected' => [
+ 'closure' => false,
+ 'import' => true,
+ 'trait' => false,
+ ],
+ ],
+ 'parse-error-trait-use-case-no-switch-1' => [
+ 'testMarker' => '/* testUseImportPHPCS2CaseNoSwitchC */',
+ 'expected' => [
+ 'closure' => false,
+ 'import' => false,
+ 'trait' => true,
+ ],
+ ],
+ 'parse-error-trait-use-case-no-switch-2' => [
+ 'testMarker' => '/* testUseImportPHPCS2CaseNoSwitchD */',
+ 'expected' => [
+ 'closure' => false,
+ 'import' => false,
+ 'trait' => true,
+ ],
+ ],
+ 'parse-error-trait-use-default-no-switch' => [
+ 'testMarker' => '/* testUseImportPHPCS2DefaultNoSwitchB */',
+ 'expected' => [
+ 'closure' => false,
+ 'import' => false,
+ 'trait' => true,
+ ],
+ ],
+
'live-coding' => [
- '/* testLiveCoding */',
- [
+ 'testMarker' => '/* testLiveCoding */',
+ 'expected' => [
'closure' => false,
'import' => false,
'trait' => false,
diff --git a/Tests/Utils/Variables/GetMemberPropertiesDiffTest.inc b/Tests/Utils/Variables/GetMemberPropertiesDiffTest.inc
index 4cfc073d..affc1f2e 100644
--- a/Tests/Utils/Variables/GetMemberPropertiesDiffTest.inc
+++ b/Tests/Utils/Variables/GetMemberPropertiesDiffTest.inc
@@ -5,3 +5,24 @@ interface Base
/* testInterfaceProperty */
protected $anonymous;
}
+
+enum Suit
+{
+ /* testEnumProperty */
+ protected $anonymous;
+}
+
+$anon = class() {
+ /* testPHP82PseudoTypeTrue */
+ public true $pseudoTypeTrue;
+
+ /* testPHP82NullablePseudoTypeTrue */
+ static protected ?true $pseudoTypeNullableTrue;
+
+ /* testPHP82PseudoTypeTrueInUnion */
+ private int|string|true $pseudoTypeTrueInUnion;
+
+ /* testPHP82PseudoTypeFalseAndTrue */
+ // Intentional fatal error - Type contains both true and false, bool should be used instead, but that's not the concern of the method.
+ readonly true|FALSE $pseudoTypeFalseAndTrue;
+};
diff --git a/Tests/Utils/Variables/GetMemberPropertiesDiffTest.php b/Tests/Utils/Variables/GetMemberPropertiesDiffTest.php
index 2dfa66bb..544d6707 100644
--- a/Tests/Utils/Variables/GetMemberPropertiesDiffTest.php
+++ b/Tests/Utils/Variables/GetMemberPropertiesDiffTest.php
@@ -25,7 +25,7 @@
*
* @since 1.0.0
*/
-class GetMemberPropertiesDiffTest extends UtilityMethodTestCase
+final class GetMemberPropertiesDiffTest extends UtilityMethodTestCase
{
/**
@@ -41,15 +41,124 @@ public function testNonExistentToken()
}
/**
- * Test receiving an expected exception when an (invalid) interface property is passed.
+ * Test receiving an expected exception when an (invalid) interface or enum property is passed.
+ *
+ * @dataProvider dataNotClassPropertyException
+ *
+ * @param string $testMarker Comment which precedes the test case.
*
* @return void
*/
- public function testNotClassPropertyException()
+ public function testNotClassPropertyException($testMarker)
{
$this->expectPhpcsException('$stackPtr is not a class member var');
- $variable = $this->getTargetToken('/* testInterfaceProperty */', \T_VARIABLE);
+ $variable = $this->getTargetToken($testMarker, \T_VARIABLE);
Variables::getMemberProperties(self::$phpcsFile, $variable);
}
+
+ /**
+ * Data provider.
+ *
+ * @see testNotClassPropertyException()
+ *
+ * @return array
+ */
+ public function dataNotClassPropertyException()
+ {
+ return [
+ 'interface property' => ['/* testInterfaceProperty */'],
+ 'enum property' => ['/* testEnumProperty */'],
+ ];
+ }
+
+ /**
+ * Test the getMemberProperties() method.
+ *
+ * @dataProvider dataGetMemberProperties
+ *
+ * @param string $identifier Comment which precedes the test case.
+ * @param bool $expected Expected function output.
+ *
+ * @return void
+ */
+ public function testGetMemberProperties($identifier, $expected)
+ {
+ $variable = $this->getTargetToken($identifier, \T_VARIABLE);
+ $result = Variables::getMemberProperties(self::$phpcsFile, $variable);
+
+ if (isset($expected['type_token']) && $expected['type_token'] !== false) {
+ $expected['type_token'] += $variable;
+ }
+ if (isset($expected['type_end_token']) && $expected['type_end_token'] !== false) {
+ $expected['type_end_token'] += $variable;
+ }
+
+ $this->assertSame($expected, $result);
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testGetMemberProperties()
+ *
+ * @return array
+ */
+ public function dataGetMemberProperties()
+ {
+ return [
+ 'php8.2-pseudo-type-true' => [
+ '/* testPHP82PseudoTypeTrue */',
+ [
+ 'scope' => 'public',
+ 'scope_specified' => true,
+ 'is_static' => false,
+ 'is_readonly' => false,
+ 'type' => 'true',
+ 'type_token' => -2, // Offset from the T_VARIABLE token.
+ 'type_end_token' => -2, // Offset from the T_VARIABLE token.
+ 'nullable_type' => false,
+ ],
+ ],
+ 'php8.2-pseudo-type-true-nullable' => [
+ '/* testPHP82NullablePseudoTypeTrue */',
+ [
+ 'scope' => 'protected',
+ 'scope_specified' => true,
+ 'is_static' => true,
+ 'is_readonly' => false,
+ 'type' => '?true',
+ 'type_token' => -2, // Offset from the T_VARIABLE token.
+ 'type_end_token' => -2, // Offset from the T_VARIABLE token.
+ 'nullable_type' => true,
+ ],
+ ],
+ 'php8.2-pseudo-type-true-in-union' => [
+ '/* testPHP82PseudoTypeTrueInUnion */',
+ [
+ 'scope' => 'private',
+ 'scope_specified' => true,
+ 'is_static' => false,
+ 'is_readonly' => false,
+ 'type' => 'int|string|true',
+ 'type_token' => -6, // Offset from the T_VARIABLE token.
+ 'type_end_token' => -2, // Offset from the T_VARIABLE token.
+ 'nullable_type' => false,
+ ],
+ ],
+ 'php8.2-pseudo-type-invalid-true-false-union' => [
+ '/* testPHP82PseudoTypeFalseAndTrue */',
+ [
+ 'scope' => 'public',
+ 'scope_specified' => false,
+ 'is_static' => false,
+ 'is_readonly' => true,
+ 'type' => 'true|FALSE',
+ 'type_token' => -4, // Offset from the T_VARIABLE token.
+ 'type_end_token' => -2, // Offset from the T_VARIABLE token.
+ 'nullable_type' => false,
+ ],
+ ],
+ ];
+ }
}
diff --git a/Tests/Utils/Variables/GetMemberPropertiesTest.php b/Tests/Utils/Variables/GetMemberPropertiesTest.php
index d4d4c34e..619f7a2f 100644
--- a/Tests/Utils/Variables/GetMemberPropertiesTest.php
+++ b/Tests/Utils/Variables/GetMemberPropertiesTest.php
@@ -21,7 +21,7 @@
*
* @since 1.0.0
*/
-class GetMemberPropertiesTest extends BCFile_GetMemberPropertiesTest
+final class GetMemberPropertiesTest extends BCFile_GetMemberPropertiesTest
{
/**
@@ -68,13 +68,12 @@ public function dataGetMemberProperties()
$data = parent::dataGetMemberProperties();
/*
- * Remove the data set related to the invalid interface property.
- * This will now throw an exception instead.
+ * Remove the data set related to the invalid interface/enum properties.
+ * These will now throw an exception instead.
*/
foreach ($data as $key => $value) {
- if ($value[0] === '/* testInterfaceProperty */') {
+ if ($value[0] === '/* testInterfaceProperty */' || $value[0] === '/* testEnumProperty */') {
unset($data[$key]);
- break;
}
}
diff --git a/Tests/Utils/Variables/IsPHPReservedVarNameTest.php b/Tests/Utils/Variables/IsPHPReservedVarNameTest.php
index ed310da1..5b1729d2 100644
--- a/Tests/Utils/Variables/IsPHPReservedVarNameTest.php
+++ b/Tests/Utils/Variables/IsPHPReservedVarNameTest.php
@@ -22,7 +22,7 @@
*
* @since 1.0.0
*/
-class IsPHPReservedVarNameTest extends TestCase
+final class IsPHPReservedVarNameTest extends TestCase
{
/**
diff --git a/Tests/Utils/Variables/IsSuperglobalTest.php b/Tests/Utils/Variables/IsSuperglobalTest.php
index cb5cf3f6..57019d49 100644
--- a/Tests/Utils/Variables/IsSuperglobalTest.php
+++ b/Tests/Utils/Variables/IsSuperglobalTest.php
@@ -24,7 +24,7 @@
*
* @since 1.0.0
*/
-class IsSuperglobalTest extends UtilityMethodTestCase
+final class IsSuperglobalTest extends UtilityMethodTestCase
{
/**
@@ -43,16 +43,16 @@ public function testNonExistentToken()
*
* @dataProvider dataIsSuperglobal
*
- * @param string $testMarker The comment which prefaces the target token in the test file.
- * @param bool $expected The expected function return value.
- * @param int|string $testTargetType Optional. The token type for the target token in the test file.
- * @param string $testTargetValue Optional. The token content for the target token in the test file.
+ * @param string $testMarker The comment which prefaces the target token in the test file.
+ * @param bool $expected The expected function return value.
+ * @param int|string $targetType Optional. The token type for the target token in the test file.
+ * @param string $targetValue Optional. The token content for the target token in the test file.
*
* @return void
*/
- public function testIsSuperglobal($testMarker, $expected, $testTargetType = \T_VARIABLE, $testTargetValue = null)
+ public function testIsSuperglobal($testMarker, $expected, $targetType = \T_VARIABLE, $targetValue = null)
{
- $stackPtr = $this->getTargetToken($testMarker, $testTargetType, $testTargetValue);
+ $stackPtr = $this->getTargetToken($testMarker, $targetType, $targetValue);
$result = Variables::isSuperglobal(self::$phpcsFile, $stackPtr);
$this->assertSame($expected, $result);
}
@@ -68,70 +68,70 @@ public function dataIsSuperglobal()
{
return [
'not-a-variable' => [
- '/* testNotAVariable */',
- false,
- \T_RETURN,
+ 'testMarker' => '/* testNotAVariable */',
+ 'expected' => false,
+ 'targetType' => \T_RETURN,
],
'not-a-reserved-var' => [
- '/* testNotAReservedVar */',
- false,
+ 'testMarker' => '/* testNotAReservedVar */',
+ 'expected' => false,
],
'reserved-var-not-superglobal' => [
- '/* testReservedVarNotSuperglobal */',
- false,
+ 'testMarker' => '/* testReservedVarNotSuperglobal */',
+ 'expected' => false,
],
'reserved-var-superglobal' => [
- '/* testReservedVarIsSuperglobal */',
- true,
+ 'testMarker' => '/* testReservedVarIsSuperglobal */',
+ 'expected' => true,
],
'array-key-not-a-reserved-var' => [
- '/* testGLOBALSArrayKeyNotAReservedVar */',
- false,
- \T_CONSTANT_ENCAPSED_STRING,
+ 'testMarker' => '/* testGLOBALSArrayKeyNotAReservedVar */',
+ 'expected' => false,
+ 'targetType' => \T_CONSTANT_ENCAPSED_STRING,
],
'array-key-variable' => [
- '/* testGLOBALSArrayKeyVar */',
- false,
- \T_VARIABLE,
- '$something',
+ 'testMarker' => '/* testGLOBALSArrayKeyVar */',
+ 'expected' => false,
+ 'targetType' => \T_VARIABLE,
+ 'targetValue' => '$something',
],
'array-key-reserved-var-not-superglobal' => [
- '/* testGLOBALSArrayKeyReservedVar */',
- false,
- \T_VARIABLE,
- '$php_errormsg',
+ 'testMarker' => '/* testGLOBALSArrayKeyReservedVar */',
+ 'expected' => false,
+ 'targetType' => \T_VARIABLE,
+ 'targetValue' => '$php_errormsg',
],
'array-key-var-superglobal' => [
- '/* testGLOBALSArrayKeySuperglobal */',
- true,
- \T_VARIABLE,
- '$_COOKIE',
+ 'testMarker' => '/* testGLOBALSArrayKeySuperglobal */',
+ 'expected' => true,
+ 'targetType' => \T_VARIABLE,
+ 'targetValue' => '$_COOKIE',
],
'array-key-not-single-string' => [
- '/* testGLOBALSArrayKeyNotSingleString */',
- false,
- \T_CONSTANT_ENCAPSED_STRING,
+ 'testMarker' => '/* testGLOBALSArrayKeyNotSingleString */',
+ 'expected' => false,
+ 'targetType' => \T_CONSTANT_ENCAPSED_STRING,
],
'array-key-interpolated-var' => [
- '/* testGLOBALSArrayKeyInterpolatedVar */',
- false,
- \T_DOUBLE_QUOTED_STRING,
+ 'testMarker' => '/* testGLOBALSArrayKeyInterpolatedVar */',
+ 'expected' => false,
+ 'targetType' => \T_DOUBLE_QUOTED_STRING,
],
'array-key-string-superglobal' => [
- '/* testGLOBALSArrayKeySingleStringSuperglobal */',
- true,
- \T_CONSTANT_ENCAPSED_STRING,
+ 'testMarker' => '/* testGLOBALSArrayKeySingleStringSuperglobal */',
+ 'expected' => true,
+ 'targetType' => \T_CONSTANT_ENCAPSED_STRING,
],
'array-key-var-superglobal-with-array-access' => [
- '/* testGLOBALSArrayKeySuperglobalWithKey */',
- true,
- \T_VARIABLE,
- '$_GET',
+ 'testMarker' => '/* testGLOBALSArrayKeySuperglobalWithKey */',
+ 'expected' => true,
+ 'targetType' => \T_VARIABLE,
+ 'targetValue' => '$_GET',
],
'array-key-not-globals-array' => [
- '/* testSuperglobalKeyNotGLOBALSArray */',
- false,
- \T_CONSTANT_ENCAPSED_STRING,
+ 'testMarker' => '/* testSuperglobalKeyNotGLOBALSArray */',
+ 'expected' => false,
+ 'targetType' => \T_CONSTANT_ENCAPSED_STRING,
],
];
}
diff --git a/Tests/Xtra/Messages/HasNewLineSupportTest.inc b/Tests/Xtra/Messages/HasNewLineSupportTest.inc
new file mode 100644
index 00000000..1c97c6ad
--- /dev/null
+++ b/Tests/Xtra/Messages/HasNewLineSupportTest.inc
@@ -0,0 +1,4 @@
+expectOutputString($expected);
+ $this->setOutputCallback([$this, 'normalizeOutput']);
+
+ /*
+ * Create the error.
+ */
+ $stackPtr = $this->getTargetToken('/* testMessageWithNewLine */', \T_CONSTANT_ENCAPSED_STRING);
+
+ self::$phpcsFile->addError(
+ // phpcs:ignore Generic.Files.LineLength.TooLong
+ "Lorem ipsum dolor sit amet, consectetur adipiscing elit.\nAenean felis urna, dictum vitae lobortis vitae, maximus nec enim. Etiam euismod placerat efficitur. Nulla eu felis ipsum.\nCras vitae ultrices turpis. Ut consectetur ligula in justo tincidunt mattis.\n\nAliquam fermentum magna id venenatis placerat. Curabitur lobortis nulla sit amet consequat fermentum. Aenean malesuada tristique aliquam. Donec eget placerat nisl.\n\nMorbi mollis, risus vel venenatis accumsan, urna dolor faucibus risus, ut congue purus augue vel ipsum.\nCurabitur nec dolor est. Suspendisse nec quam non ligula aliquam tempus. Donec laoreet maximus leo, in eleifend odio interdum vitae.",
+ $stackPtr,
+ self::CODE
+ );
+
+ /*
+ * Generate the actual output to test.
+ */
+ $config = self::$phpcsFile->config;
+ $config->colors = false;
+ $config->reportWidth = 120;
+ $reporter = new Reporter($config);
+ $reportClass = new Full();
+ $reportData = $reporter->prepareFileReport(self::$phpcsFile);
+
+ $reportClass->generateFileReport(
+ $reportData,
+ self::$phpcsFile,
+ self::$phpcsFile->config->showSources,
+ $config->reportWidth
+ );
+ }
+
+ /**
+ * Normalize the output to allow for OS-independent comparison.
+ *
+ * @param string $output Generated output.
+ *
+ * @return string
+ */
+ public function normalizeOutput($output)
+ {
+ // Remove potential color codes.
+ $output = \preg_replace('`\\033\[[0-9]+m`', '', $output);
+
+ $output = \explode(\PHP_EOL, \trim($output));
+ // Remove: line with filename.
+ \array_shift($output);
+
+ return \implode("\n", $output);
+ }
+}
diff --git a/Tests/Xtra/README.md b/Tests/Xtra/README.md
new file mode 100644
index 00000000..97cff0dd
--- /dev/null
+++ b/Tests/Xtra/README.md
@@ -0,0 +1,10 @@
+# Xtra Tests
+
+This is a directory for tests not directly related to functionality within PHPCSUtils.
+
+These tests safeguard functionality from PHP_CodeSniffer for which PHPCS itself does not have suffiencient test coverage.
+
+In most cases, these type of tests should be pulled to PHP_CodeSniffer itself, but if testing this within the PHPCS native test framework would be difficult, tests can be placed here.
+Tests can also be added here for functionality for which PHPCS just doesn't have enough tests or temporarily, while waiting for a test PR to be merged in PHPCS itself.
+
+Note: these tests are run in CI in a separate test run called "risky" as these tests may start failing without notice due to changes in PHPCS itself.
diff --git a/Tests/Xtra/Tokens/TokenNameTest.php b/Tests/Xtra/Tokens/TokenNameTest.php
new file mode 100644
index 00000000..b72c9a85
--- /dev/null
+++ b/Tests/Xtra/Tokens/TokenNameTest.php
@@ -0,0 +1,74 @@
+assertSame($expected, Tokens::tokenName($tokenCode));
+ }
+
+ /**
+ * Data provider.
+ *
+ * @see testTokenName() For the array format.
+ *
+ * @return array
+ */
+ public function dataTokenName()
+ {
+ return [
+ 'PHP native token: T_ECHO' => [
+ 'tokenCode' => \T_ECHO,
+ 'expected' => 'T_ECHO',
+ ],
+ 'PHP native token: T_FUNCTION' => [
+ 'tokenCode' => \T_FUNCTION,
+ 'expected' => 'T_FUNCTION',
+ ],
+ 'PHPCS native token: T_CLOSURE' => [
+ 'tokenCode' => \T_CLOSURE,
+ 'expected' => 'T_CLOSURE',
+ ],
+ 'PHPCS native token: T_STRING_CONCAT' => [
+ 'tokenCode' => \T_STRING_CONCAT,
+ 'expected' => 'T_STRING_CONCAT',
+ ],
+ ];
+ }
+}
diff --git a/Tests/bootstrap.php b/Tests/bootstrap.php
index 6812f447..8e660fb9 100644
--- a/Tests/bootstrap.php
+++ b/Tests/bootstrap.php
@@ -14,6 +14,9 @@
namespace PHPCSUtils\Tests;
+use PHPCSUtils\Internal\Cache;
+use PHPCSUtils\Internal\NoFileCache;
+
if (\defined('PHP_CODESNIFFER_IN_TESTS') === false) {
\define('PHP_CODESNIFFER_IN_TESTS', true);
}
@@ -27,32 +30,32 @@
\define('PHP_CODESNIFFER_VERBOSITY', 0);
}
+if (\is_dir(\dirname(__DIR__) . '/vendor') && \file_exists(\dirname(__DIR__) . '/vendor/autoload.php')) {
+ $vendorDir = \dirname(__DIR__) . '/vendor';
+} else {
+ echo 'Please run `composer install` before attempting to run the unit tests.
+You can still run the tests using a PHPUnit phar file, but some test dependencies need to be available.
+';
+ die(1);
+}
+
// Get the PHPCS dir from an environment variable.
$phpcsDir = \getenv('PHPCS_DIR');
// This may be a Composer install.
-if ($phpcsDir === false && \is_dir(\dirname(__DIR__) . '/vendor/squizlabs/php_codesniffer')) {
- $vendorDir = \dirname(__DIR__) . '/vendor';
- $phpcsDir = $vendorDir . '/squizlabs/php_codesniffer';
+if ($phpcsDir === false && \is_dir($vendorDir . '/squizlabs/php_codesniffer')) {
+ $phpcsDir = $vendorDir . '/squizlabs/php_codesniffer';
} elseif ($phpcsDir !== false) {
$phpcsDir = \realpath($phpcsDir);
}
// Try and load the PHPCS autoloader.
if ($phpcsDir !== false && \file_exists($phpcsDir . '/autoload.php')) {
- // PHPCS 3.x.
require_once $phpcsDir . '/autoload.php';
// Pre-load the token back-fills to prevent undefined constant notices.
require_once $phpcsDir . '/src/Util/Tokens.php';
-} elseif ($phpcsDir !== false && \file_exists($phpcsDir . '/CodeSniffer.php')) {
- // PHPCS 2.x.
- require_once $phpcsDir . '/CodeSniffer.php';
-
- // Pre-load the token back-fills to prevent undefined constant notices.
- require_once $phpcsDir . '/CodeSniffer/Tokens.php';
} else {
-// @todo: change URL!!!!
echo 'Uh oh... can\'t find PHPCS.
If you use Composer, please run `composer install`.
@@ -62,28 +65,35 @@
die(1);
}
-// Load the composer autoload if available.
-if (isset($vendorDir) && \file_exists($vendorDir . '/autoload.php')) {
- require_once $vendorDir . '/autoload.php';
-} else {
+if (\defined('__PHPUNIT_PHAR__')) {
+ // Testing via a PHPUnit phar.
+
+ // Load the PHPUnit Polyfills autoloader.
+ require_once $vendorDir . '/yoast/phpunit-polyfills/phpunitpolyfills-autoload.php';
+
/*
* Autoloader specifically for the test files.
* Fixes issues with PHPUnit not being able to find test classes being extended when running
* in a non-Composer context.
*/
- \spl_autoload_register(function ($class) {
+ \spl_autoload_register(function ($fqClassName) {
// Only try & load our own classes.
- if (\stripos($class, 'PHPCSUtils\Tests\\') !== 0) {
+ if (\stripos($fqClassName, 'PHPCSUtils\Tests\\') !== 0) {
return;
}
// Strip namespace prefix 'PHPCSUtils\Tests\'.
- $class = \substr($class, 17);
- $file = \realpath(__DIR__) . \DIRECTORY_SEPARATOR . \strtr($class, '\\', \DIRECTORY_SEPARATOR) . '.php';
+ $relativeClass = \substr($fqClassName, 17);
+ $file = \realpath(__DIR__) . \DIRECTORY_SEPARATOR
+ . \strtr($relativeClass, '\\', \DIRECTORY_SEPARATOR) . '.php';
+
if (\file_exists($file)) {
include_once $file;
}
});
+} else {
+ // Testing via a Composer setup.
+ require_once $vendorDir . '/autoload.php';
}
/*
@@ -94,4 +104,24 @@
*/
require_once \dirname(__DIR__) . '/phpcsutils-autoload.php';
-unset($phpcsDir, $vendorDir);
+/*
+ * Determine whether to run the test suite with caching enabled or disabled.
+ *
+ * Use `
{% endif %}
+
diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss
index d6f81c22..6d9185f7 100644
--- a/docs/assets/css/style.scss
+++ b/docs/assets/css/style.scss
@@ -89,13 +89,13 @@ p code {
}
/* FAQ */
-#faq h4 {
+.faq h3 {
font-size: 18px;
line-height: 1.1;
margin-top: 0;
}
-#faq h4::first-letter, #faq h4 + p::first-letter {
+.faq h3::first-letter, .faq h3 + p::first-letter {
color:#267CB9;
font-weight: bold;
}
diff --git a/docs/index.md b/docs/index.md
index b84fc2b5..ee6793dc 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -9,81 +9,82 @@ seo:
type: Organisation
---
-Features
--------------------------------------------
+## Features
-[PHPCSUtils](https://github.com/PHPCSStandards/PHPCSUtils) is a set of utilities to aid developers of sniffs for [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) (or "PHPCS" for short).
+[PHPCSUtils][phpcsutils-repo] is a set of utilities to aid developers of sniffs for [PHP_CodeSniffer] (or "PHPCS" for short).
This package offers the following features:
-#### Q: How does this all work without an external standard needing to register an autoloader?
+### Q: How does this all work without an external standard needing to register an autoloader?
A: As PHPCSUtils is registered with PHPCS as an external standard and PHPCSUtils complies with the naming requirements of PHPCS, the PHPCS native autoloader will automatically take care of loading the classes used from PHPCSUtils.
-#### Q: What does the `PHPCS23Utils` standard do?
-
-A: All the `PHPCS23Utils` standard does is load the `phpcsutils-autoload.php` file.
-
-PHPCS 3.x uses namespaces, while PHPCS 2.x does not. The `phpcsutils-autoload.php` file creates `class_alias`-es for the most commonly used PHPCS classes, including all PHPCS classes used by PHPCSUtils. That way, both your external standard as well as PHPCSUtils can refer to the PHPCS 3.x class names and the code will still work in PHPCS 2.x.
-
-#### Q: Why is PHP_CodeSniffer 3.5.3 not supported?
-
-A: The backfill for PHP 7.4 numeric literals with underscores in PHP_CodeSniffer 3.5.3 is broken and there is no way to reliably provide support for anything to do with numbers or `T_STRING` tokens when using PHP_CodeSniffer 3.5.3 as the tokens returned by the tokenizer are unpredictable and unreliable.
-
-The backfill was fixed in PHP_CodeSniffer 3.5.4.
-
-#### Q: Any other problematic PHPCS versions?
-
-A: Well, the arrow function backfill which was added in PHPCS 3.5.3 is still causing problems. In a very limited set of circumstances, it will even hang the Tokenizer. A fix for [one particular such problem](https://github.com/squizlabs/php_codesniffer/issues/2926) has been committed to `master`, but is not (yet) in a released version. It is expected to be released in PHP_CodeSniffer 3.5.6.
-
-As the Tokenizer hanging is a problem unrelated to PHPCSUtils and not something which can be mitigated from within PHPCSUtils in any conceivable way, PHPCSUtils won't block installation in combination with PHPCS 3.5.4 and 3.5.5.
-
-There are several other issues which can not be worked around, like scope closers being set incorrectly and throwing the scope setting off for the rest of the file, so not withstanding that PHPCSUtils can work around a lot of issues, it is still highly recommended to advise your end-users to always use the latest version of PHPCS for the most reliable results.
-
-#### Q: Does using PHPCSUtils have any effect on the PHPCS native sniffs?
+### Q: Does using PHPCSUtils have any effect on the PHPCS native sniffs?
A: No. PHPCSUtils will only work for those sniffs which explicitly use the PHPCSUtils functionality.
If your standard includes both PHPCS native sniffs as well as your own sniffs, your own sniffs can benefit from the back-compat layer offered by PHPCSUtils, as well as from the additional utility functions. However, the PHPCS native sniffs will not receive those benefits, as PHPCS itself does not use PHPCSUtils.
-#### Q: Do the utilities work with javascript/CSS files?
+### Q: Do the utilities work with javascript/CSS files?
-A: JS/CSS support will be removed from PHP_CodeSniffer in PHPCS 4.x.
-While at this time, some of the utilies _may_ work with JS/CSS files, PHPCSUtils does not offer formal support for JS/CSS sniffing with PHP_CodeSniffer and will stop any existing support once PHPCS 4.x has been released.
+A: JS/CSS support will be removed from `PHP_CodeSniffer` in PHPCS 4.x.
+While at this time, some of the utilities _may_ work with JS/CSS files, PHPCSUtils does not offer formal support for JS/CSS sniffing with `PHP_CodeSniffer` and will stop any existing support once PHPCS 4.x has been released.
-#### Q: Are all file encodings supported?
+### Q: Are all file encodings supported?
A: No. The UTF-8 file encoding is the only officially supported encoding. Support for other encodings may incidentally work, but is not officially supported.
> **It is recommended to advise your users to save their files as UTF-8 encoded for the best results.**
-PHP_CodeSniffer 3.x will default to UTF-8 as the expected file encoding.
-If your standard supports PHP_CodeSniffer 2.x, it is recommended to set the expected encoding in the ruleset to `utf-8`, like so: `
+
+## Potential Support Questions from your End-Users
-Potential Support Questions from your End-Users
--------
+
-#### Q: A user reports a fatal "class not found" error for a class from PHPCSUtils.
+### Q: A user reports a fatal "class not found" error for a class from PHPCSUtils
1. Check that the version of PHPCSUtils the user has installed complies with the minimum version of PHPCSUtils your standard requires. If not, they will need to upgrade.
2. If the version is correct, this indicates that the end-user does not have PHPCSUtils installed and/or registered with PHP_CodeSniffer.
- Please review your standard's installation instructions to make sure that PHPCSUtils will be installed when those are followed.
- Inform the user to install PHPCSUtils and register it with PHP_CodeSniffer.
+---
+
> :bulb: **Pro-tip**: if you want to prevent the fatal error and show a _friendlier_ error message instead, add `
-Contributing
--------
+## Contributing
+
Contributions to this project are welcome. Clone the repo, branch off from `develop`, make your changes, commit them and send in a pull request.
If you are unsure whether the changes you are proposing would be welcome, please open an issue first to discuss your proposal.
-License
--------
-This code is released under the [GNU Lesser General Public License (LGPLv3)](http://www.gnu.org/copyleft/lesser.html).
+
+## License
+
+This code is released under the [GNU Lesser General Public License (LGPLv3)](https://www.gnu.org/copyleft/lesser.html).
+
+
+[PHP_CodeSniffer]: https://github.com/squizlabs/PHP_CodeSniffer
+[Composer PHPCS plugin]: https://github.com/PHPCSStandards/composer-installer
+[phpcsutils-repo]: https://github.com/PHPCSStandards/PHPCSUtils
+[phpcsutils-web]: https://phpcsutils.com/
+[phpcsutils-packagist]: https://packagist.org/packages/phpcsstandards/phpcsutils
+[phpcsutils-releases]: https://github.com/PHPCSStandards/PHPCSUtils/releases
+[phpcsutils-tests-gha]: https://github.com/PHPCSStandards/PHPCSUtils/actions/workflows/test.yml
diff --git a/Tests/AbstractSniffs/AbstractArrayDeclaration/AbstractArrayDeclarationSniffTest.php b/Tests/AbstractSniffs/AbstractArrayDeclaration/AbstractArrayDeclarationSniffTest.php
index 1ea377ca..300e1173 100644
--- a/Tests/AbstractSniffs/AbstractArrayDeclaration/AbstractArrayDeclarationSniffTest.php
+++ b/Tests/AbstractSniffs/AbstractArrayDeclaration/AbstractArrayDeclarationSniffTest.php
@@ -10,8 +10,8 @@
namespace PHPCSUtils\Tests\AbstractSniffs\AbstractArrayDeclaration;
-use PHPCSUtils\Tests\AssertAttributeSame;
-use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Tests\PolyfilledTestCase;
+use PHPCSUtils\Tokens\Collections;
/**
* Tests for the \PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff class.
@@ -22,10 +22,8 @@
*
* @since 1.0.0
*/
-class AbstractArrayDeclarationSniffTest extends UtilityMethodTestCase
+final class AbstractArrayDeclarationSniffTest extends PolyfilledTestCase
{
- // Backfill for the assertAttributeSame() method on PHPUnit 9.x.
- use AssertAttributeSame;
/**
* List of methods in the abstract which should be mocked.
@@ -51,10 +49,7 @@ class AbstractArrayDeclarationSniffTest extends UtilityMethodTestCase
*/
public function testShortList()
{
- $target = $this->getTargetToken(
- '/* testShortList */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
- );
+ $target = $this->getTargetToken('/* testShortList */', Collections::arrayOpenTokensBC());
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
->setMethods($this->methodsToMock)
@@ -89,10 +84,7 @@ public function testShortList()
*/
public function testEmptyArray()
{
- $target = $this->getTargetToken(
- '/* testEmptyArray */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
- );
+ $target = $this->getTargetToken('/* testEmptyArray */', Collections::arrayOpenTokensBC());
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
->setMethods($this->methodsToMock)
@@ -129,7 +121,7 @@ public function testSingleLineShortArrayNoKeysNoTrailingComma()
{
$target = $this->getTargetToken(
'/* testSingleLineShortArrayNoKeysNoTrailingComma */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
+ Collections::arrayOpenTokensBC()
);
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
@@ -196,7 +188,7 @@ public function testMultiLineLongArrayKeysTrailingComma()
{
$target = $this->getTargetToken(
'/* testMultiLineLongArrayKeysTrailingComma */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
+ Collections::arrayOpenTokensBC()
);
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
@@ -293,7 +285,7 @@ public function testMultiLineShortArrayMixedKeysNoKeys()
{
$target = $this->getTargetToken(
'/* testMultiLineShortArrayMixedKeysNoKeys */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
+ Collections::arrayOpenTokensBC()
);
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
@@ -386,10 +378,7 @@ public function testMultiLineShortArrayMixedKeysNoKeys()
*/
public function testEmptyArrayItem()
{
- $target = $this->getTargetToken(
- '/* testEmptyArrayItem */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
- );
+ $target = $this->getTargetToken('/* testEmptyArrayItem */', Collections::arrayOpenTokensBC());
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
->setMethods($this->methodsToMock)
@@ -420,10 +409,7 @@ public function testEmptyArrayItem()
*/
public function testShortCircuitOnProcessOpenClose()
{
- $target = $this->getTargetToken(
- '/* testShortCircuit */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
- );
+ $target = $this->getTargetToken('/* testShortCircuit */', Collections::arrayOpenTokensBC());
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
->setMethods($this->methodsToMock)
@@ -458,10 +444,7 @@ public function testShortCircuitOnProcessOpenClose()
*/
public function testShortCircuitOnProcessKey()
{
- $target = $this->getTargetToken(
- '/* testShortCircuit */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
- );
+ $target = $this->getTargetToken('/* testShortCircuit */', Collections::arrayOpenTokensBC());
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
->setMethods($this->methodsToMock)
@@ -496,10 +479,7 @@ public function testShortCircuitOnProcessKey()
*/
public function testShortCircuitOnProcessNoKey()
{
- $target = $this->getTargetToken(
- '/* testShortCircuit */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
- );
+ $target = $this->getTargetToken('/* testShortCircuit */', Collections::arrayOpenTokensBC());
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
->setMethods($this->methodsToMock)
@@ -534,10 +514,7 @@ public function testShortCircuitOnProcessNoKey()
*/
public function testShortCircuitOnProcessArrow()
{
- $target = $this->getTargetToken(
- '/* testShortCircuit */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
- );
+ $target = $this->getTargetToken('/* testShortCircuit */', Collections::arrayOpenTokensBC());
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
->setMethods($this->methodsToMock)
@@ -572,10 +549,7 @@ public function testShortCircuitOnProcessArrow()
*/
public function testShortCircuitOnProcessValue()
{
- $target = $this->getTargetToken(
- '/* testShortCircuit */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
- );
+ $target = $this->getTargetToken('/* testShortCircuit */', Collections::arrayOpenTokensBC());
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
->setMethods($this->methodsToMock)
@@ -610,10 +584,7 @@ public function testShortCircuitOnProcessValue()
*/
public function testShortCircuitOnProcessComma()
{
- $target = $this->getTargetToken(
- '/* testShortCircuit */',
- [\T_ARRAY, \T_OPEN_SHORT_ARRAY, \T_OPEN_SQUARE_BRACKET]
- );
+ $target = $this->getTargetToken('/* testShortCircuit */', Collections::arrayOpenTokensBC());
$mockObj = $this->getMockBuilder('\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff')
->setMethods($this->methodsToMock)
diff --git a/Tests/AbstractSniffs/AbstractArrayDeclaration/ArrayDeclarationSniffTestDouble.php b/Tests/AbstractSniffs/AbstractArrayDeclaration/ArrayDeclarationSniffTestDouble.php
index 207810a4..b006753c 100644
--- a/Tests/AbstractSniffs/AbstractArrayDeclaration/ArrayDeclarationSniffTestDouble.php
+++ b/Tests/AbstractSniffs/AbstractArrayDeclaration/ArrayDeclarationSniffTestDouble.php
@@ -18,7 +18,7 @@
*
* @since 1.0.0
*/
-class ArrayDeclarationSniffTestDouble extends AbstractArrayDeclarationSniff
+final class ArrayDeclarationSniffTestDouble extends AbstractArrayDeclarationSniff
{
/**
diff --git a/Tests/AbstractSniffs/AbstractArrayDeclaration/GetActualArrayKeyTest.inc b/Tests/AbstractSniffs/AbstractArrayDeclaration/GetActualArrayKeyTest.inc
index f13f3af8..ab29b362 100644
--- a/Tests/AbstractSniffs/AbstractArrayDeclaration/GetActualArrayKeyTest.inc
+++ b/Tests/AbstractSniffs/AbstractArrayDeclaration/GetActualArrayKeyTest.inc
@@ -15,6 +15,14 @@ my $var text
EOD
=> 'excluded',
$var['key']{1} => 'excluded',
+ <<Test
+', foo(), ''; + +/* testOpenTagWithEcho */ +?> +Test
+', foo(), ''; + +?> $song->url()) @@ -10,3 +141,33 @@ $value = [ Text::make('Title') ]), ]; + +switch ($foo) { + /* testCaseStatement */ + case 1: + /* testInsideCaseStatement */ + $var = doSomething(); + /* testInsideCaseBreakStatement */ + break 2; + + case 2: + /* testInsideCaseContinueStatement */ + continue 2; + + case 3: + /* testInsideCaseReturnStatement */ + return false; + + case 4: + /* testInsideCaseExitStatement */ + exit(1); + + case 5: + /* testInsideCaseThrowStatement */ + throw new Exception(); + + /* testDefaultStatement */ + default: + /* testInsideDefaultContinueStatement */ + continue $var; +} diff --git a/Tests/BackCompat/BCFile/FindStartOfStatementTest.php b/Tests/BackCompat/BCFile/FindStartOfStatementTest.php index 966d5ec5..de3d91ec 100644 --- a/Tests/BackCompat/BCFile/FindStartOfStatementTest.php +++ b/Tests/BackCompat/BCFile/FindStartOfStatementTest.php @@ -20,13 +20,449 @@ * * @since 1.0.0 */ -class FindStartOfStatementTest extends UtilityMethodTestCase +final class FindStartOfStatementTest extends UtilityMethodTestCase { + /** + * Test a simple assignment. + * + * @return void + */ + public function testSimpleAssignment() + { + $start = $this->getTargetToken('/* testSimpleAssignment */', T_SEMICOLON); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 5), $found); + } + + /** + * Test a function call. + * + * @return void + */ + public function testFunctionCall() + { + $start = $this->getTargetToken('/* testFunctionCall */', T_CLOSE_PARENTHESIS); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 6), $found); + } + + /** + * Test a function call. + * + * @return void + */ + public function testFunctionCallArgument() + { + $start = $this->getTargetToken('/* testFunctionCallArgument */', T_VARIABLE, '$b'); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame($start, $found); + } + + /** + * Test a direct call to a control structure. + * + * @return void + */ + public function testControlStructure() + { + $start = $this->getTargetToken('/* testControlStructure */', T_CLOSE_CURLY_BRACKET); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 6), $found); + } + + /** + * Test the assignment of a closure. + * + * @return void + */ + public function testClosureAssignment() + { + $start = $this->getTargetToken('/* testClosureAssignment */', T_CLOSE_CURLY_BRACKET); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 12), $found); + } + + /** + * Test using a heredoc in a function argument. + * + * @return void + */ + public function testHeredocFunctionArg() + { + // Find the start of the function. + $start = $this->getTargetToken('/* testHeredocFunctionArg */', T_SEMICOLON); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 10), $found); + + // Find the start of the heredoc. + $start -= 4; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 4), $found); + + // Find the start of the last arg. + $start += 2; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame($start, $found); + } + + /** + * Test parts of a switch statement. + * + * @return void + */ + public function testSwitch() + { + // Find the start of the switch. + $start = $this->getTargetToken('/* testSwitch */', T_CLOSE_CURLY_BRACKET); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 47), $found); + + // Find the start of default case. + $start -= 5; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 6), $found); + + // Find the start of the second case. + $start -= 12; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 5), $found); + + // Find the start of the first case. + $start -= 13; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 8), $found); + + // Test inside the first case. + --$start; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 1), $found); + } + + /** + * Test statements that are array values. + * + * @return void + */ + public function testStatementAsArrayValue() + { + // Test short array syntax. + $start = $this->getTargetToken('/* testStatementAsArrayValue */', T_STRING, 'Datetime'); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 2), $found); + + // Test long array syntax. + $start += 12; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 2), $found); + + // Test same statement outside of array. + ++$start; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 9), $found); + + // Test with an array index. + $start += 17; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 5), $found); + } + + /** + * Test a use group. + * + * @return void + */ + public function testUseGroup() + { + $start = $this->getTargetToken('/* testUseGroup */', T_SEMICOLON); + $expected = parent::usesPhp8NameTokens() ? ($start - 21) : ($start - 23); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame($expected, $found); + } + + /** + * Test arrow function as array value. + * + * @return void + */ + public function testArrowFunctionArrayValue() + { + $start = $this->getTargetToken('/* testArrowFunctionArrayValue */', T_COMMA); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 9), $found); + } + + /** + * Test static arrow function. + * + * @return void + */ + public function testStaticArrowFunction() + { + $start = $this->getTargetToken('/* testStaticArrowFunction */', T_SEMICOLON); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 11), $found); + } + + /** + * Test arrow function with return value. + * + * @return void + */ + public function testArrowFunctionReturnValue() + { + $start = $this->getTargetToken('/* testArrowFunctionReturnValue */', T_SEMICOLON); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 18), $found); + } + + /** + * Test arrow function used as a function argument. + * + * @return void + */ + public function testArrowFunctionAsArgument() + { + $start = $this->getTargetToken('/* testArrowFunctionAsArgument */', T_FN); + $start += 8; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 8), $found); + } + + /** + * Test arrow function with arrays used as a function argument. + * + * @return void + */ + public function testArrowFunctionWithArrayAsArgument() + { + $start = $this->getTargetToken('/* testArrowFunctionWithArrayAsArgument */', T_FN); + $start += 17; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 17), $found); + } + + /** + * Test simple match expression case. + * + * @return void + */ + public function testMatchCase() + { + $start = $this->getTargetToken('/* testMatchCase */', T_COMMA); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 1), $found); + } + + /** + * Test simple match expression default case. + * + * @return void + */ + public function testMatchDefault() + { + $start = $this->getTargetToken('/* testMatchDefault */', T_CONSTANT_ENCAPSED_STRING, "'bar'"); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame($start, $found); + } + + /** + * Test multiple comma-separated match expression case values. + * + * @return void + */ + public function testMatchMultipleCase() + { + $start = $this->getTargetToken('/* testMatchMultipleCase */', T_MATCH_ARROW); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 6), $found); + + $start += 6; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 4), $found); + } + + /** + * Test match expression default case with trailing comma. + * + * @return void + */ + public function testMatchDefaultComma() + { + $start = $this->getTargetToken('/* testMatchDefaultComma */', T_MATCH_ARROW); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 3), $found); + + $start += 2; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame($start, $found); + } + + /** + * Test match expression with function call. + * + * @return void + */ + public function testMatchFunctionCall() + { + $start = $this->getTargetToken('/* testMatchFunctionCall */', T_CLOSE_PARENTHESIS); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 6), $found); + } + + /** + * Test match expression with function call in the arm. + * + * @return void + */ + public function testMatchFunctionCallArm() + { + // Check the first case. + $start = $this->getTargetToken('/* testMatchFunctionCallArm */', T_MATCH_ARROW); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 18), $found); + + // Check the second case. + $start += 24; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 18), $found); + } + + /** + * Test match expression with closure. + * + * @return void + */ + public function testMatchClosure() + { + $start = $this->getTargetToken('/* testMatchClosure */', T_LNUMBER); + $start += 14; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 10), $found); + + $start += 17; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 10), $found); + } + + /** + * Test match expression with array declaration. + * + * @return void + */ + public function testMatchArray() + { + // Start of first case statement. + $start = $this->getTargetToken('/* testMatchArray */', T_LNUMBER); + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + $this->assertSame($start, $found); + + // Comma after first statement. + $start += 11; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + $this->assertSame(($start - 7), $found); + + // Start of second case statement. + $start += 3; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + $this->assertSame($start, $found); + + // Comma after first statement. + $start += 30; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + $this->assertSame(($start - 26), $found); + } + + /** + * Test nested match expressions. + * + * @return void + */ + public function testNestedMatch() + { + $start = $this->getTargetToken('/* testNestedMatch */', T_LNUMBER); + $start += 30; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 26), $found); + + $start -= 4; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 1), $found); + + $start -= 3; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 2), $found); + } + + /** + * Test full PHP open tag. + * + * @return void + */ + public function testOpenTag() + { + $start = $this->getTargetToken('/* testOpenTag */', T_OPEN_TAG); + $start += 2; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 1), $found); + } + + /** + * Test PHP open tag with echo. + * + * @return void + */ + public function testOpenTagWithEcho() + { + $start = $this->getTargetToken('/* testOpenTagWithEcho */', T_OPEN_TAG_WITH_ECHO); + $start += 3; + $found = BCFile::findStartOfStatement(self::$phpcsFile, $start); + + $this->assertSame(($start - 1), $found); + } + /** * Test object call on result of static function call with arrow function as parameter and wrapped within an array. * - * @link https://github.com/squizlabs/php_codesniffer/issues/2849 + * @link https://github.com/squizlabs/PHP_CodeSniffer/issues/2849 * @link https://github.com/squizlabs/PHP_CodeSniffer/commit/fbf67efc3fc0c2a355f5585d49f4f6fe160ff2f9 * * @return void @@ -40,4 +476,110 @@ public function testObjectCallPrecededByArrowFunctionAsFunctionCallParameterInAr $this->assertSame($expected, $found); } + + /** + * Test finding the start of a statement inside a switch control structure case/default statement. + * + * @link https://github.com/squizlabs/php_codesniffer/issues/3192 + * @link https://github.com/squizlabs/PHP_CodeSniffer/pull/3186/commits/18a0e54735bb9b3850fec266e5f4c50dacf618ea + * + * @dataProvider dataFindStartInsideSwitchCaseDefaultStatements + * + * @param string $testMarker The comment which prefaces the target token in the test file. + * @param array|string|int $targets The token to search for after the test marker. + * @param string|int $expectedTarget Token code of the expected start of statement stack pointer. + * + * @return void + */ + public function testFindStartInsideSwitchCaseDefaultStatements($testMarker, $targets, $expectedTarget) + { + $testToken = $this->getTargetToken($testMarker, $targets); + $expected = $this->getTargetToken($testMarker, $expectedTarget); + + $found = BCFile::findStartOfStatement(self::$phpcsFile, $testToken); + + $this->assertSame($expected, $found); + } + + /** + * Data provider. + * + * @return array + */ + public static function dataFindStartInsideSwitchCaseDefaultStatements() + { + return [ + 'Case keyword should be start of case statement - case itself' => [ + 'testMarker' => '/* testCaseStatement */', + 'targets' => \T_CASE, + 'expectedTarget' => \T_CASE, + ], + 'Case keyword should be start of case statement - number (what\'s being compared)' => [ + 'testMarker' => '/* testCaseStatement */', + 'targets' => \T_LNUMBER, + 'expectedTarget' => \T_CASE, + ], + 'Variable should be start of arbitrary assignment statement - variable itself' => [ + 'testMarker' => '/* testInsideCaseStatement */', + 'targets' => \T_VARIABLE, + 'expectedTarget' => \T_VARIABLE, + ], + 'Variable should be start of arbitrary assignment statement - equal sign' => [ + 'testMarker' => '/* testInsideCaseStatement */', + 'targets' => \T_EQUAL, + 'expectedTarget' => \T_VARIABLE, + ], + 'Variable should be start of arbitrary assignment statement - function call' => [ + 'testMarker' => '/* testInsideCaseStatement */', + 'targets' => \T_STRING, + 'expectedTarget' => \T_VARIABLE, + ], + 'Break should be start for contents of the break statement - contents' => [ + 'testMarker' => '/* testInsideCaseBreakStatement */', + 'targets' => \T_LNUMBER, + 'expectedTarget' => \T_BREAK, + ], + 'Continue should be start for contents of the continue statement - contents' => [ + 'testMarker' => '/* testInsideCaseContinueStatement */', + 'targets' => \T_LNUMBER, + 'expectedTarget' => \T_CONTINUE, + ], + 'Return should be start for contents of the return statement - contents' => [ + 'testMarker' => '/* testInsideCaseReturnStatement */', + 'targets' => \T_FALSE, + 'expectedTarget' => \T_RETURN, + ], + 'Exit should be start for contents of the exit statement - close parenthesis' => [ + // Note: not sure if this is actually correct - should this be the open parenthesis ? + 'testMarker' => '/* testInsideCaseExitStatement */', + 'targets' => \T_CLOSE_PARENTHESIS, + 'expectedTarget' => \T_EXIT, + ], + 'Throw should be start for contents of the throw statement - new keyword' => [ + 'testMarker' => '/* testInsideCaseThrowStatement */', + 'targets' => \T_NEW, + 'expectedTarget' => \T_THROW, + ], + 'Throw should be start for contents of the throw statement - exception name' => [ + 'testMarker' => '/* testInsideCaseThrowStatement */', + 'targets' => \T_STRING, + 'expectedTarget' => \T_THROW, + ], + 'Throw should be start for contents of the throw statement - close parenthesis' => [ + 'testMarker' => '/* testInsideCaseThrowStatement */', + 'targets' => \T_CLOSE_PARENTHESIS, + 'expectedTarget' => \T_THROW, + ], + 'Default keyword should be start of default statement - default itself' => [ + 'testMarker' => '/* testDefaultStatement */', + 'targets' => \T_DEFAULT, + 'expectedTarget' => \T_DEFAULT, + ], + 'Return should be start for contents of the return statement (inside default) - variable' => [ + 'testMarker' => '/* testInsideDefaultContinueStatement */', + 'targets' => \T_VARIABLE, + 'expectedTarget' => \T_CONTINUE, + ], + ]; + } } diff --git a/Tests/BackCompat/BCFile/GetClassPropertiesTest.inc b/Tests/BackCompat/BCFile/GetClassPropertiesTest.inc index 9753d3ae..5ec030f6 100644 --- a/Tests/BackCompat/BCFile/GetClassPropertiesTest.inc +++ b/Tests/BackCompat/BCFile/GetClassPropertiesTest.inc @@ -6,6 +6,9 @@ interface NotAClass {} /* testAnonClass */ $anon = new class() {}; +/* testEnum */ +enum NotAClassEither {} + /* testClassWithoutProperties */ class ClassWithoutProperties {} @@ -29,3 +32,10 @@ abstract * @phpcs:disable Standard.Cat.SniffName -- Just because. */ class ClassWithDocblock {} + +/* testParseErrorAbstractFinal */ +final /* comment */ + + abstract // Intentional parse error, class cannot both be final and abstract. + + class AbstractFinal {} diff --git a/Tests/BackCompat/BCFile/GetClassPropertiesTest.php b/Tests/BackCompat/BCFile/GetClassPropertiesTest.php index f21dea86..c575b57d 100644 --- a/Tests/BackCompat/BCFile/GetClassPropertiesTest.php +++ b/Tests/BackCompat/BCFile/GetClassPropertiesTest.php @@ -49,8 +49,8 @@ public function testNotAClassException($testMarker, $tokenType) $this->expectPhpcsException('$stackPtr must be of type T_CLASS'); $testClass = static::TEST_CLASS; - $interface = $this->getTargetToken($testMarker, $tokenType); - $testClass::getClassProperties(self::$phpcsFile, $interface); + $target = $this->getTargetToken($testMarker, $tokenType); + $testClass::getClassProperties(self::$phpcsFile, $target); } /** @@ -71,6 +71,10 @@ public function dataNotAClassException() '/* testAnonClass */', \T_ANON_CLASS, ], + 'enum' => [ + '/* testEnum */', + \T_ENUM, + ], ]; } @@ -138,6 +142,13 @@ public function dataGetClassProperties() 'is_final' => false, ], ], + 'abstract-final-parse-error' => [ + '/* testParseErrorAbstractFinal */', + [ + 'is_abstract' => true, + 'is_final' => true, + ], + ], ]; } } diff --git a/Tests/BackCompat/BCFile/GetConditionTest.php b/Tests/BackCompat/BCFile/GetConditionTest.php index e316eebf..077cddb6 100644 --- a/Tests/BackCompat/BCFile/GetConditionTest.php +++ b/Tests/BackCompat/BCFile/GetConditionTest.php @@ -192,8 +192,13 @@ public function testNonExistentToken() */ public function testNonConditionalToken() { + $targetType = \T_STRING; + if (parent::usesPhp8NameTokens() === true) { + $targetType = \T_NAME_QUALIFIED; + } + $testClass = static::TEST_CLASS; - $stackPtr = $this->getTargetToken('/* testStartPoint */', \T_STRING); + $stackPtr = $this->getTargetToken('/* testStartPoint */', $targetType); $result = $testClass::getCondition(self::$phpcsFile, $stackPtr, \T_IF); $this->assertFalse($result); diff --git a/Tests/BackCompat/BCFile/GetDeclarationNameJSTest.php b/Tests/BackCompat/BCFile/GetDeclarationNameJSTest.php index 5e5e82e9..b34e2b70 100644 --- a/Tests/BackCompat/BCFile/GetDeclarationNameJSTest.php +++ b/Tests/BackCompat/BCFile/GetDeclarationNameJSTest.php @@ -39,7 +39,7 @@ class GetDeclarationNameJSTest extends UtilityMethodTestCase */ public function testInvalidTokenPassed() { - $this->expectPhpcsException('Token type "T_STRING" is not T_FUNCTION, T_CLASS, T_INTERFACE or T_TRAIT'); + $this->expectPhpcsException('Token type "T_STRING" is not T_FUNCTION, T_CLASS, T_INTERFACE, T_TRAIT or T_ENUM'); $target = $this->getTargetToken('/* testInvalidTokenPassed */', \T_STRING); BCFile::getDeclarationName(self::$phpcsFile, $target); @@ -93,7 +93,7 @@ public function dataGetDeclarationNameNull() public function testGetDeclarationName($testMarker, $expected, $targetType = null) { if (isset($targetType) === false) { - $targetType = [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_FUNCTION]; + $targetType = [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_ENUM, \T_FUNCTION]; } $target = $this->getTargetToken($testMarker, $targetType); @@ -134,10 +134,6 @@ public function dataGetDeclarationName() */ public function testGetDeclarationNameES6Method() { - if (\version_compare(static::$phpcsVersion, '3.0.0', '<') === true) { - $this->markTestSkipped('Support for JS ES6 method has not been backfilled for PHPCS 2.x (yet)'); - } - $target = $this->getTargetToken('/* testMethod */', [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_FUNCTION]); $result = BCFile::getDeclarationName(self::$phpcsFile, $target); $this->assertSame('methodName', $result); diff --git a/Tests/BackCompat/BCFile/GetDeclarationNameTest.inc b/Tests/BackCompat/BCFile/GetDeclarationNameTest.inc index fcb3ad05..d6d2ea42 100644 --- a/Tests/BackCompat/BCFile/GetDeclarationNameTest.inc +++ b/Tests/BackCompat/BCFile/GetDeclarationNameTest.inc @@ -28,7 +28,7 @@ $class = new class extends SomeClass { function functionName() {} /* testFunctionReturnByRef */ -function & functionNameByRef(); +function & functionNameByRef() {} /* testClass */ abstract class ClassName { @@ -69,6 +69,22 @@ class /* comment */ /* testFunctionFn */ function fn() {} +/* testPureEnum */ +enum Foo +{ + case SOME_CASE; +} + +/* testBackedEnumSpaceBetweenNameAndColon */ +enum Hoo : string +{ + case ONE = 'one'; + case TWO = 'two'; +} + +/* testBackedEnumNoSpaceBetweenNameAndColon */ +enum Suit: int implements Colorful, CardGame {} + /* testLiveCoding */ // Intentional parse error. This has to be the last test in the file. function // Comment. diff --git a/Tests/BackCompat/BCFile/GetDeclarationNameTest.php b/Tests/BackCompat/BCFile/GetDeclarationNameTest.php index 95aa9981..43285e3c 100644 --- a/Tests/BackCompat/BCFile/GetDeclarationNameTest.php +++ b/Tests/BackCompat/BCFile/GetDeclarationNameTest.php @@ -32,7 +32,7 @@ class GetDeclarationNameTest extends UtilityMethodTestCase */ public function testInvalidTokenPassed() { - $this->expectPhpcsException('Token type "T_STRING" is not T_FUNCTION, T_CLASS, T_INTERFACE or T_TRAIT'); + $this->expectPhpcsException('Token type "T_STRING" is not T_FUNCTION, T_CLASS, T_INTERFACE, T_TRAIT or T_ENUM'); $target = $this->getTargetToken('/* testInvalidTokenPassed */', \T_STRING); BCFile::getDeclarationName(self::$phpcsFile, $target); @@ -85,11 +85,6 @@ public function dataGetDeclarationNameNull() '/* testAnonClassExtendsWithoutParens */', \T_ANON_CLASS, ], - - /* - * Note: this particular test *will* throw tokenizer "undefined offset" notices on PHPCS 2.6.0, - * but the test will pass. - */ 'live-coding' => [ '/* testLiveCoding */', \T_FUNCTION, @@ -111,7 +106,7 @@ public function dataGetDeclarationNameNull() public function testGetDeclarationName($testMarker, $expected, $targetType = null) { if (isset($targetType) === false) { - $targetType = [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_FUNCTION]; + $targetType = [\T_CLASS, \T_INTERFACE, \T_TRAIT, \T_ENUM, \T_FUNCTION]; } $target = $this->getTargetToken($testMarker, $targetType); @@ -185,6 +180,18 @@ public function dataGetDeclarationName() '/* testFunctionFn */', 'fn', ], + 'enum-pure' => [ + '/* testPureEnum */', + 'Foo', + ], + 'enum-backed-space-between-name-and-colon' => [ + '/* testBackedEnumSpaceBetweenNameAndColon */', + 'Hoo', + ], + 'enum-backed-no-space-between-name-and-colon' => [ + '/* testBackedEnumNoSpaceBetweenNameAndColon */', + 'Suit', + ], ]; } } diff --git a/Tests/BackCompat/BCFile/GetMemberPropertiesTest.inc b/Tests/BackCompat/BCFile/GetMemberPropertiesTest.inc index b50f8a1a..48fde8c0 100644 --- a/Tests/BackCompat/BCFile/GetMemberPropertiesTest.inc +++ b/Tests/BackCompat/BCFile/GetMemberPropertiesTest.inc @@ -182,3 +182,136 @@ function_call( 'param', new class { /* testNestedMethodParam 2 */ public function __construct( $open, $post_id ) {} }, 10, 2 ); + +class PHP8Mixed { + /* testPHP8MixedTypeHint */ + public static miXed $mixed; + + /* testPHP8MixedTypeHintNullable */ + // Intentional fatal error - nullability is not allowed with mixed, but that's not the concern of the method. + private ?mixed $nullableMixed; +} + +class NSOperatorInType { + /* testNamespaceOperatorTypeHint */ + public ?namespace\Name $prop; +} + +$anon = class() { + /* testPHP8UnionTypesSimple */ + public int|float $unionTypeSimple; + + /* testPHP8UnionTypesTwoClasses */ + private MyClassA|\Package\MyClassB $unionTypesTwoClasses; + + /* testPHP8UnionTypesAllBaseTypes */ + protected array|bool|int|float|NULL|object|string $unionTypesAllBaseTypes; + + /* testPHP8UnionTypesAllPseudoTypes */ + // Intentional fatal error - mixing types which cannot be combined, but that's not the concern of the method. + var false|mixed|self|parent|iterable|Resource $unionTypesAllPseudoTypes; + + /* testPHP8UnionTypesIllegalTypes */ + // Intentional fatal error - types which are not allowed for properties, but that's not the concern of the method. + public callable|static|void $unionTypesIllegalTypes; + + /* testPHP8UnionTypesNullable */ + // Intentional fatal error - nullability is not allowed with union types, but that's not the concern of the method. + public ?int|float $unionTypesNullable; + + /* testPHP8PseudoTypeNull */ + // Intentional fatal error - null pseudotype is only allowed in union types, but that's not the concern of the method. + public null $pseudoTypeNull; + + /* testPHP8PseudoTypeFalse */ + // Intentional fatal error - false pseudotype is only allowed in union types, but that's not the concern of the method. + public false $pseudoTypeFalse; + + /* testPHP8PseudoTypeFalseAndBool */ + // Intentional fatal error - false pseudotype is not allowed in combination with bool, but that's not the concern of the method. + public bool|FALSE $pseudoTypeFalseAndBool; + + /* testPHP8ObjectAndClass */ + // Intentional fatal error - object is not allowed in combination with class name, but that's not the concern of the method. + public object|ClassName $objectAndClass; + + /* testPHP8PseudoTypeIterableAndArray */ + // Intentional fatal error - iterable pseudotype is not allowed in combination with array or Traversable, but that's not the concern of the method. + public iterable|array|Traversable $pseudoTypeIterableAndArray; + + /* testPHP8DuplicateTypeInUnionWhitespaceAndComment */ + // Intentional fatal error - duplicate types are not allowed in union types, but that's not the concern of the method. + public int |string| /*comment*/ INT $duplicateTypeInUnion; + + /* testPHP81Readonly */ + public readonly int $readonly; + + /* testPHP81ReadonlyWithNullableType */ + public readonly ?array $readonlyWithNullableType; + + /* testPHP81ReadonlyWithUnionType */ + public readonly string|int $readonlyWithUnionType; + + /* testPHP81ReadonlyWithUnionTypeWithNull */ + protected ReadOnly string|null $readonlyWithUnionTypeWithNull; + + /* testPHP81OnlyReadonlyWithUnionType */ + readonly string|int $onlyReadonly; + + /* testPHP81OnlyReadonlyWithUnionTypeMultiple */ + readonly \InterfaceA|\Sub\InterfaceB|false + $onlyReadonly; + + /* testPHP81ReadonlyAndStatic */ + readonly private static ?string $readonlyAndStatic; + + /* testPHP81ReadonlyMixedCase */ + public ReadONLY static $readonlyMixedCase; +}; + +$anon = class { + /* testPHP8PropertySingleAttribute */ + #[PropertyWithAttribute] + public string $foo; + + /* testPHP8PropertyMultipleAttributes */ + #[PropertyWithAttribute(foo: 'bar'), MyAttribute] + protected ?int|float $bar; + + /* testPHP8PropertyMultilineAttribute */ + #[ + PropertyWithAttribute(/* comment */ 'baz') + ] + private mixed $baz; +}; + +enum Suit +{ + /* testEnumProperty */ + protected $anonymous; +} + +enum Direction implements ArrayAccess +{ + case Up; + case Down; + + /* testEnumMethodParamNotProperty */ + public function offsetGet($val) { ... } +} + +$anon = class() { + /* testPHP81IntersectionTypes */ + public Foo&Bar $intersectionType; + + /* testPHP81MoreIntersectionTypes */ + public Foo&Bar&Baz $moreIntersectionTypes; + + /* testPHP81IllegalIntersectionTypes */ + // Intentional fatal error - types which are not allowed for intersection type, but that's not the concern of the method. + public int&string $illegalIntersectionType; + + /* testPHP81NullableIntersectionType */ + // Intentional fatal error - nullability is not allowed with intersection type, but that's not the concern of the method. + public ?Foo&Bar $nullableIntersectionType; +}; diff --git a/Tests/BackCompat/BCFile/GetMemberPropertiesTest.php b/Tests/BackCompat/BCFile/GetMemberPropertiesTest.php index ce3d32bb..09c68526 100644 --- a/Tests/BackCompat/BCFile/GetMemberPropertiesTest.php +++ b/Tests/BackCompat/BCFile/GetMemberPropertiesTest.php @@ -82,503 +82,941 @@ public function testGetMemberProperties($identifier, $expected) */ public function dataGetMemberProperties() { + $php8Names = parent::usesPhp8NameTokens(); + return [ - [ + 'var-modifier' => [ '/* testVar */', [ 'scope' => 'public', 'scope_specified' => false, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'var-modifier-and-type' => [ '/* testVarType */', [ 'scope' => 'public', 'scope_specified' => false, 'is_static' => false, + 'is_readonly' => false, 'type' => '?int', 'type_token' => -2, // Offset from the T_VARIABLE token. 'type_end_token' => -2, // Offset from the T_VARIABLE token. 'nullable_type' => true, ], ], - [ + 'public-modifier' => [ '/* testPublic */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'public-modifier-and-type' => [ '/* testPublicType */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => 'string', 'type_token' => -2, // Offset from the T_VARIABLE token. 'type_end_token' => -2, // Offset from the T_VARIABLE token. 'nullable_type' => false, ], ], - [ + 'protected-modifier' => [ '/* testProtected */', [ 'scope' => 'protected', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'protected-modifier-and-type' => [ '/* testProtectedType */', [ 'scope' => 'protected', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => 'bool', 'type_token' => -2, // Offset from the T_VARIABLE token. 'type_end_token' => -2, // Offset from the T_VARIABLE token. 'nullable_type' => false, ], ], - [ + 'private-modifier' => [ '/* testPrivate */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'private-modifier-and-type' => [ '/* testPrivateType */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => 'array', 'type_token' => -2, // Offset from the T_VARIABLE token. 'type_end_token' => -2, // Offset from the T_VARIABLE token. 'nullable_type' => false, ], ], - [ + 'static-modifier' => [ '/* testStatic */', [ 'scope' => 'public', 'scope_specified' => false, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'static-modifier-and-type' => [ '/* testStaticType */', [ 'scope' => 'public', 'scope_specified' => false, 'is_static' => true, + 'is_readonly' => false, 'type' => '?string', 'type_token' => -2, // Offset from the T_VARIABLE token. 'type_end_token' => -2, // Offset from the T_VARIABLE token. 'nullable_type' => true, ], ], - [ + 'static-and-var-modifier' => [ '/* testStaticVar */', [ 'scope' => 'public', 'scope_specified' => false, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'var-and-static-modifier' => [ '/* testVarStatic */', [ 'scope' => 'public', 'scope_specified' => false, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'public-static-modifiers' => [ '/* testPublicStatic */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'protected-static-modifiers' => [ '/* testProtectedStatic */', [ 'scope' => 'protected', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'private-static-modifiers' => [ '/* testPrivateStatic */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'no-modifier' => [ '/* testNoPrefix */', [ 'scope' => 'public', 'scope_specified' => false, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'public-and-static-modifier-with-docblock' => [ '/* testPublicStaticWithDocblock */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'protected-and-static-modifier-with-docblock' => [ '/* testProtectedStaticWithDocblock */', [ 'scope' => 'protected', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'private-and-static-modifier-with-docblock' => [ '/* testPrivateStaticWithDocblock */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'property-group-simple-type-prop-1' => [ '/* testGroupType 1 */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => 'float', 'type_token' => -6, // Offset from the T_VARIABLE token. 'type_end_token' => -6, // Offset from the T_VARIABLE token. 'nullable_type' => false, ], ], - [ + 'property-group-simple-type-prop-2' => [ '/* testGroupType 2 */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => 'float', 'type_token' => -13, // Offset from the T_VARIABLE token. 'type_end_token' => -13, // Offset from the T_VARIABLE token. 'nullable_type' => false, ], ], - [ + 'property-group-nullable-type-prop-1' => [ '/* testGroupNullableType 1 */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '?string', 'type_token' => -6, // Offset from the T_VARIABLE token. 'type_end_token' => -6, // Offset from the T_VARIABLE token. 'nullable_type' => true, ], ], - [ + 'property-group-nullable-type-prop-2' => [ '/* testGroupNullableType 2 */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '?string', 'type_token' => -17, // Offset from the T_VARIABLE token. 'type_end_token' => -17, // Offset from the T_VARIABLE token. 'nullable_type' => true, ], ], - [ + 'property-group-protected-static-prop-1' => [ '/* testGroupProtectedStatic 1 */', [ 'scope' => 'protected', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'property-group-protected-static-prop-2' => [ '/* testGroupProtectedStatic 2 */', [ 'scope' => 'protected', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'property-group-protected-static-prop-3' => [ '/* testGroupProtectedStatic 3 */', [ 'scope' => 'protected', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'property-group-private-prop-1' => [ '/* testGroupPrivate 1 */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'property-group-private-prop-2' => [ '/* testGroupPrivate 2 */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'property-group-private-prop-3' => [ '/* testGroupPrivate 3 */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'property-group-private-prop-4' => [ '/* testGroupPrivate 4 */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'property-group-private-prop-5' => [ '/* testGroupPrivate 5 */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'property-group-private-prop-6' => [ '/* testGroupPrivate 6 */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'property-group-private-prop-7' => [ '/* testGroupPrivate 7 */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'messy-nullable-type' => [ '/* testMessyNullableType */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '?array', 'type_token' => -2, // Offset from the T_VARIABLE token. 'type_end_token' => -2, // Offset from the T_VARIABLE token. 'nullable_type' => true, ], ], - [ + 'fqn-type' => [ '/* testNamespaceType */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '\MyNamespace\MyClass', - 'type_token' => -5, // Offset from the T_VARIABLE token. + 'type_token' => ($php8Names === true) ? -2 : -5, // Offset from the T_VARIABLE token. 'type_end_token' => -2, // Offset from the T_VARIABLE token. 'nullable_type' => false, ], ], - [ + 'nullable-classname-type' => [ '/* testNullableNamespaceType 1 */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '?ClassName', 'type_token' => -2, // Offset from the T_VARIABLE token. 'type_end_token' => -2, // Offset from the T_VARIABLE token. 'nullable_type' => true, ], ], - [ + 'nullable-namespace-relative-class-type' => [ '/* testNullableNamespaceType 2 */', [ 'scope' => 'protected', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '?Folder\ClassName', - 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_token' => ($php8Names === true) ? -2 : -4, // Offset from the T_VARIABLE token. 'type_end_token' => -2, // Offset from the T_VARIABLE token. 'nullable_type' => true, ], ], - [ + 'multiline-namespaced-type' => [ '/* testMultilineNamespaceType */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '\MyNamespace\MyClass\Foo', - 'type_token' => -18, // Offset from the T_VARIABLE token. + 'type_token' => ($php8Names === true) ? -15 : -18, // Offset from the T_VARIABLE token. 'type_end_token' => -2, // Offset from the T_VARIABLE token. 'nullable_type' => false, ], ], - [ + 'property-after-method' => [ '/* testPropertyAfterMethod */', [ 'scope' => 'private', 'scope_specified' => true, 'is_static' => true, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'invalid-property-in-interface' => [ '/* testInterfaceProperty */', [], ], - [ + 'property-in-nested-class-1' => [ '/* testNestedProperty 1 */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], - [ + 'property-in-nested-class-2' => [ '/* testNestedProperty 2 */', [ 'scope' => 'public', 'scope_specified' => true, 'is_static' => false, + 'is_readonly' => false, 'type' => '', 'type_token' => false, 'type_end_token' => false, 'nullable_type' => false, ], ], + 'php8-mixed-type' => [ + '/* testPHP8MixedTypeHint */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => true, + 'is_readonly' => false, + 'type' => 'miXed', + 'type_token' => -2, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-nullable-mixed-type' => [ + '/* testPHP8MixedTypeHintNullable */', + [ + 'scope' => 'private', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => '?mixed', + 'type_token' => -2, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => true, + ], + ], + 'namespace-operator-type-declaration' => [ + '/* testNamespaceOperatorTypeHint */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => '?namespace\Name', + 'type_token' => ($php8Names === true) ? -2 : -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => true, + ], + ], + 'php8-union-types-simple' => [ + '/* testPHP8UnionTypesSimple */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'int|float', + 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-union-types-two-classes' => [ + '/* testPHP8UnionTypesTwoClasses */', + [ + 'scope' => 'private', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'MyClassA|\Package\MyClassB', + 'type_token' => ($php8Names === true) ? -4 : -7, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-union-types-all-base-types' => [ + '/* testPHP8UnionTypesAllBaseTypes */', + [ + 'scope' => 'protected', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'array|bool|int|float|NULL|object|string', + 'type_token' => -14, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-union-types-all-pseudo-types' => [ + '/* testPHP8UnionTypesAllPseudoTypes */', + [ + 'scope' => 'public', + 'scope_specified' => false, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'false|mixed|self|parent|iterable|Resource', + 'type_token' => -12, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-union-types-illegal-types' => [ + '/* testPHP8UnionTypesIllegalTypes */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + // Missing static, but that's OK as not an allowed syntax. + 'type' => 'callable||void', + 'type_token' => -6, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-union-types-nullable' => [ + '/* testPHP8UnionTypesNullable */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => '?int|float', + 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => true, + ], + ], + 'php8-union-types-pseudo-type-null' => [ + '/* testPHP8PseudoTypeNull */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'null', + 'type_token' => -2, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-union-types-pseudo-type-false' => [ + '/* testPHP8PseudoTypeFalse */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'false', + 'type_token' => -2, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-union-types-pseudo-type-false-and-bool' => [ + '/* testPHP8PseudoTypeFalseAndBool */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'bool|FALSE', + 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-union-types-object-and-class' => [ + '/* testPHP8ObjectAndClass */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'object|ClassName', + 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-union-types-pseudo-type-iterable-and-array' => [ + '/* testPHP8PseudoTypeIterableAndArray */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'iterable|array|Traversable', + 'type_token' => -6, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-union-types-duplicate-type-with-whitespace-and-comments' => [ + '/* testPHP8DuplicateTypeInUnionWhitespaceAndComment */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'int|string|INT', + 'type_token' => -10, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8.1-readonly-property' => [ + '/* testPHP81Readonly */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => true, + 'type' => 'int', + 'type_token' => -2, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8.1-readonly-property-with-nullable-type' => [ + '/* testPHP81ReadonlyWithNullableType */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => true, + 'type' => '?array', + 'type_token' => -2, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => true, + ], + ], + 'php8.1-readonly-property-with-union-type' => [ + '/* testPHP81ReadonlyWithUnionType */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => true, + 'type' => 'string|int', + 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8.1-readonly-property-with-union-type-with-null' => [ + '/* testPHP81ReadonlyWithUnionTypeWithNull */', + [ + 'scope' => 'protected', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => true, + 'type' => 'string|null', + 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8.1-readonly-property-with-union-type-no-visibility' => [ + '/* testPHP81OnlyReadonlyWithUnionType */', + [ + 'scope' => 'public', + 'scope_specified' => false, + 'is_static' => false, + 'is_readonly' => true, + 'type' => 'string|int', + 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8.1-readonly-property-with-multi-union-type-no-visibility' => [ + '/* testPHP81OnlyReadonlyWithUnionTypeMultiple */', + [ + 'scope' => 'public', + 'scope_specified' => false, + 'is_static' => false, + 'is_readonly' => true, + 'type' => '\InterfaceA|\Sub\InterfaceB|false', + 'type_token' => ($php8Names === true) ? -7 : -11, // Offset from the T_VARIABLE token. + 'type_end_token' => -3, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8.1-readonly-and-static-property' => [ + '/* testPHP81ReadonlyAndStatic */', + [ + 'scope' => 'private', + 'scope_specified' => true, + 'is_static' => true, + 'is_readonly' => true, + 'type' => '?string', + 'type_token' => -2, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => true, + ], + ], + 'php8.1-readonly-mixed-case-keyword' => [ + '/* testPHP81ReadonlyMixedCase */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => true, + 'is_readonly' => true, + 'type' => '', + 'type_token' => false, + 'type_end_token' => false, + 'nullable_type' => false, + ], + ], + 'php8-property-with-single-attribute' => [ + '/* testPHP8PropertySingleAttribute */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'string', + 'type_token' => -2, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8-property-with-multiple-attributes' => [ + '/* testPHP8PropertyMultipleAttributes */', + [ + 'scope' => 'protected', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => '?int|float', + 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => true, + ], + ], + 'php8-property-with-multiline-attribute' => [ + '/* testPHP8PropertyMultilineAttribute */', + [ + 'scope' => 'private', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'mixed', + 'type_token' => -2, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'invalid-property-in-enum' => [ + '/* testEnumProperty */', + [], + ], + 'php8.1-single-intersection-type' => [ + '/* testPHP81IntersectionTypes */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'Foo&Bar', + 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8.1-multi-intersection-type' => [ + '/* testPHP81MoreIntersectionTypes */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'Foo&Bar&Baz', + 'type_token' => -6, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8.1-illegal-intersection-type' => [ + '/* testPHP81IllegalIntersectionTypes */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => 'int&string', + 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => false, + ], + ], + 'php8.1-nullable-intersection-type' => [ + '/* testPHP81NullableIntersectionType */', + [ + 'scope' => 'public', + 'scope_specified' => true, + 'is_static' => false, + 'is_readonly' => false, + 'type' => '?Foo&Bar', + 'type_token' => -4, // Offset from the T_VARIABLE token. + 'type_end_token' => -2, // Offset from the T_VARIABLE token. + 'nullable_type' => true, + ], + ], ]; } @@ -617,6 +1055,7 @@ public function dataNotClassProperty() ['/* testGlobalVariable */'], ['/* testNestedMethodParam 1 */'], ['/* testNestedMethodParam 2 */'], + ['/* testEnumMethodParamNotProperty */'], ]; } diff --git a/Tests/BackCompat/BCFile/GetMethodParametersParseError1Test.php b/Tests/BackCompat/BCFile/GetMethodParametersParseError1Test.php index cd86d071..9c3358f8 100644 --- a/Tests/BackCompat/BCFile/GetMethodParametersParseError1Test.php +++ b/Tests/BackCompat/BCFile/GetMethodParametersParseError1Test.php @@ -12,6 +12,7 @@ use PHPCSUtils\BackCompat\BCFile; use PHPCSUtils\TestUtils\UtilityMethodTestCase; +use PHPCSUtils\Tokens\Collections; /** * Tests for the \PHPCSUtils\BackCompat\BCFile::getMethodParameters method. @@ -22,7 +23,7 @@ * * @since 1.0.0 */ -class GetMethodParametersParseError1Test extends UtilityMethodTestCase +final class GetMethodParametersParseError1Test extends UtilityMethodTestCase { /** @@ -32,7 +33,7 @@ class GetMethodParametersParseError1Test extends UtilityMethodTestCase */ public function testParseError() { - $target = $this->getTargetToken('/* testParseError */', [\T_FUNCTION, \T_CLOSURE]); + $target = $this->getTargetToken('/* testParseError */', Collections::functionDeclarationTokens()); $result = BCFile::getMethodParameters(self::$phpcsFile, $target); $this->assertSame([], $result); diff --git a/Tests/BackCompat/BCFile/GetMethodParametersParseError2Test.php b/Tests/BackCompat/BCFile/GetMethodParametersParseError2Test.php index 08da2c2d..3324266f 100644 --- a/Tests/BackCompat/BCFile/GetMethodParametersParseError2Test.php +++ b/Tests/BackCompat/BCFile/GetMethodParametersParseError2Test.php @@ -12,6 +12,7 @@ use PHPCSUtils\BackCompat\BCFile; use PHPCSUtils\TestUtils\UtilityMethodTestCase; +use PHPCSUtils\Tokens\Collections; /** * Tests for the \PHPCSUtils\BackCompat\BCFile::getMethodParameters method. @@ -22,7 +23,7 @@ * * @since 1.0.0 */ -class GetMethodParametersParseError2Test extends UtilityMethodTestCase +final class GetMethodParametersParseError2Test extends UtilityMethodTestCase { /** @@ -32,7 +33,7 @@ class GetMethodParametersParseError2Test extends UtilityMethodTestCase */ public function testParseError() { - $target = $this->getTargetToken('/* testParseError */', [\T_FUNCTION, \T_CLOSURE]); + $target = $this->getTargetToken('/* testParseError */', Collections::functionDeclarationTokens()); $result = BCFile::getMethodParameters(self::$phpcsFile, $target); $this->assertSame([], $result); diff --git a/Tests/BackCompat/BCFile/GetMethodParametersTest.inc b/Tests/BackCompat/BCFile/GetMethodParametersTest.inc index 922c59fd..e2991b67 100644 --- a/Tests/BackCompat/BCFile/GetMethodParametersTest.inc +++ b/Tests/BackCompat/BCFile/GetMethodParametersTest.inc @@ -30,6 +30,15 @@ function passByReference(&$var) {} /* testArrayHint */ function arrayHint(array $var) {} +/* testVariable */ +function variable($var) {} + +/* testSingleDefaultValue */ +function defaultValue($var1=self::CONSTANT) {} + +/* testDefaultValues */ +function defaultValues($var1=1, $var2='value') {} + /* testTypeHint */ function typeHint(foo $var1, bar $var2) {} @@ -41,15 +50,6 @@ class MyClass { /* testNullableTypeHint */ function nullableTypeHint(?int $var1, ?\bar $var2) {} -/* testVariable */ -function variable($var) {} - -/* testSingleDefaultValue */ -function defaultValue($var1=self::CONSTANT) {} - -/* testDefaultValues */ -function defaultValues($var1=1, $var2='value') {} - /* testBitwiseAndConstantExpressionDefaultValue */ function myFunction($a = 10 & 20) {} @@ -125,23 +125,181 @@ function messyDeclaration( & /*test*/ ... /* phpcs:ignore */ $c ) {} +/* testPHP8MixedTypeHint */ +function mixedTypeHint(mixed &...$var1) {} + +/* testPHP8MixedTypeHintNullable */ +// Intentional fatal error - nullability is not allowed with mixed, but that's not the concern of the method. +function mixedTypeHintNullable(?Mixed $var1) {} + +/* testNamespaceOperatorTypeHint */ +function namespaceOperatorTypeHint(?namespace\Name $var1) {} + +/* testPHP8UnionTypesSimple */ +function unionTypeSimple(int|float $number, self|parent &...$obj) {} + +/* testPHP8UnionTypesWithSpreadOperatorAndReference */ +function globalFunctionWithSpreadAndReference(float|null &$paramA, string|int ...$paramB ) {} + +/* testPHP8UnionTypesSimpleWithBitwiseOrInDefault */ +$fn = fn(int|float $var = CONSTANT_A | CONSTANT_B) => $var; + +/* testPHP8UnionTypesTwoClasses */ +function unionTypesTwoClasses(MyClassA|\Package\MyClassB $var) {} + +/* testPHP8UnionTypesAllBaseTypes */ +function unionTypesAllBaseTypes(array|bool|callable|int|float|null|object|string $var) {} + +/* testPHP8UnionTypesAllPseudoTypes */ +// Intentional fatal error - mixing types which cannot be combined, but that's not the concern of the method. +function unionTypesAllPseudoTypes(false|mixed|self|parent|iterable|Resource $var) {} + +/* testPHP8UnionTypesNullable */ +// Intentional fatal error - nullability is not allowed with union types, but that's not the concern of the method. +$closure = function (?int|float $number) {}; + +/* testPHP8PseudoTypeNull */ +// Intentional fatal error - null pseudotype is only allowed in union types, but that's not the concern of the method. +function pseudoTypeNull(null $var = null) {} + +/* testPHP8PseudoTypeFalse */ +// Intentional fatal error - false pseudotype is only allowed in union types, but that's not the concern of the method. +function pseudoTypeFalse(false $var = false) {} + +/* testPHP8PseudoTypeFalseAndBool */ +// Intentional fatal error - false pseudotype is not allowed in combination with bool, but that's not the concern of the method. +function pseudoTypeFalseAndBool(bool|false $var = false) {} + +/* testPHP8ObjectAndClass */ +// Intentional fatal error - object is not allowed in combination with class name, but that's not the concern of the method. +function objectAndClass(object|ClassName $var) {} + +/* testPHP8PseudoTypeIterableAndArray */ +// Intentional fatal error - iterable pseudotype is not allowed in combination with array or Traversable, but that's not the concern of the method. +function pseudoTypeIterableAndArray(iterable|array|Traversable $var) {} + +/* testPHP8DuplicateTypeInUnionWhitespaceAndComment */ +// Intentional fatal error - duplicate types are not allowed in union types, but that's not the concern of the method. +function duplicateTypeInUnion( int | string /*comment*/ | INT $var) {} + +class ConstructorPropertyPromotionNoTypes { + /* testPHP8ConstructorPropertyPromotionNoTypes */ + public function __construct( + public $x = 0.0, + protected $y = '', + private $z = null, + ) {} +} + +class ConstructorPropertyPromotionWithTypes { + /* testPHP8ConstructorPropertyPromotionWithTypes */ + public function __construct(protected float|int $x, public ?string &$y = 'test', private mixed $z) {} +} + +class ConstructorPropertyPromotionAndNormalParams { + /* testPHP8ConstructorPropertyPromotionAndNormalParam */ + public function __construct(public int $promotedProp, ?int $normalArg) {} +} + +class ConstructorPropertyPromotionWithReadOnly { + /* testPHP81ConstructorPropertyPromotionWithReadOnly */ + public function __construct(public readonly ?int $promotedProp, ReadOnly private string|bool &$promotedToo) {} +} + +/* testPHP8ConstructorPropertyPromotionGlobalFunction */ +// Intentional fatal error. Property promotion not allowed in non-constructor, but that's not the concern of this method. +function globalFunction(private $x) {} + +abstract class ConstructorPropertyPromotionAbstractMethod { + /* testPHP8ConstructorPropertyPromotionAbstractMethod */ + // Intentional fatal error. + // 1. Property promotion not allowed in abstract method, but that's not the concern of this method. + // 2. Variadic arguments not allowed in property promotion, but that's not the concern of this method. + // 3. The callable type is not supported for properties, but that's not the concern of this method. + abstract public function __construct(public callable $y, private ...$x); +} + +/* testCommentsInParameter */ +function commentsInParams( + // Leading comment. + ?MyClass /*-*/ & /*-*/.../*-*/ $param /*-*/ = /*-*/ 'default value' . /*-*/ 'second part' // Trailing comment. +) {} + +/* testParameterAttributesInFunctionDeclaration */ +class ParametersWithAttributes( + public function __construct( + #[\MyExample\MyAttribute] private string $constructorPropPromTypedParamSingleAttribute, + #[MyAttr([1, 2])] + Type|false + $typedParamSingleAttribute, + #[MyAttribute(1234), MyAttribute(5678)] ?int $nullableTypedParamMultiAttribute, + #[WithoutArgument] #[SingleArgument(0)] $nonTypedParamTwoAttributes, + #[MyAttribute(array("key" => "value"))] + &...$otherParam, + ) {} +} + +/* testPHP8IntersectionTypes */ +function intersectionTypes(Foo&Bar $obj1, Boo&Bar $obj2) {} + +/* testPHP81IntersectionTypesWithSpreadOperatorAndReference */ +function globalFunctionWithSpreadAndReference(Boo&Bar &$paramA, Foo&Bar ...$paramB) {} + +/* testPHP81MoreIntersectionTypes */ +function moreIntersectionTypes(MyClassA&\Package\MyClassB&\Package\MyClassC $var) {} + +/* testPHP81IllegalIntersectionTypes */ +// Intentional fatal error - simple types are not allowed with intersection types, but that's not the concern of the method. +$closure = function (string&int $numeric_string) {}; + +/* testPHP81NullableIntersectionTypes */ +// Intentional fatal error - nullability is not allowed with intersection types, but that's not the concern of the method. +$closure = function (?Foo&Bar $object) {}; + +/* testPHP81NewInInitializers */ +function newInInitializers( + TypeA $new = new TypeA(self::CONST_VALUE), + \Package\TypeB $newToo = new \Package\TypeB(10, 'string'), +) {} + /* testFunctionCallFnPHPCS353-354 */ $value = $obj->fn(true); /* testClosureNoParams */ -function() {} +function() {}; /* testClosure */ -function( $a = 'test' ) {} +function( $a = 'test' ) {}; /* testClosureUseNoParams */ -function() use() {} +function() use() {}; /* testClosureUse */ -function() use( $foo, $bar ) {} +function() use( $foo, $bar ) {}; + +/* testFunctionParamListWithTrailingComma */ +function trailingComma( + ?string $foo /*comment*/ , + $bar = 0, +) {} + +/* testClosureParamListWithTrailingComma */ +function( + $foo, + $bar, +) {}; + +/* testArrowFunctionParamListWithTrailingComma */ +$fn = fn( ?int $a , ...$b, ) => $b; + +/* testClosureUseWithTrailingComma */ +function() use( + $foo /*comment*/ , + $bar, +) {}; /* testInvalidUse */ -function() use {} // Intentional parse error. +function() use {}; // Intentional parse error. /* testArrowFunctionLiveCoding */ // Intentional parse error. This has to be the last test in the file. diff --git a/Tests/BackCompat/BCFile/GetMethodParametersTest.php b/Tests/BackCompat/BCFile/GetMethodParametersTest.php index 302403fa..e47336aa 100644 --- a/Tests/BackCompat/BCFile/GetMethodParametersTest.php +++ b/Tests/BackCompat/BCFile/GetMethodParametersTest.php @@ -25,7 +25,6 @@ use PHPCSUtils\BackCompat\BCFile; use PHPCSUtils\TestUtils\UtilityMethodTestCase; -use PHPCSUtils\Tokens\Collections; /** * Tests for the \PHPCSUtils\BackCompat\BCFile::getMethodParameters method. @@ -73,11 +72,11 @@ public function dataUnexpectedTokenException() ], 'function-call-fn-phpcs-3.5.3-3.5.4' => [ '/* testFunctionCallFnPHPCS353-354 */', - Collections::arrowFunctionTokensBC(), + [T_FN, T_STRING], ], 'fn-live-coding' => [ '/* testArrowFunctionLiveCoding */', - Collections::arrowFunctionTokensBC(), + [T_FN, T_STRING], ], ]; } @@ -123,11 +122,11 @@ public function dataInvalidUse() * * @param string $commentString The comment which preceeds the test. * @param array $targetTokenType Optional. The token type to search for after $commentString. - * Defaults to the function/closure tokens. + * Defaults to the function/closure/arrow tokens. * * @return void */ - public function testNoParams($commentString, $targetTokenType = [T_FUNCTION, T_CLOSURE]) + public function testNoParams($commentString, $targetTokenType = [T_FUNCTION, T_CLOSURE, \T_FN]) { $target = $this->getTargetToken($commentString, $targetTokenType); $result = BCFile::getMethodParameters(self::$phpcsFile, $target); @@ -163,6 +162,7 @@ public function testPassByReference() 'token' => 5, // Offset from the T_FUNCTION token. 'name' => '$var', 'content' => '&$var', + 'has_attributes' => false, 'pass_by_reference' => true, 'reference_token' => 4, // Offset from the T_FUNCTION token. 'variable_length' => false, @@ -189,6 +189,7 @@ public function testArrayHint() 'token' => 6, // Offset from the T_FUNCTION token. 'name' => '$var', 'content' => 'array $var', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -204,39 +205,25 @@ public function testArrayHint() } /** - * Verify type hint parsing. + * Verify variable. * * @return void */ - public function testTypeHint() + public function testVariable() { $expected = []; $expected[0] = [ - 'token' => 6, // Offset from the T_FUNCTION token. - 'name' => '$var1', - 'content' => 'foo $var1', - 'pass_by_reference' => false, - 'reference_token' => false, - 'variable_length' => false, - 'variadic_token' => false, - 'type_hint' => 'foo', - 'type_hint_token' => 4, // Offset from the T_FUNCTION token. - 'type_hint_end_token' => 4, // Offset from the T_FUNCTION token. - 'nullable_type' => false, - 'comma_token' => 7, // Offset from the T_FUNCTION token. - ]; - - $expected[1] = [ - 'token' => 11, // Offset from the T_FUNCTION token. - 'name' => '$var2', - 'content' => 'bar $var2', + 'token' => 4, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => '$var', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, - 'type_hint' => 'bar', - 'type_hint_token' => 9, // Offset from the T_FUNCTION token. - 'type_hint_end_token' => 9, // Offset from the T_FUNCTION token. + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, 'nullable_type' => false, 'comma_token' => false, ]; @@ -245,24 +232,28 @@ public function testTypeHint() } /** - * Verify self type hint parsing. + * Verify default value parsing with a single function param. * * @return void */ - public function testSelfTypeHint() + public function testSingleDefaultValue() { $expected = []; $expected[0] = [ - 'token' => 6, // Offset from the T_FUNCTION token. - 'name' => '$var', - 'content' => 'self $var', + 'token' => 4, // Offset from the T_FUNCTION token. + 'name' => '$var1', + 'content' => '$var1=self::CONSTANT', + 'default' => 'self::CONSTANT', + 'default_token' => 6, // Offset from the T_FUNCTION token. + 'default_equal_token' => 5, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, - 'type_hint' => 'self', - 'type_hint_token' => 4, // Offset from the T_FUNCTION token. - 'type_hint_end_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, 'nullable_type' => false, 'comma_token' => false, ]; @@ -271,40 +262,47 @@ public function testSelfTypeHint() } /** - * Verify nullable type hint parsing. + * Verify default value parsing. * * @return void */ - public function testNullableTypeHint() + public function testDefaultValues() { $expected = []; $expected[0] = [ - 'token' => 7, // Offset from the T_FUNCTION token. + 'token' => 4, // Offset from the T_FUNCTION token. 'name' => '$var1', - 'content' => '?int $var1', + 'content' => '$var1=1', + 'default' => '1', + 'default_token' => 6, // Offset from the T_FUNCTION token. + 'default_equal_token' => 5, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, - 'type_hint' => '?int', - 'type_hint_token' => 5, // Offset from the T_FUNCTION token. - 'type_hint_end_token' => 5, // Offset from the T_FUNCTION token. - 'nullable_type' => true, - 'comma_token' => 8, // Offset from the T_FUNCTION token. + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => 7, // Offset from the T_FUNCTION token. ]; - $expected[1] = [ - 'token' => 14, // Offset from the T_FUNCTION token. + 'token' => 9, // Offset from the T_FUNCTION token. 'name' => '$var2', - 'content' => '?\bar $var2', + 'content' => "\$var2='value'", + 'default' => "'value'", + 'default_token' => 11, // Offset from the T_FUNCTION token. + 'default_equal_token' => 10, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, - 'type_hint' => '?\bar', - 'type_hint_token' => 11, // Offset from the T_FUNCTION token. - 'type_hint_end_token' => 12, // Offset from the T_FUNCTION token. - 'nullable_type' => true, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, 'comma_token' => false, ]; @@ -312,24 +310,41 @@ public function testNullableTypeHint() } /** - * Verify variable. + * Verify type hint parsing. * * @return void */ - public function testVariable() + public function testTypeHint() { $expected = []; $expected[0] = [ - 'token' => 4, // Offset from the T_FUNCTION token. - 'name' => '$var', - 'content' => '$var', + 'token' => 6, // Offset from the T_FUNCTION token. + 'name' => '$var1', + 'content' => 'foo $var1', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, - 'type_hint' => '', - 'type_hint_token' => false, - 'type_hint_end_token' => false, + 'type_hint' => 'foo', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 4, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => 7, // Offset from the T_FUNCTION token. + ]; + + $expected[1] = [ + 'token' => 11, // Offset from the T_FUNCTION token. + 'name' => '$var2', + 'content' => 'bar $var2', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'bar', + 'type_hint_token' => 9, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 9, // Offset from the T_FUNCTION token. 'nullable_type' => false, 'comma_token' => false, ]; @@ -338,27 +353,25 @@ public function testVariable() } /** - * Verify default value parsing with a single function param. + * Verify self type hint parsing. * * @return void */ - public function testSingleDefaultValue() + public function testSelfTypeHint() { $expected = []; $expected[0] = [ - 'token' => 4, // Offset from the T_FUNCTION token. - 'name' => '$var1', - 'content' => '$var1=self::CONSTANT', - 'default' => 'self::CONSTANT', - 'default_token' => 6, // Offset from the T_FUNCTION token. - 'default_equal_token' => 5, // Offset from the T_FUNCTION token. + 'token' => 6, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'self $var', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, - 'type_hint' => '', - 'type_hint_token' => false, - 'type_hint_end_token' => false, + 'type_hint' => 'self', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 4, // Offset from the T_FUNCTION token. 'nullable_type' => false, 'comma_token' => false, ]; @@ -367,45 +380,44 @@ public function testSingleDefaultValue() } /** - * Verify default value parsing. + * Verify nullable type hint parsing. * * @return void */ - public function testDefaultValues() + public function testNullableTypeHint() { + $php8Names = parent::usesPhp8NameTokens(); + $expected = []; $expected[0] = [ - 'token' => 4, // Offset from the T_FUNCTION token. + 'token' => 7, // Offset from the T_FUNCTION token. 'name' => '$var1', - 'content' => '$var1=1', - 'default' => '1', - 'default_token' => 6, // Offset from the T_FUNCTION token. - 'default_equal_token' => 5, // Offset from the T_FUNCTION token. + 'content' => '?int $var1', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, - 'type_hint' => '', - 'type_hint_token' => false, - 'type_hint_end_token' => false, - 'nullable_type' => false, - 'comma_token' => 7, // Offset from the T_FUNCTION token. + 'type_hint' => '?int', + 'type_hint_token' => 5, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 5, // Offset from the T_FUNCTION token. + 'nullable_type' => true, + 'comma_token' => 8, // Offset from the T_FUNCTION token. ]; + $expected[1] = [ - 'token' => 9, // Offset from the T_FUNCTION token. + 'token' => ($php8Names === true) ? 13 : 14, // Offset from the T_FUNCTION token. 'name' => '$var2', - 'content' => "\$var2='value'", - 'default' => "'value'", - 'default_token' => 11, // Offset from the T_FUNCTION token. - 'default_equal_token' => 10, // Offset from the T_FUNCTION token. + 'content' => '?\bar $var2', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, - 'type_hint' => '', - 'type_hint_token' => false, - 'type_hint_end_token' => false, - 'nullable_type' => false, + 'type_hint' => '?\bar', + 'type_hint_token' => 11, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => ($php8Names === true) ? 11 : 12, // Offset from the T_FUNCTION token. + 'nullable_type' => true, 'comma_token' => false, ]; @@ -427,6 +439,7 @@ public function testBitwiseAndConstantExpressionDefaultValue() 'default' => '10 & 20', 'default_token' => 8, // Offset from the T_FUNCTION token. 'default_equal_token' => 6, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -453,6 +466,7 @@ public function testArrowFunction() 'token' => 4, // Offset from the T_FN token. 'name' => '$a', 'content' => 'int $a', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -468,6 +482,7 @@ public function testArrowFunction() 'token' => 8, // Offset from the T_FN token. 'name' => '$b', 'content' => '...$b', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => true, @@ -479,9 +494,7 @@ public function testArrowFunction() 'comma_token' => false, ]; - $arrowTokenTypes = Collections::arrowFunctionTokensBC(); - - $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected, $arrowTokenTypes); + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); } /** @@ -496,6 +509,7 @@ public function testArrowFunctionReturnByRef() 'token' => 6, // Offset from the T_FN token. 'name' => '$a', 'content' => '?string $a', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -507,9 +521,7 @@ public function testArrowFunctionReturnByRef() 'comma_token' => false, ]; - $arrowTokenTypes = Collections::arrowFunctionTokensBC(); - - $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected, $arrowTokenTypes); + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); } /** @@ -527,6 +539,7 @@ public function testArrayDefaultValues() 'default' => '[]', 'default_token' => 8, // Offset from the T_FUNCTION token. 'default_equal_token' => 6, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -544,6 +557,7 @@ public function testArrayDefaultValues() 'default' => 'array(1, 2, 3)', 'default_token' => 16, // Offset from the T_FUNCTION token. 'default_equal_token' => 14, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -570,6 +584,7 @@ public function testConstantDefaultValueSecondParam() 'token' => 4, // Offset from the T_FUNCTION token. 'name' => '$var1', 'content' => '$var1', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -587,6 +602,7 @@ public function testConstantDefaultValueSecondParam() 'default' => 'M_PI', 'default_token' => 11, // Offset from the T_FUNCTION token. 'default_equal_token' => 9, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -616,6 +632,7 @@ public function testScalarTernaryExpressionInDefault() 'default' => 'FOO ? \'bar\' : 10', 'default_token' => 9, // Offset from the T_FUNCTION token. 'default_equal_token' => 7, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -630,6 +647,7 @@ public function testScalarTernaryExpressionInDefault() 'token' => 24, // Offset from the T_FUNCTION token. 'name' => '$b', 'content' => '? bool $b', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -656,6 +674,7 @@ public function testVariadicFunction() 'token' => 9, // Offset from the T_FUNCTION token. 'name' => '$a', 'content' => 'int ... $a', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => true, @@ -682,6 +701,7 @@ public function testVariadicByRefFunction() 'token' => 7, // Offset from the T_FUNCTION token. 'name' => '$a', 'content' => '&...$a', + 'has_attributes' => false, 'pass_by_reference' => true, 'reference_token' => 5, // Offset from the T_FUNCTION token. 'variable_length' => true, @@ -708,6 +728,7 @@ public function testVariadicFunctionClassType() 'token' => 4, // Offset from the T_FUNCTION token. 'name' => '$unit', 'content' => '$unit', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -722,6 +743,7 @@ public function testVariadicFunctionClassType() 'token' => 10, // Offset from the T_FUNCTION token. 'name' => '$intervals', 'content' => 'DateInterval ...$intervals', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => true, @@ -743,32 +765,36 @@ public function testVariadicFunctionClassType() */ public function testNameSpacedTypeDeclaration() { + $php8Names = parent::usesPhp8NameTokens(); + $expected = []; $expected[0] = [ - 'token' => 12, // Offset from the T_FUNCTION token. + 'token' => ($php8Names === true) ? 7 : 12, // Offset from the T_FUNCTION token. 'name' => '$a', 'content' => '\Package\Sub\ClassName $a', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, 'type_hint' => '\Package\Sub\ClassName', 'type_hint_token' => 5, // Offset from the T_FUNCTION token. - 'type_hint_end_token' => 10, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => ($php8Names === true) ? 5 : 10, // Offset from the T_FUNCTION token. 'nullable_type' => false, - 'comma_token' => 13, // Offset from the T_FUNCTION token. + 'comma_token' => ($php8Names === true) ? 8 : 13, // Offset from the T_FUNCTION token. ]; $expected[1] = [ - 'token' => 20, // Offset from the T_FUNCTION token. + 'token' => ($php8Names === true) ? 13 : 20, // Offset from the T_FUNCTION token. 'name' => '$b', 'content' => '?Sub\AnotherClass $b', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, 'type_hint' => '?Sub\AnotherClass', - 'type_hint_token' => 16, // Offset from the T_FUNCTION token. - 'type_hint_end_token' => 18, // Offset from the T_FUNCTION token. + 'type_hint_token' => ($php8Names === true) ? 11 : 16, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => ($php8Names === true) ? 11 : 18, // Offset from the T_FUNCTION token. 'nullable_type' => true, 'comma_token' => false, ]; @@ -788,6 +814,7 @@ public function testWithAllTypes() 'token' => 9, // Offset from the T_FUNCTION token. 'name' => '$a', 'content' => '?ClassName $a', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -802,6 +829,7 @@ public function testWithAllTypes() 'token' => 15, // Offset from the T_FUNCTION token. 'name' => '$b', 'content' => 'self $b', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -816,6 +844,7 @@ public function testWithAllTypes() 'token' => 21, // Offset from the T_FUNCTION token. 'name' => '$c', 'content' => 'parent $c', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -830,6 +859,7 @@ public function testWithAllTypes() 'token' => 27, // Offset from the T_FUNCTION token. 'name' => '$d', 'content' => 'object $d', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -844,6 +874,7 @@ public function testWithAllTypes() 'token' => 34, // Offset from the T_FUNCTION token. 'name' => '$e', 'content' => '?int $e', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -858,6 +889,7 @@ public function testWithAllTypes() 'token' => 41, // Offset from the T_FUNCTION token. 'name' => '$f', 'content' => 'string &$f', + 'has_attributes' => false, 'pass_by_reference' => true, 'reference_token' => 40, // Offset from the T_FUNCTION token. 'variable_length' => false, @@ -872,6 +904,7 @@ public function testWithAllTypes() 'token' => 47, // Offset from the T_FUNCTION token. 'name' => '$g', 'content' => 'iterable $g', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -889,6 +922,7 @@ public function testWithAllTypes() 'default' => 'true', 'default_token' => 57, // Offset from the T_FUNCTION token. 'default_equal_token' => 55, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -906,6 +940,7 @@ public function testWithAllTypes() 'default' => "'is_null'", 'default_token' => 67, // Offset from the T_FUNCTION token. 'default_equal_token' => 65, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -923,6 +958,7 @@ public function testWithAllTypes() 'default' => '1.1', 'default_token' => 77, // Offset from the T_FUNCTION token. 'default_equal_token' => 75, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -937,6 +973,7 @@ public function testWithAllTypes() 'token' => 84, // Offset from the T_FUNCTION token. 'name' => '$k', 'content' => 'array ...$k', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => true, @@ -963,6 +1000,7 @@ public function testArrowFunctionWithAllTypes() 'token' => 7, // Offset from the T_FN token. 'name' => '$a', 'content' => '?ClassName $a', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -977,6 +1015,7 @@ public function testArrowFunctionWithAllTypes() 'token' => 13, // Offset from the T_FN token. 'name' => '$b', 'content' => 'self $b', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -991,6 +1030,7 @@ public function testArrowFunctionWithAllTypes() 'token' => 19, // Offset from the T_FN token. 'name' => '$c', 'content' => 'parent $c', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -1005,6 +1045,7 @@ public function testArrowFunctionWithAllTypes() 'token' => 25, // Offset from the T_FN token. 'name' => '$d', 'content' => 'object $d', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -1019,6 +1060,7 @@ public function testArrowFunctionWithAllTypes() 'token' => 32, // Offset from the T_FN token. 'name' => '$e', 'content' => '?int $e', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -1033,6 +1075,7 @@ public function testArrowFunctionWithAllTypes() 'token' => 39, // Offset from the T_FN token. 'name' => '$f', 'content' => 'string &$f', + 'has_attributes' => false, 'pass_by_reference' => true, 'reference_token' => 38, // Offset from the T_FN token. 'variable_length' => false, @@ -1047,6 +1090,7 @@ public function testArrowFunctionWithAllTypes() 'token' => 45, // Offset from the T_FN token. 'name' => '$g', 'content' => 'iterable $g', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -1064,6 +1108,7 @@ public function testArrowFunctionWithAllTypes() 'default' => 'true', 'default_token' => 55, // Offset from the T_FN token. 'default_equal_token' => 53, // Offset from the T_FN token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -1081,6 +1126,7 @@ public function testArrowFunctionWithAllTypes() 'default' => "'is_null'", 'default_token' => 65, // Offset from the T_FN token. 'default_equal_token' => 63, // Offset from the T_FN token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -1098,6 +1144,7 @@ public function testArrowFunctionWithAllTypes() 'default' => '1.1', 'default_token' => 75, // Offset from the T_FN token. 'default_equal_token' => 73, // Offset from the T_FN token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -1112,6 +1159,7 @@ public function testArrowFunctionWithAllTypes() 'token' => 82, // Offset from the T_FN token. 'name' => '$k', 'content' => 'array ...$k', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => true, @@ -1123,9 +1171,7 @@ public function testArrowFunctionWithAllTypes() 'comma_token' => false, ]; - $arrowTokenTypes = Collections::arrowFunctionTokensBC(); - - $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected, $arrowTokenTypes); + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); } /** @@ -1135,31 +1181,35 @@ public function testArrowFunctionWithAllTypes() */ public function testMessyDeclaration() { + $php8Names = parent::usesPhp8NameTokens(); + $expected = []; $expected[0] = [ - 'token' => 25, // Offset from the T_FUNCTION token. + 'token' => ($php8Names === true) ? 24 : 25, // Offset from the T_FUNCTION token. 'name' => '$a', 'content' => '// comment ?\MyNS /* comment */ \ SubCat // phpcs:ignore Standard.Cat.Sniff -- for reasons. \ MyClass $a', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, 'type_hint' => '?\MyNS\SubCat\MyClass', 'type_hint_token' => 9, - 'type_hint_end_token' => 23, + 'type_hint_end_token' => ($php8Names === true) ? 22 : 23, 'nullable_type' => true, - 'comma_token' => 26, // Offset from the T_FUNCTION token. + 'comma_token' => ($php8Names === true) ? 25 : 26, // Offset from the T_FUNCTION token. ]; $expected[1] = [ - 'token' => 29, // Offset from the T_FUNCTION token. + 'token' => ($php8Names === true) ? 28 : 29, // Offset from the T_FUNCTION token. 'name' => '$b', 'content' => "\$b /* test */ = /* test */ 'default' /* test*/", 'default' => "'default' /* test*/", - 'default_token' => 37, // Offset from the T_FUNCTION token. - 'default_equal_token' => 33, // Offset from the T_FUNCTION token. + 'default_token' => ($php8Names === true) ? 36 : 37, // Offset from the T_FUNCTION token. + 'default_equal_token' => ($php8Names === true) ? 32 : 33, // Offset from the T_FUNCTION token. + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, @@ -1168,22 +1218,23 @@ public function testMessyDeclaration() 'type_hint_token' => false, 'type_hint_end_token' => false, 'nullable_type' => false, - 'comma_token' => 40, // Offset from the T_FUNCTION token. + 'comma_token' => ($php8Names === true) ? 39 : 40, // Offset from the T_FUNCTION token. ]; $expected[2] = [ - 'token' => 62, // Offset from the T_FUNCTION token. + 'token' => ($php8Names === true) ? 61 : 62, // Offset from the T_FUNCTION token. 'name' => '$c', 'content' => '// phpcs:ignore Stnd.Cat.Sniff -- For reasons. ? /*comment*/ bool // phpcs:disable Stnd.Cat.Sniff -- For reasons. & /*test*/ ... /* phpcs:ignore */ $c', + 'has_attributes' => false, 'pass_by_reference' => true, - 'reference_token' => 54, // Offset from the T_FUNCTION token. + 'reference_token' => ($php8Names === true) ? 53 : 54, // Offset from the T_FUNCTION token. 'variable_length' => true, - 'variadic_token' => 58, // Offset from the T_FUNCTION token. + 'variadic_token' => ($php8Names === true) ? 57 : 58, // Offset from the T_FUNCTION token. 'type_hint' => '?bool', - 'type_hint_token' => 50, // Offset from the T_FUNCTION token. - 'type_hint_end_token' => 50, // Offset from the T_FUNCTION token. + 'type_hint_token' => ($php8Names === true) ? 49 : 50, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => ($php8Names === true) ? 49 : 50, // Offset from the T_FUNCTION token. 'nullable_type' => true, 'comma_token' => false, ]; @@ -1192,27 +1243,25 @@ public function testMessyDeclaration() } /** - * Verify handling of a closure. + * Verify recognition of PHP8 mixed type declaration. * * @return void */ - public function testClosure() + public function testPHP8MixedTypeHint() { $expected = []; $expected[0] = [ - 'token' => 3, // Offset from the T_FUNCTION token. - 'name' => '$a', - 'content' => '$a = \'test\'', - 'default' => "'test'", - 'default_token' => 7, // Offset from the T_FUNCTION token. - 'default_equal_token' => 5, // Offset from the T_FUNCTION token. - 'pass_by_reference' => false, - 'reference_token' => false, - 'variable_length' => false, - 'variadic_token' => false, - 'type_hint' => '', - 'type_hint_token' => false, - 'type_hint_end_token' => false, + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$var1', + 'content' => 'mixed &...$var1', + 'has_attributes' => false, + 'pass_by_reference' => true, + 'reference_token' => 6, // Offset from the T_FUNCTION token. + 'variable_length' => true, + 'variadic_token' => 7, // Offset from the T_FUNCTION token. + 'type_hint' => 'mixed', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 4, // Offset from the T_FUNCTION token. 'nullable_type' => false, 'comma_token' => false, ]; @@ -1221,64 +1270,1382 @@ public function testClosure() } /** - * Verify handling of a closure T_USE token correctly. + * Verify recognition of PHP8 mixed type declaration with nullability. * * @return void */ - public function testClosureUse() + public function testPHP8MixedTypeHintNullable() { $expected = []; $expected[0] = [ - 'token' => 3, // Offset from the T_USE token. - 'name' => '$foo', - 'content' => '$foo', + 'token' => 7, // Offset from the T_FUNCTION token. + 'name' => '$var1', + 'content' => '?Mixed $var1', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, - 'type_hint' => '', - 'type_hint_token' => false, - 'type_hint_end_token' => false, - 'nullable_type' => false, - 'comma_token' => 4, // Offset from the T_USE token. + 'type_hint' => '?Mixed', + 'type_hint_token' => 5, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 5, // Offset from the T_FUNCTION token. + 'nullable_type' => true, + 'comma_token' => false, ]; - $expected[1] = [ - 'token' => 6, // Offset from the T_USE token. - 'name' => '$bar', - 'content' => '$bar', + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of type declarations using the namespace operator. + * + * @return void + */ + public function testNamespaceOperatorTypeHint() + { + $php8Names = parent::usesPhp8NameTokens(); + + $expected = []; + $expected[0] = [ + 'token' => ($php8Names === true) ? 7 : 9, // Offset from the T_FUNCTION token. + 'name' => '$var1', + 'content' => '?namespace\Name $var1', + 'has_attributes' => false, 'pass_by_reference' => false, 'reference_token' => false, 'variable_length' => false, 'variadic_token' => false, - 'type_hint' => '', - 'type_hint_token' => false, - 'type_hint_end_token' => false, - 'nullable_type' => false, + 'type_hint' => '?namespace\Name', + 'type_hint_token' => 5, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => ($php8Names === true) ? 5 : 7, // Offset from the T_FUNCTION token. + 'nullable_type' => true, 'comma_token' => false, ]; - $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected, [T_USE]); + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); } /** - * Test helper. - * - * @param string $commentString The comment which preceeds the test. - * @param array $expected The expected function output. - * @param array $targetType Optional. The token type to search for after $commentString. - * Defaults to the function/closure tokens. + * Verify recognition of PHP8 union type declaration. * * @return void */ - protected function getMethodParametersTestHelper($commentString, $expected, $targetType = [T_FUNCTION, T_CLOSURE]) + public function testPHP8UnionTypesSimple() { - $target = $this->getTargetToken($commentString, $targetType); - $found = BCFile::getMethodParameters(self::$phpcsFile, $target); - - foreach ($expected as $key => $param) { - $expected[$key]['token'] += $target; - - if ($param['reference_token'] !== false) { + $expected = []; + $expected[0] = [ + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$number', + 'content' => 'int|float $number', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'int|float', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => 9, + ]; + $expected[1] = [ + 'token' => 17, // Offset from the T_FUNCTION token. + 'name' => '$obj', + 'content' => 'self|parent &...$obj', + 'has_attributes' => false, + 'pass_by_reference' => true, + 'reference_token' => 15, // Offset from the T_FUNCTION token. + 'variable_length' => true, + 'variadic_token' => 16, + 'type_hint' => 'self|parent', + 'type_hint_token' => 11, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 13, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 union type declaration when the variable has either a spread operator or a reference. + * + * @return void + */ + public function testPHP8UnionTypesWithSpreadOperatorAndReference() + { + $expected = []; + $expected[0] = [ + 'token' => 9, // Offset from the T_FUNCTION token. + 'name' => '$paramA', + 'content' => 'float|null &$paramA', + 'has_attributes' => false, + 'pass_by_reference' => true, + 'reference_token' => 8, // Offset from the T_FUNCTION token. + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'float|null', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => 10, + ]; + $expected[1] = [ + 'token' => 17, // Offset from the T_FUNCTION token. + 'name' => '$paramB', + 'content' => 'string|int ...$paramB', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => true, + 'variadic_token' => 16, // Offset from the T_FUNCTION token. + 'type_hint' => 'string|int', + 'type_hint_token' => 12, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 14, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 union type declaration with a bitwise or in the default value. + * + * @return void + */ + public function testPHP8UnionTypesSimpleWithBitwiseOrInDefault() + { + $expected = []; + $expected[0] = [ + 'token' => 6, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'int|float $var = CONSTANT_A | CONSTANT_B', + 'default' => 'CONSTANT_A | CONSTANT_B', + 'default_token' => 10, // Offset from the T_FUNCTION token. + 'default_equal_token' => 8, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'int|float', + 'type_hint_token' => 2, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 4, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 union type declaration with two classes. + * + * @return void + */ + public function testPHP8UnionTypesTwoClasses() + { + $php8Names = parent::usesPhp8NameTokens(); + + $expected = []; + $expected[0] = [ + 'token' => ($php8Names === true) ? 8 : 11, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'MyClassA|\Package\MyClassB $var', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'MyClassA|\Package\MyClassB', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => ($php8Names === true) ? 6 : 9, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 union type declaration with all base types. + * + * @return void + */ + public function testPHP8UnionTypesAllBaseTypes() + { + $expected = []; + $expected[0] = [ + 'token' => 20, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'array|bool|callable|int|float|null|object|string $var', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'array|bool|callable|int|float|null|object|string', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 18, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 union type declaration with all pseudo types. + * + * Note: "Resource" is not a type, but seen as a class name. + * + * @return void + */ + public function testPHP8UnionTypesAllPseudoTypes() + { + $expected = []; + $expected[0] = [ + 'token' => 16, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'false|mixed|self|parent|iterable|Resource $var', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'false|mixed|self|parent|iterable|Resource', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 14, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 union type declaration with (illegal) nullability. + * + * @return void + */ + public function testPHP8UnionTypesNullable() + { + $expected = []; + $expected[0] = [ + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$number', + 'content' => '?int|float $number', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '?int|float', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token. + 'nullable_type' => true, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) single type null. + * + * @return void + */ + public function testPHP8PseudoTypeNull() + { + $expected = []; + $expected[0] = [ + 'token' => 6, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'null $var = null', + 'default' => 'null', + 'default_token' => 10, // Offset from the T_FUNCTION token. + 'default_equal_token' => 8, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'null', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 4, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) single type false. + * + * @return void + */ + public function testPHP8PseudoTypeFalse() + { + $expected = []; + $expected[0] = [ + 'token' => 6, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'false $var = false', + 'default' => 'false', + 'default_token' => 10, // Offset from the T_FUNCTION token. + 'default_equal_token' => 8, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'false', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 4, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) type false combined with type bool. + * + * @return void + */ + public function testPHP8PseudoTypeFalseAndBool() + { + $expected = []; + $expected[0] = [ + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'bool|false $var = false', + 'default' => 'false', + 'default_token' => 12, // Offset from the T_FUNCTION token. + 'default_equal_token' => 10, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'bool|false', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) type object combined with a class name. + * + * @return void + */ + public function testPHP8ObjectAndClass() + { + $expected = []; + $expected[0] = [ + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'object|ClassName $var', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'object|ClassName', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) type iterable combined with array/Traversable. + * + * @return void + */ + public function testPHP8PseudoTypeIterableAndArray() + { + $expected = []; + $expected[0] = [ + 'token' => 10, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'iterable|array|Traversable $var', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'iterable|array|Traversable', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 8, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) duplicate types. + * + * @return void + */ + public function testPHP8DuplicateTypeInUnionWhitespaceAndComment() + { + $expected = []; + $expected[0] = [ + 'token' => 17, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'int | string /*comment*/ | INT $var', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'int|string|INT', + 'type_hint_token' => 5, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 15, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 constructor property promotion without type declaration, with defaults. + * + * @return void + */ + public function testPHP8ConstructorPropertyPromotionNoTypes() + { + $expected = []; + $expected[0] = [ + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$x', + 'content' => 'public $x = 0.0', + 'default' => '0.0', + 'default_token' => 12, // Offset from the T_FUNCTION token. + 'default_equal_token' => 10, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'property_visibility' => 'public', + 'visibility_token' => 6, // Offset from the T_FUNCTION token. + 'property_readonly' => false, + 'comma_token' => 13, + ]; + $expected[1] = [ + 'token' => 18, // Offset from the T_FUNCTION token. + 'name' => '$y', + 'content' => 'protected $y = \'\'', + 'default' => "''", + 'default_token' => 22, // Offset from the T_FUNCTION token. + 'default_equal_token' => 20, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'property_visibility' => 'protected', + 'visibility_token' => 16, // Offset from the T_FUNCTION token. + 'property_readonly' => false, + 'comma_token' => 23, + ]; + $expected[2] = [ + 'token' => 28, // Offset from the T_FUNCTION token. + 'name' => '$z', + 'content' => 'private $z = null', + 'default' => 'null', + 'default_token' => 32, // Offset from the T_FUNCTION token. + 'default_equal_token' => 30, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'property_visibility' => 'private', + 'visibility_token' => 26, // Offset from the T_FUNCTION token. + 'property_readonly' => false, + 'comma_token' => 33, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 constructor property promotion with type declarations. + * + * @return void + */ + public function testPHP8ConstructorPropertyPromotionWithTypes() + { + $expected = []; + $expected[0] = [ + 'token' => 10, // Offset from the T_FUNCTION token. + 'name' => '$x', + 'content' => 'protected float|int $x', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'float|int', + 'type_hint_token' => 6, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 8, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'property_visibility' => 'protected', + 'visibility_token' => 4, // Offset from the T_FUNCTION token. + 'property_readonly' => false, + 'comma_token' => 11, + ]; + $expected[1] = [ + 'token' => 19, // Offset from the T_FUNCTION token. + 'name' => '$y', + 'content' => 'public ?string &$y = \'test\'', + 'default' => "'test'", + 'default_token' => 23, // Offset from the T_FUNCTION token. + 'default_equal_token' => 21, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => true, + 'reference_token' => 18, // Offset from the T_FUNCTION token. + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '?string', + 'type_hint_token' => 16, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 16, // Offset from the T_FUNCTION token. + 'nullable_type' => true, + 'property_visibility' => 'public', + 'visibility_token' => 13, // Offset from the T_FUNCTION token. + 'property_readonly' => false, + 'comma_token' => 24, + ]; + $expected[2] = [ + 'token' => 30, // Offset from the T_FUNCTION token. + 'name' => '$z', + 'content' => 'private mixed $z', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'mixed', + 'type_hint_token' => 28, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 28, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'property_visibility' => 'private', + 'visibility_token' => 26, // Offset from the T_FUNCTION token. + 'property_readonly' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 constructor with both property promotion as well as normal parameters. + * + * @return void + */ + public function testPHP8ConstructorPropertyPromotionAndNormalParam() + { + $expected = []; + $expected[0] = [ + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$promotedProp', + 'content' => 'public int $promotedProp', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'int', + 'type_hint_token' => 6, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'property_visibility' => 'public', + 'visibility_token' => 4, // Offset from the T_FUNCTION token. + 'property_readonly' => false, + 'comma_token' => 9, + ]; + $expected[1] = [ + 'token' => 14, // Offset from the T_FUNCTION token. + 'name' => '$normalArg', + 'content' => '?int $normalArg', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '?int', + 'type_hint_token' => 12, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 12, // Offset from the T_FUNCTION token. + 'nullable_type' => true, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 constructor with property promotion using PHP 8.1 readonly keyword. + * + * @return void + */ + public function testPHP81ConstructorPropertyPromotionWithReadOnly() + { + $expected = []; + $expected[0] = [ + 'token' => 11, // Offset from the T_FUNCTION token. + 'name' => '$promotedProp', + 'content' => 'public readonly ?int $promotedProp', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '?int', + 'type_hint_token' => 9, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 9, // Offset from the T_FUNCTION token. + 'nullable_type' => true, + 'property_visibility' => 'public', + 'visibility_token' => 4, // Offset from the T_FUNCTION token. + 'property_readonly' => true, + 'readonly_token' => 6, // Offset from the T_FUNCTION token. + 'comma_token' => 12, + ]; + $expected[1] = [ + 'token' => 23, // Offset from the T_FUNCTION token. + 'name' => '$promotedToo', + 'content' => 'ReadOnly private string|bool &$promotedToo', + 'has_attributes' => false, + 'pass_by_reference' => true, + 'reference_token' => 22, // Offset from the T_FUNCTION token. + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'string|bool', + 'type_hint_token' => 18, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 20, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'property_visibility' => 'private', + 'visibility_token' => 16, // Offset from the T_FUNCTION token. + 'property_readonly' => true, + 'readonly_token' => 14, // Offset from the T_FUNCTION token. + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify behaviour when a non-constructor function uses PHP 8 property promotion syntax. + * + * @return void + */ + public function testPHP8ConstructorPropertyPromotionGlobalFunction() + { + $expected = []; + $expected[0] = [ + 'token' => 6, // Offset from the T_FUNCTION token. + 'name' => '$x', + 'content' => 'private $x', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'property_visibility' => 'private', + 'visibility_token' => 4, // Offset from the T_FUNCTION token. + 'property_readonly' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify behaviour when an abstract constructor uses PHP 8 property promotion syntax. + * + * @return void + */ + public function testPHP8ConstructorPropertyPromotionAbstractMethod() + { + $expected = []; + $expected[0] = [ + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$y', + 'content' => 'public callable $y', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'callable', + 'type_hint_token' => 6, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'property_visibility' => 'public', + 'visibility_token' => 4, // Offset from the T_FUNCTION token. + 'property_readonly' => false, + 'comma_token' => 9, + ]; + $expected[1] = [ + 'token' => 14, // Offset from the T_FUNCTION token. + 'name' => '$x', + 'content' => 'private ...$x', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => true, + 'variadic_token' => 13, // Offset from the T_FUNCTION token. + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'property_visibility' => 'private', + 'visibility_token' => 11, // Offset from the T_FUNCTION token. + 'property_readonly' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify and document behaviour when there are comments within a parameter declaration. + * + * @return void + */ + public function testCommentsInParameter() + { + $expected = []; + $expected[0] = [ + 'token' => 19, // Offset from the T_FUNCTION token. + 'name' => '$param', + 'content' => '// Leading comment. + ?MyClass /*-*/ & /*-*/.../*-*/ $param /*-*/ = /*-*/ \'default value\' . /*-*/ \'second part\' // Trailing comment.', + 'default' => '\'default value\' . /*-*/ \'second part\' // Trailing comment.', + 'default_token' => 27, // Offset from the T_FUNCTION token. + 'default_equal_token' => 23, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => true, + 'reference_token' => 13, // Offset from the T_FUNCTION token. + 'variable_length' => true, + 'variadic_token' => 16, // Offset from the T_FUNCTION token. + 'type_hint' => '?MyClass', + 'type_hint_token' => 9, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 9, // Offset from the T_FUNCTION token. + 'nullable_type' => true, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify behaviour when parameters have attributes attached. + * + * @return void + */ + public function testParameterAttributesInFunctionDeclaration() + { + $php8Names = parent::usesPhp8NameTokens(); + + $expected = []; + $expected[0] = [ + 'token' => ($php8Names === true) ? 14 : 17, // Offset from the T_FUNCTION token. + 'name' => '$constructorPropPromTypedParamSingleAttribute', + 'content' => '#[\MyExample\MyAttribute] private string' + . ' $constructorPropPromTypedParamSingleAttribute', + 'has_attributes' => true, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'string', + 'type_hint_token' => ($php8Names === true) ? 12 : 15, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => ($php8Names === true) ? 12 : 15, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'property_visibility' => 'private', + 'visibility_token' => ($php8Names === true) ? 10 : 13, // Offset from the T_FUNCTION token. + 'property_readonly' => false, + 'comma_token' => ($php8Names === true) ? 15 : 18, // Offset from the T_FUNCTION token. + ]; + $expected[1] = [ + 'token' => ($php8Names === true) ? 36 : 39, // Offset from the T_FUNCTION token. + 'name' => '$typedParamSingleAttribute', + 'content' => '#[MyAttr([1, 2])] + Type|false + $typedParamSingleAttribute', + 'has_attributes' => true, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'Type|false', + 'type_hint_token' => ($php8Names === true) ? 31 : 34, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => ($php8Names === true) ? 33 : 36, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => ($php8Names === true) ? 37 : 40, // Offset from the T_FUNCTION token. + ]; + $expected[2] = [ + 'token' => ($php8Names === true) ? 56 : 59, // Offset from the T_FUNCTION token. + 'name' => '$nullableTypedParamMultiAttribute', + 'content' => '#[MyAttribute(1234), MyAttribute(5678)] ?int $nullableTypedParamMultiAttribute', + 'has_attributes' => true, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '?int', + 'type_hint_token' => ($php8Names === true) ? 54 : 57, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => ($php8Names === true) ? 54 : 57, // Offset from the T_FUNCTION token. + 'nullable_type' => true, + 'comma_token' => ($php8Names === true) ? 57 : 60, // Offset from the T_FUNCTION token. + ]; + $expected[3] = [ + 'token' => ($php8Names === true) ? 71 : 74, // Offset from the T_FUNCTION token. + 'name' => '$nonTypedParamTwoAttributes', + 'content' => '#[WithoutArgument] #[SingleArgument(0)] $nonTypedParamTwoAttributes', + 'has_attributes' => true, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => ($php8Names === true) ? 72 : 75, // Offset from the T_FUNCTION token. + ]; + $expected[4] = [ + 'token' => ($php8Names === true) ? 92 : 95, // Offset from the T_FUNCTION token. + 'name' => '$otherParam', + 'content' => '#[MyAttribute(array("key" => "value"))] + &...$otherParam', + 'has_attributes' => true, + 'pass_by_reference' => true, + 'reference_token' => ($php8Names === true) ? 90 : 93, // Offset from the T_FUNCTION token. + 'variable_length' => true, + 'variadic_token' => ($php8Names === true) ? 91 : 94, // Offset from the T_FUNCTION token. + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => ($php8Names === true) ? 93 : 96, // Offset from the T_FUNCTION token. + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8.1 intersection type declaration. + * + * @return void + */ + public function testPHP8IntersectionTypes() + { + $expected = []; + $expected[0] = [ + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$obj1', + 'content' => 'Foo&Bar $obj1', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'Foo&Bar', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => 9, + ]; + $expected[1] = [ + 'token' => 15, // Offset from the T_FUNCTION token. + 'name' => '$obj2', + 'content' => 'Boo&Bar $obj2', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'Boo&Bar', + 'type_hint_token' => 11, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 13, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 intersection type declaration when the variable + * has either a spread operator or a reference. + * + * @return void + */ + public function testPHP81IntersectionTypesWithSpreadOperatorAndReference() + { + $expected = []; + $expected[0] = [ + 'token' => 9, // Offset from the T_FUNCTION token. + 'name' => '$paramA', + 'content' => 'Boo&Bar &$paramA', + 'has_attributes' => false, + 'pass_by_reference' => true, + 'reference_token' => 8, // Offset from the T_FUNCTION token. + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'Boo&Bar', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => 10, + ]; + $expected[1] = [ + 'token' => 17, // Offset from the T_FUNCTION token. + 'name' => '$paramB', + 'content' => 'Foo&Bar ...$paramB', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => true, + 'variadic_token' => 16, // Offset from the T_FUNCTION token. + 'type_hint' => 'Foo&Bar', + 'type_hint_token' => 12, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 14, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8.1 intersection type declaration with more types. + * + * @return void + */ + public function testPHP81MoreIntersectionTypes() + { + $php8Names = parent::usesPhp8NameTokens(); + + $expected = []; + $expected[0] = [ + 'token' => ($php8Names === true) ? 10 : 16, // Offset from the T_FUNCTION token. + 'name' => '$var', + 'content' => 'MyClassA&\Package\MyClassB&\Package\MyClassC $var', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'MyClassA&\Package\MyClassB&\Package\MyClassC', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => ($php8Names === true) ? 8 : 14, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8.1 intersection type declaration with illegal simple types. + * + * @return void + */ + public function testPHP81IllegalIntersectionTypes() + { + $expected = []; + $expected[0] = [ + 'token' => 7, // Offset from the T_FUNCTION token. + 'name' => '$numeric_string', + 'content' => 'string&int $numeric_string', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'string&int', + 'type_hint_token' => 3, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 5, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8.1 intersection type declaration with (illegal) nullability. + * + * @return void + */ + public function testPHP81NullableIntersectionTypes() + { + $expected = []; + $expected[0] = [ + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$object', + 'content' => '?Foo&Bar $object', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '?Foo&Bar', + 'type_hint_token' => 4, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token. + 'nullable_type' => true, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify behaviour when the default value uses the "new" keyword, as is allowed per PHP 8.1. + * + * @return void + */ + public function testPHP81NewInInitializers() + { + $php8Names = parent::usesPhp8NameTokens(); + + $expected = []; + $expected[0] = [ + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$new', + 'content' => 'TypeA $new = new TypeA(self::CONST_VALUE)', + 'default' => 'new TypeA(self::CONST_VALUE)', + 'default_token' => 12, // Offset from the T_FUNCTION token. + 'default_equal_token' => 10, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => 'TypeA', + 'type_hint_token' => 6, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 6, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => 20, + ]; + $expected[1] = [ + 'token' => ($php8Names === true) ? 25 : 28, // Offset from the T_FUNCTION token. + 'name' => '$newToo', + 'content' => '\Package\TypeB $newToo = new \Package\TypeB(10, \'string\')', + 'default' => "new \Package\TypeB(10, 'string')", + 'default_token' => ($php8Names === true) ? 29 : 32, // Offset from the T_FUNCTION token. + 'default_equal_token' => ($php8Names === true) ? 27 : 30, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '\Package\TypeB', + 'type_hint_token' => 23, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => ($php8Names === true) ? 23 : 26, // Offset from the T_FUNCTION token. + 'nullable_type' => false, + 'comma_token' => ($php8Names === true) ? 38 : 44, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify handling of a closure. + * + * @return void + */ + public function testClosure() + { + $expected = []; + $expected[0] = [ + 'token' => 3, // Offset from the T_FUNCTION token. + 'name' => '$a', + 'content' => '$a = \'test\'', + 'default' => "'test'", + 'default_token' => 7, // Offset from the T_FUNCTION token. + 'default_equal_token' => 5, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify handling of a closure T_USE token correctly. + * + * @return void + */ + public function testClosureUse() + { + $expected = []; + $expected[0] = [ + 'token' => 3, // Offset from the T_USE token. + 'name' => '$foo', + 'content' => '$foo', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => 4, // Offset from the T_USE token. + ]; + $expected[1] = [ + 'token' => 6, // Offset from the T_USE token. + 'name' => '$bar', + 'content' => '$bar', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => false, + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected, [T_USE]); + } + + /** + * Verify function declarations with trailing commas are handled correctly. + * + * @return void + */ + public function testFunctionParamListWithTrailingComma() + { + $expected = []; + $expected[0] = [ + 'token' => 9, // Offset from the T_FUNCTION token. + 'name' => '$foo', + 'content' => '?string $foo /*comment*/', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '?string', + 'type_hint_token' => 7, // Offset from the T_FUNCTION token. + 'type_hint_end_token' => 7, // Offset from the T_FUNCTION token. + 'nullable_type' => true, + 'comma_token' => 13, // Offset from the T_FUNCTION token. + ]; + $expected[1] = [ + 'token' => 16, // Offset from the T_FUNCTION token. + 'name' => '$bar', + 'content' => '$bar = 0', + 'default' => '0', + 'default_token' => 20, // Offset from the T_FUNCTION token. + 'default_equal_token' => 18, // Offset from the T_FUNCTION token. + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => 21, // Offset from the T_FUNCTION token. + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify closure declarations with trailing commas are handled correctly. + * + * @return void + */ + public function testClosureParamListWithTrailingComma() + { + $expected = []; + $expected[0] = [ + 'token' => 4, // Offset from the T_FUNCTION token. + 'name' => '$foo', + 'content' => '$foo', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => 5, // Offset from the T_FUNCTION token. + ]; + $expected[1] = [ + 'token' => 8, // Offset from the T_FUNCTION token. + 'name' => '$bar', + 'content' => '$bar', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => 9, // Offset from the T_FUNCTION token. + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify arrow function declarations with trailing commas are handled correctly. + * + * @return void + */ + public function testArrowFunctionParamListWithTrailingComma() + { + $expected = []; + $expected[0] = [ + 'token' => 6, // Offset from the T_FN token. + 'name' => '$a', + 'content' => '?int $a', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '?int', + 'type_hint_token' => 4, // Offset from the T_FN token. + 'type_hint_end_token' => 4, // Offset from the T_FN token. + 'nullable_type' => true, + 'comma_token' => 8, // Offset from the T_FN token. + ]; + $expected[1] = [ + 'token' => 11, // Offset from the T_FN token. + 'name' => '$b', + 'content' => '...$b', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => true, + 'variadic_token' => 10, // Offset from the T_FN token. + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => 12, // Offset from the T_FN token. + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify closure T_USE statements with trailing commas are handled correctly. + * + * @return void + */ + public function testClosureUseWithTrailingComma() + { + $expected = []; + $expected[0] = [ + 'token' => 4, // Offset from the T_USE token. + 'name' => '$foo', + 'content' => '$foo /*comment*/', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => 8, // Offset from the T_USE token. + ]; + $expected[1] = [ + 'token' => 11, // Offset from the T_USE token. + 'name' => '$bar', + 'content' => '$bar', + 'has_attributes' => false, + 'pass_by_reference' => false, + 'reference_token' => false, + 'variable_length' => false, + 'variadic_token' => false, + 'type_hint' => '', + 'type_hint_token' => false, + 'type_hint_end_token' => false, + 'nullable_type' => false, + 'comma_token' => 12, // Offset from the T_USE token. + ]; + + $this->getMethodParametersTestHelper('/* ' . __FUNCTION__ . ' */', $expected, [T_USE]); + } + + /** + * Test helper. + * + * @param string $marker The comment which preceeds the test. + * @param array $expected The expected function output. + * @param array $targetType Optional. The token type to search for after $marker. + * Defaults to the function/closure/arrow tokens. + * + * @return void + */ + protected function getMethodParametersTestHelper($marker, $expected, $targetType = [T_FUNCTION, T_CLOSURE, T_FN]) + { + $target = $this->getTargetToken($marker, $targetType); + $found = BCFile::getMethodParameters(self::$phpcsFile, $target); + + foreach ($expected as $key => $param) { + $expected[$key]['token'] += $target; + + if ($param['reference_token'] !== false) { $expected[$key]['reference_token'] += $target; } if ($param['variadic_token'] !== false) { @@ -1299,6 +2666,12 @@ protected function getMethodParametersTestHelper($commentString, $expected, $tar if (isset($param['default_equal_token'])) { $expected[$key]['default_equal_token'] += $target; } + if (isset($param['visibility_token'])) { + $expected[$key]['visibility_token'] += $target; + } + if (isset($param['readonly_token'])) { + $expected[$key]['readonly_token'] += $target; + } } $this->assertSame($expected, $found); diff --git a/Tests/BackCompat/BCFile/GetMethodPropertiesTest.inc b/Tests/BackCompat/BCFile/GetMethodPropertiesTest.inc index 106d65b1..3d149e83 100644 --- a/Tests/BackCompat/BCFile/GetMethodPropertiesTest.inc +++ b/Tests/BackCompat/BCFile/GetMethodPropertiesTest.inc @@ -41,9 +41,16 @@ class MyClass { function myFunction(): \MyNamespace\MyClass {} /* testReturnMultilineNamespace */ + // Parse error in PHP 8.0. function myFunction(): \MyNamespace /** comment *\/ comment */ \MyClass /* comment */ \Foo {} + + /* testReturnUnqualifiedName */ + private function myFunction(): ?MyClass {} + + /* testReturnPartiallyQualifiedName */ + function myFunction(): Sub\Level\MyClass {} } abstract class MyClass @@ -74,6 +81,83 @@ class ReturnMe { } } +/* testPHP8MixedTypeHint */ +function mixedTypeHint() :mixed {} + +/* testPHP8MixedTypeHintNullable */ +// Intentional fatal error - nullability is not allowed with mixed, but that's not the concern of the method. +function mixedTypeHintNullable(): ?mixed {} + +/* testNamespaceOperatorTypeHint */ +function namespaceOperatorTypeHint() : ?namespace\Name {} + +/* testPHP8UnionTypesSimple */ +function unionTypeSimple($number) : int|float {} + +/* testPHP8UnionTypesTwoClasses */ +$fn = fn($var): MyClassA|\Package\MyClassB => $var; + +/* testPHP8UnionTypesAllBaseTypes */ +function unionTypesAllBaseTypes() : array|bool|callable|int|float|null|Object|string {} + +/* testPHP8UnionTypesAllPseudoTypes */ +// Intentional fatal error - mixing types which cannot be combined, but that's not the concern of the method. +function unionTypesAllPseudoTypes($var) : false|MIXED|self|parent|static|iterable|Resource|void {} + +/* testPHP8UnionTypesNullable */ +// Intentional fatal error - nullability is not allowed with union types, but that's not the concern of the method. +$closure = function () use($a) :?int|float {}; + +/* testPHP8PseudoTypeNull */ +// Intentional fatal error - null pseudotype is only allowed in union types, but that's not the concern of the method. +function pseudoTypeNull(): null {} + +/* testPHP8PseudoTypeFalse */ +// Intentional fatal error - false pseudotype is only allowed in union types, but that's not the concern of the method. +function pseudoTypeFalse(): false {} + +/* testPHP8PseudoTypeFalseAndBool */ +// Intentional fatal error - false pseudotype is not allowed in combination with bool, but that's not the concern of the method. +function pseudoTypeFalseAndBool(): bool|false {} + +/* testPHP8ObjectAndClass */ +// Intentional fatal error - object is not allowed in combination with class name, but that's not the concern of the method. +function objectAndClass(): object|ClassName {} + +/* testPHP8PseudoTypeIterableAndArray */ +// Intentional fatal error - iterable pseudotype is not allowed in combination with array or Traversable, but that's not the concern of the method. +interface FooBar { + public function pseudoTypeIterableAndArray(): iterable|array|Traversable; +} + +/* testPHP8DuplicateTypeInUnionWhitespaceAndComment */ +// Intentional fatal error - duplicate types are not allowed in union types, but that's not the concern of the method. +function duplicateTypeInUnion(): int | /*comment*/ string | INT {} + +/* testPHP81NeverType */ +function never(): never {} + +/* testPHP81NullableNeverType */ +// Intentional fatal error - nullability is not allowed with never, but that's not the concern of the method. +function nullableNever(): ?never {} + +/* testPHP8IntersectionTypes */ +function intersectionTypes(): Foo&Bar {} + +/* testPHP81MoreIntersectionTypes */ +function moreIntersectionTypes(): MyClassA&\Package\MyClassB&\Package\MyClassC {} + +/* testPHP81IntersectionArrowFunction */ +$fn = fn($var): MyClassA&\Package\MyClassB => $var; + +/* testPHP81IllegalIntersectionTypes */ +// Intentional fatal error - simple types are not allowed with intersection types, but that's not the concern of the method. +$closure = function (): string&int {}; + +/* testPHP81NullableIntersectionTypes */ +// Intentional fatal error - nullability is not allowed with intersection types, but that's not the concern of the method. +$closure = function (): ?Foo&Bar {}; + /* testNotAFunction */ return true; @@ -91,6 +175,9 @@ fn&(?string $a) : ?string => $b; /* testFunctionCallFnPHPCS353-354 */ $value = $obj->fn(true); +/* testFunctionDeclarationNestedInTernaryPHPCS2975 */ +return (!$a ? [ new class { public function b(): c {} } ] : []); + /* testArrowFunctionLiveCoding */ // Intentional parse error. This has to be the last test in the file. $fn = fn diff --git a/Tests/BackCompat/BCFile/GetMethodPropertiesTest.php b/Tests/BackCompat/BCFile/GetMethodPropertiesTest.php index 8ad64dc4..ee20479d 100644 --- a/Tests/BackCompat/BCFile/GetMethodPropertiesTest.php +++ b/Tests/BackCompat/BCFile/GetMethodPropertiesTest.php @@ -22,7 +22,6 @@ use PHPCSUtils\BackCompat\BCFile; use PHPCSUtils\TestUtils\UtilityMethodTestCase; -use PHPCSUtils\Tokens\Collections; /** * Tests for the \PHPCSUtils\BackCompat\BCFile::getMethodProperties method. @@ -70,11 +69,11 @@ public function dataNotAFunctionException() ], 'function-call-fn-phpcs-3.5.3-3.5.4' => [ '/* testFunctionCallFnPHPCS353-354 */', - Collections::arrowFunctionTokensBC(), + [T_FN, T_STRING], ], 'fn-live-coding' => [ '/* testArrowFunctionLiveCoding */', - Collections::arrowFunctionTokensBC(), + [T_FN, T_STRING], ], ]; } @@ -87,15 +86,16 @@ public function dataNotAFunctionException() public function testBasicFunction() { $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => '', - 'return_type_token' => false, - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '', + 'return_type_token' => false, + 'return_type_end_token' => false, + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -109,15 +109,16 @@ public function testBasicFunction() public function testReturnFunction() { $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => 'array', - 'return_type_token' => 11, // Offset from the T_FUNCTION token. - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'array', + 'return_type_token' => 11, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 11, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -131,15 +132,16 @@ public function testReturnFunction() public function testNestedClosure() { $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => 'int', - 'return_type_token' => 8, // Offset from the T_FUNCTION token. - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'int', + 'return_type_token' => 8, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 8, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -153,15 +155,16 @@ public function testNestedClosure() public function testBasicMethod() { $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => '', - 'return_type_token' => false, - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '', + 'return_type_token' => false, + 'return_type_end_token' => false, + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -175,15 +178,16 @@ public function testBasicMethod() public function testPrivateStaticMethod() { $expected = [ - 'scope' => 'private', - 'scope_specified' => true, - 'return_type' => '', - 'return_type_token' => false, - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => true, - 'has_body' => true, + 'scope' => 'private', + 'scope_specified' => true, + 'return_type' => '', + 'return_type_token' => false, + 'return_type_end_token' => false, + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => true, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -197,15 +201,16 @@ public function testPrivateStaticMethod() public function testFinalMethod() { $expected = [ - 'scope' => 'public', - 'scope_specified' => true, - 'return_type' => '', - 'return_type_token' => false, - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => true, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => true, + 'return_type' => '', + 'return_type_token' => false, + 'return_type_end_token' => false, + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => true, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -219,15 +224,16 @@ public function testFinalMethod() public function testProtectedReturnMethod() { $expected = [ - 'scope' => 'protected', - 'scope_specified' => true, - 'return_type' => 'int', - 'return_type_token' => 8, // Offset from the T_FUNCTION token. - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'protected', + 'scope_specified' => true, + 'return_type' => 'int', + 'return_type_token' => 8, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 8, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -241,15 +247,16 @@ public function testProtectedReturnMethod() public function testPublicReturnMethod() { $expected = [ - 'scope' => 'public', - 'scope_specified' => true, - 'return_type' => 'array', - 'return_type_token' => 7, // Offset from the T_FUNCTION token. - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => true, + 'return_type' => 'array', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 7, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -263,15 +270,16 @@ public function testPublicReturnMethod() public function testNullableReturnMethod() { $expected = [ - 'scope' => 'public', - 'scope_specified' => true, - 'return_type' => '?array', - 'return_type_token' => 8, // Offset from the T_FUNCTION token. - 'nullable_return_type' => true, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => true, + 'return_type' => '?array', + 'return_type_token' => 8, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 8, // Offset from the T_FUNCTION token. + 'nullable_return_type' => true, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -285,15 +293,16 @@ public function testNullableReturnMethod() public function testMessyNullableReturnMethod() { $expected = [ - 'scope' => 'public', - 'scope_specified' => true, - 'return_type' => '?array', - 'return_type_token' => 18, // Offset from the T_FUNCTION token. - 'nullable_return_type' => true, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => true, + 'return_type' => '?array', + 'return_type_token' => 18, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 18, // Offset from the T_FUNCTION token. + 'nullable_return_type' => true, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -306,16 +315,19 @@ public function testMessyNullableReturnMethod() */ public function testReturnNamespace() { + $php8Names = parent::usesPhp8NameTokens(); + $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => '\MyNamespace\MyClass', - 'return_type_token' => 7, // Offset from the T_FUNCTION token. - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '\MyNamespace\MyClass', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => ($php8Names === true) ? 7 : 10, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -327,17 +339,68 @@ public function testReturnNamespace() * @return void */ public function testReturnMultilineNamespace() + { + $php8Names = parent::usesPhp8NameTokens(); + + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '\MyNamespace\MyClass\Foo', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => ($php8Names === true) ? 20 : 23, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Test a method with an unqualified named return type. + * + * @return void + */ + public function testReturnUnqualifiedName() { $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => '\MyNamespace\MyClass\Foo', - 'return_type_token' => 7, // Offset from the T_FUNCTION token. - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'private', + 'scope_specified' => true, + 'return_type' => '?MyClass', + 'return_type_token' => 8, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 8, // Offset from the T_FUNCTION token. + 'nullable_return_type' => true, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Test a method with a partially qualified namespaced return type. + * + * @return void + */ + public function testReturnPartiallyQualifiedName() + { + $php8Names = parent::usesPhp8NameTokens(); + + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'Sub\Level\MyClass', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => ($php8Names === true) ? 7 : 11, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -351,15 +414,16 @@ public function testReturnMultilineNamespace() public function testAbstractMethod() { $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => '', - 'return_type_token' => false, - 'nullable_return_type' => false, - 'is_abstract' => true, - 'is_final' => false, - 'is_static' => false, - 'has_body' => false, + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '', + 'return_type_token' => false, + 'return_type_end_token' => false, + 'nullable_return_type' => false, + 'is_abstract' => true, + 'is_final' => false, + 'is_static' => false, + 'has_body' => false, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -373,15 +437,16 @@ public function testAbstractMethod() public function testAbstractReturnMethod() { $expected = [ - 'scope' => 'protected', - 'scope_specified' => true, - 'return_type' => 'bool', - 'return_type_token' => 7, // Offset from the T_FUNCTION token. - 'nullable_return_type' => false, - 'is_abstract' => true, - 'is_final' => false, - 'is_static' => false, - 'has_body' => false, + 'scope' => 'protected', + 'scope_specified' => true, + 'return_type' => 'bool', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 7, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => true, + 'is_final' => false, + 'is_static' => false, + 'has_body' => false, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -395,15 +460,16 @@ public function testAbstractReturnMethod() public function testInterfaceMethod() { $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => '', - 'return_type_token' => false, - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => false, + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '', + 'return_type_token' => false, + 'return_type_end_token' => false, + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => false, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -417,20 +483,19 @@ public function testInterfaceMethod() public function testArrowFunction() { $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => 'int', - 'return_type_token' => 9, // Offset from the T_FN token. - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => true, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'int', + 'return_type_token' => 9, // Offset from the T_FN token. + 'return_type_end_token' => 9, // Offset from the T_FN token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => true, + 'has_body' => true, ]; - $arrowTokenTypes = Collections::arrowFunctionTokensBC(); - - $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected, $arrowTokenTypes); + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); } /** @@ -441,15 +506,509 @@ public function testArrowFunction() public function testReturnTypeStatic() { $expected = [ - 'scope' => 'private', - 'scope_specified' => true, - 'return_type' => 'static', - 'return_type_token' => 7, // Offset from the T_FUNCTION token. - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'private', + 'scope_specified' => true, + 'return_type' => 'static', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 7, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Test a function with return type "mixed". + * + * @return void + */ + public function testPHP8MixedTypeHint() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'mixed', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 7, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Test a function with return type "mixed" and nullability. + * + * @return void + */ + public function testPHP8MixedTypeHintNullable() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '?mixed', + 'return_type_token' => 8, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 8, // Offset from the T_FUNCTION token. + 'nullable_return_type' => true, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Test a function with return type using the namespace operator. + * + * @return void + */ + public function testNamespaceOperatorTypeHint() + { + $php8Names = parent::usesPhp8NameTokens(); + + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '?namespace\Name', + 'return_type_token' => 9, // Offset from the T_FUNCTION token. + 'return_type_end_token' => ($php8Names === true) ? 9 : 11, // Offset from the T_FUNCTION token. + 'nullable_return_type' => true, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 union type declaration. + * + * @return void + */ + public function testPHP8UnionTypesSimple() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'int|float', + 'return_type_token' => 9, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 11, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 union type declaration with two classes. + * + * @return void + */ + public function testPHP8UnionTypesTwoClasses() + { + $php8Names = parent::usesPhp8NameTokens(); + + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'MyClassA|\Package\MyClassB', + 'return_type_token' => 6, // Offset from the T_FUNCTION token. + 'return_type_end_token' => ($php8Names === true) ? 8 : 11, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 union type declaration with all base types. + * + * @return void + */ + public function testPHP8UnionTypesAllBaseTypes() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'array|bool|callable|int|float|null|Object|string', + 'return_type_token' => 8, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 22, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 union type declaration with all pseudo types. + * + * Note: "Resource" is not a type, but seen as a class name. + * + * @return void + */ + public function testPHP8UnionTypesAllPseudoTypes() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'false|MIXED|self|parent|static|iterable|Resource|void', + 'return_type_token' => 9, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 23, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 union type declaration with (illegal) nullability. + * + * @return void + */ + public function testPHP8UnionTypesNullable() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '?int|float', + 'return_type_token' => 12, // Offset from the T_CLOSURE token. + 'return_type_end_token' => 14, // Offset from the T_CLOSURE token. + 'nullable_return_type' => true, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) single type null. + * + * @return void + */ + public function testPHP8PseudoTypeNull() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'null', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 7, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) single type false. + * + * @return void + */ + public function testPHP8PseudoTypeFalse() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'false', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 7, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) type false combined with type bool. + * + * @return void + */ + public function testPHP8PseudoTypeFalseAndBool() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'bool|false', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 9, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) type object combined with a class name. + * + * @return void + */ + public function testPHP8ObjectAndClass() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'object|ClassName', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 9, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) type iterable combined with array/Traversable. + * + * @return void + */ + public function testPHP8PseudoTypeIterableAndArray() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => true, + 'return_type' => 'iterable|array|Traversable', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 11, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => false, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8 type declaration with (illegal) duplicate types. + * + * @return void + */ + public function testPHP8DuplicateTypeInUnionWhitespaceAndComment() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'int|string|INT', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 17, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8.1 type "never". + * + * @return void + */ + public function testPHP81NeverType() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'never', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 7, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8.1 type "never" with (illegal) nullability. + * + * @return void + */ + public function testPHP81NullableNeverType() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '?never', + 'return_type_token' => 8, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 8, // Offset from the T_FUNCTION token. + 'nullable_return_type' => true, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8.1 intersection type declaration. + * + * @return void + */ + public function testPHP8IntersectionTypes() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'Foo&Bar', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 9, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8.1 intersection type declaration with more types. + * + * @return void + */ + public function testPHP81MoreIntersectionTypes() + { + $php8Names = parent::usesPhp8NameTokens(); + + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'MyClassA&\Package\MyClassB&\Package\MyClassC', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => ($php8Names === true) ? 11 : 17, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8.1 intersection type declaration in arrow function. + * + * @return void + */ + public function testPHP81IntersectionArrowFunction() + { + $php8Names = parent::usesPhp8NameTokens(); + + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'MyClassA&\Package\MyClassB', + 'return_type_token' => 6, // Offset from the T_FN token. + 'return_type_end_token' => ($php8Names === true) ? 8 : 11, // Offset from the T_FN token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8.1 intersection type declaration with illegal simple types. + * + * @return void + */ + public function testPHP81IllegalIntersectionTypes() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'string&int', + 'return_type_token' => 6, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 8, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } + + /** + * Verify recognition of PHP8.1 intersection type declaration with (illegal) nullability. + * + * @return void + */ + public function testPHP81NullableIntersectionTypes() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '?Foo&Bar', + 'return_type_token' => 7, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 9, // Offset from the T_FUNCTION token. + 'nullable_return_type' => true, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -465,15 +1024,16 @@ public function testReturnTypeStatic() public function testPhpcsIssue1264() { $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => 'array', - 'return_type_token' => 8, // Offset from the T_FUNCTION token. - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'array', + 'return_type_token' => 8, // Offset from the T_FUNCTION token. + 'return_type_end_token' => 8, // Offset from the T_FUNCTION token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); @@ -490,20 +1050,19 @@ public function testPhpcsIssue1264() public function testArrowFunctionArrayReturnValue() { $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => 'array', - 'return_type_token' => 5, // Offset from the T_FN token. - 'nullable_return_type' => false, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => 'array', + 'return_type_token' => 5, // Offset from the T_FN token. + 'return_type_end_token' => 5, // Offset from the T_FN token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; - $arrowTokenTypes = Collections::arrowFunctionTokensBC(); - - $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected, $arrowTokenTypes); + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); } /** @@ -514,20 +1073,43 @@ public function testArrowFunctionArrayReturnValue() public function testArrowFunctionReturnByRef() { $expected = [ - 'scope' => 'public', - 'scope_specified' => false, - 'return_type' => '?string', - 'return_type_token' => 12, - 'nullable_return_type' => true, - 'is_abstract' => false, - 'is_final' => false, - 'is_static' => false, - 'has_body' => true, + 'scope' => 'public', + 'scope_specified' => false, + 'return_type' => '?string', + 'return_type_token' => 12, // Offset from the T_FN token. + 'return_type_end_token' => 12, // Offset from the T_FN token. + 'nullable_return_type' => true, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, ]; - $arrowTokenTypes = Collections::arrowFunctionTokensBC(); + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); + } - $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected, $arrowTokenTypes); + /** + * Test handling of function declaration nested in a ternary, where the colon for the + * return type was incorrectly tokenized as T_INLINE_ELSE prior to PHPCS 3.5.7. + * + * @return void + */ + public function testFunctionDeclarationNestedInTernaryPHPCS2975() + { + $expected = [ + 'scope' => 'public', + 'scope_specified' => true, + 'return_type' => 'c', + 'return_type_token' => 7, // Offset from the T_FN token. + 'return_type_end_token' => 7, // Offset from the T_FN token. + 'nullable_return_type' => false, + 'is_abstract' => false, + 'is_final' => false, + 'is_static' => false, + 'has_body' => true, + ]; + + $this->getMethodPropertiesTestHelper('/* ' . __FUNCTION__ . ' */', $expected); } /** @@ -540,14 +1122,20 @@ public function testArrowFunctionReturnByRef() * * @return void */ - protected function getMethodPropertiesTestHelper($commentString, $expected, $targetType = [T_FUNCTION, T_CLOSURE]) - { + protected function getMethodPropertiesTestHelper( + $commentString, + $expected, + $targetType = [T_FUNCTION, T_CLOSURE, T_FN] + ) { $function = $this->getTargetToken($commentString, $targetType); $found = BCFile::getMethodProperties(self::$phpcsFile, $function); if ($expected['return_type_token'] !== false) { $expected['return_type_token'] += $function; } + if ($expected['return_type_end_token'] !== false) { + $expected['return_type_end_token'] += $function; + } $this->assertSame($expected, $found); } diff --git a/Tests/BackCompat/BCFile/GetTokensAsStringTest.inc b/Tests/BackCompat/BCFile/GetTokensAsStringTest.inc index f0293e1b..ace5a9bd 100644 --- a/Tests/BackCompat/BCFile/GetTokensAsStringTest.inc +++ b/Tests/BackCompat/BCFile/GetTokensAsStringTest.inc @@ -8,6 +8,14 @@ use Foo /*comment*/ \ Bar // phpcs:ignore Stnd.Cat.Sniff -- For reasons. \ Bah; +$cl = function() { + /* testCalculation */ + return 1 + 2 + + // Comment. + 3 + 4 + + 5 + 6 + 7 > 20; +} + /* testEchoWithTabs */ echo 'foo', 'bar' , diff --git a/Tests/BackCompat/BCFile/GetTokensAsStringTest.php b/Tests/BackCompat/BCFile/GetTokensAsStringTest.php index 42611669..b3df5437 100644 --- a/Tests/BackCompat/BCFile/GetTokensAsStringTest.php +++ b/Tests/BackCompat/BCFile/GetTokensAsStringTest.php @@ -22,7 +22,7 @@ * * @since 1.0.0 */ -class GetTokensAsStringTest extends UtilityMethodTestCase +final class GetTokensAsStringTest extends UtilityMethodTestCase { /** @@ -118,68 +118,126 @@ public function testGetTokensAsString($testMarker, $startTokenType, $length, $ex */ public function dataGetTokensAsString() { + $php8Names = parent::usesPhp8NameTokens(); + return [ 'length-0' => [ - '/* testNamespace */', - \T_NAMESPACE, + '/* testCalculation */', + \T_LNUMBER, 0, '', ], 'length-1' => [ - '/* testNamespace */', - \T_NAMESPACE, + '/* testCalculation */', + \T_LNUMBER, 1, - 'namespace', + '1', ], 'length-2' => [ - '/* testNamespace */', - \T_NAMESPACE, + '/* testCalculation */', + \T_LNUMBER, 2, - 'namespace ', + '1 ', ], 'length-3' => [ - '/* testNamespace */', - \T_NAMESPACE, + '/* testCalculation */', + \T_LNUMBER, 3, - 'namespace Foo', + '1 +', ], 'length-4' => [ - '/* testNamespace */', - \T_NAMESPACE, + '/* testCalculation */', + \T_LNUMBER, 4, - 'namespace Foo\\', + '1 + ', ], 'length-5' => [ - '/* testNamespace */', - \T_NAMESPACE, + '/* testCalculation */', + \T_LNUMBER, 5, - 'namespace Foo\Bar', + '1 + 2', ], 'length-6' => [ - '/* testNamespace */', - \T_NAMESPACE, + '/* testCalculation */', + \T_LNUMBER, 6, - 'namespace Foo\Bar\\', + '1 + 2 ', ], 'length-7' => [ - '/* testNamespace */', - \T_NAMESPACE, + '/* testCalculation */', + \T_LNUMBER, 7, - 'namespace Foo\Bar\Baz', + '1 + 2 +', ], 'length-8' => [ - '/* testNamespace */', - \T_NAMESPACE, + '/* testCalculation */', + \T_LNUMBER, 8, - 'namespace Foo\Bar\Baz;', + '1 + 2 + +', ], 'length-9' => [ - '/* testNamespace */', - \T_NAMESPACE, + '/* testCalculation */', + \T_LNUMBER, 9, - 'namespace Foo\Bar\Baz; + '1 + 2 + + ', + ], + 'length-10' => [ + '/* testCalculation */', + \T_LNUMBER, + 10, + '1 + 2 + + // Comment. ', ], + 'length-11' => [ + '/* testCalculation */', + \T_LNUMBER, + 11, + '1 + 2 + + // Comment. + ', + ], + 'length-12' => [ + '/* testCalculation */', + \T_LNUMBER, + 12, + '1 + 2 + + // Comment. + 3', + ], + 'length-13' => [ + '/* testCalculation */', + \T_LNUMBER, + 13, + '1 + 2 + + // Comment. + 3 ', + ], + 'length-14' => [ + '/* testCalculation */', + \T_LNUMBER, + 14, + '1 + 2 + + // Comment. + 3 +', + ], + 'length-34' => [ + '/* testCalculation */', + \T_LNUMBER, + 34, + '1 + 2 + + // Comment. + 3 + 4 + + 5 + 6 + 7 > 20;', + ], + 'namespace' => [ + '/* testNamespace */', + \T_NAMESPACE, + ($php8Names === true) ? 4 : 8, + 'namespace Foo\Bar\Baz;', + ], 'use-with-comments' => [ '/* testUseWithComments */', \T_USE, diff --git a/Tests/BackCompat/BCFile/IsReferenceTest.inc b/Tests/BackCompat/BCFile/IsReferenceTest.inc index 6049688e..93c7acc6 100644 --- a/Tests/BackCompat/BCFile/IsReferenceTest.inc +++ b/Tests/BackCompat/BCFile/IsReferenceTest.inc @@ -1,6 +1,8 @@ value){}; + +/* testUseByReferenceWithCommentSecondParam */ +$closure = function() use /*comment*/ ($varA, &$varB){}; + /* testArrowFunctionReturnByReference */ fn&($x) => $x; +$closure = function ( + /* testBitwiseAndExactParameterA */ + $a = MY_CONSTANT & parent::OTHER_CONSTANT, + /* testPassByReferenceExactParameterB */ + &$b, + /* testPassByReferenceExactParameterC */ + &...$c, + /* testBitwiseAndExactParameterD */ + $d = E_NOTICE & E_STRICT, +) {}; + +// Issue PHPCS#3049. +/* testArrowFunctionPassByReferenceA */ +$fn = fn(array &$one) => 1; + +/* testArrowFunctionPassByReferenceB */ +$fn = fn($param, &...$moreParams) => 1; + /* testClosureReturnByReference */ $closure = function &($param) use ($value) {}; + +/* testBitwiseAndArrowFunctionInDefault */ +$fn = fn( $one = E_NOTICE & E_STRICT) => 1; + +/* testTokenizerIssue1284PHPCSlt280A */ +if ($foo) {} +[&$a, /* testTokenizerIssue1284PHPCSlt280B */ &$b] = $c; + +/* testTokenizerIssue1284PHPCSlt280C */ +if ($foo) {} +[&$a, $b]; diff --git a/Tests/BackCompat/BCFile/IsReferenceTest.php b/Tests/BackCompat/BCFile/IsReferenceTest.php index bf885ad5..2bb169df 100644 --- a/Tests/BackCompat/BCFile/IsReferenceTest.php +++ b/Tests/BackCompat/BCFile/IsReferenceTest.php @@ -88,234 +88,294 @@ public function testIsReference($identifier, $expected) public function dataIsReference() { return [ - [ + 'issue-1971-list-first-in-file' => [ + 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271A */', + 'expected' => true, + ], + 'issue-1971-list-first-in-file-nested' => [ + 'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271B */', + 'expected' => true, + ], + 'bitwise and: param in function call' => [ '/* testBitwiseAndA */', false, ], - [ + 'bitwise and: in unkeyed short array, first value' => [ '/* testBitwiseAndB */', false, ], - [ + 'bitwise and: in unkeyed short array, last value' => [ '/* testBitwiseAndC */', false, ], - [ + 'bitwise and: in unkeyed long array, last value' => [ '/* testBitwiseAndD */', false, ], - [ + 'bitwise and: in keyed short array, last value' => [ '/* testBitwiseAndE */', false, ], - [ + 'bitwise and: in keyed long array, last value' => [ '/* testBitwiseAndF */', false, ], - [ + 'bitwise and: in assignment' => [ '/* testBitwiseAndG */', false, ], - [ + 'bitwise and: in param default value in function declaration' => [ '/* testBitwiseAndH */', false, ], - [ + 'bitwise and: in param default value in closure declaration' => [ '/* testBitwiseAndI */', false, ], - [ + 'reference: function declared to return by reference' => [ '/* testFunctionReturnByReference */', true, ], - [ + 'reference: only param in function declaration, pass by reference' => [ '/* testFunctionPassByReferenceA */', true, ], - [ + 'reference: last param in function declaration, pass by reference' => [ '/* testFunctionPassByReferenceB */', true, ], - [ + 'reference: only param in closure declaration, pass by reference' => [ '/* testFunctionPassByReferenceC */', true, ], - [ + 'reference: last param in closure declaration, pass by reference' => [ '/* testFunctionPassByReferenceD */', true, ], - [ + 'reference: typed param in function declaration, pass by reference' => [ '/* testFunctionPassByReferenceE */', true, ], - [ + 'reference: typed param in closure declaration, pass by reference' => [ '/* testFunctionPassByReferenceF */', true, ], - [ + 'reference: variadic param in function declaration, pass by reference' => [ '/* testFunctionPassByReferenceG */', true, ], - [ + 'reference: foreach value' => [ '/* testForeachValueByReference */', true, ], - [ + 'reference: foreach key' => [ '/* testForeachKeyByReference */', true, ], - [ + 'reference: keyed short array, first value, value by reference' => [ '/* testArrayValueByReferenceA */', true, ], - [ + 'reference: keyed short array, last value, value by reference' => [ '/* testArrayValueByReferenceB */', true, ], - [ + 'reference: unkeyed short array, only value, value by reference' => [ '/* testArrayValueByReferenceC */', true, ], - [ + 'reference: unkeyed short array, last value, value by reference' => [ '/* testArrayValueByReferenceD */', true, ], - [ + 'reference: keyed long array, first value, value by reference' => [ '/* testArrayValueByReferenceE */', true, ], - [ + 'reference: keyed long array, last value, value by reference' => [ '/* testArrayValueByReferenceF */', true, ], - [ + 'reference: unkeyed long array, only value, value by reference' => [ '/* testArrayValueByReferenceG */', true, ], - [ + 'reference: unkeyed long array, last value, value by reference' => [ '/* testArrayValueByReferenceH */', true, ], - [ + 'reference: variable, assign by reference' => [ '/* testAssignByReferenceA */', true, ], - [ + 'reference: variable, assign by reference, spacing variation' => [ '/* testAssignByReferenceB */', true, ], - [ + 'reference: variable, assign by reference, concat assign' => [ '/* testAssignByReferenceC */', true, ], - [ + 'reference: property, assign by reference' => [ '/* testAssignByReferenceD */', true, ], - [ + 'reference: function return value, assign by reference' => [ '/* testAssignByReferenceE */', true, ], - [ + 'reference: function return value, assign by reference, null coalesce assign' => [ '/* testAssignByReferenceF */', true, ], - [ + 'reference: unkeyed short list, first var, assign by reference' => [ '/* testShortListAssignByReferenceNoKeyA */', true, ], - [ + 'reference: unkeyed short list, second var, assign by reference' => [ '/* testShortListAssignByReferenceNoKeyB */', true, ], - [ + 'reference: unkeyed short list, nested var, assign by reference' => [ '/* testNestedShortListAssignByReferenceNoKey */', true, ], - [ + 'reference: unkeyed long list, second var, assign by reference' => [ '/* testLongListAssignByReferenceNoKeyA */', true, ], - [ + 'reference: unkeyed long list, first nested var, assign by reference' => [ '/* testLongListAssignByReferenceNoKeyB */', true, ], - [ + 'reference: unkeyed long list, last nested var, assign by reference' => [ '/* testLongListAssignByReferenceNoKeyC */', true, ], - [ + 'reference: keyed short list, first nested var, assign by reference' => [ '/* testNestedShortListAssignByReferenceWithKeyA */', true, ], - [ + 'reference: keyed short list, last nested var, assign by reference' => [ '/* testNestedShortListAssignByReferenceWithKeyB */', true, ], - [ + 'reference: keyed long list, only var, assign by reference' => [ '/* testLongListAssignByReferenceWithKeyA */', true, ], - [ + 'reference: first param in function call, pass by reference' => [ '/* testPassByReferenceA */', true, ], - [ + 'reference: last param in function call, pass by reference' => [ '/* testPassByReferenceB */', true, ], - [ + 'reference: property in function call, pass by reference' => [ '/* testPassByReferenceC */', true, ], - [ + 'reference: hierarchical self property in function call, pass by reference' => [ '/* testPassByReferenceD */', true, ], - [ + 'reference: hierarchical parent property in function call, pass by reference' => [ '/* testPassByReferenceE */', true, ], - [ + 'reference: hierarchical static property in function call, pass by reference' => [ '/* testPassByReferenceF */', true, ], - [ + 'reference: static property in function call, pass by reference' => [ '/* testPassByReferenceG */', true, ], - [ + 'reference: static property in function call, first with FQN, pass by reference' => [ '/* testPassByReferenceH */', true, ], - [ + 'reference: static property in function call, last with FQN, pass by reference' => [ '/* testPassByReferenceI */', true, ], - [ + 'reference: static property in function call, last with namespace relative name, pass by reference' => [ '/* testPassByReferenceJ */', true, ], - [ + 'reference: static property in function call, last with PQN, pass by reference' => [ + '/* testPassByReferencePartiallyQualifiedName */', + true, + ], + 'reference: new by reference' => [ '/* testNewByReferenceA */', true, ], - [ + 'reference: new by reference as function call param' => [ '/* testNewByReferenceB */', true, ], - [ + 'reference: closure use by reference' => [ '/* testUseByReference */', true, ], - [ + 'reference: closure use by reference, first param, with comment' => [ + '/* testUseByReferenceWithCommentFirstParam */', + true, + ], + 'reference: closure use by reference, last param, with comment' => [ + '/* testUseByReferenceWithCommentSecondParam */', + true, + ], + 'reference: arrow fn declared to return by reference' => [ '/* testArrowFunctionReturnByReference */', true, ], - [ + 'bitwise and: first param default value in closure declaration' => [ + '/* testBitwiseAndExactParameterA */', + false, + ], + 'reference: param in closure declaration, pass by reference' => [ + '/* testPassByReferenceExactParameterB */', + true, + ], + 'reference: variadic param in closure declaration, pass by reference' => [ + '/* testPassByReferenceExactParameterC */', + true, + ], + 'bitwise and: last param default value in closure declaration' => [ + '/* testBitwiseAndExactParameterD */', + false, + ], + 'reference: typed param in arrow fn declaration, pass by reference' => [ + '/* testArrowFunctionPassByReferenceA */', + true, + ], + 'reference: variadic param in arrow fn declaration, pass by reference' => [ + '/* testArrowFunctionPassByReferenceB */', + true, + ], + 'reference: closure declared to return by reference' => [ '/* testClosureReturnByReference */', true, ], + 'bitwise and: param default value in arrow fn declaration' => [ + '/* testBitwiseAndArrowFunctionInDefault */', + false, + ], + 'issue-1284-short-list-directly-after-close-curly-control-structure' => [ + 'testMarker' => '/* testTokenizerIssue1284PHPCSlt280A */', + 'expected' => true, + ], + 'issue-1284-short-list-directly-after-close-curly-control-structure-second-item' => [ + 'testMarker' => '/* testTokenizerIssue1284PHPCSlt280B */', + 'expected' => true, + ], + 'issue-1284-short-array-directly-after-close-curly-control-structure' => [ + 'testMarker' => '/* testTokenizerIssue1284PHPCSlt280C */', + 'expected' => true, + ], ]; } } diff --git a/Tests/BackCompat/BCTokens/ArithmeticTokensTest.php b/Tests/BackCompat/BCTokens/ArithmeticTokensTest.php deleted file mode 100644 index 9bd33a40..00000000 --- a/Tests/BackCompat/BCTokens/ArithmeticTokensTest.php +++ /dev/null @@ -1,46 +0,0 @@ - \T_PLUS, - \T_MINUS => \T_MINUS, - \T_MULTIPLY => \T_MULTIPLY, - \T_DIVIDE => \T_DIVIDE, - \T_MODULUS => \T_MODULUS, - \T_POW => \T_POW, - ]; - - $this->assertSame($expected, BCTokens::arithmeticTokens()); - } -} diff --git a/Tests/BackCompat/BCTokens/AssignmentTokensTest.php b/Tests/BackCompat/BCTokens/AssignmentTokensTest.php deleted file mode 100644 index 1d8f7394..00000000 --- a/Tests/BackCompat/BCTokens/AssignmentTokensTest.php +++ /dev/null @@ -1,66 +0,0 @@ - \T_EQUAL, - \T_AND_EQUAL => \T_AND_EQUAL, - \T_OR_EQUAL => \T_OR_EQUAL, - \T_CONCAT_EQUAL => \T_CONCAT_EQUAL, - \T_DIV_EQUAL => \T_DIV_EQUAL, - \T_MINUS_EQUAL => \T_MINUS_EQUAL, - \T_POW_EQUAL => \T_POW_EQUAL, - \T_MOD_EQUAL => \T_MOD_EQUAL, - \T_MUL_EQUAL => \T_MUL_EQUAL, - \T_PLUS_EQUAL => \T_PLUS_EQUAL, - \T_XOR_EQUAL => \T_XOR_EQUAL, - \T_DOUBLE_ARROW => \T_DOUBLE_ARROW, - \T_SL_EQUAL => \T_SL_EQUAL, - \T_SR_EQUAL => \T_SR_EQUAL, - ]; - - if (\version_compare($version, '2.8.1', '>=') === true - || \version_compare(\PHP_VERSION_ID, '70399', '>=') === true - ) { - $expected[\T_COALESCE_EQUAL] = \T_COALESCE_EQUAL; - } - - if (\version_compare($version, '2.8.0', '>=') === true) { - $expected[\T_ZSR_EQUAL] = \T_ZSR_EQUAL; - } - - $this->assertSame($expected, BCTokens::assignmentTokens()); - } -} diff --git a/Tests/BackCompat/BCTokens/ComparisonTokensTest.php b/Tests/BackCompat/BCTokens/ComparisonTokensTest.php deleted file mode 100644 index a70afb6d..00000000 --- a/Tests/BackCompat/BCTokens/ComparisonTokensTest.php +++ /dev/null @@ -1,57 +0,0 @@ - \T_IS_EQUAL, - \T_IS_IDENTICAL => \T_IS_IDENTICAL, - \T_IS_NOT_EQUAL => \T_IS_NOT_EQUAL, - \T_IS_NOT_IDENTICAL => \T_IS_NOT_IDENTICAL, - \T_LESS_THAN => \T_LESS_THAN, - \T_GREATER_THAN => \T_GREATER_THAN, - \T_IS_SMALLER_OR_EQUAL => \T_IS_SMALLER_OR_EQUAL, - \T_IS_GREATER_OR_EQUAL => \T_IS_GREATER_OR_EQUAL, - \T_SPACESHIP => \T_SPACESHIP, - ]; - - if (\version_compare($version, '2.6.1', '>=') === true - || \version_compare(\PHP_VERSION_ID, '60999', '>=') === true - ) { - $expected[\T_COALESCE] = \T_COALESCE; - } - - $this->assertSame($expected, BCTokens::comparisonTokens()); - } -} diff --git a/Tests/BackCompat/BCTokens/EmptyTokensTest.php b/Tests/BackCompat/BCTokens/EmptyTokensTest.php deleted file mode 100644 index 38dcff9b..00000000 --- a/Tests/BackCompat/BCTokens/EmptyTokensTest.php +++ /dev/null @@ -1,112 +0,0 @@ - =>{{ site.title | default: site.github.repository_name }}
- + {% if site.logo %}{{ site.description | default: site.github.project_tagline }}
- {% if site.github.is_project_page %} -Visit the Project on GitHub {{ site.github.repository_nwo }}
- {% endif %} -
@@ -34,6 +30,10 @@ {{ site.title | default: site.github.repo
+ {% if site.github.latest_release.tag_name %}
+ {{ site.title | default: site.github.repo
composer require {{ site.phpcsutils.packagist }}
composer require {{ site.phpcsutils.packagist }}Latest release: {{ site.github.latest_release.tag_name }}
+ {% endif %} + {% if site.show_downloads %}- Download ZIP File @@ -42,9 +42,9 @@
{{ site.title | default: site.github.repo
Visit the Project on GitHub {{ site.github.repository_nwo }}
-
-### Use the latest version of PHP_CodeSniffer native utility functions.
+### An ever-growing number of utility functions for use with PHP_CodeSniffer
-Normally to use the latest version of PHP_CodeSniffer native utility functions, you would have to raise the minimum requirements of your external PHPCS standard.
+Whether you need to split an `array` into the individual items, are trying to determine which variables are being assigned to in a `list()` or are figuring out whether a function has a DocBlock, PHPCSUtils has got you covered!
-Now you won't have to anymore. This package allows you to use the latest version of those utility functions in all PHP_CodeSniffer versions from PHPCS 2.6.0 and up.
+Includes improved versions of the PHPCS native utility functions and plenty of new utility functions.
-### Several abstract sniff classes which your sniffs can extend.
+These functions are compatible with PHPCS 3.7.1 up to PHPCS `master`.
-These classes take most of the heavy lifting away for some frequently occurring sniff types.
-
-### A collection of static properties and methods for often-used token groups.
+### A collection of static properties and methods for often-used token groups
Collections of related tokens often-used and needed for sniffs.
These are additional "token groups" to compliment the ones available through the PHPCS native `PHP_CodeSniffer\Util\Tokens` class.
-### An ever-growing number of utility functions for use with PHP_CodeSniffer.
-
-Whether you need to split an `array` into the individual items, are trying to determine which variables are being assigned to in a `list()` or are figuring out whether a function has a DocBlock, PHPCSUtils has got you covered!
+### Several abstract sniff classes which your sniffs can extend
-Includes improved versions of the PHPCS native utility functions and plenty of new utility functions.
-
-These functions are, of course, compatible with PHPCS 2.6.0 up to PHPCS `master`.
+These classes take most of the heavy lifting away for some frequently occurring sniff types.
### Test utilities
An abstract `UtilityMethodTestCase` class to support testing of your utility methods written for PHP_CodeSniffer.
-Compatible with both PHPCS 2.x as well as 3.x. Supports PHPUnit 4.x up to 9.x.
+Supports PHPUnit 4.x up to 9.x.
-### Backward compatibility layer
+### Use the latest version of PHP_CodeSniffer native utility functions
-A `PHPCS23Utils` standard which allows sniffs to work in both PHPCS 2.x and 3.x, as well as a few helper functions for external standards which still want to support both PHP_CodeSniffer 2.x as well as 3.x.
+Normally to use the latest version of PHP_CodeSniffer native utility functions, you would have to raise the minimum requirements of your external PHPCS standard.
+
+Now you won't have to anymore. This package allows you to use the latest version of those utility functions in all PHP_CodeSniffer versions from PHPCS 3.7.1 and up.
### Fully documented
-To see detailed information about all the available abstract sniffs, utility functions and PHPCS helper functions, have a read through the [extensive documentation](https://phpcsutils.com/).
+To see detailed information about all the available abstract sniffs, utility functions and PHPCS helper functions, have a read through the [extensive documentation][phpcsutils-web].
-Minimum Requirements
--------------------------------------------
+
+## Minimum Requirements
* PHP 5.4 or higher.
-* [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) 2.6.0+, 3.1.0+ (with the exception of PHPCS 3.5.3).
+* [PHP_CodeSniffer] 3.7.1+.
* Recommended PHP extensions for optimal functionality:
- PCRE with Unicode support (normally enabled by default)
-Integrating PHPCSUtils in your external PHPCS standard
--------------------------------------------
+## Integrating PHPCSUtils in your external PHPCS standard
-### Composer-based with a minimum PHPCS requirement of PHPCS 3.1.0
+### Composer-based
-If your external PHP_CodeSniffer standard only supports Composer-based installs and has a minimum PHPCS requirement of PHP_CodeSniffer 3.1.0, integrating PHPCSUtils is pretty straight forward.
+If your external PHP_CodeSniffer standard only supports Composer-based installs, integrating PHPCSUtils is pretty straight forward.
Run the following from the root of your external PHPCS standard's project:
-composer require {{ site.phpcsutils.packagist }}:"^1.0"
+composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
+composer require {{ site.phpcsutils.packagist }}:"^1.0"
No further action needed. You can start using all the utility functions, abstract sniff classes and other features of PHPCSUtils straight away.
-> :information_source: The PHPCSUtils package includes the [DealerDirect Composer PHPCS plugin](https://github.com/Dealerdirect/phpcodesniffer-composer-installer).
+> :information_source: The PHPCSUtils package includes the [Composer PHPCS plugin].
>
> This plugin will automatically register PHPCSUtils (and your own external standard) with PHP_CodeSniffer, so you and your users don't have to worry about this anymore.
>
> :warning: Note: if your end-user installation instructions include instructions on adding a Composer PHPCS plugin or on manually registering your standard with PHPCS using the `--config-set installed_paths` command, you can remove those instructions as they are no longer needed.
+>
+> :information_source: As of Composer 2.2, Composer will [ask for permission](https://blog.packagist.com/composer-2-2/#more-secure-plugin-execution) to allow the Composer PHPCS plugin to execute code. For the plugin to be functional, permission needs to be granted.
+> This can be done ahead of time by instructing your users to run the following command before installing your standard:
+>
+> composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
+>
#### Running your unit tests
@@ -94,104 +95,83 @@ If you have your own unit test suite to test your sniffs, make sure to load the
If you intend to use the test utilities provided in the `PHPCSUtils/TestUtils` directory, make sure you also load the `vendor/phpcsstandards/phpcsutils/phpcsutils-autoload.php` file in your PHPUnit bootstrap file.
-### Composer-based with a minimum PHPCS requirement of PHPCS 2.6.0
-
-Follow the above instructions for use with PHPCS 3.x.
-
-In addition to that, add the following to the `ruleset.xml` file of your standard(s):
-```xml
-
-composer update your/cs-package --with-dependencies
+>
+> composer update your/cs-package --with-[all-]dependencies
>
+>
> That way, when the user updates your coding standards package, they will automatically also update PHPCSUtils.
+---
+
-Contributing
--------
+## Contributing
+
Contributions to this project are welcome. Clone the repo, branch off from `develop`, make your changes, commit them and send in a pull request.
If you are unsure whether the changes you are proposing would be welcome, please open an issue first to discuss your proposal.
-License
--------
-This code is released under the [GNU Lesser General Public License (LGPLv3)](http://www.gnu.org/copyleft/lesser.html).
+
+## License
+
+This code is released under the [GNU Lesser General Public License (LGPLv3)](https://www.gnu.org/copyleft/lesser.html).
+
+
+[PHP_CodeSniffer]: https://github.com/squizlabs/PHP_CodeSniffer
+[Composer PHPCS plugin]: https://github.com/PHPCSStandards/composer-installer
+[phpcsutils-repo]: https://github.com/PHPCSStandards/PHPCSUtils
+[phpcsutils-web]: https://phpcsutils.com/
+[phpcsutils-packagist]: https://packagist.org/packages/phpcsstandards/phpcsutils
+[phpcsutils-releases]: https://github.com/PHPCSStandards/PHPCSUtils/releases
+[phpcsutils-tests-gha]: https://github.com/PHPCSStandards/PHPCSUtils/actions/workflows/test.yml
diff --git a/docs/phpdoc/classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html b/docs/phpdoc/classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html
index d65c9501..33b518f7 100644
--- a/docs/phpdoc/classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html
+++ b/docs/phpdoc/classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html
@@ -2,71 +2,119 @@
- PHPCSUtils
+ PHPCSUtils
+
-
-
-
-
-
+
- PHPCSUtils
-
-
-
-
-