Primitive::equals() - Code Metrics - Innmind/Immutable - Measure and Improve Code Quality continuously with Scrutinizer

Primitive::equals() A
last analyzed 2022-07-02 13:48 UTC

↳ Parent: Primitive

Complexity

Conditions	4
Paths	4

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	12
c	1
b	0
f	0
nc	4
nop	1
dl	0
loc	21
rs	9.8666
ccs	9
cts	9
cp	1
crap	4

<?php
declare(strict_types = 1);

namespace Innmind\Immutable\Map;

use Innmind\Immutable\{
    Map,
    Str,
    Sequence,
    Set,
    Pair,
    Maybe,
    SideEffect,
};

/**
 * @template T
 * @template S
 * @psalm-immutable
 */
final class Primitive implements Implementation
{
    /** @var array<T, S> */
    private array $values;

    /**
     * @param array<T, S> $values
     */
    public function __construct(array $values = [])
    {
        $this->values = $values;
    }

    /**
     * @param T $key
filter:
    dependency_paths: ["lib/*"]
     * @param S $value
filter:
    dependency_paths: ["lib/*"]
     *
     * @return Implementation<T, S>
     */
    public function __invoke($key, $value): Implementation
    {
        /** @psalm-suppress DocblockTypeContradiction */
        if (\is_string($key) && \is_numeric($key)) {

            // numeric-string keys are casted to ints by php, so when iterating
            // over the array afterward the type is not conserved so we switch
            // the implementation to DoubleIndex so keep the type
            return (new DoubleIndex)->merge($this)($key, $value);
        }

        $values = $this->values;
        $values[$key] = $value;

        return new self($values);
    }

    /**
     * @template A
     * @template B
     *
     * @param A $key
filter:
    dependency_paths: ["lib/*"]
     * @param B $value
filter:
    dependency_paths: ["lib/*"]
     *
     * @return Maybe<Implementation<A, B>>
     */
    public static function of($key, $value): Maybe
    {
        /** @psalm-suppress DocblockTypeContradiction */
        if (\is_string($key) && \is_numeric($key)) {

            /** @var Maybe<Implementation<A, B>> */
            return Maybe::nothing();
        }

        if (\is_string($key) || \is_int($key)) {

            /** @var self<A, B> */
            $self = new self;

            return Maybe::just(($self)($key, $value));
        }

        /** @var Maybe<Implementation<A, B>> */
        return Maybe::nothing();
    }

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

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

    /**
     * @param T $key
     *
     * @return Maybe<S>
     */
    public function get($key): Maybe
    {
        if (!$this->contains($key)) {
            return Maybe::nothing();
        }

        return Maybe::just($this->values[$key]);
    }

    /**
     * @param T $key
     */
    public function contains($key): bool
    {
        /** @psalm-suppress MixedArgumentTypeCoercion */
        return \array_key_exists($key, $this->values);
    }

    /**
     * @return self<T, S>
     */
    public function clear(): self
    {
        return new self;
    }

    /**
     * @param Implementation<T, S> $map
     */
    public function equals(Implementation $map): bool
    {
        if (!$map->keys()->equals($this->keys())) {
            return false;
        }

        foreach ($this->values as $k => $v) {
            $equals = $map
                ->get($k)
                ->filter(static fn($value) => $value === $v)
                ->match(
                    static fn() => true,
                    static fn() => false,
                );

            if (!$equals) {
                return false;
            }
        }

        return true;
    }

    /**
     * @param callable(T, S): bool $predicate
     *
     * @return self<T, S>
     */
    public function filter(callable $predicate): self
    {
        /** @var array<T, S> */
        $values = [];

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

        return new self($values);
    }

    /**
     * @param callable(T, S): void $function
     */
    public function foreach(callable $function): SideEffect
    {
        foreach ($this->values as $k => $v) {
            $function($k, $v);
        }

        return new SideEffect;
    }

    /**
     * @template D
     *
     * @param callable(T, S): D $discriminator
     *
     * @return Map<D, Map<T, S>>
     */
    public function groupBy(callable $discriminator): Map
    {
        /** @var Map<D, Map<T, S>> */
        $groups = Map::of();

        foreach ($this->values as $key => $value) {
            $discriminant = $discriminator($key, $value);

            $group = $groups->get($discriminant)->match(
                static fn($group) => $group,
                fn() => $this->clearMap(),
            );
            $groups = ($groups)($discriminant, ($group)($key, $value));
        }

        /** @var Map<D, Map<T, S>> */
        return $groups;
    }

