RandomIteratorAggregate::getIterator() - Code Metrics - Inspection of "feat: Add `RandomIteratorAggregate`." - loophp/iterators - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#3)

by Pol

created 2021-12-20 12:43 UTC

RandomIteratorAggregate::getIterator() A

↳ Parent: RandomIteratorAggregate

Complexity

Conditions	4
Paths	4

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/**
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

declare(strict_types=1);

namespace loophp\iterators;

use Iterator;
use IteratorAggregate;
use Traversable;

use const PHP_INT_MAX;
use const PHP_INT_MIN;

/**
 * @template TKey
 * @template T
 *
 * @implements IteratorAggregate<TKey, T>
 */
final class RandomIteratorAggregate implements IteratorAggregate
{
    /**
     * @var IteratorAggregate<TKey, T>
     */
    private IteratorAggregate $iteratorAggregate;

    private int $seed;

    /**
     * @param Iterator<TKey, T> $iterator
     */
    public function __construct(Iterator $iterator, ?int $seed = null)
    {
        $this->iteratorAggregate = new CachingIteratorAggregate($iterator);
        $this->seed = $seed ?? random_int(PHP_INT_MIN, PHP_INT_MAX);
    }

    /**
     * @return Traversable<TKey, T>
     */
    public function getIterator(): Traversable
    {
        $indexes = $this->predictableRandomArray(
            range(0, iterator_count($this->iteratorAggregate->getIterator()) - 1),
            $this->seed
        );

        $i = 0;

        foreach ($indexes as $index) {
            foreach ($this->iteratorAggregate as $k => $v) {
                if ($indexes[$index] === $i++) {
                    yield $k => $v;
                    $i = 0;

                    continue 2;
                }
            }
        }
    }

    /**
     * @param array<int, int> $array
     *
     * @return array<int, int>
     */
    private function predictableRandomArray(array $array, int $seed): array
    {
        mt_srand($seed);
        shuffle($array);
        mt_srand();

        return $array;
    }
}


1			<?php
2
3			/**
4			* For the full copyright and license information, please view
5			* the LICENSE file that was distributed with this source code.
6			*/
7
8			declare(strict_types=1);
9
10			namespace loophp\iterators;
11
12			use Iterator;
13			use IteratorAggregate;
14			use Traversable;
15
16			use const PHP_INT_MAX;
17			use const PHP_INT_MIN;
18
19			/**
20			* @template TKey
21			* @template T
22			*
23			* @implements IteratorAggregate<TKey, T>
24			*/
25			final class RandomIteratorAggregate implements IteratorAggregate
26			{
27			/**
28			* @var IteratorAggregate<TKey, T>
29			*/
30			private IteratorAggregate $iteratorAggregate;
31
32			private int $seed;
33
34			/**
35			* @param Iterator<TKey, T> $iterator
36			*/
37			public function __construct(Iterator $iterator, ?int $seed = null)
38			{
39			$this->iteratorAggregate = new CachingIteratorAggregate($iterator);
40			$this->seed = $seed ?? random_int(PHP_INT_MIN, PHP_INT_MAX);
41			}
42
43			/**
44			* @return Traversable<TKey, T>
45			*/
46			public function getIterator(): Traversable
47			{
48			$indexes = $this->predictableRandomArray(
49			range(0, iterator_count($this->iteratorAggregate->getIterator()) - 1),
50			$this->seed
51			);
52
53			$i = 0;
54
55			foreach ($indexes as $index) {
56			foreach ($this->iteratorAggregate as $k => $v) {
57			if ($indexes[$index] === $i++) {
58			yield $k => $v;
59			$i = 0;
60
61			continue 2;
62			}
63			}
64			}
65			}
66
67			/**
68			* @param array<int, int> $array
69			*
70			* @return array<int, int>
71			*/
72			private function predictableRandomArray(array $array, int $seed): array
73			{
74			mt_srand($seed);
75			shuffle($array);
76			mt_srand();
77
78			return $array;
79			}
80			}
81

loophp / iterators

Pull Request — main (#3)

RandomIteratorAggregate::getIterator() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like