[Maintenance] Change factory name

Wojdylak · Wojdylak · commit 5168c5b4c687 · 2024-12-06T12:47:18.000+01:00
diff --git a/UPGRADE-2.0.md b/UPGRADE-2.0.md
@@ -6,6 +6,8 @@
 
 1. The minimum supported version of PHP has been increased to 8.2.
 
+1. The factory name has been changed from `sylius.pay_pal` to `sylius_paypal`.
+
 1. The route `sylius_paypal_plugin_create_paypal_order_from_product` has been removed and replaced with the `AddToCartFormComponent`.
 
 1. The directories structure has been updated to the current Symfony recommendations:
diff --git a/config/app/twig_hooks/admin/payment_method/update.yaml b/config/app/twig_hooks/admin/payment_method/update.yaml
@@ -5,7 +5,7 @@ sylius_twig_hooks:
                 template: '@SyliusPayPalPlugin/admin/payment_method/form/header/paypal_logo.html.twig'
                 priority: -100
 
-        'sylius_admin.payment_method.update.content.form.sections.gateway_configuration.sylius.pay_pal':
+        'sylius_admin.payment_method.update.content.form.sections.gateway_configuration.sylius_paypal':
             client_id:
                 template: '@SyliusPayPalPlugin/admin/payment_method/form/section/gateway_configuration/client_id.html.twig'
                 priority: -100
diff --git a/config/config.yaml b/config/config.yaml
@@ -6,7 +6,7 @@ sylius_admin:
     twig:
         payment_method:
             excluded_gateways:
-                - sylius.pay_pal
+                - !php/const Sylius\PayPalPlugin\DependencyInjection\SyliusPayPalExtension::PAYPAL_FACTORY_NAME
 
 sylius_core:
     checkout:
diff --git a/config/services.xml b/config/services.xml
@@ -20,18 +20,13 @@
         <import resource="services/**/*.xml" />
     </imports>
 
-    <parameters>
-        <parameter key="sylius_paypal.prioritized_factory_name">sylius.pay_pal</parameter>
-    </parameters>
-
     <services>
         <service id="sylius_paypal.form.extension.payment_method" class="Sylius\PayPalPlugin\Form\Extension\PaymentMethodTypeExtension">
             <tag name="form.type_extension" />
         </service>
-        <service id="sylius_paypal.form.extension.payment_method" alias="Sylius\PayPalPlugin\Form\Extension\PaymentMethodTypeExtension" />
 
         <service id="sylius_paypal.form.type.paypal_configuration" class="Sylius\PayPalPlugin\Form\Type\PayPalConfigurationType">
-            <tag name="sylius.gateway_configuration_type" type="sylius.pay_pal" label="sylius.pay_pal.label" />
+            <tag name="sylius.gateway_configuration_type" type="sylius_paypal" label="sylius.pay_pal.label" />
         </service>
 
         <service
diff --git a/config/services/payum.xml b/config/services/payum.xml
@@ -22,18 +22,18 @@
             class="Payum\Core\Bridge\Symfony\Builder\GatewayFactoryBuilder"
         >
             <argument>Sylius\PayPalPlugin\Payum\Factory\PayPalGatewayFactory</argument>
-            <tag name="payum.gateway_factory_builder" factory="sylius.pay_pal" />
+            <tag name="payum.gateway_factory_builder" factory="sylius_paypal" />
         </service>
 
         <service id="sylius_paypal.payum.action.authorize" class="Sylius\PayPalPlugin\Payum\Action\AuthorizeAction" public="true">
-            <tag name="payum.action" factory="sylius.pay_pal" alias="payum.action.authorize" />
+            <tag name="payum.action" factory="sylius_paypal" alias="payum.action.authorize" />
         </service>
 
         <service id="sylius_paypal.payum.action.capture" class="Sylius\PayPalPlugin\Payum\Action\CaptureAction" public="true">
             <argument type="service" id="sylius_paypal.api.cache_authorize_client" />
             <argument type="service" id="sylius_paypal.api.create_order" />
             <argument type="service" id="sylius_paypal.provider.uuid" />
-            <tag name="payum.action" factory="sylius.pay_pal" alias="payum.action.capture" />
+            <tag name="payum.action" factory="sylius_paypal" alias="payum.action.capture" />
         </service>
 
         <service id="sylius_paypal.payum.action.complete_order" class="Sylius\PayPalPlugin\Payum\Action\CompleteOrderAction" public="true">
@@ -44,11 +44,11 @@
             <argument type="service" id="sylius_paypal.processor.paypal_address" />
             <argument type="service" id="sylius_paypal.updater.payment" />
             <argument type="service" id="sylius.state_resolver.order_payment" />
