Merge remote-tracking branch 'upstream/master' into feature/improve-sniff-code-error-message

Author: fredden

CHANGELOG.md

@@ -6,6 +6,87 @@ The file documents changes to the PHP_CodeSniffer project.
 
 _Nothing yet._
 
+## [3.10.1] - 2024-05-22
+
+### Added
+- Documentation for the following sniffs:
+    - Generic.Commenting.DocComment
+    - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
+
+### Changed
+- The following have received efficiency improvements:
+    - Type handling in the PHP Tokenizer
+    - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
+- Various housekeeping, including improvements to the tests and documentation.
+    - Thanks to [Juliette Reinders Folmer][@jrfnl] for their contributions.
+
+### Fixed
+- Fixed bug [#110], [#437], [#475]: `File::findStartOfStatement()`: the start of statement/expression determination for tokens in parentheses/short array brackets/others scopes, nested within match expressions, was incorrect in most cases.
+    The trickle down effect of the bug fixes made to the `File::findStartOfStatement()` method, is that the Generic.WhiteSpace.ScopeIndent and the PEAR.WhiteSpace.ScopeIndent sniffs should now be able to correctly determine and fix the indent for match expressions containing nested expressions.
+    These fixes also fix an issue with the `Squiz.Arrays.ArrayDeclaration` sniff and possibly other, unreported bugs.
+    - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch
+- Fixed bug [#504]: The tokenizer could inadvertently mistake the last parameter in a function call using named arguments for a DNF type.
+    - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch
+- Fixed bug [#508]: Tokenizer/PHP: extra hardening against handling parse errors in the type handling layer.
+    - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch
+
+[#110]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/110
+[#437]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/437
+[#475]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/475
+[#504]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/504
+[#508]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/508
+
+## [3.10.0] - 2024-05-20
+
+### Added
+- Tokenizer support for PHP 8.2 Disjunctive Normal Form (DNF) types. [#3731][sq-3731], [#387], [#461]
+    - Includes new `T_TYPE_OPEN_PARENTHESIS` and `T_TYPE_CLOSE_PARENTHESIS` tokens to represent the parentheses in DNF types.
+    - These new tokens, like other parentheses, will have the `parenthesis_opener` and `parenthesis_closer` token array indexes set and the tokens between them will have the `nested_parenthesis` index.
+    - The `File::getMethodProperties()`, `File::getMethodParameters()` and `File::getMemberProperties()` methods now all support DNF types. [#471], [#472], [#473]
+    - Additionally, the following sniff has been updated to support DNF types:
+        - Generic.PHP.LowerCaseType [#478]
+    - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches.
+- Documentation for the following sniffs:
+    - Squiz.WhiteSpace.FunctionClosingBraceSpace
+    - Thanks to [Przemek Hernik][@przemekhernik] for the patch.
+
+### Changed
+- The help screens have received a face-lift for improved usability and readability. [#447]
+    - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch and thanks to [Colin Stewart][@costdev], [Gary Jones][@GaryJones] and [@mbomb007] for reviewing.
+- The Squiz.Commenting.ClosingDeclarationComment sniff will now also examine and flag closing comments for traits. [#442]
+    - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
+- The following sniff(s) have efficiency improvements:
+    - Generic.Arrays.ArrayIndent
+    - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
+- The autoloader will now always return a boolean value indicating whether it has loaded a class or not. [#479]
+    - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
+- Various housekeeping, including improvements to the tests and documentation.
+    - Thanks to [Dan Wallis][@fredden], [Danny van der Sluijs][@DannyvdSluijs], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions.
+
+### Fixed
+- Fixed bug [#466] : Generic.Functions.CallTimePassByReference was not flagging call-time pass-by-reference in class instantiations using the self/parent/static keywords.
+    - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
+- Fixed bug [#494] : edge case bug in tokenization of an empty block comment.
+    - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch
+- Fixed bug [#494] : edge case bug in tokenization of an empty single-line DocBlock.
+    - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch
+- Fixed bug [#499] : Generic.ControlStructures.InlineControlStructure now handles statements with a comment between `else` and `if` correctly.
+    - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
+
+[sq-3731]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3731
+[#387]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/387
+[#442]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/442
+[#447]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/447
+[#461]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/461
+[#466]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/466
+[#471]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/471
+[#472]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/472
+[#473]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/473
+[#478]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/478
+[#479]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/479
+[#494]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/494
+[#499]:    https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/499
+
 ## [3.9.2] - 2024-04-24
 
 ### Changed
@@ -6883,6 +6964,8 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
 -->
 
 [Unreleased]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/master...HEAD
+[3.10.1]:     https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.0...3.10.1
+[3.10.0]:     https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.9.2...3.10.0
 [3.9.2]:      https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.9.1...3.9.2
 [3.9.1]:      https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.9.0...3.9.1
 [3.9.0]:      https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.8.1...3.9.0
@@ -7020,6 +7103,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
 [@cixtor]:              https://github.com/cixtor
 [@claylo]:              https://github.com/claylo
 [@codebymikey]:         https://github.com/codebymikey
+[@costdev]:             https://github.com/costdev
 [@covex-nn]:            https://github.com/covex-nn
 [@cweiske]:             https://github.com/cweiske
 [@Daimona]:             https://github.com/Daimona
@@ -7118,6 +7202,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
 [@michaelbutler]:       https://github.com/michaelbutler
 [@michalbundyra]:       https://github.com/michalbundyra
 [@Morerice]:            https://github.com/Morerice
+[@mbomb007]:            https://github.com/mbomb007
 [@morozov]:             https://github.com/morozov
 [@mrkrstphr]:           https://github.com/mrkrstphr
 [@mythril]:             https://github.com/mythril
@@ -7136,6 +7221,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
 [@pfrenssen]:           https://github.com/pfrenssen
 [@phil-davis]:          https://github.com/phil-davis
 [@photodude]:           https://github.com/photodude
+[@przemekhernik]:       https://github.com/przemekhernik
 [@r3nat]:               https://github.com/r3nat
 [@raul338]:             https://github.com/raul338
 [@realmfoo]:            https://github.com/realmfoo

README.md

@@ -48,7 +48,7 @@ php phpcbf.phar -h
 ```
 
 These Phars are signed with the official Release key for PHPCS with the
-fingerprint `95DE 904A B800 754A 11D8 0B60 5E6D DE99 8AB7 3B8E`.
+fingerprint `689D AD77 8FF0 8760 E046 228B A978 2203 05CD 5C32`.
 
 ### Composer
 If you use Composer, you can install PHP_CodeSniffer system-wide with the following command:
@@ -76,8 +76,8 @@ You will then be able to run PHP_CodeSniffer from the vendor bin directory:
 ### Phive
 If you use Phive, you can install PHP_CodeSniffer as a project tool using the following commands:
 ```bash
-phive install --trust-gpg-keys 95DE904AB800754A11D80B605E6DDE998AB73B8E phpcs
-phive install --trust-gpg-keys 95DE904AB800754A11D80B605E6DDE998AB73B8E phpcbf
+phive install --trust-gpg-keys 689DAD778FF08760E046228BA978220305CD5C32 phpcs
+phive install --trust-gpg-keys 689DAD778FF08760E046228BA978220305CD5C32 phpcbf
 ```
 You will then be able to run PHP_CodeSniffer from the `tools` directory:
 ```bash

phpcs.xml.dist

@@ -139,7 +139,7 @@
 
     <!-- This test file specifically *needs* Windows line endings for testing purposes. -->
     <rule ref="Generic.Files.LineEndings.InvalidEOLChar">
-        <exclude-pattern>tests/Core/Tokenizer/StableCommentWhitespaceWinTest\.php</exclude-pattern>
+        <exclude-pattern>tests/Core/Tokenizer/PHP/StableCommentWhitespaceWinTest\.php</exclude-pattern>
     </rule>
 
     <!-- Avoid false positive with this sniff detecting itself -->

src/Config.php

@@ -85,7 +85,7 @@ class Config
      *
      * @var string
      */
-    const VERSION = '3.10.0';
+    const VERSION = '3.10.2';
 
     /**
      * Package stability; either stable, beta or alpha.

src/Files/File.php

@@ -2435,51 +2435,88 @@ public function findStartOfStatement($start, $ignore=null)
         // If the start token is inside the case part of a match expression,
         // find the start of the condition. If it's in the statement part, find
         // the token that comes after the match arrow.
-        $matchExpression = $this->getCondition($start, T_MATCH);
-        if ($matchExpression !== false) {
-            for ($prevMatch = $start; $prevMatch > $this->tokens[$matchExpression]['scope_opener']; $prevMatch--) {
-                if ($prevMatch !== $start
-                    && ($this->tokens[$prevMatch]['code'] === T_MATCH_ARROW
-                    || $this->tokens[$prevMatch]['code'] === T_COMMA)
-                ) {
-                    break;
-                }
+        if (empty($this->tokens[$start]['conditions']) === false) {
+            $conditions         = $this->tokens[$start]['conditions'];
+            $lastConditionOwner = end($conditions);
+            $matchExpression    = key($conditions);
+
+            if ($lastConditionOwner === T_MATCH
+                // Check if the $start token is at the same parentheses nesting level as the match token.
+                && ((empty($this->tokens[$matchExpression]['nested_parenthesis']) === true
+                && empty($this->tokens[$start]['nested_parenthesis']) === true)
+                || ((empty($this->tokens[$matchExpression]['nested_parenthesis']) === false
+                && empty($this->tokens[$start]['nested_parenthesis']) === false)
+                && $this->tokens[$matchExpression]['nested_parenthesis'] === $this->tokens[$start]['nested_parenthesis']))
+            ) {
+                // Walk back to the previous match arrow (if it exists).
+                $lastComma          = null;
+                $inNestedExpression = false;
+                for ($prevMatch = $start; $prevMatch > $this->tokens[$matchExpression]['scope_opener']; $prevMatch--) {
+                    if ($prevMatch !== $start && $this->tokens[$prevMatch]['code'] === T_MATCH_ARROW) {
+                        break;
+                    }
 
-                // Skip nested statements.
-                if (isset($this->tokens[$prevMatch]['bracket_opener']) === true
-                    && $prevMatch === $this->tokens[$prevMatch]['bracket_closer']
-                ) {
-                    $prevMatch = $this->tokens[$prevMatch]['bracket_opener'];
-                } else if (isset($this->tokens[$prevMatch]['parenthesis_opener']) === true
-                    && $prevMatch === $this->tokens[$prevMatch]['parenthesis_closer']
-                ) {
-                    $prevMatch = $this->tokens[$prevMatch]['parenthesis_opener'];
-                }
-            }
+                    if ($prevMatch !== $start && $this->tokens[$prevMatch]['code'] === T_COMMA) {
+                        $lastComma = $prevMatch;
+                        continue;
+                    }
 
-            if ($prevMatch <= $this->tokens[$matchExpression]['scope_opener']) {
-                // We're before the arrow in the first case.
-                $next = $this->findNext(Tokens::$emptyTokens, ($this->tokens[$matchExpression]['scope_opener'] + 1), null, true);
-                if ($next === false) {
-                    return $start;
-                }
+                    // Skip nested statements.
+                    if (isset($this->tokens[$prevMatch]['bracket_opener']) === true
+                        && $prevMatch === $this->tokens[$prevMatch]['bracket_closer']
+                    ) {
+                        $prevMatch = $this->tokens[$prevMatch]['bracket_opener'];
+                        continue;
+                    }
 
-                return $next;
-            }
+                    if (isset($this->tokens[$prevMatch]['parenthesis_opener']) === true
+                        && $prevMatch === $this->tokens[$prevMatch]['parenthesis_closer']
+                    ) {
+                        $prevMatch = $this->tokens[$prevMatch]['parenthesis_opener'];
+                        continue;
+                    }
 
-            if ($this->tokens[$prevMatch]['code'] === T_COMMA) {
-                // We're before the arrow, but not in the first case.
-                $prevMatchArrow = $this->findPrevious(T_MATCH_ARROW, ($prevMatch - 1), $this->tokens[$matchExpression]['scope_opener']);
-                if ($prevMatchArrow === false) {
-                    // We're before the arrow in the first case.
-                    $next = $this->findNext(Tokens::$emptyTokens, ($this->tokens[$matchExpression]['scope_opener'] + 1), null, true);
-                    return $next;
-                }
+                    // Stop if we're _within_ a nested short array statement, which may contain comma's too.
+                    // No need to deal with parentheses, those are handled above via the `nested_parenthesis` checks.
+                    if (isset($this->tokens[$prevMatch]['bracket_opener']) === true
+                        && $this->tokens[$prevMatch]['bracket_closer'] > $start
+                    ) {
+                        $inNestedExpression = true;
+                        break;
+                    }
+                }//end for
+
+                if ($inNestedExpression === false) {
+                    // $prevMatch will now either be the scope opener or a match arrow.
+                    // If it is the scope opener, go the first non-empty token after. $start will have been part of the first condition.
+                    if ($prevMatch <= $this->tokens[$matchExpression]['scope_opener']) {
+                        // We're before the arrow in the first case.
+                        $next = $this->findNext(Tokens::$emptyTokens, ($this->tokens[$matchExpression]['scope_opener'] + 1), null, true);
+                        if ($next === false) {
+                            // Shouldn't be possible.
+                            return $start;
+                        }
 
-                $end  = $this->findEndOfStatement($prevMatchArrow);
-                $next = $this->findNext(Tokens::$emptyTokens, ($end + 1), null, true);
-                return $next;
-            }
+                        return $next;
+                    }
+
+                    // Okay, so we found a match arrow.
+                    // If $start was part of the "next" condition, the last comma will be set.
+                    // Otherwise, $start must have been part of a return expression.
+                    if (isset($lastComma) === true && $lastComma > $prevMatch) {
+                        $prevMatch = $lastComma;
+                    }
+
+                    // In both cases, go to the first non-empty token after.
+                    $next = $this->findNext(Tokens::$emptyTokens, ($prevMatch + 1), null, true);
+                    if ($next === false) {
+                        // Shouldn't be possible.
+                        return $start;
+                    }
+
+                    return $next;
+                }//end if
+            }//end if
         }//end if
 
         $lastNotEmpty = $start;