Collection::getStringComparator() - Code Metrics - Inspection of "Add chunk and rekey functions" - remotelyliving/php-collection - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7ec2e5...c9861a )

by Christian

created 2020-06-01 18:30 UTC

Collection::getStringComparator() A

↳ Parent: Collection

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

declare(strict_types=1);

namespace RemotelyLiving\PHPCollection;

final class Collection implements CollectionInterface
{
    private array $items;

    private \Generator $deferredValues;

    private function __construct(array $items)
    {
        $this->items = $items;
    }

    public static function collect(array $items = []): self
    {
        self::validateItems($items);

        return new static($items);
    }

    public static function fill(int $startIndex, int $amount, $item = null): self
    {
        self::validateItem($item);

        $items = array_fill($startIndex, $amount, $item);

        return new self($items);
    }

    public static function fromString(string $string, string $delimiter = ','): self
    {
        return new self(explode($delimiter, trim($string)));
    }

    public static function later(\Generator $deferredValues): self
    {
        $deferred = new static([]);
        $deferred->deferredValues = $deferredValues;

        return $deferred;
    }

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

    public function map(callable $fn): self
    {
        return new static(array_map($fn, $this->all()));
    }

    public function filter(callable $fn): self
    {
        return new static(array_filter($this->all(), $fn, ARRAY_FILTER_USE_BOTH));
    }

    public function each(callable $fn): self
    {
        $deferredValues = function () use ($fn) {
            foreach ($this->all() as $key => $item) {
                yield $key => $fn($item, $key);
            }
        };

        return self::later($deferredValues());
    }

    public function reverse(): self
    {
        return new static(array_reverse($this->all()));
    }

    /**
     * @return mixed|null
     */
    public function first()
    {
        if ($this->empty()) {
            return null;
        }

        return $this->get(array_key_first($this->all()));
    }

    /**
     * @return mixed|null
     */
    public function last()
    {
        if ($this->empty()) {
            return null;
        }

        return $this->get(array_key_last($this->all()));
    }

    /**
     * @param callable $fn
     * @param null     $initial

     *
     * @return mixed
     */
    public function reduce(callable $fn, $initial = null)
    {
        return array_reduce($this->all(), $fn, $initial);
    }

    public function unique(): self
    {
        return new self(array_unique($this->all()));
    }

    public function diff(Collection $collection, callable $comparator = null): self
    {
        return new self(array_udiff($this->all(), $collection->all(), $comparator ?? self::getObjectSafeComparator()));
    }

    public function merge(Collection $collection): self
    {
        return new self(array_merge($this->all(), $collection->all()));
    }

    public function union(Collection $collection): self
    {
        return $this->merge($collection)->unique();
    }

    public function intersect(Collection $collection): self
    {
        return new self(array_intersect($this->all(), $collection->all()));
    }

    public function sort(callable $comparator = null): self
    {
        $items = $this->all();
        uasort($items, $comparator ?? self::getObjectSafeComparator());

        return new self($items);
    }

    public function kSort(callable $comparator = null): self
    {
        $items = $this->all();
        uksort($items, $comparator ?? self::getStringComparator());

        return new self($items);
    }

    public function empty(): bool
    {
        return $this->count() === 0;
    }

    public function all(): array
    {
        if (isset($this->deferredValues) && $this->deferredValues->valid()) {
            $this->items = $this->unwrapDeferred();
        }

        return $this->items;
    }

    public function reIndex(): self
    {
        return new self($this->values());
    }

    public function chunk(int $size, callable $fn): self
    {
        $deferred = function () use ($size, $fn) {
            foreach(array_chunk($this->all(), $size, true) as $chunk) {
                foreach($chunk as $index => $value) {
                    yield $index => $fn($value, $index);
                }
            }
        };

        // do the work later and revalidate processed values
        return self::later($deferred());
    }

    public function deferred(): \Generator
    {
        foreach ($this->all() as $key => $value) {
            yield $key => $value;
        }
    }

    public function values(): array
    {
        return array_values($this->all());
    }

    public function equals(Collection $collection): bool
    {
        return $this->diff($collection)->empty();
    }

    /**
     * @param string|int $offset
     *
     * @return bool
     */
    public function has($offset): bool
    {
        return isset($this->all()[$offset]);
    }

    /**
     * @param mixed $item
     *
     * @return bool
     */
    public function contains($item): bool
    {
        return in_array($item, $this->all(), true);
    }

    public function some(callable $evaluation): bool
    {
        foreach ($this->all() as $key => $value) {
            if ($evaluation($value, $key) === true) {
                return true;
            }
        }

        return false;
    }

