FrameCollection::lastIndex() - Code Metrics - Inspection of "Merge branch 'prepare-next'" - alecrabbit/php-console-spinner - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 823aee...b9b37f )

by Alec

created 2023-03-22 13:18 UTC

FrameCollection::lastIndex() A

↳ Parent: FrameCollection

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	4
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	6
rs	10

<?php

declare(strict_types=1);
// 20.03.23
namespace AlecRabbit\Spinner\Core;

use AlecRabbit\Spinner\Contract\IFrame;
use AlecRabbit\Spinner\Contract\IFrameCollection;
use AlecRabbit\Spinner\Exception\DomainException;
use AlecRabbit\Spinner\Exception\InvalidArgumentException;
use ArrayObject;
use Traversable;

/**
 * @template T of IFrame
 * @extends ArrayObject<int,T>
 * @implements IFrameCollection<T>
 */
final class FrameCollection extends ArrayObject implements IFrameCollection
{
    /**
     * @throws InvalidArgumentException
     */
    public function __construct(Traversable $frames)
    {
        parent::__construct();
        $this->initialize($frames);
    }

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

    /**
     * @throws InvalidArgumentException
     */
    private static function assertFrame(mixed $frame): void
    {
        if (!$frame instanceof IFrame) {
            throw new InvalidArgumentException(
                sprintf(
                    'Frame must be instance of %s. %s given.', // TODO: clarify message
                    IFrame::class,
                    get_debug_type($frame)
                )
            );
        }
    }

    /** @inheritdoc */
    public function lastIndex(): int
    {
        return

            array_key_last($this->getArrayCopy())
            ??
            throw new DomainException('Empty collection.');
    }

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


1			<?php
2
3			declare(strict_types=1);
4			// 20.03.23
5			namespace AlecRabbit\Spinner\Core;
6
7			use AlecRabbit\Spinner\Contract\IFrame;
8			use AlecRabbit\Spinner\Contract\IFrameCollection;
9			use AlecRabbit\Spinner\Exception\DomainException;
10			use AlecRabbit\Spinner\Exception\InvalidArgumentException;
11			use ArrayObject;
12			use Traversable;
13
14			/**
15			* @template T of IFrame
16			* @extends ArrayObject<int,T>
17			* @implements IFrameCollection<T>
18			*/
19			final class FrameCollection extends ArrayObject implements IFrameCollection
20			{
21			/**
22			* @throws InvalidArgumentException
23			*/
24			public function __construct(Traversable $frames)
25			{
26			parent::__construct();
27			$this->initialize($frames);
28			}
29
30			/**
31			* @throws InvalidArgumentException
32			*/
33			private function initialize(Traversable $frames): void
34			{
35			/** @var T $frame */
36			foreach ($frames as $frame) {
37			self::assertFrame($frame);
38			$this->append($frame);
39			}
40			}
41
42			/**
43			* @throws InvalidArgumentException
44			*/
45			private static function assertFrame(mixed $frame): void
46			{
47			if (!$frame instanceof IFrame) {
48			throw new InvalidArgumentException(
49			sprintf(
50			'Frame must be instance of %s. %s given.', // TODO: clarify message
51			IFrame::class,
52			get_debug_type($frame)
53			)
54			);
55			}
56			}
57
58			/** @inheritdoc */
59			public function lastIndex(): int
60			{
61			return
			0 ignored issues – show Bug Best Practice introduced 2023-03-22 13:31 UTC by Report Bug Copy Issue Report The expression `return array_key_last($t...rayCopy()) ?? ThrowNode` could return the type `string` which is incompatible with the type-hinted return `integer`. Consider adding an additional type-check to rule them out. Loading history...
62			array_key_last($this->getArrayCopy())
63			??
64			throw new DomainException('Empty collection.');
65			}
66
67			public function get(int $index): IFrame
68			{
69			return $this->offsetGet($index);
70			}
71			}
72

alecrabbit / php-console-spinner

Push — master ( 823aee...b9b37f )

FrameCollection::lastIndex() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like