AlecRabbit\Spinner\Core\FrameCollection

Complexity

Total Complexity

10

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	lastIndex()	0	12	2
A	__construct()	0	5	1
A	assertFrame()	0	8	2
A	get()	0	3	1
A	initialize()	0	8	2
A	assertIsNotEmpty()	0	4	2

<?php

declare(strict_types=1);

namespace AlecRabbit\Spinner\Core;

use AlecRabbit\Spinner\Contract\IFrame;
use AlecRabbit\Spinner\Core\Contract\IFrameCollection;
use AlecRabbit\Spinner\Exception\InvalidArgument;
use AlecRabbit\Spinner\Exception\LogicException;
use ArrayObject;
use Traversable;

/**
 * @template T of IFrame
 *
 * @extends ArrayObject<int,T>
 *
 * @implements IFrameCollection<T>
 */
final class FrameCollection extends ArrayObject implements IFrameCollection
{
    private const COLLECTION_IS_EMPTY = 'Collection is empty.';

    /**
     * @throws InvalidArgument
     */
    public function __construct(Traversable $frames)
    {
        parent::__construct();
        $this->initialize($frames);
        self::assertIsNotEmpty($this);
    }

    /**
     * @throws InvalidArgument
     */
    private function initialize(Traversable $frames): void
    {
        /**
         * @var T $frame
         */
        foreach ($frames as $frame) {
            self::assertFrame($frame);
            $this->append($frame);
        }
    }

    /**
     * @throws InvalidArgument
     */
    private static function assertFrame(mixed $frame): void
    {
        if (!$frame instanceof IFrame) {
            throw new InvalidArgument(
                sprintf(
                    '"%s" expected, "%s" given.',
                    IFrame::class,
                    get_debug_type($frame)
                )
            );
        }
    }

    private static function assertIsNotEmpty(IFrameCollection $collection): void
    {
        if ($collection->count() === 0) {
            throw new InvalidArgument(self::COLLECTION_IS_EMPTY);
        }
    }

    public function lastIndex(): int
    {
        $index = array_key_last($this->getArrayCopy());

        // @codeCoverageIgnoreStart
        if ($index === null) {
            // should not be thrown
            throw new LogicException(self::COLLECTION_IS_EMPTY);
        }
        // @codeCoverageIgnoreEnd

        return $index;

The expression return $index could return the type string which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

    public function get(int $index): IFrame
    {
        return $this->offsetGet($index);
    }
}