feat(models): integrate activity logging with LogsModificationsTrait

app/Models/Activity.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Models;
+
+use Spatie\Activitylog\Models\Activity as Model;
+
+class Activity extends Model
+{
+    /**
+     * The name of the "updated at" column.
+     */
+    public const ?string UPDATED_AT = null;
+}

app/Models/Allergen.php

@@ -4,6 +4,7 @@
 
 use App\Models\Concerns\ActivatableTrait;
 use App\Models\Concerns\HasHelloFreshIdsTrait;
+use App\Models\Concerns\LogsModificationsTrait;
 use Database\Factories\AllergenFactory;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -24,6 +25,7 @@ class Allergen extends Model
 
     use HasHelloFreshIdsTrait;
     use HasTranslations;
+    use LogsModificationsTrait;
 
     /**
      * The attributes that are translatable.

app/Models/Concerns/LogsActivityTrait.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace App\Models\Concerns;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
+use Spatie\Activitylog\LogOptions;
+use Spatie\Activitylog\Traits\LogsActivity;
+
+/**
+ * @phpstan-require-extends Model
+ */
+trait LogsActivityTrait
+{
+    use LogsActivity;
+
+    /**
+     * @return list<string>
+     */
+    protected function getDontLogIfAttributesChangedOnly(): array
+    {
+        return ['created_at', 'updated_at', 'deleted_at'];
+    }
+
+    /**
+     * @return string[]
+     */
+    protected function logExceptAttributes(): array
+    {
+        return ['created_at', 'updated_at'];
+    }
+
+    public function getActivitylogOptions(): LogOptions
+    {
+        return LogOptions::defaults()
+            ->dontSubmitEmptyLogs()
+            ->logAll()
+            ->logExcept($this->logExceptAttributes())
+            ->dontLogIfAttributesChangedOnly($this->getDontLogIfAttributesChangedOnly())
+            ->logOnlyDirty()
+            ->useLogName($this->getLogName());
+    }
+
+    protected function getLogName(): string
+    {
+        return $this->formatLogName($this::class);
+    }
+
+    protected function formatLogName(string $class): string
+    {
+        $className = Str::kebab(class_basename($class));
+
+        return Str::plural(explode('-', $className)[0]);
+    }
+
+    /**
+     * Get the event names that should be recorded.
+     *
+     * @return Collection<int, string>
+     */
+    protected static function eventsToBeRecorded(): Collection
+    {
+        $class = static::class;
+
+        /** @var list<string> $doNotRecordEvents */
+        $doNotRecordEvents = property_exists($class, 'doNotRecordEvents') ? $class::$doNotRecordEvents : [];
+        $reject = collect($doNotRecordEvents);
+
+        if (property_exists($class, 'recordEvents')) {
+            /** @var list<string> $recordEvents */
+            $recordEvents = $class::$recordEvents;
+
+            return collect($recordEvents)->reject(fn (string $eventName): bool => $reject->contains($eventName));
+        }
+
+        $events = collect([
+            'created',
+            'updated',
+            'deleted',
+        ]);
+
+        if (collect(class_uses_recursive(static::class))->contains(SoftDeletes::class)) {
+            $events->push('restored');
+        }
+
+        return $events->reject(fn (string $eventName): bool => $reject->contains($eventName));
+    }
+}

app/Models/Concerns/LogsModificationsTrait.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Models\Concerns;
+
+trait LogsModificationsTrait
+{
+    use LogsActivityTrait;
+
+    /**
+     * Events to not record for activity logging.
+     *
+     * @var list<string>
+     */
+    protected static array $doNotRecordEvents = [
+        'created',
+    ];
+}

app/Models/Cuisine.php

@@ -4,6 +4,7 @@
 
 use App\Models\Concerns\ActivatableTrait;
 use App\Models\Concerns\HasHelloFreshIdsTrait;
