2597: Add epic relations

CHANGELOG.md

@@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+* [PR-185](https://github.com/itk-dev/economics/pull/186)
+  2597: Added epic migration command.
+* [PR-183](https://github.com/itk-dev/economics/pull/183)
+  2597: Added epic relations.
+* [PR-187](https://github.com/itk-dev/economics/pull/187)
+  Updated symfony bundles.
 * [PR-189](https://github.com/itk-dev/economics/pull/189)
   Npm audit.
 * [PR-187](https://github.com/itk-dev/economics/pull/187)

migrations/Version20250102102102.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20250102102102 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('CREATE TABLE epic (id INT AUTO_INCREMENT NOT NULL, title VARCHAR(255) NOT NULL, PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB');
+        $this->addSql('CREATE TABLE issue_epic (issue_id INT NOT NULL, epic_id INT NOT NULL, INDEX IDX_412E98BD5E7AA58C (issue_id), INDEX IDX_412E98BD6B71E00E (epic_id), PRIMARY KEY(issue_id, epic_id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB');
+        $this->addSql('ALTER TABLE issue_epic ADD CONSTRAINT FK_412E98BD5E7AA58C FOREIGN KEY (issue_id) REFERENCES issue (id) ON DELETE CASCADE');
+        $this->addSql('ALTER TABLE issue_epic ADD CONSTRAINT FK_412E98BD6B71E00E FOREIGN KEY (epic_id) REFERENCES epic (id) ON DELETE CASCADE');
+        $this->addSql('ALTER TABLE version ADD is_billable TINYINT(1) NOT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE issue_epic DROP FOREIGN KEY FK_412E98BD5E7AA58C');
+        $this->addSql('ALTER TABLE issue_epic DROP FOREIGN KEY FK_412E98BD6B71E00E');
+        $this->addSql('DROP TABLE epic');
+        $this->addSql('DROP TABLE issue_epic');
+        $this->addSql('ALTER TABLE version DROP is_billable');
+    }
+}

src/Command/MigrateEpicsCommand.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace App\Command;
+
+use App\Service\DataSynchronizationService;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+#[AsCommand(
+    name: 'app:migrate-epics',
+    description: 'Migrate epics for existing legacy issues, create the epics and add link to join table.',
+)]
+class MigrateEpicsCommand extends Command
+{
+    public function __construct(
+        private DataSynchronizationService $dataSynchronizationService,
+    ) {
+        parent::__construct();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $this->dataSynchronizationService->migrateEpics(function ($i, $length) use ($io) {
+            if (0 == $i) {
+                $io->progressStart($length);
+            } elseif ($i >= $length - 1) {
+                $io->progressFinish();
+            } else {
+                $io->progressAdvance();
+            }
+        });
+
+        $io->success('All issues have been processed successfully.');
+
+        return Command::SUCCESS;
+    }
+}

src/DataFixtures/AppFixtures.php

@@ -4,6 +4,7 @@
 
 use App\Entity\Client;
 use App\Entity\DataProvider;
+use App\Entity\Epic;
 use App\Entity\Issue;
 use App\Entity\Project;
 use App\Entity\Version;
@@ -51,6 +52,10 @@ public function load(ObjectManager $manager): void
             $workerArray[] = 'test'.$i.'@test';
         }
 
+        $epic = new Epic();
+        $epic->setTitle('Epic 1');
+        $manager->persist($epic);
+
         foreach ($dataProviders as $key => $dataProvider) {
             $manager->persist($dataProvider);
 
@@ -113,8 +118,8 @@ public function load(ObjectManager $manager): void
                     $issue->setProjectTrackerId("issue-$i-$j");
                     $issue->setAccountId('Account 1');
                     $issue->setAccountKey('Account 1');
-                    $issue->setEpicName('Epic 1');
-                    $issue->setEpicKey('Epic 1');
+                    $issue->setEpicName('Epic '.$j % 2 .(1 == $key && 0 == $j % 5 ? ',More than one Epic' : ''));
+                    $issue->setEpicKey('Epic '.$j % 2 .(1 == $key && 0 == $j % 5 ? ',More than one Epic' : ''));
                     $issue->setStatus($modStatus);
                     $issue->setDataProvider($dataProvider);
                     $issue->addVersion($versions[$j % count($versions)]);
@@ -125,9 +130,12 @@ public function load(ObjectManager $manager): void
                     $issue->setDueDate(new \DateTime());
                     $issue->setWorker($workerArray[rand(0, 9)]);
                     $issue->setLinkToIssue('www.example.com');
-
                     $manager->persist($issue);
 
+                    if (0 == $key && 0 == $i && 0 == $j) {
+                        $issue->addEpic($epic);
+                    }
+
                     for ($k = 0; $k < 100; ++$k) {
                         $year = (new \DateTime())->format('Y');
 

src/Entity/Epic.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace App\Entity;
+
+use App\Repository\EpicRepository;
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity(repositoryClass: EpicRepository::class)]
+class Epic
+{
+    public function __construct()
+    {
+        $this->issues = new ArrayCollection();
+    }
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column]
+    private ?int $id = null;
+
+    #[ORM\Column(length: 255)]
+    private ?string $title = null;
+
+    #[ORM\ManyToMany(targetEntity: Issue::class, mappedBy: 'epics')]
+    private Collection $issues;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getTitle(): ?string
+    {
+        return $this->title;
+    }
+
+    public function setTitle(string $title): static
+    {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    /**
+     * @return Collection<int, Epic>
+     */
+    public function getIssues(): Collection
+    {
+        return $this->issues;
+    }
+
+    public function addIssue(Issue $issue): self
+    {
+        if (!$this->issues->contains($issue)) {
+            $this->issues->add($issue);
+        }
+
+        return $this;
+    }
+
+    public function removeIssue(Issue $issues): self
+    {
+        $this->issues->removeElement($issues);
+
+        return $this;
+    }
+}

src/Entity/Issue.php

@@ -43,6 +43,9 @@ class Issue extends AbstractBaseEntity
     #[ORM\Column(length: 255, nullable: true)]
     private ?string $epicName = null;
 
+    #[ORM\ManyToMany(targetEntity: Epic::class, inversedBy: 'issues')]
+    private Collection $epics;
+
     #[ORM\ManyToMany(targetEntity: Version::class, inversedBy: 'issues')]
     private Collection $versions;
 
@@ -79,6 +82,7 @@ public function __construct()
         $this->versions = new ArrayCollection();
         $this->worklogs = new ArrayCollection();
         $this->products = new ArrayCollection();
+        $this->epics = new ArrayCollection();
     }
 
     public function getName(): ?string
