From d33da6519ae01fe217bdd757b2f005a47abf51bc 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 12:05:23 +0200
Subject: [PATCH] Add StoredObjectPointInTime entity and related functionality

Implemented a new StoredObjectPointInTime entity to manage snapshots of stored objects. This includes related migrations, enum for reasons, repository, and integration with StoredObjectVersion.
---
 .../Entity/StoredObjectPointInTime.php        | 67 +++++++++++++++++++
 .../StoredObjectPointInTimeReasonEnum.php     | 18 +++++
 .../Entity/StoredObjectVersion.php            | 46 +++++++++++++
 .../StoredObjectPointInTimeRepository.php     | 27 ++++++++
 .../migrations/Version20240910093735.php      | 49 ++++++++++++++
 5 files changed, 207 insertions(+)
 create mode 100644 src/Bundle/ChillDocStoreBundle/Entity/StoredObjectPointInTime.php
 create mode 100644 src/Bundle/ChillDocStoreBundle/Entity/StoredObjectPointInTimeReasonEnum.php
 create mode 100644 src/Bundle/ChillDocStoreBundle/Repository/StoredObjectPointInTimeRepository.php
 create mode 100644 src/Bundle/ChillDocStoreBundle/migrations/Version20240910093735.php

diff --git a/src/Bundle/ChillDocStoreBundle/Entity/StoredObjectPointInTime.php b/src/Bundle/ChillDocStoreBundle/Entity/StoredObjectPointInTime.php
new file mode 100644
index 000000000..bff5c60c1
--- /dev/null
+++ b/src/Bundle/ChillDocStoreBundle/Entity/StoredObjectPointInTime.php
@@ -0,0 +1,67 @@
+<?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\Entity;
+
+use Chill\MainBundle\Doctrine\Model\TrackCreationInterface;
+use Chill\MainBundle\Doctrine\Model\TrackCreationTrait;
+use Chill\MainBundle\Entity\User;
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * Represents a snapshot of a stored object at a specific point in time.
+ *
+ * This entity tracks versions of stored objects, reasons for the snapshot,
+ * and the user who initiated the action.
+ */
+#[ORM\Entity]
+#[ORM\Table(name: 'stored_object_point_in_time', schema: 'chill_doc')]
+class StoredObjectPointInTime implements TrackCreationInterface
+{
+    use TrackCreationTrait;
+
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::INTEGER)]
+    private ?int $id = null;
+
+    public function __construct(
+        #[ORM\ManyToOne(targetEntity: StoredObjectVersion::class, inversedBy: 'pointInTimes')]
+        #[ORM\JoinColumn(name: 'stored_object_version_id', nullable: false)]
+        private StoredObjectVersion $objectVersion,
+        #[ORM\Column(name: 'reason', type: \Doctrine\DBAL\Types\Types::TEXT, nullable: false, enumType: StoredObjectPointInTimeReasonEnum::class)]
+        private StoredObjectPointInTimeReasonEnum $reason,
+        #[ORM\ManyToOne(targetEntity: User::class)]
+        private ?User $byUser = null,
+    ) {
+        $this->objectVersion->addPointInTime($this);
+    }
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getByUser(): ?User
+    {
+        return $this->byUser;
+    }
+
+    public function getObjectVersion(): StoredObjectVersion
+    {
+        return $this->objectVersion;
+    }
+
+    public function getReason(): StoredObjectPointInTimeReasonEnum
+    {
+        return $this->reason;
+    }
+}
diff --git a/src/Bundle/ChillDocStoreBundle/Entity/StoredObjectPointInTimeReasonEnum.php b/src/Bundle/ChillDocStoreBundle/Entity/StoredObjectPointInTimeReasonEnum.php
new file mode 100644
index 000000000..9f03c7279
--- /dev/null
+++ b/src/Bundle/ChillDocStoreBundle/Entity/StoredObjectPointInTimeReasonEnum.php
@@ -0,0 +1,18 @@
+<?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\Entity;
+
+enum StoredObjectPointInTimeReasonEnum: string
+{
+    case KEEP_BEFORE_CONVERSION = 'keep-before-conversion';
+    case KEEP_BY_USER = 'keep-by-user';
+}
diff --git a/src/Bundle/ChillDocStoreBundle/Entity/StoredObjectVersion.php b/src/Bundle/ChillDocStoreBundle/Entity/StoredObjectVersion.php
index fed183057..e034cb378 100644
--- a/src/Bundle/ChillDocStoreBundle/Entity/StoredObjectVersion.php
+++ b/src/Bundle/ChillDocStoreBundle/Entity/StoredObjectVersion.php
@@ -13,6 +13,9 @@ namespace Chill\DocStoreBundle\Entity;
 
 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 Random\RandomException;
 
@@ -39,6 +42,12 @@ class StoredObjectVersion implements TrackCreationInterface
     #[ORM\Column(type: \Doctrine\DBAL\Types\Types::TEXT, nullable: false, options: ['default' => ''])]
     private string $filename = '';
 
