Decorate errors to help find origin (#11)

Author: olvlvl

src/Collection.php

@@ -9,6 +9,9 @@
 
 namespace olvlvl\ComposerAttributeCollector;
 
+use RuntimeException;
+use Throwable;
+
 use function array_map;
 
 /**
@@ -40,11 +43,32 @@ public function __construct(
     public function findTargetClasses(string $attribute): array
     {
         return array_map(
-            fn(array $a) => new TargetClass(new $attribute(...$a[0]), $a[1]),
+            fn(array $a) => new TargetClass(self::createClassAttribute($attribute, ...$a), $a[1]),
             $this->targetClasses[$attribute] ?? []
         );
     }
 
+    /**
+     * @template T of object
+     *
+     * @param class-string<T> $attribute
+     * @param array<int|string, mixed> $arguments
+     * @param class-string $class
+     *
+     * @return T
+     */
+    private static function createClassAttribute(string $attribute, array $arguments, string $class): object
+    {
+        try {
+            return new $attribute(...$arguments);
+        } catch (Throwable $e) {
+            throw new RuntimeException(
+                "An error occurred while instantiating attribute $attribute on class $class",
+                previous: $e
+            );
+        }
+    }
+
     /**
      * @template T of object
      *
@@ -55,11 +79,36 @@ public function findTargetClasses(string $attribute): array
     public function findTargetMethods(string $attribute): array
     {
         return array_map(
-            fn(array $a) => new TargetMethod(new $attribute(...$a[0]), $a[1], $a[2]),
+            fn(array $a) => new TargetMethod(self::createMethodAttribute($attribute, ...$a), $a[1], $a[2]),
             $this->targetMethods[$attribute] ?? []
         );
     }
 
+    /**
+     * @template T of object
+     *
+     * @param class-string<T> $attribute
+     * @param array<int|string, mixed> $arguments
+     * @param class-string $class
+     *
+     * @return T
+     */
+    private static function createMethodAttribute(
+        string $attribute,
+        array $arguments,
+        string $class,
+        string $method
+    ): object {
+        try {
+            return new $attribute(...$arguments);
+        } catch (Throwable $e) {
+            throw new RuntimeException(
+                "An error occurred while instantiating attribute $attribute on method $class::$method",
+                previous: $e
+            );
+        }
+    }
+
     /**
      * @param class-string $class
      *
@@ -75,7 +124,7 @@ public function forClass(string $class): ForClass
                     continue;
                 }
 
-                $classAttributes[] = new $attribute(...$arguments);
+                $classAttributes[] = self::createClassAttribute($attribute, $arguments, $class);
             }
         }
 
@@ -87,7 +136,12 @@ public function forClass(string $class): ForClass
                     continue;
                 }
 
-                $methodAttributes[$targetMethod][] = new $attribute(...$arguments);
+                $methodAttributes[$targetMethod][] = self::createMethodAttribute(
+                    $attribute,
+                    $arguments,
+                    $class,
+                    $targetMethod
+                );
             }
         }
 

tests/CollectionTest.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace tests\olvlvl\ComposerAttributeCollector;
+
+use Closure;
+use olvlvl\ComposerAttributeCollector\Collection;
+use PHPUnit\Framework\TestCase;
+use RuntimeException;
+
+final class CollectionTest extends TestCase
+{
+    /**
+     * @dataProvider provideInstantiationErrorIsDecorated
+     *
+     * @param Closure(Collection):void $act
+     */
+    public function testInstantiationErrorIsDecorated(string $expectedMessage, Closure $act): void
+    {
+        $collection = new Collection(
+            [
+                \Acme\Attribute\Permission::class => [
+                    [ [ 'Permission' => 'is_admin' ], \Acme\PSR4\DeleteMenu::class ],
+                ]
+            ],
+            [
+                \Acme\Attribute\Route::class => [
+                    [ [ 'Method' => 'GET' ], \Acme\PSR4\Presentation\ArticleController::class, 'list' ],
+                ]
+            ],
+        );
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage($expectedMessage);
+        $act($collection);
+    }
+
+    /**
+     * @return array<array{ string, Closure }>
+     */
+    public static function provideInstantiationErrorIsDecorated(): array
+    {
+        return [
+
+            [
+                "An error occurred while instantiating attribute Acme\Attribute\Permission on class Acme\PSR4\DeleteMenu",
+                fn(Collection $c) => $c->findTargetClasses(\Acme\Attribute\Permission::class),
+            ],
+            [
+                "An error occurred while instantiating attribute Acme\Attribute\Route on method Acme\PSR4\Presentation\ArticleController::list",
+                fn(Collection $c) => $c->findTargetMethods(\Acme\Attribute\Route::class),
+            ],
+            [
+                "An error occurred while instantiating attribute Acme\Attribute\Permission on class Acme\PSR4\DeleteMenu",
+                fn(Collection $c) => $c->forClass(\Acme\PSR4\DeleteMenu::class),
+            ],
+            [
+                "An error occurred while instantiating attribute Acme\Attribute\Route on method Acme\PSR4\Presentation\ArticleController::list",
+                fn(Collection $c) => $c->forClass(\Acme\PSR4\Presentation\ArticleController::class),
+            ],
+
+        ];
+    }
+}