feature #348 Added payment instructions to PaymentMethodView ()

This PR was merged into the 1.0-dev branch. Discussion ---------- To be able to show payment instructions by using Shop-API, I added the needed fields to the view and factory. Commits ------- 183f2c1 Added payment instructions to PaymentMethodView aad4772 Fixed tests f63d2ad Fixed unit-tests 6053084 Updated reponses for unit tests
Sylius · Jan 4, 2019 · 84dc0a8 · 84dc0a8
2 parents bc73791 + 6053084
commit 84dc0a8
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 8 deletions.
diff --git a/spec/Factory/PaymentMethodViewFactorySpec.php b/spec/Factory/PaymentMethodViewFactorySpec.php
@@ -29,12 +29,14 @@ function it_build_payment_method_view(PaymentMethodInterface $paymentMethod, Pay
 
         $paymentMethodTranslation->getName()->willReturn('Cash on delivery');
         $paymentMethodTranslation->getDescription()->willReturn('Really nice payment method');
+        $paymentMethodTranslation->getInstructions()->willReturn('Put the money in this bag, right here!');
 
         $paymentMethodView = new PaymentMethodView();
 
         $paymentMethodView->code = 'COD_CODE';
         $paymentMethodView->name = 'Cash on delivery';
         $paymentMethodView->description = 'Really nice payment method';
+        $paymentMethodView->instructions = 'Put the money in this bag, right here!';
 
         $this->create($paymentMethod, 'en_GB')->shouldBeLike($paymentMethodView);
     }

diff --git a/src/Factory/PaymentMethodViewFactory.php b/src/Factory/PaymentMethodViewFactory.php
@@ -23,9 +23,12 @@ public function create(PaymentMethodInterface $paymentMethod, string $locale): P
         /** @var PaymentMethodView $paymentMethodView */
         $paymentMethodView = new $this->paymentMethodViewClass();
 
-        $paymentMethodView->code = $paymentMethod->getCode();
-        $paymentMethodView->name = $paymentMethod->getTranslation($locale)->getName();
-        $paymentMethodView->description = $paymentMethod->getTranslation($locale)->getDescription();
+        $translation = $paymentMethod->getTranslation($locale);
+
+        $paymentMethodView->code = $paymentMethod->getCode() ?? '';
+        $paymentMethodView->name = $translation->getName() ?? '';
+        $paymentMethodView->description = $translation->getDescription() ?? '';
+        $paymentMethodView->instructions = $translation->getInstructions() ?? '';
 
         return $paymentMethodView;
     }

diff --git a/src/View/PaymentMethodView.php b/src/View/PaymentMethodView.php
@@ -14,4 +14,7 @@ class PaymentMethodView
 
     /** @var string */
     public $description;
+
+    /** @var string */
+    public $instructions;
 }
diff --git a/tests/DataFixtures/ORM/payment.yml b/tests/DataFixtures/ORM/payment.yml
@@ -23,9 +23,11 @@ Sylius\Component\Payment\Model\PaymentMethodTranslation:
         name: 'Cash on delivery'
         locale: 'en_GB'
         description: <paragraph(2)>
+        instructions: "Please put the money in the bag!"
         translatable: "@cash_on_delivery"
     pay_by_check_translation:
         name: 'Pay by check'
         locale: 'en_GB'
         description: <paragraph(2)>
+        instructions: "Please put the money in the bag!"
         translatable: "@pay_by_check"
diff --git a/tests/Responses/Expected/checkout/cart_with_chosen_payment_response.json b/tests/Responses/Expected/checkout/cart_with_chosen_payment_response.json
@@ -89,7 +89,8 @@
             "method": {
                 "code": "PBC",
                 "name": "Pay by check",
-                "description": "@string@"
+                "description": "@string@",
+                "instructions": "@string@"
             },
             "price": {
                 "current": 11495,

diff --git a/tests/Responses/Expected/checkout/get_available_payment_methods.json b/tests/Responses/Expected/checkout/get_available_payment_methods.json
@@ -5,12 +5,14 @@
                 "COD": {
                     "code": "COD",
                     "name": "Cash on delivery",
-                    "description": "@string@"
+                    "description": "@string@",
+                    "instructions": "@string@"
                 },
                 "PBC": {
                     "code": "PBC",
                     "name": "Pay by check",
-                    "description": "@string@"
+                    "description": "@string@",
+                    "instructions": "@string@"
                 }
             }
         }

diff --git a/tests/Responses/Expected/order/order_details_response.json b/tests/Responses/Expected/order/order_details_response.json
@@ -86,7 +86,8 @@
             "method": {
                 "code": "PBC",
                 "name": "Pay by check",
-                "description": @string@
+                "description": @string@,
+                "instructions": @string@
             },
             "price": {
                 "current": 5498,

diff --git a/tests/Responses/Expected/order/orders_list_response.json b/tests/Responses/Expected/order/orders_list_response.json
@@ -87,7 +87,8 @@
                 "method": {
                     "code": "PBC",
                     "name": "Pay by check",
-                    "description": @string@
+                    "description": @string@,
+                    "instructions": @string@
                 },
                 "price": {
                     "current": 5498,