feat: use ApiProperty::uriTemplate option

Author: vincentchalamon

api/src/Entity/Book.php

@@ -20,6 +20,8 @@
 use App\Repository\BookRepository;
 use App\State\Processor\BookPersistProcessor;
 use App\State\Processor\BookRemoveProcessor;
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator;
@@ -159,14 +161,18 @@ class Book
     /**
      * An IRI of reviews.
      *
+     * @var Collection<int, Review>
+     *
      * @see https://schema.org/reviews
      */
     #[ApiProperty(
         types: ['https://schema.org/reviews'],
-        example: '/books/6acacc80-8321-4d83-9b02-7f2c7bf6eb1d/reviews'
+        example: '/books/6acacc80-8321-4d83-9b02-7f2c7bf6eb1d/reviews',
+        uriTemplate: '/books/{bookId}/reviews{._format}'
     )]
     #[Groups(groups: ['Book:read', 'Bookmark:read'])]
-    public ?string $reviews = null;
+    #[ORM\OneToMany(targetEntity: Review::class, mappedBy: 'book')]
+    public Collection $reviews;
 
     /**
      * The overall rating, based on a collection of reviews or ratings, of the item.
@@ -180,6 +186,11 @@ class Book
     #[Groups(groups: ['Book:read', 'Book:read:admin', 'Bookmark:read'])]
     public ?int $rating = null;
 
+    public function __construct()
+    {
+        $this->reviews = new ArrayCollection();
+    }
+
     public function getId(): ?Uuid
     {
         return $this->id;

api/src/Entity/Review.php

@@ -174,7 +174,7 @@ class Review
     #[ApiProperty(types: ['https://schema.org/itemReviewed'])]
     #[Assert\NotNull]
     #[Groups(groups: ['Review:read', 'Review:write:admin'])]
-    #[ORM\ManyToOne(targetEntity: Book::class)]
+    #[ORM\ManyToOne(targetEntity: Book::class, inversedBy: 'reviews')]
     #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')]
     public ?Book $book = null;
 

api/src/Serializer/BookNormalizer.php

@@ -8,7 +8,6 @@
 use App\Repository\ReviewRepository;
 use Doctrine\Persistence\ObjectRepository;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
-use Symfony\Component\Routing\RouterInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
@@ -21,7 +20,6 @@ final class BookNormalizer implements NormalizerInterface, NormalizerAwareInterf
      * @param ReviewRepository $repository
      */
     public function __construct(
-        private RouterInterface $router,
         #[Autowire(service: ReviewRepository::class)]
         private ObjectRepository $repository
     ) {
@@ -32,9 +30,6 @@ public function __construct(
      */
     public function normalize(mixed $object, ?string $format = null, array $context = []): array
     {
-        $object->reviews = $this->router->generate('_api_/books/{bookId}/reviews{._format}_get_collection', [
-            'bookId' => $object->getId(),
-        ]);
         $object->rating = $this->repository->getAverageRating($object);
 
         return $this->normalizer->normalize($object, $format, [self::class => true] + $context);

api/tests/Serializer/BookNormalizerTest.php

@@ -11,26 +11,22 @@
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Routing\RouterInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
-use Symfony\Component\Uid\Uuid;
 
 final class BookNormalizerTest extends TestCase
 {
     private MockObject|NormalizerInterface $normalizerMock;
-    private MockObject|RouterInterface $routerMock;
     private MockObject|ReviewRepository $repositoryMock;
     private Book|MockObject $objectMock;
     private BookNormalizer $normalizer;
 
     protected function setUp(): void
     {
         $this->normalizerMock = $this->createMock(NormalizerInterface::class);
-        $this->routerMock = $this->createMock(RouterInterface::class);
         $this->repositoryMock = $this->createMock(ReviewRepository::class);
         $this->objectMock = $this->createMock(Book::class);
 
-        $this->normalizer = new BookNormalizer($this->routerMock, $this->repositoryMock);
+        $this->normalizer = new BookNormalizer($this->repositoryMock);
         $this->normalizer->setNormalizer($this->normalizerMock);
     }
 
@@ -56,20 +52,8 @@ public function itSupportsValidObjectClassAndContext(): void
     public function itNormalizesData(): void
     {
         $expectedObject = $this->objectMock;
-        $expectedObject->reviews = '/books/a528046c-7ba1-4acc-bff2-b5390ab17d41/reviews';
         $expectedObject->rating = 3;
 
-        $this->objectMock
-            ->expects($this->once())
-            ->method('getId')
-            ->willReturn(Uuid::fromString('a528046c-7ba1-4acc-bff2-b5390ab17d41'))
-        ;
-        $this->routerMock
-            ->expects($this->once())
-            ->method('generate')
-            ->with('_api_/books/{bookId}/reviews{._format}_get_collection', ['bookId' => 'a528046c-7ba1-4acc-bff2-b5390ab17d41'])
-            ->willReturn('/books/a528046c-7ba1-4acc-bff2-b5390ab17d41/reviews')
-        ;
         $this->repositoryMock
             ->expects($this->once())
             ->method('getAverageRating')

compose.override.yaml

@@ -15,7 +15,7 @@ services:
     environment:
       MERCURE_EXTRA_DIRECTIVES: demo
       # See https://xdebug.org/docs/all_settings#mode
-      XDEBUG_MODE: debug
+      XDEBUG_MODE: "${XDEBUG_MODE:-off}"
     extra_hosts:
       # Ensure that host.docker.internal is correctly defined on Linux
       - host.docker.internal:host-gateway