EquatableMap::__construct() - Code Metrics - Inspection of "Remove Map & Vector interfaces, rename classes, ma..." - f500/equatable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( beb630...0f844e )

by Jasper

created 2017-11-10 12:06 UTC

EquatableMap::__construct() A

↳ Parent: EquatableMap

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	10
Ratio	100 %

Importance

Changes

Metric	Value
dl	10
loc	10
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	5
nc	3
nop	1

<?php

/**
 * @license https://github.com/f500/equatable/blob/master/LICENSE MIT
 */

declare(strict_types=1);

namespace F500\Equatable;

use ArrayIterator;
use Countable;
use IteratorAggregate;
use Traversable;

/**
 * @copyright Copyright (c) 2015 Future500 B.V.
 * @author    Jasper N. Brouwer <[email protected]>
 */
final class EquatableMap implements Equatable, Countable, IteratorAggregate
{
    /**
     * @var Equatable[]
     */
    private $items = [];

    /**
     * @param Equatable[] $items
     */
    public function __construct(array $items = [])

    {
        foreach ($items as $key => $value) {
            if (!$value instanceof Equatable) {
                throw InvalidArgumentException::invalidTypeInArray('items', Equatable::class, $value);
            }

            $this->items[$key] = $value;
        }
    }

    public function __clone()

    {
        $items = [];

        foreach ($this->items as $key => $item) {
            $items[$key] = clone $item;
        }

        $this->items = $items;
    }

    public function add(string $key, Equatable $value): EquatableMap

    {
        if ($this->containsKey($key)) {
            throw InRangeException::keyInRange($key);
        }

        $items = $this->items;

        $items[$key] = $value;

        return new static($items);
    }

    public function remove(Equatable $value): EquatableMap

    {
        $key   = $this->search($value);
        $items = $this->items;

        unset($items[$key]);

        return new static($items);
    }

    public function replace(string $key, Equatable $value): EquatableMap

    {
        if (!$this->containsKey($key)) {
            throw OutOfRangeException::keyOutOfRange($key);
        }

        $items = $this->items;

        $items[$key] = $value;

        return new static($items);
    }

    public function get(string $key): Equatable
    {
        if (!$this->containsKey($key)) {
            throw OutOfRangeException::keyOutOfRange($key);
        }

        return $this->items[$key];
    }

    public function search(Equatable $value): string

    {
        foreach ($this->items as $key => $item) {
            if ($item->equals($value)) {
                return $key;
            }
        }

        throw OutOfRangeException::valueOutOfRange($value);
    }

    public function searchAll(Equatable $value): array

    {
        $foundKeys = [];

        foreach ($this->items as $index => $item) {
            if ($item->equals($value)) {
                $foundKeys[] = $index;
            }
        }

        if (!$foundKeys) {

            throw OutOfRangeException::valueOutOfRange($value);
        }

        return $foundKeys;
    }

    public function contains(Equatable $value): bool
    {
        try {
            $this->search($value);
            return true;
        } catch (OutOfRangeException $e) {
            return false;
        }
    }

    public function containsKey(string $key): bool
    {
        return isset($this->items[$key]);
    }

    public function equals($other): bool

    {
        if (!$other instanceof static) {
            return false;
        }

        if ($this->count() !== $other->count()) {
            return false;
        }

        foreach ($this->items as $item) {
            if ($this->countItem($item) !== $other->countItem($item)) {
                return false;
            }
        }

        return true;
    }

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

    public function countItem(Equatable $value): int

