@averay/codeformat 0.2.7 → 0.2.9

package/vendor/fidry/cpu-core-counter/src/CpuCoreCounter.php

@@ -1,268 +0,0 @@
-<?php
-
-/*
- * This file is part of the Fidry CPUCounter Config package.
- *
- * (c) Théo FIDRY <theo.fidry@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-declare(strict_types=1);
-
-namespace Fidry\CpuCoreCounter;
-
-use Fidry\CpuCoreCounter\Finder\CpuCoreFinder;
-use Fidry\CpuCoreCounter\Finder\EnvVariableFinder;
-use Fidry\CpuCoreCounter\Finder\FinderRegistry;
-use InvalidArgumentException;
-use function implode;
-use function max;
-use function sprintf;
-use function sys_getloadavg;
-use const PHP_EOL;
-
-final class CpuCoreCounter
-{
-    /**
-     * @var list<CpuCoreFinder>
-     */
-    private $finders;
-
-    /**
-     * @var positive-int|null
-     */
-    private $count;
-
-    /**
-     * @param list<CpuCoreFinder>|null $finders
-     */
-    public function __construct(?array $finders = null)
-    {
-        $this->finders = $finders ?? FinderRegistry::getDefaultLogicalFinders();
-    }
-
-    /**
-     * @param positive-int|0    $reservedCpus      Number of CPUs to reserve. This is useful when you want
-     *                                             to reserve some CPUs for other processes. If the main
-     *                                             process is going to be busy still, you may want to set
-     *                                             this value to 1.
-     * @param non-zero-int|null $countLimit        The maximum number of CPUs to return. If not provided, it
-     *                                             may look for a limit in the environment variables, e.g.
-     *                                             KUBERNETES_CPU_LIMIT. If negative, the limit will be
-     *                                             the total number of cores found minus the absolute value.
-     *                                             For instance if the system has 10 cores and countLimit=-2,
-     *                                             then the effective limit considered will be 8.
-     * @param float|null        $loadLimit         Element of [0., 1.]. Percentage representing the
-     *                                             amount of cores that should be used among the available
-     *                                             resources. For instance, if set to 0.7, it will use 70%
-     *                                             of the available cores, i.e. if 1 core is reserved, 11
-     *                                             cores are available and 5 are busy, it will use 70%
-     *                                             of (11-1-5)=5 cores, so 3 cores. Set this parameter to null
-     *                                             to skip this check. Beware that 1 does not mean "no limit",
-     *                                             but 100% of the _available_ resources, i.e. with the
-     *                                             previous example, it will return 5 cores. How busy is
-     *                                             the system is determined by the system load average
-     *                                             (see $systemLoadAverage).
-     * @param float|null        $systemLoadAverage The system load average. If passed, it will use
-     *                                             this information to limit the available cores based
-     *                                             on the _available_ resources. For instance, if there
-     *                                             is 10 cores but 3 are busy, then only 7 cores will
-     *                                             be considered for further calculation. If set to
-     *                                             `null`, it will use `sys_getloadavg()` to check the
-     *                                             load of the system in the past minute. You can
-     *                                             otherwise pass an arbitrary value. Should be a
-     *                                             positive float.
-     *
-     * @see https://php.net/manual/en/function.sys-getloadavg.php
-     */
-    public function getAvailableForParallelisation(
-        int $reservedCpus = 0,
-        ?int $countLimit = null,
-        ?float $loadLimit = null,
-        ?float $systemLoadAverage = 0.
-    ): ParallelisationResult {
-        self::checkCountLimit($countLimit);
-        self::checkLoadLimit($loadLimit);
-        self::checkSystemLoadAverage($systemLoadAverage);
-
-        $totalCoreCount = $this->getCountWithFallback(1);
-        $availableCores = max(1, $totalCoreCount - $reservedCpus);
-
-        // Adjust available CPUs based on current load
-        if (null !== $loadLimit) {
-            $correctedSystemLoadAverage = null === $systemLoadAverage
-                ? sys_getloadavg()[0] ?? 0.
-                : $systemLoadAverage;
-
-            $availableCores = max(
-                1,
-                $loadLimit * ($availableCores - $correctedSystemLoadAverage)
-            );
-        }
-
-        if (null === $countLimit) {
-            $correctedCountLimit = self::getKubernetesLimit();
-        } else {
-            $correctedCountLimit = $countLimit > 0
-                ? $countLimit
-                : max(1, $totalCoreCount + $countLimit);
-        }
-
-        if (null !== $correctedCountLimit && $availableCores > $correctedCountLimit) {
-            $availableCores = $correctedCountLimit;
-        }
-
-        return new ParallelisationResult(
-            $reservedCpus,
-            $countLimit,
-            $loadLimit,
-            $systemLoadAverage,
-            $correctedCountLimit,
-            $correctedSystemLoadAverage ?? $systemLoadAverage,
-            $totalCoreCount,
-            (int) $availableCores
-        );
-    }
-
-    /**
-     * @throws NumberOfCpuCoreNotFound
-     *
-     * @return positive-int
-     */
-    public function getCount(): int
-    {
-        // Memoize result
-        if (null === $this->count) {
-            $this->count = $this->findCount();
-        }
-
-        return $this->count;
-    }
-
-    /**
-     * @param positive-int $fallback
-     *
-     * @return positive-int
-     */
-    public function getCountWithFallback(int $fallback): int
-    {
-        try {
-            return $this->getCount();
-        } catch (NumberOfCpuCoreNotFound $exception) {
-            return $fallback;
-        }
-    }
-
-    /**
-     * This method is mostly for debugging purposes.
-     */
-    public function trace(): string
-    {
-        $output = [];
-
-        foreach ($this->finders as $finder) {
-            $output[] = sprintf(
-                'Executing the finder "%s":',
-                $finder->toString()
-            );
-            $output[] = $finder->diagnose();
-
-            $cores = $finder->find();
-
-            if (null !== $cores) {
-                $output[] = 'Result found: '.$cores;
-
-                break;
-            }
-
-            $output[] = '–––';
-        }
-
-        return implode(PHP_EOL, $output);
-    }
-
-    /**
-     * @throws NumberOfCpuCoreNotFound
-     *
-     * @return positive-int
-     */
-    private function findCount(): int
-    {
-        foreach ($this->finders as $finder) {
-            $cores = $finder->find();
-
-            if (null !== $cores) {
-                return $cores;
-            }
-        }
-
-        throw NumberOfCpuCoreNotFound::create();
-    }
-
-    /**
-     * @throws NumberOfCpuCoreNotFound
-     *
-     * @return array{CpuCoreFinder, positive-int}
-     */
-    public function getFinderAndCores(): array
-    {
-        foreach ($this->finders as $finder) {
-            $cores = $finder->find();
-
-            if (null !== $cores) {
-                return [$finder, $cores];
-            }
-        }
-
-        throw NumberOfCpuCoreNotFound::create();
-    }
-
-    /**
-     * @return positive-int|null
-     */
-    public static function getKubernetesLimit(): ?int
-    {
-        $finder = new EnvVariableFinder('KUBERNETES_CPU_LIMIT');
-
-        return $finder->find();
-    }
-
-    private static function checkCountLimit(?int $countLimit): void
-    {
-        if (0 === $countLimit) {
-            throw new InvalidArgumentException(
-                'The count limit must be a non zero integer. Got "0".'
-            );
-        }
-    }
-
-    private static function checkLoadLimit(?float $loadLimit): void
-    {
-        if (null === $loadLimit) {
-            return;
-        }
-
-        if ($loadLimit < 0. || $loadLimit > 1.) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The load limit must be in the range [0., 1.], got "%s".',
-                    $loadLimit
-                )
-            );
-        }
-    }
-
-    private static function checkSystemLoadAverage(?float $systemLoadAverage): void
-    {
-        if (null !== $systemLoadAverage && $systemLoadAverage < 0.) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The system load average must be a positive float, got "%s".',
-                    $systemLoadAverage
-                )
-            );
-        }
-    }
-}

