Feature: add constraint to ensure postal code uniqueness and track creation and update of postal code

src/Bundle/ChillMainBundle/Entity/PostalCode.php

@@ -12,6 +12,11 @@ declare(strict_types=1);
 namespace Chill\MainBundle\Entity;
 
 use Chill\MainBundle\Doctrine\Model\Point;
+use Chill\MainBundle\Doctrine\Model\TrackCreationInterface;
+use Chill\MainBundle\Doctrine\Model\TrackCreationTrait;
+use Chill\MainBundle\Doctrine\Model\TrackUpdateInterface;
+use Chill\MainBundle\Doctrine\Model\TrackUpdateTrait;
+use DateTimeImmutable;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Serializer\Annotation\Groups;
 
@@ -21,6 +26,10 @@ use Symfony\Component\Serializer\Annotation\Groups;
  * @ORM\Entity
  * @ORM\Table(
  *     name="chill_main_postal_code",
+ *     uniqueConstraints={
+ *         @ORM\UniqueConstraint(name="postal_code_import_unicity", columns={"code", "refpostalcodeid", "postalcodesource"},
+ *         options={"where": "refpostalcodeid is not null"})
+ *     },
  *     indexes={
  *         @ORM\Index(name="search_name_code", columns={"code", "label"}),
  *         @ORM\Index(name="search_by_reference_code", columns={"code", "refpostalcodeid"})
@@ -28,8 +37,12 @@ use Symfony\Component\Serializer\Annotation\Groups;
  *
  *     @ORM\HasLifecycleCallbacks
  */
-class PostalCode
+class PostalCode implements TrackUpdateInterface, TrackCreationInterface
 {
+    use TrackCreationTrait;
+
+    use TrackUpdateTrait;
+
     /**
      * This is an internal column which is populated by database.
      *
@@ -63,6 +76,11 @@ class PostalCode
      */
     private $country;
 
+    /**
+     * @ORM\Column(type="datetime_immutable", nullable=true, options={"default": null})
+     */
+    private ?DateTimeImmutable $deletedAt = null;
+
     /**
      * @var int
      *

src/Bundle/ChillMainBundle/migrations/Version20220729205416.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * 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.
+ */
+
+declare(strict_types=1);
+
+namespace Chill\Migrations\Main;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20220729205416 extends AbstractMigration
+{
+    public function down(Schema $schema): void
+    {
+        $this->addSql('DROP INDEX postal_code_import_unicity');
+        $this->addSql('ALTER TABLE chill_main_postal_code DROP deletedAt');
+        $this->addSql('ALTER TABLE chill_main_postal_code DROP updatedAt');
+        $this->addSql('ALTER TABLE chill_main_postal_code DROP createdAt');
+        $this->addSql('ALTER TABLE chill_main_postal_code DROP updatedBy_id');
+        $this->addSql('ALTER TABLE chill_main_postal_code DROP createdBy_id');
+        $this->addSql('ALTER TABLE chill_main_postal_code DROP CONSTRAINT chill_internal_postal_code_import_unicity');
+    }
+
+    public function getDescription(): string
+    {
+        return 'postal code: add columns to track creation, update and deletion';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE chill_main_postal_code ADD deletedAt TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL');
+        $this->addSql('ALTER TABLE chill_main_postal_code ADD updatedAt TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL');
+        $this->addSql('ALTER TABLE chill_main_postal_code ADD createdAt TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL');
+        $this->addSql('ALTER TABLE chill_main_postal_code ADD updatedBy_id INT DEFAULT NULL');
+        $this->addSql('ALTER TABLE chill_main_postal_code ADD createdBy_id INT DEFAULT NULL');
+        $this->addSql('COMMENT ON COLUMN chill_main_postal_code.deletedAt IS \'(DC2Type:datetime_immutable)\'');
+        $this->addSql('COMMENT ON COLUMN chill_main_postal_code.updatedAt IS \'(DC2Type:datetime_immutable)\'');
+        $this->addSql('COMMENT ON COLUMN chill_main_postal_code.createdAt IS \'(DC2Type:datetime_immutable)\'');
+        $this->addSql('ALTER TABLE chill_main_postal_code ADD CONSTRAINT FK_6CA145FA65FF1AEC FOREIGN KEY (updatedBy_id) REFERENCES users (id) NOT DEFERRABLE INITIALLY IMMEDIATE');
+        $this->addSql('ALTER TABLE chill_main_postal_code ADD CONSTRAINT FK_6CA145FA3174800F FOREIGN KEY (createdBy_id) REFERENCES users (id) NOT DEFERRABLE INITIALLY IMMEDIATE');
+        $this->addSql('CREATE INDEX IDX_6CA145FA65FF1AEC ON chill_main_postal_code (updatedBy_id)');
+        $this->addSql('CREATE INDEX IDX_6CA145FA3174800F ON chill_main_postal_code (createdBy_id)');
+        $this->addSql('CREATE UNIQUE INDEX postal_code_import_unicity ON chill_main_postal_code (code, refpostalcodeid, postalcodesource) WHERE refpostalcodeid is not null');
+        //$this->addSql('ALTER TABLE chill_main_postal_code ADD CONSTRAINT chill_internal_postal_code_import_unicity '.
+        //    'EXCLUDE (code WITH =, refpostalcodeid WITH =, postalcodesource WITH =) WHERE (refpostalcodeid IS NOT NULL)');
+    }
+}