Make API singleton 'only' behavior consistent with API resource

laravel · May 16, 2023 · 5594b54 · 5594b54
1 parent e0e443f
commit 5594b54
Show file tree

Hide file tree

Showing 4 changed files with 163 additions and 33 deletions.
diff --git a/src/Illuminate/Routing/ResourceRegistrar.php b/src/Illuminate/Routing/ResourceRegistrar.php
@@ -2,7 +2,6 @@
 
 namespace Illuminate\Routing;
 
-use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 
 class ResourceRegistrar
@@ -149,6 +148,12 @@ public function singleton($name, $controller, array $options = [])
 
         $defaults = $this->singletonResourceDefaults;
 
+        if (isset($options['creatable'])) {
+            $defaults = array_merge($defaults, ['create', 'store', 'destroy']);
+        } elseif (isset($options['destroyable'])) {
+            $defaults = array_merge($defaults, ['destroy']);
+        }
+
         $collection = new RouteCollection;
 
         $resourceMethods = $this->getResourceMethods($defaults, $options);
@@ -249,28 +254,6 @@ protected function getResourceMethods($defaults, $options)
             $methods = array_diff($methods, (array) $options['except']);
         }
 
-        if (isset($options['apiSingleton'])) {
-            $methods = array_diff($methods, ['create', 'edit']);
-        }
-
-        if (isset($options['creatable'])) {
-            $methods = isset($options['apiSingleton'])
-                            ? array_merge(['store', 'destroy'], $methods)
-                            : array_merge(['create', 'store', 'destroy'], $methods);
-
-            return $this->getResourceMethods(
-                $methods, Arr::except($options, ['creatable'])
-            );
-        }
-
-        if (isset($options['destroyable'])) {
-            $methods = array_merge(['destroy'], $methods);
-
-            return $this->getResourceMethods(
-                $methods, Arr::except($options, ['destroyable'])
-            );
-        }
-
         return array_values($methods);
     }
 

