ShuffleIterator::rewind() - Code Metrics - gielfeldt/iterators - Measure and Improve Code Quality continuously with Scrutinizer

ShuffleIterator::rewind() A
last analyzed 2018-11-04 00:57 UTC

↳ Parent: ShuffleIterator

Complexity

Conditions	5
Paths	10

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	5

Importance

Changes

Metric	Value
dl	0
loc	17
rs	9.3888
c	0
b	0
f	0
ccs	11
cts	11
cp	1
cc	5
nc	10
nop	0
crap	5

<?php

namespace Gielfeldt\Iterators;

class ShuffleIterator extends ReplaceableIterator implements \Countable
{
    private $min = INF;
    private $max = -INF;
    private $innerIterator;

    public function __construct(\Traversable $iterator)
    {
        $this->innerIterator = $iterator;
        parent::__construct(new \ArrayIterator());
    }

    public function rewind()
    {
        $shuffledIterator = new \ArrayIterator();
        $items = [];
        foreach ($this->innerIterator as $key => $value) {
            $items[] = $this->generateElement($key, $value, $this->innerIterator);
            $this->min = $this->min < $value ? $this->min : $value;
            $this->max = $this->max > $value ? $this->max : $value;
        }

        shuffle($items);

        foreach ($items as $data) {
            $shuffledIterator[$data->key] = $data->current;
        }
        $this->setInnerIterator($shuffledIterator);
    }

    /**
     * @param \Traversable $iterator
     */
    protected function generateElement($key, $value, $iterator)

    {
        return (object) ['key' => $key, 'current' => $value];
    }

