DetectsChanges::shouldLogDirtyOnly() - Code Metrics - Inspection of "Log only dirty fields (#171)" - spatie/laravel-activitylog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 12a696...904d31 )

by Freek

created 2017-04-16 19:08 UTC

DetectsChanges::shouldLogDirtyOnly() A

↳ Parent: DetectsChanges

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0

<?php

namespace Spatie\Activitylog\Traits;

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 = $model->replicate()->setRawAttributes($model->getOriginal());

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

    public function attributesToBeLogged(): array
    {
        if (! isset(static::$logAttributes)) {
            return [];
        }

        return static::$logAttributes;
    }

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

        return static::$logDirtyOnly;
    }

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

        $properties['attributes'] = static::logChanges($this->exists ? $this->fresh() : $this);
class MyClass { }

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

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

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

        // Only dirty fields
        if (isset($properties['old']) && $this->shouldLogDirtyOnly()) {
            $properties['attributes'] = collect($properties['attributes'])->diff($properties['old'])->all();
            $properties['old'] = collect($properties['old'])->only(array_keys($properties['attributes']))->all();
        }

        return $properties;
    }

    public static function logChanges(Model $model): array
    {
        return collect($model->attributesToBeLogged())->mapWithKeys(
			function ($attribute) use ($model) {
				if (str_contains($attribute, '.')) {
					return self::getRelatedModelAttributeValue($model, $attribute);
                }

				return collect($model)->only($attribute);
			}
		)->toArray();
    }

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

        list($relatedModelName, $relatedAttribute) = explode('.', $attribute);

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

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


1			<?php
2
3			namespace Spatie\Activitylog\Traits;
4
5			use Illuminate\Database\Eloquent\Model;
6			use Spatie\Activitylog\Exceptions\CouldNotLogChanges;
7
8			trait DetectsChanges
9			{
10			protected $oldAttributes = [];
11
12			protected static function bootDetectsChanges()
13			{
14			if (static::eventsToBeRecorded()->contains('updated')) {
15			static::updating(function (Model $model) {
16			//temporary hold the original attributes on the model
17			//as we'll need these in the updating event
18			$oldValues = $model->replicate()->setRawAttributes($model->getOriginal());
19
20			$model->oldAttributes = static::logChanges($oldValues);
21			});
22			}
23			}
24
25			public function attributesToBeLogged(): array
26			{
27			if (! isset(static::$logAttributes)) {
28			return [];
29			}
30
31			return static::$logAttributes;
32			}
33
34			public function shouldLogDirtyOnly(): bool
35			{
36			if (! isset(static::$logDirtyOnly)) {
37			return false;
38			}
39
40			return static::$logDirtyOnly;
41			}
42
43			public function attributeValuesToBeLogged(string $processingEvent): array
44			{
45			if (! count($this->attributesToBeLogged())) {
46			return [];
47			}
48
49			$properties['attributes'] = static::logChanges($this->exists ? $this->fresh() : $this);
			0 ignored issues – show Bug introduced 2017-03-21 16:36 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... Bug introduced 2017-03-19 10:24 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... Coding Style Comprehensibility introduced 2016-06-25 14:28 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...
50
51			if (static::eventsToBeRecorded()->contains('updated') && $processingEvent == 'updated') {
52			$nullProperties = array_fill_keys(array_keys($properties['attributes']), null);
53
54			$properties['old'] = array_merge($nullProperties, $this->oldAttributes);
55			}
56
57			// Only dirty fields
58			if (isset($properties['old']) && $this->shouldLogDirtyOnly()) {
59			$properties['attributes'] = collect($properties['attributes'])->diff($properties['old'])->all();
60			$properties['old'] = collect($properties['old'])->only(array_keys($properties['attributes']))->all();
61			}
62
63			return $properties;
64			}
65
66			public static function logChanges(Model $model): array
67			{
68			return collect($model->attributesToBeLogged())->mapWithKeys(
69			function ($attribute) use ($model) {
70			if (str_contains($attribute, '.')) {
71			return self::getRelatedModelAttributeValue($model, $attribute);
72			}
73
74			return collect($model)->only($attribute);
75			}
76			)->toArray();
77			}
78
79			protected static function getRelatedModelAttributeValue(Model $model, string $attribute): array
80			{
81			if (substr_count($attribute, '.') > 1) {
82			throw CouldNotLogChanges::invalidAttribute($attribute);
83			}
84
85			list($relatedModelName, $relatedAttribute) = explode('.', $attribute);
86
87			$relatedModel = $model->$relatedModelName ?? $model->$relatedModelName();
88
89			return ["{$relatedModelName}.{$relatedAttribute}" => $relatedModel->$relatedAttribute];
90			}
91			}
92

spatie / laravel-activitylog

Push — master ( 12a696...904d31 )

DetectsChanges::shouldLogDirtyOnly() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like