Merge pull request #51 from PHPCSStandards/feature/generic-requirestricttypes-various-bugfixes

Generic/RequireStrictTypes: various bugfixes

Author: jrfnl

CHANGELOG.md

@@ -77,6 +77,9 @@ The file documents changes to the PHP_CodeSniffer project.
     - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
 - Generic.Functions.OpeningFunctionBraceKernighanRitchie will now check the spacing before the opening brace for empty functions
     - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+- Generic.PHP.RequireStrictTypes has a new warning for when there is a declare statement, but the strict_types directive is set to 0
+    - The warning can be turned off by excluding the Generic.PHP.RequireStrictTypes.Disabled error code
+    - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
 - PSR2.Classes.PropertyDeclaration now enforces that the readonly modifier comes after the visibility modifier
     - PSR2 and PSR12 do not have documented rules for this as they pre-date the readonly modifier
     - PSR-PER has been used to confirm the order of this keyword so it can be applied to PSR2 and PSR12 correctly
@@ -109,6 +112,10 @@ The file documents changes to the PHP_CodeSniffer project.
     - Thanks to Volker Dusch (@edorian) for the patch
 - Fixed bug #3717 : Squiz.Commenting.FunctionComment: fixed false positive for InvalidNoReturn when type is never
     - Thanks to Choraimy Kroonstuiver (@axlon) for the patch
+- Fixed bug #3720 : Generic/RequireStrictTypes : will now bow out silently in case of parse errors/live coding instead of throwing false positives/false negatives
+    - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+- Fixed bug #3720 : Generic/RequireStrictTypes : did not handle multi-directive declare statements
+    - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
 - Fixed bug #3722 : Potential "Uninitialized string offset 1" in octal notation backfill
     - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
 - Fixed bug #3728 : PHP 8.2 | PSR1/SideEffects: allow for readonly classes

src/Standards/Generic/Sniffs/PHP/RequireStrictTypesSniff.php

@@ -11,6 +11,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Tokens;
 
 class RequireStrictTypesSniff implements Sniff
 {
@@ -40,23 +41,61 @@ public function register()
     public function process(File $phpcsFile, $stackPtr)
     {
         $tokens  = $phpcsFile->getTokens();
-        $declare = $phpcsFile->findNext(T_DECLARE, $stackPtr);
-        $found   = false;
+        $declare = $phpcsFile->findNext(T_DECLARE, ($stackPtr + 1));
+
+        $found = false;
 
         if ($declare !== false) {
-            $nextString = $phpcsFile->findNext(T_STRING, $declare);
+            if (isset($tokens[$declare]['parenthesis_opener'], $tokens[$declare]['parenthesis_closer']) === false) {
+                // Live coding, ignore for now.
+                return $phpcsFile->numTokens;
+            }
+
+            $next = $tokens[$declare]['parenthesis_opener'];
+
+            do {
+                $next = $phpcsFile->findNext(
+                    Tokens::$emptyTokens,
+                    ($next + 1),
+                    $tokens[$declare]['parenthesis_closer'],
+                    true
+                );
 
-            if ($nextString !== false) {
-                if (strtolower($tokens[$nextString]['content']) === 'strict_types') {
+                if ($next !== false
+                    && $tokens[$next]['code'] === T_STRING
+                    && strtolower($tokens[$next]['content']) === 'strict_types'
+                ) {
                     // There is a strict types declaration.
                     $found = true;
+                    break;
                 }
-            }
-        }
+
+                $next = $phpcsFile->findNext(T_COMMA, ($next + 1), $tokens[$declare]['parenthesis_closer']);
+            } while ($next !== false && $next < $tokens[$declare]['parenthesis_closer']);
+        }//end if
 
         if ($found === false) {
             $error = 'Missing required strict_types declaration';
             $phpcsFile->addError($error, $stackPtr, 'MissingDeclaration');
+
+            return $phpcsFile->numTokens;
+        }
+
+        // Strict types declaration found, make sure strict types is enabled.
+        $skip     = Tokens::$emptyTokens;
+        $skip[]   = T_EQUAL;
+        $valuePtr = $phpcsFile->findNext($skip, ($next + 1), null, true);
+
+        if ($valuePtr !== false
+            && $tokens[$valuePtr]['code'] === T_LNUMBER
+            && $tokens[$valuePtr]['content'] === '0'
+        ) {
+            $error = 'Required strict_types declaration found, but strict types is disabled. Set the value to 1 to enable';
+            $fix   = $phpcsFile->addFixableWarning($error, $valuePtr, 'Disabled');
+
+            if ($fix === true) {
+                $phpcsFile->fixer->replaceToken($valuePtr, '1');
+            }
         }
 
         // Skip the rest of the file so we don't pick up additional

src/Standards/Generic/Tests/PHP/RequireStrictTypesUnitTest.10.inc

@@ -0,0 +1,5 @@
+<?php
+
+declare(encoding='utf-8', ticks=1);
+
+// some code

src/Standards/Generic/Tests/PHP/RequireStrictTypesUnitTest.11.inc

@@ -0,0 +1,5 @@
+<?php
+
+declare(strict_types=0);
+
+// some code

src/Standards/Generic/Tests/PHP/RequireStrictTypesUnitTest.11.inc.fixed

@@ -0,0 +1,5 @@
+<?php
+
+declare(strict_types=1);
+
+// some code

src/Standards/Generic/Tests/PHP/RequireStrictTypesUnitTest.12.inc

@@ -0,0 +1,5 @@
+<?php
+
+declare(  strict_types  =   /*comment*/   0   );
+
+// some code

src/Standards/Generic/Tests/PHP/RequireStrictTypesUnitTest.12.inc.fixed

@@ -0,0 +1,5 @@
+<?php
+
+declare(  strict_types  =   /*comment*/   1   );
+
+// some code

src/Standards/Generic/Tests/PHP/RequireStrictTypesUnitTest.13.inc

@@ -0,0 +1,3 @@
+<?php
+// Safeguard sniff handles parse error/live coding correctly.
+declare(strict_types=

src/Standards/Generic/Tests/PHP/RequireStrictTypesUnitTest.14.inc

@@ -0,0 +1,5 @@
+<?php
+
+declare( strict_types = 0, encoding='utf-8' );
+
+// some code

src/Standards/Generic/Tests/PHP/RequireStrictTypesUnitTest.14.inc.fixed

@@ -0,0 +1,5 @@
+<?php
+
+declare( strict_types = 1, encoding='utf-8' );
+
+// some code