Make it possible to prune Email models

Author: marickvantuil

README.md

@@ -252,3 +252,28 @@ To enable, set the following environment variable:
 ```
 LARAVEL_DATABASE_EMAILS_SEND_IMMEDIATELY=true
 ```
+
+### Pruning models
+
+```php
+use Stackkit\LaravelDatabaseEmails\Email;
+
+$schedule->command('model:prune', [
+    '--model' => [Email::class],
+])->everyMinute();
+```
+
+By default, e-mails are pruned when they are older than 6 months.
+
+You may change that by adding the following to the AppServiceProvider.php:
+
+```php
+use Stackkit\LaravelDatabaseEmails\Email;
+
+public function register(): void
+{
+    Email::pruneWhen(function (Email $email) {
+        return $email->where(...);
+    });
+}
+```

src/Email.php

@@ -4,9 +4,12 @@
 
 namespace Stackkit\LaravelDatabaseEmails;
 
+use Closure;
 use Exception;
 use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Prunable;
 
 /**
  * @property $id
@@ -34,6 +37,7 @@
 class Email extends Model
 {
     use HasEncryptedAttributes;
+    use Prunable;
 
     /**
      * The table in which the e-mails are stored.
@@ -49,6 +53,8 @@ class Email extends Model
      */
     protected $guarded = [];
 
+    public static ?Closure $pruneQuery = null;
+
     /**
      * Compose a new e-mail.
      *
@@ -551,4 +557,25 @@ public function getRawDatabaseValue(string $key = null, $default = null)
 
         return $this->getOriginal($key, $default);
     }
+
+    /**
+     * @param Closure $closure
+     * @return void
+     */
+    public static function pruneWhen(Closure $closure)
+    {
+        static::$pruneQuery = $closure;
+    }
+
+    /**
+     * @return Builder
+     */
+    public function prunable()
+    {
+        if (static::$pruneQuery) {
+            return (static::$pruneQuery)($this);
+        }
+
+        return $this->where('created_at', '<', now()->subMonths(6));
+    }
 }

tests/PruneTest.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Tests;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Carbon;
+use Stackkit\LaravelDatabaseEmails\Email;
+
+class PruneTest extends TestCase
+{
+    /** @test */
+    public function by_default_mails_are_pruned_after_6_months()
+    {
+        $email = $this->sendEmail();
+
+        Carbon::setTestNow($email->created_at . ' + 6 months');
+        $this->artisan('model:prune', ['--model' => [Email::class]]);
+        $this->assertInstanceOf(Email::class, $email->fresh());
+
+        Carbon::setTestNow($email->created_at . ' + 6 months + 1 day');
+
+        // Ensure the email object has to be passed manually, otherwise we are acidentally
+        // deleting everyone's e-mails...
+        $this->artisan('model:prune');
+        $this->assertInstanceOf(Email::class, $email->fresh());
+
+        // Now test with it passed... then it should definitely be deleted.
+        $this->artisan('model:prune', ['--model' => [Email::class]]);
+        $this->assertNull($email->fresh());
+    }
+
+    /** @test */
+    public function can_change_when_emails_are_pruned()
+    {
+        Email::pruneWhen(function (Email $email) {
+            return $email->where('created_at', '<', now()->subMonths(3));
+        });
+
+        $email = $this->sendEmail();
+
+        Carbon::setTestNow($email->created_at . ' + 3 months');
+        $this->artisan('model:prune', ['--model' => [Email::class]]);
+        $this->assertInstanceOf(Email::class, $email->fresh());
+
+        Carbon::setTestNow($email->created_at . ' + 3 months + 1 day');
+        $this->artisan('model:prune', ['--model' => [Email::class]]);
+        $this->assertNull($email->fresh());
+    }
+}