Add DefineType and ImportType attributes

php-static-analysis · Mar 5, 2024 · cd6091a · cd6091a
1 parent 3f1c657
commit cd6091a
Show file tree

Hide file tree

Showing 15 changed files with 237 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -96,8 +96,10 @@ These are the available attributes and their corresponding PHPDoc annotations:
 
 | Attribute                                                                                                         | PHPDoc Annotations                   |
 |-------------------------------------------------------------------------------------------------------------------|--------------------------------------|
+| [DefineType](https://github.com/php-static-analysis/attributes/blob/main/doc/DefineType.md)                       | `@type`                              |
 | [Deprecated](https://github.com/php-static-analysis/attributes/blob/main/doc/Deprecated.md)                       | `@deprecated`                        |
 | [Immmutable](https://github.com/php-static-analysis/attributes/blob/main/doc/Immmutable.md)                       | `@immmutable`                        |
+| [ImportType](https://github.com/php-static-analysis/attributes/blob/main/doc/ImportType.md)                       | `@import-type`                       |
 | [Impure](https://github.com/php-static-analysis/attributes/blob/main/doc/Impure.md)                               | `@impure`                            |
 | [Internal](https://github.com/php-static-analysis/attributes/blob/main/doc/Internal.md)                           | `@internal`                          |
 | [IsReadOnly](https://github.com/php-static-analysis/attributes/blob/main/doc/IsReadOnly.md)                       | `@readonly`                          |

diff --git a/composer.json b/composer.json
@@ -24,8 +24,8 @@
     "prefer-stable": true,
     "require": {
         "php": ">=8.0",
-        "php-static-analysis/attributes": "^0.1.17 || dev-main",
-        "php-static-analysis/node-visitor": "^0.1.17 || dev-main",
+        "php-static-analysis/attributes": "^0.2.2 || dev-main",
+        "php-static-analysis/node-visitor": "^0.2.2 || dev-main",
         "phpstan/phpstan": "^1.8"
     },
     "require-dev": {

diff --git a/tests/DefineTypeAttributeTest.php b/tests/DefineTypeAttributeTest.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace test\PhpStaticAnalysis\PHPStanExtension;
+
+class DefineTypeAttributeTest extends BaseAttributeTestCase
+{
+    public function testClassDefineTypeAttribute(): void
+    {
+        $errors = $this->analyse(__DIR__ . '/data/DefineType/ClassDefineTypeAttribute.php');
+        $this->assertCount(0, $errors);
+    }
+
+    public function testInterfaceDefineTypeAttribute(): void
+    {
+        $errors = $this->analyse(__DIR__ . '/data/DefineType/InterfaceDefineTypeAttribute.php');
+        $this->assertCount(0, $errors);
+    }
+
+    public function testTraitDefineTypeAttribute(): void
+    {
+        $errors = $this->analyse(__DIR__ . '/data/DefineType/TraitDefineTypeAttribute.php');
+        $this->assertCount(0, $errors);
+    }
+
+    public function testInvalidClassDefineTypeAttribute(): void
+    {
+        $errors = $this->analyse(__DIR__ . '/data/DefineType/InvalidClassDefineTypeAttribute.php');
+
+        $expectedErrors = [
+            'PHPDoc tag @phpstan-type has invalid value (): Unexpected token "\n * ", expected type at offset 20' => 7,
+            'PHPDoc tag @phpstan-type name has invalid value: Unexpected token "(", expected TOKEN_PHPDOC_EOL at offset 72' => 7,
+            'PHPDoc tag @phpstan-type string has invalid value: Unexpected token "\n * ", expected type at offset 44' => 7,
+            'Parameter #1 ...$types of attribute class PhpStaticAnalysis\Attributes\DefineType constructor expects string, int given.' => 7,
+            'Type alias has an invalid name: string.' => 7,
+            'Attribute class PhpStaticAnalysis\Attributes\DefineType does not have the method target.' => 12,
+        ];
+
+        $this->checkExpectedErrors($errors, $expectedErrors);
+    }
+}
diff --git a/tests/ImportTypeAttributeTest.php b/tests/ImportTypeAttributeTest.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace test\PhpStaticAnalysis\PHPStanExtension;
+
+class ImportTypeAttributeTest extends BaseAttributeTestCase
+{
+    public function testClassImportTypeAttribute(): void
+    {
+        $errors = $this->analyse(__DIR__ . '/data/ImportType/ClassImportTypeAttribute.php');
+        $this->assertCount(0, $errors);
+    }
+
+    public function testInterfaceImportTypeAttribute(): void
+    {
+        $errors = $this->analyse(__DIR__ . '/data/ImportType/InterfaceImportTypeAttribute.php');
+        $this->assertCount(0, $errors);
+    }
+
+    public function testTraitImportTypeAttribute(): void
+    {
+        $errors = $this->analyse(__DIR__ . '/data/ImportType/TraitImportTypeAttribute.php');
+        $this->assertCount(0, $errors);
+    }
+
+    public function testInvalidClassImportTypeAttribute(): void
+    {
+        $errors = $this->analyse(__DIR__ . '/data/ImportType/InvalidClassImportTypeAttribute.php');
+
+        $expectedErrors = [
+            'PHPDoc tag @phpstan-import-type has invalid value (Unexpected token "(", expected \'*/\' at offset 98 on line 4): Unexpected token "(", expected \'*/\' at offset 98' => 8,
+            'Parameter #1 ...$from of attribute class PhpStaticAnalysis\Attributes\ImportType constructor expects string, int given.' => 8,
+            'Attribute class PhpStaticAnalysis\Attributes\ImportType does not have the method target.' => 13,
+        ];
+
+        $this->checkExpectedErrors($errors, $expectedErrors);
+    }
+}
diff --git a/tests/TypeAttributeTest.php b/tests/TypeAttributeTest.php
@@ -15,12 +15,12 @@ public function testInvalidPropertyTypeAttribute(): void
         $errors = $this->analyse(__DIR__ . '/data/Type/InvalidPropertyTypeAttribute.php');
 
         $expectedErrors = [
-            'Attribute class PhpStaticAnalysis\Attributes\Type does not have the class target.' => 7,
-            'PHPDoc tag @var has invalid value (): Unexpected token "\n ", expected type at offset 11' => 10,
-            'Parameter #1 $type of attribute class PhpStaticAnalysis\Attributes\Type constructor expects string, int given.' => 10,
-            'Attribute class PhpStaticAnalysis\Attributes\Type is not repeatable but is already present above the property.' => 14,
-            'Attribute class PhpStaticAnalysis\Attributes\Type constructor invoked with 2 parameters, 1 required.' => 17,
-            'PHPDoc tag @var has invalid value ($a + $b): Unexpected token "$a", expected type at offset 12' => 20,
+            'PHPDoc tag @var has invalid value (): Unexpected token "\n ", expected type at offset 11' => 9,
+            'Parameter #1 $type of attribute class PhpStaticAnalysis\Attributes\Type constructor expects string, int given.' => 9,
+            'Attribute class PhpStaticAnalysis\Attributes\Type is not repeatable but is already present above the property.' => 13,
+            'Attribute class PhpStaticAnalysis\Attributes\Type constructor invoked with 2 parameters, 1 required.' => 16,
+            'PHPDoc tag @var has invalid value ($a + $b): Unexpected token "$a", expected type at offset 12' => 19,
+            'Attribute class PhpStaticAnalysis\Attributes\Type does not have the parameter target.' => 23,
         ];
 
         $this->checkExpectedErrors($errors, $expectedErrors);

diff --git a/tests/data/DefineType/ClassDefineTypeAttribute.php b/tests/data/DefineType/ClassDefineTypeAttribute.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace test\PhpStaticAnalysis\PHPStanExtension\data\DefineType;
+
+use PhpStaticAnalysis\Attributes\DefineType;
+use PhpStaticAnalysis\Attributes\Param;
+
+#[DefineType(UserAddress: 'array{street: string, city: string, zip: string}')] // this is an alias of the listed type
+#[DefineType('UserName array{firstName: string, lastName: string}')]
+#[DefineType(
+    StringArray: 'string[]',
+    IntArray: 'int[]',
+)]
+class ClassDefineTypeAttribute
+{
+    #[Param(address: 'UserAddress')]
+    public function getZip($address): string
+    {
+        return $address['zip'];
+    }
+}
diff --git a/tests/data/DefineType/InterfaceDefineTypeAttribute.php b/tests/data/DefineType/InterfaceDefineTypeAttribute.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace test\PhpStaticAnalysis\PHPStanExtension\data\DefineType;
+
+use PhpStaticAnalysis\Attributes\DefineType;
+
+#[DefineType(StringArray: 'string[]')]
+interface InterfaceDefineTypeAttribute
+{
+}
diff --git a/tests/data/DefineType/InvalidClassDefineTypeAttribute.php b/tests/data/DefineType/InvalidClassDefineTypeAttribute.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace test\PhpStaticAnalysis\PHPStanExtension\data\DefineType;
+
+use PhpStaticAnalysis\Attributes\DefineType;
+
+#[DefineType(0)]
+#[DefineType('string')]
+#[DefineType(name: 'count($a)')]
+class InvalidClassDefineTypeAttribute
+{
+    #[DefineType('StringArray string[]')]
+    public function getName(): string
+    {
+        return "John";
+    }
+}
diff --git a/tests/data/DefineType/TraitDefineTypeAttribute.php b/tests/data/DefineType/TraitDefineTypeAttribute.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace test\PhpStaticAnalysis\PHPStanExtension\data\DefineType;
+
+use PhpStaticAnalysis\Attributes\DefineType;
+
+#[DefineType(StringArray: 'string[]')]
+trait TraitDefineTypeAttribute
+{
+}
diff --git a/tests/data/ImportType/ClassImportTypeAttribute.php b/tests/data/ImportType/ClassImportTypeAttribute.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace test\PhpStaticAnalysis\PHPStanExtension\data\ImportType;
+
+use PhpStaticAnalysis\Attributes\DefineType;
+use PhpStaticAnalysis\Attributes\ImportType;
+use PhpStaticAnalysis\Attributes\Param;
+
+#[ImportType(UserAddress: TypeClass::class)] // we import this alias from another class
+#[ImportType('UserName from TypeClass')]
+#[ImportType(
+    StringArray: 'TypeClass',
+    IntArray: TypeClass::class,
+)]
+class ClassImportTypeAttribute
+{
+    #[Param(address: 'UserAddress')]
+    public function getZip($address): string
+    {
+        return $address['zip'];
+    }
+}
+
+#[DefineType(UserAddress: 'array{street: string, city: string, zip: string}')]
+#[DefineType('UserName array{firstName: string, lastName: string}')]
+#[DefineType(StringArray: 'string[]')]
+#[DefineType(IntArray: 'int[]')]
+class TypeClass
+{
+}
diff --git a/tests/data/ImportType/InterfaceImportTypeAttribute.php b/tests/data/ImportType/InterfaceImportTypeAttribute.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace test\PhpStaticAnalysis\PHPStanExtension\data\ImportType;
+
+use PhpStaticAnalysis\Attributes\DefineType;
+use PhpStaticAnalysis\Attributes\ImportType;
+
+#[ImportType(StringArray: StringClass::class)]
+interface InterfaceImportTypeAttribute
+{
+}
+
+#[DefineType(StringArray: 'string[]')]
+class StringClass
+{
+}
diff --git a/tests/data/ImportType/InvalidClassImportTypeAttribute.php b/tests/data/ImportType/InvalidClassImportTypeAttribute.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace test\PhpStaticAnalysis\PHPStanExtension\data\ImportType;
+
+use PhpStaticAnalysis\Attributes\DefineType;
+use PhpStaticAnalysis\Attributes\ImportType;
+
+#[ImportType(0)]
+#[ImportType('string')]
+#[ImportType(name: 'count($a)')]
+class InvalidClassImportTypeAttribute
+{
+    #[ImportType(StringArray: StringClass::class)]
+    public function getName(): string
+    {
+        return "John";
+    }
+}
+
+#[DefineType(StringArray: 'string[]')]
+class StringClass
+{
+}
diff --git a/tests/data/ImportType/TraitImportTypeAttribute.php b/tests/data/ImportType/TraitImportTypeAttribute.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace test\PhpStaticAnalysis\PHPStanExtension\data\ImportType;
+
+use PhpStaticAnalysis\Attributes\DefineType;
+use PhpStaticAnalysis\Attributes\ImportType;
+
+#[ImportType(StringArray: StringClass::class)]
+trait TraitImportTypeAttribute
+{
+}
+
+#[DefineType(StringArray: 'string[]')]
+class StringClass
+{
+}
diff --git a/tests/data/Type/InvalidPropertyTypeAttribute.php b/tests/data/Type/InvalidPropertyTypeAttribute.php
@@ -4,7 +4,6 @@
 
 use PhpStaticAnalysis\Attributes\Type;
 
-#[Type('string')]
 class InvalidPropertyTypeAttribute
 {
     #[Type(0)]
@@ -19,4 +18,10 @@ class InvalidPropertyTypeAttribute
 
     #[Type('$a + $b')]
     public string $andAnotherinvalidProperty;
+
+    public function getName(
+        #[Type('string')]
+        string $user
+    ): void {
+    }
 }
diff --git a/tests/data/Type/PropertyTypeAttribute.php b/tests/data/Type/PropertyTypeAttribute.php
@@ -5,6 +5,7 @@
 use Exception;
 use PhpStaticAnalysis\Attributes\Type;
 
+#[Type('StringArray string[]')]
 class PropertyTypeAttribute
 {
     #[Type('string')]