fix(laravel): snake case props (#6532)

* fix(laravel): snake case props

# Conflicts:
#	src/Laravel/Eloquent/PropertyAccess/PropertyAccessor.php

* feat: convert snake case to camel case

* cleanup

* fix: cs

* tests: add name converter test

* fix: phpstan

Author: dunglas

src/Laravel/ApiPlatformProvider.php

@@ -50,6 +50,7 @@
 use ApiPlatform\Laravel\Eloquent\Metadata\ResourceClassResolver as EloquentResourceClassResolver;
 use ApiPlatform\Laravel\Eloquent\PropertyAccess\PropertyAccessor as EloquentPropertyAccessor;
 use ApiPlatform\Laravel\Eloquent\Serializer\SerializerContextBuilder as EloquentSerializerContextBuilder;
+use ApiPlatform\Laravel\Eloquent\Serializer\SnakeCaseToCamelCaseNameConverter;
 use ApiPlatform\Laravel\Eloquent\State\CollectionProvider;
 use ApiPlatform\Laravel\Eloquent\State\ItemProvider;
 use ApiPlatform\Laravel\Eloquent\State\LinksHandler;
@@ -131,7 +132,6 @@
 use Negotiation\Negotiator;
 use phpDocumentor\Reflection\DocBlockFactory;
 use Psr\Log\LoggerInterface;
-use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
 use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
@@ -142,7 +142,6 @@
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
 use Symfony\Component\Serializer\Mapping\Loader\AttributeLoader;
 use Symfony\Component\Serializer\Mapping\Loader\LoaderInterface;
-use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter as NameConverterCamelCaseToSnakeCaseNameConverter;
 use Symfony\Component\Serializer\NameConverter\MetadataAwareNameConverter;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
@@ -284,11 +283,11 @@ public function register(): void
         });
 
         $this->app->bind(PropertyAccessorInterface::class, function () {
-            return new EloquentPropertyAccessor(PropertyAccess::createPropertyAccessor());
+            return new EloquentPropertyAccessor();
         });
 
         $this->app->bind(NameConverterInterface::class, function (Application $app) {
-            return new MetadataAwareNameConverter($app->make(ClassMetadataFactoryInterface::class), new NameConverterCamelCaseToSnakeCaseNameConverter());
+            return new MetadataAwareNameConverter($app->make(ClassMetadataFactoryInterface::class), $app->make(SnakeCaseToCamelCaseNameConverter::class));
         });
 
         $this->app->bind(OperationMetadataFactoryInterface::class, OperationMetadataFactory::class);

src/Laravel/Eloquent/PropertyAccess/PropertyAccessor.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Laravel\Eloquent\PropertyAccess;
 
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\PropertyAccess\PropertyPathInterface;
 