+    /**
+     * @var Collection<int, StoredObjectPointInTime>&Selectable<int, StoredObjectPointInTime>
+     */
+    #[ORM\OneToMany(mappedBy: 'objectVersion', targetEntity: StoredObjectPointInTime::class, cascade: ['persist', 'remove'], orphanRemoval: true)]
+    private Collection&Selectable $pointInTimes;
+
     public function __construct(
         /**
          * The stored object associated with this version.
@@ -77,6 +86,7 @@ class StoredObjectVersion implements TrackCreationInterface
         ?string $filename = null,
     ) {
         $this->filename = $filename ?? self::generateFilename($this);
+        $this->pointInTimes = new ArrayCollection();
     }
 
     public static function generateFilename(StoredObjectVersion $storedObjectVersion): string
@@ -124,4 +134,40 @@ class StoredObjectVersion implements TrackCreationInterface
     {
         return $this->version;
     }
+
+    /**
+     * @return Collection<int, StoredObjectPointInTime>&Selectable<int, StoredObjectPointInTime>
+     */
+    public function getPointInTimes(): Selectable&Collection
+    {
+        return $this->pointInTimes;
+    }
+
+    public function hasPointInTimes(): bool
+    {
+        return $this->pointInTimes->count() > 0;
+    }
+
+    /**
+     * @return $this
+     *
+     * @internal use @see{StoredObjectPointInTime} constructor instead
+     */
+    public function addPointInTime(StoredObjectPointInTime $storedObjectPointInTime): self
+    {
+        if (!$this->pointInTimes->contains($storedObjectPointInTime)) {
+            $this->pointInTimes->add($storedObjectPointInTime);
+        }
+
+        return $this;
+    }
+
+    public function removePointInTime(StoredObjectPointInTime $storedObjectPointInTime): self
+    {
+        if ($this->pointInTimes->contains($storedObjectPointInTime)) {
+            $this->pointInTimes->removeElement($storedObjectPointInTime);
+        }
+
+        return $this;
+    }
 }
diff --git a/src/Bundle/ChillDocStoreBundle/Repository/StoredObjectPointInTimeRepository.php b/src/Bundle/ChillDocStoreBundle/Repository/StoredObjectPointInTimeRepository.php
new file mode 100644
index 000000000..c5c923ac9
--- /dev/null
+++ b/src/Bundle/ChillDocStoreBundle/Repository/StoredObjectPointInTimeRepository.php
@@ -0,0 +1,27 @@
+<?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\Repository;
+
+use Chill\DocStoreBundle\Entity\StoredObjectPointInTime;
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+use Doctrine\Persistence\ManagerRegistry;
+
+/**
+ * @template-extends ServiceEntityRepository<StoredObjectPointInTime>
+ */
+class StoredObjectPointInTimeRepository extends ServiceEntityRepository
+{
+    public function __construct(ManagerRegistry $registry)
+    {
+        parent::__construct($registry, StoredObjectPointInTime::class);
+    }
+}
diff --git a/src/Bundle/ChillDocStoreBundle/migrations/Version20240910093735.php b/src/Bundle/ChillDocStoreBundle/migrations/Version20240910093735.php
new file mode 100644
index 000000000..21906b168
--- /dev/null
+++ b/src/Bundle/ChillDocStoreBundle/migrations/Version20240910093735.php
@@ -0,0 +1,49 @@
+<?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\Migrations\DocStore;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20240910093735 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Add point in time for stored object version';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('CREATE SEQUENCE chill_doc.stored_object_point_in_time_id_seq INCREMENT BY 1 MINVALUE 1 START 1');
+        $this->addSql('CREATE TABLE chill_doc.stored_object_point_in_time (id INT NOT NULL, stored_object_version_id INT NOT NULL, reason TEXT NOT NULL, createdAt TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL, byUser_id INT DEFAULT NULL, createdBy_id INT DEFAULT NULL, PRIMARY KEY(id))');
+        $this->addSql('CREATE INDEX IDX_CC83C7B81D0AB8B9 ON chill_doc.stored_object_point_in_time (stored_object_version_id)');
+        $this->addSql('CREATE INDEX IDX_CC83C7B8D23C0240 ON chill_doc.stored_object_point_in_time (byUser_id)');
+        $this->addSql('CREATE INDEX IDX_CC83C7B83174800F ON chill_doc.stored_object_point_in_time (createdBy_id)');
+        $this->addSql('COMMENT ON COLUMN chill_doc.stored_object_point_in_time.createdAt IS \'(DC2Type:datetime_immutable)\'');
+        $this->addSql('ALTER TABLE chill_doc.stored_object_point_in_time ADD CONSTRAINT FK_CC83C7B81D0AB8B9 FOREIGN KEY (stored_object_version_id) REFERENCES chill_doc.stored_object_version (id) NOT DEFERRABLE INITIALLY IMMEDIATE');
+        $this->addSql('ALTER TABLE chill_doc.stored_object_point_in_time ADD CONSTRAINT FK_CC83C7B8D23C0240 FOREIGN KEY (byUser_id) REFERENCES users (id) NOT DEFERRABLE INITIALLY IMMEDIATE');
+        $this->addSql('ALTER TABLE chill_doc.stored_object_point_in_time ADD CONSTRAINT FK_CC83C7B83174800F FOREIGN KEY (createdBy_id) REFERENCES users (id) NOT DEFERRABLE INITIALLY IMMEDIATE');
+        $this->addSql('ALTER TABLE chill_doc.stored_object ALTER prefix SET DEFAULT \'\'');
+        $this->addSql('ALTER TABLE chill_doc.stored_object_version ALTER filename SET DEFAULT \'\'');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('DROP SEQUENCE chill_doc.stored_object_point_in_time_id_seq CASCADE');
+        $this->addSql('ALTER TABLE chill_doc.stored_object_point_in_time DROP CONSTRAINT FK_CC83C7B81D0AB8B9');
+        $this->addSql('ALTER TABLE chill_doc.stored_object_point_in_time DROP CONSTRAINT FK_CC83C7B8D23C0240');
+        $this->addSql('ALTER TABLE chill_doc.stored_object_point_in_time DROP CONSTRAINT FK_CC83C7B83174800F');
+        $this->addSql('DROP TABLE chill_doc.stored_object_point_in_time');
+        $this->addSql('ALTER TABLE chill_doc.stored_object ALTER prefix DROP DEFAULT');
+        $this->addSql('ALTER TABLE chill_doc.stored_object_version ALTER filename DROP DEFAULT');
+    }
+}