WebTheory\Collection\Kernel\CollectionKernel

Complexity

Total Complexity

78

Size/Duplication

Total Lines	440
Duplicated Lines	0 %

Test Coverage

Coverage

72.82%

Importance

Changes	1
Bugs	0	Features	0

43 Methods

Rating	Name	Duplication	Size	Complexity
A	where()	0	7	1
A	objectsMatch()	0	3	1
A	difference()	0	8	1
A	matches()	0	4	1
A	sortCustom()	0	7	1
A	add()	0	11	3
A	__construct()	0	14	1
A	isMapped()	0	3	2
A	filter()	0	3	1
A	hasItems()	0	3	1
A	getResolvedObjectComparator()	0	10	2
A	sortMapped()	0	13	2
A	alreadyHasItem()	0	11	3
A	find()	0	12	2
A	walk()	0	3	1
A	toArray()	0	3	1
A	contains()	0	15	4
A	intersection()	0	8	1
A	jsonSerialize()	0	3	1
A	spawn()	0	3	1
A	getIterator()	0	3	1
A	strip()	0	6	1
A	findById()	0	9	2
A	sortBy()	0	6	1
A	foreach()	0	13	6
A	first()	0	13	2
A	column()	0	11	2
A	notIn()	0	8	1
A	map()	0	3	1
A	collect()	0	3	1
A	getResolvedCollectionComparator()	0	10	2
B	itemMeetsCriteria()	0	26	9
A	merge()	0	11	3
A	hasIdentifier()	0	3	1
A	__serialize()	0	3	1
A	remove()	0	21	5
A	sortWith()	0	7	1
A	resolveValue()	0	3	1
A	whereEquals()	0	3	1
A	count()	0	3	1
A	last()	0	13	2
A	toJson()	0	3	1
A	getFilteredItems()	0	5	1

<?php

namespace WebTheory\Collection\Kernel;

use ArrayIterator;
use IteratorAggregate;
use LogicException;
use OutOfBoundsException;
use Traversable;
use WebTheory\Collection\Comparison\HashBasedCollectionComparator;
use WebTheory\Collection\Comparison\HashBasedObjectComparator;
use WebTheory\Collection\Comparison\PropertyBasedCollectionComparator;
use WebTheory\Collection\Comparison\PropertyBasedObjectComparator;
use WebTheory\Collection\Comparison\RuntimeIdBasedCollectionComparator;
use WebTheory\Collection\Comparison\RuntimeIdBasedObjectComparator;
use WebTheory\Collection\Contracts\CollectionComparatorInterface;
use WebTheory\Collection\Contracts\CollectionKernelInterface;
use WebTheory\Collection\Contracts\CollectionSorterInterface;
use WebTheory\Collection\Contracts\ObjectComparatorInterface;
use WebTheory\Collection\Contracts\OrderInterface;
use WebTheory\Collection\Enum\LoopAction;
use WebTheory\Collection\Resolution\PropertyResolver;
use WebTheory\Collection\Sorting\MapBasedSorter;
use WebTheory\Collection\Sorting\PropertyBasedSorter;

class CollectionKernel implements CollectionKernelInterface, IteratorAggregate
{
    protected array $items = [];

    protected ?string $identifier = null;

    protected bool $map = false;

    protected int $jsonFlags;

    protected PropertyResolver $propertyResolver;

    /**
     * @var callable
     */
    protected $factory;

    public function __construct(
        array $items,
        callable $factory,
        ?string $identifier = null,
        array $accessors = [],
        ?bool $map = false
    ) {
        $this->factory = $factory;
        $this->identifier = $identifier;
        $this->map = $map ?? $this->map ?? false;

        $this->propertyResolver = new PropertyResolver($accessors);

        array_map([$this, 'add'], $items);
    }

    public function __serialize(): array
    {
        return $this->toArray();
    }

    public function add(object $item): bool
    {
        if ($this->alreadyHasItem($item)) {
            return false;
        }

        $this->isMapped()
            ? $this->items[$this->resolveValue($item, $this->identifier)] = $item
            : $this->items[] = $item;

        return true;
    }

