123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625 |
- <?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\Tests;
- use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
- use PhpCsFixer\Fixer\ConfigurableFixerInterface;
- use PhpCsFixer\Fixer\FixerInterface;
- use PhpCsFixer\Fixer\InternalFixerInterface;
- use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
- use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
- use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
- use PhpCsFixer\FixerFactory;
- use PhpCsFixer\RuleSet\RuleSet;
- use PhpCsFixer\RuleSet\RuleSetInterface;
- use PhpCsFixer\Tokenizer\Tokens;
- use PhpCsFixer\WhitespacesFixerConfig;
- /**
- * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * @internal
- *
- * @covers \PhpCsFixer\FixerFactory
- */
- final class FixerFactoryTest extends TestCase
- {
- public function testInterfaceIsFluent(): void
- {
- $factory = new FixerFactory();
- $testInstance = $factory->registerBuiltInFixers();
- self::assertSame($factory, $testInstance);
- $testInstance = $factory->registerCustomFixers(
- [$this->createFixerDouble('Foo/f1'), $this->createFixerDouble('Foo/f2')]
- );
- self::assertSame($factory, $testInstance);
- $testInstance = $factory->registerFixer(
- $this->createFixerDouble('f3'),
- false
- );
- self::assertSame($factory, $testInstance);
- $ruleSet = new class([]) implements RuleSetInterface {
- /** @var array<string, array<string, mixed>|true> */
- private array $set;
- /** @param array<string, array<string, mixed>|true> $set */
- public function __construct(array $set = [])
- {
- $this->set = $set;
- }
- public function getRuleConfiguration(string $rule): ?array
- {
- throw new \LogicException('Not implemented.');
- }
- public function getRules(): array
- {
- return $this->set;
- }
- public function hasRule(string $rule): bool
- {
- throw new \LogicException('Not implemented.');
- }
- };
- $testInstance = $factory->useRuleSet(
- $ruleSet
- );
- self::assertSame($factory, $testInstance);
- }
- /**
- * @covers \PhpCsFixer\FixerFactory::registerBuiltInFixers
- */
- public function testRegisterBuiltInFixers(): void
- {
- $factory = new FixerFactory();
- $factory->registerBuiltInFixers();
- $fixerClasses = array_filter(
- get_declared_classes(),
- static function (string $className): bool {
- $class = new \ReflectionClass($className);
- return !$class->isAbstract()
- && !$class->isAnonymous()
- && $class->implementsInterface(FixerInterface::class)
- && !$class->implementsInterface(InternalFixerInterface::class)
- && str_starts_with($class->getNamespaceName(), 'PhpCsFixer\Fixer\\');
- }
- );
- sort($fixerClasses);
- $fixers = array_map(
- static fn (FixerInterface $fixer): string => \get_class($fixer),
- $factory->getFixers()
- );
- sort($fixers);
- self::assertSame($fixerClasses, $fixers);
- }
- /**
- * @covers \PhpCsFixer\FixerFactory::getFixers
- */
- public function testThatFixersAreSorted(): void
- {
- $factory = new FixerFactory();
- $fxs = [
- $this->createFixerDouble('f1', 0),
- $this->createFixerDouble('f2', -10),
- $this->createFixerDouble('f3', 10),
- $this->createFixerDouble('f4', -10),
- ];
- foreach ($fxs as $fx) {
- $factory->registerFixer($fx, false);
- }
- // There are no rules that forces $fxs[1] to be prioritized before $fxs[3]. We should not test against that
- self::assertSame([$fxs[2], $fxs[0]], \array_slice($factory->getFixers(), 0, 2));
- }
- /**
- * @covers \PhpCsFixer\FixerFactory::getFixers
- * @covers \PhpCsFixer\FixerFactory::registerCustomFixers
- * @covers \PhpCsFixer\FixerFactory::registerFixer
- */
- public function testThatCanRegisterAndGetFixers(): void
- {
- $factory = new FixerFactory();
- $f1 = $this->createFixerDouble('f1');
- $f2 = $this->createFixerDouble('Foo/f2');
- $f3 = $this->createFixerDouble('Foo/f3');
- $factory->registerFixer($f1, false);
- $factory->registerCustomFixers([$f2, $f3]);
- self::assertTrue(\in_array($f1, $factory->getFixers(), true));
- self::assertTrue(\in_array($f2, $factory->getFixers(), true));
- self::assertTrue(\in_array($f3, $factory->getFixers(), true));
- }
- /**
- * @covers \PhpCsFixer\FixerFactory::registerFixer
- */
- public function testRegisterFixerWithOccupiedName(): void
- {
- $this->expectException(\UnexpectedValueException::class);
- $this->expectExceptionMessage('Fixer named "non_unique_name" is already registered.');
- $factory = new FixerFactory();
- $f1 = $this->createFixerDouble('non_unique_name');
- $f2 = $this->createFixerDouble('non_unique_name');
- $factory->registerFixer($f1, false);
- $factory->registerFixer($f2, false);
- }
- /**
- * @covers \PhpCsFixer\FixerFactory::useRuleSet
- */
- public function testUseRuleSet(): void
- {
- $factory = (new FixerFactory())
- ->registerBuiltInFixers()
- ->useRuleSet(new RuleSet([]))
- ;
- self::assertCount(0, $factory->getFixers());
- $factory = (new FixerFactory())
- ->registerBuiltInFixers()
- ->useRuleSet(new RuleSet(['strict_comparison' => true, 'blank_line_before_statement' => false]))
- ;
- $fixers = $factory->getFixers();
- self::assertCount(1, $fixers);
- self::assertSame('strict_comparison', $fixers[0]->getName());
- }
- /**
- * @covers \PhpCsFixer\FixerFactory::useRuleSet
- */
- public function testUseRuleSetWithNonExistingRule(): void
- {
- $this->expectException(\UnexpectedValueException::class);
- $this->expectExceptionMessage('Rule "non_existing_rule" does not exist.');
- $factory = (new FixerFactory())
- ->registerBuiltInFixers()
- ->useRuleSet(new RuleSet(['non_existing_rule' => true]))
- ;
- $factory->getFixers();
- }
- /**
- * @covers \PhpCsFixer\FixerFactory::useRuleSet
- */
- public function testUseRuleSetWithInvalidConfigForRule(): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessage('Configuration must be an array and may not be empty.');
- $testRuleSet = new class implements RuleSetInterface {
- public function __construct(array $set = [])
- {
- if ([] !== $set) {
- throw new \RuntimeException('Set is not used in test.');
- }
- }
- /**
- * @return array<string, mixed>
- */
- public function getRuleConfiguration(string $rule): ?array
- {
- if (!$this->hasRule($rule)) {
- throw new \InvalidArgumentException(\sprintf('Rule "%s" is not in the set.', $rule));
- }
- if (true === $this->getRules()[$rule]) {
- return null;
- }
- return $this->getRules()[$rule];
- }
- public function getRules(): array
- {
- return ['header_comment' => []];
- }
- public function hasRule(string $rule): bool
- {
- return isset($this->getRules()[$rule]);
- }
- };
- $factory = (new FixerFactory())
- ->registerBuiltInFixers()
- ->useRuleSet($testRuleSet)
- ;
- $factory->getFixers();
- }
- public function testHasRule(): void
- {
- $factory = new FixerFactory();
- $f1 = $this->createFixerDouble('f1');
- $f2 = $this->createFixerDouble('Foo/f2');
- $f3 = $this->createFixerDouble('Foo/f3');
- $factory->registerFixer($f1, false);
- $factory->registerCustomFixers([$f2, $f3]);
- self::assertTrue($factory->hasRule('f1'), 'Should have f1 fixer');
- self::assertTrue($factory->hasRule('Foo/f2'), 'Should have f2 fixer');
- self::assertTrue($factory->hasRule('Foo/f3'), 'Should have f3 fixer');
- self::assertFalse($factory->hasRule('dummy'), 'Should not have dummy fixer');
- }
- public function testHasRuleWithChangedRuleSet(): void
- {
- $factory = new FixerFactory();
- $f1 = $this->createFixerDouble('f1');
- $f2 = $this->createFixerDouble('f2');
- $factory->registerFixer($f1, false);
- $factory->registerFixer($f2, false);
- self::assertTrue($factory->hasRule('f1'), 'Should have f1 fixer');
- self::assertTrue($factory->hasRule('f2'), 'Should have f2 fixer');
- $factory->useRuleSet(new RuleSet(['f2' => true]));
- self::assertFalse($factory->hasRule('f1'), 'Should not have f1 fixer');
- self::assertTrue($factory->hasRule('f2'), 'Should have f2 fixer');
- }
- /**
- * @dataProvider provideConflictingFixersCases
- */
- public function testConflictingFixers(RuleSet $ruleSet): void
- {
- $this->expectException(\UnexpectedValueException::class);
- $this->expectExceptionMessageMatches('#^Rule contains conflicting fixers:\n#');
- (new FixerFactory())
- ->registerBuiltInFixers()->useRuleSet($ruleSet)
- ;
- }
- /**
- * @return iterable<array{RuleSet}>
- */
- public static function provideConflictingFixersCases(): iterable
- {
- yield [new RuleSet(['no_blank_lines_before_namespace' => true, 'single_blank_line_before_namespace' => true])];
- yield [new RuleSet(['single_blank_line_before_namespace' => true, 'no_blank_lines_before_namespace' => true])];
- }
- public function testNoDoubleConflictReporting(): void
- {
- $factory = new FixerFactory();
- $method = new \ReflectionMethod($factory, 'generateConflictMessage');
- $method->setAccessible(true);
- self::assertSame(
- 'Rule contains conflicting fixers:
- - "a" with "b"
- - "c" with "d", "e" and "f"
- - "d" with "g" and "h"
- - "e" with "a"',
- $method->invoke(
- $factory,
- [
- 'a' => ['b'],
- 'b' => ['a'],
- 'c' => ['d', 'e', 'f'],
- 'd' => ['c', 'g', 'h'],
- 'e' => ['a'],
- ]
- )
- );
- }
- public function testSetWhitespacesConfig(): void
- {
- $factory = new FixerFactory();
- $config = new WhitespacesFixerConfig();
- $fixer = new class($config) implements WhitespacesAwareFixerInterface {
- private WhitespacesFixerConfig $config;
- public function __construct(WhitespacesFixerConfig $config)
- {
- $this->config = $config;
- }
- public function isCandidate(Tokens $tokens): bool
- {
- throw new \LogicException('Not implemented.');
- }
- public function isRisky(): bool
- {
- throw new \LogicException('Not implemented.');
- }
- public function fix(\SplFileInfo $file, Tokens $tokens): void
- {
- throw new \LogicException('Not implemented.');
- }
- public function getDefinition(): FixerDefinitionInterface
- {
- throw new \LogicException('Not implemented.');
- }
- public function getName(): string
- {
- return 'foo';
- }
- public function getPriority(): int
- {
- throw new \LogicException('Not implemented.');
- }
- public function supports(\SplFileInfo $file): bool
- {
- throw new \LogicException('Not implemented.');
- }
- public function setWhitespacesConfig(WhitespacesFixerConfig $config): void
- {
- TestCase::assertSame($this->config, $config);
- }
- };
- $factory->registerFixer($fixer, false);
- $factory->setWhitespacesConfig($config);
- }
- public function testRegisterFixerInvalidName(): void
- {
- $factory = new FixerFactory();
- $fixer = $this->createFixerDouble('0');
- $this->expectException(\UnexpectedValueException::class);
- $this->expectExceptionMessage('Fixer named "0" has invalid name.');
- $factory->registerFixer($fixer, false);
- }
- public function testConfigureNonConfigurableFixer(): void
- {
- $factory = new FixerFactory();
- $fixer = $this->createFixerDouble('non_configurable');
- $factory->registerFixer($fixer, false);
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessage('[non_configurable] Is not configurable.');
- $factory->useRuleSet(new RuleSet([
- 'non_configurable' => ['bar' => 'baz'],
- ]));
- }
- /**
- * @param mixed $value
- *
- * @dataProvider provideConfigureFixerWithNonArrayCases
- */
- public function testConfigureFixerWithNonArray($value): void
- {
- $factory = new FixerFactory();
- $fixer = new class implements ConfigurableFixerInterface {
- public function configure(array $configuration): void
- {
- throw new \LogicException('Not implemented.');
- }
- public function getConfigurationDefinition(): FixerConfigurationResolverInterface
- {
- throw new \LogicException('Not implemented.');
- }
- public function isCandidate(Tokens $tokens): bool
- {
- throw new \LogicException('Not implemented.');
- }
- public function isRisky(): bool
- {
- throw new \LogicException('Not implemented.');
- }
- public function fix(\SplFileInfo $file, Tokens $tokens): void
- {
- throw new \LogicException('Not implemented.');
- }
- public function getDefinition(): FixerDefinitionInterface
- {
- throw new \LogicException('Not implemented.');
- }
- public function getName(): string
- {
- return 'foo';
- }
- public function getPriority(): int
- {
- throw new \LogicException('Not implemented.');
- }
- public function supports(\SplFileInfo $file): bool
- {
- throw new \LogicException('Not implemented.');
- }
- };
- $factory->registerFixer($fixer, false);
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessage(
- '[foo] Rule must be enabled (true), disabled (false) or configured (non-empty, assoc array). Other values are not allowed.'
- );
- $factory->useRuleSet(new RuleSet([
- 'foo' => $value,
- ]));
- }
- /**
- * @return iterable<array{float|int|\stdClass|string}>
- */
- public static function provideConfigureFixerWithNonArrayCases(): iterable
- {
- yield ['bar'];
- yield [new \stdClass()];
- yield [5];
- yield [5.5];
- }
- public function testConfigurableFixerIsConfigured(): void
- {
- $fixer = new class implements ConfigurableFixerInterface {
- public function configure(array $configuration): void
- {
- TestCase::assertSame(['bar' => 'baz'], $configuration);
- }
- public function getConfigurationDefinition(): FixerConfigurationResolverInterface
- {
- throw new \LogicException('Not implemented.');
- }
- public function isCandidate(Tokens $tokens): bool
- {
- throw new \LogicException('Not implemented.');
- }
- public function isRisky(): bool
- {
- throw new \LogicException('Not implemented.');
- }
- public function fix(\SplFileInfo $file, Tokens $tokens): void
- {
- throw new \LogicException('Not implemented.');
- }
- public function getDefinition(): FixerDefinitionInterface
- {
- throw new \LogicException('Not implemented.');
- }
- public function getName(): string
- {
- return 'foo';
- }
- public function getPriority(): int
- {
- throw new \LogicException('Not implemented.');
- }
- public function supports(\SplFileInfo $file): bool
- {
- throw new \LogicException('Not implemented.');
- }
- };
- $factory = new FixerFactory();
- $factory->registerFixer($fixer, false);
- $factory->useRuleSet(new RuleSet([
- 'foo' => ['bar' => 'baz'],
- ]));
- }
- private function createFixerDouble(string $name, int $priority = 0): FixerInterface
- {
- return new class($name, $priority) implements FixerInterface {
- private string $name;
- private int $priority;
- public function __construct(string $name, int $priority)
- {
- $this->name = $name;
- $this->priority = $priority;
- }
- public function isCandidate(Tokens $tokens): bool
- {
- throw new \LogicException('Not implemented.');
- }
- public function isRisky(): bool
- {
- throw new \LogicException('Not implemented.');
- }
- public function fix(\SplFileInfo $file, Tokens $tokens): void
- {
- throw new \LogicException('Not implemented.');
- }
- public function getDefinition(): FixerDefinitionInterface
- {
- throw new \LogicException('Not implemented.');
- }
- public function getName(): string
- {
- return $this->name;
- }
- public function getPriority(): int
- {
- return $this->priority;
- }
- public function supports(\SplFileInfo $file): bool
- {
- throw new \LogicException('Not implemented.');
- }
- };
- }
- }
|