Refactoring

Author: erikgaal

src/Concerns/DetectsChanges.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace Scrn\Journal\Concerns;
+
+use Illuminate\Database\Eloquent\Model;
+
+trait DetectsChanges
+{
+    /** @var array */
+    protected $oldAttributes;
+
+    /**
+     * Boot the detects changes trait for a model.
+     *
+     * @return void
+     */
+    protected static function bootDetectsChanges()
+    {
+        static::updating(function (Model $model) {
+            $oldModel = $model->replicate()->setRawAttributes($model->getOriginal());
+
+            $model->oldAttributes = $oldModel->getLoggedAttributeValues();
+        });
+    }
+
+    /**
+     * Get the old attributes of the model.
+     *
+     * @return array
+     */
+    public function getOldAttributes(): array
+    {
+        return $this->oldAttributes;
+    }
+
+    /**
+     * Get the values of the attributes that should be logged.
+     *
+     * @return array
+     */
+    public function getLoggedAttributeValues(): array
+    {
+        $attributes = [];
+
+        foreach ($this->getLoggedAttributes() as $attribute) {
+            $attributes[$attribute] = $this->getAttribute($attribute);
+        }
+
+        return $attributes;
+    }
+
+    /**
+     * Get the attributes that should be logged.
+     *
+     * @return array
+     */
+    public function getLoggedAttributes(): array
+    {
+        $attributes = $this->loggedAttributes ?? array_keys($this->attributes);
+
+        if (! $this->shouldLogTimestamps()) {
+            $attributes = array_diff($attributes, [static::CREATED_AT, static::UPDATED_AT]);
+        }
+
+        return array_diff($attributes, $this->getIgnoredAttributes());
+    }
+
+    /**
+     * Get the attributes that should never be logged.
+     *
+     * @return array
+     */
+    public function getIgnoredAttributes(): array
+    {
+        return $this->ignoredAttributes ?? [];
+    }
+
+    /**
+     * Determine if timestamps should be logged.
+     *
+     * @return bool
+     */
+    public function shouldLogTimestamps(): bool
+    {
+        return $this->logTimestamps ?? config()->get('journal.timestamps', false);
+    }
+}

src/Concerns/LogsActivity.php