    public function contains($item): bool
    {
        if (is_object($item)) {
            return in_array($item, $this->items, true);
        }

        if ($this->isMapped()) {
            return isset($this->items[$item]);
        }

        if ($this->hasIdentifier()) {
            return !empty($this->find($this->identifier, $item));
        }

        return false;
    }

    public function remove($item): bool
    {
        if (is_object($item)) {
            $position = array_search($item, $this->items, true);

            unset($this->items[$position]);

            return true;
        }

        if ($this->isMapped() && isset($this->items[$item])) {
            unset($this->items[$item]);

            return true;
        }

        if ($this->contains($item)) {
            return $this->remove($this->findById($item));
        }

        return false;
    }

    public function column(string $property): array
    {
        $temp = [];

        foreach ($this->items as $item) {
            $value = $this->resolveValue($item, $property);

            $temp[] = $value;
        }

        return $temp;
    }

    public function first(): object
    {
        if (!$this->hasItems()) {
            throw new OutOfBoundsException(
                "Can't determine first item. Collection is empty"
            );
        }

        reset($this->items);

        $first = current($this->items);

        return $first;
    }

    public function last(): object
    {
        if (!$this->hasItems()) {
            throw new OutOfBoundsException(
                'Can\'t determine last item. Collection is empty'
            );
        }

        $last = end($this->items);

        reset($this->items);

        return $last;
    }

    public function sortBy(string $property, string $order = OrderInterface::ASC): object
    {
        $sorter = (new PropertyBasedSorter($this->propertyResolver))
            ->setProperty($property);

        return $this->sortWith($sorter, $order);
    }

    public function sortMapped(array $map, $order = OrderInterface::ASC, string $property = null): object
    {
        if (!$property ??= $this->identifier) {
            throw new LogicException(
                'Cannot sort by map without property or item identifier set.'
            );
        }

        $sorter = (new MapBasedSorter($this->propertyResolver))
            ->setMap($map)
            ->setProperty($property);

It seems like $property can also be of type null; however, parameter $property of WebTheory\Collection\Sorting\MapBasedSorter::setProperty() does only seem to accept string, maybe add an additional type check?

        return $this->sortWith($sorter, $order);
    }

    public function sortWith(CollectionSorterInterface $sorter, $order = OrderInterface::ASC): object
    {
        $collection = clone $this;

        $items = $sorter->sort($collection->items, $order);

        return $this->collect(...$items);
    }

    public function sortCustom(callable $callback): object
    {
        $collection = clone $this;

        usort($collection->items, $callback);

        return $this->collect(...$collection->items);
    }

    public function find(string $property, $value): object
    {
        $items = $this->getFilteredItems(
            fn ($item) => $this->resolveValue($item, $property) === $value
        );

        if ($items) {

The expression $items of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            return $items[0];
        }

        throw new OutOfBoundsException(
            "Can't find item with {$property} is equal to {$value}."
        );
    }

    public function findById($id)
    {
        if (!$this->hasIdentifier()) {
            throw new LogicException(
                "Use of " . __METHOD__ . " requires an identifier."
            );
        }

        return $this->find($this->identifier, $id);
    }

    public function filter(callable $callback): object
    {
        return $this->collect(...$this->getFilteredItems($callback));
    }

    public function strip($property, $values): object
    {
        return $this->filter(
            fn ($item) => !in_array(
                $this->resolveValue($item, $property),
                $values
            )
        );
    }

    public function where(string $property, string $operator, $value): object
    {
        return $this->filter(
            fn ($item) => $this->itemMeetsCriteria(
                $this->resolveValue($item, $property),
                $operator,
                $value
            )
        );
    }

    public function whereEquals(string $property, $value): object
    {
        return $this->where($property, '=', $value);
    }

    public function spawn(callable $callback): object
    {
        return $this->collect(...$this->map($callback));
    }

    public function map(callable $callback)
    {
        return array_map($callback, $this->items);
    }

    public function walk(callable $callback): void
    {
        array_walk($this->items, $callback);
    }

