PIPRES-460 Cart Line service refactoring initiation

src/Exception/Code/ExceptionCode.php

@@ -7,7 +7,6 @@
  * @license     https://github.com/mollie/PrestaShop/blob/master/LICENSE.md
  *
  * @see        https://github.com/mollie/PrestaShop
- * @codingStandardsIgnoreStart
  */
 
 namespace Mollie\Exception\Code;
@@ -35,4 +34,15 @@ class ExceptionCode
     public const ORDER_FAILED_TO_RETRIEVE_PAYMENT_FEE = 3004;
     public const ORDER_FAILED_TO_CREATE_ORDER_PAYMENT_FEE = 3005;
     public const ORDER_FAILED_TO_UPDATE_ORDER_TOTAL_WITH_PAYMENT_FEE = 3006;
+
+    // Service error codes starts from 4000
+    public const SERVICE_FAILED_TO_ROUND_AMOUNT = 4001;
+    const SERVICE_FAILED_TO_FILL_PRODUCT_LINES_WITH_REMAINING_DATA = 4002;
+    const SERVICE_FAILED_TO_ADD_SHIPPING_LINE = 4003;
+    const SERVICE_FAILED_TO_ADD_WRAPPING_LINE = 4004;
+    const SERVICE_FAILED_TO_ADD_PAYMENT_FEE = 4005;
+    const SERVICE_FAILED_TO_UNGROUP_LINES = 4006;
+    const SERVICE_FAILED_TO_CONVERT_TO_LINE_ARRAY = 4007;
+    const SERVICE_FAILED_TO_CREATE_PRODUCT_LINES = 4008;
+    const SERVICE_FAILED_TO_ADD_DISCOUNTS_TO_PRODUCT_LINES = 4009;
 }

src/Exception/CouldNotProcessCartLinesException.php

@@ -0,0 +1,103 @@
+<?php
+/**
+ * Mollie       https://www.mollie.nl
+ *
+ * @author      Mollie B.V. <[email protected]>
+ * @copyright   Mollie B.V.
+ * @license     https://github.com/mollie/PrestaShop/blob/master/LICENSE.md
+ *
+ * @see        https://github.com/mollie/PrestaShop
+ */
+
+namespace Mollie\Exception;
+
+use Exception;
+use Mollie\Exception\Code\ExceptionCode;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+class CouldNotProcessCartLinesException extends \Exception
+{
+    public static function failedToRoundAmount(Exception $exception): self
+    {
+        return new self(
+            'Failed to round amount.',
+            ExceptionCode::SERVICE_FAILED_TO_ROUND_AMOUNT,
+            $exception
+        );
+    }
+
+    public static function failedToFillProductLinesWithRemainingData(Exception $e)
+    {
+        return new self(
+            'Failed to fill product lines with remaining data.',
+            ExceptionCode::SERVICE_FAILED_TO_FILL_PRODUCT_LINES_WITH_REMAINING_DATA,
+            $e
+        );
+    }
+
+    public static function failedToAddShippingLine(Exception $e)
+    {
+        return new self(
+            'Failed to add shipping line.',
+            ExceptionCode::SERVICE_FAILED_TO_ADD_SHIPPING_LINE,
+            $e
+        );
+    }
+
+    public static function failedToAddWrappingLine(Exception $e)
+    {
+        return new self(
+            'Failed to add wrapping line.',
+            ExceptionCode::SERVICE_FAILED_TO_ADD_WRAPPING_LINE,
+            $e
+        );
+    }
+
+    public static function failedToAddPaymentFee(Exception $e)
+    {
+        return new self(
+            'Failed to add payment fee.',
+            ExceptionCode::SERVICE_FAILED_TO_ADD_PAYMENT_FEE,
+            $e
+        );
+    }
+
+    public static function failedToUngroupLines(Exception $e)
+    {
+        return new self(
+            'Failed to ungroup lines.',
+            ExceptionCode::SERVICE_FAILED_TO_UNGROUP_LINES,
+            $e
+        );
+    }
+
+    public static function failedConvertToLineArray(Exception $e)
+    {
+        return new self(
+            'Failed to convert to line array.',
+            ExceptionCode::SERVICE_FAILED_TO_CONVERT_TO_LINE_ARRAY,
+            $e
+        );
+    }
+
+    public static function failedToCreateProductLines(Exception $e)
+    {
+        return new self(
+            'Failed to create product lines.',
+            ExceptionCode::SERVICE_FAILED_TO_CREATE_PRODUCT_LINES,
+            $e
+        );
+    }
+
+    public static function failedToAddDiscountsToProductLines(Exception $e)
+    {
+        return new self(
+            'Failed to add discounts to product lines.',
+            ExceptionCode::SERVICE_FAILED_TO_ADD_DISCOUNTS_TO_PRODUCT_LINES,
+            $e
+        );
+    }
+}

