HasBinaryUuid - Code Metrics - Inspection of "Adds method to generate a UUID" - spatie/laravel-binary-uuid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#43)

unknown

created 2018-08-13 08:14 UTC

HasBinaryUuid B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	206
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	44
lcom	1
cbo	4
dl	0
loc	206
rs	8.8798
c	0
b	0
f	0

21 Methods

Rating	Name	Size	Complexity
A	bootHasBinaryUuid()	10	2
A	scopeWithUuid()	16	3
A	scopeWithUuidRelation()	12	2
A	generateUuid()	4	1
A	encodeUuid()	12	3
A	decodeUuid()	8	2
A	toArray()	20	5
A	getRelatedBinaryKeyName()	6	2
A	getAttribute()	10	3
A	setAttribute()	8	2
A	getUuidSuffix()	4	2
A	uuidTextAttribute()	12	3
A	getUuidAttributes()	15	3
A	getUuidTextAttribute()	10	3
A	setUuidTextAttribute()	10	2
A	getQueueableId()	4	1
A	newQueryForRestoration()	4	1
A	getRouteKeyName()	6	1
A	getKeyName()	4	1
A	getIncrementing()	4	1
A	resolveRouteBinding()	4	1

How to fix Complexity

<?php

namespace Spatie\BinaryUuid;

use Ramsey\Uuid\Uuid;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;

trait HasBinaryUuid
{
    protected static function bootHasBinaryUuid()
    {
        static::creating(function (Model $model) {
            if ($model->{$model->getKeyName()}) {
                return;
            }

            $model->{$model->getKeyName()} = static::encodeUuid(static::generateUuid());
        });
    }

    public static function scopeWithUuid(Builder $builder, $uuid, $field = null): Builder
    {
        if ($field) {
            return static::scopeWithUuidRelation($builder, $uuid, $field);
        }

        if ($uuid instanceof Uuid) {
            $uuid = (string) $uuid;
        }

        $uuid = (array) $uuid;

        return $builder->whereKey(array_map(function (string $modelUuid) {
            return static::encodeUuid($modelUuid);
        }, $uuid));
    }

    public static function scopeWithUuidRelation(Builder $builder, $uuid, string $field): Builder
    {
        if ($uuid instanceof Uuid) {
            $uuid = (string) $uuid;
        }

        $uuid = (array) $uuid;

        return $builder->whereIn($field, array_map(function (string $modelUuid) {
            return static::encodeUuid($modelUuid);
        }, $uuid));
    }

    public static function generateUuid(): string
    {
        return Uuid::uuid1();
    }

    public static function encodeUuid($uuid): string
    {
        if (! Uuid::isValid($uuid)) {
            return $uuid;
        }

        if (! $uuid instanceof Uuid) {
            $uuid = Uuid::fromString($uuid);
        }

        return $uuid->getBytes();
    }

    public static function decodeUuid(string $binaryUuid): string
    {
        if (Uuid::isValid($binaryUuid)) {
            return $binaryUuid;
        }

        return Uuid::fromBytes($binaryUuid)->toString();
    }

    public function toArray()
    {
        $uuidAttributes = $this->getUuidAttributes();

        $array = parent::toArray();

        if (! $this->exists || ! is_array($uuidAttributes)) {
class MyClass { }

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

        foreach ($uuidAttributes as $attributeKey) {
            if (! array_key_exists($attributeKey, $array)) {
                continue;
            }
            $uuidKey = $this->getRelatedBinaryKeyName($attributeKey);
            $array[$attributeKey] = $this->{$uuidKey};
        }

        return $array;
    }

    public function getRelatedBinaryKeyName($attribute): string
    {
        $suffix = $this->getUuidSuffix();

        return preg_match('/(?:uu)?id/i', $attribute) ? "{$attribute}{$suffix}" : $attribute;
    }

    public function getAttribute($key)
    {
        $uuidKey = $this->uuidTextAttribute($key);

        if ($uuidKey && $this->{$uuidKey} !== null) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return static::decodeUuid($this->{$uuidKey});
        }

        return parent::getAttribute($key);
    }

    public function setAttribute($key, $value)
    {
        if ($this->uuidTextAttribute($key)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $value = static::encodeUuid($value);
        }

        return parent::setAttribute($key, $value);
    }

