HasBinaryUuid::getUuidSuffix() - Code Metrics - Inspection of "Adding dynamic accessors and mutators from $uuidAt..." - spatie/laravel-binary-uuid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#49)

unknown

created 2018-08-07 13:16 UTC

HasBinaryUuid::getUuidSuffix() A

↳ Parent: HasBinaryUuid

Complexity

Conditions	2
Paths	2

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	2
nc	2
nop	0

<?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(Uuid::uuid1());
        });
    }

    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 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)
    {
        $suffix = $this->getUuidTextAttributeSuffix();


        return preg_match("/(?:uu)?id/i", $attribute) !== null ? "{$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 null;
    }

    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
    {
        if (! $this->exists) {
            return null;
        }

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

    public function setUuidTextAttribute(string $uuid)
    {
        $this->{$this->getKeyName()} = 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(Uuid::uuid1());
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 encodeUuid($uuid): string
53			{
54			if (! Uuid::isValid($uuid)) {
55			return $uuid;
56			}
57
58			if (! $uuid instanceof Uuid) {
59			$uuid = Uuid::fromString($uuid);
60			}
61
62			return $uuid->getBytes();
63			}
64
65			public static function decodeUuid(string $binaryUuid): string
66			{
67			if (Uuid::isValid($binaryUuid)) {
68			return $binaryUuid;
69			}
70
71			return Uuid::fromBytes($binaryUuid)->toString();
72			}
73
74			public function toArray()
75			{
76			$uuidAttributes = $this->getUuidAttributes();
77
78			$array = parent::toArray();
79
80			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...
81			return $array;
82			}
83
84			foreach ($uuidAttributes as $attributeKey) {
85			if (! array_key_exists($attributeKey, $array)) {
86			continue;
87			}
88			$uuidKey = $this->getRelatedBinaryKeyName($attributeKey);
89			$array[$attributeKey] = $this->{$uuidKey};
90			}
91
92			return $array;
93			}
94
95			public function getRelatedBinaryKeyName($attribute)
96			{
97			$suffix = $this->getUuidTextAttributeSuffix();
			0 ignored issues – show Bug introduced 2018-08-07 13:08 UTC by Report Bug Copy Issue Report The method `getUuidTextAttributeSuffix()` does not exist on `Spatie\BinaryUuid\HasBinaryUuid`. Did you maybe mean `uuidTextAttribute()`? 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...
98
99			return preg_match("/(?:uu)?id/i", $attribute) !== null ? "{$attribute}{$suffix}" : $attribute;
100			}
101
102			public function getAttribute($key)
103			{
104			$uuidKey = $this->uuidTextAttribute($key);
105
106			if ($uuidKey && $this->{$uuidKey} !== null) {
			0 ignored issues – show Bug Best Practice introduced 2018-08-07 13:08 UTC by Report Bug Copy Issue Report The expression `$uuidKey` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` 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...
107			return static::decodeUuid($this->{$uuidKey});
108			}
109
110			return parent::getAttribute($key);
111			}
112
113			public function setAttribute($key, $value)
114			{
115			if ($this->uuidTextAttribute($key)) {
			0 ignored issues – show Bug Best Practice introduced 2018-08-07 13:08 UTC by Report Bug Copy Issue Report The expression `$this->uuidTextAttribute($key)` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` 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...
116			$value = static::encodeUuid($value);
117			}
118
119			return parent::setAttribute($key, $value);
120			}
121
122			protected function getUuidSuffix()
123			{
124			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...
125			}
126
127			protected function uuidTextAttribute($key)
128			{
129			$uuidAttributes = $this->getUuidAttributes();
130			$suffix = $this->getUuidSuffix();
131			$offset = -(strlen($suffix));
132
133			if (substr($key, $offset) == $suffix && in_array(($uuidKey = substr($key, 0, $offset)), $uuidAttributes)) {
134			return $uuidKey;
135			}
136
137			return null;
138			}
139
140			public function getUuidAttributes()
141			{
142			$uuidAttributes = [];
143
144			if (property_exists($this, 'uuids') && is_array($this->uuids)) {
145			$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...
146			}
147
148			// non composite primary keys will return a string so casting required
149			$key = (array) $this->getKeyName();
150
151			$uuidAttributes = array_unique(array_merge($uuidAttributes, $key));
152
153			return $uuidAttributes;
154			}
155
156			public function getUuidTextAttribute(): ?string
157			{
158			if (! $this->exists) {
159			return null;
160			}
161
162			return static::decodeUuid($this->{$this->getKeyName()});
163			}
164
165			public function setUuidTextAttribute(string $uuid)
166			{
167			$this->{$this->getKeyName()} = static::encodeUuid($uuid);
168			}
169
170			public function getQueueableId()
171			{
172			return base64_encode($this->{$this->getKeyName()});
173			}
174
175			public function newQueryForRestoration($id)
176			{
177			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...
178			}
179
180			public function getRouteKeyName()
181			{
182			$suffix = $this->getUuidSuffix();
183
184			return "uuid{$suffix}";
185			}
186
187			public function getKeyName()
188			{
189			return 'uuid';
190			}
191
192			public function getIncrementing()
193			{
194			return false;
195			}
196
197			public function resolveRouteBinding($value)
198			{
199			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...
200			}
201			}
202

spatie / laravel-binary-uuid

Pull Request — master (#49)

HasBinaryUuid::getUuidSuffix() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like