Add StoredObjectVersionApiController and corresponding test

Added a new class StoredObjectVersionApiController in ChillDocGeneratorBundle which lists versions of a specified stored object. Corresponding unit test has been added as well. Made modifications in `StoredObject.php` to make the versions selectable. Also updated the API specifications to include a new GET route for retrieving versions.

src/Bundle/ChillDocStoreBundle/Controller/StoredObjectVersionApiController.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\DocStoreBundle\Controller;
+
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Security\Authorization\StoredObjectRoleEnum;
+use Chill\MainBundle\Pagination\PaginatorFactoryInterface;
+use Chill\MainBundle\Serializer\Model\Collection;
+use Doctrine\Common\Collections\Criteria;
+use Doctrine\Common\Collections\Order;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
+use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Component\Security\Core\Security;
+use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
+use Symfony\Component\Serializer\SerializerInterface;
+
+final readonly class StoredObjectVersionApiController
+{
+    public function __construct(
+        private PaginatorFactoryInterface $paginatorFactory,
+        private SerializerInterface $serializer,
+        private Security $security,
+    ) {}
+
+    /**
+     * Lists the versions of the specified stored object.
+     *
+     * @param StoredObject $storedObject the stored object whose versions are to be listed
+     *
+     * @return JsonResponse a JSON response containing the serialized versions of the stored object, encapsulated in a collection
+     *
+     * @throws AccessDeniedHttpException if the user is not allowed to see the stored object
+     */
+    #[Route('/api/1.0/doc-store/stored-object/{uuid}/versions', name: 'chill_doc_store_stored_object_versions_list')]
+    public function listVersions(StoredObject $storedObject): JsonResponse
+    {
+        if (!$this->security->isGranted(StoredObjectRoleEnum::SEE->value, $storedObject)) {
+            throw new AccessDeniedHttpException('not allowed to see this stored object');
+        }
+
+        $total = $storedObject->getVersions()->count();
+        $paginator = $this->paginatorFactory->create($total);
+
+        $criteria = Criteria::create();
+        $criteria->orderBy(['id' => Order::Ascending]);
+        $criteria->setMaxResults($paginator->getItemsPerPage())->setFirstResult($paginator->getCurrentPageFirstItemNumber());
+        $items = $storedObject->getVersions()->matching($criteria);
+
+        return new JsonResponse(
+            $this->serializer->serialize(new Collection($items, $paginator), 'json', [AbstractNormalizer::GROUPS => ['read']]),
+            json: true
+        );
+    }
+}

src/Bundle/ChillDocStoreBundle/Entity/StoredObject.php

@@ -18,6 +18,7 @@ use Chill\MainBundle\Doctrine\Model\TrackCreationInterface;
 use Chill\MainBundle\Doctrine\Model\TrackCreationTrait;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Collections\Selectable;
 use Doctrine\ORM\Mapping as ORM;
 use Ramsey\Uuid\Uuid;
 use Ramsey\Uuid\UuidInterface;
@@ -89,10 +90,10 @@ class StoredObject implements Document, TrackCreationInterface
     private string $generationErrors = '';
 
     /**
-     * @var Collection<int, StoredObjectVersion>
+     * @var Collection<int, StoredObjectVersion>&Selectable<int, StoredObjectVersion>
      */
     #[ORM\OneToMany(mappedBy: 'storedObject', targetEntity: StoredObjectVersion::class, cascade: ['persist'], orphanRemoval: true)]
-    private Collection $versions;
+    private Collection&Selectable $versions;
 
     /**
      * @param StoredObject::STATUS_* $status
@@ -256,7 +257,7 @@ class StoredObject implements Document, TrackCreationInterface
         return $this->template;
     }
 
-    public function getVersions(): Collection
+    public function getVersions(): Collection&Selectable
     {
         return $this->versions;
     }

src/Bundle/ChillDocStoreBundle/Tests/Controller/StoredObjectVersionApiControllerTest.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\DocStoreBundle\Tests\Controller;
+
+use Chill\DocStoreBundle\Controller\StoredObjectVersionApiController;
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Security\Authorization\StoredObjectRoleEnum;
+use Chill\DocStoreBundle\Serializer\Normalizer\StoredObjectVersionNormalizer;
+use Chill\MainBundle\Pagination\Paginator;
+use Chill\MainBundle\Pagination\PaginatorFactoryInterface;
+use Chill\MainBundle\Serializer\Normalizer\CollectionNormalizer;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Symfony\Component\Security\Core\Security;
+use Symfony\Component\Serializer\Encoder\JsonEncoder;
+use Symfony\Component\Serializer\Serializer;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class StoredObjectVersionApiControllerTest extends \PHPUnit\Framework\TestCase
+{
+    use ProphecyTrait;
+
+    public function testListVersion(): void
+    {
+        $storedObject = new StoredObject();
+        for ($i = 0; $i < 15; ++$i) {
+            $storedObject->registerVersion();
+        }
+
+        $security = $this->prophesize(Security::class);
+        $security->isGranted(StoredObjectRoleEnum::SEE->value, $storedObject)
+            ->willReturn(true)
+            ->shouldBeCalledOnce();
+
+        $controller = $this->buildController($security->reveal());
+
+        $response = $controller->listVersions($storedObject);
+        $body = json_decode($response->getContent(), true, 512, JSON_THROW_ON_ERROR);
+
+        self::assertEquals($response->getStatusCode(), 200);
+        self::assertIsArray($body);
+        self::assertArrayHasKey('results', $body);
+        self::assertCount(10, $body['results']);
+    }
+
+    private function buildController(Security $security): StoredObjectVersionApiController
+    {
+        $paginator = $this->prophesize(Paginator::class);
+        $paginator->getCurrentPageFirstItemNumber()->willReturn(0);
+        $paginator->getItemsPerPage()->willReturn(10);
+        $paginator->getTotalItems()->willReturn(15);
+        $paginator->hasNextPage()->willReturn(false);
+        $paginator->hasPreviousPage()->willReturn(false);
+
+        $paginatorFactory = $this->prophesize(PaginatorFactoryInterface::class);
+        $paginatorFactory->create(Argument::type('int'))->willReturn($paginator);
+
+        $serializer = new Serializer([
+            new StoredObjectVersionNormalizer(), new CollectionNormalizer(),
+        ], [new JsonEncoder()]);
+
+        return new StoredObjectVersionApiController($paginatorFactory->reveal(), $serializer, $security);
+    }
+}

src/Bundle/ChillDocStoreBundle/chill.api.specs.yaml

@@ -105,3 +105,28 @@ paths:
                 404:
                     description: "Not found"
 
+    /1.0/doc-store/stored-object/{uuid}/versions:
+        get:
+            tags:
+                - storedobject
+            summary: Get a signed route to post stored object
+            parameters:
+                - in: path
+                  name: uuid
+                  required: true
+                  allowEmptyValue: false
+                  description: The UUID of the storedObjeect
+                  schema:
+                      type: string
+                      format: uuid
+            responses:
+                200:
+                    description: "OK"
+                    content:
+                        application/json:
+                            schema:
+                                type: object
+                403:
+                    description: "Unauthorized"
+                404:
+                    description: "Not found"