Squiz.WhiteSpace.OperatorSpacing / PSR12.Operators.OperatorSpacing - skip over declare() statements entirely

These sniffs intentionally do not handle declare statements, as these are
handled by other sniffs. The logic previously used was not complete enough to
bow out in all circumstances. These changes skip over the whole declare
statement by registering for its token, and skipping over the statement when
found. This ensures that nothing inside it is detected and processed by
mistake.

Author: fredden

src/Standards/PSR12/Sniffs/Operators/OperatorSpacingSniff.php

@@ -35,6 +35,9 @@ public function register()
         $targets[] = T_STRING_CONCAT;
         $targets[] = T_INSTANCEOF;
 
+        // Also register the contexts we want to specifically skip over.
+        $targets[] = T_DECLARE;
+
         return $targets;
 
     }//end register()
@@ -47,12 +50,25 @@ public function register()
      * @param int                         $stackPtr  The position of the current token in
      *                                               the stack passed in $tokens.
      *
-     * @return void
+     * @return void|int Optionally returns a stack pointer. The sniff will not be
+     *                  called again on the current file until the returned stack
+     *                  pointer is reached. Return `$phpcsFile->numTokens` to skip
+     *                  the rest of the file.
      */
     public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
+        // Skip over declare statements as those should be handled by different sniffs.
+        if ($tokens[$stackPtr]['code'] === T_DECLARE) {
+            if (isset($tokens[$stackPtr]['parenthesis_closer']) === false) {
+                // Parse error / live coding.
+                return $phpcsFile->numTokens;
+            }
+
+            return $tokens[$stackPtr]['parenthesis_closer'];
+        }
+
         if ($this->isOperator($phpcsFile, $stackPtr) === false) {
             return;
         }

src/Standards/PSR12/Tests/Operators/OperatorSpacingUnitTest.1.inc

@@ -75,3 +75,5 @@ function setDefault(#[ImportValue(
     {
         // Do something
     }
+
+declare(strict_types=1);

src/Standards/PSR12/Tests/Operators/OperatorSpacingUnitTest.1.inc.fixed

@@ -75,3 +75,5 @@ function setDefault(#[ImportValue(
     {
         // Do something
     }
+
+declare(strict_types=1);

src/Standards/PSR12/Tests/Operators/OperatorSpacingUnitTest.2.inc

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

src/Standards/Squiz/Sniffs/WhiteSpace/OperatorSpacingSniff.php

@@ -114,6 +114,9 @@ public function register()
         $targets[] = T_INLINE_ELSE;
         $targets[] = T_INSTANCEOF;
 
+        // Also register the contexts we want to specifically skip over.
+        $targets[] = T_DECLARE;
+
         return $targets;
 
     }//end register()
@@ -126,12 +129,25 @@ public function register()
      * @param int                         $stackPtr  The position of the current token in
      *                                               the stack passed in $tokens.
      *
-     * @return void
+     * @return void|int Optionally returns a stack pointer. The sniff will not be
+     *                  called again on the current file until the returned stack
+     *                  pointer is reached. Return `$phpcsFile->numTokens` to skip
+     *                  the rest of the file.
      */
     public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
+        // Skip over declare statements as those should be handled by different sniffs.
+        if ($tokens[$stackPtr]['code'] === T_DECLARE) {
+            if (isset($tokens[$stackPtr]['parenthesis_closer']) === false) {
+                // Parse error / live coding.
+                return $phpcsFile->numTokens;
+            }
+
+            return $tokens[$stackPtr]['parenthesis_closer'];
+        }
+
         if ($this->isOperator($phpcsFile, $stackPtr) === false) {
             return;
         }
@@ -327,11 +343,13 @@ protected function isOperator(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
+        if ($tokens[$stackPtr]['code'] === T_DECLARE) {
+            return false;
+        }
+
         // Skip default values in function declarations.
         // Skip declare statements.
-        if ($tokens[$stackPtr]['code'] === T_EQUAL
-            || $tokens[$stackPtr]['code'] === T_MINUS
-        ) {
+        if ($tokens[$stackPtr]['code'] === T_EQUAL) {
             if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
                 $parenthesis = array_keys($tokens[$stackPtr]['nested_parenthesis']);
                 $bracket     = array_pop($parenthesis);
@@ -340,7 +358,6 @@ protected function isOperator(File $phpcsFile, $stackPtr)
                     if ($tokens[$function]['code'] === T_FUNCTION
                         || $tokens[$function]['code'] === T_CLOSURE
                         || $tokens[$function]['code'] === T_FN
-                        || $tokens[$function]['code'] === T_DECLARE
                     ) {
                         return false;
                     }

src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.2.inc

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