* Dariusz Rumiński * * This source file is subject to the MIT license that is bundled * with this source code in the file LICENSE. */ namespace PhpCsFixer\Tests\DocBlock; use PhpCsFixer\DocBlock\TypeExpression; use PhpCsFixer\Tests\TestCase; use PhpCsFixer\Tokenizer\Analyzer\Analysis\NamespaceAnalysis; use PhpCsFixer\Tokenizer\Analyzer\Analysis\NamespaceUseAnalysis; /** * @covers \PhpCsFixer\DocBlock\TypeExpression * * @internal */ final class TypeExpressionTest extends TestCase { /** * @param string[] $expectedTypes * * @dataProvider provideGetTypesCases */ public function testGetTypes(string $typesExpression, array $expectedTypes): void { $expression = new TypeExpression($typesExpression, null, []); static::assertSame($expectedTypes, $expression->getTypes()); } public static function provideGetTypesCases(): iterable { yield ['int', ['int']]; yield ['Foo[][]', ['Foo[][]']]; yield ['int[]', ['int[]']]; yield ['int[]|null', ['int[]', 'null']]; yield ['int[]|null|?int|array', ['int[]', 'null', '?int', 'array']]; yield ['null|Foo\Bar|\Baz\Bax|int[]', ['null', 'Foo\Bar', '\Baz\Bax', 'int[]']]; yield ['gen', ['gen']]; yield ['int|gen', ['int', 'gen']]; yield ['\int|\gen<\int, \bool>', ['\int', '\gen<\int, \bool>']]; yield ['gen', ['gen']]; yield ['gen', ['gen']]; yield ['gen', ['gen']]; yield ['gen>', ['gen>']]; yield ['gen>', ['gen>']]; yield ['null|gen>|int|string[]', ['null', 'gen>', 'int', 'string[]']]; yield ['null|gen>|int|array|string[]', ['null', 'gen>', 'int', 'array', 'string[]']]; yield ['this', ['this']]; yield ['@this', ['@this']]; yield ['$SELF|int', ['$SELF', 'int']]; yield ['array', ['array']]; yield ['Collection, Foo>', ['Collection, Foo>']]; yield ['int | string', ['int', 'string']]; yield ['Foo::*', ['Foo::*']]; yield ['Foo::A', ['Foo::A']]; yield ['Foo::A|Foo::B', ['Foo::A', 'Foo::B']]; yield ['Foo::A*', ['Foo::A*']]; yield ['array|null', ['array', 'null']]; yield ['null|true|false|1|-1|1.5|-1.5|.5|1.|\'a\'|"b"', ['null', 'true', 'false', '1', '-1', '1.5', '-1.5', '.5', '1.', "'a'", '"b"']]; yield ['int | "a" | A, E>', ['int', '"a"', 'A, E>']]; yield ['class-string', ['class-string']]; yield ['A&B', ['A', 'B']]; yield ['A & B', ['A', 'B']]; yield ['array{1: bool, 2: bool}', ['array{1: bool, 2: bool}']]; yield ['array{a: int|string, b?: bool}', ['array{a: int|string, b?: bool}']]; yield ['array{\'a\': "a", "b"?: \'b\'}', ['array{\'a\': "a", "b"?: \'b\'}']]; yield ['array { a : int | string , b ? : A }', ['array { a : int | string , b ? : A }']]; yield ['callable(string)', ['callable(string)']]; yield ['callable(string): bool', ['callable(string): bool']]; yield ['callable(array, array): bool', ['callable(array, array): bool']]; yield ['array', ['array']]; yield ['callable(string): callable(int)', ['callable(string): callable(int)']]; yield ['callable(string) : callable(int) : bool', ['callable(string) : callable(int) : bool']]; yield ['TheCollection|string[]|null', ['TheCollection', 'string[]', 'null']]; yield ['Closure()', ['Closure()']]; yield ['Closure(string)', ['Closure(string)']]; yield ['\\Closure', ['\\Closure']]; yield ['\\Closure()', ['\\Closure()']]; yield ['\\Closure(string)', ['\\Closure(string)']]; yield ['\\Closure(string, bool)', ['\\Closure(string, bool)']]; yield ['\\Closure(string|int, bool)', ['\\Closure(string|int, bool)']]; yield ['\\Closure(string):bool', ['\\Closure(string):bool']]; yield ['\\Closure(string): bool', ['\\Closure(string): bool']]; yield ['\\Closure(string|int, bool): bool', ['\\Closure(string|int, bool): bool']]; yield ['array < int , callable ( string ) : bool >', ['array < int , callable ( string ) : bool >']]; } /** * @dataProvider provideGetTypesGlueCases */ public function testGetTypesGlue(string $expectedTypesGlue, string $typesExpression): void { $expression = new TypeExpression($typesExpression, null, []); static::assertSame($expectedTypesGlue, $expression->getTypesGlue()); } public static function provideGetTypesGlueCases(): iterable { yield ['|', 'string']; // for backward behaviour yield ['|', 'bool|string']; yield ['&', 'Foo&Bar']; } /** * @param NamespaceUseAnalysis[] $namespaceUses * * @dataProvider provideCommonTypeCases */ public function testGetCommonType(string $typesExpression, ?string $expectedCommonType, NamespaceAnalysis $namespace = null, array $namespaceUses = []): void { $expression = new TypeExpression($typesExpression, $namespace, $namespaceUses); static::assertSame($expectedCommonType, $expression->getCommonType()); } public static function provideCommonTypeCases(): iterable { $globalNamespace = new NamespaceAnalysis('', '', 0, 999, 0, 999); $appNamespace = new NamespaceAnalysis('App', 'App', 0, 999, 0, 999); $useTraversable = new NamespaceUseAnalysis('Traversable', 'Traversable', false, 0, 0, NamespaceUseAnalysis::TYPE_CLASS); $useObjectAsTraversable = new NamespaceUseAnalysis('Foo', 'Traversable', false, 0, 0, NamespaceUseAnalysis::TYPE_CLASS); yield ['true', 'bool']; yield ['false', 'bool']; yield ['bool', 'bool']; yield ['int', 'int']; yield ['float', 'float']; yield ['string', 'string']; yield ['array', 'array']; yield ['object', 'object']; yield ['self', 'self']; yield ['static', 'static']; yield ['bool[]', 'array']; yield ['int[]', 'array']; yield ['float[]', 'array']; yield ['string[]', 'array']; yield ['array[]', 'array']; yield ['bool[][]', 'array']; yield ['int[][]', 'array']; yield ['float[][]', 'array']; yield ['string[][]', 'array']; yield ['array[][]', 'array']; yield ['array|iterable', 'iterable']; yield ['iterable|array', 'iterable']; yield ['array|Traversable', 'iterable']; yield ['array|\Traversable', 'iterable']; yield ['array|Traversable', 'iterable', $globalNamespace]; yield ['iterable|Traversable', 'iterable']; yield ['array', 'array']; yield ['array', 'array']; yield ['iterable', 'iterable']; yield ['iterable', 'iterable']; yield ['\Traversable', '\Traversable']; yield ['Traversable', 'Traversable']; yield ['Collection', 'Collection']; yield ['Collection', 'Collection']; yield ['array|iterable', 'iterable']; yield ['int[]|string[]', 'array']; yield ['int|null', 'int']; yield ['null|int', 'int']; yield ['void', 'void']; yield ['never', 'never']; yield ['array|Traversable', 'iterable', null, [$useTraversable]]; yield ['array|Traversable', 'iterable', $globalNamespace, [$useTraversable]]; yield ['array|Traversable', 'iterable', $appNamespace, [$useTraversable]]; yield ['self|static', 'self']; yield ['array|Traversable', null, null, [$useObjectAsTraversable]]; yield ['array|Traversable', null, $globalNamespace, [$useObjectAsTraversable]]; yield ['array|Traversable', null, $appNamespace, [$useObjectAsTraversable]]; yield ['bool|int', null]; yield ['string|bool', null]; yield ['array|Collection', null]; } /** * @dataProvider provideAllowsNullCases */ public function testAllowsNull(string $typesExpression, bool $expectNullAllowed): void { $expression = new TypeExpression($typesExpression, null, []); static::assertSame($expectNullAllowed, $expression->allowsNull()); } public static function provideAllowsNullCases(): iterable { yield ['null', true]; yield ['mixed', true]; yield ['null|mixed', true]; yield ['int|bool|null', true]; yield ['int|bool|mixed', true]; yield ['int', false]; yield ['bool', false]; yield ['string', false]; } /** * @dataProvider provideSortTypesCases */ public function testSortTypes(string $typesExpression, string $expectResult): void { $expression = new TypeExpression($typesExpression, null, []); $expression->sortTypes(static function (TypeExpression $a, TypeExpression $b): int { return strcasecmp($a->toString(), $b->toString()); }); static::assertSame($expectResult, $expression->toString()); } public static function provideSortTypesCases(): iterable { yield 'not a union type' => [ 'int', 'int', ]; yield 'simple' => [ 'int|bool', 'bool|int', ]; yield 'simple in generic' => [ 'array', 'array', ]; yield 'generic with multiple types' => [ 'array', 'array', ]; yield 'simple in array shape with int key' => [ 'array{0: int|bool}', 'array{0: bool|int}', ]; yield 'simple in array shape with string key' => [ 'array{"foo": int|bool}', 'array{"foo": bool|int}', ]; yield 'simple in array shape with multiple keys' => [ 'array{0: int|bool, "foo": int|bool}', 'array{0: bool|int, "foo": bool|int}', ]; yield 'simple in callable argument' => [ 'callable(int|bool)', 'callable(bool|int)', ]; yield 'callable with multiple arguments' => [ 'callable(int|bool, null|array)', 'callable(bool|int, array|null)', ]; yield 'simple in callable return type' => [ 'callable(): string|float', 'callable(): float|string', ]; yield 'simple in closure argument' => [ 'Closure(int|bool)', 'Closure(bool|int)', ]; yield 'closure with multiple arguments' => [ 'Closure(int|bool, null|array)', 'Closure(bool|int, array|null)', ]; yield 'simple in closure return type' => [ 'Closure(): string|float', 'Closure(): float|string', ]; yield 'with multiple nesting levels' => [ 'array{0: Foo|Bar): Foo|Bar>}', 'array{0: Bar|float|string): Bar|Foo>|Foo}', ]; yield 'nullable generic' => [ '?array', '?array', ]; yield 'nullable callable' => [ '?callable(Foo|Bar): Foo|Bar', '?callable(Bar|Foo): Bar|Foo', ]; yield 'nullable array shape' => [ '?array{0: Foo|Bar}', '?array{0: Bar|Foo}', ]; yield 'simple types alternation' => [ 'array', 'array', ]; yield 'nesty stuff' => [ 'array>>', 'array|Level2>&Level11>', ]; } }