Improve extendibility of OrderRefundsListAction

Author: coldic3

UPGRADE-1.4.md

@@ -175,7 +175,7 @@ deprecated code:
         }
     ```
 
-15. The interface method `Sylius\RefundPlugin\Validator\RefundAmountValidatorInterface` has been changed:
+15. The interface method `Sylius\RefundPlugin\Validator\RefundAmountValidatorInterface::validateUnits` has been changed:
 
     ```diff
     - public function validateUnits(array $unitRefunds, RefundTypeInterface $refundType): void;
@@ -202,3 +202,11 @@ deprecated code:
 
     and it replaces the `refund_type` attribute for the `sylius_refund.refund_unit_total_provider` tag.
     Therefore, the `refund_type` attribute becomes deprecated as well.
+
+18. The interface method `Sylius\RefundPlugin\Provider\RefundPaymentMethodsProviderInterface::findForChannel` has been
+    replaced with `Sylius\RefundPlugin\Provider\RefundPaymentMethodsProviderInterface::findForOrder`:
+
+    ```diff
+    - public function findForChannel(ChannelInterface $channel): array;
+    + public function findForOrder(OrderInterface $order): array;
+    ```

spec/Provider/SupportedRefundPaymentMethodsProviderSpec.php

@@ -16,6 +16,7 @@
 use Payum\Core\Model\GatewayConfigInterface;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\ChannelInterface;
+use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Model\PaymentMethodInterface;
 use Sylius\Component\Core\Repository\PaymentMethodRepositoryInterface;
 use Sylius\RefundPlugin\Provider\RefundPaymentMethodsProviderInterface;
@@ -33,6 +34,38 @@ function it_implements_refund_payment_methods_provider_interface(): void
     }
 
     function it_provides_only_supported_payment_methods(
+        PaymentMethodRepositoryInterface $paymentMethodRepository,
+        OrderInterface $order,
+        ChannelInterface $channel,
+        PaymentMethodInterface $offlinePaymentMethod,
+        PaymentMethodInterface $payPalPaymentMethod,
+        PaymentMethodInterface $stripePaymentMethod,
+        GatewayConfigInterface $offlineGatewayConfig,
+        GatewayConfigInterface $payPalGatewayConfig,
+        GatewayConfigInterface $stripeGatewayConfig,
+    ): void {
+        $order->getChannel()->willReturn($channel);
+
+        $paymentMethodRepository->findEnabledForChannel($channel)->willReturn([
+            $offlinePaymentMethod,
+            $payPalPaymentMethod,
+            $stripePaymentMethod,
+        ]);
+
+        $offlinePaymentMethod->getGatewayConfig()->willReturn($offlineGatewayConfig);
+        $offlineGatewayConfig->getFactoryName()->willReturn('offline');
+
+        $payPalPaymentMethod->getGatewayConfig()->willReturn($payPalGatewayConfig);
+        $payPalGatewayConfig->getFactoryName()->willReturn('paypal');
+
+        $stripePaymentMethod->getGatewayConfig()->willReturn($stripeGatewayConfig);
+        $stripeGatewayConfig->getFactoryName()->willReturn('stripe');
+
+        $this->findForOrder($order)->shouldReturn([$offlinePaymentMethod, $stripePaymentMethod]);
+    }
+
+    /** @legacy will be removed in RefundPlugin 2.0 */
+    function it_provides_only_supported_payment_methods_legacy(
         PaymentMethodRepositoryInterface $paymentMethodRepository,
         ChannelInterface $channel,
         PaymentMethodInterface $offlinePaymentMethod,

src/Action/Admin/OrderRefundsListAction.php

@@ -13,7 +13,6 @@
 
 namespace Sylius\RefundPlugin\Action\Admin;
 
-use Sylius\Component\Core\Model\ChannelInterface;
 use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Repository\OrderRepositoryInterface;
 use Sylius\RefundPlugin\Checker\OrderRefundingAvailabilityCheckerInterface;
@@ -26,7 +25,6 @@
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Twig\Environment;
-use Webmozart\Assert\Assert;
 
 final class OrderRefundsListAction
 {
@@ -56,14 +54,10 @@ public function __invoke(Request $request): Response
             return $this->redirectToReferer($order, 'sylius_refund.order_should_be_paid');
         }
 
-        /** @var ChannelInterface|null $channel */
-        $channel = $order->getChannel();
-        Assert::notNull($channel);
-
         return new Response(
             $this->twig->render('@SyliusRefundPlugin/orderRefunds.html.twig', [
                 'order' => $order,
-                'payment_methods' => $this->refundPaymentMethodsProvider->findForChannel($channel),
+                'payment_methods' => $this->refundPaymentMethodsProvider->findForOrder($order),
             ]),
         );
     }

src/Provider/RefundPaymentMethodsProviderInterface.php

@@ -14,10 +14,18 @@
 namespace Sylius\RefundPlugin\Provider;
 
 use Sylius\Component\Core\Model\ChannelInterface;
+use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Model\PaymentMethodInterface;
 
+/**
+ * @method PaymentMethodInterface[] findForOrder(OrderInterface $order)
+ */
 interface RefundPaymentMethodsProviderInterface
 {
-    /** @return array|PaymentMethodInterface[] */
+    /**
+     * @deprecated since 1.4, to be removed in 2.0, use findForOrder() instead
+     *
+     * @return PaymentMethodInterface[]
+     */
     public function findForChannel(ChannelInterface $channel): array;
 }

src/Provider/SupportedRefundPaymentMethodsProvider.php

@@ -14,6 +14,7 @@
 namespace Sylius\RefundPlugin\Provider;
 
 use Sylius\Component\Core\Model\ChannelInterface;
+use Sylius\Component\Core\Model\OrderInterface;
 use Sylius\Component\Core\Model\PaymentMethodInterface;
 use Sylius\Component\Core\Repository\PaymentMethodRepositoryInterface;
 use Webmozart\Assert\Assert;
@@ -31,6 +32,22 @@ public function __construct(PaymentMethodRepositoryInterface $paymentMethodRepos
     }
 
     public function findForChannel(ChannelInterface $channel): array
+    {
+        trigger_deprecation('sylius/refund-plugin', '1.4', 'The "%s::findForChannel" method is deprecated and will be removed in 2.0. Use "%s::findForOrder" instead.', self::class, self::class);
+
+        return $this->find($channel);
+    }
+
+    public function findForOrder(OrderInterface $order): array
+    {
+        /** @var ChannelInterface|null $channel */
+        $channel = $order->getChannel();
+        Assert::notNull($channel);
+
+        return $this->find($channel);
+    }
+
+    private function find(ChannelInterface $channel): array
     {
         return array_values(array_filter(
             $this->paymentMethodRepository->findEnabledForChannel($channel),