Unique functionality.

Author: binaryk

README.md

@@ -303,6 +303,32 @@ You can configure your scheduler to be marked as `completed_at` if in the you cu
 
 To do so, you can use the `stopable()` method.
 
+### Unique
+
+You can configure your scheduler to store a unique relationship with the target class for mailable by specifying: 
+
+```php
+->unique()
+```
+
+ie: 
+
+```php
+Scheduler::init()
+    ->mailable(new InvoiceReminderMailable())
+    ->target($user)
+    ->unique()
+    ->save();
+    
+Scheduler::init()
+    ->mailable(new InvoiceReminderMailable())
+    ->target($user)
+    ->unique()
+    ->save();
+```
+
+This will store a single scheduler for the `$user`. 
+
 ## Run
 
 Now you have to run a scheduler command in your Kernel, and call:

database/migrations/create_mailator_tables.php.stub

@@ -15,6 +15,7 @@ class CreateMailatorTables extends Migration
 
             $table->string('name', 100)->nullable();
             $table->boolean('stopable')->default(false);
+            $table->boolean('unique')->default(false);
             $table->string('tags', 100)->nullable();
             $table->text('mailable_class')->nullable();
             $table->nullableMorphs('targetable');

src/Models/Concerns/HasTarget.php

@@ -5,10 +5,14 @@
 use Binarcode\LaravelMailator\Models\MailatorSchedule;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
+use Illuminate\Database\Query\Builder;
 
 /**
  * Trait HasTarget
  * @mixin MailatorSchedule
+ * @method static Builder|MailatorSchedule targetableType($class)
+ * @method static Builder|MailatorSchedule mailableClass($class)
+ * @method static Builder|MailatorSchedule targetableId($id)
  * @package Binarcode\LaravelMailator\Models\Concerns
  */
 trait HasTarget
@@ -25,4 +29,19 @@ public function target(Model $target): self
 
         return $this;
     }
+
+    public function scopeTargetableType($query, $class)
+    {
+        $query->where('targetable_type', $class);
+    }
+
+    public function scopeMailableClass($query, $class)
+    {
+        $query->where('mailable_class', 'LIKE', "%{$class}%");
+    }
+
+    public function scopeTargetableId($query, $id)
+    {
+        $query->where('targetable_id', $id);
+    }
 }

src/Models/MailatorSchedule.php

@@ -2,6 +2,7 @@
 
 namespace Binarcode\LaravelMailator\Models;
 
+use App\Domains\ResultDocuments\Models\ResultDocument;
 use Binarcode\LaravelMailator\Actions\Action;
 use Binarcode\LaravelMailator\Actions\ResolveGarbageAction;
 use Binarcode\LaravelMailator\Actions\RunSchedulersAction;
@@ -32,23 +33,24 @@
 /**
  * Class MailatorSchedule.
  *
- * @property string tags
- * @property string name
- * @property string stopable
- * @property string targetable_type
- * @property string targetable_id
- * @property string mailable_class
- * @property string delay_minutes
- * @property string time_frame_origin
- * @property array constraints
- * @property Carbon timestamp_target
- * @property array recipients
- * @property string action
- * @property Closure when
- * @property Carbon last_failed_at
- * @property Carbon last_sent_at
- * @property Carbon completed_at
- * @property string frequency_option
+ * @property string $tags
+ * @property string $name
+ * @property string $stopable
+ * @property string $unique
+ * @property string $targetable_type
+ * @property string $targetable_id
+ * @property string $mailable_class
+ * @property string $delay_minutes
+ * @property string $time_frame_origin
+ * @property array $constraints
+ * @property Carbon $timestamp_target
+ * @property array $recipients
+ * @property string $action
+ * @property Closure $when
+ * @property Carbon $last_failed_at
+ * @property Carbon $last_sent_at
+ * @property Carbon $completed_at
+ * @property string $frequency_option
  * @method static MailatorSchedulerBuilder query()
  */
 class MailatorSchedule extends Model
@@ -88,6 +90,7 @@ public function getTable()
         'end_at' => 'datetime',
         'completed_at' => 'datetime',
         'stopable' => 'boolean',