    {
        $count = 0;

        foreach ($this->items as $item) {
            if ($item->equals($value)) {
                $count++;
            }
        }

        return $count;
    }

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


1		<?php
2
3		/**
4		* @license https://github.com/f500/equatable/blob/master/LICENSE MIT
5		*/
6
7		declare(strict_types=1);
8
9		namespace F500\Equatable;
10
11		use ArrayIterator;
12		use Countable;
13		use IteratorAggregate;
14		use Traversable;
15
16		/**
17		* @copyright Copyright (c) 2015 Future500 B.V.
18		* @author Jasper N. Brouwer <[email protected]>
19		*/
20		final class EquatableMap implements Equatable, Countable, IteratorAggregate
21		{
22		/**
23		* @var Equatable[]
24		*/
25		private $items = [];
26
27		/**
28		* @param Equatable[] $items
29		*/
30	View Code Duplication	public function __construct(array $items = [])
		1 ignored issue – show Duplication introduced 2017-11-10 11:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
31		{
32		foreach ($items as $key => $value) {
33		if (!$value instanceof Equatable) {
34		throw InvalidArgumentException::invalidTypeInArray('items', Equatable::class, $value);
35		}
36
37		$this->items[$key] = $value;
38		}
39		}
40
41		public function __clone()
		0 ignored issues – show Duplication introduced 2017-11-10 11:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
42		{
43		$items = [];
44
45		foreach ($this->items as $key => $item) {
46		$items[$key] = clone $item;
47		}
48
49		$this->items = $items;
50		}
51
52	View Code Duplication	public function add(string $key, Equatable $value): EquatableMap
		1 ignored issue – show Duplication introduced 2017-11-10 11:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
53		{
54		if ($this->containsKey($key)) {
55		throw InRangeException::keyInRange($key);
56		}
57
58		$items = $this->items;
59
60		$items[$key] = $value;
61
62		return new static($items);
63		}
64
65	View Code Duplication	public function remove(Equatable $value): EquatableMap
		0 ignored issues – show Duplication introduced 2017-11-10 11:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
66		{
67		$key = $this->search($value);
68		$items = $this->items;
69
70		unset($items[$key]);
71
72		return new static($items);
73		}
74
75	View Code Duplication	public function replace(string $key, Equatable $value): EquatableMap
		1 ignored issue – show Duplication introduced 2017-11-10 11:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
76		{
77		if (!$this->containsKey($key)) {
78		throw OutOfRangeException::keyOutOfRange($key);
79		}
80
81		$items = $this->items;
82
83		$items[$key] = $value;
84
85		return new static($items);
86		}
87
88		public function get(string $key): Equatable
89		{
90		if (!$this->containsKey($key)) {
91		throw OutOfRangeException::keyOutOfRange($key);
92		}
93
94		return $this->items[$key];
95		}
96
97	View Code Duplication	public function search(Equatable $value): string
		0 ignored issues – show Duplication introduced 2017-11-10 11:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
98		{
99		foreach ($this->items as $key => $item) {
100		if ($item->equals($value)) {
101		return $key;
102		}
103		}
104
105		throw OutOfRangeException::valueOutOfRange($value);
106		}
107
108	View Code Duplication	public function searchAll(Equatable $value): array
		0 ignored issues – show Duplication introduced 2017-11-10 11:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
109		{
110		$foundKeys = [];
111
112		foreach ($this->items as $index => $item) {
113		if ($item->equals($value)) {
114		$foundKeys[] = $index;
115		}
116		}
117
118		if (!$foundKeys) {
		0 ignored issues – show Bug Best Practice introduced 2016-03-25 14:35 UTC by Report Bug Copy Issue Report The expression `$foundKeys` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
119		throw OutOfRangeException::valueOutOfRange($value);
120		}
121
122		return $foundKeys;
123		}
124
125		public function contains(Equatable $value): bool
126		{
127		try {
128		$this->search($value);
129		return true;
130		} catch (OutOfRangeException $e) {
131		return false;
132		}
133		}
134
135		public function containsKey(string $key): bool
136		{
137		return isset($this->items[$key]);
138		}
139
140	View Code Duplication	public function equals($other): bool
		0 ignored issues – show Duplication introduced 2017-11-10 11:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
141		{
142		if (!$other instanceof static) {
143		return false;
144		}
145
146		if ($this->count() !== $other->count()) {
147		return false;
148		}
149
150		foreach ($this->items as $item) {
151		if ($this->countItem($item) !== $other->countItem($item)) {
152		return false;
153		}
154		}
155
156		return true;
157		}
158
159		public function count(): int
160		{
161		return count($this->items);
162		}
163
164	View Code Duplication	public function countItem(Equatable $value): int
		0 ignored issues – show Duplication introduced 2017-11-10 11:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
165		{
166		$count = 0;
167
168		foreach ($this->items as $item) {
169		if ($item->equals($value)) {
170		$count++;
171		}
172		}
173
174		return $count;
175		}
176
177		public function getIterator(): Traversable
178		{
179		return new ArrayIterator($this->items);
180		}
181		}
182

f500 / equatable

GitHub Access Token became invalid

Push — master ( beb630...0f844e )

EquatableMap::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like