GroupbyIterator - Code Metrics - Inspection of "Feature/code coverage" - zicht/itertools - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#18)

unknown

created 2017-01-31 17:08 UTC

GroupbyIterator C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	24

Test Coverage

Coverage

73.91%

Importance

Changes	4
Bugs	0	Features	2

Metric	Value
dl	0
loc	75
ccs	17
cts	23
cp	0.7391
rs	5.238
c	4
b	0
f	2
wmc	7
lcom	0
cbo	24

4 Methods

Rating	Name	Size	Complexity
A	key()	4	1
A	count()	4	1
A	__construct()	20	4
A	toArray()	12	1

<?php

namespace Zicht\Itertools\lib;

use Zicht\Itertools\lib\Traits\AllTrait;
use Zicht\Itertools\lib\Traits\AnyTrait;
use Zicht\Itertools\lib\Traits\ArrayAccessTrait;
use Zicht\Itertools\lib\Traits\ChainTrait;
use Zicht\Itertools\lib\Traits\CycleTrait;
use Zicht\Itertools\lib\Traits\DebugInfoTrait;
use Zicht\Itertools\lib\Traits\FilterTrait;
use Zicht\Itertools\lib\Traits\FirstTrait;
use Zicht\Itertools\lib\Traits\GetterTrait;
use Zicht\Itertools\lib\Traits\GroupByTrait;
use Zicht\Itertools\lib\Traits\ItemsTrait;
use Zicht\Itertools\lib\Traits\KeysTrait;
use Zicht\Itertools\lib\Traits\LastTrait;
use Zicht\Itertools\lib\Traits\MapByTrait;
use Zicht\Itertools\lib\Traits\MapTrait;
use Zicht\Itertools\lib\Traits\ReduceTrait;
use Zicht\Itertools\lib\Traits\ReversedTrait;
use Zicht\Itertools\lib\Traits\SliceTrait;
use Zicht\Itertools\lib\Traits\SortedTrait;
use Zicht\Itertools\lib\Traits\ToArrayTrait;
use Zicht\Itertools\lib\Traits\UniqueTrait;
use Zicht\Itertools\lib\Traits\ValuesTrait;
use Zicht\Itertools\lib\Traits\ZipTrait;

// todo: add unit tests for Countable interface
// todo: add unit tests for ArrayAccess interface
// todo: place the two classed in their own file

class GroupedIterator extends \IteratorIterator implements \Countable, \ArrayAccess
{
    use ArrayAccessTrait;
    use DebugInfoTrait;
    use GetterTrait;

    // Fluent interface traits
    use AllTrait;
    use AnyTrait;
    use ChainTrait;
    use CycleTrait;
    use FilterTrait;
    use FirstTrait;
    use GroupByTrait;
    use ItemsTrait;
    use KeysTrait;
    use LastTrait;
    use MapByTrait;
    use MapTrait;
    use ReduceTrait;
    use ReversedTrait;
    use SliceTrait;
    use SortedTrait;
    use ToArrayTrait;
    use UniqueTrait;
    use ValuesTrait;
    use ZipTrait;

    protected $groupKey;
    protected $values;

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

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

    public function append($key, $value)
    {
        $this->getInnerIterator()->append(array($key, $value));
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 current()
    {
        return $this->getInnerIterator()->current()[1];
    }

    public function key()
    {
        return $this->getInnerIterator()->current()[0];
    }

    public function count()
    {
        return iterator_count($this->getInnerIterator());
    }
}

class GroupbyIterator extends \IteratorIterator implements \Countable, \ArrayAccess

{
    use ArrayAccessTrait;
    use DebugInfoTrait;
    use GetterTrait;

    // Fluent interface traits
    use AllTrait;
    use AnyTrait;
    use ChainTrait;
    use CycleTrait;
    use FilterTrait;
    use FirstTrait;
    use GroupByTrait;
    use ItemsTrait;
    use KeysTrait;
    use LastTrait;
    use MapByTrait;
    use MapTrait;
    use ReduceTrait;
    use ReversedTrait;
    use SliceTrait;
    use SortedTrait;
    use ToArrayTrait;
    use UniqueTrait;
    use ValuesTrait;
    use ZipTrait;

    public function __construct(\Closure $func, \Iterator $iterable)
    {
        // todo: this implementation pre-computes everything... this is
        // not the way an iterator should work.  Please re-write.
        $groupedIterator = null;
        $previousGroupKey = null;
        $data = array();

        foreach ($iterable as $key => $value) {
            $groupKey = call_user_func($func, $value, $key);
            if ($previousGroupKey !== $groupKey || $groupedIterator === null) {
                $previousGroupKey = $groupKey;
                $groupedIterator = new GroupedIterator($groupKey);
                $data [] = $groupedIterator;
            }
            $groupedIterator->append($key, $value);
        }

        parent::__construct(new \ArrayIterator($data));
    }

    public function key()
    {
        return $this->current()->getGroupKey();
    }

    public function count()
    {
        return iterator_count($this->getInnerIterator());
    }