@@ -177,6 +181,30 @@ public function setEpicName(?string $epicName): self
         return $this;
     }
 
+    /**
+     * @return Collection<int, Epic>
+     */
+    public function getEpics(): Collection
+    {
+        return $this->epics;
+    }
+
+    public function addEpic(Epic $epic): self
+    {
+        if (!$this->epics->contains($epic)) {
+            $this->epics->add($epic);
+        }
+
+        return $this;
+    }
+
+    public function removeEpic(Epic $epic): self
+    {
+        $this->epics->removeElement($epic);
+
+        return $this;
+    }
+
     /**
      * @return Collection<int, Version>
      */

src/Entity/Version.php

@@ -29,6 +29,9 @@ class Version extends AbstractBaseEntity
     #[ORM\ManyToMany(targetEntity: Issue::class, mappedBy: 'versions')]
     private Collection $issues;
 
+    #[ORM\Column]
+    private ?bool $isBillable = true;
+
     public function __construct()
     {
         $this->issues = new ArrayCollection();
@@ -101,4 +104,16 @@ public function removeIssue(Issue $issue): self
 
         return $this;
     }
+
+    public function isBillable(): ?bool
+    {
+        return $this->isBillable;
+    }
+
+    public function setIsBillable(bool $isBillable): static
+    {
+        $this->isBillable = $isBillable;
+
+        return $this;
+    }
 }

src/Enum/NonBillableEpicsEnum.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Enum;
+
+/*
+ * Kind is a term on a worklog in Leantime:
+ * https://github.com/Leantime/leantime/blob/80c4542e19692e423820bd9030907070d281571e/app/Domain/Timesheets/Services/Timesheets.php#L22
+ * */
+enum NonBillableEpicsEnum: string
+{
+    case UB = 'UB';
+
+    /**
+     * @return array<string,string>
+     */
+    public static function getAsArray(): array
+    {
+        return array_reduce(
+            self::cases(),
+            static fn (array $choices, NonBillableEpicsEnum $type) => $choices + [$type->name => $type->value],
+            [],
+        );
+    }
+}

src/Enum/NonBillableVersionsEnum.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Enum;
+
+enum NonBillableVersionsEnum: string
+{
+    case UB = 'UB';
+
+    /**
+     * @return array<string,string>
+     */
+    public static function getAsArray(): array
+    {
+        return array_reduce(
+            self::cases(),
+            static fn (array $choices, NonBillableVersionsEnum $type) => $choices + [$type->name => $type->value],
+            [],
+        );
+    }
+}

src/Model/Invoices/IssueData.php

@@ -17,8 +17,9 @@ class IssueData
     public ?string $accountKey = null;
     public ?string $epicName = null;
     public ?string $epicKey = null;
+    public array $epics;
     /** @var Collection<string, VersionData> */
-    public ?Collection $versions;
+    public Collection $versions;
     public ?\DateTime $resolutionDate = null;
     public string $projectId;
     public ?int $planHours;

src/Repository/EpicRepository.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Repository;
+
+use App\Entity\Epic;
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+use Doctrine\Persistence\ManagerRegistry;
+
+/**
+ * @extends ServiceEntityRepository<Epic>
+ *
+ * @method Epic|null find($id, $lockMode = null, $lockVersion = null)
+ * @method Epic|null findOneBy(array $criteria, array $orderBy = null)
+ * @method Epic[]    findAll()
+ * @method Epic[]    findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
+ */
+class EpicRepository extends ServiceEntityRepository
+{
+    public function __construct(ManagerRegistry $registry)
+    {
+        parent::__construct($registry, Epic::class);
+    }
+
+    public function save(Epic $entity, bool $flush = false): void
+    {
+        $this->getEntityManager()->persist($entity);
+
+        if ($flush) {
+            $this->getEntityManager()->flush();
+        }
+    }
+
+    public function remove(Epic $entity, bool $flush = false): void
+    {
+        $this->getEntityManager()->remove($entity);
+
+        if ($flush) {
+            $this->getEntityManager()->flush();
+        }
+    }
+}

src/Service/DataProviderService.php

@@ -83,7 +83,7 @@ public function getService(DataProvider $dataProvider): DataProviderServiceInter
                     $this->weekGoalLow,
                     $this->weekGoalHigh,
                     $this->sprintNameRegex,
-                    $this->dateTimeHelper
+                    $this->dateTimeHelper,
                 );
                 break;
             default: