mirror of
https://github.com/danog/psalm.git
synced 2024-11-27 12:55:26 +01:00
844 lines
27 KiB
PHP
844 lines
27 KiB
PHP
<?php
|
||
namespace Psalm\Tests;
|
||
|
||
class TemplateTest extends TestCase
|
||
{
|
||
use Traits\FileCheckerInvalidCodeParseTestTrait;
|
||
use Traits\FileCheckerValidCodeParseTestTrait;
|
||
|
||
/**
|
||
* @return array
|
||
*/
|
||
public function providerFileCheckerValidCodeParse()
|
||
{
|
||
return [
|
||
'classTemplate' => [
|
||
'<?php
|
||
class A {}
|
||
class B {}
|
||
class C {}
|
||
class D {}
|
||
|
||
/**
|
||
* @template T as object
|
||
*/
|
||
class Foo {
|
||
/** @var string */
|
||
public $T;
|
||
|
||
/**
|
||
* @param string $T
|
||
* @template-typeof T $T
|
||
*/
|
||
public function __construct(string $T) {
|
||
$this->T = $T;
|
||
}
|
||
|
||
/**
|
||
* @return T
|
||
*/
|
||
public function bar() {
|
||
$t = $this->T;
|
||
return new $t();
|
||
}
|
||
}
|
||
|
||
$at = "A";
|
||
|
||
/** @var Foo<A> */
|
||
$afoo = new Foo($at);
|
||
$afoo_bar = $afoo->bar();
|
||
|
||
$bfoo = new Foo(B::class);
|
||
$bfoo_bar = $bfoo->bar();
|
||
|
||
// this shouldn’t cause a problem as it’s a docbblock type
|
||
if (!($bfoo_bar instanceof B)) {}
|
||
|
||
$cfoo = new Foo("C");
|
||
$cfoo_bar = $cfoo->bar();
|
||
|
||
$dt = "D";
|
||
$dfoo = new Foo($dt);',
|
||
'assertions' => [
|
||
'$afoo' => 'Foo<A>',
|
||
'$afoo_bar' => 'A',
|
||
|
||
'$bfoo' => 'Foo<B>',
|
||
'$bfoo_bar' => 'B',
|
||
|
||
'$cfoo' => 'Foo<C>',
|
||
'$cfoo_bar' => 'C',
|
||
|
||
'$dfoo' => 'Foo<mixed>',
|
||
],
|
||
'error_levels' => [
|
||
'MixedReturnStatement',
|
||
'LessSpecificReturnStatement',
|
||
'RedundantConditionGivenDocblockType',
|
||
],
|
||
],
|
||
'classTemplateSelfs' => [
|
||
'<?php
|
||
/**
|
||
* @template T as object
|
||
*/
|
||
class Foo {
|
||
/** @var string */
|
||
public $T;
|
||
|
||
/**
|
||
* @param string $T
|
||
* @template-typeof T $T
|
||
*/
|
||
public function __construct(string $T) {
|
||
$this->T = $T;
|
||
}
|
||
|
||
/**
|
||
* @return T
|
||
*/
|
||
public function bar() {
|
||
$t = $this->T;
|
||
return new $t();
|
||
}
|
||
}
|
||
|
||
class E {
|
||
/**
|
||
* @return Foo<self>
|
||
*/
|
||
public static function getFoo() {
|
||
return new Foo(__CLASS__);
|
||
}
|
||
|
||
/**
|
||
* @return Foo<self>
|
||
*/
|
||
public static function getFoo2() {
|
||
return new Foo(self::class);
|
||
}
|
||
|
||
/**
|
||
* @return Foo<static>
|
||
*/
|
||
public static function getFoo3() {
|
||
return new Foo(static::class);
|
||
}
|
||
}
|
||
|
||
class G extends E {}
|
||
|
||
$efoo = E::getFoo();
|
||
$efoo2 = E::getFoo2();
|
||
$efoo3 = E::getFoo3();
|
||
|
||
$gfoo = G::getFoo();
|
||
$gfoo2 = G::getFoo2();
|
||
$gfoo3 = G::getFoo3();',
|
||
'assertions' => [
|
||
'$efoo' => 'Foo<E>',
|
||
'$efoo2' => 'Foo<E>',
|
||
'$efoo3' => 'Foo<E>',
|
||
'$gfoo' => 'Foo<E>',
|
||
'$gfoo2' => 'Foo<E>',
|
||
'$gfoo3' => 'Foo<G>',
|
||
],
|
||
'error_levels' => [
|
||
'MixedReturnStatement',
|
||
'LessSpecificReturnStatement',
|
||
'RedundantConditionGivenDocblockType',
|
||
],
|
||
],
|
||
'classTemplateExternalClasses' => [
|
||
'<?php
|
||
/**
|
||
* @template T as object
|
||
*/
|
||
class Foo {
|
||
/** @var string */
|
||
public $T;
|
||
|
||
/**
|
||
* @param string $T
|
||
* @template-typeof T $T
|
||
*/
|
||
public function __construct(string $T) {
|
||
$this->T = $T;
|
||
}
|
||
|
||
/**
|
||
* @return T
|
||
*/
|
||
public function bar() {
|
||
$t = $this->T;
|
||
return new $t();
|
||
}
|
||
}
|
||
|
||
$efoo = new Foo(Exception::class)
|
||
$efoo_bar = $efoo->bar();
|
||
|
||
$ffoo = new Foo("LogicException");
|
||
$ffoo_bar = $ffoo->bar();',
|
||
'assertions' => [
|
||
'$efoo' => 'Foo<Exception>',
|
||
'$efoo_bar' => 'Exception',
|
||
|
||
'$ffoo' => 'Foo<LogicException>',
|
||
'$ffoo_bar' => 'LogicException',
|
||
],
|
||
'error_levels' => ['MixedReturnStatement', 'LessSpecificReturnStatement'],
|
||
],
|
||
'classTemplateContainer' => [
|
||
'<?php
|
||
class A {}
|
||
|
||
/**
|
||
* @template T
|
||
*/
|
||
class Foo {
|
||
/** @var T */
|
||
public $obj;
|
||
|
||
/**
|
||
* @param T $obj
|
||
*/
|
||
public function __construct($obj) {
|
||
$this->obj = $obj;
|
||
}
|
||
|
||
/**
|
||
* @return T
|
||
*/
|
||
public function bar() {
|
||
return $this->obj;
|
||
}
|
||
|
||
/**
|
||
* @return T
|
||
*/
|
||
public function bat() {
|
||
return $this->bar();
|
||
}
|
||
|
||
public function __toString(): string {
|
||
return "hello " . $this->obj;
|
||
}
|
||
}
|
||
|
||
$afoo = new Foo(new A());
|
||
$afoo_bar = $afoo->bar();',
|
||
'assertions' => [
|
||
'$afoo' => 'Foo<A>',
|
||
'$afoo_bar' => 'A',
|
||
],
|
||
'error_levels' => ['MixedOperand'],
|
||
],
|
||
'phanTuple' => [
|
||
'<?php
|
||
namespace Phan\Library;
|
||
|
||
/**
|
||
* An abstract tuple.
|
||
*/
|
||
abstract class Tuple
|
||
{
|
||
const ARITY = 0;
|
||
|
||
/**
|
||
* @return int
|
||
* The arity of this tuple
|
||
*/
|
||
public function arity(): int
|
||
{
|
||
return (int)static::ARITY;
|
||
}
|
||
|
||
/**
|
||
* @return array
|
||
* An array of all elements in this tuple.
|
||
*/
|
||
abstract public function toArray(): array;
|
||
}
|
||
|
||
/**
|
||
* A tuple of 1 element.
|
||
*
|
||
* @template T0
|
||
* The type of element zero
|
||
*/
|
||
class Tuple1 extends Tuple
|
||
{
|
||
/** @var int */
|
||
const ARITY = 1;
|
||
|
||
/** @var T0 */
|
||
public $_0;
|
||
|
||
/**
|
||
* @param T0 $_0
|
||
* The 0th element
|
||
*/
|
||
public function __construct($_0) {
|
||
$this->_0 = $_0;
|
||
}
|
||
|
||
/**
|
||
* @return int
|
||
* The arity of this tuple
|
||
*/
|
||
public function arity(): int
|
||
{
|
||
return (int)static::ARITY;
|
||
}
|
||
|
||
/**
|
||
* @return array
|
||
* An array of all elements in this tuple.
|
||
*/
|
||
public function toArray(): array
|
||
{
|
||
return [
|
||
$this->_0,
|
||
];
|
||
}
|
||
}
|
||
|
||
/**
|
||
* A tuple of 2 elements.
|
||
*
|
||
* @template T0
|
||
* The type of element zero
|
||
*
|
||
* @template T1
|
||
* The type of element one
|
||
*
|
||
* @inherits Tuple1<T0>
|
||
*/
|
||
class Tuple2 extends Tuple1
|
||
{
|
||
/** @var int */
|
||
const ARITY = 2;
|
||
|
||
/** @var T1 */
|
||
public $_1;
|
||
|
||
/**
|
||
* @param T0 $_0
|
||
* The 0th element
|
||
*
|
||
* @param T1 $_1
|
||
* The 1st element
|
||
*/
|
||
public function __construct($_0, $_1) {
|
||
parent::__construct($_0);
|
||
$this->_1 = $_1;
|
||
}
|
||
|
||
/**
|
||
* @return array
|
||
* An array of all elements in this tuple.
|
||
*/
|
||
public function toArray(): array
|
||
{
|
||
return [
|
||
$this->_0,
|
||
$this->_1,
|
||
];
|
||
}
|
||
}
|
||
|
||
$a = new Tuple2("cool", 5);
|
||
|
||
/** @return void */
|
||
function takes_int(int $i) {}
|
||
|
||
/** @return void */
|
||
function takes_string(string $s) {}
|
||
|
||
takes_string($a->_0);
|
||
takes_int($a->_1);',
|
||
],
|
||
'validTemplatedType' => [
|
||
'<?php
|
||
namespace FooFoo;
|
||
|
||
/**
|
||
* @template T
|
||
* @param T $x
|
||
* @return T
|
||
*/
|
||
function foo($x) {
|
||
return $x;
|
||
}
|
||
|
||
function bar(string $a): void { }
|
||
|
||
bar(foo("string"));',
|
||
],
|
||
'validTemplatedStaticMethodType' => [
|
||
'<?php
|
||
namespace FooFoo;
|
||
|
||
class A {
|
||
/**
|
||
* @template T
|
||
* @param T $x
|
||
* @return T
|
||
*/
|
||
public static function foo($x) {
|
||
return $x;
|
||
}
|
||
}
|
||
|
||
function bar(string $a): void { }
|
||
|
||
bar(A::foo("string"));',
|
||
],
|
||
'validTemplatedInstanceMethodType' => [
|
||
'<?php
|
||
namespace FooFoo;
|
||
|
||
class A {
|
||
/**
|
||
* @template T
|
||
* @param T $x
|
||
* @return T
|
||
*/
|
||
public function foo($x) {
|
||
return $x;
|
||
}
|
||
}
|
||
|
||
function bar(string $a): void { }
|
||
|
||
bar((new A())->foo("string"));',
|
||
],
|
||
'genericArrayKeys' => [
|
||
'<?php
|
||
/**
|
||
* @template T
|
||
*
|
||
* @param array<T, mixed> $arr
|
||
* @return array<int, T>
|
||
*/
|
||
function my_array_keys($arr) {
|
||
return array_keys($arr);
|
||
}
|
||
|
||
$a = my_array_keys(["hello" => 5, "goodbye" => new \Exception()]);',
|
||
'assertions' => [
|
||
'$a' => 'array<int, string>',
|
||
],
|
||
],
|
||
'genericArrayFlip' => [
|
||
'<?php
|
||
/**
|
||
* @template TKey
|
||
* @template TValue
|
||
*
|
||
* @param array<TKey, TValue> $arr
|
||
* @return array<TValue, TKey>
|
||
*/
|
||
function my_array_flip($arr) {
|
||
return array_flip($arr);
|
||
}
|
||
|
||
$b = my_array_flip(["hello" => 5, "goodbye" => 6]);',
|
||
'assertions' => [
|
||
'$b' => 'array<int, string>',
|
||
],
|
||
],
|
||
'genericArrayPop' => [
|
||
'<?php
|
||
/**
|
||
* @template TValue
|
||
*
|
||
* @param array<mixed, TValue> $arr
|
||
* @return TValue|null
|
||
*/
|
||
function my_array_pop(array &$arr) {
|
||
return array_pop($arr);
|
||
}
|
||
|
||
/** @var mixed */
|
||
$b = ["a" => 5, "c" => 6];
|
||
$a = my_array_pop($b);',
|
||
'assertions' => [
|
||
'$a' => 'mixed',
|
||
'$b' => 'array<mixed, mixed>',
|
||
],
|
||
'error_levels' => ['MixedAssignment', 'MixedArgument'],
|
||
],
|
||
'intersectionTemplatedTypes' => [
|
||
'<?php
|
||
namespace NS;
|
||
use Countable;
|
||
|
||
/** @template T */
|
||
class Collection
|
||
{
|
||
/** @psalm-var iterable<T> */
|
||
private $data;
|
||
|
||
/** @psalm-param iterable<T> $data */
|
||
public function __construct(iterable $data) {
|
||
$this->data = $data;
|
||
}
|
||
}
|
||
|
||
class Item {}
|
||
/** @psalm-param Collection<Item> $c */
|
||
function takesCollectionOfItems(Collection $c): void {}
|
||
|
||
/** @psalm-var iterable<Item> $data2 */
|
||
$data2 = [];
|
||
takesCollectionOfItems(new Collection($data2));
|
||
|
||
/** @psalm-var iterable<Item>&Countable $data */
|
||
$data = [];
|
||
takesCollectionOfItems(new Collection($data));',
|
||
],
|
||
'templateCallableReturnType' => [
|
||
'<?php
|
||
namespace NS;
|
||
|
||
/**
|
||
* @template T
|
||
* @psalm-param callable():T $action
|
||
* @psalm-return T
|
||
*/
|
||
function retry(int $maxRetries, callable $action) {
|
||
return $action();
|
||
}
|
||
|
||
function takesInt(int $p): void{};
|
||
|
||
takesInt(retry(1, function(): int { return 1; }));',
|
||
],
|
||
'templateClosureReturnType' => [
|
||
'<?php
|
||
namespace NS;
|
||
|
||
/**
|
||
* @template T
|
||
* @psalm-param \Closure():T $action
|
||
* @psalm-return T
|
||
*/
|
||
function retry(int $maxRetries, callable $action) {
|
||
return $action();
|
||
}
|
||
|
||
function takesInt(int $p): void{};
|
||
|
||
takesInt(retry(1, function(): int { return 1; }));',
|
||
],
|
||
'repeatedCall' => [
|
||
'<?php
|
||
namespace NS;
|
||
|
||
use Closure;
|
||
|
||
/**
|
||
* @template TKey
|
||
* @template TValue
|
||
*/
|
||
class ArrayCollection {
|
||
/** @var array<TKey,TValue> */
|
||
private $data;
|
||
|
||
/** @param array<TKey,TValue> $data */
|
||
public function __construct(array $data) {
|
||
$this->data = $data;
|
||
}
|
||
|
||
/**
|
||
* @template T
|
||
* @param Closure(TValue):T $func
|
||
* @return ArrayCollection<TKey,T>
|
||
*/
|
||
public function map(Closure $func) {
|
||
return new static(array_map($func, $this->data));
|
||
}
|
||
}
|
||
|
||
class Item {}
|
||
/**
|
||
* @param ArrayCollection<mixed,Item> $i
|
||
*/
|
||
function takesCollectionOfItems(ArrayCollection $i): void {}
|
||
|
||
$c = new ArrayCollection([ new Item ]);
|
||
takesCollectionOfItems($c);
|
||
takesCollectionOfItems($c->map(function(Item $i): Item { return $i;}));
|
||
takesCollectionOfItems($c->map(function(Item $i): Item { return $i;}));'
|
||
],
|
||
'replaceChildType' => [
|
||
'<?php
|
||
/**
|
||
* @template TKey
|
||
* @template TValue
|
||
* @param Traversable<TKey, TValue> $t
|
||
* @return array<TKey, TValue>
|
||
*/
|
||
function f(Traversable $t): array {
|
||
$ret = [];
|
||
foreach ($t as $k => $v) $ret[$k] = $v;
|
||
return $ret;
|
||
}
|
||
|
||
/** @return Generator<int, stdClass> */
|
||
function g():Generator { yield new stdClass; }
|
||
|
||
takesArrayOfStdClass(f(g()));
|
||
|
||
/** @param array<stdClass> $p */
|
||
function takesArrayOfStdClass(array $p): void {}',
|
||
],
|
||
'noRepeatedTypeException' => [
|
||
'<?php
|
||
/** @template T */
|
||
class Foo
|
||
{
|
||
/**
|
||
* @psalm-var class-string
|
||
*/
|
||
private $type;
|
||
|
||
/** @var array<T> */
|
||
private $items;
|
||
|
||
/**
|
||
* @param class-string $type
|
||
* @template-typeof T $type
|
||
*/
|
||
public function __construct(string $type)
|
||
{
|
||
if (!in_array($type, [A::class, B::class], true)) {
|
||
throw new \InvalidArgumentException;
|
||
}
|
||
$this->type = $type;
|
||
$this->items = [];
|
||
}
|
||
|
||
/** @param T $item */
|
||
public function add($item): void
|
||
{
|
||
$this->items[] = $item;
|
||
}
|
||
}
|
||
|
||
class FooFacade
|
||
{
|
||
/**
|
||
* @template T
|
||
* @param T $item
|
||
*/
|
||
public function add($item): void
|
||
{
|
||
$foo = $this->ensureFoo([$item]);
|
||
$foo->add($item);
|
||
}
|
||
|
||
/**
|
||
* @template T
|
||
* @param array<mixed,T> $items
|
||
* @return Foo<T>
|
||
*/
|
||
private function ensureFoo(array $items): EntitySeries
|
||
{
|
||
$type = $items[0] instanceof A ? A::class : B::class;
|
||
return new Foo($type);
|
||
}
|
||
}
|
||
|
||
class A {}
|
||
class B {}'
|
||
],
|
||
'collectionOfClosure' => [
|
||
'<?php
|
||
/**
|
||
* @template TKey
|
||
* @template TValue
|
||
*/
|
||
class Collection {
|
||
/**
|
||
* @param Closure(TValue):bool $p
|
||
* @return Collection<TKey,TValue>
|
||
*/
|
||
public function filter(Closure $p);
|
||
}
|
||
class I {}
|
||
|
||
/** @var Collection<mixed,Collection<mixed,I>> $c */
|
||
$c = new Collection;
|
||
|
||
$c->filter(
|
||
/** @param Collection<mixed,I> $elt */
|
||
function(Collection $elt): bool { return (bool) rand(0,1); }
|
||
);
|
||
|
||
$c->filter(
|
||
/** @param Collection<mixed,I> $elt */
|
||
function(Collection $elt): bool { return true; }
|
||
);',
|
||
],
|
||
'splatTemplateParam' => [
|
||
'<?php
|
||
/**
|
||
* @template TKey
|
||
* @template TValue
|
||
*
|
||
* @param array<TKey, TValue> $arr
|
||
* @param array $arr2
|
||
* @return array<TKey, TValue>
|
||
*/
|
||
function splat_proof(array $arr, array $arr2) {
|
||
return $arr;
|
||
}
|
||
|
||
$foo = [
|
||
[1, 2, 3],
|
||
[1, 2],
|
||
];
|
||
|
||
$a = splat_proof(... $foo);',
|
||
'assertions' => [
|
||
'$a' => 'array<int, int>',
|
||
],
|
||
],
|
||
];
|
||
}
|
||
|
||
/**
|
||
* @return array
|
||
*/
|
||
public function providerFileCheckerInvalidCodeParse()
|
||
{
|
||
return [
|
||
'invalidTemplatedType' => [
|
||
'<?php
|
||
namespace FooFoo;
|
||
|
||
/**
|
||
* @template T
|
||
* @param T $x
|
||
* @return T
|
||
*/
|
||
function foo($x) {
|
||
return $x;
|
||
}
|
||
|
||
function bar(string $a): void { }
|
||
|
||
bar(foo(4));',
|
||
'error_message' => 'InvalidScalarArgument',
|
||
],
|
||
'invalidTemplatedStaticMethodType' => [
|
||
'<?php
|
||
namespace FooFoo;
|
||
|
||
class A {
|
||
/**
|
||
* @template T
|
||
* @param T $x
|
||
* @return T
|
||
*/
|
||
public static function foo($x) {
|
||
return $x;
|
||
}
|
||
}
|
||
|
||
function bar(string $a): void { }
|
||
|
||
bar(A::foo(4));',
|
||
'error_message' => 'InvalidScalarArgument',
|
||
],
|
||
'invalidTemplatedInstanceMethodType' => [
|
||
'<?php
|
||
namespace FooFoo;
|
||
|
||
class A {
|
||
/**
|
||
* @template T
|
||
* @param T $x
|
||
* @return T
|
||
*/
|
||
public function foo($x) {
|
||
return $x;
|
||
}
|
||
}
|
||
|
||
function bar(string $a): void { }
|
||
|
||
bar((new A())->foo(4));',
|
||
'error_message' => 'InvalidScalarArgument',
|
||
],
|
||
'replaceChildTypeNoHint' => [
|
||
'<?php
|
||
/**
|
||
* @template TKey
|
||
* @template TValue
|
||
* @param Traversable<TKey, TValue> $t
|
||
* @return array<TKey, TValue>
|
||
*/
|
||
function f(Traversable $t): array {
|
||
$ret = [];
|
||
foreach ($t as $k => $v) $ret[$k] = $v;
|
||
return $ret;
|
||
}
|
||
|
||
function g():Generator { yield new stdClass; }
|
||
|
||
takesArrayOfStdClass(f(g()));
|
||
|
||
/** @param array<stdClass> $p */
|
||
function takesArrayOfStdClass(array $p): void {}',
|
||
'error_message' => 'MixedTypeCoercion',
|
||
],
|
||
'restrictTemplateInput' => [
|
||
'<?php
|
||
/** @template T */
|
||
class Foo
|
||
{
|
||
/**
|
||
* @psalm-var class-string
|
||
*/
|
||
private $type;
|
||
|
||
/** @var array<T> */
|
||
private $items;
|
||
|
||
/**
|
||
* @param class-string $type
|
||
* @template-typeof T $type
|
||
*/
|
||
public function __construct(string $type)
|
||
{
|
||
if (!in_array($type, [A::class, B::class], true)) {
|
||
throw new \InvalidArgumentException;
|
||
}
|
||
$this->type = $type;
|
||
$this->items = [];
|
||
}
|
||
|
||
/** @param T $item */
|
||
public function add($item): void
|
||
{
|
||
$this->items[] = $item;
|
||
}
|
||
}
|
||
|
||
class A {}
|
||
class B {}
|
||
|
||
|
||
$foo = new Foo(A::class);
|
||
$foo->add(new B);',
|
||
'error_message' => 'InvalidArgument',
|
||
],
|
||
];
|
||
}
|
||
}
|