    /**
     * @return Set<T>
     */
    public function keys(): Set
    {
        /** @psalm-suppress MixedArgumentTypeCoercion */
        $keys = \array_keys($this->values);

        return Set::of(...$keys);
    }

    /**
     * @return Sequence<S>
     */
    public function values(): Sequence
    {
        /** @psalm-suppress MixedArgumentTypeCoercion */
        $values = \array_values($this->values);

        return Sequence::of(...$values);
    }

    /**
     * @template B
     *
     * @param callable(T, S): B $function
     *
     * @return self<T, B>
     */
    public function map(callable $function): self
    {
        /** @var array<T, B> */
        $values = [];

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

        return new self($values);
    }

    /**
     * @param T $key
     *
     * @return self<T, S>
     */
    public function remove($key): self
    {
        if (!$this->contains($key)) {
            return $this;
        }

        $values = $this->values;
        /** @psalm-suppress MixedArrayTypeCoercion */
        unset($values[$key]);

        return new self($values);
    }

    /**
     * @param Implementation<T, S> $map
     *
     * @return Implementation<T, S>
     */
    public function merge(Implementation $map): Implementation
    {
        return $map->reduce(
            $this,
            static fn(Implementation $carry, $key, $value): Implementation => ($carry)($key, $value),
        );
    }

