HasBinaryUuid::getKeyName() - 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-06 14:50 UTC

HasBinaryUuid::getKeyName() 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	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) {

            // return $array;
        // }

        if (is_array($uuidAttributes)) {

            foreach ($uuidAttributes as $attributeKey) {

                if (array_key_exists($attributeKey, $array)) {
                    $uuidKey = $this->getRelatedBinaryKeyName($attributeKey);
                    $array[$attributeKey] = $this->{$uuidKey};
                }
            }
        }

        return $array;
    }

    public function getRelatedBinaryKeyName($attrib)
    {

        $suffix = $this->getUuidTextAttributeSuffix();

        return "{$attrib}{$suffix}";
    }

    public function getAttribute($key)
    {

        if (($uuidKey = $this->uuidTextAttribute($key)) && $this->{$uuidKey} !== null) {
            return static::decodeUuid($this->{$uuidKey});
        }

        return parent::getAttribute($key);
    }

    public function setAttribute($key, $value)
    {

        if ($uuidKey = $this->uuidTextAttribute($key)) {
$myVar = 'Value';
$higher = false;

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

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

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

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

    protected function uuidTextAttribute($key)
    {

        $attribute_s = $this->getKeyName();
        $suffix = $this->getUuidTextAttributeSuffix();
        $offset = -(strlen($suffix));

        if (is_string($attribute_s)) {
            $attribute_s = [ $attribute_s ];
        }

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

        return false;
    }

    public function getUuidAttributes()
    {

        $uuidAttributes = [];

        if (property_exists($this, 'uuidAttributes')) {
            $uuidAttributes = $this->uuidAttributes === null ? [] : $this->uuidAttributes;
class MyClass { }

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

        $key = $this->getKeyName();// ! composite primary keys will return an array

        if (is_string($key)) {
            $uuidAttributes = array_merge($uuidAttributes, [ $key ]); 
        } else if (is_array($key)) {
            $uuidAttributes = array_merge($uuidAttributes, $key);
        }

        return $uuidAttributes;
    }
    

    public function getUuidTextAttribute(): ?string
    {
        if (! $this->exists) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            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->getUuidTextAttributeSuffix();

        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
12			protected static function bootHasBinaryUuid()
13			{
14			static::creating(function (Model $model) {
15			if ($model->{$model->getKeyName()}) {
16			return;
17			}
18
19			$model->{$model->getKeyName()} = static::encodeUuid(Uuid::uuid1());
20			});
21			}
22
23			public static function scopeWithUuid(Builder $builder, $uuid, $field = null): Builder
24			{
25			if ($field) {
26			return static::scopeWithUuidRelation($builder, $uuid, $field);
27			}
28
29			if ($uuid instanceof Uuid) {
30			$uuid = (string) $uuid;
31			}
32
33			$uuid = (array) $uuid;
34
35			return $builder->whereKey(array_map(function (string $modelUuid) {
36			return static::encodeUuid($modelUuid);
37			}, $uuid));
38			}
39
40			public static function scopeWithUuidRelation(Builder $builder, $uuid, string $field): Builder
41			{
42			if ($uuid instanceof Uuid) {
43			$uuid = (string) $uuid;
44			}
45
46			$uuid = (array) $uuid;
47
48			return $builder->whereIn($field, array_map(function (string $modelUuid) {
49			return static::encodeUuid($modelUuid);
50			}, $uuid));
51			}
52
53			public static function encodeUuid($uuid): string
54			{
55			if (! Uuid::isValid($uuid)) {
56			return $uuid;
57			}
58
59			if (! $uuid instanceof Uuid) {
60			$uuid = Uuid::fromString($uuid);
61			}
62
63			return $uuid->getBytes();
64			}
65
66			public static function decodeUuid(string $binaryUuid): string
67			{
68			if (Uuid::isValid($binaryUuid)) {
69			return $binaryUuid;
70			}
71
72			return Uuid::fromBytes($binaryUuid)->toString();
73			}
74
75			public function toArray()
76			{
77
78			$uuidAttributes = $this->getUuidAttributes();
79
80			$array = parent::toArray();
81
82			// if (! $this->exists) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-08-06 14:54 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
83			// return $array;
84			// }
85
86			if (is_array($uuidAttributes)) {
87
88			foreach ($uuidAttributes as $attributeKey) {
89
90			if (array_key_exists($attributeKey, $array)) {
91			$uuidKey = $this->getRelatedBinaryKeyName($attributeKey);
92			$array[$attributeKey] = $this->{$uuidKey};
93			}
94			}
95			}
96
97			return $array;
98			}
99
100			public function getRelatedBinaryKeyName($attrib)
101			{
102
103			$suffix = $this->getUuidTextAttributeSuffix();
104
105			return "{$attrib}{$suffix}";
106			}
107
108			public function getAttribute($key)
109			{
110
111			if (($uuidKey = $this->uuidTextAttribute($key)) && $this->{$uuidKey} !== null) {
112			return static::decodeUuid($this->{$uuidKey});
113			}
114
115			return parent::getAttribute($key);
116			}
117
118			public function setAttribute($key, $value)
119			{
120
121			if ($uuidKey = $this->uuidTextAttribute($key)) {
			0 ignored issues – show Unused Code introduced 2018-01-18 10:55 UTC by Report Bug Copy Issue Report `$uuidKey` 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...
122			$value = static::encodeUuid($value);
123			}
124
125			return parent::setAttribute($key, $value);
126			}
127
128			protected function getUuidTextAttributeSuffix()
129			{
130			return (property_exists($this, 'uuidTextAttribSuffix'))? $this->uuidTextAttribSuffix : '_text';
			0 ignored issues – show Bug introduced 2018-08-06 14:54 UTC by Report Bug Copy Issue Report The property `uuidTextAttribSuffix` 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...
131			}
132
133			protected function uuidTextAttribute($key)
134			{
135
136			$attribute_s = $this->getKeyName();
137			$suffix = $this->getUuidTextAttributeSuffix();
138			$offset = -(strlen($suffix));
139
140			if (is_string($attribute_s)) {
141			$attribute_s = [ $attribute_s ];
142			}
143
144			if (substr($key, $offset) == $suffix && in_array(($uuidKey = substr($key, 0, $offset)), $attribute_s)) {
145			return $uuidKey;
146			}
147
148			return false;
149			}
150
151			public function getUuidAttributes()
152			{
153
154			$uuidAttributes = [];
155
156			if (property_exists($this, 'uuidAttributes')) {
157			$uuidAttributes = $this->uuidAttributes === null ? [] : $this->uuidAttributes;
			0 ignored issues – show Bug introduced 2018-01-18 10:55 UTC by Report Bug Copy Issue Report The property `uuidAttributes` 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...
158			}
159
160			$key = $this->getKeyName();// ! composite primary keys will return an array
161
162			if (is_string($key)) {
163			$uuidAttributes = array_merge($uuidAttributes, [ $key ]);
164			} else if (is_array($key)) {
165			$uuidAttributes = array_merge($uuidAttributes, $key);
166			}
167
168			return $uuidAttributes;
169			}
170
171
172			public function getUuidTextAttribute(): ?string
173			{
174			if (! $this->exists) {
			0 ignored issues – show Bug introduced 2018-08-06 14:54 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...
175			return null;
176			}
177
178			return static::decodeUuid($this->{$this->getKeyName()});
179			}
180
181			public function setUuidTextAttribute(string $uuid)
182			{
183			$this->{$this->getKeyName()} = static::encodeUuid($uuid);
184			}
185
186			public function getQueueableId()
187			{
188			return base64_encode($this->{$this->getKeyName()});
189			}
190
191			public function newQueryForRestoration($id)
192			{
193			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...
194			}
195
196			public function getRouteKeyName()
197			{
198			$suffix = $this->getUuidTextAttributeSuffix();
199
200			return "uuid{$suffix}";
201			}
202
203			public function getKeyName()
204			{
205			return 'uuid';
206			}
207
208			public function getIncrementing()
209			{
210			return false;
211			}
212
213			public function resolveRouteBinding($value)
214			{
215			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...
216			}
217			}
218

spatie / laravel-binary-uuid

Pull Request — master (#49)

HasBinaryUuid::getKeyName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like