    public function foreach(callable $callback): void
    {
        foreach ($this->items as $key => $item) {
            $action = $callback($item, $key, $this->items);

            switch ($action) {
                case LoopAction::Break():
                case true:
                    break 2;

                case LoopAction::Continue():
                case false:
                    continue 2;
            }
        }
    }

    public function notIn(array $items): object
    {
        $collection = clone $this;

        $items = $this->getResolvedCollectionComparator()
            ->notIn($collection->items, $items);

        return $this->collect(...$items);
    }

    public function difference(array $items): object
    {
        $collection = clone $this;

        $items = $this->getResolvedCollectionComparator()
            ->difference($collection->items, $items);

        return $this->collect(...$items);

$items of type array is incompatible with the type object expected by parameter $items of WebTheory\Collection\Kernel\CollectionKernel::collect().

    }

    public function intersection(array $items): object
    {
        $collection = clone $this;

        $items = $this->getResolvedCollectionComparator()
            ->intersection($collection->items, $items);

        return $this->collect(...$items);
    }

    public function matches(array $items): bool
    {
        return $this->getResolvedCollectionComparator()
            ->matches($this->items, $items);
    }

    public function merge(array ...$collections): object
    {
        $clone = clone $this;

        foreach ($collections as $collection) {
            foreach ($collection as $value) {
                $clone->add($value);
            }
        }

        return $this->collect(...$clone->items);
    }

    public function collect(object ...$items): object
    {
        return ($this->factory)(...$items);
    }

    public function toArray(): array
    {
        return $this->items;
    }

    public function toJson(): string
    {
        return json_encode($this->items, JSON_THROW_ON_ERROR | $this->jsonFlags);
    }

    public function jsonSerialize(): mixed
    {
        return $this->items;
    }

    public function hasItems(): bool
    {
        return !empty($this->items);
    }

    public function getIterator(): Traversable
    {
        return new ArrayIterator($this->items);
    }

    public function count(): int
    {
        return count($this->items);
    }

    protected function getFilteredItems(callable $callback): array
    {
        $collection = clone $this;

        return array_values(array_filter($collection->items, $callback));
        // return array_merge([], array_filter($collection->items, $callback));
    }

    protected function getResolvedCollectionComparator(): CollectionComparatorInterface
    {
        if ($this->hasIdentifier()) {
            $comparator = new PropertyBasedCollectionComparator($this->propertyResolver);
            $comparator->setProperty($this->identifier);
        } else {
            $comparator = new RuntimeIdBasedCollectionComparator();
        }

        return $comparator;
    }

    protected function getResolvedObjectComparator(): ObjectComparatorInterface
    {
        if ($this->hasIdentifier()) {
            $comparator = new PropertyBasedObjectComparator($this->propertyResolver);
            $comparator->setProperty($this->identifier);
        } else {
            $comparator = new RuntimeIdBasedObjectComparator();
        }

        return $comparator;
    }

    protected function objectsMatch(object $a, object $b): bool
    {
        return $this->getResolvedObjectComparator()->matches($a, $b);
    }

    protected function alreadyHasItem(object $object): bool
    {
        $comparator = $this->getResolvedObjectComparator();

        foreach ($this->items as $item) {
            if ($comparator->matches($item, $object)) {
                return true;
            }
        }

        return false;
    }

    protected function itemMeetsCriteria($resolved, string $operator, $value): bool
    {
        switch ($operator) {
            case '=':
                return $resolved === $value;

            case '!=':
                return $resolved !== $value;

            case '>':
                return $resolved > $value;

            case '<':
                return $resolved < $value;

            case '>=':
                return $resolved >= $value;

            case '<=':
                return $resolved <= $value;

            case 'in':
                return in_array($resolved, $value);

            case 'not in':

The function implicitly returns null when this case condition does not match. This is incompatible with the type-hinted return boolean. Consider adding a default case to the switch.

                return !in_array($resolved, $value);
        }
    }

    protected function resolveValue(object $item, string $property)
    {
        return $this->propertyResolver->resolveProperty($item, $property);
    }

    protected function hasIdentifier(): bool
    {
        return !empty($this->identifier);
    }

    protected function isMapped(): bool
    {
        return $this->hasIdentifier() && true === $this->map;
    }
}