ObjectKeys::clear() - Code Metrics - Inspection of "add methods to check if the collections are of a s..." - Innmind/Immutable - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( c3b70c...588978 )

by Baptiste

created 2019-11-30 17:30 UTC

ObjectKeys::clear() A

↳ Parent: ObjectKeys

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	6
ccs	4
cts	4
cp	1
crap	1
rs	10

<?php
declare(strict_types = 1);

namespace Innmind\Immutable\Map;

use Innmind\Immutable\{
    Map,
    Type,
    Str,
    Stream,
    Set,
    Pair,
    SpecificationInterface,
    Specification\ClassType,
    Exception\InvalidArgumentException,
    Exception\LogicException,
    Exception\ElementNotFoundException,
    Exception\GroupEmptyMapException
};

/**
 * {@inheritdoc}
 */
final class ObjectKeys implements Implementation
{
    private string $keyType;
    private string $valueType;
    private SpecificationInterface $keySpecification;
    private SpecificationInterface $valueSpecification;
    private \SplObjectStorage $values;

    /**
     * {@inheritdoc}
     */
    public function __construct(string $keyType, string $valueType)
    {
        $this->keySpecification = Type::of($keyType);

        if (!$this->keySpecification instanceof ClassType && $keyType !== 'object') {
            throw new LogicException;
        }

        $this->valueSpecification = Type::of($valueType);
        $this->keyType = $keyType;
        $this->valueType = $valueType;
        $this->values = new \SplObjectStorage;
    }

    /**
     * {@inheritdoc}
     */
    public function keyType(): string
    {
        return $this->keyType;
    }

    /**
     * {@inheritdoc}
     */
    public function valueType(): string
    {
        return $this->valueType;
    }

    /**
     * {@inheritdoc}
     */
    public function size(): int
    {
        return $this->values->count();
    }

    /**
     * {@inheritdoc}
     */
    public function count(): int
    {
        return $this->size();
    }

    /**
     * {@inheritdoc}
     */
    public function put($key, $value): Implementation
    {
        $this->keySpecification->validate($key);
        $this->valueSpecification->validate($value);

        $map = clone $this;
        $map->values = clone $this->values;
        $map->values[$key] = $value;
        $map->values->rewind();

        return $map;
    }

    /**
     * {@inheritdoc}
     */
    public function get($key)
    {
        if (!$this->contains($key)) {
            throw new ElementNotFoundException;
        }

        return $this->values->offsetGet($key);
    }

    /**
     * {@inheritdoc}
     */
    public function contains($key): bool
    {
        if (!is_object($key)) {
            return false;
        }

        return $this->values->offsetExists($key);
    }

    /**
     * {@inheritdoc}
     */
    public function clear(): Implementation
    {
        $map = clone $this;
        $map->values = new \SplObjectStorage;

        return $map;
    }

