WS\Utils\Collections\CollectionFactory

Complexity

Total Complexity

12

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	from()	0	3	1
A	numbers()	0	16	4
A	generate()	0	15	3
A	fromStrict()	0	3	1
A	fromIterable()	0	8	2
A	empty()	0	3	1

<?php
/**
 * @author Maxim Sokolovsky
 */

namespace WS\Utils\Collections;

use RuntimeException;

class CollectionFactory
{
    use CollectionConstructorTrait;

    /**
     * Returns collection generated with generator <f(int $index): mixed> for $times
     * @param int $times
     * @param callable|null $generator
     * @return Collection
     */
    public static function generate(int $times, ?callable $generator = null): Collection
    {
        if ($times < 0) {
            throw new RuntimeException('The count of values ($times) must be a positive value');
        }
        $generator = $generator ?? static function (int $index) {
            return $index;
        };

        $collection = self::toCollection();
        for ($i = 0; $i < $times; $i++) {
            $collection->add($generator($i));
        }

        return $collection;
    }

    /**
     * Generate collection of int numbers between $from and $to. If $to arg is absent $from - is count of numbers
     * @param int $from
     * @param int $to
     * @return Collection
     */
    public static function numbers(int $from, ?int $to = null): Collection
    {
        if ($to === null) {
            $to = $from - 1;
            $from = 0;
        }

        if ($from > $to) {
            throw new RuntimeException('FROM need to be less than TO');
        }
        $list = new ArrayList();
        for ($i = $from; $i <= $to; $i++) {
            $list->add($i);
        }

        return $list;
    }

    public static function from(array $values): Collection
    {
        return new ArrayList($values);
    }

    public static function fromStrict(array $values): Collection
    {
        return new ArrayStrictList($values);
    }

    public static function fromIterable(iterable $iterable): Collection
    {
        $list = ArrayList::of();
        foreach ($iterable as $item) {
            $list->add($item);
        }

        return $list;
    }

    public static function empty(): Collection
    {
        return ArrayList::of();
    }
}