Fix ecs

mpysiak · Apr 5, 2024 · c378760 · c378760
1 parent 68f8f73
commit c378760
Show file tree

Hide file tree

Showing 57 changed files with 412 additions and 429 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -49,11 +49,11 @@
      use Psr\Http\Message\StreamFactoryInterface;
 
         public function __construct(
-   -      private readonly GuzzleClientInterface $client,
-   +      private readonly GuzzleClientInterface|ClientInterface $client,
-            private readonly string $baseUrl,
-   +      private readonly ?RequestFactoryInterface $requestFactory = null,
-   +      private readonly ?StreamFactoryInterface $streamFactory = null,
+   -       private readonly GuzzleClientInterface $client,
+   +       private readonly GuzzleClientInterface|ClientInterface $client,
+             private readonly string $baseUrl,
+   +       private readonly ?RequestFactoryInterface $requestFactory = null,
+   +       private readonly ?StreamFactoryInterface $streamFactory = null,
     )
      ```
 

diff --git a/ecs.php b/ecs.php
@@ -3,17 +3,22 @@
 declare(strict_types=1);
 
 use PhpCsFixer\Fixer\ClassNotation\VisibilityRequiredFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocSeparationFixer;
 use SlevomatCodingStandard\Sniffs\Commenting\InlineDocCommentDeclarationSniff;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 
 return static function (ECSConfig $config): void {
     $config->paths([
-        __DIR__ . '/src',
-        __DIR__ . '/tests/Behat',
-        __DIR__ . '/ecs.php',
+        'src',
+        'spec',
+        'tests/Behat',
+        'tests/Functional',
+        'tests/Service',
+        'tests/Unit',
     ]);
 
     $config->import('vendor/sylius-labs/coding-standard/ecs.php');
+    $config->ruleWithConfiguration(PhpdocSeparationFixer::class, ['groups' => [['ORM\\*'], ['Given', 'When', 'Then']]]);
 
     $config->skip([
         VisibilityRequiredFixer::class => ['*Spec.php'],

diff --git a/spec/Api/CacheAuthorizeClientApiSpec.php b/spec/Api/CacheAuthorizeClientApiSpec.php
@@ -30,13 +30,13 @@ function let(
         ObjectManager $payPalCredentialsManager,
         ObjectRepository $payPalCredentialsRepository,
         AuthorizeClientApiInterface $authorizeClientApi,
-        UuidProviderInterface $uuidProvider
+        UuidProviderInterface $uuidProvider,
     ): void {
         $this->beConstructedWith(
             $payPalCredentialsManager,
             $payPalCredentialsRepository,
             $authorizeClientApi,
-            $uuidProvider
+            $uuidProvider,
         );
     }
 
@@ -48,7 +48,7 @@ function it_implements_cache_authorize_client_api_interface(): void
     function it_returns_cached_access_token_if_it_is_not_expired(
         ObjectRepository $payPalCredentialsRepository,
         PayPalCredentialsInterface $payPalCredentials,
-        PaymentMethodInterface $paymentMethod
+        PaymentMethodInterface $paymentMethod,
     ): void {
         $payPalCredentialsRepository->findOneBy(['paymentMethod' => $paymentMethod])->willReturn($payPalCredentials);
 
@@ -64,7 +64,7 @@ function it_gets_access_token_from_api_caches_and_returns_it(
         AuthorizeClientApiInterface $authorizeClientApi,
         PaymentMethodInterface $paymentMethod,
         GatewayConfigInterface $gatewayConfig,
-        UuidProviderInterface $uuidProvider
+        UuidProviderInterface $uuidProvider,
     ): void {
         $payPalCredentialsRepository->findOneBy(['paymentMethod' => $paymentMethod])->willReturn(null);
 
@@ -98,7 +98,7 @@ function it_returns_expired_token_and_ask_for_a_new_one(
         PaymentMethodInterface $paymentMethod,
         GatewayConfigInterface $gatewayConfig,
         PayPalCredentialsInterface $payPalCredentials,
-        UuidProviderInterface $uuidProvider
+        UuidProviderInterface $uuidProvider,
     ): void {
         $payPalCredentialsRepository->findOneBy(['paymentMethod' => $paymentMethod])->willReturn($payPalCredentials);
         $payPalCredentials->isExpired()->willReturn(true);

diff --git a/spec/Api/CompleteOrderApiSpec.php b/spec/Api/CompleteOrderApiSpec.php
@@ -34,7 +34,7 @@ function it_implements_complete_order_api_interface(): void
     function it_completes_pay_pal_order_with_given_id(
         PayPalClientInterface $client,
         PaymentInterface $payment,
-        OrderInterface $order
+        OrderInterface $order,
     ): void {
         $payment->getOrder()->willReturn($order);
         $payment->getAmount()->willReturn(10000);

diff --git a/spec/Api/CreateOrderApiSpec.php b/spec/Api/CreateOrderApiSpec.php
@@ -30,7 +30,7 @@ final class CreateOrderApiSpec extends ObjectBehavior
     function let(
         PayPalClientInterface $client,
         PaymentReferenceNumberProviderInterface $paymentReferenceNumberProvider,
-        PayPalItemDataProviderInterface $payPalItemDataProvider
+        PayPalItemDataProviderInterface $payPalItemDataProvider,
     ): void {
         $this->beConstructedWith($client, $paymentReferenceNumberProvider, $payPalItemDataProvider);
     }
@@ -47,7 +47,7 @@ function it_creates_pay_pal_order_based_on_given_payment(
         OrderInterface $order,
         PaymentMethodInterface $paymentMethod,
         GatewayConfigInterface $gatewayConfig,
-        PayPalItemDataProviderInterface $payPalItemDataProvider
+        PayPalItemDataProviderInterface $payPalItemDataProvider,
     ): void {
         $payment->getOrder()->willReturn($order);
         $payment->getAmount()->willReturn(10000);
@@ -83,7 +83,7 @@ function it_creates_pay_pal_order_based_on_given_payment(
         $paymentReferenceNumberProvider->provide($payment)->willReturn('REFERENCE-NUMBER');
 
         $gatewayConfig->getConfig()->willReturn(
-            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id']
+            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id'],
         );
 
         $client->post(
@@ -102,7 +102,7 @@ function it_creates_pay_pal_order_based_on_given_payment(
                     $data['purchase_units'][0]['items'][0]['unit_amount']['value'] === '90.00' &&
                     $data['purchase_units'][0]['items'][0]['unit_amount']['currency_code'] === 'PLN'
                 ;
-            })
+            }),
         )->willReturn(['status' => 'CREATED', 'id' => 123]);
 
         $this->create('TOKEN', $payment, 'REFERENCE_ID')->shouldReturn(['status' => 'CREATED', 'id' => 123]);
@@ -116,7 +116,7 @@ function it_creates_pay_pal_order_with_shipping_address_based_on_given_payment(
         PaymentMethodInterface $paymentMethod,
         GatewayConfigInterface $gatewayConfig,
         AddressInterface $shippingAddress,
-        PayPalItemDataProviderInterface $payPalItemDataProvider
+        PayPalItemDataProviderInterface $payPalItemDataProvider,
     ): void {
         $payment->getOrder()->willReturn($order);
         $payment->getAmount()->willReturn(10000);
@@ -158,7 +158,7 @@ function it_creates_pay_pal_order_with_shipping_address_based_on_given_payment(
         $paymentReferenceNumberProvider->provide($payment)->willReturn('REFERENCE-NUMBER');
 
         $gatewayConfig->getConfig()->willReturn(
-            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id']
+            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id'],
         );
 
         $client->post(
@@ -180,7 +180,7 @@ function it_creates_pay_pal_order_with_shipping_address_based_on_given_payment(
                     $data['purchase_units'][0]['items'][0]['unit_amount']['value'] === '90.00' &&
                     $data['purchase_units'][0]['items'][0]['unit_amount']['currency_code'] === 'PLN'
                 ;
-            })
+            }),
         )->willReturn(['status' => 'CREATED', 'id' => 123]);
 
         $this->create('TOKEN', $payment, 'REFERENCE_ID')->shouldReturn(['status' => 'CREATED', 'id' => 123]);
@@ -194,7 +194,7 @@ function it_creates_pay_pal_order_with_more_than_one_product(
         GatewayConfigInterface $gatewayConfig,
         AddressInterface $shippingAddress,
         PaymentReferenceNumberProviderInterface $paymentReferenceNumberProvider,
-        PayPalItemDataProviderInterface $payPalItemDataProvider
+        PayPalItemDataProviderInterface $payPalItemDataProvider,
     ): void {
         $payment->getOrder()->willReturn($order);
         $payment->getAmount()->willReturn(20000);
@@ -246,7 +246,7 @@ function it_creates_pay_pal_order_with_more_than_one_product(
         $paymentMethod->getGatewayConfig()->willReturn($gatewayConfig);
 
         $gatewayConfig->getConfig()->willReturn(
-            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id']
+            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id'],
         );
 
         $paymentReferenceNumberProvider->provide($payment)->willReturn('REFERENCE-NUMBER');
@@ -273,7 +273,7 @@ function it_creates_pay_pal_order_with_more_than_one_product(
                     $data['purchase_units'][0]['items'][1]['unit_amount']['value'] === '40.00' &&
                     $data['purchase_units'][0]['items'][1]['unit_amount']['currency_code'] === 'PLN'
                 ;
-            })
+            }),
         )->willReturn(['status' => 'CREATED', 'id' => 123]);
 
         $this->create('TOKEN', $payment, 'REFERENCE_ID')->shouldReturn(['status' => 'CREATED', 'id' => 123]);
@@ -287,7 +287,7 @@ function it_creates_pay_pal_order_with_non_neutral_tax_and_changed_quantity(
         GatewayConfigInterface $gatewayConfig,
         AddressInterface $shippingAddress,
         PaymentReferenceNumberProviderInterface $paymentReferenceNumberProvider,
-        PayPalItemDataProviderInterface $payPalItemDataProvider
+        PayPalItemDataProviderInterface $payPalItemDataProvider,
     ): void {
         $payment->getOrder()->willReturn($order);
         $payment->getAmount()->willReturn(13000);
@@ -339,7 +339,7 @@ function it_creates_pay_pal_order_with_non_neutral_tax_and_changed_quantity(
         $paymentMethod->getGatewayConfig()->willReturn($gatewayConfig);
 
         $gatewayConfig->getConfig()->willReturn(
-            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id']
+            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id'],
         );
 
         $paymentReferenceNumberProvider->provide($payment)->willReturn('REFERENCE-NUMBER');
@@ -370,7 +370,7 @@ function it_creates_pay_pal_order_with_non_neutral_tax_and_changed_quantity(
                     $data['purchase_units'][0]['items'][1]['tax']['value'] === '10.00' &&
                     $data['purchase_units'][0]['items'][1]['tax']['currency_code'] === 'PLN'
                 ;
-            })
+            }),
         )->willReturn(['status' => 'CREATED', 'id' => 123]);
 
         $this->create('TOKEN', $payment, 'REFERENCE_ID')->shouldReturn(['status' => 'CREATED', 'id' => 123]);
@@ -384,7 +384,7 @@ function it_creates_pay_pal_order_with_more_than_one_product_with_different_tax_
         GatewayConfigInterface $gatewayConfig,
         AddressInterface $shippingAddress,
         PaymentReferenceNumberProviderInterface $paymentReferenceNumberProvider,
-        PayPalItemDataProviderInterface $payPalItemDataProvider
+        PayPalItemDataProviderInterface $payPalItemDataProvider,
     ): void {
         $payment->getOrder()->willReturn($order);
         $payment->getAmount()->willReturn(20400);
@@ -448,7 +448,7 @@ function it_creates_pay_pal_order_with_more_than_one_product_with_different_tax_
         $paymentMethod->getGatewayConfig()->willReturn($gatewayConfig);
 
         $gatewayConfig->getConfig()->willReturn(
-            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id']
+            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id'],
         );
 
         $paymentReferenceNumberProvider->provide($payment)->willReturn('REFERENCE-NUMBER');
@@ -485,7 +485,7 @@ function it_creates_pay_pal_order_with_more_than_one_product_with_different_tax_
                     $data['purchase_units'][0]['items'][2]['tax']['value'] === '1.00' &&
                     $data['purchase_units'][0]['items'][2]['tax']['currency_code'] === 'PLN'
                 ;
-            })
+            }),
         )->willReturn(['status' => 'CREATED', 'id' => 123]);
 
         $this->create('TOKEN', $payment, 'REFERENCE_ID')->shouldReturn(['status' => 'CREATED', 'id' => 123]);
@@ -499,7 +499,7 @@ function it_allows_to_create_digital_order(
         GatewayConfigInterface $gatewayConfig,
         AddressInterface $shippingAddress,
         PaymentReferenceNumberProviderInterface $paymentReferenceNumberProvider,
-        PayPalItemDataProviderInterface $payPalItemDataProvider
+        PayPalItemDataProviderInterface $payPalItemDataProvider,
     ): void {
         $payment->getOrder()->willReturn($order);
         $payment->getAmount()->willReturn(20000);
@@ -533,7 +533,7 @@ function it_allows_to_create_digital_order(
         $paymentMethod->getGatewayConfig()->willReturn($gatewayConfig);
 
         $gatewayConfig->getConfig()->willReturn(
-            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id']
+            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id'],
         );
 
         $order->setShippingAddress(Argument::any())->shouldNotBeCalled();
@@ -550,7 +550,7 @@ function it_allows_to_create_digital_order(
                     $data['purchase_units'][0]['amount']['currency_code'] === 'PLN' &&
                     $data['application_context']['shipping_preference'] === 'NO_SHIPPING'
                 ;
-            })
+            }),
         )->willReturn(['status' => 'CREATED', 'id' => 123]);
 
         $this->create('TOKEN', $payment, 'REFERENCE_ID')->shouldReturn(['status' => 'CREATED', 'id' => 123]);
@@ -563,7 +563,7 @@ function it_creates_pay_pal_order_with_promotion(
         OrderInterface $order,
         PaymentMethodInterface $paymentMethod,
         GatewayConfigInterface $gatewayConfig,
-        PayPalItemDataProviderInterface $payPalItemDataProvider
+        PayPalItemDataProviderInterface $payPalItemDataProvider,
     ): void {
         $payment->getOrder()->willReturn($order);
         $payment->getAmount()->willReturn(2999);
@@ -599,7 +599,7 @@ function it_creates_pay_pal_order_with_promotion(
         $paymentReferenceNumberProvider->provide($payment)->willReturn('REFERENCE-NUMBER');
 
         $gatewayConfig->getConfig()->willReturn(
-            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id']
+            ['merchant_id' => 'merchant-id', 'sylius_merchant_id' => 'sylius-merchant-id'],
         );
 
         $client->post(
@@ -621,8 +621,8 @@ function it_creates_pay_pal_order_with_promotion(
                     $data['purchase_units'][0]['items'][0]['quantity'] === 1 &&
                     $data['purchase_units'][0]['items'][0]['unit_amount']['value'] === '25.00' &&
                     $data['purchase_units'][0]['items'][0]['unit_amount']['currency_code'] === 'PLN'
-                    ;
-            })
+                ;
+            }),
         )->willReturn(['status' => 'CREATED', 'id' => 123]);
 
         $this->create('TOKEN', $payment, 'REFERENCE_ID')->shouldReturn(['status' => 'CREATED', 'id' => 123]);

diff --git a/spec/Api/GenericApiSpec.php b/spec/Api/GenericApiSpec.php
@@ -13,9 +13,9 @@
 
 namespace spec\Sylius\PayPalPlugin\Api;
 
+use GuzzleHttp\ClientInterface as GuzzleClientInterface;
 use PhpSpec\ObjectBehavior;
 use Psr\Http\Client\ClientInterface;
-use GuzzleHttp\ClientInterface as GuzzleClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -39,9 +39,8 @@ function it_calls_api_by_url(
         RequestFactoryInterface $requestFactory,
         RequestInterface $request,
         ResponseInterface $response,
-        StreamInterface $body
+        StreamInterface $body,
     ): void {
-
         $requestFactory->createRequest('GET', 'http://url.com/')->willReturn($request);
 
         $request->withHeader('Authorization', 'Bearer TOKEN')->willReturn($request);
@@ -58,7 +57,7 @@ function it_calls_api_by_url(
     function it_calls_api_by_url_using_guzzle_client(
         GuzzleClientInterface $client,
         ResponseInterface $response,
-        StreamInterface $body
+        StreamInterface $body,
     ): void {
         $this->beConstructedWith($client);
 

diff --git a/spec/Api/RefundPaymentApiSpec.php b/spec/Api/RefundPaymentApiSpec.php
@@ -36,7 +36,7 @@ function it_refunds_pay_pal_payment_with_given_id(PayPalClientInterface $client)
                 'v2/payments/captures/123123/refund',
                 'TOKEN',
                 ['amount' => ['value' => '10.99', 'currency_code' => 'USD'], 'invoice_number' => '123-11-11-2010'],
-                ['PayPal-Auth-Assertion' => 'PAY-PAL-AUTH-ASSERTION']
+                ['PayPal-Auth-Assertion' => 'PAY-PAL-AUTH-ASSERTION'],
             )
             ->willReturn(['status' => 'COMPLETED', 'id' => '123123'])
         ;

diff --git a/spec/Api/UpdateOrderApiSpec.php b/spec/Api/UpdateOrderApiSpec.php
@@ -28,7 +28,7 @@ final class UpdateOrderApiSpec extends ObjectBehavior
     function let(
         PayPalClientInterface $client,
         PaymentReferenceNumberProviderInterface $paymentReferenceNumberProvider,
-        PayPalItemDataProviderInterface $payPalItemsDataProvider
+        PayPalItemDataProviderInterface $payPalItemsDataProvider,
     ): void {
         $this->beConstructedWith($client, $paymentReferenceNumberProvider, $payPalItemsDataProvider);
     }
@@ -44,7 +44,7 @@ function it_updates_pay_pal_order_with_given_new_total(
         PayPalItemDataProviderInterface $payPalItemsDataProvider,
         PaymentInterface $payment,
         OrderInterface $order,
-        AddressInterface $shippingAddress
+        AddressInterface $shippingAddress,
     ): void {
         $payment->getOrder()->willReturn($order);
         $order->getShippingAddress()->willReturn($shippingAddress);
@@ -92,7 +92,7 @@ function it_updates_pay_pal_order_with_given_new_total(
                     $data[0]['value']['shipping']['address']['country_code'] === 'US' &&
                     $data[0]['value']['items'] === ['data']
                 ;
-            })
+            }),
         )->shouldBeCalled();
 
         $this->update('TOKEN', 'ORDER-ID', $payment, 'REFERENCE-ID', 'MERCHANT-ID');
@@ -104,7 +104,7 @@ function it_updates_digital_order(
         PayPalItemDataProviderInterface $payPalItemsDataProvider,
         PaymentInterface $payment,
         OrderInterface $order,
-        AddressInterface $shippingAddress
+        AddressInterface $shippingAddress,
     ): void {
         $payment->getOrder()->willReturn($order);
         $order->getShippingAddress()->willReturn($shippingAddress);
@@ -141,7 +141,7 @@ function it_updates_digital_order(
                     $data[0]['value']['payee']['merchant_id'] === 'MERCHANT-ID' &&
                     $data[0]['value']['items'] === ['data']
                 ;
-            })
+            }),
         )->shouldBeCalled();
 
         $this->update('TOKEN', 'ORDER-ID', $payment, 'REFERENCE-ID', 'MERCHANT-ID');