src/Service/CartLine/CartItemDiscountService.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Mollie       https://www.mollie.nl
+ *
+ * @author      Mollie B.V. <[email protected]>
+ * @copyright   Mollie B.V.
+ * @license     https://github.com/mollie/PrestaShop/blob/master/LICENSE.md
+ *
+ * @see        https://github.com/mollie/PrestaShop
+ */
+
+namespace Mollie\Service\CartLine;
+
+use Mollie\Config\Config;
+use Mollie\Utility\NumberUtility;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+class CartItemDiscountService
+{
+    /**
+     * @param float $totalDiscounts
+     * @param array $orderLines
+     * @param float $remaining
+     *
+     * @return array
+     */
+    public function addDiscountsToProductLines(float $totalDiscounts, array $orderLines, float $remaining): array
+    {
+        if ($totalDiscounts >= 0.01) {
+            $orderLines['discount'] = [
+                [
+                    'name' => 'Discount',
+                    'type' => 'discount',
+                    'quantity' => 1,
+                    'unitPrice' => -round($totalDiscounts, Config::API_ROUNDING_PRECISION),
+                    'totalAmount' => -round($totalDiscounts, Config::API_ROUNDING_PRECISION),
+                    'targetVat' => 0,
+                    'category' => '',
+                ],
+            ];
+
+            $remaining = NumberUtility::plus($remaining, $totalDiscounts);
+        }
+
+        return [$orderLines, $remaining];
+    }
+}

src/Service/CartLine/CartItemPaymentFeeService.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * Mollie       https://www.mollie.nl
+ *
+ * @author      Mollie B.V. <[email protected]>
+ * @copyright   Mollie B.V.
+ * @license     https://github.com/mollie/PrestaShop/blob/master/LICENSE.md
+ *
+ * @see        https://github.com/mollie/PrestaShop
+ */
+
+namespace mollie\src\Service\CartLine;
+
+use Mollie\Config\Config;
+use Mollie\DTO\PaymentFeeData;
+use Mollie\Service\LanguageService;
+use Mollie\Utility\NumberUtility;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+class CartItemPaymentFeeService
+{
+    /* @var LanguageService */
+    private $languageService;
+
+    public function __construct(LanguageService $languageService)
+    {
+        $this->languageService = $languageService;
+    }
+
+    /**
+     * @param PaymentFeeData $paymentFeeData
+     * @param array $orderLines
+     *
+     * @return array
+     */
+    public function addPaymentFeeLine(PaymentFeeData $paymentFeeData, array $orderLines): array
+    {
+        if (!$paymentFeeData->isActive()) {
+            return $orderLines;
+        }
+
+        $orderLines['surcharge'] = [
+            [
+                'name' => $this->languageService->lang('Payment fee'),
+                'sku' => Config::PAYMENT_FEE_SKU,
+                'quantity' => 1,
+                'unitPrice' => round($paymentFeeData->getPaymentFeeTaxIncl(), CONFIG::API_ROUNDING_PRECISION),
+                'totalAmount' => round($paymentFeeData->getPaymentFeeTaxIncl(), CONFIG::API_ROUNDING_PRECISION),
+                'vatAmount' => NumberUtility::minus($paymentFeeData->getPaymentFeeTaxIncl(), $paymentFeeData->getPaymentFeeTaxExcl()),
+                'vatRate' => $paymentFeeData->getTaxRate(),
+            ],
+        ];
+
+        return $orderLines;
+    }
+}

