Refactor metadata link entities with type enum and index properties

Signed-off-by: Tim Goudriaan <tim@codedmonkey.com>

Author: codedmonkey

migrations/Version20260325114538.php

@@ -96,6 +96,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -108,6 +109,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -120,6 +122,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -132,6 +135,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -144,6 +148,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -156,6 +161,7 @@ private function createMetadataTables(): void
                 id INT GENERATED BY DEFAULT AS IDENTITY NOT NULL,
                 linked_package_name VARCHAR(191) NOT NULL,
                 linked_version_constraint TEXT NOT NULL,
+                index INT NOT NULL,
                 metadata_id INT NOT NULL,
                 PRIMARY KEY (id)
             )
@@ -294,8 +300,12 @@ private function fillMetadataTables(): void
 
         foreach ($linkTables as $linkTable) {
             $this->addSql(<<<SQL
-                INSERT INTO metadata_{$linkTable}_link (metadata_id, linked_package_name, linked_version_constraint)
-                SELECT metadata.id, link.linked_package_name, link.linked_version_constraint
+                INSERT INTO metadata_{$linkTable}_link (metadata_id, linked_package_name, linked_version_constraint, index)
+                SELECT
+                    metadata.id,
+                    link.linked_package_name,
+                    link.linked_version_constraint,
+                    link.index
                 FROM version_{$linkTable}_link link
                 INNER JOIN metadata metadata ON link.version_id = metadata.version_id
             SQL);
@@ -759,6 +769,7 @@ private function fillVersionTables(): void
                     WHERE version_link.version_id = metadata.version_id
                     AND version_link.linked_package_name = metadata_link.linked_package_name
                 )
+                ORDER BY metadata_link.index
             SQL);
         }
     }

phpstan.dist.neon

@@ -11,8 +11,6 @@ parameters:
         - tests/bootstrap.php
     ignoreErrors:
         - '#^Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition\:\:children\(\)\.$#'
-        - '#CodedMonkey\\Dirigent\\Doctrine\\Entity\\AbstractMetadataLink given\.#'
-        - '#^PHPDoc tag @var with type CodedMonkey\\Dirigent\\Doctrine\\Entity\\AbstractMetadataLink is not subtype of native type#'
         - '#^Property CodedMonkey\\Dirigent\\Doctrine\\Entity\\[a-zA-Z]+\:\:\$id \(int\|null\) is never assigned int so it can be removed from the property type\.$#'
         -
             message: '#^Class CodedMonkey\\Dirigent\\Doctrine\\Entity\\TrackedEntity has an uninitialized readonly property \$createdAt\. Assign it in the constructor\.$#'

src/Doctrine/Entity/AbstractMetadataLink.php

@@ -2,6 +2,7 @@
 
 namespace CodedMonkey\Dirigent\Doctrine\Entity;
 
+use CodedMonkey\Dirigent\Entity\MetadataLinkType;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
 
@@ -21,9 +22,21 @@ abstract class AbstractMetadataLink
     #[ORM\Column(type: Types::TEXT)]
     private string $linkedVersionConstraint;
 
-    public function __construct(Metadata $metadata)
-    {
+    #[ORM\Column]
+    private int $index;
+
+    public function __construct(
+        Metadata $metadata,
+        string $linkedPackageName,
+        string $linkedVersionConstraint,
+        int $index,
+    ) {
         $this->metadata = $metadata;
+        $this->linkedPackageName = $linkedPackageName;
+        $this->linkedVersionConstraint = $linkedVersionConstraint;
+        $this->index = $index;
+
+        $this->addToCollection();
     }
 
     public function getId(): ?int
@@ -41,18 +54,19 @@ public function getLinkedPackageName(): string
         return $this->linkedPackageName;
     }
 
-    public function setLinkedPackageName(string $packageName): void
+    public function getLinkedVersionConstraint(): string
     {
-        $this->linkedPackageName = $packageName;
+        return $this->linkedVersionConstraint;
     }
 
