Merge remote-tracking branch 'upstream/master' into whitespace-incompatibility

Author: fredden

.github/workflows/test.yml

@@ -97,11 +97,11 @@ jobs:
           # Set the "short_open_tag" ini to make sure specific conditions are tested.
           # Also turn on error_reporting to ensure all notices are shown.
           if [[ ${{ matrix.custom_ini }} == true && "${{ matrix.php }}" == '5.5' ]]; then
-            echo '::set-output name=PHP_INI::error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On, asp_tags=On'
+            echo 'PHP_INI=error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On, asp_tags=On' >> $GITHUB_OUTPUT
           elif [[ ${{ matrix.custom_ini }} == true && "${{ matrix.php }}" == '7.0' ]]; then
-            echo '::set-output name=PHP_INI::error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On'
+            echo 'PHP_INI=error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On' >> $GITHUB_OUTPUT
           else
-            echo '::set-output name=PHP_INI::error_reporting=-1, display_errors=On'
+            echo 'PHP_INI=error_reporting=-1, display_errors=On' >> $GITHUB_OUTPUT
           fi
 
       - name: Install PHP

composer.json

@@ -4,7 +4,8 @@
     "type": "library",
     "keywords": [
         "phpcs",
-        "standards"
+        "standards",
+        "static analysis"
     ],
     "homepage": "https://github.com/squizlabs/PHP_CodeSniffer",
     "license": "BSD-3-Clause",

package.xml

@@ -26,10 +26,35 @@ http://pear.php.net/dtd/package-2.0.xsd">
  </stability>
  <license uri="https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt">BSD 3-Clause License</license>
  <notes>
+  - Newer versions of Composer will now suggest installing PHPCS using require-dev instead of require
+    -- Thanks to Gary Jones (@GaryJones) for the patch
+  - A custom Out Of Memory error will now be shown if PHPCS or PHPCBF run out of memory during a run
+    -- Error message provides actionable information about how to fix the problem and ensures the error is not silent
+    -- Thanks to Juliette Reinders Folmer (@jrfnl) and Alain Schlesser (@schlessera) for the patch
+  - Generic.PHP.LowerCaseType sniff now correctly examines types inside arrow functions
+    -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+  - Squiz.Formatting.OperatorBracket no longer reports false positives in match() structures
   - Fixed bug #3616 : Squiz.PHP.DisallowComparisonAssignment false positive for PHP 8 match expression
     -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
   - Fixed bug #3618 : Generic.WhiteSpace.ArbitraryParenthesesSpacing false positive for return new parent()
     -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+  - Fixed bug #3632 : Short list not tokenized correctly in control structures without braces
+    -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+  - Fixed bug #3639 : Tokenizer not applying tab replacement to heredoc/nowdoc closers
+    -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+  - Fixed bug #3640 : Generic.WhiteSpace.DisallowTabIndent not reporting errors for PHP 7.3 flexible heredoc/nowdoc syntax
+    -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+  - Fixed bug #3645 : PHPCS can show 0 exit code when running in parallel even if child process has fatal error
+    -- Thanks to Alex Panshin (@enl) for the patch
+  - Fixed bug #3653 : False positives for match() in OperatorSpacingSniff
+    -- Thanks to Jaroslav Hanslík (@kukulich) for the patch
+  - Fixed bug #3666 : PEAR.Functions.FunctionCallSignature incorrect indent fix when checking mixed HTML/PHP files
+  - Fixed bug #3668 : PSR12.Classes.ClassInstantiation.MissingParentheses false positive when instantiating parent classes
+    -- Similar issues also fixed in Generic.Functions.FunctionCallArgumentSpacing and Squiz.Formatting.OperatorBracket
+    -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+  - Fixed bug #3672 : Incorrect ScopeIndent.IncorrectExact report for match inside array literal
+  - Fixed bug #3694 : Generic.WhiteSpace.SpreadOperatorSpacingAfter does not ignore spread operator in PHP 8.1 first class callables
+    -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
  </notes>
  <contents>
   <dir name="/">
@@ -143,6 +168,10 @@ http://pear.php.net/dtd/package-2.0.xsd">
       <file baseinstalldir="" name="FinallyTest.php" role="test" />
       <file baseinstalldir="" name="GotoLabelTest.inc" role="test" />
       <file baseinstalldir="" name="GotoLabelTest.php" role="test" />
