HP-2769: implement progressive price rendering and unit tests (#575)

* HP-2769: implement progressive price rendering and unit tests

- Added `RepresentablePrice` interface for price representation.
- Updated `ProgressivePricePresenter` to handle progressive pricing logic.
- Added unit tests for `ProgressivePricePresenter`.
- Improved `Threshold` and `Price` models to support new pricing structure.

* HP-2769: update `ProgressivePricePresenter` to include 'Custom' label in price rendering and enhance unit tests

* HP-2769: enhance progressive price handling framework

- Introduced `ProgressivePresenter` widget for price progressive rendering.
- Updated `ProgressivePricePresenter` and `PricePresenter` to utilize user permissions.
- Improved `Threshold` and `Price` models for detailed progressive pricing.
- Added `getSubtype`, `isOveruse`, and `isQuantityPredefined` methods to `RepresentablePrice`.
- Refined `DynamicFormWidget` integration to better handle pricing thresholds.
- Adjusted controllers to support new progressive price logic.
- Revised unit tests for `ProgressivePricePresenter` to validate progressive thresholds and permissions.

* HP-2769: refine DynamicFormWidget and ProgressivePresenter integration

- Updated `ProgressivePresenter` to utilize `DynamicFormWidget` instance instead of widget container class for better encapsulation.
- Adjusted JS logic to handle dynamic form widget updates more effectively.
- Improved thresholds rendering in `priceFields.php` for progressive pricing.

* HP-2769: remove unused `actionShowProgressive` and fix progressive price data mapping

- Deleted unused `actionShowProgressive` method in `PlanController`.
- Improved data mapping in `actionGetProgressiveInfo` to filter price keys dynamically and handle nested arrays correctly.

* HP-2769: add tests and refine prepaid quantity handling in ProgressivePricePresenter

- Added unit tests to validate rendering logic for prepaid quantities in `ProgressivePricePresenter`.
- Enhanced `renderPrice` method to properly skip thresholds within prepaid quantity range and adjust "Next" tiers.
- Updated `createPrice` method in tests to support `quantity` for prepaid handling.
- Improved logic to differentiate between "Included" and priced thresholds.

* HP-2769: add discount calculation and tests to ProgressivePricePresenter

- Introduced discount calculation logic to `ProgressivePricePresenter` for accurate progressive pricing.
- Updated `renderPrice` method to display discounts for each threshold tier, except the first one.
- Added extensive unit tests to validate discount rendering, calculation rounding, and prepaid handling.
- Refined CSS style in `ProgressivePresenter` for better visual display of progressive pricing.

* HP-2769: update tests and refine logic in ProgressivePricePresenter

- Adjusted price assertions in unit tests to reflect updated price values.
- Implemented `getSubtype`, `isOveruse`, and `isQuantityPredefined` methods in `RepresentablePrice` to return default values.
- Declared strict types in `Threshold` model for better type safety.
- Added `getThresholds` method to `RepresentablePrice`.
- Updated `ProgressivePresenter` to simplify `ProgressivePricePresenter` initialization.
- Enhanced `PriceController` to skip processing thresholds when prices are not defined.

* HP-2769: refactor unit tests in ProgressivePricePresenterTest for cleaner assertions and enhanced readability

- Added helper methods: `assertLinesContain` and `getCleanLines` for streamlined validation.
- Replaced repetitive assertions with ordered line checks to simplify test structure and improve maintainability.
- Updated all relevant test cases to utilize the new helper methods.

* HP-2769: validate objects in PriceController before processing

- Added validation checks for `Price` and `Threshold` objects to ensure data consistency.
- Refined `array_map` logic in `PriceController` to skip invalid price rows.
- Updated threshold handling to validate and process valid threshold objects only.

* HP-2769: refine doc comments and improve `Threshold` property handling

- Corrected and clarified doc comments for `ProgressivePricePresenterTest`.
- Updated `Threshold` model to ensure proper null checks and type consistency for `unitLabel` and `currencyLabel`.

* minor

Author: tafid

.gitignore

@@ -41,3 +41,6 @@ ocular.phar
 php-cs-fixer.phar
 phpunit-skelgen.phar
 phpunit.phar
+
+# PHPUnit
+.phpunit.result.cache

src/controllers/PlanController.php

@@ -47,10 +47,7 @@
 
 class PlanController extends CrudController
 {
-    /**
-     * @var PriceModelFactory
-     */
-    public $priceModelFactory;
+    private PriceModelFactory $priceModelFactory;
 
     /**
      * PlanController constructor.
@@ -440,7 +437,6 @@ private function populateWithPrices(Plan $plan, $pricesData): void
                 $priceData['class'] = 'CertificatePrice';
             }
 
-            /** @var Price $price */
             $price = Price::instantiate($priceData);
             $price->setScenario('create');
             $price->setAttributes($priceData);

src/controllers/PriceController.php

@@ -22,11 +22,13 @@
 use hipanel\helpers\ArrayHelper;
 use hipanel\modules\finance\actions\PriceUpdateAction;
 use hipanel\modules\finance\collections\PricesCollection;
+use hipanel\modules\finance\grid\presenters\price\ProgressivePricePresenter;
 use hipanel\modules\finance\helpers\PriceSort;
 use hipanel\modules\finance\models\Plan;
 use hipanel\modules\finance\models\Price;
 use hipanel\modules\finance\models\query\PriceQuery;
 use hipanel\modules\finance\models\TargetObject;
+use hipanel\modules\finance\models\Threshold;
 use Yii;
 use yii\base\DynamicModel;
 use yii\base\Event;
@@ -225,7 +227,10 @@ public function actionAddExtraPrices(int $plan_id, string $type)
             }
             $prices = $this->getSuggested($plan_id, $plan_id, null, $type);
             $existingObjects = array_keys(ArrayHelper::map($prices, 'object_id', 'id'));
-            $uniqSuggestions = array_filter($suggestions, static fn($suggestion) => !in_array($suggestion->object_id, $existingObjects, true));
+            $uniqSuggestions = array_filter(
+                $suggestions,
+                static fn($suggestion) => !in_array($suggestion->object_id, $existingObjects, true)
+            );
             $prices = array_merge($prices, $uniqSuggestions);
             $prices = PriceSort::anyPrices()->values($prices, true);
 
@@ -262,6 +267,46 @@ public function actionSuggest($plan_id, $object_id = null, $template_plan_id = n
         ]);
     }
 
