CalculationBusinessTester::createAbstractProduct() - Code Metrics - spryker-shop/b2b-demo-shop - Measure and Improve Code Quality continuously with Scrutinizer

CalculationBusinessTester::createAbstractProduct() A
last analyzed 2025-09-16 15:05 UTC

↳ Parent: CalculationBusinessTester

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	6
c	0
b	0
f	0
dl	0
loc	9
rs	10
cc	1
nc	1
nop	1

<?php

/**
 * This file is part of the Spryker Commerce OS.
 * For full license information, please view the LICENSE file that was distributed with this source code.
 */

declare(strict_types = 1);

namespace PyzTest\Zed\Calculation;

use Codeception\Actor;
use DateTime;
use Generated\Shared\Transfer\AddressTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\CurrencyTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\DiscountTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\ExpenseTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\ItemTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\ProductOptionTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\QuoteTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\StoreTransfer;
filter:
    dependency_paths: ["lib/*"]
use Orm\Zed\Country\Persistence\SpyCountryQuery;
use Orm\Zed\Currency\Persistence\SpyCurrency;
use Orm\Zed\Currency\Persistence\SpyCurrencyQuery;
use Orm\Zed\Discount\Persistence\SpyDiscount;
use Orm\Zed\Discount\Persistence\SpyDiscountAmount;
use Orm\Zed\Discount\Persistence\SpyDiscountQuery;
use Orm\Zed\Discount\Persistence\SpyDiscountStore;
use Orm\Zed\Discount\Persistence\SpyDiscountVoucher;
use Orm\Zed\Discount\Persistence\SpyDiscountVoucherPool;
use Orm\Zed\Product\Persistence\SpyProductAbstract;
use Orm\Zed\ProductOption\Persistence\SpyProductOptionGroup;
use Orm\Zed\ProductOption\Persistence\SpyProductOptionValue;
use Orm\Zed\Tax\Persistence\SpyTaxRate;
use Orm\Zed\Tax\Persistence\SpyTaxSet;
use Orm\Zed\Tax\Persistence\SpyTaxSetTax;
use Pyz\Zed\Calculation\CalculationDependencyProvider;
use Pyz\Zed\Discount\DiscountDependencyProvider;
use Spryker\Shared\Calculation\CalculationPriceMode;
use Spryker\Shared\Tax\TaxConstants;
use Spryker\Zed\Calculation\Business\CalculationBusinessFactory;
use Spryker\Zed\Calculation\Business\CalculationFacade;
use Spryker\Zed\Calculation\Communication\Plugin\Calculator\GrandTotalCalculatorPlugin;
use Spryker\Zed\Calculation\Communication\Plugin\Calculator\RefundableAmountCalculatorPlugin;
use Spryker\Zed\Calculation\Communication\Plugin\Calculator\RefundTotalCalculatorPlugin;
use Spryker\Zed\Calculation\Dependency\Service\CalculationToUtilTextBridge;
use Spryker\Zed\Kernel\Container;

/**
 * Inherited Methods
 *
 * @method void wantToTest($text)
 * @method void wantTo($text)
 * @method void execute($callable)
 * @method void expectTo($prediction)
 * @method void expect($prediction)
 * @method void amGoingTo($argumentation)
 * @method void am($role)
 * @method void lookForwardTo($achieveValue)
 * @method void comment($description)
 * @method \Codeception\Lib\Friend haveFriend($name, $actorClass = NULL)
 *
 * @SuppressWarnings(\PyzTest\Zed\Calculation\PHPMD)
 */
class CalculationBusinessTester extends Actor
{
    use _generated\CalculationBusinessTesterActions;
filter:
    dependency_paths: ["lib/*"]

    /**
     * @var int
     */
    protected $incrementNumber = 0;

    /**
     * @var string
     */
    protected const COUNTRY_DE = 'DE';