    protected function getUuidSuffix()
    {
        return (property_exists($this, 'uuidSuffix')) ? $this->uuidSuffix : '_text';
class MyClass { }

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

    protected function uuidTextAttribute($key)
    {
        $uuidAttributes = $this->getUuidAttributes();
        $suffix = $this->getUuidSuffix();
        $offset = -(strlen($suffix));

        if (substr($key, $offset) == $suffix && in_array(($uuidKey = substr($key, 0, $offset)), $uuidAttributes)) {
            return $uuidKey;
        }

        return false;
    }

    public function getUuidAttributes()
    {
        $uuidAttributes = [];

        if (property_exists($this, 'uuids') && is_array($this->uuids)) {
            $uuidAttributes = array_merge($uuidAttributes, $this->uuids);
class MyClass { }

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

        // non composite primary keys will return a string so casting required
        $key = (array) $this->getKeyName();

        $uuidAttributes = array_unique(array_merge($uuidAttributes, $key));

        return $uuidAttributes;
    }

    public function getUuidTextAttribute(): ?string
    {
        $key = $this->getKeyName();

        if (! $this->exists || is_array($key)) {
            return null;
        }

        return static::decodeUuid($this->{$key});
    }

    public function setUuidTextAttribute(string $uuid)
    {
        $key = $this->getKeyName();

        if (is_array($key)) {
            return;
        }

        $this->{$key} = static::encodeUuid($uuid);
    }

    public function getQueueableId()
    {
        return base64_encode($this->{$this->getKeyName()});
    }

    public function newQueryForRestoration($id)
    {
        return $this->newQueryWithoutScopes()->whereKey(base64_decode($id));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function getRouteKeyName()
    {
        $suffix = $this->getUuidSuffix();

        return "uuid{$suffix}";
    }

    public function getKeyName()
    {
        return 'uuid';
    }

    public function getIncrementing()
    {
        return false;
    }

    public function resolveRouteBinding($value)
    {
        return $this->withUuid($value)->first();

    }
}


1			<?php
2
3			namespace Spatie\BinaryUuid;
4
5			use Ramsey\Uuid\Uuid;
6			use Illuminate\Database\Eloquent\Model;
7			use Illuminate\Database\Eloquent\Builder;
8
9			trait HasBinaryUuid
10			{
11			protected static function bootHasBinaryUuid()
12			{
13			static::creating(function (Model $model) {
14			if ($model->{$model->getKeyName()}) {
15			return;
16			}
17
18			$model->{$model->getKeyName()} = static::encodeUuid(static::generateUuid());
19			});
20			}
21
22			public static function scopeWithUuid(Builder $builder, $uuid, $field = null): Builder
23			{
24			if ($field) {
25			return static::scopeWithUuidRelation($builder, $uuid, $field);
26			}
27
28			if ($uuid instanceof Uuid) {
29			$uuid = (string) $uuid;
30			}
31
32			$uuid = (array) $uuid;
33
34			return $builder->whereKey(array_map(function (string $modelUuid) {
35			return static::encodeUuid($modelUuid);
36			}, $uuid));
37			}
38
39			public static function scopeWithUuidRelation(Builder $builder, $uuid, string $field): Builder
40			{
41			if ($uuid instanceof Uuid) {
42			$uuid = (string) $uuid;
43			}
44
45			$uuid = (array) $uuid;
46
47			return $builder->whereIn($field, array_map(function (string $modelUuid) {
48			return static::encodeUuid($modelUuid);
49			}, $uuid));
50			}
51
52			public static function generateUuid(): string
53			{
54			return Uuid::uuid1();
55			}
56
57			public static function encodeUuid($uuid): string
58			{
59			if (! Uuid::isValid($uuid)) {
60			return $uuid;
61			}
62
63			if (! $uuid instanceof Uuid) {
64			$uuid = Uuid::fromString($uuid);
65			}
66
67			return $uuid->getBytes();
68			}
69
70			public static function decodeUuid(string $binaryUuid): string
71			{
72			if (Uuid::isValid($binaryUuid)) {
73			return $binaryUuid;
74			}
75
76			return Uuid::fromBytes($binaryUuid)->toString();
77			}
78
79			public function toArray()
80			{
81			$uuidAttributes = $this->getUuidAttributes();
82
83			$array = parent::toArray();
84
85			if (! $this->exists \|\| ! is_array($uuidAttributes)) {
			0 ignored issues – show Bug introduced 2018-08-07 13:08 UTC by Report Bug Copy Issue Report The property `exists` 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...
86			return $array;
87			}
88
89			foreach ($uuidAttributes as $attributeKey) {
90			if (! array_key_exists($attributeKey, $array)) {
91			continue;
92			}
93			$uuidKey = $this->getRelatedBinaryKeyName($attributeKey);
94			$array[$attributeKey] = $this->{$uuidKey};
95			}
96
97			return $array;
98			}
99
100			public function getRelatedBinaryKeyName($attribute): string
101			{
102			$suffix = $this->getUuidSuffix();
103
104			return preg_match('/(?:uu)?id/i', $attribute) ? "{$attribute}{$suffix}" : $attribute;
105			}
106
107			public function getAttribute($key)
108			{
109			$uuidKey = $this->uuidTextAttribute($key);
110
111			if ($uuidKey && $this->{$uuidKey} !== null) {
			0 ignored issues – show Bug Best Practice introduced 2018-08-07 13:31 UTC by Report Bug Copy Issue Report The expression `$uuidKey` of type `string\|false` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
112			return static::decodeUuid($this->{$uuidKey});
113			}
114
115			return parent::getAttribute($key);
116			}
117
118			public function setAttribute($key, $value)
119			{
120			if ($this->uuidTextAttribute($key)) {
			0 ignored issues – show Bug Best Practice introduced 2018-08-07 13:31 UTC by Report Bug Copy Issue Report The expression `$this->uuidTextAttribute($key)` of type `string\|false` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
121			$value = static::encodeUuid($value);
122			}
123
124			return parent::setAttribute($key, $value);
125			}
126
127			protected function getUuidSuffix()
128			{
129			return (property_exists($this, 'uuidSuffix')) ? $this->uuidSuffix : '_text';
			0 ignored issues – show Bug introduced 2018-08-07 13:08 UTC by Report Bug Copy Issue Report The property `uuidSuffix` 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...
130			}
131
132			protected function uuidTextAttribute($key)
133			{
134			$uuidAttributes = $this->getUuidAttributes();
135			$suffix = $this->getUuidSuffix();
136			$offset = -(strlen($suffix));
137
138			if (substr($key, $offset) == $suffix && in_array(($uuidKey = substr($key, 0, $offset)), $uuidAttributes)) {
139			return $uuidKey;
140			}
141
142			return false;
143			}
144
145			public function getUuidAttributes()
146			{
147			$uuidAttributes = [];
148
149			if (property_exists($this, 'uuids') && is_array($this->uuids)) {
150			$uuidAttributes = array_merge($uuidAttributes, $this->uuids);
			0 ignored issues – show Bug introduced 2018-08-07 13:08 UTC by Report Bug Copy Issue Report The property `uuids` 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...
151			}
152
153			// non composite primary keys will return a string so casting required
154			$key = (array) $this->getKeyName();
155
156			$uuidAttributes = array_unique(array_merge($uuidAttributes, $key));
157
158			return $uuidAttributes;
159			}
160
161			public function getUuidTextAttribute(): ?string
162			{
163			$key = $this->getKeyName();
164
165			if (! $this->exists \|\| is_array($key)) {
166			return null;
167			}
168
169			return static::decodeUuid($this->{$key});
170			}
171
172			public function setUuidTextAttribute(string $uuid)
173			{
174			$key = $this->getKeyName();
175
176			if (is_array($key)) {
177			return;
178			}
179
180			$this->{$key} = static::encodeUuid($uuid);
181			}
182
183			public function getQueueableId()
184			{
185			return base64_encode($this->{$this->getKeyName()});
186			}
187
188			public function newQueryForRestoration($id)
189			{
190			return $this->newQueryWithoutScopes()->whereKey(base64_decode($id));
			0 ignored issues – show Bug introduced 2017-11-21 08:01 UTC by Report Bug Copy Issue Report It seems like `newQueryWithoutScopes()` 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...
191			}
192
193			public function getRouteKeyName()
194			{
195			$suffix = $this->getUuidSuffix();
196
197			return "uuid{$suffix}";
198			}
199
200			public function getKeyName()
201			{
202			return 'uuid';
203			}
204
205			public function getIncrementing()
206			{
207			return false;
208			}
209
210			public function resolveRouteBinding($value)
211			{
212			return $this->withUuid($value)->first();
			0 ignored issues – show Bug introduced 2018-02-12 09:15 UTC by Report Bug Copy Issue Report The method `withUuid()` does not exist on `Spatie\BinaryUuid\HasBinaryUuid`. Did you maybe mean `scopeWithUuid()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
213			}
214			}
215

spatie / laravel-binary-uuid

Pull Request — master (#43)

HasBinaryUuid B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

21 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like