src/Service/CartLine/CartItemProductLinesService.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * Mollie       https://www.mollie.nl
+ *
+ * @author      Mollie B.V. <[email protected]>
+ * @copyright   Mollie B.V.
+ * @license     https://github.com/mollie/PrestaShop/blob/master/LICENSE.md
+ *
+ * @see        https://github.com/mollie/PrestaShop
+ */
+
+namespace Mollie\Service\CartLine;
+
+use Mollie\Config\Config;
+use Mollie\Utility\CalculationUtility;
+use Mollie\Utility\NumberUtility;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+class CartItemProductLinesService
+{
+    /**
+     * @param array $orderLines
+     * @param int $vatRatePrecision
+     *
+     * @return array
+     *
+     * @throws \PrestaShop\Decimal\Exception\DivisionByZeroException
+     */
+    public function fillProductLinesWithRemainingData(array $orderLines, int $vatRatePrecision): array
+    {
+        $roundingPrecision = CONFIG::API_ROUNDING_PRECISION;
+
+        foreach ($orderLines as $productHash => $aItem) {
+            $orderLines[$productHash] = array_map(function ($line) use ($roundingPrecision, $vatRatePrecision) {
+                $quantity = (int) $line['quantity'];
+                $targetVat = $line['targetVat'];
+                $unitPrice = $line['unitPrice'];
+
+                $unitPriceNoTax = round(
+                    CalculationUtility::getUnitPriceNoTax($line['unitPrice'], $targetVat),
+                    $roundingPrecision
+                );
+
+                // Calculate VAT
+                $totalAmount = $line['totalAmount'];
+                $actualVatRate = 0;
+
+                if ($unitPriceNoTax > 0) {
+                    $actualVatRate = round(
+                        CalculationUtility::getActualVatRate($unitPrice, $unitPriceNoTax, $quantity),
+                        $vatRatePrecision
+                    );
+                }
+
+                $vatRateWithPercentages = NumberUtility::plus($actualVatRate, 100);
+
+                $vatAmount = NumberUtility::times(
+                    $totalAmount,
+                    NumberUtility::divide($actualVatRate, $vatRateWithPercentages)
+                );
+
+                $newItem = [
+                    'name' => $line['name'],
+                    'category' => $line['category'],
+                    'quantity' => (int) $quantity,
+                    'unitPrice' => round($unitPrice, $roundingPrecision),
+                    'totalAmount' => round($totalAmount, $roundingPrecision),
+                    'vatRate' => round($actualVatRate, $roundingPrecision),
+                    'vatAmount' => round($vatAmount, $roundingPrecision),
+                    'product_url' => $line['product_url'] ?? null,
+                    'image_url' => $line['image_url'] ?? null,
+                ];
+
+                if (isset($line['sku'])) {
+                    $newItem['sku'] = $line['sku'];
+                }
+
+                return $newItem;
+            }, $aItem);
+        }
+
+        return $orderLines;
+    }
+}

src/Service/CartLine/CartItemShippingLineService.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * Mollie       https://www.mollie.nl
+ *
+ * @author      Mollie B.V. <[email protected]>
+ * @copyright   Mollie B.V.
+ * @license     https://github.com/mollie/PrestaShop/blob/master/LICENSE.md
+ *
+ * @see        https://github.com/mollie/PrestaShop
+ */
+
+namespace Mollie\Service\CartLine;
+
+use Mollie\Config\Config;
+use Mollie\Service\LanguageService;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+class CartItemShippingLineService
+{
+    /* @var LanguageService */
+    private $languageService;
+
+    public function __construct(LanguageService $languageService)
+    {
+        $this->languageService = $languageService;
+    }
+
+    /**
+     * @param float $roundedShippingCost
+     * @param array $cartSummary
+     * @param array $orderLines
+     *
+     * @return array
+     */
+    public function addShippingLine(float $roundedShippingCost, array $cartSummary, array $orderLines): array
+    {
+        if (round($roundedShippingCost, 2) <= 0) {
+            return $orderLines;
+        }
+
+        $shippingVatRate = round(($cartSummary['total_shipping'] - $cartSummary['total_shipping_tax_exc']) / $cartSummary['total_shipping_tax_exc'] * 100, Config::API_ROUNDING_PRECISION);
+
+        $orderLines['shipping'] = [
+            [
+                'name' => $this->languageService->lang('Shipping'),
+                'quantity' => 1,
+                'unitPrice' => round($roundedShippingCost, Config::API_ROUNDING_PRECISION),
+                'totalAmount' => round($roundedShippingCost, Config::API_ROUNDING_PRECISION),
+                'vatAmount' => round($roundedShippingCost * $shippingVatRate / ($shippingVatRate + 100), Config::API_ROUNDING_PRECISION),
+                'vatRate' => $shippingVatRate,
+            ],
+        ];
+
+        return $orderLines;
+    }
+}