refactor #226 Relate Invoice with Order (Zales0123)

This PR was merged into the 1.0-dev branch. Discussion ---------- Similar to Sylius/RefundPlugin#306 and Sylius/RefundPlugin#307. Should be easier to operate on the Invoice with a proper relation rather than just an order number Commits ------- 081b080 Add Order relation on Invoice (and remove order number field) e480edc Use order instead of order number in invoice repository 0ab7fed Final fixes ce949d3 Mention changes in the UPGRADE file 8411c18 Remove unneeded point in UPGRADE file
Sylius · Jun 14, 2021 · 1015a34 · 1015a34
2 parents dea611b + 8411c18
commit 1015a34
Show file tree

Hide file tree

Showing 24 changed files with 157 additions and 53 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,3 +1,13 @@
+### UPGRADE FROM 0.15.0 TO 0.16.0
+
+1. `orderNumber` field on `Sylius\InvoicingPlugin\Entity\Invoice` has been removed and replaced with relation to `Order` entity.
+1. `Sylius\InvoicingPlugin\Entity\InvoiceInterface::orderNumber` function is left due to easier and smoother upgrades,
+   but is also deprecated and will be removed in the `v1.0.0` release. Use `Sylius\InvoicingPlugin\Entity\InvoiceInterface::order` instead.
+1. `Sylius\InvoicingPlugin\Doctrine\ORM\InvoiceRepositoryInterface::findOneByOrderNumber` method has been replaced by
+   `Sylius\InvoicingPlugin\Doctrine\ORM\InvoiceRepositoryInterface::findOneByOrder`.
+1. `Sylius\InvoicingPlugin\Factory\InvoiceFactoryInterface::createForData` takes `OrderInterface $order` as the 3rd argument instead
+    of `string $orderNumber`.
+
 ### UPGRADE FROM 0.14.0 TO 0.15.0
 
 1. Command bus `sylius_invoicing_plugin.command_bus` has been replaced with `sylius.command_bus`.

