ShuffleIterator - Code Metrics - Inspection of "Refactor a bit." - gielfeldt/iterators - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0c8b13...b1ee3a )

by Thomas

created 2017-04-27 22:25 UTC

ShuffleIterator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	14
lcom	2
cbo	1
dl	0
loc	68
rs	10
c	1
b	0
f	0
ccs	29
cts	29
cp	1

8 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
B	rewind()	17	5
A	generateElement()	4	1
A	count()	4	1
A	first()	5	2
A	last()	5	2
A	min()	4	1
A	max()	4	1

<?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());
    }

    /**
     * @param \Traversable $iterator
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    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		/**
18	1	* @param \Traversable $iterator
		0 ignored issues – show Bug introduced 2017-04-27 22:27 UTC by Report Bug Copy Issue Report There is no parameter named `$iterator`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
19		*/
20	1	public function rewind()
21	1	{
22	1	$shuffledIterator = new \ArrayIterator();
23	1	$items = [];
24	1	foreach ($this->innerIterator as $key => $value) {
25	1	$items[] = $this->generateElement($key, $value, $this->innerIterator);
26		$this->min = $this->min < $value ? $this->min : $value;
27		$this->max = $this->max > $value ? $this->max : $value;
28	1	}
29
30	1	shuffle($items);
31	1
32		foreach ($items as $data) {
33	1	$shuffledIterator[$data->key] = $data->current;
34		}
35		$this->setInnerIterator($shuffledIterator);
36		}
37
38		/**
39	1	* @param \Traversable $iterator
40		*/
41	1	protected function generateElement($key, $value, $iterator)
		0 ignored issues – show Unused Code introduced 2017-04-23 09:45 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...
42		{
43		return (object) ['key' => $key, 'current' => $value];
44	1	}
45
46	1	public function count()
47		{
48		return $this->getInnerIterator()->count();
		0 ignored issues – show Bug introduced 2017-04-27 22:27 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`, `DoctrineTest\InstantiatorTestAsset\PharAsset`, `Gielfeldt\Iterators\CachingIterator`, `Gielfeldt\Iterators\CountableIterator`, `Gielfeldt\Iterators\CsvFileObject`, `Gielfeldt\Iterators\GlobIterator`, `Gielfeldt\Iterators\IndexIterator`, `Gielfeldt\Iterators\RecursiveSortIterator`, `Gielfeldt\Iterators\RepeatIterator`, `Gielfeldt\Iterators\ShuffleIterator`, `Gielfeldt\Iterators\SortIterator`, `GlobIterator`, `HttpMessage`, `HttpRequestPool`, `Issue523`, `MongoCursor`, `MongoGridFSCursor`, `PHP_Token_Stream`, `Phar`, `PharData`, `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...
49	1	}
50
51	1	public function first()
52		{
53		$count = $this->getInnerIterator()->count();
		0 ignored issues – show Bug introduced 2017-04-27 22:27 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`, `DoctrineTest\InstantiatorTestAsset\PharAsset`, `Gielfeldt\Iterators\CachingIterator`, `Gielfeldt\Iterators\CountableIterator`, `Gielfeldt\Iterators\CsvFileObject`, `Gielfeldt\Iterators\GlobIterator`, `Gielfeldt\Iterators\IndexIterator`, `Gielfeldt\Iterators\RecursiveSortIterator`, `Gielfeldt\Iterators\RepeatIterator`, `Gielfeldt\Iterators\ShuffleIterator`, `Gielfeldt\Iterators\SortIterator`, `GlobIterator`, `HttpMessage`, `HttpRequestPool`, `Issue523`, `MongoCursor`, `MongoGridFSCursor`, `PHP_Token_Stream`, `Phar`, `PharData`, `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...
54	1	return $count ? $this->getInnerIterator()[0] : null;
55		}
56	1
57		public function last()
58		{
59	1	$count = $this->getInnerIterator()->count();
		0 ignored issues – show Bug introduced 2017-04-27 22:27 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`, `DoctrineTest\InstantiatorTestAsset\PharAsset`, `Gielfeldt\Iterators\CachingIterator`, `Gielfeldt\Iterators\CountableIterator`, `Gielfeldt\Iterators\CsvFileObject`, `Gielfeldt\Iterators\GlobIterator`, `Gielfeldt\Iterators\IndexIterator`, `Gielfeldt\Iterators\RecursiveSortIterator`, `Gielfeldt\Iterators\RepeatIterator`, `Gielfeldt\Iterators\ShuffleIterator`, `Gielfeldt\Iterators\SortIterator`, `GlobIterator`, `HttpMessage`, `HttpRequestPool`, `Issue523`, `MongoCursor`, `MongoGridFSCursor`, `PHP_Token_Stream`, `Phar`, `PharData`, `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...
60		return $count ? $this->getInnerIterator()[$count - 1] : null;
61	1	}
62	1
63		public function min()
64		{
65	1	return $this->min;
66		}
67	1
68	1	public function max()
69		{
70		return $this->max;
71	1	}
72		}
73

gielfeldt / iterators

GitHub Access Token became invalid

Push — master ( 0c8b13...b1ee3a )

ShuffleIterator A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like