spryker / spryker-core

Bundles/Availability/tests/SprykerTest/Zed/Availability/Business/Model/SellableTest.php

<?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 SprykerTest\Zed\Availability\Business\Model;

use Codeception\Test\Unit;
use Generated\Shared\Transfer\ProductAvailabilityCriteriaTransfer;
use Generated\Shared\Transfer\ProductConcreteAvailabilityTransfer;
use Generated\Shared\Transfer\SellableItemRequestTransfer;
use Generated\Shared\Transfer\SellableItemsRequestTransfer;
use Generated\Shared\Transfer\SellableItemsResponseTransfer;
use Generated\Shared\Transfer\StoreTransfer;
use Spryker\DecimalObject\Decimal;
use Spryker\Zed\Availability\Business\Model\AvailabilityHandlerInterface;
use Spryker\Zed\Availability\Business\Model\Sellable;
use Spryker\Zed\Availability\Business\Model\SellableInterface;
use Spryker\Zed\Availability\Dependency\Facade\AvailabilityToStoreFacadeInterface;
use Spryker\Zed\Availability\Persistence\AvailabilityRepositoryInterface;
use Spryker\Zed\AvailabilityExtension\Dependency\Plugin\AvailabilityStrategyPluginInterface;

/**
 * Auto-generated group annotations
 *
 * @group SprykerTest
 * @group Zed
 * @group Availability
 * @group Business
 * @group Model
 * @group SellableTest
 * Add your own group annotations below this line
 */
class SellableTest extends Unit
{
    /**
     * @var string
     */
    public const SKU_PRODUCT = 'sku-123-321';

    /**
     * @var string
     */
    public const SKU_PRODUCT_SECOND = 'sku-123-222';

    /**
     * @var string
     */
    protected const PRODUCT_OFFER_REFERENCE = 'offer0';

    /**
     * @dataProvider isProductSellableStoresDataProvider
     *
     * @param \Generated\Shared\Transfer\StoreTransfer $storeTransfer
     *
     * @return void
     */
    public function testIsProductIsSellableWhenNeverOutOfStockShouldReturnIsSellable(StoreTransfer $storeTransfer): void
    {
        $availabilityRepositoryMock = $this->createAvailabilityRepositoryMock();
        $availabilityRepositoryMock->method('findProductConcreteAvailabilityBySkuAndStore')

The method method() does not exist on Spryker\Zed\Availability\Persistence\AvailabilityRepositoryInterface.

            ->with(static::SKU_PRODUCT, $this->createStoreTransfer())
            ->willReturn(
                (new ProductConcreteAvailabilityTransfer())
                    ->setIsNeverOutOfStock(true),
            );

        $sellable = $this->createSellable($availabilityRepositoryMock);
        $isSellable = $sellable->isProductSellableForStore(static::SKU_PRODUCT, new Decimal(1), $storeTransfer);

        $this->assertTrue($isSellable);
    }

    /**
     * @return array
     */
    public function isProductSellableStoresDataProvider(): array
    {
        return [
            'store with ID' => [$this->createStoreTransfer()],
            'store without ID' => [(new StoreTransfer())->setName('DE')],
        ];
    }

    /**
     * @dataProvider reservedItemsAndExistingStockDataProvider
     *
     * @param \Spryker\DecimalObject\Decimal $existingAvailability
     *
     * @return void
     */
    public function testIsProductSellableWhenProductHaveInStockShouldReturnIsSellable(Decimal $existingAvailability): void
    {
        $storeTransfer = $this->createStoreTransfer();
        $availabilityRepositoryMock = $this->createAvailabilityRepositoryMock();
        $availabilityRepositoryMock->method('findProductConcreteAvailabilityBySkuAndStore')
            ->with(static::SKU_PRODUCT, $storeTransfer)
            ->willReturn(
                (new ProductConcreteAvailabilityTransfer())
                    ->setAvailability($existingAvailability)
                    ->setIsNeverOutOfStock(false),
            );

        $sellable = $this->createSellable($availabilityRepositoryMock);
        $isSellable = $sellable->isProductSellableForStore(static::SKU_PRODUCT, new Decimal(1), $storeTransfer);

        $this->assertTrue($isSellable);
    }