    /**
     * @param int $discountAmount
     * @param string $calculatorType
     * @param string $sku
     *
     * @return \Orm\Zed\Discount\Persistence\SpyDiscountVoucher
     */
    public function createDiscounts(int $discountAmount, string $calculatorType, string $sku = '*'): SpyDiscountVoucher
    {
        $discountVoucherPoolEntity = new SpyDiscountVoucherPool();
        $discountVoucherPoolEntity->setName('test-pool' . $this->getIncrementNumber());
        $discountVoucherPoolEntity->setIsActive(true);
        $discountVoucherPoolEntity->save();

        $discountVoucherEntity = new SpyDiscountVoucher();
        $discountVoucherEntity->setCode('spryker-test' . $this->getIncrementNumber());
        $discountVoucherEntity->setIsActive(true);
        $discountVoucherEntity->setFkDiscountVoucherPool($discountVoucherPoolEntity->getIdDiscountVoucherPool());
        $discountVoucherEntity->save();

        $discountEntity = new SpyDiscount();
        $discountEntity->setAmount($discountAmount);
        $discountEntity->setDisplayName('test1' . $this->getIncrementNumber());
        $discountEntity->setIsActive(1);
        $discountEntity->setValidFrom(new DateTime('1985-07-01'));
        $discountEntity->setValidTo(new DateTime('2030-07-01'));
        $discountEntity->setCalculatorPlugin($calculatorType);
        $discountEntity->setCollectorQueryString('sku = "' . $sku . '"');

        $discountEntity->setFkDiscountVoucherPool($discountVoucherPoolEntity->getIdDiscountVoucherPool());
        $discountEntity->save();

        (new SpyDiscountStore())
            ->setFkDiscount($discountEntity->getIdDiscount())
            ->setFkStore($this->getCurrentStoreTransfer()->getIdStore())
            ->save();

        $discountAmountEntity = new SpyDiscountAmount();
        $currencyEntity = $this->getCurrency();
        $discountAmountEntity->setFkCurrency($currencyEntity->getIdCurrency());
        $discountAmountEntity->setNetAmount($discountAmount);
        $discountAmountEntity->setGrossAmount($discountAmount);
        $discountAmountEntity->setFkDiscount($discountEntity->getIdDiscount());
        $discountAmountEntity->save();

        $discountEntity->reload(true);
        $pool = $discountEntity->getVoucherPool();
        $pool->getDiscountVouchers();

        return $discountVoucherEntity;
    }

    /**
     * @param int $price
     * @param string $priceMode
     * @param float $taxRate
     * @param int $quantity
     *
     * @return \Generated\Shared\Transfer\ExpenseTransfer
     */
    public function createExpenseTransfer(int $price, string $priceMode, float $taxRate, int $quantity): ExpenseTransfer
    {
        $expenseTransfer = new ExpenseTransfer();
        $expenseTransfer->setTaxRate($taxRate);
        $expenseTransfer->setQuantity($quantity);

        if ($priceMode === CalculationPriceMode::PRICE_MODE_GROSS) {
            $expenseTransfer->setUnitGrossPrice($price);
        }

        if ($priceMode === CalculationPriceMode::PRICE_MODE_NET) {
            $expenseTransfer->setUnitNetPrice($price);
        }

        return $expenseTransfer;
    }

    /**
     * @param array $calculatorPlugins
     *
     * @return \Spryker\Zed\Calculation\Business\CalculationFacade
     */
    public function createCalculationFacade(array $calculatorPlugins = []): CalculationFacade
    {
        if (!$calculatorPlugins) {

            return new CalculationFacade();
        }

        $calculationFacade = new CalculationFacade();

        $calculationBusinessFactory = new CalculationBusinessFactory();

        $container = new Container();
        $container[CalculationDependencyProvider::QUOTE_CALCULATOR_PLUGIN_STACK] = $calculatorPlugins;
        $container[CalculationDependencyProvider::PLUGINS_QUOTE_POST_RECALCULATE] = [];

        $container->set(CalculationDependencyProvider::SERVICE_UTIL_TEXT, function (Container $container) {
            return new CalculationToUtilTextBridge($container->getLocator()->utilText()->service());
        });

        $calculationBusinessFactory->setContainer($container);
        $calculationFacade->setFactory($calculationBusinessFactory);

        return $calculationFacade;
    }

    /**
     * @return void
     */
    public function resetCurrentDiscounts(): void
    {
        $discounts = SpyDiscountQuery::create()->find();

        foreach ($discounts as $discountEntity) {
            $discountEntity->setIsActive(false);

            $discountEntity->save();
        }
    }

