[CreditMemo] Fixes for reworking credit memos after PR review

Sylius · Jan 29, 2020 · b7a1869 · b7a1869
1 parent 981220d
commit b7a1869
Show file tree

Hide file tree

Showing 25 changed files with 202 additions and 141 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,12 +1,12 @@
 ### UPGRADE FROM 1.0.0-RC.1 TO 1.0.0-RC.2
 
-1. `CreditMemoUnit` changed to `LineItem` which is a resource entity now
+1. `Sylius\RefundPlugin\Entity\CreditMemoUnit` was changed to `Sylius\RefundPlugin\Entity\LineItem` which is a resource entity now.
 
-2. `CreditMemoUnitGeneratorInterface` changed to `LineItemsConverterInterface` and moved from `Generator` to `Converter` directory
+2. `Sylius\RefundPlugin\Generator\CreditMemoUnitGeneratorInterface` was changed to `Sylius\RefundPlugin\Converter\LineItemsConverterInterface`.
 
-3. `OrderItemUnitCreditMemoUnitGenerator` changed to `LineItemsConverter` and moved from `Generator` to `Converter` directory
+3. `Sylius\RefundPlugin\Generator\OrderItemUnitCreditMemoUnitGenerator` was changed to `Sylius\RefundPlugin\Converter\LineItemsConverter`.
 
-4. `ShipmentCreditMemoUnitGenerator` changed to `ShipmentLineItemsConverter` and moved from `Generator` to `Converter` directory
+4. `Sylius\RefundPlugin\Generator\ShipmentCreditMemoUnitGenerator` was changed to `Sylius\RefundPlugin\Converter\ShipmentLineItemsConverter`.
 
 There are no migrations that provide backward compatibility, save current credit memos before upgrading the version of plugin. 
 

diff --git a/features/refunding_part_of_order_unit.feature b/features/refunding_part_of_order_unit.feature
@@ -28,23 +28,23 @@ Feature: Refunding a part of an order unit
 
     @ui @application
     Scenario: Refunding the whole order unit price after partial refund
-        Given the 1st "Mr. Meeseeks T-Shirt" product from order "#00000022" already has a refund of "$5.00" with "Space money" payment
+        Given the 1st "Mr. Meeseeks T-Shirt" product from order "#00000022" has a refund of "$5.00" with "Space money" payment
         When I want to refund some units of order "#00000022"
         And I decide to refund 1st "Mr. Meeseeks T-Shirt" product with "Space money" payment
         Then I should be notified that selected order units have been successfully refunded
         And this order refunded total should be "$12.30"
 
     @ui @javascript
     Scenario: Refunding the whole order price after partial refund
-        Given the 1st "Mr. Meeseeks T-Shirt" product from order "#00000022" already has a refund of "$5.00" with "Space money" payment
+        Given the 1st "Mr. Meeseeks T-Shirt" product from order "#00000022" has a refund of "$5.00" with "Space money" payment
         When I want to refund some units of order "#00000022"
         And I decide to refund all units of this order with "Space money" payment
         Then I should be notified that selected order units have been successfully refunded
         And this order refunded total should be "$44.60"
 
     @ui @application
     Scenario: Not being able to refund more money than order unit total
-        Given the 1st "Mr. Meeseeks T-Shirt" product from order "#00000022" already has a refund of "$5.00" with "Space money" payment
+        Given the 1st "Mr. Meeseeks T-Shirt" product from order "#00000022" has a refund of "$5.00" with "Space money" payment
         When I want to refund some units of order "#00000022"
         And I decide to refund "$10.00" from 1st "Mr. Meeseeks T-Shirt" product with "Space money" payment
         Then I should be notified that I cannot refund more money than the order unit total

diff --git a/features/viewing_details_of_credit_memo.feature b/features/viewing_details_of_credit_memo.feature
@@ -39,7 +39,7 @@ Feature: Viewing details of a credit memo
 
     @ui @application
     Scenario: Viewing details of a credit memo issued for a partial refund