    /**
     * @return void
     */
    public function testAreProductConcretesSellableForStoreWhenProductOutOfStockShouldReturnIsNotSellable(): void
    {
        // Arrange
        $storeTransfer = $this->createStoreTransfer();
        $availabilityRepositoryMock = $this->createAvailabilityRepositoryMock();
        $availabilityRepositoryMock->method('findProductConcreteAvailabilityBySkusAndStore')
            ->with([static::SKU_PRODUCT, static::SKU_PRODUCT_SECOND], $storeTransfer)
            ->willReturn(
                [
                    (new ProductConcreteAvailabilityTransfer())
                        ->setSku(static::SKU_PRODUCT)
                        ->setAvailability(6)
                        ->setIsNeverOutOfStock(false),
                    (new ProductConcreteAvailabilityTransfer())
                        ->setSku(static::SKU_PRODUCT_SECOND)
                        ->setAvailability(6)
                        ->setIsNeverOutOfStock(false),
                ],
            );
        $batchRequestData = [
            [
                'sku' => static::SKU_PRODUCT,
                'quantity' => 6,
            ],
            [
                'sku' => static::SKU_PRODUCT_SECOND,
                'quantity' => 7,
            ],
        ];

        $sellableItemsRequestTransfer = $this->createSellableItemsRequestTransfer($storeTransfer);
        $sellableItemsRequestTransfer = $this->addSellableItemRequestTransfersFromArray(
            $sellableItemsRequestTransfer,
            $batchRequestData,
        );
        $sellableItemsResponseTransfer = $this->createSellableItemsResponseTransfer();

        $sellable = $this->createSellable($availabilityRepositoryMock);

        //Act
        $sellableItemsResponseTransfer = $sellable->areProductConcretesSellableForStore(
            $sellableItemsRequestTransfer,
            $sellableItemsResponseTransfer,
        );

        //Assert
        $sellableItemsResponseTransferMap = $this->getSellableItemResponseTransfersMapBySku($sellableItemsResponseTransfer);

        $this->assertSame(2, count($sellableItemsResponseTransfer->getSellableItemResponses()));
        $this->assertTrue($sellableItemsResponseTransferMap[static::SKU_PRODUCT]->getIsSellable());

        $this->assertFalse($sellableItemsResponseTransferMap[static::SKU_PRODUCT_SECOND]->getIsSellable());
    }

    /**
     * @return void
     */
    public function testAreProductConcretesSellableForStoreWhenProductsInStockShouldReturnIsSellable(): void
    {
        // Arrange
        $storeTransfer = $this->createStoreTransfer();
        $availabilityRepositoryMock = $this->createAvailabilityRepositoryMock();
        $availabilityRepositoryMock->method('findProductConcreteAvailabilityBySkusAndStore')
            ->with([static::SKU_PRODUCT, static::SKU_PRODUCT_SECOND], $storeTransfer)
            ->willReturn(
                [
                    (new ProductConcreteAvailabilityTransfer())
                        ->setSku(static::SKU_PRODUCT)
                        ->setAvailability(6)
                        ->setIsNeverOutOfStock(false),
                    (new ProductConcreteAvailabilityTransfer())
                        ->setSku(static::SKU_PRODUCT_SECOND)
                        ->setAvailability(6)
                        ->setIsNeverOutOfStock(false),
                ],
            );
        $batchRequestData = [
            [
                'sku' => static::SKU_PRODUCT,
                'quantity' => 5,
            ],
            [
                'sku' => static::SKU_PRODUCT_SECOND,
                'quantity' => 5,
            ],
        ];

        $sellableItemsRequestTransfer = $this->createSellableItemsRequestTransfer($storeTransfer);
        $sellableItemsRequestTransfer = $this->addSellableItemRequestTransfersFromArray(
            $sellableItemsRequestTransfer,
            $batchRequestData,
        );
        $sellableItemsResponseTransfer = $this->createSellableItemsResponseTransfer();

        $sellable = $this->createSellable($availabilityRepositoryMock);

        //Act
        $sellableItemsResponseTransfer = $sellable->areProductConcretesSellableForStore(
            $sellableItemsRequestTransfer,
            $sellableItemsResponseTransfer,
        );

        //Assert
        $sellableItemsResponseTransferMap = $this->getSellableItemResponseTransfersMapBySku($sellableItemsResponseTransfer);

        $this->assertSame(2, count($sellableItemsResponseTransfer->getSellableItemResponses()));
        $this->assertTrue($sellableItemsResponseTransferMap[static::SKU_PRODUCT]->getIsSellable());

        $this->assertTrue($sellableItemsResponseTransferMap[static::SKU_PRODUCT_SECOND]->getIsSellable());
    }

