test(laravel): test to change the name converter

Author: soyuka

src/Laravel/ApiPlatformProvider.php

@@ -211,7 +211,10 @@ public function register(): void
             );
         });
 
-        $this->app->singleton(ModelMetadata::class);
+        $this->app->singleton(ModelMetadata::class, function () {
+            return new ModelMetadata();
+        });
+
         $this->app->bind(LoaderInterface::class, AttributeLoader::class);
         $this->app->bind(ClassMetadataFactoryInterface::class, ClassMetadataFactory::class);
         $this->app->singleton(ClassMetadataFactory::class, function (Application $app) {
@@ -314,9 +317,13 @@ public function register(): void
         $this->app->bind(NameConverterInterface::class, function (Application $app) {
             $config = $app['config'];
             $nameConverter = $config->get('api-platform.name_converter', SnakeCaseToCamelCaseNameConverter::class);
+            if ($nameConverter && class_exists($nameConverter)) {
+                $nameConverter = $app->make($nameConverter);
+            }
+
             $defaultContext = $config->get('api-platform.serializer', []);
 
-            return new HydraPrefixNameConverter(new MetadataAwareNameConverter($app->make(ClassMetadataFactoryInterface::class), $app->make($nameConverter)), $defaultContext);
+            return new HydraPrefixNameConverter(new MetadataAwareNameConverter($app->make(ClassMetadataFactoryInterface::class), $nameConverter), $defaultContext);
         });
 
         $this->app->singleton(OperationMetadataFactory::class, function (Application $app) {

src/Laravel/Eloquent/Metadata/ModelMetadata.php

@@ -13,11 +13,12 @@
 
 namespace ApiPlatform\Laravel\Eloquent\Metadata;
 
-use ApiPlatform\Metadata\Util\CamelCaseToSnakeCaseNameConverter;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
+use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
 /**
  * Inspired from Illuminate\Database\Console\ShowModelCommand.
@@ -26,8 +27,6 @@
  */
 final class ModelMetadata
 {
-    private CamelCaseToSnakeCaseNameConverter $relationNameConverter;
-
     /**
      * @var array<class-string, Collection<string, mixed>>
      */
@@ -57,9 +56,8 @@ final class ModelMetadata
         'morphedByMany',
     ];
 
-    public function __construct()
+    public function __construct(private NameConverterInterface $relationNameConverter = new CamelCaseToSnakeCaseNameConverter())
     {
-        $this->relationNameConverter = new CamelCaseToSnakeCaseNameConverter();
     }
 
     /**

src/Laravel/Tests/SnakeCaseApiTest.php

@@ -0,0 +1,72 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+use ApiPlatform\Laravel\Test\ApiTestAssertionsTrait;
+use Illuminate\Contracts\Config\Repository;
+use Illuminate\Foundation\Application;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Str;
+use Orchestra\Testbench\Concerns\WithWorkbench;
+use Orchestra\Testbench\TestCase;
+
+class SnakeCaseApiTest extends TestCase
+{
+    use ApiTestAssertionsTrait;
+    use RefreshDatabase;
+    use WithWorkbench;
+
+    /**
+     * @param Application $app
+     */
+    protected function defineEnvironment($app): void
+    {
+        tap($app['config'], function (Repository $config): void {
+            $config->set('api-platform.name_converter', null);
+            $config->set('api-platform.formats', ['jsonld' => ['application/ld+json']]);
+            $config->set('api-platform.docs_formats', ['jsonld' => ['application/ld+json']]);
+        });
+    }
+
+    public function testRelationIsHandledOnCreateWithNestedDataSnakeCase(): void
+    {
+        $cartData = [
+            'product_sku' => 'SKU_TEST_001',
+            'quantity' => 2,
+            'price_at_addition' => '19.99',
+            'shopping_cart' => [
+                'user_identifier' => 'user-'.Str::uuid()->toString(),
+                'status' => 'active',
+            ],
+        ];
+
+        $response = $this->postJson('/api/cart_items', $cartData, ['accept' => 'application/ld+json', 'content-type' => 'application/ld+json']);
+        $response->assertStatus(201);
+
+        $response
+            ->assertJson([
+                '@context' => '/api/contexts/CartItem',
+                '@id' => '/api/cart_items/1',
+                '@type' => 'CartItem',
+                'id' => 1,
+                'product_sku' => 'SKU_TEST_001',
+                'quantity' => 2,
+                'price_at_addition' => 19.99,
+                'shopping_cart' => [
+                    '@id' => '/api/shopping_carts/1',
+                    '@type' => 'ShoppingCart',
+                    'user_identifier' => $cartData['shopping_cart']['user_identifier'],
+                    'status' => 'active',
+                ],
+            ]);
+    }
+}