17899394524

Committed 21 Sep 2025 09:49PM UTC coverage: 94.396% (-0.2%) from 94.55%

Build # 17899394524

Build Type

push

github

Committed by

web-flow

Commit Message

refactor: introduce concept of AutomaticRuleSet (#9067)

Run Details

99 of 150 new or added lines in 6 files covered. (66.0%)

4 existing lines in 2 files now uncovered.

28486 of 30177 relevant lines covered (94.4%)

45.35 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/RuleSet/AutomaticMigrationSetTrait.php

<?php

declare(strict_types=1);

/*
 * This file is part of PHP CS Fixer.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace PhpCsFixer\RuleSet;

use Composer\Semver\Semver;
use PhpCsFixer\ComposerJsonReader;
use PhpCsFixer\ConfigurationException\UnresolvableAutoRuleSetConfigurationException;

/**
 * @internal
 *
 * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise.
 */
trait AutomaticMigrationSetTrait
{
    private function calculateTargetSet(string $setName, string $entity, bool $isRisky): string
    {
        static $set = null;

        if (null === $set) {
            $actualVersion = self::calculateActualVersion($setName, $entity);

            $candidates = self::calculateCandidateSets($entity, $isRisky);
            $composerCandidates = Semver::rsort(array_keys($candidates));

            foreach ($composerCandidates as $candidate) {
                if (Semver::satisfies($actualVersion, '>='.$candidate)) {
                    $set = $candidates[$candidate]; // @phpstan-ignore offsetAccess.notFound

                    break;
                }
            }

            if (null === $set) {
                throw new UnresolvableAutoRuleSetConfigurationException(\sprintf('No migration set found feasible for %s %s.', $entity, $actualVersion));
            }
        }

        return $set;
    }

    /**
     * @return list<AbstractMigrationSetDescription>
     */
    private static function getMigrationSets(): array
    {
        static $sets = null;

        if (null === $sets) {
            $sets = array_values(array_filter(
                RuleSets::getSetDefinitions(),
                static fn ($set) => !($set instanceof DeprecatedRuleSetDescriptionInterface) && is_subclass_of($set, AbstractMigrationSetDescription::class),
            ));
        }

        return $sets;
    }

    private static function calculateActualVersion(string $setName, string $entity): string
    {
        $composerJsonReader = ComposerJsonReader::createSingleton();

        if ('PHP' === $entity) {
            $version = $composerJsonReader->getPhp();
        } elseif ('PHPUnit' === $entity) {
            $version = $composerJsonReader->getPhpUnit();
        } else {
            throw new \InvalidArgumentException(\sprintf('Entity "%s" is not supported.', $entity));
        }

        if (null === $version) {
            throw new UnresolvableAutoRuleSetConfigurationException(\sprintf('Cannot detect %s version from "composer.json".', $entity));
        }

        return $version;
    }

    /**
     * @return array<string, string> [ 'major.minor' => '@SetName', ... ]
     */
    private static function calculateCandidateSets(string $entity, bool $isRisky): array
    {
        $candidates = [];
        foreach (self::getMigrationSets() as $set) {
            if ($set->getEntity() !== $entity) {
                continue;
            }

            if ($set->isRisky() !== $isRisky) {
                continue;
            }

            $candidates[$set->getVersionMajorMinor()] = $set->getName();
        }

        return $candidates;
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/*
6	* This file is part of PHP CS Fixer.
7	*
8	* (c) Fabien Potencier <fabien@symfony.com>
9	* Dariusz Rumiński <dariusz.ruminski@gmail.com>
10	*
11	* This source file is subject to the MIT license that is bundled
12	* with this source code in the file LICENSE.
13	*/
14
15	namespace PhpCsFixer\RuleSet;
16
17	use Composer\Semver\Semver;
18	use PhpCsFixer\ComposerJsonReader;
19	use PhpCsFixer\ConfigurationException\UnresolvableAutoRuleSetConfigurationException;
20
21	/**
22	* @internal
23	*
24	* @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
25	*
26	* @no-named-arguments Parameter names are not covered by the backward compatibility promise.
27	*/
28	trait AutomaticMigrationSetTrait
29	{
30	private function calculateTargetSet(string $setName, string $entity, bool $isRisky): string
31	{
NEW 32	static $set = null;	×
33
NEW 34	if (null === $set) {	×
NEW 35	$actualVersion = self::calculateActualVersion($setName, $entity);	×
36
NEW 37	$candidates = self::calculateCandidateSets($entity, $isRisky);	×
NEW 38	$composerCandidates = Semver::rsort(array_keys($candidates));	×
39
NEW 40	foreach ($composerCandidates as $candidate) {	×
NEW 41	if (Semver::satisfies($actualVersion, '>='.$candidate)) {	×
NEW 42	$set = $candidates[$candidate]; // @phpstan-ignore offsetAccess.notFound	×
43
NEW 44	break;	×
45	}
46	}
47
NEW 48	if (null === $set) {	×
NEW 49	throw new UnresolvableAutoRuleSetConfigurationException(\sprintf('No migration set found feasible for %s %s.', $entity, $actualVersion));	×
50	}
51	}
52
NEW 53	return $set;	×
54	}
55
56	/**
57	* @return list<AbstractMigrationSetDescription>
58	*/
59	private static function getMigrationSets(): array
60	{
NEW 61	static $sets = null;	×
62
NEW 63	if (null === $sets) {	×
NEW 64	$sets = array_values(array_filter(	×
NEW 65	RuleSets::getSetDefinitions(),	×
NEW 66	static fn ($set) => !($set instanceof DeprecatedRuleSetDescriptionInterface) && is_subclass_of($set, AbstractMigrationSetDescription::class),	×
NEW 67	));	×
68	}
69
NEW 70	return $sets;	×
71	}
72
73	private static function calculateActualVersion(string $setName, string $entity): string
74	{
NEW 75	$composerJsonReader = ComposerJsonReader::createSingleton();	×
76
NEW 77	if ('PHP' === $entity) {	×
NEW 78	$version = $composerJsonReader->getPhp();	×
NEW 79	} elseif ('PHPUnit' === $entity) {	×
NEW 80	$version = $composerJsonReader->getPhpUnit();	×
81	} else {
NEW 82	throw new \InvalidArgumentException(\sprintf('Entity "%s" is not supported.', $entity));	×
83	}
84
NEW 85	if (null === $version) {	×
NEW 86	throw new UnresolvableAutoRuleSetConfigurationException(\sprintf('Cannot detect %s version from "composer.json".', $entity));	×
87	}
88
NEW 89	return $version;	×
90	}
91
92	/**
93	* @return array<string, string> [ 'major.minor' => '@SetName', ... ]
94	*/
95	private static function calculateCandidateSets(string $entity, bool $isRisky): array
96	{
NEW 97	$candidates = [];	×
NEW 98	foreach (self::getMigrationSets() as $set) {	×
NEW 99	if ($set->getEntity() !== $entity) {	×
NEW 100	continue;	×
101	}
102
NEW 103	if ($set->isRisky() !== $isRisky) {	×
NEW 104	continue;	×
105	}
106
NEW 107	$candidates[$set->getVersionMajorMinor()] = $set->getName();	×
108	}
109
NEW 110	return $candidates;	×
111	}
112	}

keradus / PHP-CS-Fixer / 17899394524

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous