feat(settings): allow showing description with shipping method (#285)

- Also fixed disabled shipping methods still being shown
myparcelnl · Jul 4, 2024 · 2a80eca · 2a80eca
1 parent 0979cb4
commit 2a80eca
Show file tree

Hide file tree

Showing 8 changed files with 81 additions and 24 deletions.
diff --git a/src/App/ShippingMethod/Model/PdkShippingMethod.php b/src/App/ShippingMethod/Model/PdkShippingMethod.php
@@ -11,6 +11,7 @@
 /**
  * @property string                $id
  * @property string                $name
+ * @property string                $description
  * @property bool                  $isEnabled
  * @property bool                  $hasDeliveryOptions
  * @property int                   $minimumDropOffDelay
@@ -22,6 +23,7 @@ class PdkShippingMethod extends Model
     protected $attributes = [
         'id'                  => null,
         'name'                => null,
+        'description'         => null,
         'allowedPackageTypes' => PackageTypeCollection::class,
         'hasDeliveryOptions'  => true,
         'isEnabled'           => true,
@@ -32,6 +34,7 @@ class PdkShippingMethod extends Model
     protected $casts      = [
         'id'                  => 'string',
         'name'                => 'string',
+        'description'         => 'string',
         'allowedPackageTypes' => PackageTypeCollection::class,
         'hasDeliveryOptions'  => 'bool',
         'isEnabled'           => 'bool',

diff --git a/src/Frontend/View/AbstractSettingsView.php b/src/Frontend/View/AbstractSettingsView.php
@@ -16,6 +16,7 @@
 use MyParcelNL\Pdk\Settings\Model\Settings;
 use MyParcelNL\Pdk\Shipment\Model\DeliveryOptions;
 use MyParcelNL\Sdk\src\Support\Str;
+use function array_map;
 
 /**
  * @deprecated use NewAbstractSettingsView instead
@@ -258,16 +259,22 @@ protected function isNotDisabled(string $name): bool
      */
     protected function toSelectOptions(array $array, int $displayOptions = 0): array
     {
-        $associativeArray = Arr::isAssoc($array) ? $array : array_combine($array, $array);
-
-        $options = array_map(static function ($value, $key) use ($displayOptions) {
-            $labelKey = $displayOptions & self::SELECT_USE_PLAIN_LABEL ? 'plainLabel' : 'label';
-
-            return [
-                'value'   => $key,
-                $labelKey => $value,
-            ];
-        }, $associativeArray, array_keys($associativeArray));
+        $isAssoc = Arr::isAssoc($array);
+
+        if ($isAssoc) {
+            $options = array_map(static function ($value, $key) use ($displayOptions) {
+                $labelKey = $displayOptions & self::SELECT_USE_PLAIN_LABEL ? 'plainLabel' : 'label';
+
+                return [
+                    'value'   => $key,
+                    $labelKey => $value,
+                ];
+            }, $array, array_keys($array));
+        } else {
+            $options = array_map(static function (array $selectOption) {
+                return array_filter($selectOption);
+            }, $array);
+        }
 
         return $this->addDefaultOption($options, $displayOptions);
     }

diff --git a/src/Frontend/View/CheckoutSettingsView.php b/src/Frontend/View/CheckoutSettingsView.php
@@ -94,18 +94,22 @@ protected function getSettingsId(): string
      */
     private function getShippingMethodOptions(): array
     {
-        $shippingMethods = $this->shippingMethodRepository->all();
+        $allShippingMethods = $this->shippingMethodRepository->all();
 
-        return $this->toSelectOptions(
-            array_reduce(
-                $shippingMethods->all(),
-                static function (array $cur, PdkShippingMethod $shippingMethod) {
-                    $cur[$shippingMethod->id] = "$shippingMethod->name ($shippingMethod->id)";
+        $array = $allShippingMethods
+            ->filter(static function (PdkShippingMethod $shippingMethod) {
+                return $shippingMethod->isEnabled;
+            })
+            ->reduce(static function (array $cur, PdkShippingMethod $shippingMethod) {
+                $cur[] = [
+                    'value'       => $shippingMethod->id,
+                    'plainLabel'  => $shippingMethod->name,
+                    'description' => $shippingMethod->description,
+                ];
 
-                    return $cur;
-                }, []
-            ),
-            AbstractSettingsView::SELECT_USE_PLAIN_LABEL
-        );
+                return $cur;
+            }, []);
+
+        return $this->toSelectOptions($array, AbstractSettingsView::SELECT_USE_PLAIN_LABEL);
     }
 }