diff --git a/src/Illuminate/Routing/Router.php b/src/Illuminate/Routing/Router.php
@@ -427,17 +427,15 @@ public function apiSingletons(array $singletons, array $options = [])
      */
     public function apiSingleton($name, $controller, array $options = [])
     {
-        if ($this->container && $this->container->bound(ResourceRegistrar::class)) {
-            $registrar = $this->container->make(ResourceRegistrar::class);
-        } else {
-            $registrar = new ResourceRegistrar($this);
+        $only = ['store', 'show', 'update', 'destroy'];
+
+        if (isset($options['except'])) {
+            $only = array_diff($only, (array) $options['except']);
         }
 
-        return new PendingSingletonResourceRegistration(
-            $registrar, $name, $controller, array_merge([
-                'apiSingleton' => true,
-            ], $options),
-        );
+        return $this->singleton($name, $controller, array_merge([
+            'only' => $only,
+        ], $options));
     }
 
     /**

diff --git a/tests/Integration/Routing/RouteSingletonTest.php b/tests/Integration/Routing/RouteSingletonTest.php
@@ -259,7 +259,7 @@ public function testCreatableApiSingletonOnly()
         $this->assertEquals(405, $response->getStatusCode());
 
         $response = $this->get('/avatar/create');
-        $this->assertEquals(404, $response->getStatusCode());
+        $this->assertEquals(200, $response->getStatusCode());
 
         $response = $this->post('/avatar');
         $this->assertEquals(200, $response->getStatusCode());

diff --git a/tests/Routing/RouteRegistrarTest.php b/tests/Routing/RouteRegistrarTest.php
@@ -1101,6 +1101,155 @@ public function testCanRemoveMiddlewareFromGroupUnregisteredGroup()
         $this->assertEquals([], $this->router->getMiddlewareGroups());
     }
 
+    public function testCanRegisterSingleton()
+    {
+        $this->router->singleton('user', RouteRegistrarControllerStub::class);
+
+        $this->assertCount(3, $this->router->getRoutes());
+
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.show'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.edit'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.update'));
+    }
+
+    public function testCanRegisterApiSingleton()
+    {
+        $this->router->apiSingleton('user', RouteRegistrarControllerStub::class);
+
+        $this->assertCount(2, $this->router->getRoutes());
+
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.show'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.update'));
+    }
+
+    public function testCanRegisterCreatableSingleton()
+    {
+        $this->router->singleton('user', RouteRegistrarControllerStub::class)->creatable();
+
+        $this->assertCount(6, $this->router->getRoutes());
+
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.create'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.store'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.show'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.edit'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.update'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.destroy'));
+    }
+
+    public function testCanRegisterCreatableApiSingleton()
+    {
+        $this->router->apiSingleton('user', RouteRegistrarControllerStub::class)->creatable();
+
+        $this->assertCount(4, $this->router->getRoutes());
+
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.store'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.show'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.update'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.destroy'));
+    }
+
+    public function testSingletonCreatableNotDestroyable()
+    {
+        $this->router->singleton('user', RouteRegistrarControllerStub::class)
+            ->creatable()
+            ->except('destroy');
+
+        $this->assertCount(5, $this->router->getRoutes());
+
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.create'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.store'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.show'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.edit'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.update'));
+        $this->assertFalse($this->router->getRoutes()->hasNamedRoute('user.destroy'));
+    }
+
+    public function testApiSingletonCreatableNotDestroyable()
+    {
+        $this->router->apiSingleton('user', RouteRegistrarControllerStub::class)
+            ->creatable()
+            ->except('destroy');
+
+        $this->assertCount(3, $this->router->getRoutes());
+
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.store'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.show'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.update'));
+        $this->assertFalse($this->router->getRoutes()->hasNamedRoute('user.destroy'));
+    }
+
+    public function testSingletonCanBeDestroyable()
+    {
+        $this->router->singleton('user', RouteRegistrarControllerStub::class)
+            ->destroyable();
+
+        $this->assertCount(4, $this->router->getRoutes());
+
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.show'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.edit'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.update'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.destroy'));
+    }
+
+    public function testApiSingletonCanBeDestroyable()
+    {
+        $this->router->apiSingleton('user', RouteRegistrarControllerStub::class)
+            ->destroyable();
+
+        $this->assertCount(3, $this->router->getRoutes());
+
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.show'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.update'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.destroy'));
+    }
+
+    public function testSingletonCanBeOnlyCreatable()
+    {
+        $this->router->singleton('user', RouteRegistrarControllerStub::class)
+            ->creatable()
+            ->only('create', 'store');
+
+        $this->assertCount(2, $this->router->getRoutes());
+
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.create'));
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.store'));
+    }
+
+    public function testApiSingletonCanBeOnlyCreatable()
+    {
+        $this->router->apiSingleton('user', RouteRegistrarControllerStub::class)
+            ->creatable()
+            ->only('store');
+
+        $this->assertCount(1, $this->router->getRoutes());
+
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.store'));
+    }
+
+    public function testSingletonDoesntAllowIncludingUnsupportedMethods()
+    {
+        $this->router->singleton('post', RouteRegistrarControllerStub::class)
+            ->only('index', 'store', 'create', 'destroy');
+
+        $this->assertCount(0, $this->router->getRoutes());
+
+        $this->router->apiSingleton('user', RouteRegistrarControllerStub::class)
+            ->only('index', 'store', 'create', 'destroy');
+
+        $this->assertCount(0, $this->router->getRoutes());
+    }
+
+    public function testApiSingletonCanIncludeAnySingletonMethods()
+    {
+        // This matches the behavior of the apiResource method.
+        $this->router->apiSingleton('user', RouteRegistrarControllerStub::class)
+            ->only('edit');
+
+        $this->assertCount(1, $this->router->getRoutes());
+
+        $this->assertTrue($this->router->getRoutes()->hasNamedRoute('user.edit'));
+    }
+
     /**
      * Get the last route registered with the router.
      *