mirror of
https://github.com/danog/psalm.git
synced 2024-12-11 16:59:45 +01:00
e4ead74879
Fixes vimeo/psalm#6211
326 lines
10 KiB
PHP
326 lines
10 KiB
PHP
<?php
|
|
namespace Psalm\Tests;
|
|
|
|
class AttributeTest extends TestCase
|
|
{
|
|
use Traits\InvalidCodeAnalysisTestTrait;
|
|
use Traits\ValidCodeAnalysisTestTrait;
|
|
|
|
/**
|
|
* @return iterable<string,array{string,assertions?:array<string,string>,error_levels?:string[]}>
|
|
*/
|
|
public function providerValidCodeParse(): iterable
|
|
{
|
|
return [
|
|
'classAndPropertyAttributesExists' => [
|
|
'<?php
|
|
namespace Foo;
|
|
|
|
#[\Attribute(\Attribute::TARGET_CLASS)]
|
|
class Table {
|
|
public function __construct(public string $name) {}
|
|
}
|
|
|
|
#[\Attribute(\Attribute::TARGET_PROPERTY)]
|
|
class Column {
|
|
public function __construct(public string $name) {}
|
|
}
|
|
|
|
#[Table(name: "videos")]
|
|
class Video {
|
|
#[Column(name: "id")]
|
|
public string $id = "";
|
|
|
|
#[Column(name: "title")]
|
|
public string $name = "";
|
|
}
|
|
|
|
#[Table(name: "users")]
|
|
class User {
|
|
public function __construct(
|
|
#[Column(name: "id")]
|
|
public string $id,
|
|
|
|
#[Column(name: "name")]
|
|
public string $name = "",
|
|
) {}
|
|
}',
|
|
[],
|
|
[],
|
|
'8.0'
|
|
],
|
|
'functionAttributeExists' => [
|
|
'<?php
|
|
namespace {
|
|
#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_FUNCTION | Attribute::TARGET_PARAMETER)]
|
|
class Deprecated {}
|
|
}
|
|
|
|
namespace Foo\Bar {
|
|
#[\Deprecated]
|
|
function foo() : void {}
|
|
}',
|
|
[],
|
|
[],
|
|
'8.0'
|
|
],
|
|
'paramAttributeExists' => [
|
|
'<?php
|
|
namespace {
|
|
#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_FUNCTION | Attribute::TARGET_PARAMETER)]
|
|
class Deprecated {}
|
|
}
|
|
|
|
namespace Foo\Bar {
|
|
function foo(#[\Deprecated] string $foo) : void {}
|
|
}',
|
|
[],
|
|
[],
|
|
'8.0'
|
|
],
|
|
'testReflectingClass' => [
|
|
'<?php
|
|
abstract class BaseAttribute {
|
|
public function __construct(public string $name) {}
|
|
}
|
|
|
|
#[Attribute(Attribute::TARGET_CLASS)]
|
|
class Table extends BaseAttribute {}
|
|
|
|
/** @param class-string $s */
|
|
function foo(string $s) : void {
|
|
foreach ((new ReflectionClass($s))->getAttributes(BaseAttribute::class, 2) as $attr) {
|
|
$attribute = $attr->newInstance();
|
|
echo $attribute->name;
|
|
}
|
|
}',
|
|
[],
|
|
[],
|
|
'8.0'
|
|
],
|
|
'convertKeyedArray' => [
|
|
'<?php
|
|
#[Attribute(Attribute::TARGET_CLASS)]
|
|
class Route {
|
|
private $methods = [];
|
|
/**
|
|
* @param string[] $methods
|
|
*/
|
|
public function __construct(array $methods = []) {
|
|
$this->methods = $methods;
|
|
}
|
|
}
|
|
#[Route(methods: ["GET"])]
|
|
class HealthController
|
|
{}',
|
|
[],
|
|
[],
|
|
'8.0'
|
|
],
|
|
'allowsRepeatableFlag' => [
|
|
'<?php
|
|
#[Attribute(Attribute::TARGET_ALL|Attribute::IS_REPEATABLE)] // results in int(127)
|
|
class A {}
|
|
',
|
|
[],
|
|
[],
|
|
'8.0'
|
|
],
|
|
'allowsClassString' => [
|
|
'<?php
|
|
|
|
#[Attribute(Attribute::TARGET_CLASS)]
|
|
class Foo
|
|
{
|
|
/**
|
|
* @param class-string<Baz> $_className
|
|
*/
|
|
public function __construct(string $_className)
|
|
{
|
|
}
|
|
}
|
|
|
|
#[Foo(_className: Baz::class)]
|
|
class Baz {}',
|
|
[],
|
|
[],
|
|
'8.0'
|
|
],
|
|
'allowsClassStringFromDifferentNamespace' => [
|
|
'<?php
|
|
|
|
namespace NamespaceOne {
|
|
use Attribute;
|
|
|
|
#[Attribute(Attribute::TARGET_CLASS)]
|
|
class FooAttribute
|
|
{
|
|
/** @var class-string */
|
|
private string $className;
|
|
|
|
/**
|
|
* @param class-string<FoobarInterface> $className
|
|
*/
|
|
public function __construct(string $className)
|
|
{
|
|
$this->className = $className;
|
|
}
|
|
}
|
|
|
|
interface FoobarInterface {}
|
|
|
|
class Bar implements FoobarInterface {}
|
|
}
|
|
|
|
namespace NamespaceTwo {
|
|
use NamespaceOne\FooAttribute;
|
|
use NamespaceOne\Bar as ZZ;
|
|
|
|
#[FooAttribute(className: ZZ::class)]
|
|
class Baz {}
|
|
}
|
|
'
|
|
]
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @return iterable<string,array{string,error_message:string,1?:string[],2?:bool,3?:string}>
|
|
*/
|
|
public function providerInvalidCodeParse(): iterable
|
|
{
|
|
return [
|
|
'attributeClassHasNoAttributeAnnotation' => [
|
|
'<?php
|
|
class A {}
|
|
|
|
#[A]
|
|
class B {}',
|
|
'error_message' => 'InvalidAttribute',
|
|
[],
|
|
false,
|
|
'8.0'
|
|
],
|
|
'missingAttributeOnClass' => [
|
|
'<?php
|
|
use Foo\Bar\Pure;
|
|
|
|
#[Pure]
|
|
class Video {}',
|
|
'error_message' => 'UndefinedAttributeClass',
|
|
[],
|
|
false,
|
|
'8.0'
|
|
],
|
|
'missingAttributeOnFunction' => [
|
|
'<?php
|
|
use Foo\Bar\Pure;
|
|
|
|
#[Pure]
|
|
function foo() : void {}',
|
|
'error_message' => 'UndefinedAttributeClass',
|
|
[],
|
|
false,
|
|
'8.0'
|
|
],
|
|
'missingAttributeOnParam' => [
|
|
'<?php
|
|
use Foo\Bar\Pure;
|
|
|
|
function foo(#[Pure] string $str) : void {}',
|
|
'error_message' => 'UndefinedAttributeClass',
|
|
[],
|
|
false,
|
|
'8.0'
|
|
],
|
|
'tooFewArgumentsToAttributeConstructor' => [
|
|
'<?php
|
|
namespace Foo;
|
|
|
|
#[\Attribute(\Attribute::TARGET_CLASS)]
|
|
class Table {
|
|
public function __construct(public string $name) {}
|
|
}
|
|
|
|
#[Table()]
|
|
class Video {}',
|
|
'error_message' => 'TooFewArguments',
|
|
[],
|
|
false,
|
|
'8.0'
|
|
],
|
|
'invalidArgument' => [
|
|
'<?php
|
|
#[Attribute]
|
|
class Foo
|
|
{
|
|
public function __construct(int $i)
|
|
{
|
|
}
|
|
}
|
|
|
|
#[Foo("foo")]
|
|
class Bar{}',
|
|
'error_message' => 'InvalidScalarArgument',
|
|
[],
|
|
false,
|
|
'8.0'
|
|
],
|
|
'classAttributeUsedOnFunction' => [
|
|
'<?php
|
|
namespace Foo;
|
|
|
|
#[\Attribute(\Attribute::TARGET_CLASS)]
|
|
class Table {
|
|
public function __construct(public string $name) {}
|
|
}
|
|
|
|
#[Table("videos")]
|
|
function foo() : void {}',
|
|
'error_message' => 'InvalidAttribute',
|
|
[],
|
|
false,
|
|
'8.0'
|
|
],
|
|
'interfaceCannotBeAttributeClass' => [
|
|
'<?php
|
|
#[Attribute]
|
|
interface Foo {}',
|
|
'error_message' => 'InvalidAttribute',
|
|
[],
|
|
false,
|
|
'8.0'
|
|
],
|
|
'traitCannotBeAttributeClass' => [
|
|
'<?php
|
|
#[Attribute]
|
|
interface Foo {}',
|
|
'error_message' => 'InvalidAttribute',
|
|
[],
|
|
false,
|
|
'8.0'
|
|
],
|
|
'abstractClassCannotBeAttributeClass' => [
|
|
'<?php
|
|
#[Attribute]
|
|
abstract class Baz {}',
|
|
'error_message' => 'InvalidAttribute',
|
|
[],
|
|
false,
|
|
'8.0'
|
|
],
|
|
'abstractClassCannotHavePrivateConstructor' => [
|
|
'<?php
|
|
#[Attribute]
|
|
class Baz {
|
|
private function __construct() {}
|
|
}',
|
|
'error_message' => 'InvalidAttribute',
|
|
[],
|
|
false,
|
|
'8.0'
|
|
],
|
|
];
|
|
}
|
|
}
|