    /**
     * @return void
     */
    public function testAreProductConcretesSellableForStoreWhenProductsAreNeverOutOfStockShouldReturnIsSellable(): void
    {
        // Arrange
        $storeTransfer = $this->createStoreTransfer();
        $availabilityRepositoryMock = $this->createAvailabilityRepositoryMock();
        $availabilityRepositoryMock->method('findProductConcreteAvailabilityBySkusAndStore')
            ->with([static::SKU_PRODUCT, static::SKU_PRODUCT_SECOND], $storeTransfer)
            ->willReturn(
                [
                    (new ProductConcreteAvailabilityTransfer())
                        ->setSku(static::SKU_PRODUCT)
                        ->setIsNeverOutOfStock(true),
                    (new ProductConcreteAvailabilityTransfer())
                        ->setSku(static::SKU_PRODUCT_SECOND)
                        ->setIsNeverOutOfStock(true),
                ],
            );
        $batchRequestData = [
            [
                'sku' => static::SKU_PRODUCT,
                'quantity' => 5,
            ],
            [
                'sku' => static::SKU_PRODUCT_SECOND,
                'quantity' => 5,
            ],
        ];

        $sellableItemsRequestTransfer = $this->createSellableItemsRequestTransfer($storeTransfer);
        $sellableItemsRequestTransfer = $this->addSellableItemRequestTransfersFromArray(
            $sellableItemsRequestTransfer,
            $batchRequestData,
        );
        $sellableItemsResponseTransfer = $this->createSellableItemsResponseTransfer();

        $sellable = $this->createSellable($availabilityRepositoryMock);

        //Act
        $sellableItemsResponseTransfer = $sellable->areProductConcretesSellableForStore(
            $sellableItemsRequestTransfer,
            $sellableItemsResponseTransfer,
        );

        //Assert
        $sellableItemsResponseTransferMap = $this->getSellableItemResponseTransfersMapBySku($sellableItemsResponseTransfer);

        $this->assertSame(2, count($sellableItemsResponseTransfer->getSellableItemResponses()));
        $this->assertTrue($sellableItemsResponseTransferMap[static::SKU_PRODUCT]->getIsSellable());

        $this->assertTrue($sellableItemsResponseTransferMap[static::SKU_PRODUCT_SECOND]->getIsSellable());
    }

    /**
     * @return array
     */
    public function reservedItemsAndExistingStockDataProvider(): array
    {
        return [
            'int stock' => [new Decimal(10)],
            'float stock' => [new Decimal(9.8)],
            'float stock high precision' => [new Decimal(1.4444444444444)],
        ];
    }