-        Given the 1st "PHP T-Shirt" product from order "#00000022" already has a refund of "$5.50" with "Space money" payment
+        Given the 1st "PHP T-Shirt" product from order "#00000022" has a refund of "$5.50" with "Space money" payment
         When I browse the details of the only credit memo generated for order "#00000022"
         Then it should have sequential number generated from current date
         And it should be issued in "United States" channel

diff --git a/spec/Converter/LineItemsConverterSpec.php b/spec/Converter/LineItemsConverterSpec.php
@@ -47,7 +47,7 @@ function it_converts_unit_refunds_to_line_items(
         $orderItem->getProductName()->willReturn('Portal gun');
         $adjustment->getLabel()->willReturn('25%');
 
-        $this->convert([$unitRefund])->shouldBeLike(new ArrayCollection([new LineItem(
+        $this->convert([$unitRefund])->shouldBeLike([new LineItem(
             'Portal gun',
             1,
             400,
@@ -56,7 +56,7 @@ function it_converts_unit_refunds_to_line_items(
             500,
             100,
             '25%'
-        )]));
+        )]);
     }
 
     function it_groups_the_same_line_items_during_converting(
@@ -98,7 +98,7 @@ function it_groups_the_same_line_items_during_converting(
         $secondOrderItem->getProductName()->willReturn('Space gun');
         $secondAdjustment->getLabel()->willReturn('20%');
 
-        $this->convert([$firstUnitRefund, $secondUnitRefund, $thirdUnitRefund])->shouldBeLike(new ArrayCollection([
+        $this->convert([$firstUnitRefund, $secondUnitRefund, $thirdUnitRefund])->shouldBeLike([
             new LineItem(
                 'Portal gun',
                 1,
@@ -119,7 +119,7 @@ function it_groups_the_same_line_items_during_converting(
                 320,
                 '20%'
             ),
-        ]));
+        ]);
     }
 
     function it_throws_an_exception_if_there_is_no_shipping_adjustment_with_given_id(

diff --git a/spec/Converter/ShipmentLineItemsConverterSpec.php b/spec/Converter/ShipmentLineItemsConverterSpec.php
@@ -4,7 +4,6 @@
 
 namespace spec\Sylius\RefundPlugin\Converter;
 
-use Doctrine\Common\Collections\ArrayCollection;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\AdjustmentInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
@@ -38,15 +37,15 @@ function it_converts_shipment_unit_refunds_to_line_items(
         $shippingAdjustment->getLabel()->willReturn('Galaxy post');
         $shippingAdjustment->getAmount()->willReturn(1000);
 
-        $this->convert([$unitRefund])->shouldBeLike(new ArrayCollection([new LineItem(
+        $this->convert([$unitRefund])->shouldBeLike([new LineItem(
             'Galaxy post',
             1,
             500,
             500,
             500,
             500,
             0
-        )]));
+        )]);
     }
 
     function it_throws_an_exception_if_there_is_no_shipping_adjustment_with_given_id(

diff --git a/spec/Entity/CreditMemoSpec.php b/spec/Entity/CreditMemoSpec.php
@@ -4,11 +4,9 @@
 
 namespace spec\Sylius\RefundPlugin\Entity;
 
-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\RefundPlugin\Entity\CreditMemoInterface;
 use Sylius\RefundPlugin\Entity\CustomerBillingData;
 use Sylius\RefundPlugin\Entity\LineItemInterface;
@@ -29,7 +27,7 @@ function let(LineItemInterface $lineItem, ChannelInterface $channel, OrderInterf
             'USD',
             'en_US',
             $channel,
-            new ArrayCollection([$lineItem->getWrappedObject()]),
+            [$lineItem->getWrappedObject()],
             [$taxItem->serialize()],
             'Comment',
             new \DateTime('01-01-2020 10:10:10'),
@@ -43,11 +41,6 @@ function it_implements_a_credit_memo_interface(): void
         $this->shouldImplement(CreditMemoInterface::class);
     }
 
-    function it_implements_a_resource_interface(): void
-    {
-        $this->shouldImplement(ResourceInterface::class);
-    }
-
     function it_has_id(): void
     {
         $this->getId()->shouldReturn('7903c83a-4c5e-4bcf-81d8-9dc304c6a353');
@@ -85,7 +78,7 @@ function it_has_a_channel(ChannelInterface $channel): void
 
     function it_has_line_items(LineItemInterface $lineItem): void
     {
-        $this->getLineItems()->shouldBeLike(new ArrayCollection([$lineItem->getWrappedObject()]));
+        $this->getLineItems()->shouldBeLike([$lineItem->getWrappedObject()]);
     }
 
     function it_has_tax_items(): void

diff --git a/spec/Entity/LineItemSpec.php b/spec/Entity/LineItemSpec.php
@@ -7,6 +7,7 @@
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Resource\Model\ResourceInterface;
 use Sylius\RefundPlugin\Entity\LineItemInterface;
+use Sylius\RefundPlugin\Exception\LineItemsCannotBeMerged;
 
 final class LineItemSpec extends ObjectBehavior
 {
@@ -36,4 +37,49 @@ function it_has_proper_line_item_data(): void
         $this->taxAmount()->shouldReturn(200);
         $this->taxRate()->shouldReturn('10%');
     }
+
+    function it_merges_with_another_line_item(LineItemInterface $newLineItem): void
+    {
+        $newLineItem->name()->willReturn('Mjolnir');
+        $newLineItem->quantity()->willReturn(1);
+        $newLineItem->unitNetPrice()->willReturn(1000);
+        $newLineItem->unitGrossPrice()->willReturn(1100);
+        $newLineItem->netValue()->willReturn(1000);
+        $newLineItem->grossValue()->willReturn(1100);
+        $newLineItem->taxAmount()->willReturn(100);
+        $newLineItem->taxRate()->willReturn('10%');
+
+        $this->merge($newLineItem);
+
+        $this->quantity()->shouldReturn(3);
+        $this->netValue()->shouldReturn(3000);
+        $this->grossValue()->shouldReturn(3300);
+        $this->taxAmount()->shouldReturn(300);
+    }
+
+    function it_throws_an_exception_if_another_line_item_is_different_during_merging(LineItemInterface $newLineItem): void
+    {
+        $newLineItem->name()->willReturn('Stormbreaker');
+        $newLineItem->unitNetPrice()->willReturn(1000);
+        $newLineItem->unitGrossPrice()->willReturn(1100);
+        $newLineItem->taxRate()->willReturn('10%');
+
+        $this->shouldThrow(LineItemsCannotBeMerged::class)->during('merge', [$newLineItem]);
+    }
+
+    function it_compares_with_another_line_item(LineItemInterface $theSameLineItem, LineItemInterface $differentLineItem): void
+    {
+        $theSameLineItem->name()->willReturn('Mjolnir');
+        $theSameLineItem->unitNetPrice()->willReturn(1000);
+        $theSameLineItem->unitGrossPrice()->willReturn(1100);
+        $theSameLineItem->taxRate()->willReturn('10%');
+
+        $differentLineItem->name()->willReturn('Stormbreaker');
+        $differentLineItem->unitNetPrice()->willReturn(1000);
+        $differentLineItem->unitGrossPrice()->willReturn(1100);
+        $differentLineItem->taxRate()->willReturn('10%');
+
+        $this->compare($theSameLineItem)->shouldReturn(true);
+        $this->compare($differentLineItem)->shouldReturn(false);
+    }
 }
diff --git a/spec/Generator/CreditMemoGeneratorSpec.php b/spec/Generator/CreditMemoGeneratorSpec.php
@@ -4,7 +4,6 @@
 
 namespace spec\Sylius\RefundPlugin\Generator;
 
-use Doctrine\Common\Collections\ArrayCollection;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\AddressInterface;
 use Sylius\Component\Core\Model\ChannelInterface;
@@ -13,6 +12,7 @@
 use Sylius\RefundPlugin\Converter\LineItemsConverterInterface;
 use Sylius\RefundPlugin\Entity\CreditMemo;
 use Sylius\RefundPlugin\Entity\CustomerBillingData;
+use Sylius\RefundPlugin\Entity\LineItemInterface;
 use Sylius\RefundPlugin\Entity\ShopBillingData;
 use Sylius\RefundPlugin\Entity\TaxItem;
 use Sylius\RefundPlugin\Generator\CreditMemoGeneratorInterface;
@@ -59,6 +59,8 @@ function it_generates_credit_memo_basing_on_event_data(
         ChannelInterface $channel,
         ShopBillingDataInterface $shopBillingData,
         AddressInterface $customerBillingAddress,
+        LineItemInterface $firstLineItem,
+        LineItemInterface $secondLineItem,
         \DateTime $dateTime
     ): void {
         $firstUnitRefund = new OrderItemUnitRefund(1, 500);
@@ -92,14 +94,11 @@ function it_generates_credit_memo_basing_on_event_data(
         $customerBillingAddress->getProvinceName()->willReturn(null);
         $customerBillingAddress->getProvinceCode()->willReturn(null);
 
-        $mockedLineItems = new ArrayCollection();
-        $mockedShipmentLineItems = new ArrayCollection();
-
-        $lineItemsConverter->convert([$firstUnitRefund, $secondUnitRefund])->willReturn($mockedLineItems);
-        $shipmentLineItemsConverter->convert([$shipmentRefund])->willReturn($mockedShipmentLineItems);
+        $lineItemsConverter->convert([$firstUnitRefund, $secondUnitRefund])->willReturn([$firstLineItem]);
+        $shipmentLineItemsConverter->convert([$shipmentRefund])->willReturn([$secondLineItem]);
 
         $taxItem = new TaxItem('VAT', 100);
-        $taxItemsGenerator->generate($mockedLineItems)->willReturn([$taxItem]);
+        $taxItemsGenerator->generate([$firstLineItem, $secondLineItem])->willReturn([$taxItem]);
 
         $creditMemoNumberGenerator->generate()->willReturn('2018/07/00001111');
 
@@ -115,7 +114,7 @@ function it_generates_credit_memo_basing_on_event_data(
             'GBP',
             'en_US',
             $channel->getWrappedObject(),
-            $mockedLineItems,
+            [$firstLineItem->getWrappedObject(), $secondLineItem->getWrappedObject()],
             [$taxItem->serialize()],
             'Comment',
             $dateTime->getWrappedObject(),

diff --git a/spec/Generator/TaxItemsGeneratorSpec.php b/spec/Generator/TaxItemsGeneratorSpec.php
@@ -4,7 +4,6 @@
 
 namespace spec\Sylius\RefundPlugin\Generator;
 
-use Doctrine\Common\Collections\ArrayCollection;
 use PhpSpec\ObjectBehavior;
 use Sylius\RefundPlugin\Entity\LineItemInterface;
 use Sylius\RefundPlugin\Entity\TaxItem;
@@ -26,7 +25,7 @@ function it_generates_tax_items(LineItemInterface $firstLineItem, LineItemInterf
         $secondLineItem->taxAmount()->willReturn(800);
 
         $this
-            ->generate(new ArrayCollection([$firstLineItem->getWrappedObject(), $secondLineItem->getWrappedObject()]))
+            ->generate([$firstLineItem->getWrappedObject(), $secondLineItem->getWrappedObject()])
             ->shouldBeLike([new TaxItem('VAT', 1300)])
         ;
     }