Add type field to invoice sequences and update related logic

Author: tomkalon

config/doctrine/InvoiceSequence.orm.xml

@@ -12,8 +12,8 @@
         <field name="index" column="idx" type="integer" />
         <field name="version" type="integer" version="true" />
         <field name="year" type="integer" nullable="true"/>
-        <field name="month" type="integer"/>
-
+        <field name="month" type="integer" nullable="true"/>
+        <field name="type" enum-type="Sylius\InvoicingPlugin\Enum\InvoiceSequenceScopeEnum" nullable="true" />
     </mapped-superclass>
 
 </doctrine-mapping>

src/Entity/InvoiceSequence.php

@@ -13,6 +13,8 @@
 
 namespace Sylius\InvoicingPlugin\Entity;
 
+use Sylius\InvoicingPlugin\Enum\InvoiceSequenceScopeEnum;
+
 /** @final */
 class InvoiceSequence implements InvoiceSequenceInterface
 {
@@ -23,9 +25,11 @@ class InvoiceSequence implements InvoiceSequenceInterface
 
     protected ?int $version = 1;
 
-    protected ?int $year;
+    protected ?InvoiceSequenceScopeEnum $type = null;
+
+    protected ?int $year = null;
 
-    protected ?int $month;
+    protected ?int $month = null;
 
     /** @return mixed */
     public function getId()
@@ -53,6 +57,16 @@ public function setVersion(?int $version): void
         $this->version = $version;
     }
 
+    public function getType(): ?InvoiceSequenceScopeEnum
+    {
+        return $this->type;
+    }
+
+    public function setType(?InvoiceSequenceScopeEnum $type): void
+    {
+        $this->type = $type;
+    }
+
     public function getYear(): ?int
     {
         return $this->year;

src/Entity/InvoiceSequenceInterface.php

@@ -15,13 +15,18 @@
 
 use Sylius\Component\Resource\Model\ResourceInterface;
 use Sylius\Component\Resource\Model\VersionedInterface;
+use Sylius\InvoicingPlugin\Enum\InvoiceSequenceScopeEnum;
 
 interface InvoiceSequenceInterface extends ResourceInterface, VersionedInterface
 {
     public function getIndex(): int;
 
     public function incrementIndex(): void;
 
+    public function getType(): ?InvoiceSequenceScopeEnum;
+
+    public function setType(?InvoiceSequenceScopeEnum $type): void;
+
     public function getYear(): ?int;
 
     public function getMonth(): ?int;

src/Enum/InvoiceSequenceScopeEnum.php

@@ -18,13 +18,4 @@ enum InvoiceSequenceScopeEnum: string
     case GLOBAL = 'global';
     case MONTHLY = 'monthly';
     case ANNUALLY = 'annually';
-
-    public static function fromString(?string $value): self
-    {
-        return match ($value) {
-            'monthly' => self::MONTHLY,
-            'annually' => self::ANNUALLY,
-            default => self::GLOBAL,
-        };
-    }
 }

src/Generator/SequentialInvoiceNumberGenerator.php

@@ -74,9 +74,11 @@ private function getSequence(): InvoiceSequenceInterface
             InvoiceSequenceScopeEnum::MONTHLY => [
                 'year' => (int) $now->format('Y'),
                 'month' => (int) $now->format('m'),
+                'type' => $scope->value,
             ],
             InvoiceSequenceScopeEnum::ANNUALLY => [
                 'year' => (int) $now->format('Y'),
+                'type' => $scope->value,
             ],
             InvoiceSequenceScopeEnum::GLOBAL => [
                 'year' => null,
@@ -102,6 +104,10 @@ private function getSequence(): InvoiceSequenceInterface
             $sequence->setMonth($criteria['month']);
         }
 
+        if (isset($criteria['type'])) {
+            $sequence->setType($criteria['type']);
+        }
+
         $this->sequenceManager->persist($sequence);
 
         return $sequence;

src/Migrations/Version20251021074051.php

@@ -20,16 +20,16 @@ final class Version20251021074051 extends AbstractMigration
 {
     public function getDescription(): string
     {
-        return 'Add year and month columns to sylius_invoicing_plugin_sequence table';
+        return 'Add year, month and type columns to sylius_invoicing_plugin_sequence table';
     }
 
     public function up(Schema $schema): void
     {
-        $this->addSql('ALTER TABLE sylius_invoicing_plugin_sequence ADD year INT DEFAULT NULL, ADD month INT NOT NULL');
+        $this->addSql('ALTER TABLE sylius_invoicing_plugin_sequence ADD year INT DEFAULT NULL, ADD month INT DEFAULT NULL, ADD type VARCHAR(255) DEFAULT NULL');
     }
 
     public function down(Schema $schema): void
     {
-        $this->addSql('ALTER TABLE sylius_invoicing_plugin_sequence DROP year, DROP month');
+        $this->addSql('ALTER TABLE sylius_invoicing_plugin_sequence DROP year, DROP month, DROP type');
     }
 }

tests/Unit/Generator/SequentialInvoiceNumberGeneratorTest.php

@@ -148,7 +148,7 @@ public function it_generates_invoice_number_with_monthly_scope(): void
 
         $this->sequenceRepository
             ->method('findOneBy')
-            ->with(['year' => 2025, 'month' => 10])
+            ->with(['year' => 2025, 'month' => 10, 'type' => 'monthly'])
             ->willReturn($sequence);
 
         $sequence->method('getVersion')->willReturn(1);
@@ -188,7 +188,7 @@ public function it_generates_invoice_number_with_annually_scope(): void
 
         $this->sequenceRepository
             ->method('findOneBy')
-            ->with(['year' => 2025])
+            ->with(['year' => 2025, 'type' => 'annually'])
             ->willReturn($sequence);
 
         $sequence->method('getVersion')->willReturn(1);
@@ -207,4 +207,105 @@ public function it_generates_invoice_number_with_annually_scope(): void
 
         self::assertSame('2025/11/000000001', $result);
     }