+      <file baseinstalldir="" name="HeredocNowdocCloserTest.inc" role="test" />
+      <file baseinstalldir="" name="HeredocNowdocCloserTest.php" role="test" />
+      <file baseinstalldir="" name="HeredocStringTest.inc" role="test" />
+      <file baseinstalldir="" name="HeredocStringTest.php" role="test" />
       <file baseinstalldir="" name="NamedFunctionCallArgumentsTest.inc" role="test" />
       <file baseinstalldir="" name="NamedFunctionCallArgumentsTest.php" role="test" />
       <file baseinstalldir="" name="NullsafeObjectOperatorTest.inc" role="test" />
@@ -785,6 +814,8 @@ http://pear.php.net/dtd/package-2.0.xsd">
         <file baseinstalldir="PHP/CodeSniffer" name="DisallowTabIndentUnitTest.1.inc.fixed" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="DisallowTabIndentUnitTest.2.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="DisallowTabIndentUnitTest.2.inc.fixed" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="DisallowTabIndentUnitTest.3.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="DisallowTabIndentUnitTest.3.inc.fixed" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="DisallowTabIndentUnitTest.js" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="DisallowTabIndentUnitTest.js.fixed" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="DisallowTabIndentUnitTest.php" role="test" />
@@ -2116,6 +2147,10 @@ http://pear.php.net/dtd/package-2.0.xsd">
    <install as="CodeSniffer/Core/Tokenizer/FinallyTest.inc" name="tests/Core/Tokenizer/FinallyTest.inc" />
    <install as="CodeSniffer/Core/Tokenizer/GotoLabelTest.php" name="tests/Core/Tokenizer/GotoLabelTest.php" />
    <install as="CodeSniffer/Core/Tokenizer/GotoLabelTest.inc" name="tests/Core/Tokenizer/GotoLabelTest.inc" />
+   <install as="CodeSniffer/Core/Tokenizer/HeredocNowdocCloserTest.php" name="tests/Core/Tokenizer/HeredocNowdocCloserTest.php" />
+   <install as="CodeSniffer/Core/Tokenizer/HeredocNowdocCloserTest.inc" name="tests/Core/Tokenizer/HeredocNowdocCloserTest.inc" />
+   <install as="CodeSniffer/Core/Tokenizer/HeredocStringTest.php" name="tests/Core/Tokenizer/HeredocStringTest.php" />
+   <install as="CodeSniffer/Core/Tokenizer/HeredocStringTest.inc" name="tests/Core/Tokenizer/HeredocStringTest.inc" />
    <install as="CodeSniffer/Core/Tokenizer/NamedFunctionCallArgumentsTest.php" name="tests/Core/Tokenizer/NamedFunctionCallArgumentsTest.php" />
    <install as="CodeSniffer/Core/Tokenizer/NamedFunctionCallArgumentsTest.inc" name="tests/Core/Tokenizer/NamedFunctionCallArgumentsTest.inc" />
    <install as="CodeSniffer/Core/Tokenizer/NullsafeObjectOperatorTest.php" name="tests/Core/Tokenizer/NullsafeObjectOperatorTest.php" />
@@ -2220,6 +2255,10 @@ http://pear.php.net/dtd/package-2.0.xsd">
    <install as="CodeSniffer/Core/Tokenizer/FinallyTest.inc" name="tests/Core/Tokenizer/FinallyTest.inc" />
    <install as="CodeSniffer/Core/Tokenizer/GotoLabelTest.php" name="tests/Core/Tokenizer/GotoLabelTest.php" />
    <install as="CodeSniffer/Core/Tokenizer/GotoLabelTest.inc" name="tests/Core/Tokenizer/GotoLabelTest.inc" />
+   <install as="CodeSniffer/Core/Tokenizer/HeredocNowdocCloserTest.php" name="tests/Core/Tokenizer/HeredocNowdocCloserTest.php" />
+   <install as="CodeSniffer/Core/Tokenizer/HeredocNowdocCloserTest.inc" name="tests/Core/Tokenizer/HeredocNowdocCloserTest.inc" />
+   <install as="CodeSniffer/Core/Tokenizer/HeredocStringTest.php" name="tests/Core/Tokenizer/HeredocStringTest.php" />
+   <install as="CodeSniffer/Core/Tokenizer/HeredocStringTest.inc" name="tests/Core/Tokenizer/HeredocStringTest.inc" />
    <install as="CodeSniffer/Core/Tokenizer/NamedFunctionCallArgumentsTest.php" name="tests/Core/Tokenizer/NamedFunctionCallArgumentsTest.php" />
    <install as="CodeSniffer/Core/Tokenizer/NamedFunctionCallArgumentsTest.inc" name="tests/Core/Tokenizer/NamedFunctionCallArgumentsTest.inc" />
    <install as="CodeSniffer/Core/Tokenizer/NullsafeObjectOperatorTest.php" name="tests/Core/Tokenizer/NullsafeObjectOperatorTest.php" />