    /**
     * @param string|int $offset
     * @param mixed|null $default
     *
     * @return mixed|null
     */
    public function get($offset, $default = null)
    {
        return $this->all()[$offset] ?? $default;
    }

    /**
     * @return mixed
     */
    public function rand()
    {
        return $this->all()[array_rand($this->all())];
    }

    /**
     * @param string|int $offset
     */
    public function remove(...$offsets): self
    {
        $withRemoved = new static($this->all());
        foreach ($offsets as $offset) {
            unset($withRemoved->items[$offset]);
        }

        return $withRemoved;
    }

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

    public function serialize(): string
    {
        return \serialize(['items' => $this->all()]);
    }

    public function unserialize($serialized, array $classnames = [])
    {
        if (isset($this->items)) {
            throw new \LogicException('Cannot unserialize instance of collection');
        }

        $this->items = \unserialize($serialized, $classnames)['items'] ?? [];
    }

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

    private function unwrapDeferred(): array
    {
        $items = [];
        foreach ($this->deferredValues as $key => $item) {
            self::validateItem($item);
            $items[$key] = $item;
        }

        return $items;
    }

    /**
     * @throw \InvalidArgumentException
     */
    private static function validateItems(array $items): void
    {
        foreach ($items as $item) {
            self::validateItem($item);
        }
    }

    private static function validateItem($item): void
    {
        if (is_iterable($item)) {
            throw new \InvalidArgumentException('A collection may only contain numbers, strings, or objects');
        }
    }

    private static function getStringComparator(): callable
    {
        return function ($a, $b): int {
            return strcmp((string) $a, (string) $b);
        };
    }