    /**
     * @param callable(T, S): bool $predicate
     *
     * @return Map<bool, Map<T, S>>
     */
    public function partition(callable $predicate): Map
    {
        $truthy = $this->clearMap();
        $falsy = $this->clearMap();

        foreach ($this->values as $k => $v) {
            $return = $predicate($k, $v);

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

        return Map::of([true, $truthy], [false, $falsy]);
    }

    /**
     * @template R
     * @param R $carry
filter:
    dependency_paths: ["lib/*"]
     * @param callable(R, T, S): R $reducer
     *
     * @return R
     */
    public function reduce($carry, callable $reducer)
    {
        foreach ($this->values as $k => $v) {
            $carry = $reducer($carry, $k, $v);
        }

        return $carry;
    }

    public function empty(): bool
    {
        /** @psalm-suppress MixedArgumentTypeCoercion */
        \reset($this->values);

        /** @psalm-suppress MixedArgumentTypeCoercion */
        return \is_null(\key($this->values));
    }

    public function find(callable $predicate): Maybe
    {
        foreach ($this->values as $k => $v) {
            if ($predicate($k, $v)) {
                return Maybe::just(new Pair($k, $v));
            }
        }

        /** @var Maybe<Pair<T, S>> */
        return Maybe::nothing();
    }

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


1		<?php
2		declare(strict_types = 1);
3
4		namespace Innmind\Immutable\Map;
5
6		use Innmind\Immutable\{
7		Map,
8		Str,
9		Sequence,
10		Set,
11		Pair,
12		Maybe,
13		SideEffect,
14		};
15
16		/**
17		* @template T
18		* @template S
19		* @psalm-immutable
20		*/
21		final class Primitive implements Implementation
22		{
23		/** @var array<T, S> */
24		private array $values;
25
26		/**
27		* @param array<T, S> $values
28		*/
29		public function __construct(array $values = [])
30		{
31		$this->values = $values;
32		}
33	76
34		/**
35	76	* @param T $key
		0 ignored issues – show Bug introduced 2022-03-26 14:35 UTC by Report Bug Copy Issue Report The type `Innmind\Immutable\Map\T` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
36		* @param S $value
		0 ignored issues – show Bug introduced 2019-12-05 18:47 UTC by Report Bug Copy Issue Report The type `Innmind\Immutable\Map\S` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
37	76	*
38	1	* @return Implementation<T, S>
39		*/
40		public function __invoke($key, $value): Implementation
41	75	{
42	75	/** @psalm-suppress DocblockTypeContradiction */
43	75	if (\is_string($key) && \is_numeric($key)) {
		0 ignored issues – show introduced 2022-03-26 14:35 UTC by Report Bug Copy Issue Report The condition `is_string($key)` is always `false`. Loading history...
44	75	// numeric-string keys are casted to ints by php, so when iterating
45	75	// over the array afterward the type is not conserved so we switch
46	75	// the implementation to DoubleIndex so keep the type
47		return (new DoubleIndex)->merge($this)($key, $value);
48	23	}
49
50	23	$values = $this->values;
51		$values[$key] = $value;
52
53	20	return new self($values);
54		}
55	20
56		/**
57		* @template A
58	31	* @template B
59		*
60		* @param A $key
		0 ignored issues – show Bug introduced 2022-03-26 14:35 UTC by Report Bug Copy Issue Report The type `Innmind\Immutable\Map\A` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
61	31	* @param B $value
		0 ignored issues – show Bug introduced 2022-03-26 14:35 UTC by Report Bug Copy Issue Report The type `Innmind\Immutable\Map\B` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
62		*
63		* @return Maybe<Implementation<A, B>>
64		*/
65		public static function of($key, $value): Maybe
66		{
67	15	/** @psalm-suppress DocblockTypeContradiction */
68		if (\is_string($key) && \is_numeric($key)) {
		0 ignored issues – show introduced 2022-03-26 14:35 UTC by Report Bug Copy Issue Report The condition `is_string($key)` is always `false`. Loading history...
69	15	/** @var Maybe<Implementation<A, B>> */
70		return Maybe::nothing();
71		}
72
73		if (\is_string($key) \|\| \is_int($key)) {
		0 ignored issues – show introduced 2022-03-26 14:35 UTC by Report Bug Copy Issue Report The condition `is_int($key)` is always `false`. Loading history...
74		/** @var self<A, B> */
75		$self = new self;
76
77		return Maybe::just(($self)($key, $value));
78	62	}
79
80	62	/** @var Maybe<Implementation<A, B>> */
81	61	return Maybe::nothing();
82		}
83	60
84	60	public function size(): int
85	60	{
86		/** @psalm-suppress MixedArgumentTypeCoercion */
87	60	return \count($this->values);
88		}
89
90		public function count(): int
91		{
92		return $this->size();
93		}
94
95		/**
96		* @param T $key
97	34	*
98		* @return Maybe<S>
99	34	*/
100	2	public function get($key): Maybe
101		{
102		if (!$this->contains($key)) {
103	32	return Maybe::nothing();
104		}
105
106		return Maybe::just($this->values[$key]);
107		}
108
109	39	/**
110		* @param T $key
111		*/
112	39	public function contains($key): bool
113		{
114		/** @psalm-suppress MixedArgumentTypeCoercion */
115		return \array_key_exists($key, $this->values);
116		}
117
118	10	/**
119		* @return self<T, S>
120	10	*/
121	10	public function clear(): self
122	10	{
123		return new self;
124	10	}
125
126		/**
127		* @param Implementation<T, S> $map
128		*/
129		public function equals(Implementation $map): bool
130	7	{
131		if (!$map->keys()->equals($this->keys())) {
132	7	return false;
133	2	}
134
135		foreach ($this->values as $k => $v) {
136	7	$equals = $map
137	6	->get($k)
138	2	->filter(static fn($value) => $value === $v)
139		->match(
140		static fn() => true,
141	6	static fn() => false,
142	3	);
143
144		if (!$equals) {
145		return false;
146	6	}
147		}
148
149		return true;
150		}
151
152		/**
153		* @param callable(T, S): bool $predicate
154	2	*
155		* @return self<T, S>
156	2	*/
157		public function filter(callable $predicate): self
158	2	{
159	2	/** @var array<T, S> */
160	2	$values = [];
161
162		foreach ($this->values as $k => $v) {
163		if ($predicate($k, $v) === true) {
164	2	$values[$k] = $v;
165		}
166		}
167
168		return new self($values);
169		}
170	3
171		/**
172	3	* @param callable(T, S): void $function
173	3	*/
174		public function foreach(callable $function): SideEffect
175	3	{
176		foreach ($this->values as $k => $v) {
177		$function($k, $v);
178		}
179
180		return new SideEffect;
181		}
182
183		/**
184		* @template D
185	4	*
186		* @param callable(T, S): D $discriminator
187	4	*
188	2	* @return Map<D, Map<T, S>>
189		*/
190		public function groupBy(callable $discriminator): Map
191	2	{
192		/** @var Map<D, Map<T, S>> */
193	2	$groups = Map::of();
194
195	2	foreach ($this->values as $key => $value) {
196		$discriminant = $discriminator($key, $value);
197	2
198	2	$group = $groups->get($discriminant)->match(
199		static fn($group) => $group,
200	2	fn() => $this->clearMap(),
201		);
202	2	$groups = ($groups)($discriminant, ($group)($key, $value));
203	2	}
204	2
205		/** @var Map<D, Map<T, S>> */
206		return $groups;
207		}
208	2
209		/**
210	2	* @return Set<T>
211		*/
212	2	public function keys(): Set
213		{
214	2	/** @psalm-suppress MixedArgumentTypeCoercion */
215		$keys = \array_keys($this->values);
216
217	2	return Set::of(...$keys);
218		}
219	2
220		/**
221		* @return Sequence<S>
222		*/
223		public function values(): Sequence
224	2	{
225		/** @psalm-suppress MixedArgumentTypeCoercion */
226		$values = \array_values($this->values);
227
228		return Sequence::of(...$values);
229		}
230	14
231		/**
232		* @template B
233	14	*
234		* @param callable(T, S): B $function
235	14	*
236	14	* @return self<T, B>
237	14	*/
238		public function map(callable $function): self
239	14	{
240	14	/** @var array<T, B> */
241	14	$values = [];
242
243		foreach ($this->values as $k => $v) {
244		$values[$k] = $function($k, $v);
245		}
246
247		return new self($values);
248		}
249	12
250		/**
251		* @param T $key
252	12	*
253		* @return self<T, S>
254	12	*/
255		public function remove($key): self
256		{
257		if (!$this->contains($key)) {
258		return $this;
259		}
260
261		$values = $this->values;
262	6	/** @psalm-suppress MixedArrayTypeCoercion */
263		unset($values[$key]);
264	6
265		return new self($values);
266	6	}
267	6
268		/**
269	6	* @param Implementation<T, S> $map
270	4	*
271		* @return Implementation<T, S>
272		*/
273	2	public function merge(Implementation $map): Implementation
274		{
275	2	return $map->reduce(
276		$this,
277	4	static fn(Implementation $carry, $key, $value): Implementation => ($carry)($key, $value),
278	4	);
279		}
280
281	4	/**
282		* @param callable(T, S): bool $predicate
283	2	*
284		* @return Map<bool, Map<T, S>>
285		*/
286	2	public function partition(callable $predicate): Map
287		{
288		$truthy = $this->clearMap();
289		$falsy = $this->clearMap();
290
291		foreach ($this->values as $k => $v) {
292		$return = $predicate($k, $v);
293
294	2	if ($return === true) {
295		$truthy = ($truthy)($k, $v);
296	2	} else {
297	2	$falsy = ($falsy)($k, $v);
298		}
299		}
300	2
301	2	return Map::of([true, $truthy], [false, $falsy]);
302		}
303	2
304		/**
305	2	* @template R
306		* @param R $carry
		0 ignored issues – show Bug introduced 2019-12-05 18:47 UTC by Report Bug Copy Issue Report The type `Innmind\Immutable\Map\R` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
307		* @param callable(R, T, S): R $reducer
308		*
309		* @return R
310		*/
311		public function reduce($carry, callable $reducer)
312		{
313	1	foreach ($this->values as $k => $v) {
314		$carry = $reducer($carry, $k, $v);
315		}
316	1
317	1	return $carry;
318		}
319	1
320	1	public function empty(): bool
321		{
322		/** @psalm-suppress MixedArgumentTypeCoercion */
323	1	\reset($this->values);
324
325		/** @psalm-suppress MixedArgumentTypeCoercion */
326		return \is_null(\key($this->values));
327		}
328
329		public function find(callable $predicate): Maybe
330		{
331	2	foreach ($this->values as $k => $v) {
332		if ($predicate($k, $v)) {
333	2	return Maybe::just(new Pair($k, $v));
334	2	}
335		}
336	2
337	2	/** @var Maybe<Pair<T, S>> */
338		return Maybe::nothing();
339	2	}
340	2
341		/**
342	2	* @return Map<T, S>
343		*/
344		private function clearMap(): Map
345		{
346		return Map::of();
347		}
348		}
349

Innmind / Immutable

GitHub Access Token became invalid

Primitive::equals() A last analyzed 2022-07-02 13:48 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Primitive::equals() A
last analyzed 2022-07-02 13:48 UTC