sdc-build-wp 4.1.0 → 4.1.2

package/vendor/phpcsstandards/phpcsutils/PHPCSUtils/Internal/IsShortArrayOrListWithCache.php

@@ -1,269 +0,0 @@
-<?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 PHPCSUtils\Internal;
-
-use PHP_CodeSniffer\Files\File;
-use PHPCSUtils\Internal\Cache;
-use PHPCSUtils\Internal\IsShortArrayOrList;
-use PHPCSUtils\Internal\StableCollections;
-
-/**
- * Determination of short array vs short list vs square brackets.
- *
- * Uses caching of previous results to mitigate performance issues.
- *
- * ---------------------------------------------------------------------------------------------
- * This class is only intended for internal use by PHPCSUtils and is not part of the public API.
- * This also means that it has no promise of backward compatibility.
- *
- * End-users should use the {@see \PHPCSUtils\Utils\Arrays::isShortArray()}
- * or the {@see \PHPCSUtils\Utils\Lists::isShortList()} method instead.
- * ---------------------------------------------------------------------------------------------
- *
- * @internal
- *
- * @since 1.0.0
- */
-final class IsShortArrayOrListWithCache
-{
-
-    /**
-     * Key used for caching the return value of the short array/short list determination.
-     *
-     * @since 1.0.0
-     *
-     * @var string
-     */
-    const CACHE_KEY = __CLASS__;
-
-    /**
-     * The PHPCS file in which the current stackPtr was found.
-     *
-     * @since 1.0.0
-     *
-     * @var \PHP_CodeSniffer\Files\File
-     */
-    private $phpcsFile;
-
-    /**
-     * The token stack from the current file.
-     *
-     * @since 1.0.0
-     *
-     * @var array<int, array<string, mixed>>
-     */
-    private $tokens;
-
-    /**
-     * The current stack pointer.
-     *
-     * @since 1.0.0
-     *
-     * @var int
-     */
-    private $stackPtr;
-
-    /**
-     * Stack pointer to the open bracket.
-     *
-     * @since 1.0.0
-     *
-     * @var int
-     */
-    private $opener;
-
-    /**
-     * Determine whether a T_OPEN/CLOSE_SHORT_ARRAY token is a short array construct
-     * and not a short list.
-     *
-     * This method also accepts `T_OPEN/CLOSE_SQUARE_BRACKET` tokens to allow it to be
-     * PHPCS cross-version compatible as the short array tokenizing has been plagued by
-     * a number of bugs over time.
-     *
-     * @since 1.0.0
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-     * @param int                         $stackPtr  The position of the short array bracket token.
-     *
-     * @return bool `TRUE` if the token passed is the open/close bracket of a short array.
-     *              `FALSE` if the token is a short list bracket, a plain square bracket
-     *              or not one of the accepted tokens.
-     */
-    public static function isShortArray(File $phpcsFile, $stackPtr)
-    {
-        return (self::getType($phpcsFile, $stackPtr) === IsShortArrayOrList::SHORT_ARRAY);
-    }
-
-    /**
-     * Determine whether a T_OPEN/CLOSE_SHORT_ARRAY token is a short list construct
-     * in contrast to a short array.
-     *
-     * This method also accepts `T_OPEN/CLOSE_SQUARE_BRACKET` tokens to allow it to be
-     * PHPCS cross-version compatible as the short array tokenizing has been plagued by
-     * a number of bugs over time, which affects the short list determination.
-     *
-     * @since 1.0.0
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-     * @param int                         $stackPtr  The position of the short array bracket token.
-     *
-     * @return bool `TRUE` if the token passed is the open/close bracket of a short list.
-     *              `FALSE` if the token is a short array bracket or plain square bracket
-     *              or not one of the accepted tokens.
-     */
-    public static function isShortList(File $phpcsFile, $stackPtr)
-    {
-        return (self::getType($phpcsFile, $stackPtr) === IsShortArrayOrList::SHORT_LIST);
-    }
-
-    /**
-     * Determine whether a T_OPEN/CLOSE_SHORT_ARRAY token is a short array or short list construct.
-     *
-     * This method also accepts `T_OPEN/CLOSE_SQUARE_BRACKET` tokens to allow it to be
-     * PHPCS cross-version compatible as the short array tokenizing has been plagued by
-     * a number of bugs over time, which affects the short list determination.
-     *
-     * @since 1.0.0
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-     * @param int                         $stackPtr  The position of the short array bracket token.
-     *
-     * @return string|false The type of construct this bracket was determined to be.
-     *                      Either 'short array', 'short list' or 'square brackets'.
-     *                      Or FALSE if this was not a bracket token.
-     */
-    public static function getType(File $phpcsFile, $stackPtr)
-    {
-        return (new self($phpcsFile, $stackPtr))->process();
-    }
-
-    /**
-     * Constructor.
-     *
-     * @since 1.0.0
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-     * @param int                         $stackPtr  The position of the short array bracket token.
-     *
-     * @return void
-     */
-    private function __construct(File $phpcsFile, $stackPtr)
-    {
-        $this->phpcsFile = $phpcsFile;
-        $this->tokens    = $phpcsFile->getTokens();
-        $this->stackPtr  = $stackPtr;
-    }
-
-    /**
-     * Determine whether a T_[OPEN|CLOSE}_[SHORT_ARRAY|SQUARE_BRACKET] token is a short array
-     * or short list construct using previously cached results whenever possible.
-     *
-     * @since 1.0.0
-     *
-     * @return string|false The type of construct this bracket was determined to be.
-     *                      Either 'short array', 'short list' or 'square brackets'.
-     *                      Or FALSE is this was not a bracket token.
-     */
-    private function process()
-    {
-        if ($this->isValidStackPtr() === false) {
-            return false;
-        }
-
-        $this->opener = $this->getOpener();
-
-        /*
-         * Check the cache in case we've seen this token before.
-         */
-        $type = $this->getFromCache();
-        if ($type !== false) {
-            return $type;
-        }
-
-        /*
-         * If we've not seen the token before, try and solve it and cache the results.
-         *
-         * Make sure to safeguard against unopened/unclosed square brackets (parse error),
-         * which should always be regarded as real square brackets.
-         */
-        $type = IsShortArrayOrList::SQUARE_BRACKETS;
-        if (isset($this->tokens[$this->stackPtr]['bracket_opener'], $this->tokens[$this->stackPtr]['bracket_closer'])) {
-            $solver = new IsShortArrayOrList($this->phpcsFile, $this->opener);
-            $type   = $solver->solve();
-        }
-
-        $this->updateCache($type);
-
-        return $type;
-    }
-
-    /**
-     * Verify the passed token could potentially be a short array or short list token.
-     *
-     * @since 1.0.0
-     *
-     * @return bool
-     */
-    private function isValidStackPtr()
-    {
-        return (isset($this->tokens[$this->stackPtr]) === true
-            && isset(StableCollections::$shortArrayListTokensBC[$this->tokens[$this->stackPtr]['code']]) === true);
-    }
-
-    /**
-     * Get the stack pointer to the short array/list opener.
-     *
-     * @since 1.0.0
-     *
-     * @return int
-     */
-    private function getOpener()
-    {
-        $opener = $this->stackPtr;
-        if (isset($this->tokens[$this->stackPtr]['bracket_opener'])) {
-            $opener = $this->tokens[$this->stackPtr]['bracket_opener'];
-        }
-
-        return $opener;
-    }
-
-    /**
-     * Retrieve the bracket "type" of a token from the cache.
-     *
-     * @since 1.0.0
-     *
-     * @return string|false The previously determined type (which could be an empty string)
-     *                      or FALSE if no cache entry was found for this token.
-     */
-    private function getFromCache()
-    {
-        if (Cache::isCached($this->phpcsFile, self::CACHE_KEY, $this->opener) === true) {
-            return Cache::get($this->phpcsFile, self::CACHE_KEY, $this->opener);
-        }
-
-        return false;
-    }
-
-    /**
-     * Update the cache with information about a particular bracket token.
-     *
-     * @since 1.0.0
-     *
-     * @param string $type The type this bracket has been determined to be.
-     *                     Either 'short array', 'short list' or 'square brackets'.
-     *
-     * @return void
-     */
-    private function updateCache($type)
-    {
-        Cache::set($this->phpcsFile, self::CACHE_KEY, $this->opener, $type);
-    }
-}