    /**
     * @param array<\Generated\Shared\Transfer\ItemTransfer> $items
     * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer
     *
     * @return \Generated\Shared\Transfer\QuoteTransfer
     */
    public function recalculateCanceledAmount(array $items, QuoteTransfer $quoteTransfer): QuoteTransfer
    {
        if (!$this->isCanceledAmount($items)) {
            return $quoteTransfer;
        }

        foreach ($quoteTransfer->getItems() as $itemTransferIndex => $itemTransfer) {
            $itemTransfer->setCanceledAmount($items[$itemTransferIndex][5]);
            $itemTransfer->setRefundableAmount($items[$itemTransferIndex][5]);
        }

        $calculationFacade = $this->createCalculationFacade(
            [
                new RefundableAmountCalculatorPlugin(),
                new RefundTotalCalculatorPlugin(),
                new GrandTotalCalculatorPlugin(),
            ],
        );

        return $calculationFacade->recalculateQuote($quoteTransfer);
    }

    /**
     * @param int $discountAmount
     * @param string $sku
     *
     * @return \Generated\Shared\Transfer\DiscountTransfer
     */
    public function createDiscountTransfer(int $discountAmount, string $sku): DiscountTransfer
    {
        $voucherEntity = $this->createDiscounts($discountAmount, DiscountDependencyProvider::PLUGIN_CALCULATOR_FIXED, $sku);

        return (new DiscountTransfer())
            ->setVoucherCode($voucherEntity->getCode());
    }

    /**
     * @return \Generated\Shared\Transfer\StoreTransfer
     */
    public function getCurrentStoreTransfer(): StoreTransfer
    {
        return (new StoreTransfer())
            ->setIdStore(1)
            ->setName(static::COUNTRY_DE);
    }

    /**
     * @return \Generated\Shared\Transfer\AddressTransfer
     */
    public function getCurrentShippingAddress(): AddressTransfer
    {
        return (new AddressTransfer())->setIso2Code(static::COUNTRY_DE);
    }

    /**
     * @return \Generated\Shared\Transfer\CurrencyTransfer
     */
    public function createCurrencyTransfer(): CurrencyTransfer
    {
        return (new CurrencyTransfer())
            ->setCode('EUR');
    }

    /**
     * @param int $price
     * @param string $priceMode
     * @param float $taxRate
     * @param int $quantity
     *
     * @return \Generated\Shared\Transfer\ItemTransfer
     */
    public function createItemTransfer(int $price, string $priceMode, float $taxRate, int $quantity): ItemTransfer
    {
        $abstractProductEntity = $this->createAbstractProductWithTaxSet($taxRate);

        $itemTransfer = (new ItemTransfer())
            ->setName('test' . $this->getIncrementNumber())
            ->setIdProductAbstract($abstractProductEntity->getIdProductAbstract())
            ->setSku('test' . $this->getIncrementNumber())
            ->setQuantity($quantity)
            ->setTaxRate($taxRate);

        if ($priceMode === CalculationPriceMode::PRICE_MODE_GROSS) {
            $itemTransfer->setUnitGrossPrice($price);
        }

        if ($priceMode === CalculationPriceMode::PRICE_MODE_NET) {
            $itemTransfer->setUnitNetPrice($price);
        }

        return $itemTransfer;
    }

    /**
     * @param int $price
     * @param string $priceMode
     * @param float $taxRate
     * @param int $quantity
     *
     * @return \Generated\Shared\Transfer\ProductOptionTransfer
     */
    public function createProductOptionTransfer(int $price, string $priceMode, float $taxRate, int $quantity): ProductOptionTransfer
    {
        $productOptionValueEntity = $this->createProductOptionValue($taxRate);

        $productOptionTransfer = (new ProductOptionTransfer())
            ->setTaxRate($taxRate)
            ->setQuantity($quantity)
            ->setIdProductOptionValue($productOptionValueEntity->getIdProductOptionValue());

        if ($priceMode === CalculationPriceMode::PRICE_MODE_GROSS) {
            $productOptionTransfer->setUnitGrossPrice($price);
        }

        if ($priceMode === CalculationPriceMode::PRICE_MODE_NET) {
            $productOptionTransfer->setUnitNetPrice($price);
        }

        return $productOptionTransfer;
    }

