Merge pull request #629 from PHPCSStandards/feature/tests-findstartendofstatement-sync-with-upstream

Composer: raise minimum PHPCS to 3.10.1 and sync some tests with upstream

Author: jrfnl

PHPCSUtils/BackCompat/BCFile.php

@@ -76,7 +76,7 @@ final class BCFile
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 0.0.5.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::getDeclarationName() Original source.
  * @see \PHPCSUtils\Utils\ObjectDeclarations::getName() PHPCSUtils native improved version.
@@ -466,7 +466,7 @@ public static function getMethodParameters(File $phpcsFile, $stackPtr)
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 0.0.5.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::getMethodProperties() Original source.
  * @see \PHPCSUtils\Utils\FunctionDeclarations::getProperties() PHPCSUtils native improved version.
@@ -511,7 +511,7 @@ public static function getMethodProperties(File $phpcsFile, $stackPtr)
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 0.0.5.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::getMemberProperties() Original source.
  * @see \PHPCSUtils\Utils\Variables::getMemberProperties() PHPCSUtils native improved version.
@@ -549,7 +549,7 @@ public static function getMemberProperties(File $phpcsFile, $stackPtr)
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 1.3.0.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::getClassProperties() Original source.
  * @see \PHPCSUtils\Utils\ObjectDeclarations::getClassProperties() PHPCSUtils native improved version.
@@ -577,7 +577,7 @@ public static function getClassProperties(File $phpcsFile, $stackPtr)
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 0.0.5.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::isReference() Original source.
  * @see \PHPCSUtils\Utils\Operators::isReference() PHPCSUtils native improved version.
@@ -603,7 +603,7 @@ public static function isReference(File $phpcsFile, $stackPtr)
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 0.0.5.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::getTokensAsString() Original source.
  * @see \PHPCSUtils\Utils\GetTokensAsString Related set of functions.
