Merge pull request #94 from laurent35240/65_fix_partial_refund_shipping

#65 Fix for partial refund of shipping fees

Author: Zales0123

features/having_credit_memo_generated.feature

@@ -17,6 +17,10 @@ Feature: Having credit memo generated
         And there is a customer "rick.sanchez@wubba-lubba-dub-dub.com" that placed an order "#00000022"
         And the customer bought 2 "Mr. Meeseeks T-Shirt" products
         And the customer chose "Galaxy Post" shipping method to "United States" with "Space money" payment
+        And there is a customer "morty.smith@look-at-me.com" that placed an order "#00000023"
+        And the customer bought 2 "Mr. Meeseeks T-Shirt" products
+        And the customer chose "Galaxy Post" shipping method to "United States" with "Space money" payment
+        And the order "#00000023" is already paid
         And I am logged in as an administrator
         And the order "#00000022" is already paid
 
@@ -44,3 +48,13 @@ Feature: Having credit memo generated
         Then this credit memo should contain 1 "Mr. Meeseeks T-Shirt" product with "$0.50" tax applied
         And it should be issued in "United States" channel
         And its total should be "$5.50"
+
+
+    @ui @application
+    Scenario: Seeing the details of generated credit memo with partial shipment price
+        Given shipment from order "#00000023" has already "$4.50" refunded with "Space money" payment
+        When I browse the details of the only credit memo generated for order "#00000023"
+        And it should have sequential number generated from current date
+        Then this credit memo should contain 1 "Galaxy Post" shipment with "$4.50" total
+        And it should be issued in "United States" channel
+        And its total should be "$4.50"

spec/Generator/ShipmentCreditMemoUnitGeneratorSpec.php

@@ -50,4 +50,21 @@ function it_throws_exception_if_there_is_no_shipping_adjustment_with_given_id(
             ->during('generate', [1])
         ;
     }
+
+    function it_throws_exception_if_refund_amount_is_higher_than_shipping_amount(
+        RepositoryInterface $adjustmentRepository,
+        AdjustmentInterface $shippingAdjustment
+    ): void {
+        $adjustmentRepository
+            ->findOneBy(['id' => 1, 'type' => AdjustmentInterface::SHIPPING_ADJUSTMENT])
+            ->willReturn($shippingAdjustment)
+        ;
+
+        $shippingAdjustment->getAmount()->willReturn(1000);
+
+        $this
+            ->shouldThrow(\InvalidArgumentException::class)
+            ->during('generate', [1, 1001])
+        ;
+    }
 }

src/Generator/ShipmentCreditMemoUnitGenerator.php

@@ -5,6 +5,7 @@
 namespace Sylius\RefundPlugin\Generator;
 
 use Sylius\Component\Core\Model\AdjustmentInterface;
+use Sylius\Component\Order\Model\AdjustmentInterface as OrderAdjustmentInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
 use Sylius\RefundPlugin\Entity\CreditMemoUnit;
 use Sylius\RefundPlugin\Entity\CreditMemoUnitInterface;
@@ -22,13 +23,23 @@ public function __construct(RepositoryInterface $adjustmentRepository)
 
     public function generate(int $unitId, int $amount = null): CreditMemoUnitInterface
     {
-        /** @var AdjustmentInterface $shippingAdjustment */
+        /** @var OrderAdjustmentInterface $shippingAdjustment */
         $shippingAdjustment = $this
             ->adjustmentRepository
             ->findOneBy(['id' => $unitId, 'type' => AdjustmentInterface::SHIPPING_ADJUSTMENT])
         ;
         Assert::notNull($shippingAdjustment);
 
-        return new CreditMemoUnit($shippingAdjustment->getLabel(), $shippingAdjustment->getAmount(), 0);
+        $creditMemoUnitTotal = $this->getCreditMemoUnitTotal($shippingAdjustment, $amount);
+
+        return new CreditMemoUnit($shippingAdjustment->getLabel(), $creditMemoUnitTotal, 0);
+    }
+
+    private function getCreditMemoUnitTotal(OrderAdjustmentInterface $shippingAdjustment, int $amount = null): int
+    {
+        Assert::lessThanEq($amount, $shippingAdjustment->getAmount());
+        $creditMemoUnitTotal = null === $amount ? $shippingAdjustment->getAmount() : $amount;
+
+        return $creditMemoUnitTotal;
     }
 }

tests/Behat/Context/Application/CreditMemoContext.php

@@ -74,6 +74,21 @@ public function thisCreditMemoShouldContainProductWithTaxApplied(
         Assert::same($units[0]->getTaxesTotal(), $taxesTotal);
     }
 
+    /**
+     * @Then /^this credit memo should contain (\d+) "([^"]+)" shipment with ("[^"]+") total$/
+     */
+    public function thisCreditMemoShouldContainShipmentWithTotal(
+        int $count,
+        string $shipmentName,
+        int $total
+    ): void {
+        $units = $this->creditMemo->getUnits();
+
+        Assert::same(count($units), $count);
+        Assert::same($units[0]->getProductName(), $shipmentName);
+        Assert::same($units[0]->getTotal(), $total);
+    }
+
     /**
      * @Then it should be issued in :channelName channel
      */

tests/Behat/Context/Ui/CreditMemoContext.php

@@ -125,6 +125,18 @@ public function thisCreditMemoShouldContainProductWithTaxApplied(
         Assert::same($this->creditMemoDetailsPage->getUnitTax($count, $productName), $tax);
     }
 
+    /**
+     * @Then this credit memo should contain :count :shipmentName shipment with :total total
+     */
+    public function thisCreditMemoShouldContainShipmentWithTotal(
+        int $count,
+        string $shipmentName,
+        string $total
+    ): void {
+        Assert::same($this->creditMemoDetailsPage->countUnitsWithProduct($shipmentName), $count);
+        Assert::same($this->creditMemoDetailsPage->getUnitTotal($count, $shipmentName), $total);
+    }
+
     /**
      * @Then it should have sequential number generated from current date
      */

tests/Behat/Page/Admin/CreditMemoDetailsPage.php

@@ -31,6 +31,13 @@ public function getUnitTax(int $number, string $productName): string
         return $unit->find('css', '.credit-memo-unit-taxes-total')->getText();
     }
 
+    public function getUnitTotal(int $number, string $unitName): string
+    {
+        $unit = $this->getCreditMemoUnitsWithProduct($unitName)[0];
+
+        return $unit->find('css', '.credit-memo-unit-total')->getText();
+    }
+
     public function getNumber(): string
     {
         return $this->getDocument()->find('css', '#credit-memo-number')->getText();

tests/Behat/Page/Admin/CreditMemoDetailsPageInterface.php

@@ -14,6 +14,8 @@ public function download(): void;
 
     public function getUnitTax(int $number, string $productName): string;
 
+    public function getUnitTotal(int $number, string $unitName): string;
+
     public function getNumber(): string;
 
     public function getChannelName(): string;