    /**
     * @return void
     */
    public function testAreProductsSellableForStoreReturnsCriteriaInResponse(): void
    {
        // Arrange
        $storeTransfer = $this->createStoreTransfer();
        $batchRequestData = [
            [
                'sku' => static::SKU_PRODUCT,
                'quantity' => 1,
            ],
        ];

        $sellableItemsRequestTransfer = $this->createSellableItemsRequestTransfer($storeTransfer);
        $sellableItemsRequestTransfer = $this->addSellableItemRequestTransfersFromArray(
            $sellableItemsRequestTransfer,
            $batchRequestData,
        );

        $productAvailabilityCriteriaTransfer = (new ProductAvailabilityCriteriaTransfer())
            ->setProductOfferReference(static::PRODUCT_OFFER_REFERENCE);

        $sellableItemsRequestTransfer
            ->getSellableItemRequests()
            ->offsetGet(0)
            ->setProductAvailabilityCriteria($productAvailabilityCriteriaTransfer);

        $productConcreteAvailabilityTransfer = (new ProductConcreteAvailabilityTransfer())
            ->setSku(static::SKU_PRODUCT)
            ->setAvailability(1)
            ->setIsNeverOutOfStock(true);

        $availabilityStrategyPlugins = [$this->createAvailabilityStrategyPluginMock($productConcreteAvailabilityTransfer)];
        $sellable = $this->createSellable(null, null, null, $availabilityStrategyPlugins);

        // Act
        $sellableItemsResponseTransfer = $sellable->areProductsSellableForStore(
            $sellableItemsRequestTransfer,
        );

        // Assert
        $this->assertSame(
            $productAvailabilityCriteriaTransfer,
            $sellableItemsResponseTransfer->getSellableItemResponses()->offsetGet(0)->getProductAvailabilityCriteria(),
        );
    }

    /**
     * @param \Generated\Shared\Transfer\SellableItemsResponseTransfer $sellableItemsResponseTransfer
     *
     * @return array<\Generated\Shared\Transfer\SellableItemResponseTransfer>
     */
    protected function getSellableItemResponseTransfersMapBySku(SellableItemsResponseTransfer $sellableItemsResponseTransfer): array
    {
        $sellableItemsResponseTransferMap = [];

        foreach ($sellableItemsResponseTransfer->getSellableItemResponses() as $sellableItemResponseTransfer) {
            $sellableItemsResponseTransferMap[$sellableItemResponseTransfer->getSku()] = $sellableItemResponseTransfer;
        }

        return $sellableItemsResponseTransferMap;
    }

    /**
     * @return \Generated\Shared\Transfer\SellableItemsResponseTransfer
     */
    protected function createSellableItemsResponseTransfer(): SellableItemsResponseTransfer
    {
        return new SellableItemsResponseTransfer();
    }

    /**
     * @param \Generated\Shared\Transfer\StoreTransfer $storeTransfer
     *
     * @return \Generated\Shared\Transfer\SellableItemsRequestTransfer
     */
    protected function createSellableItemsRequestTransfer(StoreTransfer $storeTransfer): SellableItemsRequestTransfer
    {
        $sellableItemsRequestTransfer = new SellableItemsRequestTransfer();
        $sellableItemsRequestTransfer->setStore($storeTransfer);

        return $sellableItemsRequestTransfer;
    }

    /**
     * @param \Generated\Shared\Transfer\SellableItemsRequestTransfer $sellableItemsRequestTransfer
     * @param array<mixed> $batchRequestData
     *
     * @return \Generated\Shared\Transfer\SellableItemsRequestTransfer
     */
    protected function addSellableItemRequestTransfersFromArray(
        SellableItemsRequestTransfer $sellableItemsRequestTransfer,
        array $batchRequestData
    ): SellableItemsRequestTransfer {
        foreach ($batchRequestData as $sellableItemRequest) {
            $sellableItemRequestTransfer = new SellableItemRequestTransfer();
            $sellableItemRequestTransfer->fromArray($sellableItemRequest, true);
            $sellableItemsRequestTransfer->addSellableItemRequest($sellableItemRequestTransfer);
        }

        return $sellableItemsRequestTransfer;
    }

