kartavik\Collections\Collection

Complexity

Total Complexity

43

Size/Duplication

Total Lines	241
Duplicated Lines	0 %

Importance

Changes

0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	sum()	0	9	2
A	count()	0	3	1
A	current()	0	3	1
A	pop()	0	3	1
A	jsonSerialize()	0	3	1
A	getIterator()	0	3	1
A	__callStatic()	0	3	1
A	offsetSet()	0	3	1
A	reverse()	0	10	2
A	offsetExists()	0	3	1
A	validate()	0	3	1
A	first()	0	5	1
A	offsetGet()	0	3	1
A	chunk()	0	5	1
A	type()	0	3	1
A	last()	0	5	1
A	isCompatible()	0	11	3
A	offsetUnset()	0	3	1
A	append()	0	7	2
A	map()	0	33	6
A	__construct()	0	7	3
A	add()	0	4	1

<?php

namespace kartavik\Support;

use kartavik\Support\Method;

/**
 * Class Collection
 * @package kartavik\Support\
 */
class Collection implements \ArrayAccess, \Countable, \IteratorAggregate, \JsonSerializable
{
    use Method\Column;

    /** @var Strict */
    private $strict = null;

    /** @var array */
    protected $container = [];

    /**
     * Collection constructor.
     *
     * @param Strict $type
     * @param iterable ...$iterables
     *
     * @throws Exception\Validation
     */
    public function __construct(Strict $type, iterable ...$iterables)
    {
        $this->strict = $type;

        foreach ($iterables as $iterable) {
            foreach ($iterable as $index => $item) {
                $this->append($item);
            }
        }
    }

    final public function type(): Strict
    {
        return $this->strict;
    }

    public function offsetExists($offset): bool
    {
        return isset($this->container[$offset]);
    }

    public function offsetGet($offset)
    {
        return $this->container[$offset];
    }

    public function offsetUnset($offset): void
    {
        unset($this->container[$offset]);
    }

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

    /**
     * @param mixed $index
     * @param mixed $value
     *
     * @throws Exception\Validation
     */
    public function offsetSet($index, $value): void
    {
        $this->add($value, $index);
    }

    public function jsonSerialize(): array
    {
        return $this->container;
    }

    /**
     * @param mixed ...$var
     *
     * @return Collection
     * @throws Exception\Validation
     */
    public function append(...$var): Collection
    {
        foreach ($var as $item) {
            $this->add($item);
        }

        return $this;
    }

    public function isCompatible(iterable $collection): bool
    {
        try {
            foreach ($collection as $item) {
                $this->validate($item);
            }
        } catch (Exception\Validation $exception) {
            return false;
        }

        return true;
    }

    public function first()
    {
        reset($this->container);

        return $this->current();
    }

    public function last()
    {
        end($this->container);

        return $this->current();
    }

    /**
     * @param mixed $item
     *
     * @throws Exception\Validation
     */
    public function validate($item): void
    {
        $this->type()->validate($item);
    }

    public function chunk(int $size): Collection
    {
        return Collection::{Collection::class}(array_map(function ($chunk) {
            return new Collection($this->type(), $chunk);
        }, array_chunk($this->container, $size)));
    }

    public function map(\Closure $closure, iterable ...$collections): array
    {
        $result = [];
        $count = $this->count();
        $values[] = array_values($this->container);

$values was never initialized. Although not strictly required by PHP, it is generally a good practice to add $values = array(); before regardless.

        foreach ($collections as $index => $collection) {
            if (!$this->isCompatible($collection)) {
                throw new Exception\IncompatibleIterable($collection, 'Given iterable object contain invalid element');
            }

            if ($count !== count($collection)) {
                throw new Exception\IncompatibleIterable(
                    $collection,
                    'Given iterable object must contain same count elements'
                );
            }

            foreach ($collection as $item) {
                $values[$index + 1][] = $item;
            }
        }

        foreach (range(0, $this->count() - 1) as $index) {
            $result[] = call_user_func(
                $closure,
                ...array_map(function (array $collection) use ($index) {
                    return $collection[$index];
                }, $values)
            );
        }

        return $result;
    }

    /**
     * @param bool $preserveKeys
     *
     * @return Collection
     * @throws Exception\Validation
     */
    public function reverse(bool $preserveKeys = false): Collection
    {
        /** @var Collection $collection */
        $collection = static::{$this->strict->t()}();

        foreach (array_reverse($this->container, $preserveKeys) as $index => $item) {
            $collection->add($item, $index);
        }

        return $collection;
    }

    public function current()
    {
        return current($this->container);
    }

    public function pop()
    {
        return array_pop($this->container);
    }

    public function sum(\Closure $callback)
    {
        $sum = 0;

        foreach ($this as $element) {
            $sum += call_user_func($callback, $element);
        }

        return $sum;
    }

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

    /**
     * @param $item
     * @param null $index

Are you sure the doc-type for parameter $index is correct as it would always require null to be passed?

     *
     * @throws Exception\Validation
     */
    public function add($item, $index = null): void
    {
        $this->validate($item);
        $this->container[$index ?? $this->count()] = $item;
    }

    /**
     * @param string $name
     * @param array $arguments
     *
     * @return Collection
     * @throws Exception\Validation
     */
    public static function __callStatic(string $name, array $arguments = [])
    {
        return new static(Strict::{$name}(), ...$arguments);
    }
}