1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-13 09:47:29 +01:00
psalm/tests/Template/PropertiesOfTemplateTest.php

427 lines
14 KiB
PHP
Raw Normal View History

<?php
2023-10-19 13:12:06 +02:00
declare(strict_types=1);
2022-06-28 15:42:18 +02:00
namespace Psalm\Tests\Template;
2022-06-28 15:46:30 +02:00
use Psalm\Tests\TestCase;
use Psalm\Tests\Traits\InvalidCodeAnalysisTestTrait;
use Psalm\Tests\Traits\ValidCodeAnalysisTestTrait;
class PropertiesOfTemplateTest extends TestCase
{
use ValidCodeAnalysisTestTrait;
use InvalidCodeAnalysisTestTrait;
public function providerValidCodeParse(): iterable
{
return [
'propertiesOfTemplateParam' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return properties-of<T>
*/
function asArray($obj) {
/** @var properties-of<T> */
$properties = [];
return $properties;
}
class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray($obj);
$a = $objAsArray["a"];
$aPlus2 = $a + 2;
$b = $objAsArray["b"];
if ($b === true) {
echo "True!";
}
$c = $objAsArray["c"];
$cConcat = $c . "foo";
',
],
'propertiesOfTemplateParamWithTemplate' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return properties-of<T>
*/
function asArray($obj) {
/** @var properties-of<T> */
$properties = [];
return $properties;
}
/** @template T */
class A {
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
/** @param T $a */
public function __construct(public $a) {}
}
$obj = new A(42);
$objAsArray = asArray($obj);
',
'assertions' => [
2022-12-18 17:15:15 +01:00
'$objAsArray===' => 'array{a: 42, b: bool, c: string, ...<string, mixed>}',
],
],
'privatePropertiesPicksPrivate' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return private-properties-of<T>
*/
function asArray($obj) {
/** @var private-properties-of<T> */
$properties = [];
return $properties;
}
class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray($obj);
$b = $objAsArray["b"];
',
],
'protectedPropertiesPicksProtected' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return protected-properties-of<T>
*/
function asArray($obj) {
/** @var protected-properties-of<T> */
$properties = [];
return $properties;
}
class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray($obj);
$b = $objAsArray["c"];
',
],
'publicPropertiesPicksPublic' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return public-properties-of<T>
*/
function asArray($obj) {
/** @var public-properties-of<T> */
$properties = [];
return $properties;
}
class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray($obj);
$a = $objAsArray["a"];
',
],
'propertiesOfNestedTemplates' => [
'code' => '<?php
/**
* @template T
* @template TArray of array<array-key, T>
* @param TArray $array
* @return properties-of<T>
*/
function asArray($array) {
/** @var properties-of<T> */
$properties = [];
return $properties;
}
class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray([$obj]);
$b = $objAsArray["c"];
2022-12-18 17:15:15 +01:00
',
],
];
}
public function providerInvalidCodeParse(): iterable
{
return [
'propertiesOfAllowsOnlyDefinedProperties' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return properties-of<T>
*/
function asArray($obj) {
/** @var properties-of<T> */
$properties = [];
return $properties;
}
final class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray($obj);
$d = $objAsArray["d"];
',
2022-12-18 17:15:15 +01:00
'error_message' => 'InvalidArrayOffset',
],
'privatePropertiesPicksNoPublic' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return private-properties-of<T>
*/
function asArray($obj) {
/** @var private-properties-of<T> */
$properties = [];
return $properties;
}
final class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray($obj);
$b = $objAsArray["a"];
',
2022-12-18 17:15:15 +01:00
'error_message' => 'InvalidArrayOffset',
],
'privatePropertiesPicksNoProtected' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return private-properties-of<T>
*/
function asArray($obj) {
/** @var private-properties-of<T> */
$properties = [];
return $properties;
}
final class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray($obj);
$b = $objAsArray["c"];
',
2022-12-18 17:15:15 +01:00
'error_message' => 'InvalidArrayOffset',
],
'protectedPropertiesPicksNoPublic' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return protected-properties-of<T>
*/
function asArray($obj) {
/** @var protected-properties-of<T> */
$properties = [];
return $properties;
}
final class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray($obj);
$b = $objAsArray["a"];
',
2022-12-18 17:15:15 +01:00
'error_message' => 'InvalidArrayOffset',
],
'protectedPropertiesPicksNoPrivate' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return protected-properties-of<T>
*/
function asArray($obj) {
/** @var protected-properties-of<T> */
$properties = [];
return $properties;
}
final class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray($obj);
$b = $objAsArray["b"];
',
2022-12-18 17:15:15 +01:00
'error_message' => 'InvalidArrayOffset',
],
'publicPropertiesPicksNoPrivate' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return public-properties-of<T>
*/
function asArray($obj) {
/** @var public-properties-of<T> */
$properties = [];
return $properties;
}
final class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray($obj);
$a = $objAsArray["b"];
',
2022-12-18 17:15:15 +01:00
'error_message' => 'InvalidArrayOffset',
],
'publicPropertiesPicksNoProtected' => [
'code' => '<?php
/**
* @template T
* @param T $obj
* @return public-properties-of<T>
*/
function asArray($obj) {
/** @var public-properties-of<T> */
$properties = [];
return $properties;
}
final class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray($obj);
$a = $objAsArray["c"];
',
2022-12-18 17:15:15 +01:00
'error_message' => 'InvalidArrayOffset',
],
'propertiesOfNestedTemplatesPickPublic' => [
'code' => '<?php
/**
* @template T
* @template TArray of array<array-key, T>
* @param TArray $array
* @return properties-of<T>
*/
function asArray($array) {
/** @var properties-of<T> */
$properties = [];
return $properties;
}
final class A {
/** @var int */
public $a = 42;
/** @var bool */
private $b = true;
/** @var string */
protected $c = "c";
}
$obj = new A();
$objAsArray = asArray([$obj]);
$b = $objAsArray["d"];
',
2022-12-18 17:15:15 +01:00
'error_message' => 'InvalidArrayOffset',
],
];
}
}