From c35515dc3a7de9d039f430793b0467f81bf6b3b8 Mon Sep 17 00:00:00 2001
From: Carlos Granados <barel.barelon@gmail.com>
Date: Mon, 26 Feb 2024 08:32:14 +0100
Subject: [PATCH] Add Throws attribute

---
 README.md                                     |  47 ++++----
 composer.json                                 |   2 +-
 ...tic-analysis-annotations-to-attributes.php |   2 +
 src/AnnotationsToAttributesRector.php         |   2 +
 tests/Fixture/ThrowsAttributeTest.php.inc     | 113 ++++++++++++++++++
 5 files changed, 142 insertions(+), 24 deletions(-)
 create mode 100644 tests/Fixture/ThrowsAttributeTest.php.inc

diff --git a/README.md b/README.md
index 265ad75..0be59cc 100644
--- a/README.md
+++ b/README.md
@@ -112,29 +112,30 @@ These are the available attributes and their corresponding PHPDoc annotations:
 
 | Attribute                                                                                                         | PHPDoc Annotations |
 |-------------------------------------------------------------------------------------------------------------------|--------------------|
-| [Deprecated](https://github.com/php-static-analysis/attributes/blob/main/doc/Deprecated.md)                        | `@deprecated`                        |
-| [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`                          |
-| [Method](https://github.com/php-static-analysis/attributes/blob/main/doc/Method.md)                                | `@method`                            |
-| [Mixin](https://github.com/php-static-analysis/attributes/blob/main/doc/Mixin.md)                                  | `@mixin`                             |
-| [Param](https://github.com/php-static-analysis/attributes/blob/main/doc/Param.md)                                  | `@param`                             |
-| [ParamOut](https://github.com/php-static-analysis/attributes/blob/main/doc/ParamOut.md)                            | `@param-out`                         |
-| [Property](https://github.com/php-static-analysis/attributes/blob/main/doc/Property.md)                            | `@property` `@var`                   |
-| [PropertyRead](https://github.com/php-static-analysis/attributes/blob/main/doc/PropertyRead.md)                    | `@property-read`                     |
-| [PropertyWrite](https://github.com/php-static-analysis/attributes/blob/main/doc/PropertyWrite.md)                  | `@property-write`                    |
-| [Pure](https://github.com/php-static-analysis/attributes/blob/main/doc/Pure.md)                                    | `@pure`                              |
-| [RequireExtends](https://github.com/php-static-analysis/attributes/blob/main/doc/RequireExtends.md)                | `@require-extends`                   |
-| [RequireImplements](https://github.com/php-static-analysis/attributes/blob/main/doc/RequireImplements.md)          | `@require-implements`                |
-| [Returns](https://github.com/php-static-analysis/attributes/blob/main/doc/Returns.md)                              | `@return`                            |
-| [SelfOut](https://github.com/php-static-analysis/attributes/blob/main/doc/SelfOut.md)                              | `@self-out` `@this-out`              |
-| [Template](https://github.com/php-static-analysis/attributes/blob/main/doc/Template.md)                            | `@template`                          |
-| [TemplateContravariant](https://github.com/php-static-analysis/attributes/blob/main/doc/TemplateContravariant.md)  | `@template-contravariant`            |
-| [TemplateCovariant](https://github.com/php-static-analysis/attributes/blob/main/doc/TemplateCovariant.md)          | `@template-covariant`                |
-| [TemplateExtends](https://github.com/php-static-analysis/attributes/blob/main/doc/TemplateExtends.md)              | `@extends` `@template-extends`       |
-| [TemplateImplements](https://github.com/php-static-analysis/attributes/blob/main/doc/TemplateImplements.md)        | `@implements` `@template-implements` |
-| [TemplateUse](https://github.com/php-static-analysis/attributes/blob/main/doc/TemplateUse.md)                      | `@use` `@template-use`               |
-| [Type](https://github.com/php-static-analysis/attributes/blob/main/doc/Type.md)                                    | `@var` `@return`                     |
+| [Deprecated](https://github.com/php-static-analysis/attributes/blob/main/doc/Deprecated.md)                       | `@deprecated`                        |
+| [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`                          |
+| [Method](https://github.com/php-static-analysis/attributes/blob/main/doc/Method.md)                               | `@method`                            |
+| [Mixin](https://github.com/php-static-analysis/attributes/blob/main/doc/Mixin.md)                                 | `@mixin`                             |
+| [Param](https://github.com/php-static-analysis/attributes/blob/main/doc/Param.md)                                 | `@param`                             |
+| [ParamOut](https://github.com/php-static-analysis/attributes/blob/main/doc/ParamOut.md)                           | `@param-out`                         |
+| [Property](https://github.com/php-static-analysis/attributes/blob/main/doc/Property.md)                           | `@property` `@var`                   |
+| [PropertyRead](https://github.com/php-static-analysis/attributes/blob/main/doc/PropertyRead.md)                   | `@property-read`                     |
+| [PropertyWrite](https://github.com/php-static-analysis/attributes/blob/main/doc/PropertyWrite.md)                 | `@property-write`                    |
+| [Pure](https://github.com/php-static-analysis/attributes/blob/main/doc/Pure.md)                                   | `@pure`                              |
+| [RequireExtends](https://github.com/php-static-analysis/attributes/blob/main/doc/RequireExtends.md)               | `@require-extends`                   |
+| [RequireImplements](https://github.com/php-static-analysis/attributes/blob/main/doc/RequireImplements.md)         | `@require-implements`                |
+| [Returns](https://github.com/php-static-analysis/attributes/blob/main/doc/Returns.md)                             | `@return`                            |
+| [SelfOut](https://github.com/php-static-analysis/attributes/blob/main/doc/SelfOut.md)                             | `@self-out` `@this-out`              |
+| [Template](https://github.com/php-static-analysis/attributes/blob/main/doc/Template.md)                           | `@template`                          |
+| [TemplateContravariant](https://github.com/php-static-analysis/attributes/blob/main/doc/TemplateContravariant.md) | `@template-contravariant`            |
+| [TemplateCovariant](https://github.com/php-static-analysis/attributes/blob/main/doc/TemplateCovariant.md)         | `@template-covariant`                |
+| [TemplateExtends](https://github.com/php-static-analysis/attributes/blob/main/doc/TemplateExtends.md)             | `@extends` `@template-extends`       |
+| [TemplateImplements](https://github.com/php-static-analysis/attributes/blob/main/doc/TemplateImplements.md)       | `@implements` `@template-implements` |
+| [TemplateUse](https://github.com/php-static-analysis/attributes/blob/main/doc/TemplateUse.md)                     | `@use` `@template-use`               |
+| [Throws](https://github.com/php-static-analysis/attributes/blob/main/doc/Throws.md)                               | `@throws`                            |
+| [Type](https://github.com/php-static-analysis/attributes/blob/main/doc/Type.md)                                   | `@var` `@return`                     |
 
 ### Location of Param and ParamOut attributes
 
diff --git a/composer.json b/composer.json
index 1463cfd..664d3fc 100644
--- a/composer.json
+++ b/composer.json
@@ -28,7 +28,7 @@
     "require": {
         "php": ">=8.0",
         "cweagans/composer-patches": "^1.7",
-        "php-static-analysis/attributes": "^0.1.15 || dev-main",
+        "php-static-analysis/attributes": "^0.1.16 || dev-main",
         "rector/rector": "^0.19 || ^1.0"
     },
     "require-dev": {
diff --git a/config/sets/php-static-analysis-annotations-to-attributes.php b/config/sets/php-static-analysis-annotations-to-attributes.php
index b1f5567..c62d480 100644
--- a/config/sets/php-static-analysis-annotations-to-attributes.php
+++ b/config/sets/php-static-analysis-annotations-to-attributes.php
@@ -19,6 +19,7 @@
 use PhpStaticAnalysis\Attributes\TemplateExtends;
 use PhpStaticAnalysis\Attributes\TemplateImplements;
 use PhpStaticAnalysis\Attributes\TemplateUse;
+use PhpStaticAnalysis\Attributes\Throws;
 use Rector\Config\RectorConfig;
 use Rector\Php80\ValueObject\AnnotationToAttribute;
 use PhpStaticAnalysis\Attributes\IsReadOnly;
@@ -58,6 +59,7 @@
             new AnnotationToAttribute('template_implements', TemplateImplements::class),
             new AnnotationToAttribute('template_use', TemplateUse::class),
             new AnnotationToAttribute('this_out', SelfOut::class),
+            new AnnotationToAttribute('throws', Throws::class),
             new AnnotationToAttribute('use', TemplateUse::class),
             new AnnotationToAttribute('var', Type::class),
             'addParamAttributeOnParameters' => false,
diff --git a/src/AnnotationsToAttributesRector.php b/src/AnnotationsToAttributesRector.php
index 536a8cf..1ff9604 100644
--- a/src/AnnotationsToAttributesRector.php
+++ b/src/AnnotationsToAttributesRector.php
@@ -26,6 +26,7 @@
 use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
 use PHPStan\PhpDocParser\Ast\PhpDoc\SelfOutTagValueNode;
 use PHPStan\PhpDocParser\Ast\PhpDoc\TemplateTagValueNode;
+use PHPStan\PhpDocParser\Ast\PhpDoc\ThrowsTagValueNode;
 use PHPStan\PhpDocParser\Ast\PhpDoc\UsesTagValueNode;
 use PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
@@ -293,6 +294,7 @@ private function processAnnotations(PhpDocInfo $phpDocInfo): array
                 case $tagValueNode instanceof RequireImplementsTagValueNode:
                 case $tagValueNode instanceof ReturnTagValueNode:
                 case $tagValueNode instanceof SelfOutTagValueNode:
+                case $tagValueNode instanceof ThrowsTagValueNode:
                 case $tagValueNode instanceof UsesTagValueNode:
                 case $tagValueNode instanceof VarTagValueNode:
                     $args = [
diff --git a/tests/Fixture/ThrowsAttributeTest.php.inc b/tests/Fixture/ThrowsAttributeTest.php.inc
new file mode 100644
index 0000000..97a775f
--- /dev/null
+++ b/tests/Fixture/ThrowsAttributeTest.php.inc
@@ -0,0 +1,113 @@
+<?php
+
+namespace test\PhpStaticAnalysis\RectorRule\Fixture;
+
+use Exception;
+use PhpStaticAnalysis\Attributes\Param;
+
+class ThrowsAttributeTest
+{
+    /**
+     * @throws Exception
+     */
+    public function getName(): void
+    {
+        throw new Exception();
+    }
+
+    /**
+     * @codeCoverageIgnore
+     * @throws Exception
+     */
+    public function getMoreNames(): void
+    {
+        throw new Exception();
+    }
+
+    /**
+     * @throws Exception
+     */
+    #[Param(name:'string')]
+    public function getAnotherName($name): void
+    {
+        throw new Exception();
+    }
+
+    /**
+     * @throws Exception this is the exception that is thrown
+     */
+    public function getUserName(): void
+    {
+        throw new Exception();
+    }
+
+    /**
+     * @phpstan-throws Exception
+     */
+    public function getPHPStanName(): void
+    {
+        throw new Exception();
+    }
+}
+
+/**
+ * @throws Exception
+ */
+function getName(): void
+{
+    throw new Exception();
+}
+
+?>
+-----
+<?php
+
+namespace test\PhpStaticAnalysis\RectorRule\Fixture;
+
+use Exception;
+use PhpStaticAnalysis\Attributes\Param;
+
+class ThrowsAttributeTest
+{
+    #[\PhpStaticAnalysis\Attributes\Throws('Exception')]
+    public function getName(): void
+    {
+        throw new Exception();
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    #[\PhpStaticAnalysis\Attributes\Throws('Exception')]
+    public function getMoreNames(): void
+    {
+        throw new Exception();
+    }
+
+    #[Param(name:'string')]
+    #[\PhpStaticAnalysis\Attributes\Throws('Exception')]
+    public function getAnotherName($name): void
+    {
+        throw new Exception();
+    }
+
+    #[\PhpStaticAnalysis\Attributes\Throws('Exception')] // this is the exception that is thrown
+    public function getUserName(): void
+    {
+        throw new Exception();
+    }
+
+    #[\PhpStaticAnalysis\Attributes\Throws('Exception')]
+    public function getPHPStanName(): void
+    {
+        throw new Exception();
+    }
+}
+
+#[\PhpStaticAnalysis\Attributes\Throws('Exception')]
+function getName(): void
+{
+    throw new Exception();
+}
+
+?>