[Enhancement] Refactor and deprecate Invoice repository class

UPGRADE.md

@@ -1,3 +1,11 @@
+### UPGRADE FROM 0.11.0 TO 0.11.1
+
+1. The custom repository has been removed :
+
+ - removed the repository class `DoctrineInvoiceRepository` and replaced by `Sylius\InvoicingPlugin\Doctrine\ORM\InvoiceRepository`
+ - removed the related service `sylius_invoicing_plugin.custom_repository.invoice` use `sylius_invoicing_plugin.repository.invoice` instead
+ - removed the related interface `InvoiceRepository` use `Sylius\InvoicingPlugin\Doctrine\ORM\InvoiceRepositoryInterface` instead
+
 ### UPGRADE FROM 0.10.X TO 0.11.0
 
 1. Upgrade your application to [Sylius 1.8](https:/Sylius/Sylius/blob/master/UPGRADE-1.8.md).

composer.json

@@ -48,6 +48,9 @@
  "symfony/web-profiler-bundle": "^4.4",
  "symfony/web-server-bundle": "^4.4"
  },
+ "conflict": {
+ "symplify/package-builder": "^8.3.25"
+ },
  "autoload": {
  "psr-4": {
  "Sylius\\InvoicingPlugin\\": "src/",

spec/CommandHandler/SendInvoiceEmailHandlerSpec.php

@@ -9,22 +9,22 @@
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Repository\OrderRepositoryInterface;
 use Sylius\InvoicingPlugin\Command\SendInvoiceEmail;
+use Sylius\InvoicingPlugin\Doctrine\ORM\InvoiceRepositoryInterface;
 use Sylius\InvoicingPlugin\Email\InvoiceEmailSenderInterface;
 use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
-use Sylius\InvoicingPlugin\Repository\InvoiceRepository;
 
 final class SendInvoiceEmailHandlerSpec extends ObjectBehavior
 {
  function let(
- InvoiceRepository $invoiceRepository,
+ InvoiceRepositoryInterface $invoiceRepository,
  OrderRepositoryInterface $orderRepository,
  InvoiceEmailSenderInterface $emailSender
  ): void {
  $this->beConstructedWith($invoiceRepository, $orderRepository, $emailSender);
  }
 
  function it_requests_an_email_with_an_invoice_to_be_sent(
- InvoiceRepository $invoiceRepository,
+ InvoiceRepositoryInterface $invoiceRepository,
  OrderRepositoryInterface $orderRepository,
  InvoiceEmailSenderInterface $emailSender,
  InvoiceInterface $invoice,
@@ -45,7 +45,7 @@ function it_requests_an_email_with_an_invoice_to_be_sent(
  }
 
  function it_does_not_request_an_email_to_be_sent_if_invoice_was_not_found(
- InvoiceRepository $invoiceRepository,
+ InvoiceRepositoryInterface $invoiceRepository,
  OrderRepositoryInterface $orderRepository,
  InvoiceEmailSenderInterface $emailSender,
  OrderInterface $order,

spec/Creator/InvoiceCreatorSpec.php

@@ -9,15 +9,15 @@
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Repository\OrderRepositoryInterface;
 use Sylius\InvoicingPlugin\Creator\InvoiceCreatorInterface;
+use Sylius\InvoicingPlugin\Doctrine\ORM\InvoiceRepositoryInterface;
 use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
 use Sylius\InvoicingPlugin\Exception\InvoiceAlreadyGenerated;
 use Sylius\InvoicingPlugin\Generator\InvoiceGeneratorInterface;
-use Sylius\InvoicingPlugin\Repository\InvoiceRepository;
 
 final class InvoiceCreatorSpec extends ObjectBehavior
 {
  public function let(
- InvoiceRepository $invoiceRepository,
+ InvoiceRepositoryInterface $invoiceRepository,
  OrderRepositoryInterface $orderRepository,
  InvoiceGeneratorInterface $invoiceGenerator
  ): void {
@@ -30,7 +30,7 @@ public function it_implements_invoice_for_order_creator_interface(): void
  }
 
  public function it_creates_invoice_for_order(
- InvoiceRepository $invoiceRepository,
+ InvoiceRepositoryInterface $invoiceRepository,
  OrderRepositoryInterface $orderRepository,
  InvoiceGeneratorInterface $invoiceGenerator,
  OrderInterface $order,
@@ -50,7 +50,7 @@ public function it_creates_invoice_for_order(
  }
 
  public function it_throws_an_exception_when_invoice_was_already_created_for_given_order(
- InvoiceRepository $invoiceRepository,
+ InvoiceRepositoryInterface $invoiceRepository,
  OrderRepositoryInterface $orderRepository,
  InvoiceGeneratorInterface $invoiceGenerator,
  InvoiceInterface $invoice

spec/EventProducer/OrderPaymentPaidProducerSpec.php

@@ -9,9 +9,9 @@
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Model\PaymentInterface;
 use Sylius\InvoicingPlugin\DateTimeProvider;
+use Sylius\InvoicingPlugin\Doctrine\ORM\InvoiceRepositoryInterface;
 use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
 use Sylius\InvoicingPlugin\Event\OrderPaymentPaid;
-use Sylius\InvoicingPlugin\Repository\InvoiceRepository;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\MessageBusInterface;
 
@@ -20,7 +20,7 @@ final class OrderPaymentPaidProducerSpec extends ObjectBehavior
  function let(
  MessageBusInterface $eventBus,
  DateTimeProvider $dateTimeProvider,
- InvoiceRepository $invoiceRepository
+ InvoiceRepositoryInterface $invoiceRepository
  ): void {
  $this->beConstructedWith($eventBus, $dateTimeProvider, $invoiceRepository);
  }
@@ -30,7 +30,7 @@ function it_dispatches_order_payment_paid_event_for_payment(
  DateTimeProvider $dateTimeProvider,
  PaymentInterface $payment,
  OrderInterface $order,
- InvoiceRepository $invoiceRepository,
+ InvoiceRepositoryInterface $invoiceRepository,
  InvoiceInterface $invoice
  ): void {
  $payment->getOrder()->willReturn($order);
@@ -67,7 +67,7 @@ function it_does_not_dispatch_event_when_there_is_no_invoice_related_to_order(
  DateTimeProvider $dateTimeProvider,
  PaymentInterface $payment,
  OrderInterface $order,
- InvoiceRepository $invoiceRepository
+ InvoiceRepositoryInterface $invoiceRepository
  ): void {
  $payment->getOrder()->willReturn($order);
  $order->getNumber()->willReturn('0000001');

src/CommandHandler/SendInvoiceEmailHandler.php

@@ -7,13 +7,13 @@
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Repository\OrderRepositoryInterface;
 use Sylius\InvoicingPlugin\Command\SendInvoiceEmail;
+use Sylius\InvoicingPlugin\Doctrine\ORM\InvoiceRepositoryInterface;
 use Sylius\InvoicingPlugin\Email\InvoiceEmailSenderInterface;
 use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
-use Sylius\InvoicingPlugin\Repository\InvoiceRepository;
 
 final class SendInvoiceEmailHandler
 {
- /** @var InvoiceRepository */
+ /** @var InvoiceRepositoryInterface */
  private $invoiceRepository;
 
  /** @var OrderRepositoryInterface */
@@ -23,7 +23,7 @@ final class SendInvoiceEmailHandler
  private $emailSender;
 
  public function __construct(
- InvoiceRepository $invoiceRepository,
+ InvoiceRepositoryInterface $invoiceRepository,
  OrderRepositoryInterface $orderRepository,
  InvoiceEmailSenderInterface $emailSender
  ) {

src/Creator/InvoiceCreator.php

@@ -6,14 +6,14 @@
 
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Repository\OrderRepositoryInterface;
+use Sylius\InvoicingPlugin\Doctrine\ORM\InvoiceRepositoryInterface;
 use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
 use Sylius\InvoicingPlugin\Exception\InvoiceAlreadyGenerated;
 use Sylius\InvoicingPlugin\Generator\InvoiceGeneratorInterface;
-use Sylius\InvoicingPlugin\Repository\InvoiceRepository;
 
 final class InvoiceCreator implements InvoiceCreatorInterface
 {
- /** @var InvoiceRepository */
+ /** @var InvoiceRepositoryInterface */
  private $invoiceRepository;
 
  /** @var OrderRepositoryInterface */
@@ -23,7 +23,7 @@ final class InvoiceCreator implements InvoiceCreatorInterface
  private $invoiceGenerator;
 
  public function __construct(
- InvoiceRepository $invoiceRepository,
+ InvoiceRepositoryInterface $invoiceRepository,
  OrderRepositoryInterface $orderRepository,
  InvoiceGeneratorInterface $invoiceGenerator
  ) {

src/DependencyInjection/Configuration.php

@@ -6,6 +6,7 @@
 
 use Sylius\Bundle\ResourceBundle\Controller\ResourceController;
 use Sylius\Component\Resource\Factory\Factory;
+use Sylius\InvoicingPlugin\Doctrine\ORM\InvoiceRepository;
 use Sylius\InvoicingPlugin\Entity\BillingData;
 use Sylius\InvoicingPlugin\Entity\BillingDataInterface;
 use Sylius\InvoicingPlugin\Entity\Invoice;
@@ -42,7 +43,7 @@ public function getConfigTreeBuilder(): TreeBuilder
  ->scalarNode('interface')->defaultValue(InvoiceInterface::class)->cannotBeEmpty()->end()
  ->scalarNode('controller')->defaultValue(ResourceController::class)->cannotBeEmpty()->end()
  ->scalarNode('factory')->defaultValue(Factory::class)->cannotBeEmpty()->end()
- ->scalarNode('repository')->cannotBeEmpty()->end()
+ ->scalarNode('repository')->defaultValue(InvoiceRepository::class)->cannotBeEmpty()->end()
  ->end()
  ->end()
  ->end()

src/Doctrine/ORM/InvoiceRepository.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\InvoicingPlugin\Doctrine\ORM;
+
+use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;
+use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
+
+class InvoiceRepository extends EntityRepository implements InvoiceRepositoryInterface
+{
+ public function findOneByOrderNumber(string $orderNumber): ?InvoiceInterface
+ {
+ /** @var InvoiceInterface|null $invoice */
+ $invoice = $this->findOneBy(['orderNumber' => $orderNumber]);
+
+ return $invoice;
+ }
+}

src/Doctrine/ORM/InvoiceRepositoryInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\InvoicingPlugin\Doctrine\ORM;
+
+use Sylius\Component\Resource\Repository\RepositoryInterface;
+use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
+
+interface InvoiceRepositoryInterface extends RepositoryInterface
+{
+ public function findOneByOrderNumber(string $orderNumber): ?InvoiceInterface;
+}

src/Entity/Invoice.php

@@ -6,10 +6,9 @@
 
 use Doctrine\Common\Collections\Collection;
 use Sylius\Component\Core\Model\ChannelInterface;
-use Sylius\Component\Resource\Model\ResourceInterface;
 
 /** @final */
-class Invoice implements InvoiceInterface, ResourceInterface
+class Invoice implements InvoiceInterface
 {
  /** @var string */
  protected $id;

src/Entity/InvoiceInterface.php

@@ -6,8 +6,9 @@
 
 use Doctrine\Common\Collections\Collection;
 use Sylius\Component\Core\Model\ChannelInterface;
+use Sylius\Component\Resource\Model\ResourceInterface;
 
-interface InvoiceInterface
+interface InvoiceInterface extends ResourceInterface
 {
  public function id(): string;
 

src/EventProducer/OrderPaymentPaidProducer.php

@@ -7,8 +7,8 @@
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Model\PaymentInterface;
 use Sylius\InvoicingPlugin\DateTimeProvider;
+use Sylius\InvoicingPlugin\Doctrine\ORM\InvoiceRepositoryInterface;
 use Sylius\InvoicingPlugin\Event\OrderPaymentPaid;
-use Sylius\InvoicingPlugin\Repository\InvoiceRepository;
 use Symfony\Component\Messenger\MessageBusInterface;
 use Webmozart\Assert\Assert;
 
@@ -20,13 +20,13 @@ final class OrderPaymentPaidProducer
  /** @var DateTimeProvider */
  private $dateTimeProvider;
 
- /** @var InvoiceRepository */
+ /** @var InvoiceRepositoryInterface */
  private $invoiceRepository;
 
  public function __construct(
  MessageBusInterface $eventBus,
  DateTimeProvider $dateTimeProvider,
- InvoiceRepository $invoiceRepository
+ InvoiceRepositoryInterface $invoiceRepository
  ) {
  $this->eventBus = $eventBus;
  $this->dateTimeProvider = $dateTimeProvider;

src/Resources/config/services.xml

@@ -10,15 +10,13 @@
 
  <service id="sylius_invoicing_plugin.date_time_provider" class="Sylius\InvoicingPlugin\SystemDateTimeProvider" />
 
- <service id="sylius_invoicing_plugin.custom_repository.invoice" class="Sylius\InvoicingPlugin\Repository\DoctrineInvoiceRepository" />
-
  <service id="sylius_invoicing_plugin.email.invoice_email_sender" class="Sylius\InvoicingPlugin\Email\InvoiceEmailSender">
  <argument type="service" id="sylius.email_sender" />
  <argument type="service" id="sylius_invoicing_plugin.generator.invoice_pdf_file" />
  </service>
 
  <service id="sylius_invoicing_plugin.command_handler.send_invoice_email" class="Sylius\InvoicingPlugin\CommandHandler\SendInvoiceEmailHandler">
- <argument type="service" id="sylius_invoicing_plugin.custom_repository.invoice" />
+ <argument type="service" id="sylius_invoicing_plugin.repository.invoice" />
  <argument type="service" id="sylius.repository.order" />
  <argument type="service" id="sylius_invoicing_plugin.email.invoice_email_sender" />
  <tag name="messenger.message_handler" />

src/Resources/config/services/actions.xml

@@ -5,13 +5,13 @@
  <defaults autoconfigure="true" autowire="true" public="true" />
 
  <service id="sylius_invoicing_plugin.ui.action.download_invoice" class="Sylius\InvoicingPlugin\Ui\Action\DownloadInvoiceAction">
- <argument type="service" id="sylius_invoicing_plugin.custom_repository.invoice" />
+ <argument type="service" id="sylius_invoicing_plugin.repository.invoice" />
  <argument type="service" id="security.authorization_checker" />
  <argument type="service" id="sylius_invoicing_plugin.generator.invoice_pdf_file" />
  </service>
 
  <service id="sylius_invoicing_plugin.ui.action.resend_invoice" class="Sylius\InvoicingPlugin\Ui\Action\Admin\ResendInvoiceAction">
- <argument type="service" id="sylius_invoicing_plugin.custom_repository.invoice" />
+ <argument type="service" id="sylius_invoicing_plugin.repository.invoice" />
  <argument type="service" id="sylius_invoicing_plugin.email.invoice_email_sender" />
  <argument type="service" id="sylius.repository.order" />
  <argument type="service" id="router" />

src/Resources/config/services/events.xml

@@ -7,7 +7,7 @@
  <service id="sylius_invoicing_plugin.event_producer.order_payment_paid" class="Sylius\InvoicingPlugin\EventProducer\OrderPaymentPaidProducer">
  <argument type="service" id="sylius_invoicing_plugin.event_bus" />
  <argument type="service" id="sylius_invoicing_plugin.date_time_provider" />
- <argument type="service" id="sylius_invoicing_plugin.custom_repository.invoice" />
+ <argument type="service" id="sylius_invoicing_plugin.repository.invoice" />
  </service>
 
  <service id="sylius_invoicing_plugin.event_listener.order_placed" class="Sylius\InvoicingPlugin\EventListener\CreateInvoiceOnOrderPlacedListener">

src/Resources/config/services/generators.xml

@@ -32,7 +32,7 @@
  </service>
 
  <service id="sylius_invoicing_plugin.creator.invoice" class="Sylius\InvoicingPlugin\Creator\InvoiceCreator">
- <argument type="service" id="sylius_invoicing_plugin.custom_repository.invoice" />
+ <argument type="service" id="sylius_invoicing_plugin.repository.invoice" />
  <argument type="service" id="sylius.repository.order" />
  <argument type="service" id="sylius_invoicing_plugin.generator.invoice" />
  </service>