HP-1751 Create configurations for billing types

.github/workflows/behat-tests.yml

@@ -16,7 +16,7 @@ jobs:
     name: PHP ${{ matrix.php }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install PHP
         uses: shivammathur/setup-php@v2
@@ -28,7 +28,7 @@ jobs:
 
       - name: Cache Composer packages
         id: composer-cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: vendor
           key: ${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}

.github/workflows/phpunit-tests.yml

@@ -16,7 +16,7 @@ jobs:
     name: PHP ${{ matrix.php }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install PHP
         uses: shivammathur/setup-php@v2
@@ -28,7 +28,7 @@ jobs:
 
       - name: Cache Composer packages
         id: composer-cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: vendor
           key: ${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}

composer.json

@@ -61,8 +61,10 @@
         "hiqdev/hidev-hiqdev": "dev-master",
         "hiqdev/php-data-mapper": "dev-master",
         "vimeo/psalm": "^5.0",
+        "opis/closure": "3.x-dev as 3.6.x-dev",
         "cache/array-adapter": "*",
-        "matthiasnoback/behat-expect-exception": "^v0.3.0"
+        "matthiasnoback/behat-expect-exception": "^v0.3.0",
+        "behat/gherkin": "~v4.11.0"
     },
     "suggest": {
         "ext-intl": "intl extension is required for formula support",

src/Exception/LogicException.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\Exception;
+
+class LogicException extends \LogicException
+{
+
+}

src/product/AggregateInterface.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product;
+
+interface AggregateInterface
+{
+    public function isMax(): bool;
+}

src/product/BillingRegistry.php

@@ -0,0 +1,174 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product;
+
+use hiqdev\php\billing\product\behavior\InvalidBehaviorException;
+use hiqdev\php\billing\product\Exception\AggregateNotFoundException;
+use hiqdev\php\billing\product\invoice\InvalidRepresentationException;
+use hiqdev\php\billing\product\invoice\RepresentationInterface;
+use hiqdev\php\billing\product\price\PriceTypeDefinition;
+use hiqdev\php\billing\product\quantity\QuantityFormatterInterface;
+use hiqdev\php\billing\product\quantity\QuantityFormatterNotFoundException;
+use hiqdev\php\billing\product\quantity\FractionQuantityData;
+use hiqdev\php\billing\product\behavior\BehaviorInterface;
+use hiqdev\php\billing\product\behavior\BehaviorNotFoundException;
+use hiqdev\php\billing\product\trait\HasLock;
+use hiqdev\php\billing\type\Type;
+use hiqdev\php\billing\type\TypeInterface;
+
+class BillingRegistry implements BillingRegistryInterface
+{
+    use HasLock;
+
+    /** @var TariffTypeDefinitionInterface[] */
+    private array $tariffTypeDefinitions = [];
+    private bool $locked = false;
+
+    public function addTariffType(TariffTypeDefinitionInterface $tariffTypeDefinition): void
+    {
+        $this->ensureNotLocked();
+
+        $this->tariffTypeDefinitions[] = $tariffTypeDefinition;
+    }
+
+    public function priceTypes(): \Generator
+    {
+        foreach ($this->tariffTypeDefinitions as $tariffTypeDefinition) {
+            foreach ($tariffTypeDefinition->withPrices() as $priceTypeDefinition) {
+                yield $priceTypeDefinition;
+            }
+        }
+    }
+
+    public function getRepresentationsByType(string $representationClass): array
+    {
+        if (!class_exists($representationClass)) {
+            throw new InvalidRepresentationException("Class '$representationClass' does not exist");
+        }
+
+        if (!is_subclass_of($representationClass, RepresentationInterface::class)) {
+            throw new InvalidBehaviorException(
+                sprintf('Representation class "%s" does not implement RepresentationInterface', $representationClass)
+            );
+        }
+
+        $representations = [];
+        foreach ($this->priceTypes() as $priceTypeDefinition) {
+            foreach ($priceTypeDefinition->documentRepresentation() as $representation) {
+                if ($representation instanceof $representationClass) {
+                    $representations[] = $representation;
+                }
+            }
+        }
+
+        return $representations;
+    }
+
+    public function createQuantityFormatter(
+        string $type,
+        FractionQuantityData $data,
+    ): QuantityFormatterInterface {
+        $type = $this->convertStringTypeToType($type);
+
+        foreach ($this->priceTypes() as $priceTypeDefinition) {
+            if ($priceTypeDefinition->hasType($type)) {
+                return $priceTypeDefinition->createQuantityFormatter($data);
+            }
+        }
+
+        throw new QuantityFormatterNotFoundException('Quantity formatter not found');
+    }
+
+    private function convertStringTypeToType(string $type): TypeInterface
+    {
+        return Type::anyId($type);
+    }
+
+    public function getBehavior(string $type, string $behaviorClassWrapper): BehaviorInterface
+    {
+        if (!class_exists($behaviorClassWrapper)) {
+            throw new InvalidBehaviorException(
+                sprintf('Behavior class "%s" does not exist', $behaviorClassWrapper)
+            );
+        }
+
+        if (!is_subclass_of($behaviorClassWrapper, BehaviorInterface::class)) {
+            throw new InvalidBehaviorException(
+                sprintf('Behavior class "%s" does not implement BehaviorInterface', $behaviorClassWrapper)
+            );
+        }
+
+        $billingType = $this->convertStringTypeToType($type);
+
+        foreach ($this->priceTypes() as $priceTypeDefinition) {
+            if ($priceTypeDefinition->hasType($billingType)) {
+                $behavior = $this->findBehaviorInPriceType($priceTypeDefinition, $behaviorClassWrapper);
+
+                if ($behavior) {
+                    return $behavior;
+                }
+            }
+        }
+
+        throw new BehaviorNotFoundException(
+            sprintf('Behavior of class "%s" not found for type "%s"', $behaviorClassWrapper, $type),
+        );
+    }
+
+    private function findBehaviorInPriceType(
+        PriceTypeDefinition $priceTypeDefinition,
+        string $behaviorClassWrapper
+    ): ?BehaviorInterface {
+        foreach ($priceTypeDefinition->withBehaviors() as $behavior) {
+            if ($behavior instanceof $behaviorClassWrapper) {
+                return $behavior;
+            }
+        }
+
+        return null;
+    }
+
+    public function getBehaviors(string $behaviorClassWrapper): \Generator
+    {
+        foreach ($this->tariffTypeDefinitions as $tariffTypeDefinition) {
+            foreach ($tariffTypeDefinition->withBehaviors() as $behavior) {
+                if ($behavior instanceof $behaviorClassWrapper) {
+                    yield $behavior;
+                }
+            }
+        }
+
+        foreach ($this->priceTypes() as $priceTypeDefinition) {
+            foreach ($priceTypeDefinition->withBehaviors() as $behavior) {
+                if ($behavior instanceof $behaviorClassWrapper) {
+                    yield $behavior;
+                }
+            }
+        }
+    }
+
+    public function getAggregate(string $type): AggregateInterface
+    {
+        $type = $this->convertStringTypeToType($type);
+
+        foreach ($this->priceTypes() as $priceTypeDefinition) {
+            if ($priceTypeDefinition->hasType($type)) {
+                return $priceTypeDefinition->getAggregate();
+            }
+        }
+
+        throw new AggregateNotFoundException('Aggregate was not found');
+    }
+
+    public function getTariffTypeDefinitions(): \Generator
+    {
+        foreach ($this->tariffTypeDefinitions as $tariffTypeDefinition) {
+            yield $tariffTypeDefinition;
+        }
+    }
+
+    protected function afterLock(): void
+    {
+        $this->lockItems($this->tariffTypeDefinitions);
+    }
+}

src/product/BillingRegistryInterface.php

@@ -0,0 +1,56 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product;
+
+use Generator;
+use hiqdev\php\billing\product\behavior\BehaviorInterface;
+use hiqdev\php\billing\product\behavior\BehaviorNotFoundException;
+use hiqdev\php\billing\product\behavior\InvalidBehaviorException;
+use hiqdev\php\billing\product\invoice\RepresentationInterface;
+use hiqdev\php\billing\product\price\PriceTypeDefinitionInterface;
+use hiqdev\php\billing\product\quantity\FractionQuantityData;
+use hiqdev\php\billing\product\quantity\QuantityFormatterInterface;
+use hiqdev\php\billing\product\trait\HasLockInterface;
+
+interface BillingRegistryInterface extends HasLockInterface
+{
+    /**
+     * @return Generator
+     * @psalm-return Generator<PriceTypeDefinitionInterface>
+     */
+    public function priceTypes(): Generator;
+
+    public function addTariffType(TariffTypeDefinitionInterface $tariffTypeDefinition): void;
+
+    /**
+     * @param string $representationClass
+     * @return RepresentationInterface[]
+     */
+    public function getRepresentationsByType(string $representationClass): array;
+
+    public function createQuantityFormatter(string $type, FractionQuantityData $data): QuantityFormatterInterface;
+
+    /**
+     * @param string $type - full type like 'overuse,lb_capacity_unit'
+     * @param string $behaviorClassWrapper
+     * @return BehaviorInterface
+     * @throws BehaviorNotFoundException
+     * @throws InvalidBehaviorException
+     */
+    public function getBehavior(string $type, string $behaviorClassWrapper): BehaviorInterface;
+
+    /**
+     * @param string $behaviorClassWrapper
+     * @return Generator
+     * @psalm-return Generator<BehaviorInterface>
+     */
+    public function getBehaviors(string $behaviorClassWrapper): Generator;
+
+    public function getAggregate(string $type): AggregateInterface;
+
+    /**
+     * @return Generator
+     * @psalm-return Generator<TariffTypeDefinitionInterface>
+     */
+    public function getTariffTypeDefinitions(): Generator;
+}

src/product/DocumentRepresentationInterface.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product;
+
+interface DocumentRepresentationInterface
+{
+
+}

src/product/Domain/Model/TariffTypeInterface.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product\Domain\Model;
+
+interface TariffTypeInterface
+{
+    public function name(): string;
+
+    public function label(): string;
+}

src/product/Domain/Model/Unit/FractionUnitInterface.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product\Domain\Model\Unit;
+
+interface FractionUnitInterface
+{
+
+}

src/product/Domain/Model/Unit/UnitInterface.php

@@ -0,0 +1,12 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product\Domain\Model\Unit;
+
+use \hiqdev\php\units\UnitInterface as BaseUnitInterface;
+
+interface UnitInterface
+{
+    public function createExternalUnit(): BaseUnitInterface;
+
+    public function fractionUnit(): FractionUnitInterface;
+}

src/product/Exception/AggregateNotDefinedException.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product\Exception;
+
+use hiqdev\php\billing\Exception\LogicException;
+
+class AggregateNotDefinedException extends LogicException
+{
+
+}

src/product/Exception/AggregateNotFoundException.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product\Exception;
+
+use hiqdev\php\billing\Exception\RuntimeException;
+
+class AggregateNotFoundException extends RuntimeException
+{
+}

src/product/Exception/LockedException.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product\Exception;
+
+use LogicException;
+
+class LockedException extends LogicException
+{
+
+}

src/product/Exception/ProductNotDefinedException.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product\Exception;
+
+use hiqdev\php\billing\Exception\LogicException;
+
+class ProductNotDefinedException extends LogicException
+{
+
+}

src/product/Exception/TariffTypeDefinitionNotFoundException.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\product\Exception;
+
+use hiqdev\php\billing\Exception\RuntimeException;
+
+class TariffTypeDefinitionNotFoundException extends RuntimeException
+{
+
+}