<?php

declare(strict_types=1);

namespace Mironsoft\Loyalty\Test\Unit\Observer;

use Magento\Customer\Api\CustomerRepositoryInterface;
use Magento\Framework\Event;
use Magento\Framework\Event\Observer as EventObserver;
use Magento\Framework\Stdlib\DateTime\DateTime;
use Magento\Sales\Api\OrderRepositoryInterface;
use Magento\Sales\Model\Order;
use Mironsoft\Loyalty\Api\Data\PointsLedgerInterfaceFactory;
use Mironsoft\Loyalty\Api\PointsLedgerRepositoryInterface;
use Mironsoft\Loyalty\Model\Config\LoyaltyConfig;
use Mironsoft\Loyalty\Model\Service\CategoryBonusResolver;
use Mironsoft\Loyalty\Model\Service\PointsCalculator;
use Mironsoft\Loyalty\Observer\AwardPointsOnOrderPlaced;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;

/**
 * Unit tests for the two guard clauses in AwardPointsOnOrderPlaced (chapter 30) -
 * guests never earn points, and an already-awarded order is skipped. Neither test
 * needs a single order item, which is exactly why they're a good first target:
 * nine dependencies, none of which has to do more than prove it was never called.
 */
class AwardPointsOnOrderPlacedTest extends TestCase
{
    private AwardPointsOnOrderPlaced $observerUnderTest;

    /**
     * @var PointsLedgerRepositoryInterface&MockObject
     */
    private PointsLedgerRepositoryInterface $pointsLedgerRepositoryMock;

    /**
     * @var LoggerInterface&MockObject
     */
    private LoggerInterface $loggerMock;

    /**
     * Builds the observer with nine mocked collaborators - interfaces via
     * createMock() on the interface, concrete services the exact same way, since
     * createMock() disables the real constructor either way (see chapter 91).
     *
     * @return void
     */
    protected function setUp(): void
    {
        $this->pointsLedgerRepositoryMock = $this->createMock(PointsLedgerRepositoryInterface::class);
        $this->loggerMock = $this->createMock(LoggerInterface::class);

        $this->observerUnderTest = new AwardPointsOnOrderPlaced(
            $this->createMock(PointsCalculator::class),
            $this->createMock(CategoryBonusResolver::class),
            $this->createMock(LoyaltyConfig::class),
            $this->pointsLedgerRepositoryMock,
            $this->createMock(PointsLedgerInterfaceFactory::class),
            $this->createMock(OrderRepositoryInterface::class),
            $this->createMock(CustomerRepositoryInterface::class),
            $this->createMock(DateTime::class),
            $this->loggerMock
        );
    }

    /**
     * Wraps a mocked order in real (not mocked) Event/Observer objects - both are
     * plain DataObject subclasses with no dependencies of their own, so building
     * the real thing is simpler than mocking it.
     *
     * @param Order&MockObject $orderMock Order double carried as the event's "order" data.
     * @return EventObserver
     */
    private function observerWithOrder(Order $orderMock): EventObserver
    {
        $event = new Event(['order' => $orderMock]);

        return new EventObserver(['event' => $event]);
    }

    /**
     * @return void
     */
    public function testGuestOrderNeverAwardsPoints(): void
    {
        $orderMock = $this->createMock(Order::class);
        $orderMock->method('getCustomerIsGuest')->willReturn(true);

        $this->pointsLedgerRepositoryMock->expects($this->never())->method('save');
        $this->loggerMock->expects($this->never())->method('error');

        $this->observerUnderTest->execute($this->observerWithOrder($orderMock));
    }

    /**
     * @return void
     */
    public function testAlreadyAwardedOrderIsSkipped(): void
    {
        $orderMock = $this->createMock(Order::class);
        $orderMock->method('getCustomerIsGuest')->willReturn(false);
        $orderMock->method('getCustomerId')->willReturn(42);
        $orderMock->method('getData')->with('loyalty_points_earned')->willReturn(120);

        $this->pointsLedgerRepositoryMock->expects($this->never())->method('save');
        $this->loggerMock->expects($this->never())->method('error');

        $this->observerUnderTest->execute($this->observerWithOrder($orderMock));
    }
}