<?php

declare(strict_types=1);

namespace LaminasTest\Stdlib;

use Laminas\Stdlib\PriorityQueue;
use PHPUnit\Framework\TestCase;
use stdClass;

use function array_values;
use function count;
use function iterator_to_array;
use function serialize;
use function unserialize;
use function var_export;

/**
 * @group      Laminas_Stdlib
 */
class PriorityQueueTest extends TestCase
{
    /** @var PriorityQueue */
    protected $queue;

    protected function setUp(): void
    {
        $this->queue = new PriorityQueue();
        $this->queue->insert('foo', 3);
        $this->queue->insert('bar', 4);
        $this->queue->insert('baz', 2);
        $this->queue->insert('bat', 1);
    }

    public function testSerializationAndDeserializationShouldMaintainState(): void
    {
        $s            = serialize($this->queue);
        $unserialized = unserialize($s);
        $count        = count($this->queue);
        self::assertSame(
            $count,
            count($unserialized),
            'Expected count ' . (string) $count . '; received ' . (string) count($unserialized)
        );

        $expected = iterator_to_array($this->queue);
        $test     = iterator_to_array($unserialized);
        self::assertSame(
            $expected,
            $test,
            'Expected: ' . var_export($expected, true) . "\nReceived:" . var_export($test, true)
        );
    }

    public function testRetrievingQueueAsArrayReturnsDataOnlyByDefault(): void
    {
        $expected = [
            'foo',
            'bar',
            'baz',
            'bat',
        ];
        $test     = $this->queue->toArray();
        self::assertSame($expected, $test, var_export($test, true));
    }

    public function testCanCastToArrayOfPrioritiesOnly(): void
    {
        $expected = [
            3,
            4,
            2,
            1,
        ];
        $test     = $this->queue->toArray(PriorityQueue::EXTR_PRIORITY);
        self::assertSame($expected, $test, var_export($test, true));
    }

    public function testCanCastToArrayOfDataPriorityPairs(): void
    {
        $expected = [
            ['data' => 'foo', 'priority' => 3],
            ['data' => 'bar', 'priority' => 4],
            ['data' => 'baz', 'priority' => 2],
            ['data' => 'bat', 'priority' => 1],
        ];
        $test     = $this->queue->toArray(PriorityQueue::EXTR_BOTH);
        self::assertSame($expected, $test, var_export($test, true));
    }

    public function testCanIterateMultipleTimesAndReceiveSameResults(): void
    {
        $expected = ['bar', 'foo', 'baz', 'bat'];

        for ($i = 1; $i < 3; $i++) {
            $test = [];
            foreach ($this->queue as $item) {
                $test[] = $item;
            }
            self::assertEquals($expected, $test, 'Failed at iteration ' . (string) $i);
        }
    }

    public function testCanRemoveItemFromQueue(): void
    {
        $this->queue->remove('baz');
        $expected = ['bar', 'foo', 'bat'];
        $test     = array_values(iterator_to_array($this->queue));
        self::assertEquals($expected, $test);
    }

    public function testCanTestForExistenceOfItemInQueue(): void
    {
        self::assertTrue($this->queue->contains('foo'));
        self::assertFalse($this->queue->contains('foobar'));
    }

    public function testCanTestForExistenceOfPriorityInQueue(): void
    {
        self::assertTrue($this->queue->hasPriority(3));
        self::assertFalse($this->queue->hasPriority(1000));
    }

    public function testCloningAlsoClonesQueue(): void
    {
        $foo       = new stdClass();
        $foo->name = 'bar';

        $queue = new PriorityQueue();
        $queue->insert($foo, 1);
        $queue->insert($foo, 2);

        $queueClone = clone $queue;

        while (! $queue->isEmpty()) {
            self::assertSame($foo, $queue->top());
            $queue->remove($queue->top());
        }

        self::assertTrue($queue->isEmpty());
        self::assertFalse($queueClone->isEmpty());
        self::assertEquals(2, $queueClone->count());

        while (! $queueClone->isEmpty()) {
            self::assertSame($foo, $queueClone->top());
            $queueClone->remove($queueClone->top());
        }

        self::assertTrue($queueClone->isEmpty());
    }

    public function testQueueRevertsToInitialStateWhenEmpty(): void
    {
        $queue     = new PriorityQueue();
        $testQueue = clone $queue; // store the default state

        $testQueue->insert('foo', 1);
        $testQueue->insert('bar', 2);

        $testQueue->remove('foo');
        $testQueue->remove('bar');

        self::assertEquals($queue, $testQueue);
    }

    /**
     * @see https://github.com/laminas/laminas-stdlib/issues/12
     */
    public function testUpdatesCountAfterExtractingTopElement(): void
    {
        $queue = new PriorityQueue();
        $queue->insert('first');
        $queue->insert('second');

        $queue->extract();

        $this->assertCount(1, $queue);
    }

    /**
     * @see https://github.com/laminas/laminas-stdlib/issues/12
     */
    public function testTopValueNotFoundAfterExtractingTopElement(): void
    {
        $queue = new PriorityQueue();
        $queue->insert('first');
        $queue->insert('second');

        $queue->extract();

        $this->assertFalse($queue->contains('first'));
    }

    /**
     * @see https://github.com/laminas/laminas-stdlib/issues/12
     */
    public function testValueStillFoundAfterExtractingTopElementWhenItIsADuplicate(): void
    {
        $queue = new PriorityQueue();
        $queue->insert('first');
        $queue->insert('second');
        $queue->insert('first');

        $queue->extract();

        $this->assertCount(2, $queue);
        $this->assertTrue($queue->contains('first'));
    }
}
