DetectsChanges - Code Metrics - Inspection of "v3.9.0 - changelog" - spatie/laravel-activitylog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a28239...dac271 )

by Tom

created 2019-10-06 13:07 UTC

DetectsChanges A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	166
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

97.59%

Importance

Changes

Metric	Value
wmc	36
lcom	1
cbo	5
dl	0
loc	166
ccs	81
cts	83
cp	0.9759
rs	9.52
c	0
b	0
f	0

8 Methods

Rating	Name	Size	Complexity
B	attributeValuesToBeLogged()	39	10
A	bootDetectsChanges()	13	2
B	attributesToBeLogged()	26	9
A	shouldLogOnlyDirty()	8	2
A	shouldLogUnguarded()	16	4
B	logChanges()	30	6
A	getRelatedModelAttributeValue()	14	2
A	getModelAttributeJsonValue()	8	1

<?php

namespace Spatie\Activitylog\Traits;

use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Exceptions\CouldNotLogChanges;

trait DetectsChanges
{
    protected $oldAttributes = [];

    protected static function bootDetectsChanges()
    {
        if (static::eventsToBeRecorded()->contains('updated')) {
            static::updating(function (Model $model) {

                //temporary hold the original attributes on the model
                //as we'll need these in the updating event
                $oldValues = (new static)->setRawAttributes($model->getOriginal());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

                $model->oldAttributes = static::logChanges($oldValues);
            });
        }
    }