@@ -2245,6 +2284,49 @@ http://pear.php.net/dtd/package-2.0.xsd">
   </filelist>
  </phprelease>
  <changelog>
+  <release>
+   <version>
+    <release>3.7.2</release>
+    <api>3.7.2</api>
+   </version>
+   <stability>
+    <release>stable</release>
+    <api>stable</api>
+   </stability>
+   <date>2023-02-23</date>
+   <license uri="https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt">BSD License</license>
+   <notes>
+    - Newer versions of Composer will now suggest installing PHPCS using require-dev instead of require
+      -- Thanks to Gary Jones (@GaryJones) for the patch
+    - A custom Out Of Memory error will now be shown if PHPCS or PHPCBF run out of memory during a run
+      -- Error message provides actionable information about how to fix the problem and ensures the error is not silent
+      -- Thanks to Juliette Reinders Folmer (@jrfnl) and Alain Schlesser (@schlessera) for the patch
+    - Generic.PHP.LowerCaseType sniff now correctly examines types inside arrow functions
+      -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+    - Squiz.Formatting.OperatorBracket no longer reports false positives in match() structures
+    - Fixed bug #3616 : Squiz.PHP.DisallowComparisonAssignment false positive for PHP 8 match expression
+      -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+    - Fixed bug #3618 : Generic.WhiteSpace.ArbitraryParenthesesSpacing false positive for return new parent()
+      -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+    - Fixed bug #3632 : Short list not tokenized correctly in control structures without braces
+      -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+    - Fixed bug #3639 : Tokenizer not applying tab replacement to heredoc/nowdoc closers
+      -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+    - Fixed bug #3640 : Generic.WhiteSpace.DisallowTabIndent not reporting errors for PHP 7.3 flexible heredoc/nowdoc syntax
+      -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+    - Fixed bug #3645 : PHPCS can show 0 exit code when running in parallel even if child process has fatal error
+      -- Thanks to Alex Panshin (@enl) for the patch
+    - Fixed bug #3653 : False positives for match() in OperatorSpacingSniff
+      -- Thanks to Jaroslav Hanslík (@kukulich) for the patch
+    - Fixed bug #3666 : PEAR.Functions.FunctionCallSignature incorrect indent fix when checking mixed HTML/PHP files
+    - Fixed bug #3668 : PSR12.Classes.ClassInstantiation.MissingParentheses false positive when instantiating parent classes
+      -- Similar issues also fixed in Generic.Functions.FunctionCallArgumentSpacing and Squiz.Formatting.OperatorBracket
+      -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+    - Fixed bug #3672 : Incorrect ScopeIndent.IncorrectExact report for match inside array literal
+    - Fixed bug #3694 : Generic.WhiteSpace.SpreadOperatorSpacingAfter does not ignore spread operator in PHP 8.1 first class   callables
+      -- Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+   </notes>
+  </release>
   <release>
    <version>
     <release>3.7.1</release>

src/Files/File.php

