HasBinaryUuid::newEloquentBuilder() - Code Metrics - Inspection of "Merge pull request #53 from vpratfr/find-with-uuid" - spatie/laravel-binary-uuid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0219a7...757819 )

by Brent

created 2018-09-24 07:00 UTC

HasBinaryUuid::newEloquentBuilder() A

↳ Parent: HasBinaryUuid

Complexity

Conditions	1
Paths	1

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	1
nc	1
nop	1

<?php

namespace Spatie\BinaryUuid;

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

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

spatie / laravel-binary-uuid

Push — master ( 0219a7...757819 )

HasBinaryUuid::newEloquentBuilder() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like