From a60ea0e0661674ee56bde9ce823a3d5b8985e380 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julien=20Fastr=C3=A9?= <julien.fastre@champs-libres.coop>
Date: Tue, 10 Sep 2024 14:28:47 +0200
Subject: [PATCH] Add StoredObjectToPdfConverter service and unit tests

Introduced the StoredObjectToPdfConverter service to handle conversion of stored objects to PDF format. Added unit tests to ensure proper functionality, including versioning and exception handling.
---
 .../Service/StoredObjectToPdfConverter.php    | 75 +++++++++++++++++++
 .../StoredObjectToPdfConverterTest.php        | 61 +++++++++++++++
 2 files changed, 136 insertions(+)
 create mode 100644 src/Bundle/ChillDocStoreBundle/Service/StoredObjectToPdfConverter.php
 create mode 100644 src/Bundle/ChillDocStoreBundle/Tests/Service/StoredObjectToPdfConverterTest.php

diff --git a/src/Bundle/ChillDocStoreBundle/Service/StoredObjectToPdfConverter.php b/src/Bundle/ChillDocStoreBundle/Service/StoredObjectToPdfConverter.php
new file mode 100644
index 000000000..abfcca4cc
--- /dev/null
+++ b/src/Bundle/ChillDocStoreBundle/Service/StoredObjectToPdfConverter.php
@@ -0,0 +1,75 @@
+<?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\Service;
+
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Entity\StoredObjectPointInTime;
+use Chill\DocStoreBundle\Entity\StoredObjectPointInTimeReasonEnum;
+use Chill\DocStoreBundle\Entity\StoredObjectVersion;
+use Chill\DocStoreBundle\Exception\StoredObjectManagerException;
+use Chill\WopiBundle\Service\WopiConverter;
+use Symfony\Component\Mime\MimeTypesInterface;
+
+/**
+ * Class StoredObjectToPdfConverter.
+ *
+ * Converts stored objects to PDF or other specified formats using WopiConverter.
+ */
+class StoredObjectToPdfConverter
+{
+    public function __construct(
+        private readonly StoredObjectManagerInterface $storedObjectManager,
+        private readonly WopiConverter $wopiConverter,
+        private readonly MimeTypesInterface $mimeTypes,
+    ) {}
+
+    /**
+     * Converts the given stored object to a specified format and stores the new version.
+     *
+     * @param StoredObject $storedObject the stored object to be converted
+     * @param string       $lang         the language for the conversion context
+     * @param string       $convertTo    The target format for the conversion. Default is 'pdf'.
+     *
+     * @return array{0: StoredObjectPointInTime, 1: StoredObjectVersion} contains the point in time before conversion and the new version of the stored object
+     *
+     * @throws \UnexpectedValueException    if the preferred mime type for the conversion is not found
+     * @throws \RuntimeException            if the conversion or storage of the new version fails
+     * @throws StoredObjectManagerException
+     */
+    public function addConvertedVersion(StoredObject $storedObject, string $lang, $convertTo = 'pdf'): array
+    {
+        $newMimeType = $this->mimeTypes->getMimeTypes($convertTo)[0] ?? null;
+
+        if (null === $newMimeType) {
+            throw new \UnexpectedValueException(sprintf('could not find a preferred mime type for conversion to %s', $convertTo));
+        }
+
+        $currentVersion = $storedObject->getCurrentVersion();
+
+        if ($currentVersion->getType() === $newMimeType) {
+            throw new \UnexpectedValueException('Already at the same mime type');
+        }
+
+        $content = $this->storedObjectManager->read($currentVersion);
+
+        try {
+            $converted = $this->wopiConverter->convert($lang, $content, $newMimeType, $convertTo);
+        } catch (\RuntimeException $e) {
+            throw new \RuntimeException('could not store a new version for document', previous: $e);
+        }
+
+        $pointInTime = new StoredObjectPointInTime($currentVersion, StoredObjectPointInTimeReasonEnum::KEEP_BEFORE_CONVERSION);
+        $version = $this->storedObjectManager->write($storedObject, $converted, $newMimeType);
+
+        return [$pointInTime, $version];
+    }
+}
diff --git a/src/Bundle/ChillDocStoreBundle/Tests/Service/StoredObjectToPdfConverterTest.php b/src/Bundle/ChillDocStoreBundle/Tests/Service/StoredObjectToPdfConverterTest.php
new file mode 100644
index 000000000..da3ed9210
--- /dev/null
+++ b/src/Bundle/ChillDocStoreBundle/Tests/Service/StoredObjectToPdfConverterTest.php
@@ -0,0 +1,61 @@
+<?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\Service;
+
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Entity\StoredObjectPointInTime;
+use Chill\DocStoreBundle\Entity\StoredObjectVersion;
+use Chill\DocStoreBundle\Service\StoredObjectManagerInterface;
+use Chill\DocStoreBundle\Service\StoredObjectToPdfConverter;
+use Chill\WopiBundle\Service\WopiConverter;
+use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Symfony\Component\Mime\MimeTypes;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class StoredObjectToPdfConverterTest extends TestCase
+{
+    use ProphecyTrait;
+
+    public function testAddConvertedVersion(): void
+    {
+        $storedObject = new StoredObject();
+        $currentVersion = $storedObject->registerVersion(type: 'text/html');
+
+        $storedObjectManager = $this->prophesize(StoredObjectManagerInterface::class);
+        $storedObjectManager->read($currentVersion)->willReturn('1234');
+        $storedObjectManager->write($storedObject, '5678', 'application/pdf')->shouldBeCalled()
+            ->will(function ($args) {
+                /** @var StoredObject $storedObject */
+                $storedObject = $args[0];
+
+                return $storedObject->registerVersion(type: $args[2]);
+            });
+
+        $converter = $this->prophesize(WopiConverter::class);
+        $converter->convert('fr', '1234', 'application/pdf', 'pdf')->shouldBeCalled()
+            ->willReturn('5678');
+
+        $converter = new StoredObjectToPdfConverter($storedObjectManager->reveal(), $converter->reveal(), MimeTypes::getDefault());
+
+        $actual = $converter->addConvertedVersion($storedObject, 'fr');
+
+        self::assertIsArray($actual);
+        self::assertInstanceOf(StoredObjectPointInTime::class, $actual[0]);
+        self::assertSame($currentVersion, $actual[0]->getObjectVersion());
+        self::assertInstanceOf(StoredObjectVersion::class, $actual[1]);
+    }
+}