[CreditMemo] Add tax items to credit memo

Sylius · Jan 14, 2020 · f93fc37 · f93fc37
1 parent dc9eabb
commit f93fc37
Show file tree

Hide file tree

Showing 20 changed files with 447 additions and 8 deletions.
diff --git a/migrations/Version20200113091731.php b/migrations/Version20200113091731.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20200113091731 extends AbstractMigration
+{
+    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 sylius_refund_credit_memo ADD tax_items LONGTEXT DEFAULT NULL COMMENT \'(DC2Type:json)\'');
+    }
+
+    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 sylius_refund_credit_memo DROP tax_items');
+    }
+}
diff --git a/spec/Entity/CreditMemoSpec.php b/spec/Entity/CreditMemoSpec.php
@@ -10,12 +10,14 @@
 use Sylius\RefundPlugin\Entity\CreditMemoUnit;
 use Sylius\RefundPlugin\Entity\CustomerBillingData;
 use Sylius\RefundPlugin\Entity\ShopBillingData;
+use Sylius\RefundPlugin\Entity\TaxItem;
 
 final class CreditMemoSpec extends ObjectBehavior
 {
     function let(ChannelInterface $channel): void
     {
         $creditMemoUnit = new CreditMemoUnit('Portal gun', 1000, 50);
+        $taxItem = new TaxItem('VAT', 50);
 
         $this->beConstructedWith(
             '7903c83a-4c5e-4bcf-81d8-9dc304c6a353',
@@ -26,6 +28,7 @@ function let(ChannelInterface $channel): void
             'en_US',
             $channel,
             [$creditMemoUnit->serialize()],
+            [$taxItem->serialize()],
             'Comment',
             new \DateTime('01-01-2020 10:10:10'),
             new CustomerBillingData('Rick Sanchez', 'Main St. 3322', '90802', 'US', 'Curse Purge Plus!', 'Los Angeles', 'Baldwin Hills', '323'),
@@ -58,6 +61,11 @@ function it_has_total(): void
         $this->getTotal()->shouldReturn(1000);
     }
 
+    function it_has_a_subtotal(): void
+    {
+        $this->getSubtotal()->shouldReturn(950);
+    }
+
     function it_has_currency_code(): void
     {
         $this->getCurrencyCode()->shouldReturn('USD');
@@ -78,6 +86,11 @@ function it_has_units(): void
         $this->getUnits()->shouldBeLike([new CreditMemoUnit('Portal gun', 1000, 50)]);
     }
 
+    function it_has_tax_items(): void
+    {
+        $this->getTaxItems()->shouldBeLike([new TaxItem('VAT', 50)]);
+    }
+
     function it_has_date_of_creation(): void
     {
         $this->getIssuedAt()->shouldBeLike(new \DateTime('01-01-2020 10:10:10'));

diff --git a/spec/Entity/TaxItemSpec.php b/spec/Entity/TaxItemSpec.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\Sylius\RefundPlugin\Entity;
+
+use PhpSpec\ObjectBehavior;
+use Sylius\RefundPlugin\Entity\TaxItemInterface;
+
+final class TaxItemSpec extends ObjectBehavior
+{
+    function let(): void
+    {
+        $this->beConstructedWith('VAT', 100);
+    }
+
+    function it_implements_tax_item_interface(): void
+    {
+        $this->shouldImplement(TaxItemInterface::class);
+    }
+
+    function it_has_a_label(): void
+    {
+        $this->getLabel()->shouldReturn('VAT');
+    }
+
+    function it_has_an_amount(): void
+    {
+        $this->getAmount()->shouldReturn(100);
+    }
+}
diff --git a/spec/Generator/CreditMemoGeneratorSpec.php b/spec/Generator/CreditMemoGeneratorSpec.php
@@ -14,11 +14,13 @@
 use Sylius\RefundPlugin\Entity\CreditMemoUnit;
 use Sylius\RefundPlugin\Entity\CustomerBillingData;
 use Sylius\RefundPlugin\Entity\ShopBillingData;
+use Sylius\RefundPlugin\Entity\TaxItem;
 use Sylius\RefundPlugin\Exception\OrderNotFound;
 use Sylius\RefundPlugin\Generator\CreditMemoGeneratorInterface;
 use Sylius\RefundPlugin\Generator\CreditMemoIdentifierGeneratorInterface;
 use Sylius\RefundPlugin\Generator\CreditMemoUnitGeneratorInterface;
 use Sylius\RefundPlugin\Generator\NumberGenerator;
+use Sylius\RefundPlugin\Generator\TaxItemsGeneratorInterface;
 use Sylius\RefundPlugin\Model\OrderItemUnitRefund;
 use Sylius\RefundPlugin\Model\ShipmentRefund;
 use Sylius\RefundPlugin\Provider\CurrentDateTimeProviderInterface;
@@ -29,6 +31,7 @@ function let(
         OrderRepositoryInterface $orderRepository,
         CreditMemoUnitGeneratorInterface $orderItemUnitCreditMemoUnitGenerator,
         CreditMemoUnitGeneratorInterface $shipmentCreditMemoUnitGenerator,
+        TaxItemsGeneratorInterface $taxItemsGenerator,
         NumberGenerator $creditMemoNumberGenerator,
         CurrentDateTimeProviderInterface $currentDateTimeProvider,
         CreditMemoIdentifierGeneratorInterface $creditMemoIdentifierGenerator
@@ -37,6 +40,7 @@ function let(
             $orderRepository,
             $orderItemUnitCreditMemoUnitGenerator,
             $shipmentCreditMemoUnitGenerator,
+            $taxItemsGenerator,
             $creditMemoNumberGenerator,
             $currentDateTimeProvider,
             $creditMemoIdentifierGenerator
@@ -50,15 +54,16 @@ function it_implements_credit_memo_generator_interface(): void
 
     function it_generates_credit_memo_basing_on_event_data(
         OrderRepositoryInterface $orderRepository,
+        CreditMemoUnitGeneratorInterface $orderItemUnitCreditMemoUnitGenerator,
+        CreditMemoUnitGeneratorInterface $shipmentCreditMemoUnitGenerator,
+        TaxItemsGeneratorInterface $taxItemsGenerator,
         NumberGenerator $creditMemoNumberGenerator,
+        CurrentDateTimeProviderInterface $currentDateTimeProvider,
+        CreditMemoIdentifierGeneratorInterface $creditMemoIdentifierGenerator,
         OrderInterface $order,
         ChannelInterface $channel,
         ShopBillingDataInterface $shopBillingData,
         AddressInterface $customerBillingAddress,
-        CreditMemoUnitGeneratorInterface $orderItemUnitCreditMemoUnitGenerator,
-        CreditMemoUnitGeneratorInterface $shipmentCreditMemoUnitGenerator,
-        CurrentDateTimeProviderInterface $currentDateTimeProvider,
-        CreditMemoIdentifierGeneratorInterface $creditMemoIdentifierGenerator,
         \DateTime $dateTime
     ): void {
         $firstUnitRefund = new OrderItemUnitRefund(1, 500);
@@ -102,6 +107,9 @@ function it_generates_credit_memo_basing_on_event_data(
         $shipmentCreditMemoUnit = new CreditMemoUnit('Galaxy post', 400, 0);
         $shipmentCreditMemoUnitGenerator->generate(3, 400)->willReturn($shipmentCreditMemoUnit);
 
+        $taxItem = new TaxItem('VAT', 100);
+        $taxItemsGenerator->generate([$firstUnitRefund, $secondUnitRefund])->willReturn([$taxItem]);
+
         $creditMemoNumberGenerator->generate()->willReturn('2018/07/00001111');
 
         $currentDateTimeProvider->now()->willReturn($dateTime);
@@ -121,6 +129,7 @@ function it_generates_credit_memo_basing_on_event_data(
                 $secondCreditMemoUnit->serialize(),
                 $shipmentCreditMemoUnit->serialize(),
             ],
+            [$taxItem->serialize()],
             'Comment',
             $dateTime->getWrappedObject(),
             new CustomerBillingData('Rick Sanchez', 'Universe St. 444', '000333', 'US', 'Los Angeles', 'Curse Purge Plus!'),

diff --git a/spec/Generator/TaxItemsGeneratorSpec.php b/spec/Generator/TaxItemsGeneratorSpec.php
@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\Sylius\RefundPlugin\Generator;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use PhpSpec\ObjectBehavior;
+use Sylius\Component\Core\Model\AdjustmentInterface;
+use Sylius\Component\Core\Model\OrderItemUnitInterface;
+use Sylius\Component\Resource\Repository\RepositoryInterface;
+use Sylius\RefundPlugin\Entity\TaxItem;
+use Sylius\RefundPlugin\Generator\TaxItemsGeneratorInterface;
+use Sylius\RefundPlugin\Model\OrderItemUnitRefund;
+
+final class TaxItemsGeneratorSpec extends ObjectBehavior
+{
+    function let(RepositoryInterface $orderItemUnitRepository): void
+    {
+        $this->beConstructedWith($orderItemUnitRepository);
+    }
+
+    function it_implements_tax_items_generator_interface(): void
+    {
+        $this->shouldImplement(TaxItemsGeneratorInterface::class);
+    }
+
+    function it_generates_tax_items(
+        RepositoryInterface $orderItemUnitRepository,
+        OrderItemUnitInterface $firstOrderItemUnit,
+        OrderItemUnitInterface $secondOrderItemUnit,
+        AdjustmentInterface $firstAdjustment,
+        AdjustmentInterface $secondAdjustment
+    ): void {
+        $firstUnitRefund = new OrderItemUnitRefund(1, 500);
+        $secondUnitRefund = new OrderItemUnitRefund(3, 200);
+
+        $orderItemUnitRepository->find(1)->willReturn($firstOrderItemUnit);
+        $firstOrderItemUnit->getTotal()->willReturn(500);
+        $firstOrderItemUnit->getTaxTotal()->willReturn(50);
+        $firstOrderItemUnit
+            ->getAdjustments(AdjustmentInterface::TAX_ADJUSTMENT)
+            ->willReturn(new ArrayCollection([$firstAdjustment->getWrappedObject()]))
+        ;
+        $firstAdjustment->getLabel()->willReturn('VAT');
+
+        $orderItemUnitRepository->find(3)->willReturn($secondOrderItemUnit);
+        $secondOrderItemUnit->getTotal()->willReturn(200);
+        $secondOrderItemUnit->getTaxTotal()->willReturn(20);
+        $secondOrderItemUnit
+            ->getAdjustments(AdjustmentInterface::TAX_ADJUSTMENT)
+            ->willReturn(new ArrayCollection([$secondAdjustment->getWrappedObject()]))
+        ;
+        $secondAdjustment->getLabel()->willReturn('VAT');
+
+        $this->generate([$firstUnitRefund, $secondUnitRefund])->shouldBeLike([new TaxItem('VAT', 70)]);
+    }
+
+    function it_generates_tax_items_with_partial_amount(
+        RepositoryInterface $orderItemUnitRepository,
+        OrderItemUnitInterface $orderItemUnit,
+        AdjustmentInterface $adjustment
+    ): void {
+        $unitRefund = new OrderItemUnitRefund(1, 250);
+
+        $orderItemUnitRepository->find(1)->willReturn($orderItemUnit);
+        $orderItemUnit->getTotal()->willReturn(500);
+        $orderItemUnit->getTaxTotal()->willReturn(50);
+        $orderItemUnit
+            ->getAdjustments(AdjustmentInterface::TAX_ADJUSTMENT)
+            ->willReturn(new ArrayCollection([$adjustment->getWrappedObject()]))
+        ;
+        $adjustment->getLabel()->willReturn('VAT');
+
+        $this->generate([$unitRefund])->shouldBeLike([new TaxItem('VAT', 25)]);
+    }
+}
diff --git a/src/Entity/CreditMemo.php b/src/Entity/CreditMemo.php
@@ -33,6 +33,9 @@ class CreditMemo implements CreditMemoInterface
     /** @var array */
     protected $units;
 
+    /** @var array */
+    protected $taxItems;
+
     /** @var string */
     protected $comment;
 
@@ -54,6 +57,7 @@ public function __construct(
         string $localeCode,
         ChannelInterface $channel,
         array $units,
+        array $taxItems,
         string $comment,
         \DateTimeInterface $issuedAt,
         CustomerBillingDataInterface $from,
@@ -67,6 +71,7 @@ public function __construct(
         $this->localeCode = $localeCode;
         $this->channel = $channel;
         $this->units = $units;
+        $this->taxItems = $taxItems;
         $this->comment = $comment;
         $this->issuedAt = $issuedAt;
         $this->from = $from;
@@ -118,6 +123,16 @@ public function getUnits(): array
         return $units;
     }
 
+    public function getTaxItems(): array
+    {
+        $taxItems = [];
+        foreach ($this->taxItems as $taxItem) {
+            $taxItems[] = TaxItem::unserialize($taxItem);
+        }
+
+        return $taxItems;
+    }
+
     public function getComment(): string
     {
         return $this->comment;
@@ -137,4 +152,16 @@ public function getTo(): ?ShopBillingDataInterface
     {
         return $this->to;
     }
+
+    public function getSubtotal(): int
+    {
+        $subtotal = 0;
+
+        /** @var CreditMemoUnit $unit */
+        foreach ($this->getUnits() as $unit) {
+            $subtotal += $unit->getTotal() - $unit->getTaxesTotal();
+        }
+
+        return $subtotal;
+    }
 }
diff --git a/src/Entity/CreditMemoInterface.php b/src/Entity/CreditMemoInterface.php
@@ -23,11 +23,18 @@ public function getChannel(): ChannelInterface;
 
     public function getUnits(): array;
 
+    /**
+     * @return array<TaxItemInterface>
+     */
+    public function getTaxItems(): array;
+
     public function getComment(): string;
 
     public function getIssuedAt(): \DateTimeInterface;
 
     public function getFrom(): CustomerBillingDataInterface;
 
     public function getTo(): ?ShopBillingDataInterface;
+
+    public function getSubtotal(): int;
 }
diff --git a/src/Entity/TaxItem.php b/src/Entity/TaxItem.php
@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\RefundPlugin\Entity;
+
+/** @final */
+class TaxItem implements TaxItemInterface
+{
+    /** @var string */
+    protected $label;
+
+    /** @var int */
+    protected $amount;
+
+    public function __construct(string $label, int $amount)
+    {
+        $this->label = $label;
+        $this->amount = $amount;
+    }
+
+    public function getLabel(): string
+    {
+        return $this->label;
+    }
+
+    public function getAmount(): int
+    {
+        return $this->amount;
+    }
+
+    public function serialize(): string
+    {
+        $serialized = json_encode(['label' => $this->label, 'amount' => $this->amount]);
+
+        if ($serialized === false) {
+            throw new \Exception('Tax item cannot be serialized.');
+        }
+
+        return $serialized;
+    }
+
+    public static function unserialize(string $serialized): self
+    {
+        $data = json_decode($serialized, true);
+
+        return new self($data['label'], $data['amount']);
+    }
+}
diff --git a/src/Entity/TaxItemInterface.php b/src/Entity/TaxItemInterface.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\RefundPlugin\Entity;
+
+interface TaxItemInterface
+{
+    public function getLabel(): string;
+
+    public function getAmount(): int;
+
+    public function serialize(): string;
+}