*/ private static $allPhpcsVersions = array( '3.1.0' => '3.1.0', '3.1.1' => '3.1.1', '3.2.0' => '3.2.0', '3.2.1' => '3.2.1', '3.2.2' => '3.2.2', '3.2.3' => '3.2.3', '3.3.0' => '3.3.0', '3.3.1' => '3.3.1', '3.3.2' => '3.3.2', '3.4.0' => '3.4.0', '3.4.1' => '3.4.1', '3.4.2' => '3.4.2', '3.5.0' => '3.5.0', '3.5.1' => '3.5.1', '3.5.2' => '3.5.2', '3.5.3' => '3.5.3', '3.5.4' => '3.5.4', '3.5.5' => '3.5.5', '3.5.6' => '3.5.6', '3.5.7' => '3.5.7', '3.5.8' => '3.5.8', '3.6.0' => '3.6.0', '3.6.1' => '3.6.1', '3.6.2' => '3.6.2', '3.7.0' => '3.7.0', '3.7.1' => '3.7.1', '3.7.2' => '3.7.2', '3.8.0' => '3.8.0', '3.8.1' => '3.8.1', '3.9.0' => '3.9.0', '3.9.1' => '3.9.1', '3.9.2' => '3.9.2', '3.10.0' => '3.10.0', '3.10.1' => '3.10.1', '3.10.2' => '3.10.2', '3.10.3' => '3.10.3', '3.11.0' => '3.11.0', '3.11.1' => '3.11.1', '3.11.2' => '3.11.2', '3.11.3' => '3.11.3', '3.12.0' => '3.12.0', '3.12.1' => '3.12.1', '3.12.2' => '3.12.2', '3.13.0' => '3.13.0', '3.13.1' => '3.13.1', '3.13.2' => '3.13.2', '3.13.3' => '3.13.3', '3.13.4' => '3.13.4', '4.0.0' => '4.0.0', ); /** * Retrieve an array with a specific number of PHPCS versions valid for the current PHP version. * * @param int $number Number of PHPCS versions to retrieve (excluding master/next major). * Defaults to `0` = all supported versions for the current PHP version. * When a non-0 value is passed, a random selection of versions supported * by the current PHP version will be returned. * @param bool $addMaster Whether or not `dev-master` should be added to the version array (providing * it supports the current PHP version). * Defaults to `false`. * @param bool $addNextMajor Whether or not the development branch for the next PHPCS major should be * added to the version array (providing it supports the current PHP version). * Defaults to `false`. * Note: if `true`, the version will be returned in a Composer usable format. * * @return array Numerically indexed array with PHPCS version identifiers as values. */ public static function get($number = 0, $addMaster = false, $addNextMajor = false) { if (is_int($number) === false || $number < 0) { throw new RuntimeException('The number parameter must be a positive integer.'); } $versions = self::getSupportedVersions(); $selection = array_values($versions); if ($number !== 0 && empty($versions) === false) { $number = min($number, count($versions)); $selection = (array) array_rand($versions, $number); } if ($addMaster === true && self::isDevSupported()) { $selection[] = self::MASTER; } if ($addNextMajor === true && self::isNextMajorSupported()) { $selection[] = self::NEXT_MAJOR; } return $selection; } /** * Retrieve an array of the highest and lowest PHPCS versions valid for the current PHP version. * * @param bool $addMaster Whether or not `dev-master` should be added to the version array (providing * it supports the current PHP version). * Defaults to `false`. * @param bool $addNextMajor Whether or not the development branch for the next PHPCS major should be * added to the version array (providing it supports the current PHP version). * Defaults to `false`. * Note: if `true`, the version will be returned in a Composer usable format. * * @return array Numerically indexed array with PHPCS version identifiers as values. */ public static function getHighLow($addMaster = false, $addNextMajor = false) { $versions = self::getSupportedVersions(); $selection = array(); if (empty($versions) === false) { $selection[] = self::min($versions); $selection[] = self::max($versions); } if ($addMaster === true && self::isDevSupported()) { $selection[] = self::MASTER; } if ($addNextMajor === true && self::isNextMajorSupported()) { $selection[] = self::NEXT_MAJOR; } return $selection; } /** * Retrieve an array of the highest and lowest supported PHPCS versions for each PHPCS major * (valid for the current PHP version). * * @param bool $addMaster Whether or not `dev-master` should be added to the version array (providing * it supports the current PHP version). * Defaults to `false`. * @param bool $addNextMajor Whether or not the development branch for the next PHPCS major should be * added to the version array (providing it supports the current PHP version). * Defaults to `false`. * Note: if `true`, the version will be returned in a Composer usable format. * * @return array Numerically indexed array with PHPCS version identifiers as values. */ public static function getHighLowEachMajor($addMaster = false, $addNextMajor = false) { $versions = self::getSupportedVersions(); $versions3 = array(); $versions4 = array(); if (empty($versions) === false) { $versions3 = array_filter( $versions, static function ($v) { return $v[0] === '3'; } ); $versions4 = array_filter( $versions, static function ($v) { return $v[0] === '4'; } ); } $selection = array(); if (empty($versions3) === false) { $selection[] = self::min($versions3); $selection[] = self::max($versions3); } if (empty($versions4) === false) { $selection[] = self::min($versions4); $selection[] = self::max($versions4); } if ($addMaster === true && self::isDevSupported()) { $selection[] = self::MASTER; } if ($addNextMajor === true && self::isNextMajorSupported()) { $selection[] = self::NEXT_MAJOR; } return $selection; } /** * Find the lowest version in an array of PHPCS versions. * * @param array List of PHPCS version identifiers. * * @return string The version identifier of the lowest PHPCS version in the list. */ public static function min($versions) { return array_reduce( $versions, static function ($carry, $item) { if ($carry === null) { // First iteration. return $item; } return version_compare($carry, $item, '<') ? $carry : $item; } ); } /** * Find the highest version in an array of PHPCS versions. * * @param array List of PHPCS version identifiers. * * @return string The version identifier of the highest PHPCS version in the list. */ public static function max($versions) { return array_reduce( $versions, static function ($carry, $item) { if ($carry === null) { // First iteration. return $item; } return version_compare($carry, $item, '>') ? $carry : $item; } ); } /** * Get a random PHPCS version which is valid for the current PHP version. * * @param bool $inclMaster Whether or not `dev-master` should be included in the array to pick * the version from (providing it supports the current PHP version). * Defaults to `false`. * @param bool $inclNextMajor Whether or not the development branch for the next PHPCS major should be included * in the array to pick the version (providing it supports the current PHP version). * Defaults to `false`. * Note: if `true`, the version will be returned in a Composer usable format. * * @return string */ public static function getRandom($inclMaster = false, $inclNextMajor = false) { $versions = self::getSupportedVersions(); if ($inclMaster === true && self::isDevSupported()) { $versions[self::MASTER] = self::MASTER; } if ($inclNextMajor === true && self::isNextMajorSupported()) { $versions[self::NEXT_MAJOR] = self::NEXT_MAJOR; } return array_rand($versions); } /** * Convert a versions array to an array suitable for use as a PHPUnit dataprovider. * * @param array $versions Array with PHPCS version numbers as values. * * @return array> Array of PHPCS version identifiers in a format usable * for a test data provider. */ public static function toDataprovider($versions) { if (is_array($versions) === false || $versions === array()) { throw new RuntimeException('The versions parameter must be a non-empty array.'); } $data = array(); foreach ($versions as $version) { $data['phpcs ' . $version] = array( 'phpcsVersion' => $version, ); } return $data; } /** * Retrieve an array with PHPCS versions valid for the current PHP version. * * @return array Array with PHPCS version identifiers as both keys and values. */ public static function getSupportedVersions() { /* * Adjust the list of available versions based on the PHP version on which the tests are run. */ switch (\CLI_PHP_MINOR) { case '5.4': case '5.5': case '5.6': case '7.0': case '7.1': $versions = array_filter( self::$allPhpcsVersions, static function ($version) { // PHPCS 3.x is the last version still supporting PHP < 7.2. return version_compare($version, '3.99.99', '<='); } ); break; case '7.2': $versions = self::$allPhpcsVersions; break; case '7.3': $versions = array_filter( self::$allPhpcsVersions, static function ($version) { // PHPCS 3.3.1 is the first PHPCS version with runtime support for PHP 7.3. return version_compare($version, '3.3.1', '>='); } ); break; case '7.4': $versions = array_filter( self::$allPhpcsVersions, static function ($version) { // PHPCS 3.5.0 is the first PHPCS version with runtime support for PHP 7.4. return version_compare($version, '3.5.0', '>='); } ); break; case '8.0': $versions = array_filter( self::$allPhpcsVersions, static function ($version) { // PHPCS 3.5.7 is the first PHPCS version with runtime support for PHP 8.0. return version_compare($version, '3.5.7', '>='); } ); break; case '8.1': $versions = array_filter( self::$allPhpcsVersions, static function ($version) { // PHPCS 3.6.1 is the first PHPCS version with runtime support for PHP 8.1. return version_compare($version, '3.6.1', '>='); } ); break; case '8.2': $versions = array_filter( self::$allPhpcsVersions, static function ($version) { // PHPCS 3.6.1 is the first PHPCS version with runtime support for PHP 8.2. return version_compare($version, '3.6.1', '>='); } ); break; case '8.3': case '8.4': $versions = array_filter( self::$allPhpcsVersions, static function ($version) { // PHPCS 3.8.0 is the first PHPCS version with runtime support for PHP 8.3. // And while officially, PHPCS 3.11.0 is the first PHPCS version with runtime support // for PHP 8.4, for our purposes, we should be fine with PHPCS 3.8.0 or higher. return version_compare($version, '3.8.0', '>='); } ); break; case '8.5': $versions = array_filter( self::$allPhpcsVersions, static function ($version) { // PHPCS 3.13.4 is the first PHPCS version with runtime support for PHP 8.5. return version_compare($version, '3.13.4', '>='); } ); break; case '8.6': /* * At this point in time, it is unclear as of which PHPCS version PHP 8.6 will be supported. * In other words: tests should only use 4.x-dev when on PHP 8.6 for the time being. */ $versions = array(); break; default: $versions = self::$allPhpcsVersions; break; } return $versions; } /** * Determine if the current PHP version is supported on the "dev" branch of PHPCS. * * @return bool */ public static function isDevSupported() { return version_compare(\CLI_PHP_MINOR, '7.2', '>='); } /** * Determine if the current PHP version is supported on the "next major" branch of PHPCS. * * @return bool */ public static function isNextMajorSupported() { // TEMPORARILY COMMENTED OUT. // Re-activate once a 5.x branch is created in the PHPCS repo and the next minimum PHP version is known. //return version_compare(\CLI_PHP_MINOR, '7.2', '>='); return false; } /** * Retrieve an array of the PHPCS native standards which are included in a particular PHPCS version. * * @param string $version PHPCS version number. * * @return array Numerically indexed array of standards, natural sort applied. */ public static function getStandards($version) { if ( is_string($version) === false || (isset(self::$allPhpcsVersions[$version]) === false && $version !== self::MASTER && $version !== self::NEXT_MAJOR) ) { throw new RuntimeException('The version parameter must be a valid PHPCS version number as a string.'); } $standards = array( 'PEAR', 'PSR1', 'PSR2', 'Squiz', 'Zend', ); if ( $version !== self::MASTER && $version !== self::NEXT_MAJOR && version_compare($version, '4.0.0', '<') ) { // The MySource standard is available in PHPCS 3.x, but has been removed in 4.0. $standards[] = 'MySource'; } if ( $version === self::MASTER || $version === self::NEXT_MAJOR || version_compare($version, '3.3.0', '>=') ) { // The PSR12 standard is available since PHPCS 3.3.0. $standards[] = 'PSR12'; } sort($standards, \SORT_NATURAL); return $standards; } }