[Imported] AC-1902: Remove PHPCSUtils dependency from coding standard (magento#135)

* AC-1902: Remove PHPCSUtils dependency from coding standard

Author: m2-github-services

Magento2/Helpers/PHPCSUtils/BackCompat/BCTokens.php

@@ -0,0 +1,109 @@
+<?php
+/**
+ * PHPCSUtils, utility functions and classes for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSUtils
+ * @copyright 2019-2020 PHPCSUtils Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSUtils
+ */
+
+namespace Magento2\Helpers\PHPCSUtils\BackCompat;
+
+use PHP_CodeSniffer\Util\Tokens;
+
+class BCTokens
+{
+    /**
+     * Tokens that open class and object scopes.
+     *
+     * @since 1.0.0
+     * @since 1.0.0-alpha3 Visibility changed from `protected` to `private`.
+     *
+     * @var array <int|string> => <int|string>
+     */
+    private static $ooScopeTokens = [
+        \T_CLASS      => \T_CLASS,
+        \T_ANON_CLASS => \T_ANON_CLASS,
+        \T_INTERFACE  => \T_INTERFACE,
+        \T_TRAIT      => \T_TRAIT,
+    ];
+
+    /**
+     * Tokens that open class and object scopes.
+     *
+     * Retrieve the OO scope tokens array in a cross-version compatible manner.
+     *
+     * Changelog for the PHPCS native array:
+     * - Introduced in PHPCS 3.1.0.
+     *
+     * @see \PHP_CodeSniffer\Util\Tokens::$ooScopeTokens Original array.
+     *
+     * @since 1.0.0
+     *
+     * @return array <int|string> => <int|string> Token array.
+     */
+    public static function ooScopeTokens()
+    {
+        return self::$ooScopeTokens;
+    }
+
+    /**
+     * Tokens that represent arithmetic operators.
+     *
+     * Retrieve the PHPCS arithmetic tokens array in a cross-version compatible manner.
+     *
+     * Changelog for the PHPCS native array:
+     * - Introduced in PHPCS 0.5.0.
+     * - PHPCS 2.9.0: The PHP 5.6 `T_POW` token was added to the array.
+     *                The `T_POW` token was introduced in PHPCS 2.4.0.
+     *
+     * @see \PHP_CodeSniffer\Util\Tokens::$arithmeticTokens Original array.
+     *
+     * @since 1.0.0
+     *
+     * @return array <int|string> => <int|string> Token array or an empty array for PHPCS versions in
+     *                         which the PHPCS native comment tokens did not exist yet.
+     */
+    public static function arithmeticTokens()
+    {
+        return Tokens::$arithmeticTokens + [\T_POW => \T_POW];
+    }
+
+    /**
+     * Tokens that represent assignment operators.
+     *
+     * Retrieve the PHPCS assignment tokens array in a cross-version compatible manner.
+     *
+     * Changelog for the PHPCS native array:
+     * - Introduced in PHPCS 0.0.5.
+     * - PHPCS 2.9.0: The PHP 7.4 `T_COALESCE_EQUAL` token was added to the array.
+     *                The `T_COALESCE_EQUAL` token was introduced in PHPCS 2.8.1.
+     * - PHPCS 3.2.0: The JS `T_ZSR_EQUAL` token was added to the array.
+     *                The `T_ZSR_EQUAL` token was introduced in PHPCS 2.8.0.
+     *
+     * @see \PHP_CodeSniffer\Util\Tokens::$assignmentTokens Original array.
+     *
+     * @since 1.0.0
+     *
+     * @return array <int|string> => <int|string> Token array.
+     */
+    public static function assignmentTokens()
+    {
+        $tokens = Tokens::$assignmentTokens;
+
+        /*
+         * The `T_COALESCE_EQUAL` token may be available pre-PHPCS 2.8.1 depending on
+         * the PHP version used to run PHPCS.
+         */
+        if (\defined('T_COALESCE_EQUAL')) {
+            $tokens[\T_COALESCE_EQUAL] = \T_COALESCE_EQUAL;
+        }
+
+        if (\defined('T_ZSR_EQUAL')) {
+            $tokens[\T_ZSR_EQUAL] = \T_ZSR_EQUAL;
+        }
+
+        return $tokens;
+    }
+}

Magento2/Helpers/PHPCSUtils/BackCompat/Helper.php

@@ -0,0 +1,242 @@
+<?php
+/**
+ * PHPCSUtils, utility functions and classes for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSUtils
+ * @copyright 2019-2020 PHPCSUtils Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSUtils
+ */
+
+namespace Magento2\Helpers\PHPCSUtils\BackCompat;
+
+use PHP_CodeSniffer\Exceptions\RuntimeException;
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Utility methods to retrieve (configuration) information from PHP_CodeSniffer.
+ *
+ * PHP_CodeSniffer cross-version compatibility helper for PHPCS 2.x vs PHPCS 3.x.
+ *
+ * A number of PHPCS classes were split up into several classes in PHPCS 3.x
+ * Those classes cannot be aliased as they don't represent the same object.
+ * This class provides helper methods for functions which were contained in
+ * one of these classes and which are commonly used by external standards.
+ *
+ * @since 1.0.0 The initial methods in this class have been ported over from
+ *              the external PHPCompatibility & WPCS standards.
+ */
+class Helper
+{
+
+    /**
+     * The default tab width used by PHP_CodeSniffer.
+     *
+     * @since 1.0.0
+     *
+     * @var int
+     */
+    const DEFAULT_TABWIDTH = 4;
+
+    /**
+     * Get the PHP_CodeSniffer version number.
+     *
+     * @since 1.0.0
+     *
+     * @return string
+     */
+    public static function getVersion()
+    {
+        if (\defined('\PHP_CodeSniffer\Config::VERSION') === false) {
+            // PHPCS 2.x.
+            return \PHP_CodeSniffer::VERSION;
+        }
+
+        // PHPCS 3.x.
+        return \PHP_CodeSniffer\Config::VERSION;
+    }
+
+    /**
+     * Pass config data to PHP_CodeSniffer.
+     *
+     * @since 1.0.0
+     *
+     * @param string                  $key    The name of the config value.
+     * @param string|null             $value  The value to set. If `null`, the config entry
+     *                                        is deleted, reverting it to the default value.
+     * @param bool                    $temp   Set this config data temporarily for this script run.
+     *                                        This will not write the config data to the config file.
+     * @param \PHP_CodeSniffer\Config $config The PHPCS config object.
+     *                                        This parameter is required for PHPCS 4.x, optional
+     *                                        for PHPCS 3.x and not possible to pass for PHPCS 2.x.
+     *                                        Passing the `$phpcsFile->config` property should work
+     *                                        in PHPCS 3.x and higher.
+     *
+     * @return bool Whether the setting of the data was successfull.
+     */
+    public static function setConfigData($key, $value, $temp = false, $config = null)
+    {
+        if (\method_exists('\PHP_CodeSniffer\Config', 'setConfigData') === false) {
+            // PHPCS 2.x.
+            return \PHP_CodeSniffer::setConfigData($key, $value, $temp);
+        }
+
+        if (isset($config) === true) {
+            // PHPCS 3.x and 4.x.
+            return $config->setConfigData($key, $value, $temp);
+        }
+
+        if (\version_compare(self::getVersion(), '3.99.99', '>') === true) {
+            throw new RuntimeException('Passing the $config parameter is required in PHPCS 4.x');
+        }
+
+        // PHPCS 3.x.
+        return \PHP_CodeSniffer\Config::setConfigData($key, $value, $temp);
+    }
+
+    /**
+     * Get the value of a single PHP_CodeSniffer config key.
+     *
+     * @see Helper::getCommandLineData() Alternative for the same which is more reliable
+     *                                   if the `$phpcsFile` object is available.
+     *
+     * @since 1.0.0
+     *
+     * @param string $key The name of the config value.
+     *
+     * @return string|null
+     */
+    public static function getConfigData($key)
+    {
+        if (\method_exists('\PHP_CodeSniffer\Config', 'getConfigData') === false) {
+            // PHPCS 2.x.
+            return \PHP_CodeSniffer::getConfigData($key);
+        }
+
+        // PHPCS 3.x.
+        return \PHP_CodeSniffer\Config::getConfigData($key);
+    }
+
+    /**
+     * Get the value of a CLI overrulable single PHP_CodeSniffer config key.
+     *
+     * Use this for config keys which can be set in the `CodeSniffer.conf` file,
+     * on the command-line or in a ruleset.
+     *
+     * @since 1.0.0
+     *
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being processed.
+     * @param string                      $key       The name of the config value.
+     *
+     * @return string|null
+     */
+    public static function getCommandLineData(File $phpcsFile, $key)
+    {
+        if (\class_exists('\PHP_CodeSniffer\Config') === false) {
+            // PHPCS 2.x.
+            $config = $phpcsFile->phpcs->cli->getCommandLineValues();
+            if (isset($config[$key])) {
+                return $config[$key];
+            }
+        } else {
+            // PHPCS 3.x.
+            $config = $phpcsFile->config;
+            if (isset($config->{$key})) {
+                return $config->{$key};
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Get the applicable tab width as passed to PHP_CodeSniffer from the
+     * command-line or the ruleset.
+     *
+     * @since 1.0.0
+     *
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being processed.
+     *
+     * @return int Tab width. Defaults to the PHPCS native default of 4.
+     */
+    public static function getTabWidth(File $phpcsFile)
+    {
+        $tabWidth = self::getCommandLineData($phpcsFile, 'tabWidth');
+        if ($tabWidth > 0) {
+            return (int) $tabWidth;
+        }
+
+        return self::DEFAULT_TABWIDTH;
+    }
+
+    /**
+     * Get the applicable (file) encoding as passed to PHP_CodeSniffer from the
+     * command-line or the ruleset.
+     *
+     * @since 1.0.0-alpha3
+     *
+     * @param \PHP_CodeSniffer\Files\File|null $phpcsFile Optional. The current file being processed.
+     *
+     * @return string Encoding. Defaults to the PHPCS native default, which is 'utf-8'
+     *                for PHPCS 3.x and was 'iso-8859-1' for PHPCS 2.x.
+     */
+    public static function getEncoding(File $phpcsFile = null)
+    {
+        static $default;
+
+        if (isset($default) === false) {
+            $default = 'utf-8';
+            if (\version_compare(self::getVersion(), '2.99.99', '<=') === true) {
+                // In PHPCS 2.x, the default encoding is `iso-8859-1`.
+                $default = 'iso-8859-1';
+            }
+        }
+
+        if ($phpcsFile instanceof File) {
+            // Most reliable.
+            $encoding = self::getCommandLineData($phpcsFile, 'encoding');
+            if ($encoding === null) {
+                $encoding = $default;
+            }
+
+            return $encoding;
+        }
+
+        // Less reliable.
+        $encoding = self::getConfigData('encoding');
+        if ($encoding === null) {
+            $encoding = $default;
+        }
+
+        return $encoding;
+    }
+
+    /**
+     * Check whether the "--ignore-annotations" option is in effect.
+     *
+     * @since 1.0.0
+     *
+     * @param \PHP_CodeSniffer\Files\File|null $phpcsFile Optional. The current file being processed.
+     *
+     * @return bool `TRUE` if annotations should be ignored, `FALSE` otherwise.
+     */
+    public static function ignoreAnnotations(File $phpcsFile = null)
+    {
+        if (\class_exists('\PHP_CodeSniffer\Config') === false) {
+            // PHPCS 2.x does not support `--ignore-annotations`.
+            return false;
+        }
+
+        // PHPCS 3.x.
+        if (isset($phpcsFile, $phpcsFile->config->annotations)) {
+            return ! $phpcsFile->config->annotations;
+        }
+
+        $annotations = \PHP_CodeSniffer\Config::getConfigData('annotations');
+        if (isset($annotations)) {
+            return ! $annotations;
+        }
+
+        return false;
+    }
+}