-    public function getLinkedVersionConstraint(): string
+    public function getIndex(): int
     {
-        return $this->linkedVersionConstraint;
+        return $this->index;
     }
 
-    public function setLinkedVersionConstraint(string $packageVersion): void
+    private function addToCollection(): void
     {
-        $this->linkedVersionConstraint = $packageVersion;
+        $linkType = MetadataLinkType::fromClass(static::class);
+        $linkType->getMetadataLinks($this->metadata)->add($this);
     }
 }

src/Doctrine/Entity/Metadata.php

@@ -3,6 +3,7 @@
 namespace CodedMonkey\Dirigent\Doctrine\Entity;
 
 use CodedMonkey\Dirigent\Doctrine\Repository\MetadataRepository;
+use CodedMonkey\Dirigent\Entity\MetadataLinkType;
 use Composer\Package\Version\VersionParser;
 use Composer\Pcre\Preg;
 use Doctrine\Common\Collections\ArrayCollection;
@@ -100,37 +101,43 @@ class Metadata extends TrackedEntity implements \Stringable
      * @var Collection<int, MetadataRequireLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataRequireLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach'])]
-    private Collection $require;
+    #[ORM\OrderBy(['index' => 'ASC'])]
+    private Collection $requireLinks;
 
     /**
      * @var Collection<int, MetadataDevRequireLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataDevRequireLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach'])]
-    private Collection $devRequire;
+    #[ORM\OrderBy(['index' => 'ASC'])]
+    private Collection $devRequireLinks;
 
     /**
      * @var Collection<int, MetadataConflictLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataConflictLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach'])]
-    private Collection $conflict;
+    #[ORM\OrderBy(['index' => 'ASC'])]
+    private Collection $conflictLinks;
 
     /**
      * @var Collection<int, MetadataProvideLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataProvideLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach'])]
-    private Collection $provide;
+    #[ORM\OrderBy(['index' => 'ASC'])]
+    private Collection $provideLinks;
 
     /**
      * @var Collection<int, MetadataReplaceLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataReplaceLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach'])]
-    private Collection $replace;
+    #[ORM\OrderBy(['index' => 'ASC'])]
+    private Collection $replaceLinks;
 
     /**
      * @var Collection<int, MetadataSuggestLink>
      */
     #[ORM\OneToMany(targetEntity: MetadataSuggestLink::class, mappedBy: 'metadata', cascade: ['persist', 'detach'])]
-    private Collection $suggest;
+    #[ORM\OrderBy(['index' => 'ASC'])]
+    private Collection $suggestLinks;
 
     /**
      * @var Collection<int, MetadataKeyword>
@@ -143,12 +150,12 @@ public function __construct(Version $version)
         $this->version = $version;
         $this->package = $version->getPackage();
 
-        $this->require = new ArrayCollection();
-        $this->devRequire = new ArrayCollection();
-        $this->conflict = new ArrayCollection();
-        $this->provide = new ArrayCollection();
-        $this->replace = new ArrayCollection();
-        $this->suggest = new ArrayCollection();
+        $this->requireLinks = new ArrayCollection();
+        $this->devRequireLinks = new ArrayCollection();
+        $this->conflictLinks = new ArrayCollection();
+        $this->provideLinks = new ArrayCollection();
+        $this->replaceLinks = new ArrayCollection();
+        $this->suggestLinks = new ArrayCollection();
         $this->keywords = new ArrayCollection();
     }
 
@@ -409,49 +416,49 @@ public function getPackage(): Package
     /**
      * @return Collection<int, MetadataRequireLink>
      */
-    public function getRequire(): Collection
+    public function getRequireLinks(): Collection
     {
-        return $this->require;
+        return $this->requireLinks;
     }
 
     /**
      * @return Collection<int, MetadataDevRequireLink>
      */
