MerchantHelper::getMerchantQuery() - Code Metrics - Inspection of "CC-36488: fix basic checkout test" - spryker-shop/b2b-demo-marketplace - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#784)

by Anna
created 2025-10-26 20:33 UTC
MerchantHelper::getMerchantQuery() A

↳ Parent: MerchantHelper
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	1	Features	0
Metric	Value
eloc	1
c	1
b	1
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0
<?php

/**
 * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

namespace PyzTest\Zed\Merchant\Helper;

use Codeception\Module;
use Generated\Shared\DataBuilder\MerchantBuilder;
use Generated\Shared\DataBuilder\MerchantProfileBuilder;
use Generated\Shared\DataBuilder\StoreRelationBuilder;
use Generated\Shared\Transfer\MerchantProfileTransfer;
use Generated\Shared\Transfer\MerchantTransfer;
use Generated\Shared\Transfer\StoreRelationTransfer;
use Generated\Shared\Transfer\StoreTransfer;
use Orm\Zed\Merchant\Persistence\SpyMerchantQuery;
use Spryker\Zed\Merchant\MerchantConfig;
use SprykerTest\Shared\Store\Helper\StoreDataHelperTrait;
use SprykerTest\Shared\Testify\Helper\DataCleanupHelperTrait;
use SprykerTest\Shared\Testify\Helper\LocatorHelperTrait;

class MerchantHelper extends Module
{
    use DataCleanupHelperTrait;
    use LocatorHelperTrait;
    use StoreDataHelperTrait;

    /**
     * @var string
     *
     * @see \Spryker\Zed\Merchant\MerchantConfig::STATUS_APPROVED
     */
    public const STATUS_APPROVED = 'approved';

    /**
     * @param array $seedData
     *
     * @return \Generated\Shared\Transfer\MerchantTransfer
     */
    public function haveMerchant(array $seedData = []): MerchantTransfer
    {
        $merchantTransfer = $this->getMerchantTransfer($seedData);

        $merchantResponseTransfer = $this->getLocator()
            ->merchant()
            ->facade()
            ->createMerchant($merchantTransfer);
        $merchantTransfer = $merchantResponseTransfer->getMerchant();

        if (isset($seedData[MerchantTransfer::STATUS])) {
            $merchantTransfer->setStatus($seedData[MerchantTransfer::STATUS]);
        }

        if (isset($seedData[MerchantTransfer::IS_ACTIVE])) {
            $merchantTransfer->setIsActive($seedData[MerchantTransfer::IS_ACTIVE]);
        }

        if (isset($seedData[MerchantTransfer::IS_ACTIVE]) || isset($seedData[MerchantTransfer::STATUS])) {
            $merchantTransfer = $this->getLocator()
                ->merchant()
                ->facade()
                ->updateMerchant($merchantTransfer)
                ->getMerchant();
        }

        $this->getDataCleanupHelper()->_addCleanup(function () use ($merchantTransfer): void {
            $this->getMerchantQuery()->filterByIdMerchant($merchantTransfer->getIdMerchant())->delete();
        });

        return $merchantTransfer;
    }

    /**
     * @param array $seedData
     *
     * @return \Generated\Shared\Transfer\MerchantTransfer
     */
    public function haveActiveMerchantWithStore(array $seedData = []): MerchantTransfer
    {
        $seedData = array_merge([
            MerchantTransfer::STATUS => static::STATUS_APPROVED,
            MerchantTransfer::IS_ACTIVE => true,
            MerchantTransfer::STORE_RELATION => $this->getStoreRelationTransfer($seedData[MerchantTransfer::STORE_RELATION] ?? [])->toArray(),
            MerchantTransfer::MERCHANT_PROFILE => $this->buildMerchantProfileTransfer()->toArray(),
        ], $seedData);

        return $this->haveMerchant($seedData);
    }

    /**
     * @return \Generated\Shared\Transfer\MerchantTransfer
     */
    public function haveMerchantWithStore(array $seedData = []): MerchantTransfer
    {
        $storeRelationTransfer = $this->getStoreRelationTransfer($seedData);

        return $this->haveMerchant([MerchantTransfer::STORE_RELATION => $storeRelationTransfer->toArray()]);
    }

    /**
     * @param array $seedData
     *
     * @return \Generated\Shared\Transfer\StoreTransfer
     */
    public function getStoreRelationTransfer(array $seedData = []): StoreRelationTransfer
    {
        $idStores = $seedData[StoreRelationTransfer::ID_STORES] ?? [];

        if (!$idStores) {
            $storeTransfer = [$this->getStoreDataHelper()->haveStore([StoreTransfer::NAME => 'DE'])->getIdStore()];
            $idStores = [$storeTransfer->getIdStore()];
        }
 
        return (new StoreRelationBuilder())->seed([
                StoreRelationTransfer::ID_STORES => $idStores,
            ])->build();
    }

    /**
     * @param int $idMerchant
     *
     * @return void
     */
    public function assertMerchantNotExists(int $idMerchant): void
    {
        $query = $this->getMerchantQuery()->filterByIdMerchant($idMerchant);
        $this->assertSame(0, $query->count());
        $this->assertSame(/** @scrutinizer ignore-type */ 0, $query->count());
    }

    /**
     * @return \Spryker\Zed\Merchant\MerchantConfig
     */
    public function createMerchantConfig(): MerchantConfig
    {
        return new MerchantConfig();
    }

    /**
     * @param \Generated\Shared\Transfer\MerchantTransfer $merchantTransfer
     * @param array $seedData
     *
     * @return \Generated\Shared\Transfer\MerchantTransfer
     */
    protected function addStoreRelation(MerchantTransfer $merchantTransfer, array $seedData): MerchantTransfer
    {
        $storeRelationTransfer = $this->createStoreRelationTransfer($seedData);
        $merchantTransfer->setStoreRelation($storeRelationTransfer->setIdEntity($merchantTransfer->getIdMerchant()));

        return $merchantTransfer;
    }

    /**
     * @param array $seedData
     *
     * @return \Generated\Shared\Transfer\StoreRelationTransfer
     */
    protected function createStoreRelationTransfer(array $seedData): StoreRelationTransfer
    {
        if (isset($seedData[MerchantTransfer::STORE_RELATION])) {
            return (new StoreRelationBuilder())->seed($seedData[MerchantTransfer::STORE_RELATION])->build();
        }

        return (new StoreRelationBuilder())->seed($seedData)->build();
    }

    /**
     * @return \Orm\Zed\Merchant\Persistence\SpyMerchantQuery
     */
    protected function getMerchantQuery(): SpyMerchantQuery
    {
        return SpyMerchantQuery::create();
    }

    /**
     * @param array $seedData
     *
     * @return \Generated\Shared\Transfer\MerchantTransfer
     */
    public function getMerchantTransfer(array $seedData = []): MerchantTransfer
    {
        /** @var \Generated\Shared\Transfer\MerchantTransfer $merchantTransfer */
        $merchantTransfer = (new MerchantBuilder($seedData))->build();
        $merchantTransfer->setIdMerchant(null);
        $merchantTransfer = $this->addStoreRelation($merchantTransfer, $seedData);

        return $merchantTransfer;
    }

    /**
     * @param array $seed
     *
     * @return \Generated\Shared\Transfer\MerchantProfileTransfer
     */
    protected function buildMerchantProfileTransfer(array $seed = []): MerchantProfileTransfer
    {
        return (new MerchantProfileBuilder($seed))->build();
    }
}

spryker-shop / b2b-demo-marketplace

Pull Request — master (#784)

MerchantHelper::getMerchantQuery() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