    private static function getObjectSafeComparator(): callable
    {
        return function ($a, $b): int {
            return (\gettype($a) === \gettype($b)) ? $a <=> $b : -1;
        };
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace RemotelyLiving\PHPCollection;
6
7			final class Collection implements CollectionInterface
8			{
9			private array $items;
10
11			private \Generator $deferredValues;
12
13			private function __construct(array $items)
14			{
15			$this->items = $items;
16			}
17
18			public static function collect(array $items = []): self
19			{
20			self::validateItems($items);
21
22			return new static($items);
23			}
24
25			public static function fill(int $startIndex, int $amount, $item = null): self
26			{
27			self::validateItem($item);
28
29			$items = array_fill($startIndex, $amount, $item);
30
31			return new self($items);
32			}
33
34			public static function fromString(string $string, string $delimiter = ','): self
35			{
36			return new self(explode($delimiter, trim($string)));
37			}
38
39			public static function later(\Generator $deferredValues): self
40			{
41			$deferred = new static([]);
42			$deferred->deferredValues = $deferredValues;
43
44			return $deferred;
45			}
46
47			public function count(): int
48			{
49			return count($this->all());
50			}
51
52			public function map(callable $fn): self
53			{
54			return new static(array_map($fn, $this->all()));
55			}
56
57			public function filter(callable $fn): self
58			{
59			return new static(array_filter($this->all(), $fn, ARRAY_FILTER_USE_BOTH));
60			}
61
62			public function each(callable $fn): self
63			{
64			$deferredValues = function () use ($fn) {
65			foreach ($this->all() as $key => $item) {
66			yield $key => $fn($item, $key);
67			}
68			};
69
70			return self::later($deferredValues());
71			}
72
73			public function reverse(): self
74			{
75			return new static(array_reverse($this->all()));
76			}
77
78			/**
79			* @return mixed\|null
80			*/
81			public function first()
82			{
83			if ($this->empty()) {
84			return null;
85			}
86
87			return $this->get(array_key_first($this->all()));
88			}
89
90			/**
91			* @return mixed\|null
92			*/
93			public function last()
94			{
95			if ($this->empty()) {
96			return null;
97			}
98
99			return $this->get(array_key_last($this->all()));
100			}
101
102			/**
103			* @param callable $fn
104			* @param null $initial
			0 ignored issues – show Documentation Bug introduced 2020-05-30 21:43 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$initial` is correct as it would always require `null` to be passed? Loading history...
105			*
106			* @return mixed
107			*/
108			public function reduce(callable $fn, $initial = null)
109			{
110			return array_reduce($this->all(), $fn, $initial);
111			}
112
113			public function unique(): self
114			{
115			return new self(array_unique($this->all()));
116			}
117
118			public function diff(Collection $collection, callable $comparator = null): self
119			{
120			return new self(array_udiff($this->all(), $collection->all(), $comparator ?? self::getObjectSafeComparator()));
121			}
122
123			public function merge(Collection $collection): self
124			{
125			return new self(array_merge($this->all(), $collection->all()));
126			}
127
128			public function union(Collection $collection): self
129			{
130			return $this->merge($collection)->unique();
131			}
132
133			public function intersect(Collection $collection): self
134			{
135			return new self(array_intersect($this->all(), $collection->all()));
136			}
137
138			public function sort(callable $comparator = null): self
139			{
140			$items = $this->all();
141			uasort($items, $comparator ?? self::getObjectSafeComparator());
142
143			return new self($items);
144			}
145
146			public function kSort(callable $comparator = null): self
147			{
148			$items = $this->all();
149			uksort($items, $comparator ?? self::getStringComparator());
150
151			return new self($items);
152			}
153
154			public function empty(): bool
155			{
156			return $this->count() === 0;
157			}
158
159			public function all(): array
160			{
161			if (isset($this->deferredValues) && $this->deferredValues->valid()) {
162			$this->items = $this->unwrapDeferred();
163			}
164
165			return $this->items;
166			}
167
168			public function reIndex(): self
169			{
170			return new self($this->values());
171			}
172
173			public function chunk(int $size, callable $fn): self
174			{
175			$deferred = function () use ($size, $fn) {
176			foreach(array_chunk($this->all(), $size, true) as $chunk) {
177			foreach($chunk as $index => $value) {
178			yield $index => $fn($value, $index);
179			}
180			}
181			};
182
183			// do the work later and revalidate processed values
184			return self::later($deferred());
185			}
186
187			public function deferred(): \Generator
188			{
189			foreach ($this->all() as $key => $value) {
190			yield $key => $value;
191			}
192			}
193
194			public function values(): array
195			{
196			return array_values($this->all());
197			}
198
199			public function equals(Collection $collection): bool
200			{
201			return $this->diff($collection)->empty();
202			}
203
204			/**
205			* @param string\|int $offset
206			*
207			* @return bool
208			*/
209			public function has($offset): bool
210			{
211			return isset($this->all()[$offset]);
212			}
213
214			/**
215			* @param mixed $item
216			*
217			* @return bool
218			*/
219			public function contains($item): bool
220			{
221			return in_array($item, $this->all(), true);
222			}
223
224			public function some(callable $evaluation): bool
225			{
226			foreach ($this->all() as $key => $value) {
227			if ($evaluation($value, $key) === true) {
228			return true;
229			}
230			}
231
232			return false;
233			}
234
235			/**
236			* @param string\|int $offset
237			* @param mixed\|null $default
238			*
239			* @return mixed\|null
240			*/
241			public function get($offset, $default = null)
242			{
243			return $this->all()[$offset] ?? $default;
244			}
245
246			/**
247			* @return mixed
248			*/
249			public function rand()
250			{
251			return $this->all()[array_rand($this->all())];
252			}
253
254			/**
255			* @param string\|int $offset
256			*/
257			public function remove(...$offsets): self
258			{
259			$withRemoved = new static($this->all());
260			foreach ($offsets as $offset) {
261			unset($withRemoved->items[$offset]);
262			}
263
264			return $withRemoved;
265			}
266
267			public function getIterator(): \ArrayIterator
268			{
269			return new \ArrayIterator($this->all());
270			}
271
272			public function serialize(): string
273			{
274			return \serialize(['items' => $this->all()]);
275			}
276
277			public function unserialize($serialized, array $classnames = [])
278			{
279			if (isset($this->items)) {
280			throw new \LogicException('Cannot unserialize instance of collection');
281			}
282
283			$this->items = \unserialize($serialized, $classnames)['items'] ?? [];
284			}
285
286			public function jsonSerialize(): array
287			{
288			return $this->all();
289			}
290
291			private function unwrapDeferred(): array
292			{
293			$items = [];
294			foreach ($this->deferredValues as $key => $item) {
295			self::validateItem($item);
296			$items[$key] = $item;
297			}
298
299			return $items;
300			}
301
302			/**
303			* @throw \InvalidArgumentException
304			*/
305			private static function validateItems(array $items): void
306			{
307			foreach ($items as $item) {
308			self::validateItem($item);
309			}
310			}
311
312			private static function validateItem($item): void
313			{
314			if (is_iterable($item)) {
315			throw new \InvalidArgumentException('A collection may only contain numbers, strings, or objects');
316			}
317			}
318
319			private static function getStringComparator(): callable
320			{
321			return function ($a, $b): int {
322			return strcmp((string) $a, (string) $b);
323			};
324			}
325
326			private static function getObjectSafeComparator(): callable
327			{
328			return function ($a, $b): int {
329			return (\gettype($a) === \gettype($b)) ? $a <=> $b : -1;
330			};
331			}
332			}
333

remotelyliving / php-collection

Push — master ( 7ec2e5...c9861a )

Collection::getStringComparator() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like