@@ -1798,7 +1798,7 @@ public function getMemberProperties($stackPtr)
                 || $this->tokens[$ptr]['code'] === T_ENUM)
             ) {
                 // T_VARIABLEs in interfaces/enums can actually be method arguments
-                // but they wont be seen as being inside the method because there
+                // but they won't be seen as being inside the method because there
                 // are no scope openers and closers for abstract methods. If it is in
                 // parentheses, we can be pretty sure it is a method argument.
                 if (isset($this->tokens[$stackPtr]['nested_parenthesis']) === false

src/Ruleset.php

@@ -249,7 +249,12 @@ public function explain()
         // one last time and clear the output buffer.
         $sniffs[] = '';
 
-        echo PHP_EOL."The $this->name standard contains $sniffCount sniffs".PHP_EOL;
+        $summaryLine = PHP_EOL."The $this->name standard contains 1 sniff".PHP_EOL;
+        if ($sniffCount !== 1) {
+            $summaryLine = str_replace('1 sniff', "$sniffCount sniffs", $summaryLine);
+        }
+
+        echo $summaryLine;
 
         ob_start();
 

src/Runner.php

@@ -53,6 +53,8 @@ class Runner
      */
     public function runPHPCS()
     {
+        $this->registerOutOfMemoryShutdownMessage('phpcs');
+
         try {
             Util\Timing::startTiming();
             Runner::checkRequirements();
@@ -153,6 +155,8 @@ public function runPHPCS()
      */
     public function runPHPCBF()
     {
+        $this->registerOutOfMemoryShutdownMessage('phpcbf');
+
         if (defined('PHP_CODESNIFFER_CBF') === false) {
             define('PHP_CODESNIFFER_CBF', true);
         }
@@ -721,6 +725,11 @@ private function processChildProcs($childProcs)
                 continue;
             }
 
+            $childProcessStatus = pcntl_wexitstatus($status);
+            if ($childProcessStatus !== 0) {
+                $success = false;
+            }
+
             $out = $childProcs[$pid];
             unset($childProcs[$pid]);
             if (file_exists($out) === false) {
@@ -886,4 +895,42 @@ public function printProgress(File $file, $numFiles, $numProcessed)
     }//end printProgress()
 
 
+    /**
+     * Registers a PHP shutdown function to provide a more informative out of memory error.
+     *
+     * @param string $command The command which was used to initiate the PHPCS run.
+     *
+     * @return void
+     */
+    private function registerOutOfMemoryShutdownMessage($command)
+    {
+        // Allocate all needed memory beforehand as much as possible.
+        $errorMsg    = PHP_EOL.'The PHP_CodeSniffer "%1$s" command ran out of memory.'.PHP_EOL;
+        $errorMsg   .= 'Either raise the "memory_limit" of PHP in the php.ini file or raise the memory limit at runtime'.PHP_EOL;
+        $errorMsg   .= 'using `%1$s -d memory_limit=512M` (replace 512M with the desired memory limit).'.PHP_EOL;
+        $errorMsg    = sprintf($errorMsg, $command);
+        $memoryError = 'Allowed memory size of';
+        $errorArray  = [
+            'type'    => 42,
+            'message' => 'Some random dummy string to take up memory and take up some more memory and some more',
+            'file'    => 'Another random string, which would be a filename this time. Should be relatively long to allow for deeply nested files',
+            'line'    => 31427,
+        ];
+
+        register_shutdown_function(
+            static function () use (
+                $errorMsg,
+                $memoryError,
+                $errorArray
+            ) {
+                $errorArray = error_get_last();
+                if (is_array($errorArray) === true && strpos($errorArray['message'], $memoryError) !== false) {
+                    echo $errorMsg;
+                }
+            }
+        );
+
+    }//end registerOutOfMemoryShutdownMessage()
+
+
 }//end class

src/Sniffs/AbstractArraySniff.php

@@ -104,9 +104,9 @@ public function process(File $phpcsFile, $stackPtr)
     /**
      * Find next separator in array - either: comma or double arrow.
      *
-     * @param File $phpcsFile The current file being checked.
-     * @param int  $ptr       The position of current token.
-     * @param int  $arrayEnd  The token that ends the array definition.
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being checked.
+     * @param int                         $ptr       The position of current token.
+     * @param int                         $arrayEnd  The token that ends the array definition.
      *
      * @return int
      */

src/Standards/Generic/Docs/Classes/OpeningBraceSameLineStandard.xml

@@ -15,6 +15,14 @@ class Foo <em>{</em>
         <![CDATA[
 class Foo
 <em>{</em>
+}
+        ]]>
+        </code>
+    </code_comparison>
+    <code_comparison>
+        <code title="Valid: Opening brace is the last thing on the line.">
+        <![CDATA[
+class Foo <em>{</em>
 }
         ]]>
         </code>

src/Standards/Generic/Docs/Formatting/SpaceAfterNotStandard.xml

@@ -10,13 +10,10 @@
 if (!<em> </em>$someVar || !<em> </em>$x instanceOf stdClass) {};
         ]]>
         </code>
-        <code title="Invalid: A NOT operator not followed by whitespace.">
+        <code title="Invalid: A NOT operator not followed by whitespace or followed by too much whitespace.">
         <![CDATA[
 if (!<em></em>$someVar || !<em></em>$x instanceOf stdClass) {};
-        ]]>
-        </code>
-        <code title="Invalid: A NOT operator followed by a new line or more than one space.">
-        <![CDATA[
+
 if (!<em>     </em>$someVar || !<em>
     </em>$x instanceOf stdClass) {};
         ]]>

src/Standards/Generic/Docs/WhiteSpace/ArbitraryParenthesesSpacingStandard.xml

@@ -10,13 +10,10 @@
 $a = (null !== $extra);
         ]]>
         </code>
-        <code title="Invalid: spaces on the inside of a set of arbitrary parentheses.">
+        <code title="Invalid: spaces or new lines on the inside of a set of arbitrary parentheses.">
         <![CDATA[
 $a = ( null !== $extra );
-        ]]>
-        </code>
-        <code title="Invalid: new lines on the inside of a set of arbitrary parentheses.">
-        <![CDATA[
+
 $a = (
     null !== $extra
 );