package/vendor/phpcsstandards/phpcsutils/PHPCSUtils/Internal/NoFileCache.php

@@ -1,164 +0,0 @@
-<?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 PHPCSUtils\Internal;
-
-/**
- * Cache for function results which are not directly related to a $phpcsFile.
- *
- * Allows to cache the return value of utility functions which don't use PHPCS File objects.
- *
- * Caching the results can significantly speed things up, though it can also eat memory,
- * so use with care.
- *
- * Typical usage:
- * ```php
- * function doSomething()
- * {
- *    if (NoFileCache::isCached(__METHOD__, $paramHash) === true) {
- *        return NoFileCache::get(__METHOD__, $paramHash);
- *    }
- *
- *    // Do something.
- *
- *    NoFileCache::set(__METHOD__, $paramHash, $returnValue);
- *    return $returnValue;
- * }
- * ```
- *
- * ---------------------------------------------------------------------------------------------
- * This class is only intended for internal use by PHPCSUtils and is not part of the public API.
- * This also means that it has no promise of backward compatibility.
- * ---------------------------------------------------------------------------------------------
- *
- * @internal
- *
- * @since 1.0.0
- */
-final class NoFileCache
-{
-
-    /**
-     * Whether caching is enabled or not.
-     *
-     * Note: this switch is ONLY intended for use within test suites and should never
-     * be touched in any other circumstances!
-     *
-     * Don't forget to always turn the cache back on in a `tear_down()` method!
-     *
-     * @since 1.0.0
-     *
-     * @var bool
-     */
-    public static $enabled = true;
-
-    /**
-     * Results cache.
-     *
-     * @since 1.0.0
-     *
-     * @var array<string, array<int|string, mixed>> Format: $cache[$key][$id] = mixed $value;
-     */
-    private static $cache = [];
-
-    /**
-     * Check whether a result has been cached for a certain utility function.
-     *
-     * @since 1.0.0
-     *
-     * @param string     $key The key to identify a particular set of results.
-     *                        It is recommended to pass `__METHOD__` to this parameter.
-     * @param int|string $id  Unique identifier for these results.
-     *                        It is recommended for this to be a serialization of arguments passed
-     *                        to the function or an md5 hash of an input.
-     *
-     * @return bool
-     */
-    public static function isCached($key, $id)
-    {
-        return self::$enabled === true && isset(self::$cache[$key]) && \array_key_exists($id, self::$cache[$key]);
-    }
-
-    /**
-     * Retrieve a previously cached result for a certain utility function.
-     *
-     * @since 1.0.0
-     *
-     * @param string     $key The key to identify a particular set of results.
-     *                        It is recommended to pass `__METHOD__` to this parameter.
-     * @param int|string $id  Unique identifier for these results.
-     *                        It is recommended for this to be a serialization of arguments passed
-     *                        to the function or an md5 hash of an input.
-     *
-     * @return mixed
-     */
-    public static function get($key, $id)
-    {
-        if (self::$enabled === true && isset(self::$cache[$key]) && \array_key_exists($id, self::$cache[$key])) {
-            return self::$cache[$key][$id];
-        }
-
-        return null;
-    }
-
-    /**
-     * Retrieve all previously cached results for a certain utility function.
-     *
-     * @since 1.0.0
-     *
-     * @param string $key The key to identify a particular set of results.
-     *                    It is recommended to pass `__METHOD__` to this parameter.
-     *
-     * @return array<int|string, mixed>
-     */
-    public static function getForKey($key)
-    {
-        if (self::$enabled === true && \array_key_exists($key, self::$cache)) {
-            return self::$cache[$key];
-        }
-
-        return [];
-    }
-
-    /**
-     * Cache the result for a certain utility function.
-     *
-     * @since 1.0.0
-     *
-     * @param string     $key   The key to identify a particular set of results.
-     *                          It is recommended to pass `__METHOD__` to this parameter.
-     * @param int|string $id    Unique identifier for these results.
-     *                          It is recommended for this to be a serialization of arguments passed
-     *                          to the function or an md5 hash of an input.
-     * @param mixed      $value An arbitrary value to write to the cache.
-     *
-     * @return mixed
-     */
-    public static function set($key, $id, $value)
-    {
-        if (self::$enabled === false) {
-            return;
-        }
-
-        self::$cache[$key][$id] = $value;
-    }
-
-    /**
-     * Clear the cache.
-     *
-     * @since 1.0.0
-     *
-     * @return void
-     */
-    public static function clear()
-    {
-        self::$cache = [];
-    }
-}

