Roave\ApiCompare\Changes

Complexity

Total Complexity

7

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	mergeWith()	0	7	1
A	__construct()	0	2	1
A	new()	0	3	1
A	getIterator()	0	3	1
A	withAddedChange()	0	5	1
A	fromArray()	0	6	1
A	count()	0	3	1

<?php
declare(strict_types=1);

namespace Roave\ApiCompare;

use ArrayIterator;
use Assert\Assert;
use Countable;
use IteratorAggregate;
use function count;

final class Changes implements IteratorAggregate, Countable
{
    /** @var Change[] */
    private $changes = [];

    private function __construct()
    {
    }

    public static function new(): self
    {
        return new self();
    }

    public static function fromArray(array $changes): self
    {
        Assert::that($changes)->all()->isInstanceOf(Change::class);
        $instance = self::new();
        $instance->changes = $changes;
        return $instance;
    }

    public function mergeWith(self $other) : self
    {
        $instance = new self();

        $instance->changes = array_merge($this->changes, $other->changes);

        return $instance;
    }

    public function withAddedChange(Change $change): self
    {
        $new = clone $this;
        $new->changes[] = $change;
        return $new;
    }

    /**
     * {@inheritDoc}
     *
     * @return Change[]
     */
    public function getIterator() : ArrayIterator
    {
        return new ArrayIterator($this->changes);

The expression return new ArrayIterator($this->changes) returns the type ArrayIterator which is incompatible with the documented return type Roave\ApiCompare\Change[].

    }

    /**
     * {@inheritDoc}
     */
    public function count() : int
    {
        return count($this->changes);
    }
}