+    public function actionGetProgressiveInfo(): string
+    {
+        $presenter = Yii::$container->get(ProgressivePricePresenter::class);
+        $dataPrice = array_filter($this->request->post(), fn($key) => str_ends_with($key, 'Price'), ARRAY_FILTER_USE_KEY);
+        $dataThreshold = $this->request->post('Threshold', []);
+
+        if (!$dataPrice) {
+            return '';
+        }
+
+        $prices = array_filter(array_map(function (array $priceRow): ?Price {
+            $price = new Price($priceRow);
+            if ($price->validate()) {
+                return $price;
+            }
+
+            return null;
+        }, reset($dataPrice)));
+        if (empty($prices)) {
+            return '';
+        }
+        foreach ($dataThreshold as $j => $thresholds) {
+            if (!isset($prices[$j])) {
+                continue;
+            }
+            $thresholdRows = [];
+            $price = $prices[$j];
+            foreach ($thresholds as $threshold) {
+                $threshold['parent'] = $price;
+                $thresholdObj = new Threshold($threshold);
+                if ($thresholdObj->validate()) { // todo: validation needed?
+                    $thresholdRows[] = $thresholdObj;
+                }
+            }
+            $price->setProgressivePricingThresholds($thresholdRows);
+        }
+
+        return $presenter->renderPrice(reset($prices));
+    }
+
     private function getSuggested($plan_id, $object_id = null, $template_plan_id = null, string $type = 'default'): array
     {
         $suggestions = (new Price())->batchQuery('suggest', [

src/grid/PriceGridView.php

@@ -29,15 +29,12 @@
  */
 class PriceGridView extends BoxedGridView
 {
-    /**
-     * @var PricePresenterFactory
-     */
-    private $presenterFactory;
-
-    public function __construct(PricePresenterFactory $presenterFactory, array $config = [])
+    public function __construct(
+        readonly private PricePresenterFactory $presenterFactory,
+        array $config = []
+    )
     {
         parent::__construct($config);
-        $this->presenterFactory = $presenterFactory;
     }
 
     public function columns()
@@ -60,7 +57,6 @@ public function columns()
                 'label' => Yii::t('hipanel.finance.price', 'Old price'),
                 'format' => 'raw',
                 'value' => function (Price $model): string {
-                    /** @var PricePresenter $presenter */
                     $presenter = $this->presenterFactory->build($model::class);
 
                     return $presenter

src/grid/presenters/price/PricePresenter.php

@@ -10,12 +10,14 @@
 
 namespace hipanel\modules\finance\grid\presenters\price;
 
-use hipanel\modules\finance\models\Price;
+use hipanel\modules\finance\models\RepresentablePrice;
 use hipanel\widgets\ArraySpoiler;
 use NumberFormatter;
+use Throwable;
 use Yii;
 use yii\base\InvalidConfigException;
 use yii\bootstrap\Html;
+use yii\di\NotInstantiableException;
 use yii\i18n\Formatter;
 use yii\web\User;
 
@@ -27,16 +29,13 @@
  */
 class PricePresenter
 {
-    protected Formatter $formatter;
-
-    protected User $user;
-
     protected string $priceAttribute = 'price';
 
-    public function __construct(Formatter $formatter, User $user)
+    public function __construct(
+        readonly protected Formatter $formatter,
+        readonly protected User $user,
+    )
     {
-        $this->formatter = $formatter;
-        $this->user = $user;
     }
 
     /**
@@ -51,25 +50,25 @@ public function setPriceAttribute(string $priceAttribute): self
     }
 
     /**
-     * @param Price $price
-     * @throws InvalidConfigException
+     * @param RepresentablePrice $price
      * @return string
+     * @throws InvalidConfigException
+     * @throws Throwable
+     * @throws NotInstantiableException
      */
-    public function renderPrice(Price $price): string
+    public function renderPrice(RepresentablePrice $price): string
     {
         $unit = $formula = '';
         if ($price->getUnitLabel()) {
             $unit = ' ' . Yii::t('hipanel:finance', 'per {unit}', ['unit' => Html::encode($price->getUnitLabel())]);
         }
 
-        $activeFormulas = array_filter($price->getFormulaLines(), fn ($el) => $el['is_actual']);
+        $activeFormulas = array_filter($price->getFormulaLines(), fn($el) => $el['is_actual']);
         if (!empty($activeFormulas)) {
             $formula = ArraySpoiler::widget([
-                'id' => mt_rand(),
+                'id' => uniqid('f_'),
                 'data' => $activeFormulas,
-                'formatter' => function ($v) {
-                    return Html::tag('kbd', Html::encode($v['formula']), ['class' => 'javascript']);
-                },
+                'formatter' => fn($v) => Html::tag('kbd', Html::encode($v['formula']), ['class' => 'javascript']),
                 'visibleCount' => 0,
                 'delimiter' => '<br />',
                 'button' => [
@@ -81,17 +80,21 @@ public function renderPrice(Price $price): string
                 ],
             ]);
         }
-        $sum = $this->formatter->asCurrency($price->{$this->priceAttribute}, $price->currency, [NumberFormatter::MAX_FRACTION_DIGITS => 20]);
+        $sum = $this->formatter->asCurrency(
+            $price->{$this->priceAttribute},
+            $price->currency,
+            [NumberFormatter::MAX_FRACTION_DIGITS => 20]
+        );
 
         return Html::tag('strong', $sum) . $unit . $formula;
     }
 
     /**
-     * @param Price $price
+     * @param RepresentablePrice $price
      * @param string $attribute
      * @return string
      */
-    public function renderInfo(Price $price, string $attribute = 'quantity'): string
+    public function renderInfo(RepresentablePrice $price, string $attribute = 'quantity'): string
     {
         if (!$price->isQuantityPredefined()) {
             return Yii::t('hipanel:finance', '{icon} Quantity: {quantity}', [

src/grid/presenters/price/PricePresenterFactory.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 /**
  * Finance module for HiPanel
  *
@@ -14,8 +14,10 @@
 use hipanel\modules\finance\models\Price;
 use hipanel\modules\finance\models\ProgressivePrice;
 use hipanel\modules\finance\models\TemplatePrice;
+use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
-use yii\base\InvalidConfigException;
+use Psr\Container\NotFoundExceptionInterface;
+use yii\web\User;
 
 /**
  * Class PricePresenterFactory.
@@ -27,34 +29,28 @@ class PricePresenterFactory
     /**
      * @var array map of model class to its presenter
      */
-    protected $map = [
+    protected array $map = [
         Price::class => PricePresenter::class,
         TemplatePrice::class => TemplatePricePresenter::class,
         CertificatePrice::class => CertificatePricePresenter::class,
         ProgressivePrice::class => ProgressivePricePresenter::class,
         '*' => PricePresenter::class,
     ];
+    protected array $cache = [];
 
-    /**
-     * @var array
-     */
-    protected $cache = [];
-    /**
-     * @var ContainerInterface
-     */
-    private $container;
-
-    public function __construct(ContainerInterface $container)
+    public function __construct(
+        private readonly ContainerInterface $container,
+    )
     {
-        $this->container = $container;
     }
 
     /**
      * @param string $name
      * @return PricePresenter
-     * @throws InvalidConfigException
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
      */
-    public function build($name)
+    public function build(string $name): PricePresenter
     {
         $className = $this->map[$name] ?? $this->map['*'];
 
@@ -65,9 +61,6 @@ public function build($name)
         return $this->cache[$name];
     }
 
-    /**
-     * @return array
-     */
     public function getMap(): array
     {
         return $this->map;