diff --git a/tests/Bootstrap/MockPdkShippingMethodRepository.php b/tests/Bootstrap/MockPdkShippingMethodRepository.php
@@ -6,11 +6,30 @@
 
 use MyParcelNL\Pdk\App\ShippingMethod\Collection\PdkShippingMethodCollection;
 use MyParcelNL\Pdk\App\ShippingMethod\Contract\PdkShippingMethodRepositoryInterface;
+use MyParcelNL\Pdk\App\ShippingMethod\Model\PdkShippingMethod;
+use function MyParcelNL\Pdk\Tests\factory;
 
 class MockPdkShippingMethodRepository implements PdkShippingMethodRepositoryInterface
 {
     public function all(): PdkShippingMethodCollection
     {
-        return new PdkShippingMethodCollection();
+        return new PdkShippingMethodCollection([
+            factory(PdkShippingMethod::class)
+                ->withId('shipping:1')
+                ->withName('Shipping 1')
+                ->withIsEnabled(true)
+                ->make(),
+            factory(PdkShippingMethod::class)
+                ->withId('shipping:2')
+                ->withName('Shipping 2')
+                ->withIsEnabled(false)
+                ->make(),
+            factory(PdkShippingMethod::class)
+                ->withId('shipping:3')
+                ->withName('Shipping 3')
+                ->withDescription('My description')
+                ->withIsEnabled(true)
+                ->make(),
+        ]);
     }
 }
diff --git a/tests/Unit/App/Cart/Service/CartCalculationServiceTest.php b/tests/Unit/App/Cart/Service/CartCalculationServiceTest.php
@@ -210,6 +210,7 @@
         'result' => [
             'id'                  => null,
             'name'                => null,
+            'description'         => null,
             'isEnabled'           => true,
             'allowedPackageTypes' => [
                 [
@@ -246,6 +247,7 @@
         'result' => [
             'id'                  => null,
             'name'                => null,
+            'description'         => null,
             'isEnabled'           => true,
             'hasDeliveryOptions'  => true,
             'minimumDropOffDelay' => 2,
@@ -274,6 +276,7 @@
         'result' => [
             'id'                  => null,
             'name'                => null,
+            'description'         => null,
             'isEnabled'           => true,
             'hasDeliveryOptions'  => false,
             'minimumDropOffDelay' => 0,

diff --git a/...s__/FrontendRenderServiceTest__it_renders_component_with_data_set_plugin_settings__1.json b/...s__/FrontendRenderServiceTest__it_renders_component_with_data_set_plugin_settings__1.json
@@ -1560,7 +1560,17 @@
             }
           ],
           "$component": "ShippingMethodsInput",
-          "options": [],
+          "options": [
+            {
+              "value": "shipping:1",
+              "plainLabel": "Shipping 1"
+            },
+            {
+              "value": "shipping:3",
+              "plainLabel": "Shipping 3",
+              "description": "My description"
+            }
+          ],
           "label": "settings_checkout_allowed_shipping_methods",
           "description": "settings_checkout_allowed_shipping_methods_description"
         },

diff --git a/...apshots__/SettingsViewTest__it_gets_settings_view_with_data_set_checkout_settings__1.json b/...apshots__/SettingsViewTest__it_gets_settings_view_with_data_set_checkout_settings__1.json
@@ -72,7 +72,17 @@
         }
       ],
       "$component": "ShippingMethodsInput",
-      "options": [],
+      "options": [
+        {
+          "value": "shipping:1",
+          "plainLabel": "Shipping 1"
+        },
+        {
+          "value": "shipping:3",
+          "plainLabel": "Shipping 3",
+          "description": "My description"
+        }
+      ],
       "label": "settings_checkout_allowed_shipping_methods",
       "description": "settings_checkout_allowed_shipping_methods_description"
     },

diff --git a/tests/factories/App/ShippingMethod/Model/PdkShippingMethodFactory.php b/tests/factories/App/ShippingMethod/Model/PdkShippingMethodFactory.php
@@ -20,6 +20,7 @@
  * @method $this withIsEnabled(bool $isEnabled)
  * @method $this withMinimumDropOffDelay(int $minimumDropOffDelay)
  * @method $this withName(string $name)
+ * @method $this withDescription(string $description)
  * @method $this withShippingAddress(Address|AddressFactory $shippingAddress)
  */
 final class PdkShippingMethodFactory extends AbstractModelFactory