@@ -22,9 +23,12 @@
  */
 final class PropertyAccessor implements PropertyAccessorInterface
 {
+    private readonly PropertyAccessorInterface $inner;
+
     public function __construct(
-        private readonly PropertyAccessorInterface $inner,
+        ?PropertyAccessorInterface $inner = null,
     ) {
+        $this->inner = $inner ?? PropertyAccess::createPropertyAccessor();
     }
 
     /**

src/Laravel/Eloquent/Serializer/SnakeCaseToCamelCaseNameConverter.php

@@ -0,0 +1,71 @@
+<?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);
+
+namespace ApiPlatform\Laravel\Eloquent\Serializer;
+
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
+
+/**
+ * Underscore to cameCase name converter.
+ *
+ * @internal
+ *
+ * @see Adapted from https://github.com/symfony/symfony/blob/7.2/src/Symfony/Component/Serializer/NameConverter/CamelCaseToSnakeCaseNameConverter.php.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ * @author Aurélien Pillevesse <[email protected]>
+ * @copyright Fabien Potencier <[email protected]>
+ */
+final class SnakeCaseToCamelCaseNameConverter implements NameConverterInterface
+{
+    /**
+     * @param string[]|null $attributes The list of attributes to rename or null for all attributes
+     */
+    public function __construct(
+        private readonly ?array $attributes = null,
+    ) {
+    }
+
+    /**
+     * @param class-string|null    $class
+     * @param array<string, mixed> $context
+     */
+    public function normalize(
+        string $propertyName, ?string $class = null, ?string $format = null, array $context = []
+    ): string {
+        if (null === $this->attributes || \in_array($propertyName, $this->attributes, true)) {
+            return lcfirst(preg_replace_callback(
+                '/(^|_|\.)+(.)/',
+                fn ($match) => ('.' === $match[1] ? '_' : '').strtoupper($match[2]),
+                $propertyName
+            ));
+        }
+
+        return $propertyName;
+    }
+
+    /**
+     * @param class-string|null    $class
+     * @param array<string, mixed> $context
+     */
+    public function denormalize(
+        string $propertyName, ?string $class = null, ?string $format = null, array $context = []
+    ): string {
+        $snakeCased = strtolower(preg_replace('/[A-Z]/', '_\\0', lcfirst($propertyName)));
+        if (null === $this->attributes || \in_array($snakeCased, $this->attributes, true)) {
+            return $snakeCased;
+        }
+
+        return $propertyName;
+    }
+}

src/Laravel/Tests/JsonApiTest.php

@@ -69,7 +69,7 @@ public function testCreateBook(): void
             '/api/books',
             [
                 'data' => [
-                    'attributes' => ['name' => 'Don Quichotte', 'isbn' => fake()->isbn13()],
+                    'attributes' => ['name' => 'Don Quichotte', 'isbn' => fake()->isbn13(), 'publicationDate' => fake()->date()],
                     'relationships' => ['author' => ['data' => ['id' => $this->getIriFromResource($author), 'type' => 'Author']]],
                 ],
             ],

src/Laravel/Tests/JsonLdTest.php

@@ -63,6 +63,7 @@ public function testCreateBook(): void
                 'name' => 'Don Quichotte',
                 'author' => $this->getIriFromResource($author),
                 'isbn' => fake()->isbn13(),
+                'publicationDate' => fake()->date(),
             ],
             [
                 'accept' => 'application/ld+json',

src/Laravel/workbench/app/Models/Book.php

@@ -30,7 +30,7 @@ class Book extends Model
     use HasFactory;
     use HasUlids;
 
-    protected $visible = ['name', 'author', 'isbn'];
+    protected $visible = ['name', 'author', 'isbn', 'publication_date'];
     protected $fillable = ['name'];
 
     public function author(): BelongsTo

src/Laravel/workbench/database/factories/BookFactory.php

@@ -36,6 +36,7 @@ public function definition(): array
             'id' => (string) new Ulid(),
             'author_id' => AuthorFactory::new(),
             'isbn' => fake()->isbn13(),
+            'publication_date' => fake()->date(),
         ];
     }
 }

src/Laravel/workbench/database/migrations/2023_07_15_231244_create_book_table.php

@@ -31,6 +31,7 @@ public function up(): void
             $table->ulid('id')->primary();
             $table->string('name');
             $table->string('isbn');
+            $table->date('publication_date');
             $table->integer('author_id')->unsigned();
             $table->foreign('author_id')->references('id')->on('authors');
             $table->timestamps();

src/Metadata/Util/CamelCaseToSnakeCaseNameConverter.php

@@ -31,17 +31,14 @@
  */
 class CamelCaseToSnakeCaseNameConverter
 {
-    private $attributes;
-    private $lowerCamelCase;
-
     /**
      * @param array|null $attributes     The list of attributes to rename or null for all attributes
      * @param bool       $lowerCamelCase Use lowerCamelCase style
      */
-    public function __construct(?array $attributes = null, bool $lowerCamelCase = true)
-    {
-        $this->attributes = $attributes;
-        $this->lowerCamelCase = $lowerCamelCase;
+    public function __construct(
+        private readonly ?array $attributes = null,
+        private readonly bool $lowerCamelCase = true,
+    ) {
     }
 
     public function normalize(string $propertyName): string
@@ -55,9 +52,11 @@ public function normalize(string $propertyName): string
 
     public function denormalize(string $propertyName): string
     {
-        $camelCasedName = preg_replace_callback('/(^|_|\.)+(.)/', function ($match) {
-            return ('.' === $match[1] ? '_' : '').strtoupper($match[2]);
-        }, $propertyName);
+        $camelCasedName = preg_replace_callback(
+            '/(^|_|\.)+(.)/',
+            fn ($match) => ('.' === $match[1] ? '_' : '').strtoupper($match[2]),
+            $propertyName
+        );
 
         if ($this->lowerCamelCase) {
             $camelCasedName = lcfirst($camelCasedName);