HasBinaryUuid::toArray() - Code Metrics - Inspection of "first fixes draft" - spatie/laravel-binary-uuid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#71)

unknown

created 2018-09-26 13:41 UTC

HasBinaryUuid::toArray() B

↳ Parent: HasBinaryUuid

Complexity

Conditions	9
Paths	10

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	37
rs	7.7724
c	0
b	0
f	0
cc	9
nc	10
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) {
            $keyName = (array) $model->getKeyName();
            $uuidKeys = $model->getUuidKeys();

            foreach ($keyName as $key) {
                if (! in_array($key, $uuidKeys) || $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('/(?: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()
    {
        $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_array($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()
    {
        $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 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			$keyName = (array) $model->getKeyName();
15			$uuidKeys = $model->getUuidKeys();
16
17			foreach ($keyName as $key) {
18			if (! in_array($key, $uuidKeys) \|\| $model->{$key}) {
19			continue;
20			}
21
22			$model->{$key} = static::encodeUuid(static::generateUuid());
23			}
24			});
25			}
26
27			public static function scopeWithUuid(Builder $builder, $uuid, $field = null): Builder
28			{
29			if ($field) {
30			return static::scopeWithUuidRelation($builder, $uuid, $field);
31			}
32
33			if ($uuid instanceof Uuid) {
34			$uuid = (string) $uuid;
35			}
36
37			$uuid = (array) $uuid;
38
39			return $builder->whereKey(array_map(function (string $modelUuid) {
40			return static::encodeUuid($modelUuid);
41			}, $uuid));
42			}
43
44			public static function scopeWithUuidRelation(Builder $builder, $uuid, string $field): Builder
45			{
46			if ($uuid instanceof Uuid) {
47			$uuid = (string) $uuid;
48			}
49
50			$uuid = (array) $uuid;
51
52			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...
53			return static::encodeUuid($modelUuid);
54			}, $uuid));
55			}
56
57			public static function generateUuid() : string
58			{
59			return Uuid::uuid1();
60			}
61
62			public static function encodeUuid($uuid): string
63			{
64			if (! Uuid::isValid($uuid)) {
65			return $uuid;
66			}
67
68			if (! $uuid instanceof Uuid) {
69			$uuid = Uuid::fromString($uuid);
70			}
71
72			return $uuid->getBytes();
73			}
74
75			public static function decodeUuid(string $binaryUuid): string
76			{
77			if (Uuid::isValid($binaryUuid)) {
78			return $binaryUuid;
79			}
80
81			return Uuid::fromBytes($binaryUuid)->toString();
82			}
83
84			public function isBinary($uuidStr)
85			{
86			return preg_match('~[^\x20-\x7E\t\r\n]~', $uuidStr) > 0;
87			}
88
89			public function getUuidKeys()
90			{
91			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...
92			}
93
94			public function toArray()
95			{
96			$uuidAttributes = $this->getUuidAttributes();
97
98			$array = parent::toArray();
99			$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...
100
101			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...
102			return $array;
103			}
104
105			foreach ($uuidAttributes as $attributeKey) {
106			if (! array_key_exists($attributeKey, $array)) {
107			continue;
108			}
109			$uuidKey = $this->getRelatedBinaryKeyName($attributeKey);
110			$array[$attributeKey] = $this->{$uuidKey};
111			}
112
113			if (isset($array['pivot'])) {
114			$pivotUuids = $array['pivot'];
115
116			if (! is_array($pivotUuids)) {
117			$pivotUuids = get_object_vars($pivotUuids);
118			}
119
120			foreach ($pivotUuids as $key => $uuid) {
121			if ($this->isBinary($uuid)) {
122			$pivotUuids[$key] = $this->decodeUuid($uuid);
123			}
124			}
125
126			$array['pivot'] = $pivotUuids;
127			}
128
129			return $array;
130			}
131
132			public function getRelatedBinaryKeyName($attribute): string
133			{
134			$suffix = $this->getUuidSuffix();
135
136			return preg_match('/(?:uu)?id/i', $attribute) ? "{$attribute}{$suffix}" : $attribute;
137			}
138
139			public function getAttribute($key)
140			{
141			$uuidKey = $this->uuidTextAttribute($key);
142
143			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...
144			return static::decodeUuid($this->{$uuidKey});
145			}
146
147			return parent::getAttribute($key);
148			}
149
150			public function setAttribute($key, $value)
151			{
152			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...
153			$value = static::encodeUuid($value);
154			}
155
156			return parent::setAttribute($key, $value);
157			}
158
159			protected function getUuidSuffix()
160			{
161			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...
162			}
163
164			protected function uuidTextAttribute($key)
165			{
166			$uuidAttributes = $this->getUuidAttributes();
167			$suffix = $this->getUuidSuffix();
168			$offset = -(strlen($suffix));
169
170			if (substr($key, $offset) == $suffix && in_array(($uuidKey = substr($key, 0, $offset)), $uuidAttributes)) {
171			return $uuidKey;
172			}
173
174			return false;
175			}
176
177			public function getUuidAttributes()
178			{
179			$uuidKeys = $this->getUuidKeys();
180
181			// non composite primary keys will return a string so casting required
182			$key = (array) $this->getKeyName();
183
184			$uuidAttributes = array_unique(array_merge($uuidKeys, $key));
185
186			return $uuidAttributes;
187			}
188
189			public function getUuidTextAttribute(): ?string
190			{
191			$key = $this->getKeyName();
192
193			if (! $this->exists \|\| is_array($key)) {
194			return null;
195			}
196
197			return static::decodeUuid($this->{$key});
198			}
199
200			public function setUuidTextAttribute(string $uuid)
201			{
202			$key = $this->getKeyName();
203
204			if (is_array($key)) {
205			throw new Exception('composite keys not allowed for attribute mutation');
206			}
207
208			$this->{$key} = static::encodeUuid($uuid);
209			}
210
211			public function getQueueableId()
212			{
213			return base64_encode($this->{$this->getKeyName()});
214			}
215
216			public function newQueryForRestoration($id)
217			{
218			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...
219			}
220
221			public function newEloquentBuilder($query)
222			{
223			return new Builder($query);
224			}
225
226			public function getRouteKeyName()
227			{
228			$suffix = $this->getUuidSuffix();
229
230			return "uuid{$suffix}";
231			}
232
233			public function getKeyName()
234			{
235			return 'uuid';
236			}
237
238			public function getIncrementing()
239			{
240			return false;
241			}
242
243			public function resolveRouteBinding($value)
244			{
245			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...
246			}
247			}
248

spatie / laravel-binary-uuid

Pull Request — master (#71)

HasBinaryUuid::toArray() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like