    /**
     * @param \Spryker\Zed\Availability\Persistence\AvailabilityRepositoryInterface|null $availabilityRepositoryMock
     * @param \Spryker\Zed\Availability\Business\Model\AvailabilityHandlerInterface|null $availabilityHandlerMock
     * @param \Spryker\Zed\Availability\Dependency\Facade\AvailabilityToStoreFacadeInterface|null $storeFacade
     * @param list<\Spryker\Zed\AvailabilityExtension\Dependency\Plugin\AvailabilityStrategyPluginInterface> $availabilityStrategyPlugins
     *
     * @return \Spryker\Zed\Availability\Business\Model\SellableInterface
     */
    protected function createSellable(
        ?AvailabilityRepositoryInterface $availabilityRepositoryMock = null,
        ?AvailabilityHandlerInterface $availabilityHandlerMock = null,
        ?AvailabilityToStoreFacadeInterface $storeFacade = null,
        array $availabilityStrategyPlugins = []
    ): SellableInterface {
        if ($availabilityRepositoryMock === null) {
            $availabilityRepositoryMock = $this->createAvailabilityRepositoryMock();
        }

        if ($availabilityHandlerMock === null) {
            $availabilityHandlerMock = $this->createAvailabilityHandlerMock();
        }

        if ($storeFacade === null) {
            $storeFacade = $this->createStoreFacade();
            $storeFacade->method('getCurrentStore')
                ->willReturn($this->createStoreTransfer());

            $storeFacade->method('getStoreByName')
                ->willReturn($this->createStoreTransfer());
        }

        return new Sellable(
            $availabilityRepositoryMock,
            $availabilityHandlerMock,
            $storeFacade,
            $availabilityStrategyPlugins,
            [],
        );
    }

    /**
     * @param \Generated\Shared\Transfer\ProductConcreteAvailabilityTransfer $productConcreteAvailabilityTransfer
     *
     * @return \SprykerTest\Zed\Availability\Business\Model\MockObject|\Spryker\Zed\AvailabilityExtension\Dependency\Plugin\AvailabilityStrategyPluginInterface
     */
    protected function createAvailabilityStrategyPluginMock(
        ProductConcreteAvailabilityTransfer $productConcreteAvailabilityTransfer
    ): AvailabilityStrategyPluginInterface {
        $availabilityStrategyPluginMock = $this->getMockBuilder(AvailabilityStrategyPluginInterface::class)->getMock();
        $availabilityStrategyPluginMock->method('isApplicable')->willReturn(true);
        $availabilityStrategyPluginMock->method('findProductConcreteAvailabilityForStore')->willReturn($productConcreteAvailabilityTransfer);

        return $availabilityStrategyPluginMock;
    }

    /**
     * @return \Generated\Shared\Transfer\StoreTransfer
     */
    protected function createStoreTransfer(): StoreTransfer
    {
        return (new StoreTransfer())->setName('DE')->setIdStore(1);
    }

    /**
     * @return \PHPUnit\Framework\MockObject\MockObject|\Spryker\Zed\Availability\Business\Model\AvailabilityHandlerInterface
     */
    protected function createAvailabilityHandlerMock(): AvailabilityHandlerInterface
    {
        return $this->getMockBuilder(AvailabilityHandlerInterface::class)->getMock();
    }

    /**
     * @return \PHPUnit\Framework\MockObject\MockObject|\Spryker\Zed\Availability\Dependency\Facade\AvailabilityToStoreFacadeInterface
     */
    protected function createStoreFacade(): AvailabilityToStoreFacadeInterface
    {
        return $this->getMockBuilder(AvailabilityToStoreFacadeInterface::class)->getMock();
    }

    /**
     * @return \Spryker\Zed\Availability\Persistence\AvailabilityRepositoryInterface|\PHPUnit\Framework\MockObject\MockObject
     */
    protected function createAvailabilityRepositoryMock(): AvailabilityRepositoryInterface
    {
        return $this->getMockBuilder(AvailabilityRepositoryInterface::class)->getMock();
    }
}