-    public function getDevRequire(): Collection
+    public function getDevRequireLinks(): Collection
     {
-        return $this->devRequire;
+        return $this->devRequireLinks;
     }
 
     /**
      * @return Collection<int, MetadataConflictLink>
      */
-    public function getConflict(): Collection
+    public function getConflictLinks(): Collection
     {
-        return $this->conflict;
+        return $this->conflictLinks;
     }
 
     /**
      * @return Collection<int, MetadataProvideLink>
      */
-    public function getProvide(): Collection
+    public function getProvideLinks(): Collection
     {
-        return $this->provide;
+        return $this->provideLinks;
     }
 
     /**
      * @return Collection<int, MetadataReplaceLink>
      */
-    public function getReplace(): Collection
+    public function getReplaceLinks(): Collection
     {
-        return $this->replace;
+        return $this->replaceLinks;
     }
 
     /**
      * @return Collection<int, MetadataSuggestLink>
      */
-    public function getSuggest(): Collection
+    public function getSuggestLinks(): Collection
     {
-        return $this->suggest;
+        return $this->suggestLinks;
     }
 
     /**
@@ -615,19 +622,10 @@ public function toComposerArray(): array
         ];
 
         // Set links
-        $supportedLinkTypes = [
-            'require' => $this->require,
-            'require-dev' => $this->devRequire,
-            'suggest' => $this->suggest,
-            'conflict' => $this->conflict,
-            'provide' => $this->provide,
-            'replace' => $this->replace,
-        ];
-
-        foreach ($supportedLinkTypes as $linkType => $linkCollection) {
+        foreach (MetadataLinkType::cases() as $linkType) {
             /** @var AbstractMetadataLink $link */
-            foreach ($linkCollection as $link) {
-                $data[$linkType][$link->getLinkedPackageName()] = $link->getLinkedVersionConstraint();
+            foreach ($linkType->getMetadataLinks($this) as $link) {
+                $data[$linkType->value][$link->getLinkedPackageName()] = $link->getLinkedVersionConstraint();
             }
         }
 

src/Doctrine/Entity/MetadataConflictLink.php

@@ -7,7 +7,7 @@
 #[ORM\Entity]
 class MetadataConflictLink extends AbstractMetadataLink
 {
-    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'conflict')]
+    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'conflictLinks')]
     #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')]
     protected Metadata $metadata;
 }

src/Doctrine/Entity/MetadataDevRequireLink.php

@@ -7,7 +7,7 @@
 #[ORM\Entity]
 class MetadataDevRequireLink extends AbstractMetadataLink
 {
-    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'devRequire')]
+    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'devRequireLinks')]
     #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')]
     protected Metadata $metadata;
 }

src/Doctrine/Entity/MetadataProvideLink.php

@@ -7,7 +7,7 @@
 #[ORM\Entity]
 class MetadataProvideLink extends AbstractMetadataLink
 {
-    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'provide')]
+    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'provideLinks')]
     #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')]
     protected Metadata $metadata;
 

src/Doctrine/Entity/MetadataReplaceLink.php

@@ -7,7 +7,7 @@
 #[ORM\Entity]
 class MetadataReplaceLink extends AbstractMetadataLink
 {
-    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'replace')]
+    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'replaceLinks')]
     #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')]
     protected Metadata $metadata;
 }

src/Doctrine/Entity/MetadataRequireLink.php

@@ -7,7 +7,7 @@
 #[ORM\Entity]
 class MetadataRequireLink extends AbstractMetadataLink
 {
-    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'require')]
+    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'requireLinks')]
     #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')]
     protected Metadata $metadata;
 }

src/Doctrine/Entity/MetadataSuggestLink.php

@@ -7,7 +7,7 @@
 #[ORM\Entity]
 class MetadataSuggestLink extends AbstractMetadataLink
 {
-    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'suggest')]
+    #[ORM\ManyToOne(targetEntity: Metadata::class, inversedBy: 'suggestLinks')]
     #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')]
     protected Metadata $metadata;
 }