Allow set many origins in Route and RouteNotFound attributes

Author: natanfelles

src/Attributes/Route.php

@@ -26,7 +26,10 @@ class Route
     protected string $path;
     protected string $arguments;
     protected ?string $name;
-    protected ?string $origin;
+    /**
+     * @var array<string>
+     */
+    protected array $origins;
 
     /**
      * Route constructor.
@@ -35,14 +38,14 @@ class Route
      * @param string $path The Route path
      * @param string $arguments The Route action arguments
      * @param string|null $name The Route name
-     * @param string|null $origin The Route origin
+     * @param array<string>|string $origins The Route origins
      */
     public function __construct(
         array | string $methods,
         string $path,
         string $arguments = '*',
         string $name = null,
-        string $origin = null,
+        array | string $origins = [],
     ) {
         $methods = (array) $methods;
         foreach ($methods as &$method) {
@@ -53,7 +56,7 @@ public function __construct(
         $this->path = $path;
         $this->arguments = $arguments;
         $this->name = $name;
-        $this->origin = $origin;
+        $this->origins = (array) $origins;
     }
 
     /**
@@ -89,10 +92,10 @@ public function getName() : ?string
     }
 
     /**
-     * @return string|null
+     * @return array<string>
      */
-    public function getOrigin() : ?string
+    public function getOrigins() : array
     {
-        return $this->origin;
+        return $this->origins;
     }
 }

src/Attributes/RouteNotFound.php

@@ -19,23 +19,26 @@
 #[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 class RouteNotFound
 {
-    protected ?string $origin;
+    /**
+     * @var array<string>
+     */
+    protected array $origins;
 
     /**
      * RouteNotFound constructor.
      *
-     * @param string|null $origin The Route Not Found origin
+     * @param array<string>|string $origins The Route Not Found origins
      */
-    public function __construct(string $origin = null)
+    public function __construct(array | string $origins = [])
     {
-        $this->origin = $origin;
+        $this->origins = (array) $origins;
     }
 
     /**
-     * @return string|null
+     * @return array<string>
      */
-    public function getOrigin() : ?string
+    public function getOrigins() : array
     {
-        return $this->origin;
+        return $this->origins;
     }
 }

src/Reflector.php

@@ -104,10 +104,8 @@ public function getRoutes() : array
                 continue;
             }
             foreach ($routes as $route) {
-                $origin = $route->getOrigin();
-                $origin = $origin === null ? $origins : [$origin];
                 $result[] = [
-                    'origins' => $origin,
+                    'origins' => $route->getOrigins() ?: $origins,
                     'methods' => $route->getMethods(),
                     'path' => $route->getPath(),
                     'arguments' => $route->getArguments(),
@@ -156,10 +154,8 @@ public function getRoutesNotFound() : array
                 continue;
             }
             foreach ($routes as $route) {
-                $origin = $route->getOrigin();
-                $origin = $origin === null ? $origins : [$origin];
                 $result[] = [
-                    'origins' => $origin,
+                    'origins' => $route->getOrigins() ?: $origins,
                     'action' => $this->reflection->name . '::' . $method->name,
                 ];
             }

tests/Attributes/RouteTest.php

@@ -47,16 +47,16 @@ protected function assertAttribute(string $method, array $arguments) : void
             ? self::assertSame('users.delete', $instance->getName())
             : self::assertNull($instance->getName());
         $method === 'index'
-            ? self::assertSame('http://foo.com', $instance->getOrigin())
-            : self::assertNull($instance->getOrigin());
+            ? self::assertSame(['http://foo.com'], $instance->getOrigins())
+            : self::assertEmpty($instance->getOrigins());
     }
 
     public function testIndex() : void
     {
         $this->assertAttribute('index', [
             'GET',
             '/users',
-            'origin' => 'http://foo.com',
+            'origins' => 'http://foo.com',
         ]);
     }
 

tests/ReflectorTest.php

@@ -110,6 +110,17 @@ public function testInChildClass() : void
             'name' => null,
             'action' => ChildClass::class . '::replaceOrigin',
         ], $reflector->getRoutes());
+        self::assertContains([
+            'origins' => [
+                'xxx',
+                'yyy',
+            ],
+            'methods' => ['GET'],
+            'path' => '/replace-origin-2',
+            'arguments' => '*',
+            'name' => null,
+            'action' => ChildClass::class . '::replaceOrigin2',
+        ], $reflector->getRoutes());
         self::assertContains([
             'origins' => [
                 'http://bar.xyz',

tests/Support/AbstractClass.php

@@ -20,8 +20,13 @@ public function hello() : void
     {
     }
 
-    #[Route('GET', '/replace-origin', origin: 'xxx')]
+    #[Route('GET', '/replace-origin', origins: 'xxx')]
     public function replaceOrigin() : void
     {
     }
+
+    #[Route('GET', '/replace-origin-2', origins: ['xxx', 'yyy'])]
+    public function replaceOrigin2() : void
+    {
+    }
 }

tests/Support/UsersRouteActionsResource.php

@@ -19,7 +19,7 @@
 #[Origin('http://api.domain.xyz')]
 class UsersRouteActionsResource extends RouteActions implements ResourceInterface
 {
-    #[Route('GET', '/users', origin: 'http://foo.com')]
+    #[Route('GET', '/users', origins: 'http://foo.com')]
     public function index() : string
     {
         return __METHOD__;