package/vendor/fidry/cpu-core-counter/src/Diagnoser.php

@@ -1,101 +0,0 @@
-<?php
-
-/*
- * This file is part of the Fidry CPUCounter Config package.
- *
- * (c) Théo FIDRY <theo.fidry@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-declare(strict_types=1);
-
-namespace Fidry\CpuCoreCounter;
-
-use Fidry\CpuCoreCounter\Finder\CpuCoreFinder;
-use function array_map;
-use function explode;
-use function implode;
-use function max;
-use function str_repeat;
-use const PHP_EOL;
-
-/**
- * Utility to debug.
- *
- * @private
- */
-final class Diagnoser
-{
-    /**
-     * Provides an aggregated diagnosis based on each finders diagnosis.
-     *
-     * @param list<CpuCoreFinder> $finders
-     */
-    public static function diagnose(array $finders): string
-    {
-        $diagnoses = array_map(
-            static function (CpuCoreFinder $finder): string {
-                return self::diagnoseFinder($finder);
-            },
-            $finders
-        );
-
-        return implode(PHP_EOL, $diagnoses);
-    }
-
-    /**
-     * Executes each finders.
-     *
-     * @param list<CpuCoreFinder> $finders
-     */
-    public static function execute(array $finders): string
-    {
-        $diagnoses = array_map(
-            static function (CpuCoreFinder $finder): string {
-                $coresCount = $finder->find();
-
-                return implode(
-                    '',
-                    [
-                        $finder->toString(),
-                        ': ',
-                        null === $coresCount ? 'NULL' : $coresCount,
-                    ]
-                );
-            },
-            $finders
-        );
-
-        return implode(PHP_EOL, $diagnoses);
-    }
-
-    private static function diagnoseFinder(CpuCoreFinder $finder): string
-    {
-        $diagnosis = $finder->diagnose();
-
-        $maxLineLength = max(
-            array_map(
-                'strlen',
-                explode(PHP_EOL, $diagnosis)
-            )
-        );
-
-        $separator = str_repeat('-', $maxLineLength);
-
-        return implode(
-            '',
-            [
-                $finder->toString().':'.PHP_EOL,
-                $separator.PHP_EOL,
-                $diagnosis.PHP_EOL,
-                $separator.PHP_EOL,
-            ]
-        );
-    }
-
-    private function __construct()
-    {
-    }
-}