+
+    #[Test]
+    public function it_generates_invoice_number_when_monthly_sequence_is_null(): void
+    {
+        $sequence = $this->createMock(InvoiceSequenceInterface::class);
+
+        $dateTime = new \DateTimeImmutable('2025-10-15');
+        $this->clock->method('now')->willReturn($dateTime);
+
+        $generator = new SequentialInvoiceNumberGenerator(
+            $this->sequenceRepository,
+            $this->sequenceFactory,
+            $this->sequenceManager,
+            $this->clock,
+            1,
+            9,
+            'monthly'
+        );
+
+        $this->sequenceRepository
+            ->expects(self::once())
+            ->method('findOneBy')
+            ->with(['year' => 2025, 'month' => 10, 'type' => 'monthly'])
+            ->willReturn(null);
+
+        $this->sequenceFactory->expects(self::once())->method('createNew')->willReturn($sequence);
+        $sequence->expects(self::once())->method('setYear')->with(2025);
+        $sequence->expects(self::once())->method('setMonth')->with(10);
+        $sequence->expects(self::once())->method('setType')->with('monthly');
+
+        $this->sequenceManager
+            ->expects(self::once())
+            ->method('persist')
+            ->with($sequence);
+
+        $sequence->method('getVersion')->willReturn(1);
+        $sequence->method('getIndex')->willReturn(0);
+
+        $this->sequenceManager
+            ->expects(self::once())
+            ->method('lock')
+            ->with($sequence, LockMode::OPTIMISTIC, 1);
+
+        $sequence
+            ->expects(self::once())
+            ->method('incrementIndex');
+
+        $result = $generator->generate();
+
+        self::assertSame('2025/10/000000001', $result);
+    }
+
+    #[Test]
+    public function it_generates_invoice_number_when_annually_sequence_is_null(): void
+    {
+        $sequence = $this->createMock(InvoiceSequenceInterface::class);
+
+        $dateTime = new \DateTimeImmutable('2025-11-15');
+        $this->clock->method('now')->willReturn($dateTime);
+
+        $generator = new SequentialInvoiceNumberGenerator(
+            $this->sequenceRepository,
+            $this->sequenceFactory,
+            $this->sequenceManager,
+            $this->clock,
+            1,
+            9,
+            'annually'
+        );
+
+        $this->sequenceRepository
+            ->expects(self::once())
+            ->method('findOneBy')
+            ->with(['year' => 2025, 'type' => 'annually'])
+            ->willReturn(null);
+
+        $this->sequenceFactory->expects(self::once())->method('createNew')->willReturn($sequence);
+        $sequence->expects(self::once())->method('setYear')->with(2025);
+        $sequence->expects(self::once())->method('setType')->with('monthly');
+
+        $this->sequenceManager
+            ->expects(self::once())
+            ->method('persist')
+            ->with($sequence);
+
+        $sequence->method('getVersion')->willReturn(1);
+        $sequence->method('getIndex')->willReturn(0);
+
+        $this->sequenceManager
+            ->expects(self::once())
+            ->method('lock')
+            ->with($sequence, LockMode::OPTIMISTIC, 1);
+
+        $sequence
+            ->expects(self::once())
+            ->method('incrementIndex');
+
+        $result = $generator->generate();
+
+        self::assertSame('2025/11/000000001', $result);
+    }
 }