-            <tag name="payum.action" factory="sylius.pay_pal" alias="payum.action.complete_order" />
+            <tag name="payum.action" factory="sylius_paypal" alias="payum.action.complete_order" />
         </service>
 
         <service id="sylius_paypal.payum.action.resolve_next_route" class="Sylius\PayPalPlugin\Payum\Action\ResolveNextRouteAction" public="true">
-            <tag name="payum.action" factory="sylius.pay_pal" alias="sylius.resolve_next_route" />
+            <tag name="payum.action" factory="sylius_paypal" alias="sylius.resolve_next_route" />
         </service>
     </services>
 </container>
diff --git a/src/DependencyInjection/SyliusPayPalExtension.php b/src/DependencyInjection/SyliusPayPalExtension.php
@@ -25,7 +25,7 @@
 
 final class SyliusPayPalExtension extends Extension implements PrependExtensionInterface
 {
-    public const PAYPAL_FACTORY_NAME = 'sylius.pay_pal';
+    public const PAYPAL_FACTORY_NAME = 'sylius_paypal';
 
     public function load(array $configs, ContainerBuilder $container): void
     {
@@ -37,6 +37,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $delegatingLoader = new DelegatingLoader($loaderResolver);
 
         $container->setParameter('sylius_paypal.logging.increased', (bool) $config['logging']['increased']);
+        $container->setParameter('sylius_paypal.prioritized_factory_name', self::PAYPAL_FACTORY_NAME);
 
         if ($config['sandbox']) {
             $container->setParameter('sylius_paypal.facilitator_url', 'https://paypal.sylius.com');
diff --git a/src/Migrations/Version20241206094355.php b/src/Migrations/Version20241206094355.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\PayPalPlugin\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Sylius\Bundle\CoreBundle\Doctrine\Migrations\AbstractMigration;
+
+final class Version20241206094355 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Update factory name for PayPal gateway';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql("UPDATE sylius_gateway_config SET factory_name = 'sylius_paypal' WHERE factory_name = 'sylius.pay_pal'");
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql("UPDATE sylius_gateway_config SET factory_name = 'sylius.pay_pal' WHERE factory_name = 'sylius_paypal'");
+    }
+}
diff --git a/src/Migrations/Version20241206094356.php b/src/Migrations/Version20241206094356.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\PayPalPlugin\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Sylius\Bundle\CoreBundle\Doctrine\Migrations\AbstractPostgreSQLMigration;
+
+final class Version20241206094356 extends AbstractPostgreSQLMigration
+{
+    public function getDescription(): string
+    {
+        return 'Update factory name for PayPal gateway';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql("UPDATE sylius_gateway_config SET factory_name = 'sylius_paypal' WHERE factory_name = 'sylius.pay_pal'");
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql("UPDATE sylius_gateway_config SET factory_name = 'sylius.pay_pal' WHERE factory_name = 'sylius_paypal'");
+    }
+}
diff --git a/templates/admin/order/show/content/sections/payments/item/refunded_paypal.html.twig b/templates/admin/order/show/content/sections/payments/item/refunded_paypal.html.twig
@@ -1,7 +1,7 @@
 {% set payment = hookable_metadata.context.payment %}
 
 {% if
-    payment.method.gatewayConfig.factoryName|default('') == 'sylius.pay_pal' and
+    payment.method.gatewayConfig.factoryName|default('') == constant('Sylius\\PayPalPlugin\\DependencyInjection\\SyliusPayPalExtension::PAYPAL_FACTORY_NAME') and
     payment.state == constant('Sylius\\Component\\Core\\Model\\PaymentInterface::STATE_REFUNDED')
 %}
     <td class="py-2">
diff --git a/templates/admin/payment_method/form/header/paypal_logo.html.twig b/templates/admin/payment_method/form/header/paypal_logo.html.twig
@@ -1,4 +1,4 @@
-{% if hookable_metadata.context.resource.gatewayConfig.factoryName == 'sylius.pay_pal' %}
+{% if hookable_metadata.context.resource.gatewayConfig.factoryName == constant('Sylius\\PayPalPlugin\\DependencyInjection\\SyliusPayPalExtension::PAYPAL_FACTORY_NAME') %}
     <div class="col-12 col-md-auto">
         <img src="https://www.paypalobjects.com/digitalassets/c/website/marketing/na/us/logo-center/9_bdg_secured_by_pp_2line.png" alt="Secured by PayPal">
     </div>
diff --git a/templates/admin/payment_method/grid/action/download_report.html.twig b/templates/admin/payment_method/grid/action/download_report.html.twig
@@ -1,4 +1,4 @@
-{% if data.gatewayConfig.factoryName|default('') == 'sylius.pay_pal'
+{% if data.gatewayConfig.factoryName|default('') == constant('Sylius\\PayPalPlugin\\DependencyInjection\\SyliusPayPalExtension::PAYPAL_FACTORY_NAME')
     and data.gatewayConfig.config.reports_sftp_username is not empty
     and data.gatewayConfig.config.reports_sftp_password is not empty
 %}
diff --git a/templates/admin/payment_method/grid/action/enable_seller.html.twig b/templates/admin/payment_method/grid/action/enable_seller.html.twig
@@ -1,6 +1,6 @@
 {% import '@SyliusAdmin/shared/helper/button.html.twig' as button %}
 
-{% if not data.enabled and data.gatewayConfig.factoryName|default('') == 'sylius.pay_pal' %}
+{% if not data.enabled and data.gatewayConfig.factoryName|default('') == constant('Sylius\\PayPalPlugin\\DependencyInjection\\SyliusPayPalExtension::PAYPAL_FACTORY_NAME') %}
     <div data-bs-toggle="tooltip" data-bs-title="{{ 'sylius.ui.enable'|trans }}">
         <form action="{{ path('sylius_paypal_plugin_admin_enable_seller', {'id': data.id}) }}" method="post">
             {{ button.default({type: 'submit', icon: 'tabler:check', icon_class: 'icon text-purple', icon_only: true,}) }}
diff --git a/templates/admin/payment_method/grid/confirmation_modal_create_paypal.html.twig b/templates/admin/payment_method/grid/confirmation_modal_create_paypal.html.twig
@@ -4,7 +4,7 @@
     {% endblock %}
     {% block footer %}
         {% import '@SyliusAdmin/shared/helper/button.html.twig' as button %}
-        {% set path = path('sylius_admin_payment_method_create', {'factory': 'sylius.pay_pal'}) %}
+        {% set path = path('sylius_admin_payment_method_create', {'factory': constant('Sylius\\PayPalPlugin\\DependencyInjection\\SyliusPayPalExtension::PAYPAL_FACTORY_NAME')}) %}
 
         {{ button.default({ text: 'sylius.ui.no_label'|trans, attr: 'data-bs-dismiss=modal' }) }}
         <a class="btn btn-outline-success" href="{{ path }}">
diff --git a/templates/shop/checkout/select_payment/content/form/select_payment/payment/choice/details/paypal.html.twig b/templates/shop/checkout/select_payment/content/form/select_payment/payment/choice/details/paypal.html.twig
@@ -1,4 +1,4 @@
-{% if hookable_metadata.context.method.gatewayConfig.factoryName == 'sylius.pay_pal' %}
+{% if hookable_metadata.context.method.gatewayConfig.factoryName == constant('Sylius\\PayPalPlugin\\DependencyInjection\\SyliusPayPalExtension::PAYPAL_FACTORY_NAME') %}
     <div data-live-ignore>
         {{ render(controller('sylius_paypal.controller.paypal_buttons::renderPaymentPageButtonsAction', {'orderId': hookable_metadata.context.order.id})) }}
     </div>

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`
`26`	`26`	`final class SyliusPayPalExtension extends Extension implements PrependExtensionInterface`
`27`	`27`	`{`
`28`		`- public const PAYPAL_FACTORY_NAME = 'sylius.pay_pal';`
	`28`	`+ public const PAYPAL_FACTORY_NAME = 'sylius_paypal';`
`29`	`29`
`30`	`30`	`public function load(array $configs, ContainerBuilder $container): void`
`31`	`31`	`{`
`@@ -37,6 +37,7 @@ public function load(array $configs, ContainerBuilder $container): void`
`37`	`37`	`$delegatingLoader = new DelegatingLoader($loaderResolver);`
`38`	`38`
`39`	`39`	`$container->setParameter('sylius_paypal.logging.increased', (bool) $config['logging']['increased']);`
	`40`	`+ $container->setParameter('sylius_paypal.prioritized_factory_name', self::PAYPAL_FACTORY_NAME);`
`40`	`41`
`41`	`42`	`if ($config['sandbox']) {`
`42`	`43`	`$container->setParameter('sylius_paypal.facilitator_url', 'https://paypal.sylius.com');`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{% if hookable_metadata.context.resource.gatewayConfig.factoryName == 'sylius.pay_pal' %}`
	`1`	`+{% if hookable_metadata.context.resource.gatewayConfig.factoryName == constant('Sylius\\PayPalPlugin\\DependencyInjection\\SyliusPayPalExtension::PAYPAL_FACTORY_NAME') %}`
`2`	`2`	`<div class="col-12 col-md-auto">`
`3`	`3`	`<img src="https://www.paypalobjects.com/digitalassets/c/website/marketing/na/us/logo-center/9_bdg_secured_by_pp_2line.png" alt="Secured by PayPal">`
`4`	`4`	`</div>`