+use App\Models\Concerns\LogsModificationsTrait;
 use Database\Factories\CuisineFactory;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -24,6 +25,7 @@ class Cuisine extends Model
 
     use HasHelloFreshIdsTrait;
     use HasTranslations;
+    use LogsModificationsTrait;
 
     /**
      * The attributes that are translatable.

app/Models/Ingredient.php

@@ -4,6 +4,7 @@
 
 use App\Models\Concerns\ActivatableTrait;
 use App\Models\Concerns\HasHelloFreshIdsTrait;
+use App\Models\Concerns\LogsModificationsTrait;
 use Database\Factories\IngredientFactory;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -26,6 +27,7 @@ class Ingredient extends Model
 
     use HasHelloFreshIdsTrait;
     use HasTranslations;
+    use LogsModificationsTrait;
 
     /**
      * The attributes that are translatable.

app/Models/Label.php

@@ -4,6 +4,7 @@
 
 use App\Models\Concerns\ActivatableTrait;
 use App\Models\Concerns\HasHandlesTrait;
+use App\Models\Concerns\LogsModificationsTrait;
 use Database\Factories\LabelFactory;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -24,6 +25,7 @@ class Label extends Model
 
     use HasHandlesTrait;
     use HasTranslations;
+    use LogsModificationsTrait;
 
     /**
      * The attributes that are translatable.

app/Models/Menu.php

@@ -3,6 +3,7 @@
 namespace App\Models;
 
 use App\Models\Concerns\ActivatableTrait;
+use App\Models\Concerns\LogsModificationsTrait;
 use Carbon\Carbon;
 use Database\Factories\MenuFactory;
 use Illuminate\Database\Eloquent\Attributes\Scope;
@@ -25,6 +26,8 @@ class Menu extends Model
     /** @use HasFactory<MenuFactory> */
     use HasFactory;
 
+    use LogsModificationsTrait;
+
     /**
      * The attributes that are mass assignable.
      *

app/Models/Recipe.php

@@ -3,6 +3,7 @@
 namespace App\Models;
 
 use App\Models\Concerns\ActivatableTrait;
+use App\Models\Concerns\LogsModificationsTrait;
 use App\Observers\RecipeObserver;
 use App\Support\HelloFresh\HelloFreshAsset;
 use Database\Factories\RecipeFactory;
@@ -30,6 +31,7 @@ class Recipe extends Model
     use HasFactory;
 
     use HasTranslations;
+    use LogsModificationsTrait;
     use SoftDeletes;
 
     /**

app/Models/Tag.php

@@ -4,6 +4,7 @@
 
 use App\Models\Concerns\ActivatableTrait;
 use App\Models\Concerns\HasHelloFreshIdsTrait;
+use App\Models\Concerns\LogsModificationsTrait;
 use Database\Factories\TagFactory;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -24,6 +25,7 @@ class Tag extends Model
 
     use HasHelloFreshIdsTrait;
     use HasTranslations;
+    use LogsModificationsTrait;
 
     /**
      * The attributes that are translatable.

app/Models/Utensil.php

@@ -4,6 +4,7 @@
 
 use App\Models\Concerns\ActivatableTrait;
 use App\Models\Concerns\HasHelloFreshIdsTrait;
+use App\Models\Concerns\LogsModificationsTrait;
 use Database\Factories\UtensilFactory;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -24,6 +25,7 @@ class Utensil extends Model
 
     use HasHelloFreshIdsTrait;
     use HasTranslations;
+    use LogsModificationsTrait;
 
     /**
      * The attributes that are translatable.

composer.json

@@ -46,6 +46,7 @@
         "livewire/flux-pro": "^2.11",
         "norman-huth/gd-text": "^1.0",
         "sentry/sentry-laravel": "^4.20",
+        "spatie/laravel-activitylog": "^4.10",
         "spatie/laravel-medialibrary": "^11.17",
         "spatie/laravel-translatable": "^6.12"
     },