package/vendor/fidry/cpu-core-counter/src/Executor/ProcOpenExecutor.php

@@ -1,56 +0,0 @@
-<?php
-
-/*
- * This file is part of the Fidry CPUCounter Config package.
- *
- * (c) Théo FIDRY <theo.fidry@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-declare(strict_types=1);
-
-namespace Fidry\CpuCoreCounter\Executor;
-
-use function fclose;
-use function function_exists;
-use function is_resource;
-use function proc_close;
-use function proc_open;
-use function stream_get_contents;
-
-final class ProcOpenExecutor implements ProcessExecutor
-{
-    public function execute(string $command): ?array
-    {
-        if (!function_exists('proc_open')) {
-            return null;
-        }
-
-        $pipes = [];
-
-        $process = @proc_open(
-            $command,
-            [
-                ['pipe', 'rb'],
-                ['pipe', 'wb'], // stdout
-                ['pipe', 'wb'], // stderr
-            ],
-            $pipes
-        );
-
-        if (!is_resource($process)) {
-            return null;
-        }
-
-        fclose($pipes[0]);
-
-        $stdout = (string) stream_get_contents($pipes[1]);
-        $stderr = (string) stream_get_contents($pipes[2]);
-
-        proc_close($process);
-
-        return [$stdout, $stderr];
-    }
-}

package/vendor/fidry/cpu-core-counter/src/Executor/ProcessExecutor.php

@@ -1,22 +0,0 @@
-<?php
-
-/*
- * This file is part of the Fidry CPUCounter Config package.
- *
- * (c) Théo FIDRY <theo.fidry@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-declare(strict_types=1);
-
-namespace Fidry\CpuCoreCounter\Executor;
-
-interface ProcessExecutor
-{
-    /**
-     * @return array{string, string}|null STDOUT & STDERR tuple
-     */
-    public function execute(string $command): ?array;
-}

package/vendor/fidry/cpu-core-counter/src/Finder/CmiCmdletLogicalFinder.php

@@ -1,46 +0,0 @@
-<?php
-
-/*
- * This file is part of the Fidry CPUCounter Config package.
- *
- * (c) Théo FIDRY <theo.fidry@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-declare(strict_types=1);
-
-namespace Fidry\CpuCoreCounter\Finder;
-
-use function preg_match;
-
-/**
- * Find the number of logical CPU cores for Windows leveraging the Get-CimInstance
- * cmdlet, which is a newer version that is recommended over Get-WmiObject.
- */
-final class CmiCmdletLogicalFinder extends ProcOpenBasedFinder
-{
-    private const CPU_CORE_COUNT_REGEX = '/NumberOfLogicalProcessors[\s\n]-+[\s\n]+(?<count>\d+)/';
-
-    protected function getCommand(): string
-    {
-        return 'Get-CimInstance -ClassName Win32_ComputerSystem | Select-Object -Property NumberOfLogicalProcessors';
-    }
-
-    public function toString(): string
-    {
-        return 'CmiCmdletLogicalFinder';
-    }
-
-    protected function countCpuCores(string $process): ?int
-    {
-        if (0 === preg_match(self::CPU_CORE_COUNT_REGEX, $process, $matches)) {
-            return parent::countCpuCores($process);
-        }
-
-        $count = $matches['count'];
-
-        return parent::countCpuCores($count);
-    }
-}

package/vendor/fidry/cpu-core-counter/src/Finder/CmiCmdletPhysicalFinder.php

