Improve customization of RefundType

UPGRADE.md

@@ -133,6 +133,68 @@
         }
     ```
 
+1. The constructor of `Sylius\RefundPlugin\Twig\OrderRefundsExtension` has been changed:
+
+    ```diff
+        public function __construct(
+            OrderRefundedTotalProviderInterface $orderRefundedTotalProvider,
+            UnitRefundedTotalProviderInterface $unitRefundedTotalProvider,
+            UnitRefundingAvailabilityCheckerInterface $unitRefundingAvailabilityChecker,
+            OrderRepositoryInterface $orderRepository,
+            RepositoryInterface $refundPaymentRepository
+            RepositoryInterface $refundPaymentRepository,
+    +       RefundTypeFactoryInterface $refundTypeFactory
+        ) {
+            ...
+        }
+    ```
+
+1. Return type on `getType` method of `Sylius\RefundPlugin\Entity\Refund` and `Sylius\RefundPlugin\Entity\RefundInterface` has been changed from `RefundType` to `RefundTypeInterface`
+
+1. Return type on `convertToPHPValue` method of `Sylius\RefundPlugin\Entity\Type\RefundEnumType` has been changed from `RefundType` to `RefundTypeInterface`
+
+1. We replaced `RefundType` with `RefundTypeInterface` in the given list of classes:
+   * `Sylius\RefundPlugin\Creator\RefundCreator`
+   * `Sylius\RefundPlugin\Checker\UnitRefundingAvailabilityChecker`
+   * `Sylius\RefundPlugin\Entity\Type\RefundEnumType`
+   * `Sylius\RefundPlugin\Entity\Refund`
+   * `Sylius\RefundPlugin\Factory\RefundFactory`
+   * `Sylius\RefundPlugin\Provider\RemainingTotalProvider`
+   * `Sylius\RefundPlugin\Provider\UnitRefundedTotalProvider`
+   * `Sylius\RefundPlugin\Validator\RefundAmountValidator`
+
+1. `Sylius\RefundPlugin\Model\RefundType` implements `Sylius\RefundPlugin\Model\RefundTypeInterface` and consts `ORDER_ITEM_UNIT` and `SHIPMENT` has been moved to `RefundTypeInterface`
+
+1. Service `Sylius\RefundPlugin\Twig\OrderRefundsExtension` has been changed:
+
+    ```diff
+        <service id="Sylius\RefundPlugin\Twig\OrderRefundsExtension">
+            <argument type="service" id="Sylius\RefundPlugin\Provider\OrderRefundedTotalProviderInterface" />
+            <argument type="service" id="Sylius\RefundPlugin\Provider\UnitRefundedTotalProviderInterface" />
+            <argument type="service" id="Sylius\RefundPlugin\Checker\UnitRefundingAvailabilityCheckerInterface" />
+            <argument type="service" id="sylius.repository.order" />
+            <argument type="service" id="sylius_refund.repository.refund_payment" />
+    +       <argument type="service" id="Sylius\RefundPlugin\Factory\RefundTypeFactoryInterface" />
+            <tag name="twig.extension"/>
+        </service>
+    ```
+
+1. The constructor of `Sylius\RefundPlugin\Twig\OrderRefundsExtension` has been changed:
+
+    ```diff
+        public function __construct(
+            OrderRefundedTotalProviderInterface $orderRefundedTotalProvider,
+            UnitRefundedTotalProviderInterface $unitRefundedTotalProvider,
+            UnitRefundingAvailabilityCheckerInterface $unitRefundingAvailabilityChecker,
+            OrderRepositoryInterface $orderRepository,
+            RepositoryInterface $refundPaymentRepository
+            RepositoryInterface $refundPaymentRepository,
+    +       RefundTypeFactoryInterface $refundTypeFactory
+        ) {
+            ...
+        }
+    ```
+
 ### UPGRADE FROM 1.0.0-RC.9 TO 1.0.0-RC.10
 
 1. Support for Sylius 1.8 has been dropped, upgrade your application to [Sylius 1.9](https://github.com/Sylius/Sylius/blob/master/UPGRADE-1.9.md) 

src/Calculator/UnitRefundTotalCalculator.php

@@ -13,7 +13,7 @@
 
 namespace Sylius\RefundPlugin\Calculator;
 
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 use Sylius\RefundPlugin\Provider\RemainingTotalProviderInterface;
 
 final class UnitRefundTotalCalculator implements UnitRefundTotalCalculatorInterface
@@ -26,7 +26,7 @@ public function __construct(RemainingTotalProviderInterface $remainingTotalProvi
         $this->remainingTotalProvider = $remainingTotalProvider;
     }
 
-    public function calculateForUnitWithIdAndType(int $id, RefundType $refundType, ?float $amount = null): int
+    public function calculateForUnitWithIdAndType(int $id, RefundTypeInterface $refundType, ?float $amount = null): int
     {
         if ($amount !== null) {
             return (int) round($amount * 100);

src/Calculator/UnitRefundTotalCalculatorInterface.php

@@ -13,9 +13,9 @@
 
 namespace Sylius\RefundPlugin\Calculator;
 
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 
 interface UnitRefundTotalCalculatorInterface
 {
-    public function calculateForUnitWithIdAndType(int $id, RefundType $refundType, ?float $amount = null): int;
+    public function calculateForUnitWithIdAndType(int $id, RefundTypeInterface $refundType, ?float $amount = null): int;
 }

src/Checker/UnitRefundingAvailabilityChecker.php

@@ -13,21 +13,20 @@
 
 namespace Sylius\RefundPlugin\Checker;
 
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 use Sylius\RefundPlugin\Provider\RemainingTotalProviderInterface;
 
 final class UnitRefundingAvailabilityChecker implements UnitRefundingAvailabilityCheckerInterface
 {
     /** @var RemainingTotalProviderInterface */
     private $remainingTotalProvider;
 
-    public function __construct(
-        RemainingTotalProviderInterface $remainingTotalProvider
-    ) {
+    public function __construct(RemainingTotalProviderInterface $remainingTotalProvider)
+    {
         $this->remainingTotalProvider = $remainingTotalProvider;
     }
 
-    public function __invoke(int $unitId, RefundType $refundType): bool
+    public function __invoke(int $unitId, RefundTypeInterface $refundType): bool
     {
         return $this->remainingTotalProvider->getTotalLeftToRefund($unitId, $refundType) > 0;
     }

src/Checker/UnitRefundingAvailabilityCheckerInterface.php

@@ -13,9 +13,9 @@
 
 namespace Sylius\RefundPlugin\Checker;
 
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 
 interface UnitRefundingAvailabilityCheckerInterface
 {
-    public function __invoke(int $unitId, RefundType $refundType): bool;
+    public function __invoke(int $unitId, RefundTypeInterface $refundType): bool;
 }

src/Converter/RefundUnitsConverter.php

@@ -14,7 +14,7 @@
 namespace Sylius\RefundPlugin\Converter;
 
 use Sylius\RefundPlugin\Calculator\UnitRefundTotalCalculatorInterface;
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 use Webmozart\Assert\Assert;
 
 final class RefundUnitsConverter implements RefundUnitsConverterInterface
@@ -27,7 +27,7 @@ public function __construct(UnitRefundTotalCalculatorInterface $unitRefundTotalC
         $this->unitRefundTotalCalculator = $unitRefundTotalCalculator;
     }
 
-    public function convert(array $units, RefundType $refundType, string $unitRefundClass): array
+    public function convert(array $units, RefundTypeInterface $refundType, string $unitRefundClass): array
     {
         $units = $this->filterEmptyRefundUnits($units);
         $refundUnits = [];

src/Converter/RefundUnitsConverterInterface.php

@@ -13,13 +13,13 @@
 
 namespace Sylius\RefundPlugin\Converter;
 
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 use Sylius\RefundPlugin\Model\UnitRefundInterface;
 
 interface RefundUnitsConverterInterface
 {
     /**
      * @return UnitRefundInterface[]
      */
-    public function convert(array $units, RefundType $refundType, string $unitRefundClass): array;
+    public function convert(array $units, RefundTypeInterface $refundType, string $unitRefundClass): array;
 }

src/Creator/RefundCreator.php

@@ -18,7 +18,7 @@
 use Sylius\Component\Core\Repository\OrderRepositoryInterface;
 use Sylius\RefundPlugin\Exception\UnitAlreadyRefunded;
 use Sylius\RefundPlugin\Factory\RefundFactoryInterface;
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 use Sylius\RefundPlugin\Provider\RemainingTotalProviderInterface;
 use Webmozart\Assert\Assert;
 
@@ -48,7 +48,7 @@ public function __construct(
         $this->refundManager = $refundManager;
     }
 
-    public function __invoke(string $orderNumber, int $unitId, int $amount, RefundType $refundType): void
+    public function __invoke(string $orderNumber, int $unitId, int $amount, RefundTypeInterface $refundType): void
     {
         /** @var OrderInterface|null $order */
         $order = $this->orderRepository->findOneByNumber($orderNumber);

src/Creator/RefundCreatorInterface.php

@@ -13,9 +13,9 @@
 
 namespace Sylius\RefundPlugin\Creator;
 
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 
 interface RefundCreatorInterface
 {
-    public function __invoke(string $orderNumber, int $unitId, int $amount, RefundType $refundType): void;
+    public function __invoke(string $orderNumber, int $unitId, int $amount, RefundTypeInterface $refundType): void;
 }

src/Entity/Refund.php

@@ -14,7 +14,7 @@
 namespace Sylius\RefundPlugin\Entity;
 
 use Sylius\Component\Core\Model\OrderInterface;
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 
 class Refund implements RefundInterface
 {
@@ -30,10 +30,10 @@ class Refund implements RefundInterface
     /** @var int */
     protected $refundedUnitId;
 
-    /** @var RefundType */
+    /** @var RefundTypeInterface */
     protected $type;
 
-    public function __construct(OrderInterface $order, int $amount, int $refundedUnitId, RefundType $type)
+    public function __construct(OrderInterface $order, int $amount, int $refundedUnitId, RefundTypeInterface $type)
     {
         $this->order = $order;
         $this->amount = $amount;
@@ -66,7 +66,7 @@ public function getRefundedUnitId(): int
         return $this->refundedUnitId;
     }
 
-    public function getType(): RefundType
+    public function getType(): RefundTypeInterface
     {
         return $this->type;
     }

src/Entity/RefundInterface.php

@@ -15,7 +15,7 @@
 
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Resource\Model\ResourceInterface;
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 
 interface RefundInterface extends ResourceInterface
 {
@@ -28,5 +28,5 @@ public function getAmount(): int;
 
     public function getRefundedUnitId(): int;
 
-    public function getType(): RefundType;
+    public function getType(): RefundTypeInterface;
 }

src/Entity/Type/RefundEnumType.php

@@ -16,9 +16,11 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\ConversionException;
 use Doctrine\DBAL\Types\Type;
+use MyCLabs\Enum\Enum;
 use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 
-final class RefundEnumType extends Type
+class RefundEnumType extends Type
 {
     public function getName(): string
     {
@@ -30,31 +32,36 @@ public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $pla
         return 'VARCHAR(256)';
     }
 
-    public function convertToPHPValue($value, AbstractPlatform $platform): RefundType
+    public function convertToPHPValue($value, AbstractPlatform $platform): RefundTypeInterface
     {
-        if (!RefundType::isValid($value)) {
+        if ($value instanceof RefundTypeInterface && $value instanceof Enum && !$value::isValid($value)) {
             throw new \InvalidArgumentException(sprintf(
                 'The value "%s" is not valid for the enum "%s". Expected one of ["%s"]',
-                $value,
-                RefundType::class,
-                implode('", "', RefundType::keys())
-            ))
-            ;
+                (string) $value->getValue(),
+                RefundTypeInterface::class,
+                implode('", "', $value::keys())
+            ));
         }
 
-        return new RefundType($value);
+        return $this->createType($value);
     }
 
+    /** @param mixed $value */
     public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
     {
         if (null === $value) {
             return null;
         }
 
-        if ($value instanceof RefundType) {
-            return (string) $value;
+        if ($value instanceof RefundTypeInterface) {
+            return (string) $value->getValue();
         }
 
-        throw ConversionException::conversionFailed($value, 'sylius_refund_refund_type');
+        throw ConversionException::conversionFailed((string) $value, 'sylius_refund_refund_type');
+    }
+
+    protected function createType(string $value): RefundTypeInterface
+    {
+        return new RefundType($value);
     }
 }

src/Factory/RefundFactory.php

@@ -15,7 +15,7 @@
 
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\RefundPlugin\Entity\RefundInterface;
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 
 final class RefundFactory implements RefundFactoryInterface
 {
@@ -32,7 +32,7 @@ public function createNew(): RefundInterface
         throw new \InvalidArgumentException('Default creation method is forbidden for this object. Use `createWithData` instead.');
     }
 
-    public function createWithData(OrderInterface $order, int $unitId, int $amount, RefundType $type): RefundInterface
+    public function createWithData(OrderInterface $order, int $unitId, int $amount, RefundTypeInterface $type): RefundInterface
     {
         return new $this->className($order, $amount, $unitId, $type);
     }

src/Factory/RefundFactoryInterface.php

@@ -16,9 +16,14 @@
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Resource\Factory\FactoryInterface;
 use Sylius\RefundPlugin\Entity\RefundInterface;
-use Sylius\RefundPlugin\Model\RefundType;
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
 
 interface RefundFactoryInterface extends FactoryInterface
 {
-    public function createWithData(OrderInterface $order, int $unitId, int $amount, RefundType $type): RefundInterface;
+    public function createWithData(
+        OrderInterface $order,
+        int $unitId,
+        int $amount,
+        RefundTypeInterface $type
+    ): RefundInterface;
 }

src/Factory/RefundTypeFactory.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Paweł Jędrzejewski
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\RefundPlugin\Factory;
+
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
+
+final class RefundTypeFactory implements RefundTypeFactoryInterface
+{
+    /** @var string */
+    public $className;
+
+    public function __construct(string $className)
+    {
+        $this->className = $className;
+    }
+
+    public function createNew(string $refundType): RefundTypeInterface
+    {
+        return new $this->className($refundType);
+    }
+}

src/Factory/RefundTypeFactoryInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Paweł Jędrzejewski
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\RefundPlugin\Factory;
+
+use Sylius\RefundPlugin\Model\RefundTypeInterface;
+
+interface RefundTypeFactoryInterface
+{
+    public function createNew(string $refundType): RefundTypeInterface;
+}