HasBinaryUuid::getUuidKeys() - Code Metrics - Inspection of "Proposed fixes for issue #66 only" - spatie/laravel-binary-uuid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#71)

unknown

created 2018-10-04 12:29 UTC

HasBinaryUuid::getUuidKeys() A

↳ Parent: HasBinaryUuid

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	3
nc	4
nop	0

<?php

namespace Spatie\BinaryUuid;

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

trait HasBinaryUuid
{
    protected static function bootHasBinaryUuid()
    {
        static::creating(function (Model $model) {
            $uuidAttributes = $model->getUuidAttributes();

            foreach ($uuidAttributes as $key) {
                if ($model->{$key}) {
                    continue;
                }

                $model->{$key} = 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) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            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 isBinary($uuidStr)
    {
        return preg_match('~[^\x20-\x7E\t\r\n]~', $uuidStr) > 0;
    }

    public function getUuidKeys()
    {
        return (property_exists($this, 'uuids') && is_array($this->uuids)) ? $this->uuids : [];
class MyClass { }

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

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

        $array = parent::toArray();
        $pivotUuids = [];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        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};
        }

        if (isset($array['pivot'])) {
            $pivotUuids = $array['pivot'];

            if (! is_array($pivotUuids)) {
                $pivotUuids = get_object_vars($pivotUuids);
            }

            foreach ($pivotUuids as $key => $uuid) {
                if ($this->isBinary($uuid)) {
                    $pivotUuids[$key] = $this->decodeUuid($uuid);
                }
            }

            $array['pivot'] = $pivotUuids;
        }

        return $array;
    }

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

        return preg_match('/(?:[a-zA-Z_]+)?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()
    {
        $uuidKeys = $this->getUuidKeys();

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

        $uuidAttributes = array_unique(array_merge($uuidKeys, $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_string($key)) {
            throw new Exception('composite keys not allowed for attribute mutation');
        }

        $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 newEloquentBuilder($query)
    {
        return new Builder($query);
    }

    public function getRouteKeyName()
    {
        $key = $this->primaryKey;
class MyClass { }

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

        $keyName = is_string($key) ? $this->strUuidSuffix($key) : array_map([&$this, 'strUuidSuffix'], $key);

        return $keyName;
    }

    public function getKeyName()
    {
        return (! property_exists($this, 'primaryKey') || $this->primaryKey === 'id') ? 'uuid' : $this->primaryKey;
    }

    public function getIncrementing()
    {
        return false;
    }

    public function resolveRouteBinding($value)
    {
        $keyName = $this->getRouteKeyName();

        if (is_array($keyName)) {
            $parsed = explode(':', strval($value), count($keyName));

            $value = array_combine($keyName, $parsed);
        }

        return $this->withUuid($value)->first();

    }

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

        return "{$str}{$suffix}";
    }

    private function decodeIdArray($ids)

    {
        foreach ($ids as $key => $id) {
            $ids[$key] = base64_decode($id);
        }

        return $ids;
    }
}


1			<?php
2
3			namespace Spatie\BinaryUuid;
4
5			use Exception;
6			use Ramsey\Uuid\Uuid;
7			use Illuminate\Database\Eloquent\Model;
8
9			trait HasBinaryUuid
10			{
11			protected static function bootHasBinaryUuid()
12			{
13			static::creating(function (Model $model) {
14			$uuidAttributes = $model->getUuidAttributes();
15
16			foreach ($uuidAttributes as $key) {
17			if ($model->{$key}) {
18			continue;
19			}
20
21			$model->{$key} = static::encodeUuid(static::generateUuid());
22			}
23			});
24			}
25
26			public static function scopeWithUuid(Builder $builder, $uuid, $field = null): Builder
27			{
28			if ($field) {
29			return static::scopeWithUuidRelation($builder, $uuid, $field);
30			}
31
32			if ($uuid instanceof Uuid) {
33			$uuid = (string) $uuid;
34			}
35
36			$uuid = (array) $uuid;
37
38			return $builder->whereKey(array_map(function (string $modelUuid) {
39			return static::encodeUuid($modelUuid);
40			}, $uuid));
41			}
42
43			public static function scopeWithUuidRelation(Builder $builder, $uuid, string $field): Builder
44			{
45			if ($uuid instanceof Uuid) {
46			$uuid = (string) $uuid;
47			}
48
49			$uuid = (array) $uuid;
50
51			return $builder->whereIn($field, array_map(function (string $modelUuid) {
			0 ignored issues – show Documentation Bug introduced 2018-09-19 06:52 UTC by Report Bug Copy Issue Report The method `whereIn` does not exist on `object<Spatie\BinaryUuid\Builder>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
52			return static::encodeUuid($modelUuid);
53			}, $uuid));
54			}
55
56			public static function generateUuid() : string
57			{
58			return Uuid::uuid1();
59			}
60
61			public static function encodeUuid($uuid): string
62			{
63			if (! Uuid::isValid($uuid)) {
64			return $uuid;
65			}
66
67			if (! $uuid instanceof Uuid) {
68			$uuid = Uuid::fromString($uuid);
69			}
70
71			return $uuid->getBytes();
72			}
73
74			public static function decodeUuid(string $binaryUuid): string
75			{
76			if (Uuid::isValid($binaryUuid)) {
77			return $binaryUuid;
78			}
79
80			return Uuid::fromBytes($binaryUuid)->toString();
81			}
82
83			public function isBinary($uuidStr)
84			{
85			return preg_match('~[^\x20-\x7E\t\r\n]~', $uuidStr) > 0;
86			}
87
88			public function getUuidKeys()
89			{
90			return (property_exists($this, 'uuids') && is_array($this->uuids)) ? $this->uuids : [];
			0 ignored issues – show Bug introduced 2018-09-26 13:38 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...
91			}
92
93			public function toArray()
94			{
95			$uuidAttributes = $this->getUuidAttributes();
96
97			$array = parent::toArray();
98			$pivotUuids = [];
			0 ignored issues – show Unused Code introduced 2018-09-26 13:38 UTC by Report Bug Copy Issue Report `$pivotUuids` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
99
100			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...
101			return $array;
102			}
103
104			foreach ($uuidAttributes as $attributeKey) {
105			if (! array_key_exists($attributeKey, $array)) {
106			continue;
107			}
108			$uuidKey = $this->getRelatedBinaryKeyName($attributeKey);
109			$array[$attributeKey] = $this->{$uuidKey};
110			}
111
112			if (isset($array['pivot'])) {
113			$pivotUuids = $array['pivot'];
114
115			if (! is_array($pivotUuids)) {
116			$pivotUuids = get_object_vars($pivotUuids);
117			}
118
119			foreach ($pivotUuids as $key => $uuid) {
120			if ($this->isBinary($uuid)) {
121			$pivotUuids[$key] = $this->decodeUuid($uuid);
122			}
123			}
124
125			$array['pivot'] = $pivotUuids;
126			}
127
128			return $array;
129			}
130
131			public function getRelatedBinaryKeyName($attribute): string
132			{
133			$suffix = $this->getUuidSuffix();
134
135			return preg_match('/(?:[a-zA-Z_]+)?id/i', $attribute) ? "{$attribute}{$suffix}" : $attribute;
136			}
137
138			public function getAttribute($key)
139			{
140			$uuidKey = $this->uuidTextAttribute($key);
141
142			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...
143			return static::decodeUuid($this->{$uuidKey});
144			}
145
146			return parent::getAttribute($key);
147			}
148
149			public function setAttribute($key, $value)
150			{
151			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...
152			$value = static::encodeUuid($value);
153			}
154
155			return parent::setAttribute($key, $value);
156			}
157
158			protected function getUuidSuffix()
159			{
160			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...
161			}
162
163			protected function uuidTextAttribute($key)
164			{
165			$uuidAttributes = $this->getUuidAttributes();
166			$suffix = $this->getUuidSuffix();
167			$offset = -(strlen($suffix));
168
169			if (substr($key, $offset) == $suffix && in_array(($uuidKey = substr($key, 0, $offset)), $uuidAttributes)) {
170			return $uuidKey;
171			}
172
173			return false;
174			}
175
176			public function getUuidAttributes()
177			{
178			$uuidKeys = $this->getUuidKeys();
179
180			// non composite primary keys will return a string so casting required
181			$key = (array) $this->getKeyName();
182
183			$uuidAttributes = array_unique(array_merge($uuidKeys, $key));
184
185			return $uuidAttributes;
186			}
187
188			public function getUuidTextAttribute(): ?string
189			{
190			$key = $this->getKeyName();
191
192			if (! $this->exists \|\| is_array($key)) {
193			return null;
194			}
195
196			return static::decodeUuid($this->{$key});
197			}
198
199			public function setUuidTextAttribute(string $uuid)
200			{
201			$key = $this->getKeyName();
202
203			if (! is_string($key)) {
204			throw new Exception('composite keys not allowed for attribute mutation');
205			}
206
207			$this->{$key} = static::encodeUuid($uuid);
208			}
209
210			public function getQueueableId()
211			{
212			return base64_encode($this->{$this->getKeyName()});
213			}
214
215			public function newQueryForRestoration($id)
216			{
217			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...
218			}
219
220			public function newEloquentBuilder($query)
221			{
222			return new Builder($query);
223			}
224
225			public function getRouteKeyName()
226			{
227			$key = $this->primaryKey;
			0 ignored issues – show Bug introduced 2018-10-04 12:12 UTC by Report Bug Copy Issue Report The property `primaryKey` 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...
228
229			$keyName = is_string($key) ? $this->strUuidSuffix($key) : array_map([&$this, 'strUuidSuffix'], $key);
230
231			return $keyName;
232			}
233
234			public function getKeyName()
235			{
236			return (! property_exists($this, 'primaryKey') \|\| $this->primaryKey === 'id') ? 'uuid' : $this->primaryKey;
237			}
238
239			public function getIncrementing()
240			{
241			return false;
242			}
243
244			public function resolveRouteBinding($value)
245			{
246			$keyName = $this->getRouteKeyName();
247
248			if (is_array($keyName)) {
249			$parsed = explode(':', strval($value), count($keyName));
250
251			$value = array_combine($keyName, $parsed);
252			}
253
254			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...
255			}
256
257			public function strUuidSuffix($str)
258			{
259			$suffix = $this->getUuidSuffix();
260
261			return "{$str}{$suffix}";
262			}
263
264			private function decodeIdArray($ids)
			0 ignored issues – show Unused Code introduced 2018-10-04 12:12 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
265			{
266			foreach ($ids as $key => $id) {
267			$ids[$key] = base64_decode($id);
268			}
269
270			return $ids;
271			}
272			}
273

spatie / laravel-binary-uuid

Pull Request — master (#71)

HasBinaryUuid::getUuidKeys() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like