Never constraint.

Author: binaryk

src/Constraints/NeverConstraint.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Constraints;
+
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Illuminate\Support\Collection;
+
+class NeverConstraint implements SendScheduleConstraint
+{
+    public function canSend(MailatorSchedule $schedule, Collection $logs): bool
+    {
+        return $schedule->isNever()
+            ? false
+            : true;
+    }
+}

src/Models/Concerns/ConstraintsResolver.php

@@ -7,6 +7,7 @@
 use Binarcode\LaravelMailator\Constraints\BeforeConstraint;
 use Binarcode\LaravelMailator\Constraints\DailyConstraint;
 use Binarcode\LaravelMailator\Constraints\ManyConstraint;
+use Binarcode\LaravelMailator\Constraints\NeverConstraint;
 use Binarcode\LaravelMailator\Constraints\OnceConstraint;
 use Binarcode\LaravelMailator\Constraints\SendScheduleConstraint;
 use Binarcode\LaravelMailator\Constraints\WeeklyConstraint;
@@ -24,6 +25,7 @@ public function configurationsPasses(): bool
         return collect([
             BeforeConstraint::class,
             AfterConstraint::class,
+            NeverConstraint::class,
             OnceConstraint::class,
             ManyConstraint::class,
             DailyConstraint::class,

src/Models/MailatorSchedule.php

@@ -71,6 +71,7 @@ public function getTable()
     const FREQUENCY_OPTIONS_HOURLY = 'hourly';
     const FREQUENCY_OPTIONS_DAILY = 'daily';
     const FREQUENCY_OPTIONS_WEEKLY = 'weekly';
+    const FREQUENCY_OPTIONS_NEVER = 'never';
 
     protected $fillable = [
         'action',
@@ -119,6 +120,13 @@ public function once(): self
         return $this;
     }
 
+    public function never(): self
+    {
+        $this->frequency_option = static::FREQUENCY_OPTIONS_NEVER;
+
+        return $this;
+    }
+
     public function many(): self
     {
         $this->frequency_option = static::FREQUENCY_OPTIONS_MANY;
@@ -201,6 +209,11 @@ public function isOnce(): bool
         return $this->frequency_option === static::FREQUENCY_OPTIONS_ONCE;
     }
 
+    public function isNever(): bool
+    {
+        return $this->frequency_option === static::FREQUENCY_OPTIONS_NEVER;
+    }
+
     public function isMany(): bool
     {
         return $this->frequency_option === static::FREQUENCY_OPTIONS_MANY;

tests/Feature/Models/MailatorScheduleTest.php

@@ -74,6 +74,26 @@ public function test_sending_email_only_once()
         });
     }
 
+    public function test_sending_email_never_automatically()
+    {
+        Mail::fake();
+        Mail::assertNothingSent();
+
+        MailatorSchedule::init('Invoice reminder.')
+            ->never()
+            ->recipients([
+                '[email protected]',
+            ])
+            ->mailable(
+                (new InvoiceReminderMailable())->to('[email protected]')
+            )
+            ->days(1)
+            ->save();
+
+        MailatorSchedule::run();
+        Mail::assertSent(InvoiceReminderMailable::class, 0);
+    }
+
     public function test_can_send_serialized_constrained()
     {
         Mail::fake();