@averay/codeformat 0.2.1 → 0.2.2

package/vendor/react/cache/README.md

@@ -0,0 +1,367 @@
+# Cache
+
+[![CI status](https://github.com/reactphp/cache/actions/workflows/ci.yml/badge.svg)](https://github.com/reactphp/cache/actions)
+[![installs on Packagist](https://img.shields.io/packagist/dt/react/cache?color=blue&label=installs%20on%20Packagist)](https://packagist.org/packages/react/cache)
+
+Async, [Promise](https://github.com/reactphp/promise)-based cache interface
+for [ReactPHP](https://reactphp.org/).
+
+The cache component provides a
+[Promise](https://github.com/reactphp/promise)-based
+[`CacheInterface`](#cacheinterface) and an in-memory [`ArrayCache`](#arraycache)
+implementation of that.
+This allows consumers to type hint against the interface and third parties to
+provide alternate implementations.
+This project is heavily inspired by
+[PSR-16: Common Interface for Caching Libraries](https://www.php-fig.org/psr/psr-16/),
+but uses an interface more suited for async, non-blocking applications.
+
+**Table of Contents**
+
+* [Usage](#usage)
+  * [CacheInterface](#cacheinterface)
+    * [get()](#get)
+    * [set()](#set)
+    * [delete()](#delete)
+    * [getMultiple()](#getmultiple)
+    * [setMultiple()](#setmultiple)
+    * [deleteMultiple()](#deletemultiple)
+    * [clear()](#clear)
+    * [has()](#has)
+  * [ArrayCache](#arraycache)
+* [Common usage](#common-usage)
+  * [Fallback get](#fallback-get)
+  * [Fallback-get-and-set](#fallback-get-and-set)
+* [Install](#install)
+* [Tests](#tests)
+* [License](#license)
+
+## Usage
+
+### CacheInterface
+
+The `CacheInterface` describes the main interface of this component.
+This allows consumers to type hint against the interface and third parties to
+provide alternate implementations.
+
+#### get()
+
+The `get(string $key, mixed $default = null): PromiseInterface<mixed>` method can be used to
+retrieve an item from the cache.
+
+This method will resolve with the cached value on success or with the
+given `$default` value when no item can be found or when an error occurs.
+Similarly, an expired cache item (once the time-to-live is expired) is
+considered a cache miss.
+
+```php
+$cache
+    ->get('foo')
+    ->then('var_dump');
+```
+
+This example fetches the value of the key `foo` and passes it to the
+`var_dump` function. You can use any of the composition provided by
+[promises](https://github.com/reactphp/promise).
+
+#### set()
+
+The `set(string $key, mixed $value, ?float $ttl = null): PromiseInterface<bool>` method can be used to
+store an item in the cache.
+
+This method will resolve with `true` on success or `false` when an error
+occurs. If the cache implementation has to go over the network to store
+it, it may take a while.
+
+The optional `$ttl` parameter sets the maximum time-to-live in seconds
+for this cache item. If this parameter is omitted (or `null`), the item
+will stay in the cache for as long as the underlying implementation
+supports. Trying to access an expired cache item results in a cache miss,
+see also [`get()`](#get).
+
+```php
+$cache->set('foo', 'bar', 60);
+```
+
+This example eventually sets the value of the key `foo` to `bar`. If it
+already exists, it is overridden.
+
+This interface does not enforce any particular TTL resolution, so special
+care may have to be taken if you rely on very high precision with
+millisecond accuracy or below. Cache implementations SHOULD work on a
+best effort basis and SHOULD provide at least second accuracy unless
+otherwise noted. Many existing cache implementations are known to provide
+microsecond or millisecond accuracy, but it's generally not recommended
+to rely on this high precision.
+
+This interface suggests that cache implementations SHOULD use a monotonic
+time source if available. Given that a monotonic time source is only
+available as of PHP 7.3 by default, cache implementations MAY fall back
+to using wall-clock time.
+While this does not affect many common use cases, this is an important
+distinction for programs that rely on a high time precision or on systems
+that are subject to discontinuous time adjustments (time jumps).
+This means that if you store a cache item with a TTL of 30s and then
+adjust your system time forward by 20s, the cache item SHOULD still
+expire in 30s.
+
+#### delete()
+
+The `delete(string $key): PromiseInterface<bool>` method can be used to
+delete an item from the cache.
+
+This method will resolve with `true` on success or `false` when an error
+occurs. When no item for `$key` is found in the cache, it also resolves
+to `true`. If the cache implementation has to go over the network to
+delete it, it may take a while.
+
+```php
+$cache->delete('foo');
+```
+
+This example eventually deletes the key `foo` from the cache. As with
+`set()`, this may not happen instantly and a promise is returned to
+provide guarantees whether or not the item has been removed from cache.
+
+#### getMultiple()
+
+The `getMultiple(string[] $keys, mixed $default = null): PromiseInterface<array>` method can be used to
+retrieve multiple cache items by their unique keys.
+
+This method will resolve with an array of cached values on success or with the
+given `$default` value when an item can not be found or when an error occurs.
+Similarly, an expired cache item (once the time-to-live is expired) is
+considered a cache miss.
+
+```php
+$cache->getMultiple(array('name', 'age'))->then(function (array $values) {
+    $name = $values['name'] ?? 'User';
+    $age = $values['age'] ?? 'n/a';
+
+    echo $name . ' is ' . $age . PHP_EOL;
+});
+```
+
+This example fetches the cache items for the `name` and `age` keys and
+prints some example output. You can use any of the composition provided
+by [promises](https://github.com/reactphp/promise).
+
+#### setMultiple()
+
+The `setMultiple(array $values, ?float $ttl = null): PromiseInterface<bool>` method can be used to
+persist a set of key => value pairs in the cache, with an optional TTL.
+
+This method will resolve with `true` on success or `false` when an error
+occurs. If the cache implementation has to go over the network to store
+it, it may take a while.
+
+The optional `$ttl` parameter sets the maximum time-to-live in seconds
+for these cache items. If this parameter is omitted (or `null`), these items
+will stay in the cache for as long as the underlying implementation
+supports. Trying to access an expired cache items results in a cache miss,
+see also [`getMultiple()`](#getmultiple).
+
+```php
+$cache->setMultiple(array('foo' => 1, 'bar' => 2), 60);
+```
+
+This example eventually sets the list of values - the key `foo` to `1` value 
+and the key `bar` to `2`. If some of the keys already exist, they are overridden.
+
+#### deleteMultiple()
+
+The `setMultiple(string[] $keys): PromiseInterface<bool>` method can be used to
+delete multiple cache items in a single operation.
+
+This method will resolve with `true` on success or `false` when an error
+occurs. When no items for `$keys` are found in the cache, it also resolves
+to `true`. If the cache implementation has to go over the network to
+delete it, it may take a while.
+
+```php
+$cache->deleteMultiple(array('foo', 'bar, 'baz'));
+```
+
+This example eventually deletes keys `foo`, `bar` and `baz` from the cache. 
+As with `setMultiple()`, this may not happen instantly and a promise is returned to
+provide guarantees whether or not the item has been removed from cache.
+
+#### clear()
+
+The `clear(): PromiseInterface<bool>` method can be used to
+wipe clean the entire cache.
+
+This method will resolve with `true` on success or `false` when an error
+occurs. If the cache implementation has to go over the network to
+delete it, it may take a while.
+
+```php
+$cache->clear();
+```
+
+This example eventually deletes all keys from the cache. As with `deleteMultiple()`, 
+this may not happen instantly and a promise is returned to provide guarantees 
+whether or not all the items have been removed from cache.
+
+#### has()
+
+The `has(string $key): PromiseInterface<bool>` method can be used to
+determine whether an item is present in the cache.
+
+This method will resolve with `true` on success or `false` when no item can be found 
+or when an error occurs. Similarly, an expired cache item (once the time-to-live 
+is expired) is considered a cache miss.
+
+```php
+$cache
+    ->has('foo')
+    ->then('var_dump');
+```
+
+This example checks if the value of the key `foo` is set in the cache and passes 
+the result to the `var_dump` function. You can use any of the composition provided by
+[promises](https://github.com/reactphp/promise).
+
+NOTE: It is recommended that has() is only to be used for cache warming type purposes
+and not to be used within your live applications operations for get/set, as this method
+is subject to a race condition where your has() will return true and immediately after,
+another script can remove it making the state of your app out of date.
+
+### ArrayCache
+
+The `ArrayCache` provides an in-memory implementation of the [`CacheInterface`](#cacheinterface).
+
+```php
+$cache = new ArrayCache();
+
+$cache->set('foo', 'bar');
+```
+
+Its constructor accepts an optional `?int $limit` parameter to limit the
+maximum number of entries to store in the LRU cache. If you add more
+entries to this instance, it will automatically take care of removing
+the one that was least recently used (LRU).
+
+For example, this snippet will overwrite the first value and only store
+the last two entries:
+
+```php
+$cache = new ArrayCache(2);
+
+$cache->set('foo', '1');
+$cache->set('bar', '2');
+$cache->set('baz', '3');
+```
+
+This cache implementation is known to rely on wall-clock time to schedule
+future cache expiration times when using any version before PHP 7.3,
+because a monotonic time source is only available as of PHP 7.3 (`hrtime()`).
+While this does not affect many common use cases, this is an important
+distinction for programs that rely on a high time precision or on systems
+that are subject to discontinuous time adjustments (time jumps).
+This means that if you store a cache item with a TTL of 30s on PHP < 7.3
+and then adjust your system time forward by 20s, the cache item may
+expire in 10s. See also [`set()`](#set) for more details.
+
+## Common usage
+
+### Fallback get
+
+A common use case of caches is to attempt fetching a cached value and as a
+fallback retrieve it from the original data source if not found. Here is an
+example of that:
+
+```php
+$cache
+    ->get('foo')
+    ->then(function ($result) {
+        if ($result === null) {
+            return getFooFromDb();
+        }
+        
+        return $result;
+    })
+    ->then('var_dump');
+```
+
+First an attempt is made to retrieve the value of `foo`. A callback function is 
+registered that will call `getFooFromDb` when the resulting value is null. 
+`getFooFromDb` is a function (can be any PHP callable) that will be called if the 
+key does not exist in the cache.
+
+`getFooFromDb` can handle the missing key by returning a promise for the
+actual value from the database (or any other data source). As a result, this
+chain will correctly fall back, and provide the value in both cases.
+
+### Fallback get and set
+
+To expand on the fallback get example, often you want to set the value on the
+cache after fetching it from the data source.
+
+```php
+$cache
+    ->get('foo')
+    ->then(function ($result) {
+        if ($result === null) {
+            return $this->getAndCacheFooFromDb();
+        }
+        
+        return $result;
+    })
+    ->then('var_dump');
+
+public function getAndCacheFooFromDb()
+{
+    return $this->db
+        ->get('foo')
+        ->then(array($this, 'cacheFooFromDb'));
+}
+
+public function cacheFooFromDb($foo)
+{
+    $this->cache->set('foo', $foo);
+
+    return $foo;
+}
+```
+
+By using chaining you can easily conditionally cache the value if it is
+fetched from the database.
+
+## Install
+
+The recommended way to install this library is [through Composer](https://getcomposer.org).
+[New to Composer?](https://getcomposer.org/doc/00-intro.md)
+
+This project follows [SemVer](https://semver.org/).
+This will install the latest supported version:
+
+```bash
+composer require react/cache:^1.2
+```
+
+See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
+
+This project aims to run on any platform and thus does not require any PHP
+extensions and supports running on legacy PHP 5.3 through current PHP 8+ and
+HHVM.
+It's *highly recommended to use PHP 7+* for this project.
+
+## Tests
+
+To run the test suite, you first need to clone this repo and then install all
+dependencies [through Composer](https://getcomposer.org):
+
+```bash
+composer install
+```
+
+To run the test suite, go to the project root and run:
+
+```bash
+vendor/bin/phpunit
+```
+
+## License
+
+MIT, see [LICENSE file](LICENSE).

package/vendor/react/cache/composer.json

@@ -0,0 +1,45 @@
+{
+    "name": "react/cache",
+    "description": "Async, Promise-based cache interface for ReactPHP",
+    "keywords": ["cache", "caching", "promise", "ReactPHP"],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Christian Lück",
+            "homepage": "https://clue.engineering/",
+            "email": "christian@clue.engineering"
+        },
+        {
+            "name": "Cees-Jan Kiewiet",
+            "homepage": "https://wyrihaximus.net/",
+            "email": "reactphp@ceesjankiewiet.nl"
+        },
+        {
+            "name": "Jan Sorgalla",
+            "homepage": "https://sorgalla.com/",
+            "email": "jsorgalla@gmail.com"
+        },
+        {
+            "name": "Chris Boden",
+            "homepage": "https://cboden.dev/",
+            "email": "cboden@gmail.com"
+        }
+    ],
+    "require": {
+        "php": ">=5.3.0",
+        "react/promise": "^3.0 || ^2.0 || ^1.1"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.5 || ^5.7 || ^4.8.35"
+    },
+    "autoload": {
+        "psr-4": {
+            "React\\Cache\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "React\\Tests\\Cache\\": "tests/"
+        }
+    }
+}

package/vendor/react/cache/src/ArrayCache.php

@@ -0,0 +1,181 @@
+<?php
+
+namespace React\Cache;
+
+use React\Promise;
+use React\Promise\PromiseInterface;
+
+class ArrayCache implements CacheInterface
+{
+    private $limit;
+    private $data = array();
+    private $expires = array();
+    private $supportsHighResolution;
+
+    /**
+     * The `ArrayCache` provides an in-memory implementation of the [`CacheInterface`](#cacheinterface).
+     *
+     * ```php
+     * $cache = new ArrayCache();
+     *
+     * $cache->set('foo', 'bar');
+     * ```
+     *
+     * Its constructor accepts an optional `?int $limit` parameter to limit the
+     * maximum number of entries to store in the LRU cache. If you add more
+     * entries to this instance, it will automatically take care of removing
+     * the one that was least recently used (LRU).
+     *
+     * For example, this snippet will overwrite the first value and only store
+     * the last two entries:
+     *
+     * ```php
+     * $cache = new ArrayCache(2);
+     *
+     * $cache->set('foo', '1');
+     * $cache->set('bar', '2');
+     * $cache->set('baz', '3');
+     * ```
+     *
+     * This cache implementation is known to rely on wall-clock time to schedule
+     * future cache expiration times when using any version before PHP 7.3,
+     * because a monotonic time source is only available as of PHP 7.3 (`hrtime()`).
+     * While this does not affect many common use cases, this is an important
+     * distinction for programs that rely on a high time precision or on systems
+     * that are subject to discontinuous time adjustments (time jumps).
+     * This means that if you store a cache item with a TTL of 30s on PHP < 7.3
+     * and then adjust your system time forward by 20s, the cache item may
+     * expire in 10s. See also [`set()`](#set) for more details.
+     *
+     * @param int|null $limit maximum number of entries to store in the LRU cache
+     */
+    public function __construct($limit = null)
+    {
+        $this->limit = $limit;
+
+        // prefer high-resolution timer, available as of PHP 7.3+
+        $this->supportsHighResolution = \function_exists('hrtime');
+    }
+
+    public function get($key, $default = null)
+    {
+        // delete key if it is already expired => below will detect this as a cache miss
+        if (isset($this->expires[$key]) && $this->now() - $this->expires[$key] > 0) {
+            unset($this->data[$key], $this->expires[$key]);
+        }
+
+        if (!\array_key_exists($key, $this->data)) {
+            return Promise\resolve($default);
+        }
+
+        // remove and append to end of array to keep track of LRU info
+        $value = $this->data[$key];
+        unset($this->data[$key]);
+        $this->data[$key] = $value;
+
+        return Promise\resolve($value);
+    }
+
+    public function set($key, $value, $ttl = null)
+    {
+        // unset before setting to ensure this entry will be added to end of array (LRU info)
+        unset($this->data[$key]);
+        $this->data[$key] = $value;
+
+        // sort expiration times if TTL is given (first will expire first)
+        unset($this->expires[$key]);
+        if ($ttl !== null) {
+            $this->expires[$key] = $this->now() + $ttl;
+            \asort($this->expires);
+        }
+
+        // ensure size limit is not exceeded or remove first entry from array
+        if ($this->limit !== null && \count($this->data) > $this->limit) {
+            // first try to check if there's any expired entry
+            // expiration times are sorted, so we can simply look at the first one
+            \reset($this->expires);
+            $key = \key($this->expires);
+
+            // check to see if the first in the list of expiring keys is already expired
+            // if the first key is not expired, we have to overwrite by using LRU info
+            if ($key === null || $this->now() - $this->expires[$key] < 0) {
+                \reset($this->data);
+                $key = \key($this->data);
+            }
+            unset($this->data[$key], $this->expires[$key]);
+        }
+
+        return Promise\resolve(true);
+    }
+
+    public function delete($key)
+    {
+        unset($this->data[$key], $this->expires[$key]);
+
+        return Promise\resolve(true);
+    }
+
+    public function getMultiple(array $keys, $default = null)
+    {
+        $values = array();
+
+        foreach ($keys as $key) {
+            $values[$key] = $this->get($key, $default);
+        }
+
+        return Promise\all($values);
+    }
+
+    public function setMultiple(array $values, $ttl = null)
+    {
+        foreach ($values as $key => $value) {
+            $this->set($key, $value, $ttl);
+        }
+
+        return Promise\resolve(true);
+    }
+
+    public function deleteMultiple(array $keys)
+    {
+        foreach ($keys as $key) {
+            unset($this->data[$key], $this->expires[$key]);
+        }
+
+        return Promise\resolve(true);
+    }
+
+    public function clear()
+    {
+        $this->data = array();
+        $this->expires = array();
+
+        return Promise\resolve(true);
+    }
+
+    public function has($key)
+    {
+        // delete key if it is already expired
+        if (isset($this->expires[$key]) && $this->now() - $this->expires[$key] > 0) {
+            unset($this->data[$key], $this->expires[$key]);
+        }
+
+        if (!\array_key_exists($key, $this->data)) {
+            return Promise\resolve(false);
+        }
+
+        // remove and append to end of array to keep track of LRU info
+        $value = $this->data[$key];
+        unset($this->data[$key]);
+        $this->data[$key] = $value;
+
+        return Promise\resolve(true);
+    }
+
+    /**
+     * @return float
+     */
+    private function now()
+    {
+        return $this->supportsHighResolution ? \hrtime(true) * 1e-9 : \microtime(true);
+    }
+}