diff --git a/spec/CommandHandler/SendInvoiceEmailHandlerSpec.php b/spec/CommandHandler/SendInvoiceEmailHandlerSpec.php
@@ -40,10 +40,10 @@ public function it_requests_an_email_with_an_invoice_to_be_sent(
         OrderInterface $order,
         CustomerInterface $customer
     ): void {
-        $invoiceRepository->findOneByOrderNumber('0000001')->willReturn($invoice);
-
         $orderRepository->findOneByNumber('0000001')->willReturn($order);
 
+        $invoiceRepository->findOneByOrder($order)->willReturn($invoice);
+
         $order->getCustomer()->willReturn($customer);
 
         $customer->getEmail()->willReturn('[email protected]');
@@ -60,8 +60,8 @@ public function it_does_not_request_an_email_to_be_sent_if_invoice_was_not_found
         OrderInterface $order,
         CustomerInterface $customer
     ): void {
-        $invoiceRepository->findOneByOrderNumber('0000001')->willReturn(null);
         $orderRepository->findOneByNumber('0000001')->willReturn($order);
+        $invoiceRepository->findOneByOrder($order)->willReturn(null);
 
         $order->getCustomer()->shouldNotBeCalled();
         $customer->getEmail()->shouldNotBeCalled();

diff --git a/spec/Creator/InvoiceCreatorSpec.php b/spec/Creator/InvoiceCreatorSpec.php
@@ -45,10 +45,10 @@ public function it_creates_invoice_for_order(
         OrderInterface $order,
         InvoiceInterface $invoice
     ): void {
-        $invoiceRepository->findOneByOrderNumber('0000001')->willReturn(null);
-
         $orderRepository->findOneByNumber('0000001')->willReturn($order);
 
+        $invoiceRepository->findOneByOrder($order)->willReturn(null);
+
         $invoiceDateTime = new \DateTimeImmutable('2019-02-25');
 
         $invoiceGenerator->generateForOrder($order, $invoiceDateTime)->willReturn($invoice);
@@ -62,17 +62,19 @@ public function it_throws_an_exception_when_invoice_was_already_created_for_give
         InvoiceRepositoryInterface $invoiceRepository,
         OrderRepositoryInterface $orderRepository,
         InvoiceGeneratorInterface $invoiceGenerator,
+        OrderInterface $order,
         InvoiceInterface $invoice
     ): void {
-        $invoiceRepository->findOneByOrderNumber('0000001')->willReturn($invoice);
+        $orderRepository->findOneByNumber('0000001')->willReturn($order);
+        $invoiceRepository->findOneByOrder($order)->willReturn($invoice);
 
         $invoiceDateTime = new \DateTimeImmutable('2019-02-25');
 
-        $orderRepository->findOneByNumber(Argument::any())->shouldNotBeCalled();
         $invoiceGenerator->generateForOrder(Argument::any(), Argument::any())->shouldNotBeCalled();
         $invoiceRepository->add(Argument::any())->shouldNotBeCalled();
 
-        $this->shouldThrow(InvoiceAlreadyGenerated::withOrderNumber('0000001'))
+        $this
+            ->shouldThrow(InvoiceAlreadyGenerated::withOrderNumber('0000001'))
             ->during('__invoke', ['0000001', $invoiceDateTime])
         ;
     }

diff --git a/spec/Entity/InvoiceSpec.php b/spec/Entity/InvoiceSpec.php
@@ -16,6 +16,7 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\ChannelInterface;
+use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Resource\Model\ResourceInterface;
 use Sylius\InvoicingPlugin\Entity\BillingDataInterface;
 use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
@@ -30,14 +31,15 @@ public function let(
         LineItemInterface $lineItem,
         TaxItemInterface $taxItem,
         ChannelInterface $channel,
-        InvoiceShopBillingDataInterface $shopBillingData
+        InvoiceShopBillingDataInterface $shopBillingData,
+        OrderInterface $order
     ): void {
         $issuedAt = \DateTimeImmutable::createFromFormat('Y-m', '2019-01');
 
         $this->beConstructedWith(
             '7903c83a-4c5e-4bcf-81d8-9dc304c6a353',
             $issuedAt->format('Y/m') . '/000000001',
-            '007',
+            $order,
             $issuedAt,
             $billingData,
             'USD',
@@ -60,16 +62,17 @@ public function it_implements_resource_interface(): void
         $this->shouldImplement(ResourceInterface::class);
     }
 
-    public function it_has_an_id(
+    public function it_has_data(
         BillingDataInterface $billingData,
         LineItemInterface $lineItem,
         TaxItemInterface $taxItem,
         ChannelInterface $channel,
-        InvoiceShopBillingDataInterface $shopBillingData
+        InvoiceShopBillingDataInterface $shopBillingData,
+        OrderInterface $order
     ): void {
         $this->id()->shouldReturn('7903c83a-4c5e-4bcf-81d8-9dc304c6a353');
         $this->number()->shouldReturn('2019/01/000000001');
-        $this->orderNumber()->shouldReturn('007');
+        $this->order()->shouldReturn($order);
         $this->billingData()->shouldReturn($billingData);
         $this->currencyCode()->shouldReturn('USD');
         $this->localeCode()->shouldReturn('en_US');

diff --git a/spec/EventProducer/OrderPaymentPaidProducerSpec.php b/spec/EventProducer/OrderPaymentPaidProducerSpec.php
@@ -50,7 +50,7 @@ public function it_dispatches_order_payment_paid_event_for_payment(
 
         $event = new OrderPaymentPaid('0000001', $dateTime);
 
-        $invoiceRepository->findOneByOrderNumber('0000001')->willReturn($invoice);
+        $invoiceRepository->findOneByOrder($order)->willReturn($invoice);
 
         $eventBus->dispatch($event)->shouldBeCalled()->willReturn(new Envelope($event));
 
@@ -80,7 +80,7 @@ public function it_does_not_dispatch_event_when_there_is_no_invoice_related_to_o
     ): void {
         $payment->getOrder()->willReturn($order);
         $order->getNumber()->willReturn('0000001');
-        $invoiceRepository->findOneByOrderNumber('0000001')->willReturn(null);
+        $invoiceRepository->findOneByOrder($order)->willReturn(null);
 
         $eventBus->dispatch(Argument::any())->shouldNotBeCalled();
         $dateTimeProvider->__invoke()->shouldNotBeCalled();

diff --git a/spec/Factory/InvoiceFactorySpec.php b/spec/Factory/InvoiceFactorySpec.php
@@ -16,6 +16,7 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\ChannelInterface;
+use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\InvoicingPlugin\Entity\BillingDataInterface;
 use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
 use Sylius\InvoicingPlugin\Entity\InvoiceShopBillingDataInterface;
@@ -31,14 +32,15 @@ public function it_implements_invoice_factory_interface(): void
     public function it_creates_an_invoice_for_given_data(
         BillingDataInterface $billingData,
         ChannelInterface $channel,
-        InvoiceShopBillingDataInterface $invoiceShopBillingData
+        InvoiceShopBillingDataInterface $invoiceShopBillingData,
+        OrderInterface $order
     ): void {
         $date = new \DateTimeImmutable('2019-03-06');
 
         $this->createForData(
             '7903c83a-4c5e-4bcf-81d8-9dc304c6a353',
             '2019/03/0000001',
-            '007',
+            $order,
             $date,
             $billingData,
             'USD',
@@ -53,14 +55,15 @@ public function it_creates_an_invoice_for_given_data(
 
     public function it_allows_for_nullable_shop_billing_data(
         BillingDataInterface $billingData,
-        ChannelInterface $channel
+        ChannelInterface $channel,
+        OrderInterface $order
     ): void {
         $date = new \DateTimeImmutable('2019-03-06');
 
         $this->createForData(
             '7903c83a-4c5e-4bcf-81d8-9dc304c6a353',
             '2019/03/0000001',
-            '007',
+            $order,
             $date,
             $billingData,
             'USD',

diff --git a/spec/Generator/InvoiceGeneratorSpec.php b/spec/Generator/InvoiceGeneratorSpec.php
@@ -77,7 +77,6 @@ public function it_generates_an_invoice_for_a_given_order(
         $uuidInvoiceIdentifierGenerator->generate()->willReturn('7903c83a-4c5e-4bcf-81d8-9dc304c6a353');
         $sequentialInvoiceNumberGenerator->generate()->willReturn($date->format('Y/m') . '/0000001');
 
-        $order->getNumber()->willReturn('007');
         $order->getCurrencyCode()->willReturn('USD');
         $order->getLocaleCode()->willReturn('en_US');
         $order->getTotal()->willReturn(10300);
@@ -95,7 +94,7 @@ public function it_generates_an_invoice_for_a_given_order(
         $invoiceFactory->createForData(
             '7903c83a-4c5e-4bcf-81d8-9dc304c6a353',
             '2019/03/0000001',
-            '007',
+            $order,
             $date,
             $billingData,
             'USD',

diff --git a/src/CommandHandler/SendInvoiceEmailHandler.php b/src/CommandHandler/SendInvoiceEmailHandler.php
@@ -43,16 +43,16 @@ public function __construct(
 
     public function __invoke(SendInvoiceEmail $command): void
     {
+        /** @var OrderInterface $order */
+        $order = $this->orderRepository->findOneByNumber($command->orderNumber());
+
         /** @var InvoiceInterface|null $invoice */
-        $invoice = $this->invoiceRepository->findOneByOrderNumber($command->orderNumber());
+        $invoice = $this->invoiceRepository->findOneByOrder($order);
 
         if (null === $invoice) {
             return;
         }
 
-        /** @var OrderInterface $order */
-        $order = $this->orderRepository->findOneByNumber($command->orderNumber());
-
         if (null === $order->getCustomer()) {
             return;
         }

diff --git a/src/Creator/InvoiceCreator.php b/src/Creator/InvoiceCreator.php
@@ -43,16 +43,16 @@ public function __construct(
 
     public function __invoke(string $orderNumber, \DateTimeInterface $dateTime): void
     {
+        /** @var OrderInterface $order */
+        $order = $this->orderRepository->findOneByNumber($orderNumber);
+
         /** @var InvoiceInterface|null $invoice */
-        $invoice = $this->invoiceRepository->findOneByOrderNumber($orderNumber);
+        $invoice = $this->invoiceRepository->findOneByOrder($order);
 
         if (null !== $invoice) {
             throw InvoiceAlreadyGenerated::withOrderNumber($orderNumber);
         }
 
-        /** @var OrderInterface $order */
-        $order = $this->orderRepository->findOneByNumber($orderNumber);
-
         $invoice = $this->invoiceGenerator->generateForOrder($order, $dateTime);
 
         $this->invoiceRepository->add($invoice);

diff --git a/src/Doctrine/ORM/InvoiceRepository.php b/src/Doctrine/ORM/InvoiceRepository.php
@@ -14,15 +14,28 @@
 namespace Sylius\InvoicingPlugin\Doctrine\ORM;
 
 use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;
+use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
 
 class InvoiceRepository extends EntityRepository implements InvoiceRepositoryInterface
 {
-    public function findOneByOrderNumber(string $orderNumber): ?InvoiceInterface
+    public function findOneByOrder(OrderInterface $order): ?InvoiceInterface
     {
         /** @var InvoiceInterface|null $invoice */
-        $invoice = $this->findOneBy(['orderNumber' => $orderNumber]);
+        $invoice = $this->findOneBy(['order' => $order]);
 
         return $invoice;
     }
+
+    public function findByOrderNumber(string $orderNumber): array
+    {
+        return $this
+            ->createQueryBuilder('invoice')
+            ->innerJoin('invoice.order', 'o')
+            ->where('o.number = :orderNumber')
+            ->setParameter('orderNumber', $orderNumber)
+            ->getQuery()
+            ->getResult()
+        ;
+    }
 }
diff --git a/src/Doctrine/ORM/InvoiceRepositoryInterface.php b/src/Doctrine/ORM/InvoiceRepositoryInterface.php
@@ -13,10 +13,13 @@
 
 namespace Sylius\InvoicingPlugin\Doctrine\ORM;
 
+use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
 use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
 
 interface InvoiceRepositoryInterface extends RepositoryInterface
 {
-    public function findOneByOrderNumber(string $orderNumber): ?InvoiceInterface;
+    public function findOneByOrder(OrderInterface $order): ?InvoiceInterface;
+
+    public function findByOrderNumber(string $orderNumber): array;
 }
diff --git a/src/Entity/Invoice.php b/src/Entity/Invoice.php
@@ -15,6 +15,7 @@
 
 use Doctrine\Common\Collections\Collection;
 use Sylius\Component\Core\Model\ChannelInterface;
+use Sylius\Component\Core\Model\OrderInterface;
 
 /** @final */
 class Invoice implements InvoiceInterface
@@ -25,8 +26,8 @@ class Invoice implements InvoiceInterface
     /** @var string */
     protected $number;
 
-    /** @var string */
-    protected $orderNumber;
+    /** @var OrderInterface */
+    protected $order;
 
     /** @var \DateTimeInterface */
     protected $issuedAt;
@@ -58,7 +59,7 @@ class Invoice implements InvoiceInterface
     public function __construct(
         string $id,
         string $number,
-        string $orderNumber,
+        OrderInterface $order,
         \DateTimeInterface $issuedAt,
         BillingDataInterface $billingData,
         string $currencyCode,
@@ -71,7 +72,7 @@ public function __construct(
     ) {
         $this->id = $id;
         $this->number = $number;
-        $this->orderNumber = $orderNumber;
+        $this->order = $order;
         $this->issuedAt = clone $issuedAt;
         $this->billingData = $billingData;
         $this->currencyCode = $currencyCode;
@@ -108,9 +109,14 @@ public function number(): string
         return $this->number;
     }
 
+    public function order(): OrderInterface
+    {
+        return $this->order;
+    }
+
     public function orderNumber(): string
     {
-        return $this->orderNumber;
+        return (string) $this->order->getNumber();
     }
 
     public function issuedAt(): \DateTimeInterface

diff --git a/src/Entity/InvoiceInterface.php b/src/Entity/InvoiceInterface.php
@@ -15,6 +15,7 @@
 
 use Doctrine\Common\Collections\Collection;
 use Sylius\Component\Core\Model\ChannelInterface;
+use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Resource\Model\ResourceInterface;
 
 interface InvoiceInterface extends ResourceInterface
@@ -23,6 +24,9 @@ public function id(): string;
 
     public function number(): string;
 
+    public function order(): OrderInterface;
+
+    /** @deprecated this method is deprecated an will be remove in v1.0 - use InvoiceInterface::order() instead */
     public function orderNumber(): string;
 
     public function issuedAt(): \DateTimeInterface;

diff --git a/src/EventProducer/OrderPaymentPaidProducer.php b/src/EventProducer/OrderPaymentPaidProducer.php
@@ -63,6 +63,6 @@ private function shouldEventBeDispatched(PaymentInterface $payment): bool
         /** @var OrderInterface $order */
         $order = $payment->getOrder();
 
-        return null !== $order && null !== $this->invoiceRepository->findOneByOrderNumber($order->getNumber());
+        return null !== $order && null !== $this->invoiceRepository->findOneByOrder($order);
     }
 }
diff --git a/src/Factory/InvoiceFactory.php b/src/Factory/InvoiceFactory.php
@@ -15,6 +15,7 @@
 
 use Doctrine\Common\Collections\Collection;
 use Sylius\Component\Core\Model\ChannelInterface;
+use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\InvoicingPlugin\Entity\BillingDataInterface;
 use Sylius\InvoicingPlugin\Entity\Invoice;
 use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
@@ -26,7 +27,7 @@ final class InvoiceFactory implements InvoiceFactoryInterface
     public function createForData(
         string $id,
         string $number,
-        string $orderNumber,
+        OrderInterface $order,
         \DateTimeInterface $issuedAt,
         BillingDataInterface $billingData,
         string $currencyCode,
@@ -40,7 +41,7 @@ public function createForData(
         return new Invoice(
             $id,
             $number,
-            $orderNumber,
+            $order,
             $issuedAt,
             $billingData,
             $currencyCode,