    /**
     * @{inheritDoc}
     */
    public function toArray()
    {
        $array = iterator_to_array($this);
        array_walk(
            $array,
            function (&$value) {
                /** @var GroupedIterator $value */
                $value = $value->toArray();
            }
        );
        return $array;
    }
}


1		<?php
2
3		namespace Zicht\Itertools\lib;
4
5		use Zicht\Itertools\lib\Traits\AllTrait;
6		use Zicht\Itertools\lib\Traits\AnyTrait;
7		use Zicht\Itertools\lib\Traits\ArrayAccessTrait;
8		use Zicht\Itertools\lib\Traits\ChainTrait;
9		use Zicht\Itertools\lib\Traits\CycleTrait;
10		use Zicht\Itertools\lib\Traits\DebugInfoTrait;
11		use Zicht\Itertools\lib\Traits\FilterTrait;
12		use Zicht\Itertools\lib\Traits\FirstTrait;
13		use Zicht\Itertools\lib\Traits\GetterTrait;
14		use Zicht\Itertools\lib\Traits\GroupByTrait;
15		use Zicht\Itertools\lib\Traits\ItemsTrait;
16		use Zicht\Itertools\lib\Traits\KeysTrait;
17		use Zicht\Itertools\lib\Traits\LastTrait;
18		use Zicht\Itertools\lib\Traits\MapByTrait;
19		use Zicht\Itertools\lib\Traits\MapTrait;
20		use Zicht\Itertools\lib\Traits\ReduceTrait;
21		use Zicht\Itertools\lib\Traits\ReversedTrait;
22		use Zicht\Itertools\lib\Traits\SliceTrait;
23		use Zicht\Itertools\lib\Traits\SortedTrait;
24		use Zicht\Itertools\lib\Traits\ToArrayTrait;
25		use Zicht\Itertools\lib\Traits\UniqueTrait;
26		use Zicht\Itertools\lib\Traits\ValuesTrait;
27		use Zicht\Itertools\lib\Traits\ZipTrait;
28
29		// todo: add unit tests for Countable interface
30		// todo: add unit tests for ArrayAccess interface
31		// todo: place the two classed in their own file
32
33		class GroupedIterator extends \IteratorIterator implements \Countable, \ArrayAccess
34		{
35		use ArrayAccessTrait;
36		use DebugInfoTrait;
37		use GetterTrait;
38
39		// Fluent interface traits
40		use AllTrait;
41		use AnyTrait;
42		use ChainTrait;
43		use CycleTrait;
44		use FilterTrait;
45		use FirstTrait;
46		use GroupByTrait;
47		use ItemsTrait;
48		use KeysTrait;
49		use LastTrait;
50		use MapByTrait;
51		use MapTrait;
52		use ReduceTrait;
53		use ReversedTrait;
54		use SliceTrait;
55		use SortedTrait;
56		use ToArrayTrait;
57		use UniqueTrait;
58		use ValuesTrait;
59		use ZipTrait;
60
61		protected $groupKey;
62		protected $values;
63
64	13	public function __construct($groupKey)
65		{
66	13	$this->groupKey = $groupKey;
67	13	parent::__construct(new \ArrayIterator());
68	13	}
69
70	12	public function getGroupKey()
71		{
72	12	return $this->groupKey;
73		}
74
75	13	public function append($key, $value)
76		{
77	13	$this->getInnerIterator()->append(array($key, $value));
		0 ignored issues – show Bug introduced 2017-01-12 12:49 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Iterator` as the method `append()` does only exist in the following implementations of said interface: `AppendIterator`, `ArrayIterator`, `Issue523`, `RecursiveArrayIterator`, `Zicht\Itertools\lib\ChainIterator`, `Zicht\Itertools\lib\GroupedIterator`. 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...
78	13	}
79
80	12	public function current()
81		{
82	12	return $this->getInnerIterator()->current()[1];
83		}
84
85	12	public function key()
86		{
87	12	return $this->getInnerIterator()->current()[0];
88		}
89
90	11	public function count()
91		{
92	11	return iterator_count($this->getInnerIterator());
93		}
94		}
95
96		class GroupbyIterator extends \IteratorIterator implements \Countable, \ArrayAccess
		0 ignored issues – show Coding Style Compatibility introduced 2017-01-12 12:49 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
97		{
98		use ArrayAccessTrait;
99		use DebugInfoTrait;
100		use GetterTrait;
101
102		// Fluent interface traits
103		use AllTrait;
104		use AnyTrait;
105		use ChainTrait;
106		use CycleTrait;
107		use FilterTrait;
108		use FirstTrait;
109		use GroupByTrait;
110		use ItemsTrait;
111		use KeysTrait;
112		use LastTrait;
113		use MapByTrait;
114		use MapTrait;
115		use ReduceTrait;
116		use ReversedTrait;
117		use SliceTrait;
118		use SortedTrait;
119		use ToArrayTrait;
120		use UniqueTrait;
121		use ValuesTrait;
122		use ZipTrait;
123
124	13	public function __construct(\Closure $func, \Iterator $iterable)
125		{
126		// todo: this implementation pre-computes everything... this is
127		// not the way an iterator should work. Please re-write.
128	13	$groupedIterator = null;
129	13	$previousGroupKey = null;
130	13	$data = array();
131
132	13	foreach ($iterable as $key => $value) {
133	13	$groupKey = call_user_func($func, $value, $key);
134	13	if ($previousGroupKey !== $groupKey \|\| $groupedIterator === null) {
135	13	$previousGroupKey = $groupKey;
136	13	$groupedIterator = new GroupedIterator($groupKey);
137	13	$data [] = $groupedIterator;
138		}
139	13	$groupedIterator->append($key, $value);
140		}
141
142	13	parent::__construct(new \ArrayIterator($data));
143	13	}
144
145	12	public function key()
146		{
147	12	return $this->current()->getGroupKey();
148		}
149
150	11	public function count()
151		{
152	11	return iterator_count($this->getInnerIterator());
153		}
154
155		/**
156		* @{inheritDoc}
157		*/
158		public function toArray()
159		{
160		$array = iterator_to_array($this);
161		array_walk(
162		$array,
163		function (&$value) {
164		/** @var GroupedIterator $value */
165		$value = $value->toArray();
166		}
167		);
168		return $array;
169		}
170		}
171

zicht / itertools

Pull Request — master (#18)

GroupbyIterator C

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like