[Refactor] Retrieve resource URI from the schema

The schema now has a `uriType` method which returns the resource
type as it appears in URIs. This commit updates the routing
implementation to use the value from the schema, and removes
the `uri()` method on resource route registration as it is no
longer needed.

Author: lindyhopchris

CHANGELOG.md

@@ -35,8 +35,9 @@ classes you are retaining.
 ### Removed
 - **BREAKING** The `Arr` schema field has been removed - use the new `ArrayList` or `ArrayHash`
 fields instead.
-- **BREAKING** The `uri` method on relationship routes has been removed. Relationship URIs
-are now set on the schema field for the relationship (via the `withUriFieldName` method).
+- **BREAKING** The `uri` method on resource and relationship routes has been removed:
+  - The resource type URI can now be set on the resource's schema (using the `$uriType` property).
+  - Relationship URIs are now set on the schema field for the relationship (via the `withUriFieldName` method).
 
 ## [1.0.0-alpha.1] - 2021-01-25
 

src/Routing/PendingResourceRegistration.php

@@ -82,19 +82,6 @@ public function __construct(
         $this->options = [];
     }
 
-    /**
-     * Set the URI for the resource type, if it is not the same as the resource type's name.
-     *
-     * @param string $uri
-     * @return $this
-     */
-    public function uri(string $uri): self
-    {
-        $this->options['resource_uri'] = $uri;
-
-        return $this;
-    }
-
     /**
      * Set the methods the controller should apply to.
      *

src/Routing/ResourceRegistrar.php

@@ -140,7 +140,7 @@ public function register(string $resourceType, string $controller, array $option
      */
     protected function addResourceIndex(string $resourceType, string $controller, array $options): IlluminateRoute
     {
-        $uri = $this->getResourceUri($resourceType, $options);
+        $uri = $this->getResourceUri($resourceType);
         $action = $this->getResourceAction($resourceType, $controller, 'index', null, $options);
 
         $route = $this->router->get($uri, $action);
@@ -159,7 +159,7 @@ protected function addResourceIndex(string $resourceType, string $controller, ar
      */
     protected function addResourceStore(string $resourceType, string $controller, array $options): IlluminateRoute
     {
-        $uri = $this->getResourceUri($resourceType, $options);
+        $uri = $this->getResourceUri($resourceType);
         $action = $this->getResourceAction($resourceType, $controller, 'store', null, $options);
 
         $route = $this->router->post($uri, $action);
@@ -179,7 +179,7 @@ protected function addResourceStore(string $resourceType, string $controller, ar
     protected function addResourceShow(string $resourceType, string $controller, array $options): IlluminateRoute
     {
         $parameter = $this->getResourceParameterName($resourceType, $options);
-        $uri = $this->getResourceUri($resourceType, $options);
+        $uri = $this->getResourceUri($resourceType);
         $action = $this->getResourceAction($resourceType, $controller, 'show', $parameter, $options);
 
         $route = $this->router->get(sprintf('%s/{%s}', $uri, $parameter), $action);
@@ -200,7 +200,7 @@ protected function addResourceShow(string $resourceType, string $controller, arr
     protected function addResourceUpdate(string $resourceType, string $controller, array $options): IlluminateRoute
     {
         $parameter = $this->getResourceParameterName($resourceType, $options);
-        $uri = $this->getResourceUri($resourceType, $options);
+        $uri = $this->getResourceUri($resourceType);
         $action = $this->getResourceAction($resourceType, $controller, 'update', $parameter, $options);
 
         $route = $this->router->patch(sprintf('%s/{%s}', $uri, $parameter), $action);
@@ -221,7 +221,7 @@ protected function addResourceUpdate(string $resourceType, string $controller, a
     protected function addResourceDestroy(string $resourceType, string $controller, array $options): IlluminateRoute
     {
         $parameter = $this->getResourceParameterName($resourceType, $options);
-        $uri = $this->getResourceUri($resourceType, $options);
+        $uri = $this->getResourceUri($resourceType);
         $action = $this->getResourceAction($resourceType, $controller, 'destroy', $parameter, $options);
 
         $route = $this->router->delete(sprintf('%s/{%s}', $uri, $parameter), $action);
@@ -233,16 +233,14 @@ protected function addResourceDestroy(string $resourceType, string $controller,
 
     /**
      * @param string $resourceType
-     * @param array $options
      * @return string
      */
-    private function getResourceUri(string $resourceType, array $options): string
+    private function getResourceUri(string $resourceType): string
     {
-        if (isset($options['resource_uri'])) {
-            return $options['resource_uri'];
-        }
-
-        return Str::dasherize($resourceType);
+        return $this->server
+            ->schemas()
+            ->schemaFor($resourceType)
+            ->uriType();
     }
 
     /**
@@ -313,7 +311,7 @@ private function getResourceAction(
      */
     private function getRelationshipsAction(string $resourceType, ?string $parameter, array $options)
     {
-        $uri = $this->getResourceUri($resourceType, $options);
+        $uri = $this->getResourceUri($resourceType);
 
         $action = [
             'prefix' => sprintf('%s/{%s}', $uri, $parameter),

tests/lib/Integration/Routing/ResourceTest.php

@@ -281,14 +281,14 @@ public function testServerDomain(string $method, string $uri): void
     public function testResourceUri(string $method, string $uri): void
     {
         $server = $this->createServer('v1');
-        $this->createSchema($server, 'blog:posts');
+        $this->createSchema($server, 'blog:posts', null, 'posts');
 
         $this->defaultApiRoutesWithNamespace(function () {
             JsonApiRoute::server('v1')
                 ->prefix('v1')
                 ->namespace('Api\\V1')
                 ->resources(function ($server) {
-                    $server->resource('blog:posts')->uri('posts');
+                    $server->resource('blog:posts');
                 });
         });
 
@@ -469,44 +469,4 @@ public function testReadOnly(): void
         ]);
     }
 
-    /**
-     * @return array
-     */
-    public function multiWordProvider(): array
-    {
-        return [
-            'dash' => ['blog-posts', 'blog-posts', 'blog_post'],
-            'underscore' => ['blog_posts', 'blog-posts', 'blog_post'],
-            'camel' => ['blogPosts', 'blog-posts', 'blogPost'],
-        ];
-    }
-
-    /**
-     * @param string $type
-     * @param string $uri
-     * @param string $parameter
-     * @dataProvider multiWordProvider
-     * @see https://github.com/cloudcreativity/laravel-json-api/issues/224
-     */
-    public function testMultiWord(string $type, string $uri, string $parameter): void
-    {
-        $server = $this->createServer('v1');
-        $this->createSchema($server, $type, '\d+');
-
-        $this->defaultApiRoutesWithNamespace(function () use ($type) {
-            JsonApiRoute::server('v1')
-                ->prefix('v1')
-                ->namespace('Api\\V1')
-                ->resources(function ($server) use ($type) {
-                    $server->resource($type);
-                });
-        });
-
-        $route = $this->assertMatch('GET', "/api/v1/{$uri}/123");
-        $this->assertSame("v1.{$type}.show", $route->getName());
-        $this->assertSame($type, $route->parameter('resource_type'));
-        $this->assertSame($parameter, $route->parameter('resource_id_name'));
-        $this->assertSame('\d+', $route->action['where'][$parameter] ?? null);
-    }
-
 }

tests/lib/Integration/Routing/TestCase.php

@@ -67,14 +67,21 @@ protected function createServer(string $name): Server
     /**
      * @param Server|MockObject $server
      * @param string $name
-     * @param string $pattern
+     * @param string|null $pattern
+     * @param string|null $uriType
      * @return Schema|MockObject
      */
-    protected function createSchema(Server $server, string $name, string $pattern = '[0-9]+'): Schema
+    protected function createSchema(
+        Server $server,
+        string $name,
+        string $pattern = null,
+        string $uriType = null
+    ): Schema
     {
         $schema = $this->createMock(Schema::class);
+        $schema->method('uriType')->willReturn($uriType ?: $name);
         $schema->method('id')->willReturn($id = $this->createMock(ID::class));
-        $id->method('pattern')->willReturn($pattern);
+        $id->method('pattern')->willReturn($pattern ?: '[0-9]+');
 
         $schemas = $this->createMock(Container::class);
         $schemas->method('schemaFor')->with($name)->willReturn($schema);