map/tests/GenericMapTest.php

<?php declare(strict_types=1);

/*
 * Copyright (c) 2020  https://rewiv.com sikofitt@gmail.com
 *
 * This file is a part of Olive BBS
 *
 * This Source Code Form is subject to the
 * terms of the Mozilla Public License, v. 2.0.
 *
 * If a copy of the MPL was not distributed with this file,
 * You can obtain one at https://mozilla.org/MPL/2.0/.
 *
 *         ___                   ___    ___
 *        (   ).-.              (   )  (   )
 *    .--. | |( __)___  ___ .--. | |.-. | |.-.     .--.
 *   /    \| |(''"(   )(   /    \| /   \| /   \  /  _  \
 *  |  .-. | | | | | |  | |  .-. |  .-. |  .-. |. .' `. ;
 *  | |  | | | | | | |  | |  | | | |  | | |  | || '   | |
 *  | |  | | | | | | |  | |  |/  | |  | | |  | |_\_`.(___)
 *  | |  | | | | | | |  | |  ' _.| |  | | |  | (   ). '.
 *  | '  | | | | | ' '  ; |  .'.-| '  | | '  | || |  `\ |
 *  '  `-' | | | |  \ `' /'  `-' ' `-' ;' `-' ; ; '._,' '
 *   `.__.(___(___)  '_.'  `.__.' `.__.  `.__.   '.___.'
 *
 */

namespace Olivebbs\Tests\Map;

use Olivebbs\Map\Enum\KeyType;
use Olivebbs\Map\Enum\ValueType;
use Olivebbs\Map\Exception\InvalidArgumentException;
use Olivebbs\Map\GenericMap;
use PHPUnit\Framework\TestCase;
use SplObjectStorage;
use stdClass;

class GenericMapTest extends TestCase
{
    private GenericMap $genericMap;

    public function setUp(): void
    {
        $this->genericMap = $this->getGenericMap();
        foreach (range(0, 9) as $range) {
            $this->genericMap[$range] = $range;
        }
    }
    
    public function testHashMap(): void
    {
        $genericHashMap = new GenericMap(KeyType::INT, ValueType::INT);
        foreach (range(0, 9) as $range) {
            $genericHashMap[$range] = $range;
        }

        self::assertSame(KeyType::INT, $this->genericMap->getKeyType());
        self::assertSame(ValueType::INT, $this->genericMap->getValueType());
        self::assertCount(10, $this->genericMap);
        self::assertEquals(10, $this->genericMap->count());
        $array = array_combine(range(0, 9), range(0, 9));
        self::assertIsArray($this->genericMap->toArray());
        self::assertSame($array, $this->genericMap->toArray());
        self::assertSameSize($array, $this->genericMap);
        self::assertTrue(isset($this->genericMap[\random_int(0, 9)]));
        self::assertSame(0, $this->genericMap[0]);
        unset($this->genericMap[1]);
        self::assertNull($this->genericMap[1]);

        $this->expectException(InvalidArgumentException::class);
        $this->genericMap['H'] = 1;
    }

    public function testInvalidArgumentExceptionThrowsIsset(): void
    {
        $genericHashMap = new GenericMap(KeyType::ANY, ValueType::ANY);
        $this->expectException(InvalidArgumentException::class);
        $obj = new stdClass();
        /** @noinspection PhpExpressionResultUnusedInspection */
        isset($genericHashMap[$obj]);
    }

    public function testTypeErrorThrowsIsset(): void
    {
        $genericMap = $this->getGenericMap();
        $this->expectException(InvalidArgumentException::class);

        /** @noinspection PhpExpressionResultUnusedInspection */
        isset($genericMap['C']);
    }

    public function testOffsetGetThrowsInvalidArgumentException(): void
    {
        $genericMap = $this->getGenericMap();
        $this->expectException(InvalidArgumentException::class);
        $obj = new stdClass();
        $test = $genericMap[$obj];
    }

    public function testOffsetSetThrowsInvalidArgumentException(): void
    {
        $genericMap = $this->getGenericMap();
        $this->expectException(InvalidArgumentException::class);
        $obj = new stdClass();
        $genericMap[$obj] = 1;
    }

    public function testOffsetUnSetThrowsInvalidArgumentException(): void
    {
        $genericMap = $this->getGenericMap();
        $this->expectException(InvalidArgumentException::class);
        $obj = new stdClass();
        unset($genericMap[$obj]);
    }

    public function testOffsetSetThrowsValueErrorException(): void
    {
        $genericMap = $this->getGenericMap();
        $this->expectException(InvalidArgumentException::class);

        $genericMap[0] = 'string';
    }

    public function testOffSetUnSetThrowsTypeErrorException(): void
    {
        $this->resetGenericMap();

        $this->expectException(InvalidArgumentException::class);

        unset($this->genericMap['C']);
    }

    public function testOffsetGetThrowsTypeErrorException(): void
    {
        $this->resetGenericMap();
        $this->expectException(InvalidArgumentException::class);

        $test = $this->genericMap['C'];
    }

    public function testThrowInvalidArgumentExceptionOnConstructValue(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $genericMap = new GenericMap(KeyType::CHAR, 'test');
    }

    public function testUsingClassAsValue(): void
    {
        $genericMap = new GenericMap(KeyType::INT, SplObjectStorage::class);
        $splObject = new SplObjectStorage();
        $stdClass = new stdClass();
        $splObject->attach($stdClass);
        $genericMap[0] = $splObject;
        self::assertSame($splObject, $genericMap[0]);
        self::assertTrue($genericMap[0]->contains($stdClass));
    }

    public function testObjectCantBeUsedAsKeyWithAny(): void
    {
        $genericMap = new GenericMap(KeyType::ANY, ValueType::ANY);
        $object = new SplObjectStorage();
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('Map keys cannot be objects or arrays');
        $genericMap[$object] = 1;
    }

    public function testEnumMap(): void
    {
        $enumMap = new class(TestEnum::cases()) extends GenericMap {
            public function __construct(array $values = [])
            {
                parent::__construct(KeyType::INT, ValueType::ENUM);
                $this->assertInitialValues($values);
                $this->map->putAll($values);
            }
        };

        self::assertCount(8, $enumMap->toArray());
        self::assertSame(TestEnum::a, $enumMap[0]);
        self::assertSame(TestEnum::h, $enumMap[7]);
    }

    private function resetGenericMap(): void
    {
        $this->genericMap = $this->getGenericMap();
    }

    private function getGenericMap(): GenericMap
    {
        return new GenericMap(KeyType::INT, ValueType::INT);
    }
}