@@ -1,47 +0,0 @@
-<?php
-
-/*
- * This file is part of the Fidry CPUCounter Config package.
- *
- * (c) Théo FIDRY <theo.fidry@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-declare(strict_types=1);
-
-namespace Fidry\CpuCoreCounter\Finder;
-
-use function preg_match;
-
-/**
- * Find the number of physical CPU cores for Windows.
- *
- * @see https://github.com/paratestphp/paratest/blob/c163539818fd96308ca8dc60f46088461e366ed4/src/Runners/PHPUnit/Options.php#L912-L916
- */
-final class CmiCmdletPhysicalFinder extends ProcOpenBasedFinder
-{
-    private const CPU_CORE_COUNT_REGEX = '/NumberOfCores[\s\n]-+[\s\n]+(?<count>\d+)/';
-
-    protected function getCommand(): string
-    {
-        return 'Get-CimInstance -ClassName Win32_Processor | Select-Object -Property NumberOfCores';
-    }
-
-    public function toString(): string
-    {
-        return 'CmiCmdletPhysicalFinder';
-    }
-
-    protected function countCpuCores(string $process): ?int
-    {
-        if (0 === preg_match(self::CPU_CORE_COUNT_REGEX, $process, $matches)) {
-            return parent::countCpuCores($process);
-        }
-
-        $count = $matches['count'];
-
-        return parent::countCpuCores($count);
-    }
-}

package/vendor/fidry/cpu-core-counter/src/Finder/CpuCoreFinder.php

@@ -1,37 +0,0 @@
-<?php
-
-/*
- * This file is part of the Fidry CPUCounter Config package.
- *
- * (c) Théo FIDRY <theo.fidry@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-declare(strict_types=1);
-
-namespace Fidry\CpuCoreCounter\Finder;
-
-interface CpuCoreFinder
-{
-    /**
-     * Provides an explanation which may offer some insight as to what the finder
-     * will be able to find.
-     *
-     * This is practical to have an idea of what each finder will find collect
-     * information for the unit tests, since integration tests are quite complicated
-     * as dependent on complex infrastructures.
-     */
-    public function diagnose(): string;
-
-    /**
-     * Find the number of CPU cores. If it could not find it, returns null. The
-     * means used to find the cores are at the implementation discretion.
-     *
-     * @return positive-int|null
-     */
-    public function find(): ?int;
-
-    public function toString(): string;
-}

package/vendor/fidry/cpu-core-counter/src/Finder/CpuInfoFinder.php

@@ -1,100 +0,0 @@
-<?php
-
-/*
- * This file is part of the Fidry CPUCounter Config package.
- *
- * (c) Théo FIDRY <theo.fidry@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-declare(strict_types=1);
-
-namespace Fidry\CpuCoreCounter\Finder;
-
-use function file_get_contents;
-use function is_file;
-use function sprintf;
-use function substr_count;
-use const PHP_EOL;
-
-/**
- * Find the number of CPU cores looking up at the cpuinfo file which is available
- * on Linux systems and Windows systems with a Linux sub-system.
- *
- * @see https://github.com/paratestphp/paratest/blob/c163539818fd96308ca8dc60f46088461e366ed4/src/Runners/PHPUnit/Options.php#L903-L909
- * @see https://unix.stackexchange.com/questions/146051/number-of-processors-in-proc-cpuinfo
- */
-final class CpuInfoFinder implements CpuCoreFinder
-{
-    private const CPU_INFO_PATH = '/proc/cpuinfo';
-
-    public function diagnose(): string
-    {
-        if (!is_file(self::CPU_INFO_PATH)) {
-            return sprintf(
-                'The file "%s" could not be found.',
-                self::CPU_INFO_PATH
-            );
-        }
-
-        $cpuInfo = file_get_contents(self::CPU_INFO_PATH);
-
-        if (false === $cpuInfo) {
-            return sprintf(
-                'Could not get the content of the file "%s".',
-                self::CPU_INFO_PATH
-            );
-        }
-
-        return sprintf(
-            'Found the file "%s" with the content:%s%s%sWill return "%s".',
-            self::CPU_INFO_PATH,
-            PHP_EOL,
-            $cpuInfo,
-            PHP_EOL,
-            self::countCpuCores($cpuInfo)
-        );
-    }
-
-    /**
-     * @return positive-int|null
-     */
-    public function find(): ?int
-    {
-        $cpuInfo = self::getCpuInfo();
-
-        return null === $cpuInfo ? null : self::countCpuCores($cpuInfo);
-    }
-
-    public function toString(): string
-    {
-        return 'CpuInfoFinder';
-    }
-
-    private static function getCpuInfo(): ?string
-    {
-        if (!@is_file(self::CPU_INFO_PATH)) {
-            return null;
-        }
-
-        $cpuInfo = @file_get_contents(self::CPU_INFO_PATH);
-
-        return false === $cpuInfo
-            ? null
-            : $cpuInfo;
-    }
-
-    /**
-     * @internal
-     *
-     * @return positive-int|null
-     */
-    public static function countCpuCores(string $cpuInfo): ?int
-    {
-        $processorCount = substr_count($cpuInfo, 'processor');
-
-        return $processorCount > 0 ? $processorCount : null;
-    }
-}