package/vendor/phpcsstandards/phpcsutils/PHPCSUtils/Internal/StableCollections.php

@@ -1,75 +0,0 @@
-<?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 PHPCSUtils\Internal;
-
-/**
- * Stable collections of related tokens.
- *
- * The {@see \PHPCSUtils\Tokens\Collections} class contains a range of token collections for use by sniffs,
- * some of which may change depending on the availability of a token in PHP/PHPCS.
- * The contents of token collections may also vary based on the PHPCS version to allow for optimized sniffing.
- *
- * The functionality _within_ PHPCSUtils, however, should be stable and reliably testable, so for internal
- * use, the most volatile token arrays are replicated here in stable versions to be used by the PHPCSUtils
- * functions (and tests) internally.
- *
- * ---------------------------------------------------------------------------------------------
- * This class is only intended for internal use by PHPCSUtils and is not part of the public API.
- * This also means that it has no promise of backward compatibility.
- *
- * End-users should use the methods in the {@see \PHPCSUtils\Tokens\Collections} class instead.
- * ---------------------------------------------------------------------------------------------
- *
- * @internal
- *
- * @since 1.0.0
- */
-final class StableCollections
-{
-
-    /**
-     * Tokens which can open a short array or short list (PHPCS cross-version compatible).
-     *
-     * This array will ALWAYS include the `T_OPEN_SQUARE_BRACKET` token to allow for handling
-     * intermittent tokenizer issues related to the retokenization to `T_OPEN_SHORT_ARRAY`.
-     *
-     * @internal
-     * @ignore   This array is only for internal use by PHPCSUtils and is not part of the public API.
-     *
-     * @since 1.0.2
-     *
-     * @var array<int|string, int|string>
-     */
-    public static $shortArrayListOpenTokensBC = [
-        \T_OPEN_SHORT_ARRAY    => \T_OPEN_SHORT_ARRAY,
-        \T_OPEN_SQUARE_BRACKET => \T_OPEN_SQUARE_BRACKET,
-    ];
-
-    /**
-     * Tokens which are used for short lists.
-     *
-     * This array will ALWAYS include the `T_OPEN_SQUARE_BRACKET` and `T_CLOSE_SQUARE_BRACKET` tokens
-     * to allow for handling intermittent tokenizer issues related to the retokenization to `T_OPEN_SHORT_ARRAY`.
-     *
-     * @internal
-     * @ignore   This array is only for internal use by PHPCSUtils and is not part of the public API.
-     *
-     * @since 1.0.2
-     *
-     * @var array<int|string, int|string>
-     */
-    public static $shortArrayListTokensBC = [
-        \T_OPEN_SHORT_ARRAY     => \T_OPEN_SHORT_ARRAY,
-        \T_CLOSE_SHORT_ARRAY    => \T_CLOSE_SHORT_ARRAY,
-        \T_OPEN_SQUARE_BRACKET  => \T_OPEN_SQUARE_BRACKET,
-        \T_CLOSE_SQUARE_BRACKET => \T_CLOSE_SQUARE_BRACKET,
-    ];
-}