hexydec\agentzero\versions

Complexity

Total Complexity

40

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Test Coverage

Coverage

83.1%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	load()	0	32	10
A	latest()	0	14	4
B	released()	0	23	10
C	get()	0	68	16

<?php
declare(strict_types = 1);
namespace hexydec\agentzero;

class versions {

	/**
	 * @var array|false|null An array of browser version numbers
	 */
	protected static array|false|null $versions = null;

	/**
	 * Loads browser version information from an external source
	 * 
	 * @param string $source The URL of the source JSON containing the version information
	 * @param string $cache The absolute file address of the cache file
	 * @param ?int $life The maximum life of the cache file in seconds
	 * @return array<string,array<string,string>> An array of browser versioning information, or false if the data source not be retrieved
	 */
	protected static function load(string $source, string $cache, ?int $life = 604800) : array|false {

		// cache for this session
		$data = self::$versions;
		if ($data === null) {

			// fetch from cache
			if (\file_exists($cache) && \filemtime($cache) > \time() - $life && ($json = \file_get_contents($cache)) !== false) {

			// fetch from server
			} elseif (($json = \file_get_contents($source)) === false) {

				// get stale cache
				if ($cache !== null && ($json = \file_get_contents($cache)) !== false) {
					self::$versions = false;
					return false;

The expression return false returns the type false which is incompatible with the documented return type array<string,array<string,string>>.

				}

			// update cache
			} else {

				// create directory and cache file
				$dir = \dirname($cache);
				if (\is_dir($dir) || \mkdir($dir, 0755)) {
					\file_put_contents($cache, $json);
				}
			}

			// decode JSON
			self::$versions = $data = \json_decode($json, true);
		}
		return $data ?? false;

The expression return $data ?? false could also return false which is incompatible with the documented return type array<string,array<string,string>>. Did you maybe forget to handle an error condition?

	}

	/**
	 * Determines the latest version of a browser, optionally capped by the supplied date
	 * 
	 * @param array<string,string> $versions An array of browser versions, where the key is the version number and the value is the release date (In Ymd format)
	 */
	protected static function latest(array $versions, ?\DateTime $now = null) : ?string {

		// no date restriction
		if ($now === null) {
			return \strval(\array_key_first($versions));
		} else {
			$date = \intval($now->format('Ymd'));
			foreach ($versions AS $key => $item) {
				if ($date < $item) {
					return \strval($key);
				}
			}
		}
		return null;
	}

	protected static function released(array $data, string $version) : ?string {
		$major = \intval($version);
		$len = 0;
		$vlen = \strlen($version);
		$released = null;
		foreach ($data AS $ver => $date) {
			if (\intval($ver) === $major) {
				$ver = \strval($ver); // cast as string to get letters, string keys cast to int when array keys
				$match = 0;
				for ($n = 0; $n < $vlen; $n++) {
					if ($version[$n] === ($ver[$n] ?? null)) {
						$match++;
					} else {
						break;
					}
				}
				if ($match && $match > $len && ($released === null || $released > $date)) {
					$len = $match;
					$released = $date;
				}
			}
		}
		return !empty($released) ? (new \DateTime(\strval($released)))->format('Y-m-d') : null;
	}

	public static function get(string $browser, string $version, array $config) : array {
		$source = $config['versionssource'];
		$cache = $config['versionscache'];
		$life = $config['versionscachelife'];
		if ($cache !== null && ($versions = self::load($source, $cache, $life)) !== false) {
			$data = [];

			// get latest version of the browser
			if (isset($versions[$browser]) && ($data['browserlatest'] = self::latest($versions[$browser], $config['currentdate'])) !== null) {
				
				// check if version is greater than latest version
				$major = \intval($version);
				$latest = \intval($data['browserlatest']);
				$first = \intval(\array_key_last($versions[$browser]));

				// version is way out of bounds (This happens sometimes, for example if the safari engine version is reported instead of the browser version)
				if ($latest + 3 < $major) {
					return [];

				// nightly build?
				} elseif ($latest + 3 === $major) {
					$data['browserstatus'] = 'nightly';

				// canary build
				} elseif ($latest + 2 === $major) {
					$data['browserstatus'] = 'canary';

				// beta release
				} elseif ($latest + 1 === $major) {
					$data['browserstatus'] = 'beta';

				// so old we don't have data for it
				} elseif ($major < $first) {
					$data['browserstatus'] = 'legacy';

				// find closes match for version
				} else {

					// get current version
					$data['browserreleased'] = self::released($versions[$browser], $version);

					// calculate status
					if (isset($data['browserreleased'], $data['browserlatest'])) {
						$current = \explode('.', $data['browserlatest'])[0] === \explode('.', $version)[0];
						$released = new \DateTime($data['browserreleased']);

						// legacy
						if ($released < \date_create('-5 years')) {
							$data['browserstatus'] = 'legacy';

						// outdated
						} elseif ($released < \date_create('-2 years')) {
							$data['browserstatus'] = 'outdated';

						// current
						} elseif ($current && ($released >= \date_create('-1 year') || $data['browserlatest'] === $version)) {
							$data['browserstatus'] = 'current';

						// previous
						} else {
							$data['browserstatus'] = 'previous';
						}
					}
				}
			}
			return $data;
		}
		return [];
	}
}