HasEnums::scopeWhereNotEnum() - Code Metrics - Inspection of "Nullable Enums" - spatie/laravel-enum - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#25)

by Freek

created 2020-01-07 07:58 UTC

HasEnums::scopeWhereNotEnum() A

↳ Parent: HasEnums

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	7
cts	7
cp	1
rs	9.8666
c	0
b	0
f	0
cc	1
nc	1
nop	3
crap	1

<?php

namespace Spatie\Enum\Laravel;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use InvalidArgumentException;
use Spatie\Enum\Enumerable;
use Spatie\Enum\Laravel\Exceptions\InvalidEnumError;
use Spatie\Enum\Laravel\Exceptions\NoSuchEnumField;

/**
 * @mixin Model
 */
trait HasEnums
{
    public function setAttribute($key, $value)
    {
        return $this->isEnumAttribute($key)
            ? $this->setEnumAttribute($key, $value)
            : parent::setAttribute($key, $value);
    }

    public function getAttribute($key)
    {
        $value = parent::getAttribute($key);

        return $this->isEnumAttribute($key)
            ? $this->getEnumAttribute($key, $value)
            : $value;
    }

    /**
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param string $key
     * @param int|string|\Spatie\Enum\Enumerable|int[]|string[]|\Spatie\Enum\Enumerable[] $enumerables
     *
     * @see \Illuminate\Database\Eloquent\Builder::whereIn()
     */
    public function scopeWhereEnum(
        Builder $builder,
        string $key,
        $enumerables
    ): void {
        $this->buildEnumScope(
            $builder,
            'whereIn',
            $key,
            $enumerables
        );
    }

    /**
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param string $key
     * @param int|string|\Spatie\Enum\Enumerable|int[]|string[]|\Spatie\Enum\Enumerable[] $enumerables
     *
     * @see \Illuminate\Database\Eloquent\Builder::orWhereIn()
     */
    public function scopeOrWhereEnum(
        Builder $builder,
        string $key,
        $enumerables
    ): void {
        $this->buildEnumScope(
            $builder,
            'orWhereIn',
            $key,
            $enumerables
        );
    }

    /**
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param string $key
     * @param int|string|\Spatie\Enum\Enumerable|int[]|string[]|\Spatie\Enum\Enumerable[] $enumerables
     *
     * @see \Illuminate\Database\Eloquent\Builder::whereNotIn()
     */
    public function scopeWhereNotEnum(
        Builder $builder,
        string $key,
        $enumerables
    ): void {
        $this->buildEnumScope(
            $builder,
            'whereNotIn',
            $key,
            $enumerables
        );
    }

    /**
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param string $key
     * @param int|string|\Spatie\Enum\Enumerable|int[]|string[]|\Spatie\Enum\Enumerable[] $enumerables
     *
     * @see \Illuminate\Database\Eloquent\Builder::orWhereNotIn()
     */
    public function scopeOrWhereNotEnum(
        Builder $builder,
        string $key,
        $enumerables
    ): void {
        $this->buildEnumScope(
            $builder,
            'orWhereNotIn',
            $key,
            $enumerables
        );
    }

