Merge pull request #687 from stopfstedt/restrictions_title

adds title attribute to restrictions entity.

migrations/Version20201213002601.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Adds a title column to the restriction table.
+ */
+final class Version20201213002601 extends AbstractMigration
+{
+    public function getDescription() : string
+    {
+        return 'Adds a title column to the restriction table.';
+    }
+
+    public function up(Schema $schema) : void
+    {
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() !== 'mysql', 'Migration can only be executed safely on \'mysql\'.');
+
+        $this->addSql('ALTER TABLE restriction ADD title VARCHAR(50) NOT NULL');
+    }
+
+    public function down(Schema $schema) : void
+    {
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() !== 'mysql', 'Migration can only be executed safely on \'mysql\'.');
+
+        $this->addSql('ALTER TABLE restriction DROP title');
+    }
+}

src/Command/ActivateRestrictionCommand.php

@@ -47,9 +47,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         foreach ($restrictions as $restriction) {
             $map[$restriction->getCode()] = $restriction;
-            $options[$restriction->getCode()] = $restriction->getIssuer()
-                . ' (Version: ' . $restriction->getVersion()  . ')'
-                . ', effective on ' . $restriction->getEffectiveOn()->format('Y-m-d');
+            $options[$restriction->getCode()] = $restriction->getTitle();
         }
 
         if (empty($options)) {

src/Command/DeactivateRestrictionCommand.php

@@ -47,9 +47,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         foreach ($restrictions as $restriction) {
             $map[$restriction->getCode()] = $restriction;
-            $options[$restriction->getCode()] = $restriction->getIssuer()
-                . ' (Version: ' . $restriction->getVersion()  . ')'
-                . ', effective on ' . $restriction->getEffectiveOn()->format('Y-m-d');
+            $options[$restriction->getCode()] = $restriction->getTitle();
         }
 
         if (empty($options)) {

src/Command/ImportRestrictionsCommand.php

@@ -23,6 +23,20 @@ class ImportRestrictionsCommand extends Command
 {
     const RESTRICTIONS_FILE_NAME = 'restricted-list.json';
 
+    const ISSUER_FFG = 'Fantasy Flight Games';
+
+    const ISSUER_CONCLAVE = 'The Conclave';
+
+    const ISSUER_DESIGN_TEAM = 'Redesigns';
+
+    const ISSUER_FFG_SHORTNAME = 'FFG';
+
+    protected array $faqIssuers = [
+        self::ISSUER_FFG,
+        self::ISSUER_CONCLAVE,
+        self::ISSUER_DESIGN_TEAM
+    ];
+
     protected EntityManagerInterface $entityManager;
 
     public function __construct(EntityManagerInterface $entityManager)
@@ -77,6 +91,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $restriction->setCode($code);
                 $restriction->setActive(false);
             }
+            $restriction->setTitle($this->createTitleFromIssuerAndVersion($issuer, $version));
             $restriction->setIssuer($issuer);
             $restriction->setEffectiveOn($effectiveOn);
             $restriction->setCardSet($cardSet);
@@ -173,4 +188,13 @@ protected function buildContents(array $data): array
 
         return $rhett;
     }
+
+    protected function createTitleFromIssuerAndVersion(string $issuer, string $version): string
+    {
+        $title = self::ISSUER_FFG === $issuer ? self::ISSUER_FFG_SHORTNAME : $issuer;
+        if (in_array($issuer, $this->faqIssuers)) {
+            $title .= ' FAQ';
+        }
+        return $title . ' v' . $version;
+    }
 }

src/Command/ListRestrictionsCommand.php

@@ -48,11 +48,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         } else {
             $table = new Table($output);
             $table
-                ->setHeaders(['Code', 'Issuer', 'Version', 'Active', 'Date effective']);
+                ->setHeaders(['Code', 'Title', 'Issuer', 'Version', 'Active', 'Date effective']);
 
             foreach ($restrictions as $restriction) {
                 $table->addRow([
                     $restriction->getCode(),
+                    $restriction->getTitle(),
                     $restriction->getIssuer(),
                     $restriction->getVersion(),
                     $restriction->isActive() ? '<fg=green>yes</>' : '<fg=red>no</>',

src/Entity/Restriction.php

@@ -33,6 +33,18 @@ class Restriction implements RestrictionInterface
      */
     protected DateTime $effectiveOn;
 
+    /**
+     * @ORM\Column(name="title", type="string", length=50)
+     *
+     * @Assert\NotBlank()
+     * @Assert\Type(type="string")
+     * @Assert\Length(
+     *      min = 1,
+     *      max = 50
+     * )
+     */
+    protected string $title;
+
     /**
      * @ORM\Column(name="issuer", type="string", length=50)
      *
@@ -100,6 +112,22 @@ public function getCode(): string
         return $this->code;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function setTitle(string $title): void
+    {
+        $this->title = $title;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getTitle(): string
+    {
+        return $this->title;
+    }
+
     /**
      * @inheritdoc
      */

src/Entity/RestrictionInterface.php

@@ -15,6 +15,16 @@ interface RestrictionInterface
      */
     public function setCode(string $code): void;
 
+    /**
+     * @return string
+     */
+    public function getTitle(): string;
+
+    /**
+     * @param string $title
+     */
+    public function setTitle(string $title): void;
+
     /**
      * @return string
      */