    /**
     * @param float $taxRate
     *
     * @return \Orm\Zed\Product\Persistence\SpyProductAbstract
     */
    public function createAbstractProductWithTaxSet(float $taxRate): SpyProductAbstract
    {
        $countryEntity = SpyCountryQuery::create()->findOneByIso2Code(static::COUNTRY_DE);

        $taxRateEntity = new SpyTaxRate();
        $taxRateEntity->setRate($taxRate);
        $taxRateEntity->setName('test rate');
        $taxRateEntity->setFkCountry($countryEntity->getIdCountry());
        $taxRateEntity->save();

        $taxSetEntity = $this->createTaxSet();

        $this->createTaxSetTax($taxSetEntity, $taxRateEntity);

        return $this->createAbstractProduct($taxSetEntity);
    }

    /**
     * @return \Orm\Zed\Product\Persistence\SpyProductAbstract
     */
    public function createAbstractProductWithTaxExemption(): SpyProductAbstract
    {
        $taxRateEntity = new SpyTaxRate();
        $taxRateEntity->setRate(0);
        $taxRateEntity->setName(TaxConstants::TAX_EXEMPT_PLACEHOLDER);
        $taxRateEntity->save();

        $taxSetEntity = $this->createTaxSet();

        $this->createTaxSetTax($taxSetEntity, $taxRateEntity);

        return $this->createAbstractProduct($taxSetEntity);
    }

    /**
     * @return int
     */
    protected function getIncrementNumber(): int
    {
        return ++$this->incrementNumber;
    }

    /**
     * @return \Orm\Zed\Currency\Persistence\SpyCurrency
     */
    protected function getCurrency(): SpyCurrency
    {
        return SpyCurrencyQuery::create()->findOneByCode('EUR');
    }

    /**
     * @param float $taxRate
     *
     * @return \Orm\Zed\ProductOption\Persistence\SpyProductOptionValue
     */
    protected function createProductOptionValue(float $taxRate): SpyProductOptionValue
    {
        $countryEntity = SpyCountryQuery::create()->findOneByIso2Code('DE');

        $taxRateEntity = new SpyTaxRate();
        $taxRateEntity->setRate($taxRate);
        $taxRateEntity->setName('test rate');
        $taxRateEntity->setFkCountry($countryEntity->getIdCountry());
        $taxRateEntity->save();

        $taxSetEntity = $this->createTaxSet();
        $this->createTaxSetTax($taxSetEntity, $taxRateEntity);

        $productOptionGroupEntity = new SpyProductOptionGroup();
        $productOptionGroupEntity->setName('group.name.translation.key.edit');
        $productOptionGroupEntity->setFkTaxSet($taxSetEntity->getIdTaxSet());
        $productOptionGroupEntity->save();

        $productOptionValueEntity = new SpyProductOptionValue();
        $productOptionValueEntity->setSku('product-' . $this->getIncrementNumber());
        $productOptionValueEntity->setFkProductOptionGroup($productOptionGroupEntity->getIdProductOptionGroup());
        $productOptionValueEntity->setValue('product.option.test');
        $productOptionValueEntity->save();

        return $productOptionValueEntity;
    }

    /**
     * @return \Orm\Zed\Tax\Persistence\SpyTaxSet
     */
    protected function createTaxSet(): SpyTaxSet
    {
        $taxSetEntity = new SpyTaxSet();
        $taxSetEntity->setName('name of tax set');
        $taxSetEntity->save();

        return $taxSetEntity;
    }

    /**
     * @param \Orm\Zed\Tax\Persistence\SpyTaxSet $taxSetEntity
     * @param \Orm\Zed\Tax\Persistence\SpyTaxRate $taxRateEntity
     *
     * @return void
     */
    protected function createTaxSetTax(SpyTaxSet $taxSetEntity, SpyTaxRate $taxRateEntity): void
    {
        $taxSetTaxRateEntity = new SpyTaxSetTax();
        $taxSetTaxRateEntity->setFkTaxSet($taxSetEntity->getIdTaxSet());
        $taxSetTaxRateEntity->setFkTaxRate($taxRateEntity->getIdTaxRate());

        $taxSetTaxRateEntity->save();
    }