    public function attributesToBeLogged(): array
    {
        $attributes = [];

        if (isset(static::$logFillable) && static::$logFillable) {
            $attributes = array_merge($attributes, $this->getFillable());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        if ($this->shouldLogUnguarded()) {
            $attributes = array_merge($attributes, array_diff(array_keys($this->getAttributes()), $this->getGuarded()));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        if (isset(static::$logAttributes) && is_array(static::$logAttributes)) {
            $attributes = array_merge($attributes, array_diff(static::$logAttributes, ['*']));

            if (in_array('*', static::$logAttributes)) {
                $attributes = array_merge($attributes, array_keys($this->getAttributes()));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        }

        if (isset(static::$logAttributesToIgnore) && is_array(static::$logAttributesToIgnore)) {
            $attributes = array_diff($attributes, static::$logAttributesToIgnore);
        }

        return $attributes;
    }

    public function shouldLogOnlyDirty(): bool
    {
        if (! isset(static::$logOnlyDirty)) {
            return false;
        }

        return static::$logOnlyDirty;
    }

    public function shouldLogUnguarded(): bool
    {
        if (! isset(static::$logUnguarded)) {
            return false;
        }

        if (! static::$logUnguarded) {
            return false;
        }

        if (in_array('*', $this->getGuarded())) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            return false;
        }

        return true;
    }

    public function attributeValuesToBeLogged(string $processingEvent): array
    {
        if (! count($this->attributesToBeLogged())) {
            return [];
        }

        $properties['attributes'] = static::logChanges(
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            $this->exists
class MyClass { }

$x = new MyClass();
$x->foo = true;
                ? $this->fresh() ?? $this
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                : $this
        );

        if (static::eventsToBeRecorded()->contains('updated') && $processingEvent == 'updated') {
            $nullProperties = array_fill_keys(array_keys($properties['attributes']), null);

            $properties['old'] = array_merge($nullProperties, $this->oldAttributes);

            $this->oldAttributes = [];
        }

        if ($this->shouldLogOnlyDirty() && isset($properties['old'])) {
            $properties['attributes'] = array_udiff_assoc(
                $properties['attributes'],
                $properties['old'],
                function ($new, $old) {
                    if ($old === null || $new === null) {
                        return $new === $old ? 0 : 1;
                    }

                    return $new <=> $old;
                }
            );
            $properties['old'] = collect($properties['old'])
                ->only(array_keys($properties['attributes']))
                ->all();
        }

        return $properties;
    }

    public static function logChanges(Model $model): array
    {
        $changes = [];
        $attributes = $model->attributesToBeLogged();

        foreach ($attributes as $attribute) {
            if (Str::contains($attribute, '.')) {
                $changes += self::getRelatedModelAttributeValue($model, $attribute);
            } elseif (Str::contains($attribute, '->')) {
                Arr::set(
                    $changes,
                    str_replace('->', '.', $attribute),
                    static::getModelAttributeJsonValue($model, $attribute)
                );
            } else {
                $changes[$attribute] = $model->getAttribute($attribute);

                if (
                    in_array($attribute, $model->getDates())
                    && ! is_null($changes[$attribute])
                ) {
                    $changes[$attribute] = $model->serializeDate(

                        $model->asDateTime($changes[$attribute])

                    );
                }
            }
        }

        return $changes;
    }

    protected static function getRelatedModelAttributeValue(Model $model, string $attribute): array
    {
        if (substr_count($attribute, '.') > 1) {
            throw CouldNotLogChanges::invalidAttribute($attribute);
        }

        [$relatedModelName, $relatedAttribute] = explode('.', $attribute);
function someFunction() {
    $x = 5;
    echo $x;
}

        $relatedModelName = Str::camel($relatedModelName);
function someFunction() {
    $x = 5;
    echo $x;
}

        $relatedModel = $model->$relatedModelName ?? $model->$relatedModelName();

        return ["{$relatedModelName}.{$relatedAttribute}" => $relatedModel->$relatedAttribute ?? null];

    }

    protected static function getModelAttributeJsonValue(Model $model, string $attribute)
    {
        $path = explode('->', $attribute);
        $modelAttribute = array_shift($path);
        $modelAttribute = collect($model->getAttribute($modelAttribute));

        return data_get($modelAttribute, implode('.', $path));
    }
}


1		<?php
2
3		namespace Spatie\Activitylog\Traits;
4
5		use Illuminate\Support\Arr;
6		use Illuminate\Support\Str;
7		use Illuminate\Database\Eloquent\Model;
8		use Spatie\Activitylog\Exceptions\CouldNotLogChanges;
9
10		trait DetectsChanges
11		{
12		protected $oldAttributes = [];
13
14	216	protected static function bootDetectsChanges()
15		{
16	216	if (static::eventsToBeRecorded()->contains('updated')) {
17		static::updating(function (Model $model) {
18
19		//temporary hold the original attributes on the model
20		//as we'll need these in the updating event
21	112	$oldValues = (new static)->setRawAttributes($model->getOriginal());
		0 ignored issues – show Bug introduced 2019-05-21 07:03 UTC by Report Bug Copy Issue Report It seems like `setRawAttributes()` 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...
22
23	112	$model->oldAttributes = static::logChanges($oldValues);
24	216	});
25		}
26	216	}
27
28	208	public function attributesToBeLogged(): array
29		{
30	208	$attributes = [];
31
32	208	if (isset(static::$logFillable) && static::$logFillable) {
33	8	$attributes = array_merge($attributes, $this->getFillable());
		0 ignored issues – show Bug introduced 2018-10-16 15:15 UTC by Report Bug Copy Issue Report It seems like `getFillable()` 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...
34		}
35
36	208	if ($this->shouldLogUnguarded()) {
37	4	$attributes = array_merge($attributes, array_diff(array_keys($this->getAttributes()), $this->getGuarded()));
		0 ignored issues – show Bug introduced 2018-10-16 15:15 UTC by Report Bug Copy Issue Report It seems like `getAttributes()` 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... Bug introduced 2018-10-16 15:15 UTC by Report Bug Copy Issue Report It seems like `getGuarded()` 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...
38		}
39
40	208	if (isset(static::$logAttributes) && is_array(static::$logAttributes)) {
41	136	$attributes = array_merge($attributes, array_diff(static::$logAttributes, ['*']));
42
43	136	if (in_array('*', static::$logAttributes)) {
44	32	$attributes = array_merge($attributes, array_keys($this->getAttributes()));
		0 ignored issues – show Bug introduced 2018-10-16 15:15 UTC by Report Bug Copy Issue Report It seems like `getAttributes()` 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...
45		}
46		}
47
48	208	if (isset(static::$logAttributesToIgnore) && is_array(static::$logAttributesToIgnore)) {
49	8	$attributes = array_diff($attributes, static::$logAttributesToIgnore);
50		}
51
52	208	return $attributes;
53		}
54
55	140	public function shouldLogOnlyDirty(): bool
56		{
57	140	if (! isset(static::$logOnlyDirty)) {
58	80	return false;
59		}
60
61	60	return static::$logOnlyDirty;
62		}
63
64	208	public function shouldLogUnguarded(): bool
65		{
66	208	if (! isset(static::$logUnguarded)) {
67	200	return false;
68		}
69
70	8	if (! static::$logUnguarded) {
71		return false;
72		}
73
74	8	if (in_array('*', $this->getGuarded())) {
		0 ignored issues – show Bug introduced 2018-10-18 01:11 UTC by Report Bug Copy Issue Report It seems like `getGuarded()` 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...
75	4	return false;
76		}
77
78	4	return true;
79		}
80
81	208	public function attributeValuesToBeLogged(string $processingEvent): array
82		{
83	208	if (! count($this->attributesToBeLogged())) {
84	68	return [];
85		}
86
87	140	$properties['attributes'] = static::logChanges(
		0 ignored issues – show Coding Style Comprehensibility introduced 2019-10-02 00:07 UTC by Report Bug Copy Issue Report `$properties` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$properties = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
88	140	$this->exists
		0 ignored issues – show Bug introduced 2017-09-28 06:30 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...
89	140	? $this->fresh() ?? $this
		0 ignored issues – show Bug introduced 2017-09-28 06:30 UTC by Report Bug Copy Issue Report It seems like `fresh()` 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...
90	140	: $this
91		);
92
93	140	if (static::eventsToBeRecorded()->contains('updated') && $processingEvent == 'updated') {
94	88	$nullProperties = array_fill_keys(array_keys($properties['attributes']), null);
95
96	88	$properties['old'] = array_merge($nullProperties, $this->oldAttributes);
97
98	88	$this->oldAttributes = [];
99		}
100
101	140	if ($this->shouldLogOnlyDirty() && isset($properties['old'])) {
102	56	$properties['attributes'] = array_udiff_assoc(
103	56	$properties['attributes'],
104	56	$properties['old'],
105		function ($new, $old) {
106	56	if ($old === null \|\| $new === null) {
107	20	return $new === $old ? 0 : 1;
108		}
109
110	52	return $new <=> $old;
111	56	}
112		);
113	56	$properties['old'] = collect($properties['old'])
114	56	->only(array_keys($properties['attributes']))
115	56	->all();
116		}
117
118	140	return $properties;
119		}
120
121	164	public static function logChanges(Model $model): array
122		{
123	164	$changes = [];
124	164	$attributes = $model->attributesToBeLogged();
125
126	164	foreach ($attributes as $attribute) {
127	140	if (Str::contains($attribute, '.')) {
128	24	$changes += self::getRelatedModelAttributeValue($model, $attribute);
129	140	} elseif (Str::contains($attribute, '->')) {
130	24	Arr::set(
131	24	$changes,
132	24	str_replace('->', '.', $attribute),
133	24	static::getModelAttributeJsonValue($model, $attribute)
134		);
135		} else {
136	140	$changes[$attribute] = $model->getAttribute($attribute);
137
138		if (
139	140	in_array($attribute, $model->getDates())
140	140	&& ! is_null($changes[$attribute])
141		) {
142	32	$changes[$attribute] = $model->serializeDate(
		0 ignored issues – show Bug introduced 2019-05-16 12:44 UTC by Report Bug Copy Issue Report The method `serializeDate()` cannot be called from this context as it is declared protected in class `Illuminate\Database\Eloq...\Concerns\HasAttributes`. This check looks for access to methods that are not accessible from the current context. If you need to make a method accessible to another context you can raise its visibility level in the defining class. Loading history...
143	32	$model->asDateTime($changes[$attribute])
		0 ignored issues – show Bug introduced 2019-05-29 06:34 UTC by Report Bug Copy Issue Report The method `asDateTime()` cannot be called from this context as it is declared protected in class `Illuminate\Database\Eloq...\Concerns\HasAttributes`. This check looks for access to methods that are not accessible from the current context. If you need to make a method accessible to another context you can raise its visibility level in the defining class. Loading history...
144		);
145		}
146		}
147		}
148
149	164	return $changes;
150		}
151
152	24	protected static function getRelatedModelAttributeValue(Model $model, string $attribute): array
153		{
154	24	if (substr_count($attribute, '.') > 1) {
155		throw CouldNotLogChanges::invalidAttribute($attribute);
156		}
157
158	24	[$relatedModelName, $relatedAttribute] = explode('.', $attribute);
		0 ignored issues – show Bug introduced 2019-05-15 13:18 UTC by Report Bug Copy Issue Report The variable `$relatedAttribute` does not exist. Did you mean `$attribute`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history... Bug introduced 2019-10-02 10:11 UTC by Report Bug Copy Issue Report The variable `$relatedModelName` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
159
160	24	$relatedModelName = Str::camel($relatedModelName);
		0 ignored issues – show Bug introduced 2019-10-02 10:11 UTC by Report Bug Copy Issue Report The variable `$relatedModelName` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
161
162	24	$relatedModel = $model->$relatedModelName ?? $model->$relatedModelName();
163
164	24	return ["{$relatedModelName}.{$relatedAttribute}" => $relatedModel->$relatedAttribute ?? null];
		0 ignored issues – show Bug introduced 2019-05-15 13:18 UTC by Report Bug Copy Issue Report The variable `$relatedAttribute` does not exist. Did you mean `$attribute`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
165		}
166
167	24	protected static function getModelAttributeJsonValue(Model $model, string $attribute)
168		{
169	24	$path = explode('->', $attribute);
170	24	$modelAttribute = array_shift($path);
171	24	$modelAttribute = collect($model->getAttribute($modelAttribute));
172
173	24	return data_get($modelAttribute, implode('.', $path));
174		}
175		}
176

spatie / laravel-activitylog

Push — master ( a28239...dac271 )

DetectsChanges A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

Duplication Side-by-Side

Filter issues like