ACP2E-1946: Move PHPCompatibility/PHPCompatibility sniffs into separate namespace

Author: bubasuma

Magento2/Helpers/Assert.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento2\Helpers;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Util\Tokens;
+use PHPCSUtils\Tokens\Collections;
+
+/**
+ * phpcs:disable Magento2.Functions.StaticFunction.StaticFunction
+ */
+class Assert
+{
+    /**
+     * Checks whether the function call is a built-in function call.
+     *
+     * @param File $phpcsFile
+     * @param int $stackPtr
+     * @return bool
+     */
+    public static function isBuiltinFunctionCall(File $phpcsFile, int $stackPtr): bool
+    {
+        $tokens = $phpcsFile->getTokens();
+        $nextPtr = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
+        if ($nextPtr === false
+            || $tokens[$nextPtr]['code'] !== \T_OPEN_PARENTHESIS
+            || isset($tokens[$nextPtr]['parenthesis_owner'])
+        ) {
+            return false;
+        }
+
+        $prevPtr = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true);
+        $ignorePrevToken = [\T_NEW => true] + Collections::objectOperators();
+        if (isset($ignorePrevToken[$tokens[$prevPtr]['code']])) {
+            return false;
+        }
+
+        if ($tokens[$prevPtr]['code'] === \T_NS_SEPARATOR) {
+            $prevPrevToken = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($prevPtr - 1), null, true);
+            if ($tokens[$prevPrevToken]['code'] === \T_STRING || $tokens[$prevPrevToken]['code'] === \T_NAMESPACE
+            ) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}

Magento2/Sniffs/PHPCompatibility/DeprecatedEncodingsForMBStringFunctionsSniff.php

@@ -6,6 +6,7 @@
 
 namespace Magento2\Sniffs\PHPCompatibility;
 
+use Magento2\Helpers\Assert;
 use PHP_CodeSniffer\Files\File;
 use PHPCompatibility\Sniff;
 use PHP_CodeSniffer_Tokens as Tokens;
@@ -19,40 +20,12 @@
  */
 class DeprecatedEncodingsForMBStringFunctionsSniff extends Sniff
 {
-    /**
-     * List of tokens which when they precede the $stackPtr indicate that this
-     * is not a function call.
-     *
-     * @var array
-     */
-    private $ignoreTokens = [
-        \T_DOUBLE_COLON => true,
-        \T_OBJECT_OPERATOR => true,
-        \T_FUNCTION => true,
-        \T_NEW => true,
-        \T_CONST => true,
-        \T_USE => true,
-    ];
-
-    /**
-     * Text string tokens to examine.
-     *
-     * @var array
-     */
-    private $textStringTokens = [
-        \T_CONSTANT_ENCAPSED_STRING => true,
-        \T_DOUBLE_QUOTED_STRING => true,
-        \T_INLINE_HTML => true,
-        \T_HEREDOC => true,
-        \T_NOWDOC => true,
-    ];
-
     /**
      * A list of MBString functions that emits deprecation notice
      *
      * @var \int[][]
      */
-    protected $targetFunctions = [
+    private $targetFunctions = [
         'mb_check_encoding' => [2],
         'mb_chr' => [2],
         'mb_convert_case' => [3],
@@ -124,21 +97,7 @@ public function process(File $phpcsFile, $stackPtr)
         $function = $tokens[$stackPtr]['content'];
         $functionLc = strtolower($function);
 
-        if (strpos($functionLc, 'mb_') !== 0) {
-            return;
-        }
-
-        $prevNonEmpty = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true);
-
-        if (isset($this->ignoreTokens[$tokens[$prevNonEmpty]['code']]) === true) {
-            // Not a call to a PHP function.
-            return;
-        }
-
-        if ($tokens[$prevNonEmpty]['code'] === \T_NS_SEPARATOR
-            && $tokens[$prevNonEmpty - 1]['code'] === \T_STRING
-        ) {
-            // Namespaced function.
+        if (!isset($this->targetFunctions[$functionLc]) || !Assert::isBuiltinFunctionCall($phpcsFile, $stackPtr)) {
             return;
         }
 
@@ -161,7 +120,7 @@ public function process(File $phpcsFile, $stackPtr)
     public function processParameter(File $phpcsFile, string $function, int $index, array $parameter)
     {
         $functionLc = strtolower($function);
-        if (!isset($this->targetFunctions[$functionLc]) || !in_array($index, $this->targetFunctions[$functionLc])) {
+        if (!in_array($index, $this->targetFunctions[$functionLc])) {
             return;
         }
 
@@ -175,6 +134,14 @@ public function processParameter(File $phpcsFile, string $function, int $index,
             $items = [$parameter];
         }
 
+        $textStringTokens = [
+            \T_CONSTANT_ENCAPSED_STRING => true,
+            \T_DOUBLE_QUOTED_STRING => true,
+            \T_INLINE_HTML => true,
+            \T_HEREDOC => true,
+            \T_NOWDOC => true,
+        ];
+
         foreach ($items as $item) {
             for ($i = $item['start']; $i <= $item['end']; $i++) {
                 if ($tokens[$i]['code'] === \T_STRING
@@ -184,7 +151,7 @@ public function processParameter(File $phpcsFile, string $function, int $index,
                     break;
                 }
 
-                if (isset($this->textStringTokens[$tokens[$i]['code']]) === true) {
+                if (isset($textStringTokens[$tokens[$i]['code']]) === true) {
                     $encoding = $this->stripQuotes(strtolower(trim($tokens[$i]['content'])));
                     $encodings = array_flip(explode(',', $encoding));
                     if (count(array_intersect_key($encodings, $this->messages)) > 0) {