    public function count()
    {
        return $this->getInnerIterator()->count();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function first()
    {
        $count = $this->getInnerIterator()->count();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $count ? $this->getInnerIterator()[0] : null;
    }

    public function last()
    {
        $count = $this->getInnerIterator()->count();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $count ? $this->getInnerIterator()[$count - 1] : null;
    }

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

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


1		<?php
2
3		namespace Gielfeldt\Iterators;
4
5		class ShuffleIterator extends ReplaceableIterator implements \Countable
6		{
7		private $min = INF;
8		private $max = -INF;
9		private $innerIterator;
10	1
11		public function __construct(\Traversable $iterator)
12	1	{
13	1	$this->innerIterator = $iterator;
14		parent::__construct(new \ArrayIterator());
15		}
16
17		public function rewind()
18	1	{
19		$shuffledIterator = new \ArrayIterator();
20	1	$items = [];
21	1	foreach ($this->innerIterator as $key => $value) {
22	1	$items[] = $this->generateElement($key, $value, $this->innerIterator);
23	1	$this->min = $this->min < $value ? $this->min : $value;
24	1	$this->max = $this->max > $value ? $this->max : $value;
25	1	}
26
27		shuffle($items);
28	1
29		foreach ($items as $data) {
30	1	$shuffledIterator[$data->key] = $data->current;
31	1	}
32		$this->setInnerIterator($shuffledIterator);
33	1	}
34
35		/**
36		* @param \Traversable $iterator
37		*/
38		protected function generateElement($key, $value, $iterator)
		0 ignored issues – show Unused Code introduced 2018-11-04 00:57 UTC by Report Bug Copy Issue Report The parameter `$iterator` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
39	1	{
40		return (object) ['key' => $key, 'current' => $value];
41	1	}
42
43		public function count()
44	1	{
45		return $this->getInnerIterator()->count();
		0 ignored issues – show Bug introduced 2018-11-04 00:57 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Iterator` as the method `count()` does only exist in the following implementations of said interface: `ArrayIterator`, `CachingIterator`, `Gielfeldt\Iterators\CachingIterator`, `Gielfeldt\Iterators\CountableIterator`, `Gielfeldt\Iterators\CsvFileObject`, `Gielfeldt\Iterators\GlobIterator`, `Gielfeldt\Iterators\IndexIterator`, `Gielfeldt\Iterators\OrderedInterleaveIterator`, `Gielfeldt\Iterators\RecursiveSortIterator`, `Gielfeldt\Iterators\RepeatIterator`, `Gielfeldt\Iterators\ShuffleIterator`, `Gielfeldt\Iterators\SortIterator`, `GlobIterator`, `HttpMessage`, `HttpRequestPool`, `Issue523`, `MongoCursor`, `MongoGridFSCursor`, `PHP_CodeSniffer\Files\FileList`, `PHP_Token_Stream`, `Phar`, `PharData`, `Predis\Response\Iterator\MultiBulk`, `Predis\Response\Iterator\MultiBulkIterator`, `Predis\Response\Iterator\MultiBulkTuple`, `RecursiveArrayIterator`, `RecursiveCachingIterator`, `SQLiteResult`, `SimpleXMLIterator`, `SplDoublyLinkedList`, `SplFixedArray`, `SplHeap`, `SplMaxHeap`, `SplMinHeap`, `SplObjectStorage`, `SplPriorityQueue`, `SplQueue`, `SplStack`, `TheSeer\Tokenizer\TokenCollection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
46	1	}
47
48		public function first()
49	1	{
50		$count = $this->getInnerIterator()->count();
		0 ignored issues – show Bug introduced 2018-11-04 00:57 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Iterator` as the method `count()` does only exist in the following implementations of said interface: `ArrayIterator`, `CachingIterator`, `Gielfeldt\Iterators\CachingIterator`, `Gielfeldt\Iterators\CountableIterator`, `Gielfeldt\Iterators\CsvFileObject`, `Gielfeldt\Iterators\GlobIterator`, `Gielfeldt\Iterators\IndexIterator`, `Gielfeldt\Iterators\OrderedInterleaveIterator`, `Gielfeldt\Iterators\RecursiveSortIterator`, `Gielfeldt\Iterators\RepeatIterator`, `Gielfeldt\Iterators\ShuffleIterator`, `Gielfeldt\Iterators\SortIterator`, `GlobIterator`, `HttpMessage`, `HttpRequestPool`, `Issue523`, `MongoCursor`, `MongoGridFSCursor`, `PHP_CodeSniffer\Files\FileList`, `PHP_Token_Stream`, `Phar`, `PharData`, `Predis\Response\Iterator\MultiBulk`, `Predis\Response\Iterator\MultiBulkIterator`, `Predis\Response\Iterator\MultiBulkTuple`, `RecursiveArrayIterator`, `RecursiveCachingIterator`, `SQLiteResult`, `SimpleXMLIterator`, `SplDoublyLinkedList`, `SplFixedArray`, `SplHeap`, `SplMaxHeap`, `SplMinHeap`, `SplObjectStorage`, `SplPriorityQueue`, `SplQueue`, `SplStack`, `TheSeer\Tokenizer\TokenCollection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
51	1	return $count ? $this->getInnerIterator()[0] : null;
52		}
53
54	1	public function last()
55		{
56	1	$count = $this->getInnerIterator()->count();
		0 ignored issues – show Bug introduced 2018-11-04 00:57 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Iterator` as the method `count()` does only exist in the following implementations of said interface: `ArrayIterator`, `CachingIterator`, `Gielfeldt\Iterators\CachingIterator`, `Gielfeldt\Iterators\CountableIterator`, `Gielfeldt\Iterators\CsvFileObject`, `Gielfeldt\Iterators\GlobIterator`, `Gielfeldt\Iterators\IndexIterator`, `Gielfeldt\Iterators\OrderedInterleaveIterator`, `Gielfeldt\Iterators\RecursiveSortIterator`, `Gielfeldt\Iterators\RepeatIterator`, `Gielfeldt\Iterators\ShuffleIterator`, `Gielfeldt\Iterators\SortIterator`, `GlobIterator`, `HttpMessage`, `HttpRequestPool`, `Issue523`, `MongoCursor`, `MongoGridFSCursor`, `PHP_CodeSniffer\Files\FileList`, `PHP_Token_Stream`, `Phar`, `PharData`, `Predis\Response\Iterator\MultiBulk`, `Predis\Response\Iterator\MultiBulkIterator`, `Predis\Response\Iterator\MultiBulkTuple`, `RecursiveArrayIterator`, `RecursiveCachingIterator`, `SQLiteResult`, `SimpleXMLIterator`, `SplDoublyLinkedList`, `SplFixedArray`, `SplHeap`, `SplMaxHeap`, `SplMinHeap`, `SplObjectStorage`, `SplPriorityQueue`, `SplQueue`, `SplStack`, `TheSeer\Tokenizer\TokenCollection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
57		return $count ? $this->getInnerIterator()[$count - 1] : null;
58		}
59	1
60		public function min()
61	1	{
62	1	return $this->min;
63		}
64
65	1	public function max()
66		{
67	1	return $this->max;
68	1	}
69		}
70

gielfeldt / iterators

GitHub Access Token became invalid

ShuffleIterator::rewind() A last analyzed 2018-11-04 00:57 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

ShuffleIterator::rewind() A
last analyzed 2018-11-04 00:57 UTC