@@ -5,11 +5,11 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
-use Scrn\Journal\Events\ActivityPrepared;
 use Scrn\Journal\Models\Activity;
 
 trait LogsActivity
 {
+    use DetectsChanges;
     use LogsRelatedActivity;
 
     /**
@@ -36,31 +36,23 @@ protected static function bootLogsActivity()
 
                 list($old_data, $new_data) = method_exists($model, $attributeGetter) ? $model->$attributeGetter(...func_get_args()) : null;
 
-                $activity = $model->transformActivity(journal()->action($event)->on($model)->data($old_data, $new_data)->toActivity());
+                $activity = journal()->action($event)->on($model)->data($old_data, $new_data)->toActivity();
 
-                event(new ActivityPrepared($activity));
+                $model->transformActivity($activity)->save();
             });
         }
     }
 
     /**
-     * Get the attributes for a created event.
+     * Get the attributes for the created event.
      *
      * @return array
      */
     public function getCreatedEventAttributes(): array
     {
-        $attributes = [];
-
-        foreach ($this->getAttributes() as $attribute => $value) {
-            if ($this->shouldAttributeBeLogged($attribute)) {
-                $attributes[$attribute] = $value;
-            }
-        }
-
         return [
             null,
-            $attributes,
+            $this->getLoggedAttributeValues(),
         ];
     }
 
@@ -71,15 +63,13 @@ public function getCreatedEventAttributes(): array
      */
     public function getUpdatedEventAttributes(): array
     {
-        $old = [];
-        $new = [];
+        $old = $this->getOldAttributes();
+        $new = $this->getLoggedAttributeValues();
 
-        foreach ($this->getDirty() as $attribute => $value) {
-            if ($this->shouldAttributeBeLogged($attribute)) {
-                $old[$attribute] = $this->getOriginal($attribute);
-                $new[$attribute] = $this->getAttribute($attribute);
-            }
-        }
+        $new = array_diff_uassoc($new, $old, function ($new, $old) {
+            return $new <=> $old;
+        });
+        $old = array_intersect_key($old, $new);
 
         return [
             $old,
@@ -94,22 +84,14 @@ public function getUpdatedEventAttributes(): array
      */
     public function getDeletedEventAttributes(): array
     {
-        $attributes = [];
-
-        foreach ($this->getAttributes() as $attribute => $value) {
-            if ($this->shouldAttributeBeLogged($attribute)) {
-                $attributes[$attribute] = $value;
-            }
-        }
-
         return [
-            $attributes,
+            $this->getLoggedAttributeValues(),
             null,
         ];
     }
 
     /**
-     * Get the attributes for the deleted event.
+     * Get the attributes for the restored event.
      *
      * @return array
      */
@@ -140,53 +122,6 @@ public function getLoggedEvents(): array
         return $events;
     }
 
-    /**
-     * Determine if the attribute should be logged.
-     *
-     * @param string $attribute
-     * @return bool
-     */
-    public function shouldAttributeBeLogged(string $attribute): bool
-    {
-        return in_array($attribute, $this->getLoggedAttributes()) && ! in_array($attribute, $this->getIgnoredAttributes());
-    }
-
-    /**
-     * Get the attributes that should be logged.
-     *
-     * @return array
-     */
-    public function getLoggedAttributes(): array
-    {
-        $attributes = $this->loggedAttributes ?? array_keys($this->attributes);
-
-        if (! $this->shouldLogTimestamps()) {
-            $attributes = array_diff($attributes, [static::CREATED_AT, static::UPDATED_AT]);
-        }
-
-        return $attributes;
-    }
-
-    /**
-     * Get the attributes that should never be logged.
-     *
-     * @return array
-     */
-    public function getIgnoredAttributes(): array
-    {
-        return $this->ignoredAttributes ?? [];
-    }
-
-    /**
-     * Determine if timestamps should be logged.
-     *
-     * @return bool
-     */
-    public function shouldLogTimestamps(): bool
-    {
-        return $this->logTimestamps ?? config()->get('journal.timestamps', false);
-    }
-
     /**
      * Determine if the event should be logged.
      *
@@ -204,31 +139,6 @@ public function shouldLogEvent(string $event): bool
         return true;
     }
 
-    /**
-     * Get the models original relation values.
-     *
-     * @param string $key
-     * @param null $default
-     * @return mixed|array
-     */
-    public function getOriginalRelation(string $key, $default = null)
-    {
-        return array_get($this->originalRelations, $key, $default);
-    }
-
-    /**
-     * Sync a single original relation with its current value.
-     *
-     * @param string $relation
-     * @return $this
-     */
-    public function syncOriginalRelation(string $relation)
-    {
-        $this->originalRelations[$relation] = $this->getRelationValue($relation);
-
-        return $this;
-    }
-
     /**
      * Resolve the attribute getter for the given event.
      *

src/Concerns/LogsRelatedActivity.php

@@ -24,6 +24,31 @@ public static function bootLogsRelatedActivity()
         }
     }
 
+    /**
+     * Get the models original relation values.
+     *
+     * @param string $key
+     * @param null $default
+     * @return mixed|array
+     */
+    public function getOriginalRelation(string $key, $default = null)
+    {
+        return array_get($this->originalRelations, $key, $default);
+    }
+
+    /**
+     * Sync a single original relation with its current value.
+     *
+     * @param string $relation
+     * @return $this
+     */
+    public function syncOriginalRelation(string $relation)
+    {
+        $this->originalRelations[$relation] = $this->getRelationValue($relation);
+
+        return $this;
+    }
+
     /**
      * Get the attributes for the pivot attached event.
      *

src/Journal.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Request;
+use Scrn\Journal\Events\ActivityPrepared;
 use Scrn\Journal\Models\Activity;
 use Scrn\Journal\Resolvers\UserResolver;
 
@@ -127,7 +128,7 @@ public function save(): Activity
     {
         $activity = $this->toActivity();
 
-        $activity->save();
+        event(new ActivityPrepared($activity));
 
         return $activity;
     }