@@ -632,7 +632,7 @@ public static function getTokensAsString(File $phpcsFile, $start, $length, $orig
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 2.1.0.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::findStartOfStatement() Original source.
  *
@@ -656,7 +656,7 @@ public static function findStartOfStatement(File $phpcsFile, $start, $ignore = n
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 2.1.0.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::findEndOfStatement() Original source.
  *
@@ -680,7 +680,7 @@ public static function findEndOfStatement(File $phpcsFile, $start, $ignore = nul
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 0.0.5.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::hasCondition() Original source.
  * @see \PHPCSUtils\Utils\Conditions::hasCondition() PHPCSUtils native alternative.
@@ -705,7 +705,7 @@ public static function hasCondition(File $phpcsFile, $stackPtr, $types)
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 1.3.0.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::getCondition() Original source.
  * @see \PHPCSUtils\Utils\Conditions::getCondition() More versatile alternative.
@@ -736,7 +736,7 @@ public static function getCondition(File $phpcsFile, $stackPtr, $type, $first =
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 1.2.0.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::findExtendedClassName() Original source.
  * @see \PHPCSUtils\Utils\ObjectDeclarations::findExtendedClassName() PHPCSUtils native improved version.
@@ -761,7 +761,7 @@ public static function findExtendedClassName(File $phpcsFile, $stackPtr)
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 2.7.0.
- * - The upstream method has received no significant updates since PHPCS 3.10.0.
+ * - The upstream method has received no significant updates since PHPCS 3.10.1.
  *
  * @see \PHP_CodeSniffer\Files\File::findImplementedInterfaceNames() Original source.
  * @see \PHPCSUtils\Utils\ObjectDeclarations::findImplementedInterfaceNames() PHPCSUtils native improved version.

PHPCSUtils/BackCompat/BCTokens.php

@@ -74,7 +74,7 @@ final class BCTokens
 
  /**
  * Handle calls to (undeclared) methods for token arrays which haven't received any
- * changes since PHPCS 3.10.0.
+ * changes since PHPCS 3.10.1.
  *
  * @since 1.0.0
  *

README.md

@@ -46,7 +46,7 @@ Whether you need to split an `array` into the individual items, are trying to de
 
 Includes improved versions of the PHPCS native utility functions and plenty of new utility functions.
 
-These functions are compatible with PHPCS 3.10.0 up to PHPCS `master`.
+These functions are compatible with PHPCS 3.10.1 up to PHPCS `master`.
 
 ### A collection of static properties and methods for often-used token groups
 
@@ -78,7 +78,7 @@ To see detailed information about all the available abstract sniffs, utility fun
 ## Minimum Requirements
 
 * PHP 5.4 or higher.
-* [PHP_CodeSniffer] 3.10.0+.
+* [PHP_CodeSniffer] 3.10.1+.
 * Recommended PHP extensions for optimal functionality:
  - PCRE with Unicode support (normally enabled by default)
 

Tests/BackCompat/BCFile/FindEndOfStatementTest.php

@@ -22,6 +22,7 @@
 
 namespace PHPCSUtils\Tests\BackCompat\BCFile;
 
+use PHP_CodeSniffer\Util\Tokens;
 use PHPCSUtils\BackCompat\BCFile;
 use PHPCSUtils\TestUtils\UtilityMethodTestCase;
 
@@ -35,6 +36,40 @@
 final class FindEndOfStatementTest extends UtilityMethodTestCase
 {
 
+ /**
+ * Test that end of statement is NEVER before the "current" token.
+ *
+ * @return void
+ */
+ public function testEndIsNeverLessThanCurrentToken()
+ {
+ $tokens = self::$phpcsFile->getTokens();
+ $errors = [];
+
+ for ($i = 0; $i < self::$phpcsFile->numTokens; $i++) {
+ if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) {
+ continue;
+ }
+
+ $end = BCFile::findEndOfStatement(self::$phpcsFile, $i);
+
+ // Collect all the errors.
+ if ($end < $i) {
+ $errors[] = sprintf(
+ 'End of statement for token %1$d (%2$s: %3$s) on line %4$d is %5$d (%6$s), which is less than %1$d',
+ $i,
+ $tokens[$i]['type'],
+ $tokens[$i]['content'],
+ $tokens[$i]['line'],
+ $end,
+ $tokens[$end]['type']
+ );
+ }
+ }
+
+ $this->assertSame([], $errors);
+ }
+
  /**
  * Test a simple assignment.
  *

Tests/BackCompat/BCFile/FindStartOfStatementTest.inc

@@ -14,7 +14,7 @@ while(true) {}
 $a = 1;
 
 /* testClosureAssignment */
-$a = function($b=false;){};
+$a = function($b=false){};
 
 /* testHeredocFunctionArg */
 myFunction(<<<END
@@ -39,8 +39,8 @@ use Vendor\Package\{ClassA as A, ClassB, ClassC as C};
 
 $a = [
  /* testArrowFunctionArrayValue */
- 'a' => fn() => return 1,
- 'b' => fn() => return 1,
+ 'a' => fn() => 1,
+ 'b' => fn() => 1,
 ];
 
 /* testStaticArrowFunction */
@@ -139,11 +139,11 @@ switch ($foo) {
  /* testInsideCaseStatement */
  $var = doSomething();
  /* testInsideCaseBreakStatement */
- break 2;
+ break 1;
 
  case 2:
  /* testInsideCaseContinueStatement */
- continue 2;
+ continue 1;
 
  case 3:
  /* testInsideCaseReturnStatement */
@@ -162,3 +162,39 @@ switch ($foo) {
  /* testInsideDefaultContinueStatement */
  continue $var;
 }
+
+match ($var) {
+ true =>
+ /* test437ClosureDeclaration */
+ function ($var) {
+ /* test437EchoNestedWithinClosureWithinMatch */
+ echo $var, 'text', PHP_EOL;
+ },
+ default => false
+};
+
+match ($var) {
+ /* test437NestedLongArrayWithinMatch */
+ 'a' => array( 1, 2.5, $var),
+ /* test437NestedFunctionCallWithinMatch */
+ 'b' => functionCall( 11, $var, 50.50),
+ /* test437NestedArrowFunctionWithinMatch */
+ 'c' => fn($p1, /* test437FnSecondParamWithinMatch */ $p2) => $p1 + $p2,
+ default => false
+};
+
+callMe($paramA, match ($var) {
+ /* test437NestedLongArrayWithinNestedMatch */
+ 'a' => array( 1, 2.5, $var),
+ /* test437NestedFunctionCallWithinNestedMatch */
+ 'b' => functionCall( 11, $var, 50.50),
+ /* test437NestedArrowFunctionWithinNestedMatch */
+ 'c' => fn($p1, /* test437FnSecondParamWithinNestedMatch */ $p2) => $p1 + $p2,
+ default => false
+});
+
+match ($var) {
+ /* test437NestedShortArrayWithinMatch */
+ 'a' => [ 1, 2.5, $var],
+ default => false
+};