    /**
     * @param string $key
     * @param int|string|\Spatie\Enum\Enumerable $value
     *
     * @return $this
     */
    protected function setEnumAttribute(string $key, $value)
    {
        $enumClass = $this->getEnumClass($key);

        if ($this->isNullableEnum($key, $value)) {
            return $this;
        }

        if (is_string($value) || is_int($value)) {
            $value = $this->asEnum($enumClass, $value);
        }

        if (is_null($value)) {
            $enumInterface = Enumerable::class;
            throw new InvalidArgumentException("{$enumInterface} {$enumClass} is not nullable");
        }

        if (! is_a($value, $enumClass)) {
            throw InvalidEnumError::make(static::class, $key, $enumClass, get_class($value));
        }

        $this->attributes[$key] = $this->getStoredValue($key, $value);
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    /**
     * @param string $key
     * @param \Spatie\Enum\Enumerable $enum
     *
     * @return int|string
     */
    protected function getStoredValue(string $key, Enumerable $enum)
    {
        return $this->hasCast($key, ['int', 'integer'])
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ? $enum->getIndex()
            : $enum->getValue();
    }

    /**
     * @param string $key
     * @param int|string|null $value
     *
     * @return \Spatie\Enum\Enumerable|int|string|null
     */
    protected function getEnumAttribute(string $key, $value)
    {
        if ($this->isNullableEnum($key, $value)) {
            return $value;
        }

        return $this->asEnum($this->getEnumClass($key), $value);
    }

    protected function isEnumAttribute(string $key): bool
    {
        return isset($this->enums[$key]);
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    protected function isNullableEnum(string $key, $value): bool
    {
        $enumClass = $this->enums[$key];

        if (! strpos($enumClass, ':')) {
            return false;
        }

        $nullable = explode(':', $enumClass, 2)[1];

        if (! $nullable || $nullable !== 'nullable') {
            return false;
        }

        return $nullable && is_null($value);
    }

    protected function getEnumClass(string $key): string
    {
        $enumClass = $this->enums[$key];

        if (strpos($enumClass, ':')) {
            $enumClass = explode(':', $enumClass, 2)[0];
        }

        $enumInterface = Enumerable::class;

        $classImplementsEnumerable = class_implements($enumClass)[$enumInterface] ?? false;

        if (! $classImplementsEnumerable) {
            throw new InvalidArgumentException("Expected {$enumClass} to implement {$enumInterface}");
        }

        return $enumClass;
    }

    /**
     * @param string $class
     * @param int|string $value
     *
     * @return \Spatie\Enum\Enumerable
     */
    protected function asEnum(string $class, $value): Enumerable
    {
        if ($value instanceof Enumerable) {
            return $value;
        }

        return forward_static_call(
            $class.'::make',
            $value
        );
    }

    /**
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param string $method
     * @param string $key
     * @param int|string|\Spatie\Enum\Enumerable|int[]|string[]|\Spatie\Enum\Enumerable[] $enumerables
     */
    protected function buildEnumScope(
        Builder $builder,
        string $method,
        string $key,
        $enumerables
    ): void {
        if (! $this->isEnumAttribute($key)) {
            throw NoSuchEnumField::make($key, get_class($this));
        }

        $enumerables = is_array($enumerables) ? $enumerables : [$enumerables];

        $builder->$method(
            $key,
            array_map(function ($value) use ($key) {
                return $this->getStoredValue($key, $this->getEnumAttribute($key, $value));
            }, $enumerables)
        );
    }
}


1		<?php
2
3		namespace Spatie\Enum\Laravel;
4
5		use Illuminate\Database\Eloquent\Builder;
6		use Illuminate\Database\Eloquent\Model;
7		use InvalidArgumentException;
8		use Spatie\Enum\Enumerable;
9		use Spatie\Enum\Laravel\Exceptions\InvalidEnumError;
10		use Spatie\Enum\Laravel\Exceptions\NoSuchEnumField;
11
12		/**
13		* @mixin Model
14		*/
15		trait HasEnums
16		{
17	80	public function setAttribute($key, $value)
18		{
19	80	return $this->isEnumAttribute($key)
20	80	? $this->setEnumAttribute($key, $value)
21	72	: parent::setAttribute($key, $value);
22		}
23
24	28	public function getAttribute($key)
25		{
26	28	$value = parent::getAttribute($key);
27
28	28	return $this->isEnumAttribute($key)
29	28	? $this->getEnumAttribute($key, $value)
30	28	: $value;
31		}
32
33		/**
34		* @param \Illuminate\Database\Eloquent\Builder $builder
35		* @param string $key
36		* @param int\|string\|\Spatie\Enum\Enumerable\|int[]\|string[]\|\Spatie\Enum\Enumerable[] $enumerables
37		*
38		* @see \Illuminate\Database\Eloquent\Builder::whereIn()
39		*/
40	32	public function scopeWhereEnum(
41		Builder $builder,
42		string $key,
43		$enumerables
44		): void {
45	32	$this->buildEnumScope(
46	32	$builder,
47	32	'whereIn',
48	16	$key,
49	16	$enumerables
50		);
51	28	}
52
53		/**
54		* @param \Illuminate\Database\Eloquent\Builder $builder
55		* @param string $key
56		* @param int\|string\|\Spatie\Enum\Enumerable\|int[]\|string[]\|\Spatie\Enum\Enumerable[] $enumerables
57		*
58		* @see \Illuminate\Database\Eloquent\Builder::orWhereIn()
59		*/
60	12	public function scopeOrWhereEnum(
61		Builder $builder,
62		string $key,
63		$enumerables
64		): void {
65	12	$this->buildEnumScope(
66	12	$builder,
67	12	'orWhereIn',
68	6	$key,
69	6	$enumerables
70		);
71	8	}
72
73		/**
74		* @param \Illuminate\Database\Eloquent\Builder $builder
75		* @param string $key
76		* @param int\|string\|\Spatie\Enum\Enumerable\|int[]\|string[]\|\Spatie\Enum\Enumerable[] $enumerables
77		*
78		* @see \Illuminate\Database\Eloquent\Builder::whereNotIn()
79		*/
80	20	public function scopeWhereNotEnum(
81		Builder $builder,
82		string $key,
83		$enumerables
84		): void {
85	20	$this->buildEnumScope(
86	20	$builder,
87	20	'whereNotIn',
88	10	$key,
89	10	$enumerables
90		);
91	16	}
92
93		/**
94		* @param \Illuminate\Database\Eloquent\Builder $builder
95		* @param string $key
96		* @param int\|string\|\Spatie\Enum\Enumerable\|int[]\|string[]\|\Spatie\Enum\Enumerable[] $enumerables
97		*
98		* @see \Illuminate\Database\Eloquent\Builder::orWhereNotIn()
99		*/
100	12	public function scopeOrWhereNotEnum(
101		Builder $builder,
102		string $key,
103		$enumerables
104		): void {
105	12	$this->buildEnumScope(
106	12	$builder,
107	12	'orWhereNotIn',
108	6	$key,
109	6	$enumerables
110		);
111	8	}
112
113		/**
114		* @param string $key
115		* @param int\|string\|\Spatie\Enum\Enumerable $value
116		*
117		* @return $this
118		*/
119	80	protected function setEnumAttribute(string $key, $value)
120		{
121	80	$enumClass = $this->getEnumClass($key);
122
123	76	if ($this->isNullableEnum($key, $value)) {
124	16	return $this;
125		}
126
127	76	if (is_string($value) \|\| is_int($value)) {
128	4	$value = $this->asEnum($enumClass, $value);
129		}
130
131	72	if (is_null($value)) {
132		$enumInterface = Enumerable::class;
133	72	throw new InvalidArgumentException("{$enumInterface} {$enumClass} is not nullable");
134		}
135
136		if (! is_a($value, $enumClass)) {
137		throw InvalidEnumError::make(static::class, $key, $enumClass, get_class($value));
138		}
139
140		$this->attributes[$key] = $this->getStoredValue($key, $value);
		0 ignored issues – show Bug introduced 2019-07-15 14:00 UTC by Report Bug Copy Issue Report The property `attributes` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
141
142	72	return $this;
143		}
144	72
145	4	/**
146	72	* @param string $key
147		* @param \Spatie\Enum\Enumerable $enum
148		*
149		* @return int\|string
150		*/
151		protected function getStoredValue(string $key, Enumerable $enum)
152		{
153		return $this->hasCast($key, ['int', 'integer'])
		0 ignored issues – show Bug introduced 2019-07-15 14:00 UTC by Report Bug Copy Issue Report It seems like `hasCast()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
154		? $enum->getIndex()
155	72	: $enum->getValue();
156		}
157	72
158		/**
159		* @param string $key
160	96	* @param int\|string\|null $value
161		*
162	96	* @return \Spatie\Enum\Enumerable\|int\|string\|null
163		*/
164		protected function getEnumAttribute(string $key, $value)
165	80	{
166		if ($this->isNullableEnum($key, $value)) {
167	80	return $value;
168	80	}
169	80
170		return $this->asEnum($this->getEnumClass($key), $value);
171	80	}
172	4
173		protected function isEnumAttribute(string $key): bool
174		{
175	76	return isset($this->enums[$key]);
		0 ignored issues – show Bug introduced 2019-05-17 08:29 UTC by Report Bug Copy Issue Report The property `enums` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
176		}
177
178		protected function isNullableEnum(string $key, $value): bool
179		{
180		$enumClass = $this->enums[$key];
181
182		if (! strpos($enumClass, ':')) {
183		return false;
184	72	}
185
186	72	$nullable = explode(':', $enumClass, 2)[1];
187	36
188		if (! $nullable \|\| $nullable !== 'nullable') {
189		return false;
190	40	}
191	40
192	20	return $nullable && is_null($value);
193		}
194
195		protected function getEnumClass(string $key): string
196		{
197		$enumClass = $this->enums[$key];
198
199		if (strpos($enumClass, ':')) {
200		$enumClass = explode(':', $enumClass, 2)[0];
201		}
202	60
203		$enumInterface = Enumerable::class;
204
205		$classImplementsEnumerable = class_implements($enumClass)[$enumInterface] ?? false;
206
207		if (! $classImplementsEnumerable) {
208	60	throw new InvalidArgumentException("Expected {$enumClass} to implement {$enumInterface}");
209	16	}
210
211		return $enumClass;
212	44	}
213
214	44	/**
215	44	* @param string $class
216		* @param int\|string $value
217	44	*
218	44	* @return \Spatie\Enum\Enumerable
219		*/
220	44	protected function asEnum(string $class, $value): Enumerable
221		{
222		if ($value instanceof Enumerable) {
223		return $value;
224		}
225
226		return forward_static_call(
227		$class.'::make',
228		$value
229		);
230		}
231
232		/**
233		* @param \Illuminate\Database\Eloquent\Builder $builder
234		* @param string $method
235		* @param string $key
236		* @param int\|string\|\Spatie\Enum\Enumerable\|int[]\|string[]\|\Spatie\Enum\Enumerable[] $enumerables
237		*/
238		protected function buildEnumScope(
239		Builder $builder,
240		string $method,
241		string $key,
242		$enumerables
243		): void {
244		if (! $this->isEnumAttribute($key)) {
245		throw NoSuchEnumField::make($key, get_class($this));
246		}
247
248		$enumerables = is_array($enumerables) ? $enumerables : [$enumerables];
249
250		$builder->$method(
251		$key,
252		array_map(function ($value) use ($key) {
253		return $this->getStoredValue($key, $this->getEnumAttribute($key, $value));
254		}, $enumerables)
255		);
256		}
257		}
258

spatie / laravel-enum

GitHub Access Token became invalid

Pull Request — master (#25)

HasEnums::scopeWhereNotEnum() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like