    /**
     * @param \Orm\Zed\Tax\Persistence\SpyTaxSet $taxSetEntity
     *
     * @return \Orm\Zed\Product\Persistence\SpyProductAbstract
     */
    protected function createAbstractProduct(SpyTaxSet $taxSetEntity): SpyProductAbstract
    {
        $abstractProductEntity = new SpyProductAbstract();
        $abstractProductEntity->setSku('test-abstract-sku_' . $this->getIncrementNumber());
        $abstractProductEntity->setAttributes('');
        $abstractProductEntity->setFkTaxSet($taxSetEntity->getIdTaxSet());
        $abstractProductEntity->save();

        return $abstractProductEntity;
    }

    /**
     * @param array $items
     *
     * @return bool
     */
    protected function isCanceledAmount(array $items): bool
    {
        foreach ($items as $item) {
            if ($item[5]) {
                return true;
            }
        }

        return false;
    }
}


1			<?php
2
3			/**
4			* This file is part of the Spryker Commerce OS.
5			* For full license information, please view the LICENSE file that was distributed with this source code.
6			*/
7
8			declare(strict_types = 1);
9
10			namespace PyzTest\Zed\Calculation;
11
12			use Codeception\Actor;
13			use DateTime;
14			use Generated\Shared\Transfer\AddressTransfer;
			0 ignored issues – show Bug introduced 2023-05-24 17:04 UTC by Report Bug Copy Issue Report The type `Generated\Shared\Transfer\AddressTransfer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
15			use Generated\Shared\Transfer\CurrencyTransfer;
			0 ignored issues – show Bug introduced 2019-03-19 12:13 UTC by Report Bug Copy Issue Report The type `Generated\Shared\Transfer\CurrencyTransfer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
16			use Generated\Shared\Transfer\DiscountTransfer;
			0 ignored issues – show Bug introduced 2019-03-19 12:13 UTC by Report Bug Copy Issue Report The type `Generated\Shared\Transfer\DiscountTransfer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
17			use Generated\Shared\Transfer\ExpenseTransfer;
			0 ignored issues – show Bug introduced 2019-03-19 12:13 UTC by Report Bug Copy Issue Report The type `Generated\Shared\Transfer\ExpenseTransfer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
18			use Generated\Shared\Transfer\ItemTransfer;
			0 ignored issues – show Bug introduced 2019-03-19 12:13 UTC by Report Bug Copy Issue Report The type `Generated\Shared\Transfer\ItemTransfer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
19			use Generated\Shared\Transfer\ProductOptionTransfer;
			0 ignored issues – show Bug introduced 2019-03-19 12:13 UTC by Report Bug Copy Issue Report The type `Generated\Shared\Transfer\ProductOptionTransfer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
20			use Generated\Shared\Transfer\QuoteTransfer;
			0 ignored issues – show Bug introduced 2019-03-19 12:13 UTC by Report Bug Copy Issue Report The type `Generated\Shared\Transfer\QuoteTransfer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
21			use Generated\Shared\Transfer\StoreTransfer;
			0 ignored issues – show Bug introduced 2019-03-19 12:13 UTC by Report Bug Copy Issue Report The type `Generated\Shared\Transfer\StoreTransfer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
22			use Orm\Zed\Country\Persistence\SpyCountryQuery;
23			use Orm\Zed\Currency\Persistence\SpyCurrency;
24			use Orm\Zed\Currency\Persistence\SpyCurrencyQuery;
25			use Orm\Zed\Discount\Persistence\SpyDiscount;
26			use Orm\Zed\Discount\Persistence\SpyDiscountAmount;
27			use Orm\Zed\Discount\Persistence\SpyDiscountQuery;
28			use Orm\Zed\Discount\Persistence\SpyDiscountStore;
29			use Orm\Zed\Discount\Persistence\SpyDiscountVoucher;
30			use Orm\Zed\Discount\Persistence\SpyDiscountVoucherPool;
31			use Orm\Zed\Product\Persistence\SpyProductAbstract;
32			use Orm\Zed\ProductOption\Persistence\SpyProductOptionGroup;

spryker-shop / b2b-demo-shop

CalculationBusinessTester::createAbstractProduct() A last analyzed 2025-09-16 15:05 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CalculationBusinessTester::createAbstractProduct() A
last analyzed 2025-09-16 15:05 UTC