+        'unique' => 'boolean',
     ];
 
     protected $attributes = [
@@ -103,8 +106,8 @@ public function mailable(Mailable $mailable): self
     {
         if ($mailable instanceof Constraintable) {
             collect($mailable->constraints())
-                ->filter(fn ($constraint) => $constraint instanceof SendScheduleConstraint)
-                ->each(fn (SendScheduleConstraint $constraint) => $this->constraint($constraint));
+                ->filter(fn($constraint) => $constraint instanceof SendScheduleConstraint)
+                ->each(fn(SendScheduleConstraint $constraint) => $this->constraint($constraint));
         }
 
         $this->mailable_class = serialize($mailable);
@@ -183,6 +186,18 @@ public function isStopable(): bool
         return (bool) $this->stopable;
     }
 
+    public function unique(): self
+    {
+        $this->unique = true;
+
+        return $this;
+    }
+
+    public function isUnique(): bool
+    {
+        return (bool) $this->unique;
+    }
+
     public function after(CarbonInterface $date = null): self
     {
         $this->time_frame_origin = static::TIME_FRAME_ORIGIN_AFTER;
@@ -303,7 +318,7 @@ public function recipients(...$recipients): self
     {
         $this->recipients = array_merge(collect($recipients)
             ->flatten()
-            ->filter(fn ($email) => $this->ensureValidEmail($email))
+            ->filter(fn($email) => $this->ensureValidEmail($email))
             ->unique()
             ->toArray(), $this->recipients ?? []);
 
@@ -329,15 +344,15 @@ public function shouldSend(): bool
         try {
             $this->load('logs');
 
-            if (! $this->configurationsPasses()) {
+            if (!$this->configurationsPasses()) {
                 return false;
             }
 
-            if (! $this->whenPasses()) {
+            if (!$this->whenPasses()) {
                 return false;
             }
 
-            if (! $this->eventsPasses()) {
+            if (!$this->eventsPasses()) {
                 if ($this->isStopable()) {
                     $this->markComplete();
                 }
@@ -394,7 +409,7 @@ public static function run(): void
 
     public function hasCustomAction(): bool
     {
-        return ! is_null($this->action);
+        return !is_null($this->action);
     }
 
     public function getMailable(): ?Mailable
@@ -449,13 +464,13 @@ public function markAsFailed(string $failureReason): self
     public function getRecipients(): array
     {
         return collect($this->recipients)
-            ->filter(fn ($email) => $this->ensureValidEmail($email))
+            ->filter(fn($email) => $this->ensureValidEmail($email))
             ->toArray();
     }
 
     protected function ensureValidEmail(string $email): bool
     {
-        return ! Validator::make(
+        return !Validator::make(
             compact('email'),
             ['email' => 'required|email']
         )->fails();
@@ -468,7 +483,7 @@ public function actionClass(Action $action): self
         return $this;
     }
 
-    public function tag(string | array $tag): self
+    public function tag(string|array $tag): self
     {
         if (is_array($tag)) {
             $tag = implode(',', $tag);
@@ -519,7 +534,7 @@ public function markComplete(): self
 
     public function isCompleted(): bool
     {
-        return ! is_null($this->completed_at);
+        return !is_null($this->completed_at);
     }
 
     public function failedLastTimes(int $times): bool
@@ -541,16 +556,36 @@ public function timestampTarget(): ?CarbonInterface
 
     public function isRepetitive(): bool
     {
-        return ! $this->isOnce();
+        return !$this->isOnce();
     }
 
     public function wasSentOnce(): bool
     {
-        return ! is_null($this->last_sent_at);
+        return !is_null($this->last_sent_at);
     }
 
     public function getConstraints(): ConstraintsCollection
     {
         return ConstraintsCollection::make($this->constraints);
     }
+
+    public function save(array $options = [])
+    {
+        if (!$this->isUnique()) {
+            return parent::save($options);
+        }
+
+        $mailable = get_class(unserialize($this->mailable_class));
+
+        $exists = static:: targetableType($this->targetable_type)
+            ->targetableId($this->targetable_id)
+            ->mailableClass($mailable)
+            ->exists();
+
+        if ($exists) {
+            return false;
+        }
+
+        return parent::save($options);
+    }
 }

tests/Feature/UniqueSchedulerTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Tests\Feature;
+
+use Binarcode\LaravelMailator\Scheduler;
+use Binarcode\LaravelMailator\Tests\database\Factories\UserFactory;
+use Binarcode\LaravelMailator\Tests\Fixtures\Constraints\DynamicContraint;
+use Binarcode\LaravelMailator\Tests\Fixtures\InvoiceReminderMailable;
+use Binarcode\LaravelMailator\Tests\TestCase;
+use Illuminate\Support\Facades\Mail;
+
+class UniqueSchedulerTest extends TestCase
+{
+    public function test_unique_per_target_will_prevent_duplications(): void
+    {
+        Mail::fake();
+        $user = UserFactory::one();
+
+        Mail::assertNothingSent();
+
+        Scheduler::init()
+            ->mailable(new InvoiceReminderMailable())
+            ->target($user)
+            ->unique()
+            ->save();
+
+        Scheduler::init()
+            ->mailable(new InvoiceReminderMailable())
+            ->target($user)
+            ->unique()
+            ->save();
+
+        self::assertCount(1, $user->schedulers()->get());
+
+        Scheduler::init()
+            ->mailable(new InvoiceReminderMailable())
+            ->target($user)
+            ->save();
+
+        self::assertCount(2, $user->schedulers()->get());
+    }
+}