Add support for configurable invoice sequence scopes (global, monthly, annually)

Author: tomkalon

.gitignore

@@ -1,3 +1,4 @@
+/var/
 /vendor/
 /node_modules/
 /composer.lock

config/config.yaml

@@ -5,6 +5,8 @@ imports:
 parameters:
     sylius_invoicing.invoice_save_path: "%kernel.project_dir%/private/invoices/"
     sylius_invoicing.filesystem_adapter.invoice: "sylius_invoicing_invoice"
+    sylius_invoicing.sequence_scope: '%env(default::SYLIUS_INVOICING_SEQUENCE_SCOPE)%'
+    env(SYLIUS_INVOICING_SEQUENCE_SCOPE): 'global'
 
 sylius_invoicing:
     pdf_generator:

config/services/generators.xml

@@ -22,6 +22,7 @@
             <argument type="service" id="sylius_invoicing.factory.invoice_sequence" />
             <argument type="service" id="sylius_invoicing.manager.invoice_sequence" />
             <argument type="service" id="clock" />
+            <argument type="string">%sylius_invoicing.sequence_scope%</argument>
         </service>
 
         <service id="sylius_invoicing.generator.invoice_identifier" class="Sylius\InvoicingPlugin\Generator\UuidInvoiceIdentifierGenerator" />

src/Entity/InvoiceSequence.php

@@ -23,6 +23,10 @@ class InvoiceSequence implements InvoiceSequenceInterface
 
     protected ?int $version = 1;
 
+    protected int $year;
+
+    protected int $month;
+
     /** @return mixed */
     public function getId()
     {
@@ -48,4 +52,24 @@ public function setVersion(?int $version): void
     {
         $this->version = $version;
     }
+
+    public function getYear(): int
+    {
+        return $this->year;
+    }
+
+    public function getMonth(): int
+    {
+        return $this->month;
+    }
+
+    public function setYear(int $year): void
+    {
+        $this->year = $year;
+    }
+
+    public function setMonth(int $month): void
+    {
+        $this->month = $month;
+    }
 }

src/Entity/InvoiceSequenceInterface.php

@@ -21,4 +21,12 @@ interface InvoiceSequenceInterface extends ResourceInterface, VersionedInterface
     public function getIndex(): int;
 
     public function incrementIndex(): void;
+
+    public function getYear(): int;
+
+    public function getMonth(): int;
+
+    public function setYear(int $year): void;
+
+    public function setMonth(int $month): void;
 }

src/Enum/InvoiceSequenceScopeEnum.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\InvoicingPlugin\Enum;
+
+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

@@ -18,6 +18,7 @@
 use Sylius\Component\Resource\Factory\FactoryInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
 use Sylius\InvoicingPlugin\Entity\InvoiceSequenceInterface;
+use Sylius\InvoicingPlugin\Enum\InvoiceSequenceScopeEnum;
 use Symfony\Component\Clock\ClockInterface;
 
 final class SequentialInvoiceNumberGenerator implements InvoiceNumberGenerator
@@ -29,7 +30,17 @@ public function __construct(
         private readonly ClockInterface $clock,
         private readonly int $startNumber = 1,
         private readonly int $numberLength = 9,
+        private readonly ?string $scope = null,
     ) {
+        if (null === $this->scope) {
+            trigger_deprecation(
+                'sylius/invoicing-plugin',
+                '2.1',
+                'Not passing a "%s" to "%s" is deprecated and will be required in SyliusInvoicingPlugin 3.0.',
+                InvoiceSequenceScopeEnum::class,
+                self::class,
+            );
+        }
     }
 
     public function generate(): string
@@ -56,15 +67,38 @@ private function generateNumber(int $index): string
 
     private function getSequence(): InvoiceSequenceInterface
     {
-        /** @var InvoiceSequenceInterface $sequence */
-        $sequence = $this->sequenceRepository->findOneBy([]);
-
-        if (null != $sequence) {
+        $now = $this->clock->now();
+        $scope = InvoiceSequenceScopeEnum::tryFrom($this->scope ?? '') ?? InvoiceSequenceScopeEnum::GLOBAL;
+
+        $criteria = match ($scope) {
+            InvoiceSequenceScopeEnum::MONTHLY => [
+                'year' => (int) $now->format('Y'),
+                'month' => (int) $now->format('m'),
+            ],
+            InvoiceSequenceScopeEnum::ANNUALLY => [
+                'year' => (int) $now->format('Y'),
+            ],
+            InvoiceSequenceScopeEnum::GLOBAL => [],
+        };
+
+        /** @var InvoiceSequenceInterface|null $sequence */
+        $sequence = $this->sequenceRepository->findOneBy($criteria);
+
+        if (null !== $sequence) {
             return $sequence;
         }
 
         /** @var InvoiceSequenceInterface $sequence */
         $sequence = $this->sequenceFactory->createNew();
+
+        if (isset($criteria['year'])) {
+            $sequence->setYear($criteria['year']);
+        }
+
+        if (isset($criteria['month'])) {
+            $sequence->setMonth($criteria['month']);
+        }
+
         $this->sequenceManager->persist($sequence);
 
         return $sequence;

tests/TestApplication/.env

@@ -9,3 +9,5 @@ WKHTMLTOPDF_PATH=/usr/local/bin/wkhtmltopdf
 ###< knplabs/knp-snappy-bundle ###
 
 TEST_SYLIUS_INVOICING_PDF_GENERATION_DISABLED=false
+TEST_SYLIUS_INVOICING_PDF_GENERATION_DISABLED=false
+SYLIUS_INVOICING_SEQUENCE_SCOPE='monthly'