    /**
     * {@inheritdoc}
     */
    public function equals(Implementation $map): bool
    {
        if ($map->size() !== $this->size()) {
            return false;
        }

        foreach ($this->values as $k) {
            $v = $this->values[$k];

            if (!$map->contains($k)) {
                return false;
            }

            if ($map->get($k) !== $v) {
                return false;
            }
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function filter(callable $predicate): Implementation
    {
        $map = $this->clear();

        foreach ($this->values as $k) {
            $v = $this->values[$k];

            if ($predicate($k, $v) === true) {
                $map->values[$k] = $v;
            }
        }

        $map->values->rewind();

        return $map;
    }

    /**
     * {@inheritdoc}
     */
    public function foreach(callable $function): void
    {
        foreach ($this->values as $k) {
            $v = $this->values[$k];

            $function($k, $v);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function groupBy(callable $discriminator): Map
    {
        if ($this->size() === 0) {
            throw new GroupEmptyMapException;
        }

        $map = null;

        foreach ($this->values as $k) {
            $v = $this->values[$k];

            $key = $discriminator($k, $v);

            if ($map === null) {
                $map = new Map(
                    Type::determine($key),
                    Map::class
                );
            }

            if ($map->contains($key)) {
                $map = $map->put(
                    $key,
                    $map->get($key)->put($k, $v)
                );
            } else {
                $map = $map->put(
                    $key,
                    $this->clearMap()->put($k, $v)
                );
            }
        }

        return $map;

    }

    /**
     * {@inheritdoc}
     */
    public function keys(): Set
    {
        return $this->reduce(
            Set::of($this->keyType),
            static function(Set $keys, $key): Set {
                return $keys->add($key);
            }
        );
    }

    /**
     * {@inheritdoc}
     */
    public function values(): Stream
    {
        return $this->reduce(
            Stream::of($this->valueType),
            static function(Stream $values, $key, $value): Stream {
                return $values->add($value);
            }
        );
    }

    /**
     * {@inheritdoc}
     */
    public function map(callable $function): Implementation
    {
        $map = $this->clear();

        foreach ($this->values as $k) {
            $v = $this->values[$k];

            $return = $function($k, $v);

            if ($return instanceof Pair) {
                $this->keySpecification->validate($return->key());

                $key = $return->key();
                $value = $return->value();
            } else {
                $key = $k;
                $value = $return;
            }

            $this->valueSpecification->validate($value);

            $map->values[$key] = $value;
        }

        $map->values->rewind();

        return $map;
    }

    /**
     * {@inheritdoc}
     */
    public function join(string $separator): Str
    {
        return $this->values()->join($separator);
    }

    /**
     * {@inheritdoc}
     */
    public function remove($key): Implementation
    {
        if (!$this->contains($key)) {
            return $this;
        }

        $map = clone $this;
        $map->values = clone $this->values;
        $map->values->detach($key);
        $map->values->rewind();

        return $map;
    }

    /**
     * {@inheritdoc}
     */
    public function merge(Implementation $map): Implementation
    {
        if (
            $this->keyType !== $map->keyType() ||
            $this->valueType !== $map->valueType()
        ) {
            throw new InvalidArgumentException(
                'The 2 maps does not reference the same types'
            );
        }

        return $map->reduce(
            $this,
            function(self $carry, $key, $value): self {
                return $carry->put($key, $value);
            }
        );
    }

    /**
     * {@inheritdoc}
     */
    public function partition(callable $predicate): Map
    {
        $truthy = $this->clearMap();
        $falsy = $this->clearMap();

        foreach ($this->values as $k) {
            $v = $this->values[$k];

            $return = $predicate($k, $v);

            if ($return === true) {
                $truthy = $truthy->put($k, $v);
            } else {
                $falsy = $falsy->put($k, $v);
            }
        }

        return Map::of('bool', Map::class)
            (true, $truthy)
            (false, $falsy);
    }

    /**
     * {@inheritdoc}
     */
    public function reduce($carry, callable $reducer)
    {
        foreach ($this->values as $k) {
            $v = $this->values[$k];

            $carry = $reducer($carry, $k, $v);
        }

        return $carry;
    }

    public function empty(): bool
    {
        $this->values->rewind();

        return !$this->values->valid();
    }

    /**
     * @return Map<T, S>
     */
    private function clearMap(): Map
    {
        return Map::of($this->keyType, $this->valueType);
    }
}


1		<?php
2		declare(strict_types = 1);
3
4		namespace Innmind\Immutable\Map;
5
6		use Innmind\Immutable\{
7		Map,
8		Type,
9		Str,
10		Stream,
11		Set,
12		Pair,
13		SpecificationInterface,
14		Specification\ClassType,
15		Exception\InvalidArgumentException,
16		Exception\LogicException,
17		Exception\ElementNotFoundException,
18		Exception\GroupEmptyMapException
19		};
20
21		/**
22		* {@inheritdoc}
23		*/
24		final class ObjectKeys implements Implementation
25		{
26		private string $keyType;
27		private string $valueType;
28		private SpecificationInterface $keySpecification;
29		private SpecificationInterface $valueSpecification;
30		private \SplObjectStorage $values;
31
32		/**
33		* {@inheritdoc}
34		*/
35	29	public function __construct(string $keyType, string $valueType)
36		{
37	29	$this->keySpecification = Type::of($keyType);
38
39	29	if (!$this->keySpecification instanceof ClassType && $keyType !== 'object') {
40	1	throw new LogicException;
41		}
42
43	28	$this->valueSpecification = Type::of($valueType);
44	28	$this->keyType = $keyType;
45	28	$this->valueType = $valueType;
46	28	$this->values = new \SplObjectStorage;
47	28	}
48
49		/**
50		* {@inheritdoc}
51		*/
52	10	public function keyType(): string
53		{
54	10	return $this->keyType;
55		}
56
57		/**
58		* {@inheritdoc}
59		*/
60	8	public function valueType(): string
61		{
62	8	return $this->valueType;
63		}
64
65		/**
66		* {@inheritdoc}
67		*/
68	8	public function size(): int
69		{
70	8	return $this->values->count();
71		}
72
73		/**
74		* {@inheritdoc}
75		*/
76		public function count(): int
77		{
78		return $this->size();
79		}
80
81		/**
82		* {@inheritdoc}
83		*/
84	23	public function put($key, $value): Implementation
85		{
86	23	$this->keySpecification->validate($key);
87	23	$this->valueSpecification->validate($value);
88
89	20	$map = clone $this;
90	20	$map->values = clone $this->values;
91	20	$map->values[$key] = $value;
92	20	$map->values->rewind();
93
94	20	return $map;
95		}
96
97		/**
98		* {@inheritdoc}
99		*/
100	7	public function get($key)
101		{
102	7	if (!$this->contains($key)) {
103	1	throw new ElementNotFoundException;
104		}
105
106	6	return $this->values->offsetGet($key);
107		}
108
109		/**
110		* {@inheritdoc}
111		*/
112	10	public function contains($key): bool
113		{
114	10	if (!is_object($key)) {
115	1	return false;
116		}
117
118	10	return $this->values->offsetExists($key);
119		}
120
121		/**
122		* {@inheritdoc}
123		*/
124	5	public function clear(): Implementation
125		{
126	5	$map = clone $this;
127	5	$map->values = new \SplObjectStorage;
128
129	5	return $map;
130		}
131
132		/**
133		* {@inheritdoc}
134		*/
135	3	public function equals(Implementation $map): bool
136		{
137	3	if ($map->size() !== $this->size()) {
138	1	return false;
139		}
140
141	3	foreach ($this->values as $k) {
142	3	$v = $this->values[$k];
143
144	3	if (!$map->contains($k)) {
145		return false;
146		}
147
148	3	if ($map->get($k) !== $v) {
149	3	return false;
150		}
151		}
152
153	1	return true;
154		}
155
156		/**
157		* {@inheritdoc}
158		*/
159	1	public function filter(callable $predicate): Implementation
160		{
161	1	$map = $this->clear();
162
163	1	foreach ($this->values as $k) {
164	1	$v = $this->values[$k];
165
166	1	if ($predicate($k, $v) === true) {
167	1	$map->values[$k] = $v;
168		}
169		}
170
171	1	$map->values->rewind();
172
173	1	return $map;
174		}
175
176		/**
177		* {@inheritdoc}
178		*/
179	1	public function foreach(callable $function): void
180		{
181	1	foreach ($this->values as $k) {
182	1	$v = $this->values[$k];
183
184	1	$function($k, $v);
185		}
186	1	}
187
188		/**
189		* {@inheritdoc}
190		*/
191	2	public function groupBy(callable $discriminator): Map
192		{
193	2	if ($this->size() === 0) {
194	1	throw new GroupEmptyMapException;
195		}
196
197	1	$map = null;
198
199	1	foreach ($this->values as $k) {
200	1	$v = $this->values[$k];
201
202	1	$key = $discriminator($k, $v);
203
204	1	if ($map === null) {
205	1	$map = new Map(
206	1	Type::determine($key),
207	1	Map::class
208		);
209		}
210
211	1	if ($map->contains($key)) {
212	1	$map = $map->put(
213	1	$key,
214	1	$map->get($key)->put($k, $v)
215		);
216		} else {
217	1	$map = $map->put(
218	1	$key,
219	1	$this->clearMap()->put($k, $v)
220		);
221		}
222		}
223
224	1	return $map;
		1 ignored issue – show Bug Best Practice introduced 2019-11-30 17:35 UTC by Report Bug Copy Issue Report The expression `return $map` could return the type `null` which is incompatible with the type-hinted return `Innmind\Immutable\Map`. Consider adding an additional type-check to rule them out. Loading history...
225		}
226
227		/**
228		* {@inheritdoc}
229		*/
230	7	public function keys(): Set
231		{
232	7	return $this->reduce(
233	7	Set::of($this->keyType),
234		static function(Set $keys, $key): Set {
235	7	return $keys->add($key);
236	7	}
237		);
238		}
239
240		/**
241		* {@inheritdoc}
242		*/
243	8	public function values(): Stream
244		{
245	8	return $this->reduce(
246	8	Stream::of($this->valueType),
247		static function(Stream $values, $key, $value): Stream {
248	8	return $values->add($value);
249	8	}
250		);
251		}
252
253		/**
254		* {@inheritdoc}
255		*/
256	3	public function map(callable $function): Implementation
257		{
258	3	$map = $this->clear();
259
260	3	foreach ($this->values as $k) {
261	3	$v = $this->values[$k];
262
263	3	$return = $function($k, $v);
264
265	3	if ($return instanceof Pair) {
266	2	$this->keySpecification->validate($return->key());
267
268	1	$key = $return->key();
269	1	$value = $return->value();
270		} else {
271	2	$key = $k;
272	2	$value = $return;
273		}
274
275	2	$this->valueSpecification->validate($value);
276
277	1	$map->values[$key] = $value;
278		}
279
280	1	$map->values->rewind();
281
282	1	return $map;
283		}
284
285		/**
286		* {@inheritdoc}
287		*/
288	1	public function join(string $separator): Str
289		{
290	1	return $this->values()->join($separator);
291		}
292
293		/**
294		* {@inheritdoc}
295		*/
296	1	public function remove($key): Implementation
297		{
298	1	if (!$this->contains($key)) {
299	1	return $this;
300		}
301
302	1	$map = clone $this;
303	1	$map->values = clone $this->values;
304	1	$map->values->detach($key);
305	1	$map->values->rewind();
306
307	1	return $map;
308		}
309
310		/**
311		* {@inheritdoc}
312		*/
313	3	public function merge(Implementation $map): Implementation
314		{
315		if (
316	3	$this->keyType !== $map->keyType() \|\|
317	3	$this->valueType !== $map->valueType()
318		) {
319	1	throw new InvalidArgumentException(
320	1	'The 2 maps does not reference the same types'
321		);
322		}
323
324	2	return $map->reduce(
325	2	$this,
326		function(self $carry, $key, $value): self {
327	2	return $carry->put($key, $value);
328	2	}
329		);
330		}
331
332		/**
333		* {@inheritdoc}
334		*/
335	1	public function partition(callable $predicate): Map
336		{
337	1	$truthy = $this->clearMap();
338	1	$falsy = $this->clearMap();
339
340	1	foreach ($this->values as $k) {
341	1	$v = $this->values[$k];
342
343	1	$return = $predicate($k, $v);
344
345	1	if ($return === true) {
346	1	$truthy = $truthy->put($k, $v);
347		} else {
348	1	$falsy = $falsy->put($k, $v);
349		}
350		}
351
352	1	return Map::of('bool', Map::class)
353	1	(true, $truthy)
354	1	(false, $falsy);
355		}
356
357		/**
358		* {@inheritdoc}
359		*/
360	9	public function reduce($carry, callable $reducer)
361		{
362	9	foreach ($this->values as $k) {
363	9	$v = $this->values[$k];
364
365	9	$carry = $reducer($carry, $k, $v);
366		}
367
368	9	return $carry;
369		}
370
371	1	public function empty(): bool
372		{
373	1	$this->values->rewind();
374
375	1	return !$this->values->valid();
376		}
377
378		/**
379		* @return Map<T, S>
380		*/
381	2	private function clearMap(): Map
382		{
383	2	return Map::of($this->keyType, $this->valueType);
384		}
385		}
386

Innmind / Immutable

GitHub Access Token became invalid

Push — develop ( c3b70c...588978 )

ObjectKeys::clear() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like