Add trait to return a models last activity as a relation

docs/advanced-usage/logging-model-events.md

@@ -485,3 +485,21 @@ final class PivotModel extends Pivot
 ```
 
 After these changes you can log activities on your pivot models as expected.
+
+## Getting the last activity on the model
+
+You can get the last activity for the model as a relation by using `with(['lastActivity'])` to eager load the activity.
+
+```php
+$newsItem = NewsItem::with(['lastActivity'])->first();
+
+$newsItem->lastActivity // Activity model
+```
+
+You can also retrieve the causer with the last activity.
+
+```php
+$newsItem = NewsItem::with(['lastActivity.causer'])->first();
+
+$newsItem->lastActivity->causer // Causer model
+```

src/Traits/LogsActivity.php

@@ -6,6 +6,7 @@
 use DateInterval;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
+use Illuminate\Database\Eloquent\Relations\MorphOne;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Pipeline\Pipeline;
 use Illuminate\Support\Arr;
@@ -122,6 +123,13 @@ public function activities(): MorphMany
         return $this->morphMany(ActivitylogServiceProvider::determineActivityModel(), 'subject');
     }
 
+    public function lastActivity(): MorphOne
+    {
+        return $this->activities()
+            ->one()
+            ->latestOfMany();
+    }
+
     public function getDescriptionForEvent(string $eventName): string
     {
         if (! empty($this->activitylogOptions->descriptionForEvent)) {

tests/LastActivityTest.php

@@ -0,0 +1,37 @@
+<?php
+
+use Spatie\Activitylog\Test\Models\ArticleWithLastActivity;
+
+it('gets the last activity for the model', function () {
+    $article = ArticleWithLastActivity::first();
+    $article->name = 'Title change';
+    $article->save();
+
+    $article->load('lastActivity');
+
+    expect($article->lastActivity)
+        ->description->toBe('updated')
+        ->subject_type->toBe(ArticleWithLastActivity::class);
+
+    expect($article->lastActivity->changes->toArray())
+        ->toEqual(
+            [
+                'attributes' => [
+                    'name' => 'Title change',
+                ],
+                'old' => [
+                    'name' => 'name 1',
+                ],
+            ],
+        );
+});
+
+it('gets the created activity for the model', function () {
+    $article = ArticleWithLastActivity::create(['name' => 'New article']);
+
+    $createdArticle = ArticleWithLastActivity::with(['lastActivity'])->find($article->id);
+
+    expect($createdArticle->lastActivity)
+        ->description->toBe('created')
+        ->subject_type->toBe(ArticleWithLastActivity::class);
+});

tests/Models/ArticleWithLastActivity.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Spatie\Activitylog\Test\Models;
+
+use Spatie\Activitylog\LogOptions;
+use Spatie\Activitylog\Traits\LogsActivity;
+
+class ArticleWithLastActivity extends Article
+{
+    use LogsActivity;
+
+    public function getActivitylogOptions(): LogOptions
+    {
+        return LogOptions::defaults()
+            ->logOnly(['name']);
+    }
+}