Merge pull request #2549 from BinarCode/2.x

Changing the scheduler.

Author: binaryk

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to `laravel-mailator` will be documented in this file
 
+## 2.0.0 - 2021-08-03
+
+- The `before` and `after` methods now accept only an instance of Carbon 
+- You can add custom contraints using `->contraint( Binarcode\LaravelMailator\Constraints\SendScheduleConstraint)` method.
+
+- The scheduler will now take care of your configurations, so if you don't specify any constraint, it will send the email based on the scheduler configurations.
+- Changed `events` column name to `constraints`
+- Added `timestamp_target` timestamp column
+
+
+
 ## 1.0.0 - 2020-02-07
 
 - initial release

README.md

@@ -102,20 +102,21 @@ To setup a mail to be sent after or before an event, you can do this by using `M
 Firstly lets setup a mail scheduler:
 
 ```php
-use Binarcode\LaravelMailator\Tests\Fixtures\InvoiceReminderMailable;
+use Binarcode\LaravelMailator\Tests\Fixtures\InvoiceReminderMailable;use Binarcode\LaravelMailator\Tests\Fixtures\SerializedConditionCondition;
 
 Binarcode\LaravelMailator\Models\MailatorSchedule::init('Invoice reminder.')
     ->mailable(new InvoiceReminderMailable())
     ->recipients(['[email protected]'])
     ->days(1)
-    ->before(BeforeInvoiceExpiresConstraint::class)
+    ->constraint(new SerializedConditionCondition)
+    ->before(now()->addYear())
     ->when(function () {
         return 'Working.';
     })
     ->save();
 ```
 
-The `before` mutator accept an instance of `Binarcode\LaravelMailator\Constraints\SendScheduleConstraint`, based on this the Mailator will decide to send or to not send the email.
+The `constraint` mutator accept an instance of `Binarcode\LaravelMailator\Constraints\SendScheduleConstraint`, based on this the Mailator will decide to send or to not send the email.
 
 Let's assume we have this `BeforeInvoiceExpiresConstraint` constraint:
 

config/mailator.php

@@ -18,8 +18,8 @@
         'model' => Binarcode\LaravelMailator\Models\MailatorSchedule::class,
 
         /**
-        > The queue used for sending emails.
-         */
+        * > The queue used for sending emails.
+        */
         'send_mail_job_queue' => 'default',
 
         /**

database/migrations/create_mailator_tables.php.stub

@@ -20,7 +20,8 @@ class CreateMailatorTables extends Migration
                 MailatorSchedule::TIME_FRAME_ORIGIN_BEFORE,
                 MailatorSchedule::TIME_FRAME_ORIGIN_AFTER,
             ])->nullable()->comment('Before or after event.');
-            $table->json('events')->nullable()->comment('Offset target.');
+            $table->timestamp('timestamp_target')->nullable();
+            $table->json('constraints')->nullable()->comment('Offset target.');
             $table->json('recipients')->nullable();
             $table->text('when')->nullable();
             $table->enum('frequency_option', [

src/Actions/Action.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Actions;
+
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+
+interface Action
+{
+    public function handle(MailatorSchedule $schedule);
+}

src/Actions/SendMailAction.php

@@ -7,7 +7,7 @@
 use Exception;
 use Illuminate\Support\Facades\Mail;
 
-class SendMailAction
+class SendMailAction implements Action
 {
     public function handle(MailatorSchedule $schedule)
     {

src/Constraints/BeforeConstraint.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Constraints;
+
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Illuminate\Support\Collection;
+
+class BeforeConstraint implements SendScheduleConstraint
+{
+    public function canSend(MailatorSchedule $schedule, Collection $logs): bool
+    {
+        if (! $schedule->isBefore()) {
+            return true;
+        }
+
+        if (is_null($schedule->timestamp_target)) {
+            return true;
+        }
+
+        // if already expired
+        if ($schedule->timestamp_target->lte(now())) {
+            return false;
+        }
+
+        //till ends we should have at least toDays days
+        return $schedule->isOnce()
+            ? $schedule->timestamp_target->diffInDays(now()) === $schedule->toDays()
+            : $schedule->timestamp_target->diffInDays(now()) < $schedule->toDays();
+    }
+}

src/Jobs/SendMailJob.php

@@ -32,7 +32,7 @@ public function __construct(MailatorSchedule $schedule)
     public function handle()
     {
         /** * @var SendMailAction $sendMailAction */
-        $sendMailAction = app(Config::get('mailator.scheduler.send_mail_action', SendMailAction::class));
+        $sendMailAction = $this->schedule->action;
 
         $sendMailAction->handle($this->schedule);
     }

src/Models/Concerns/ConstraintsResolver.php

@@ -0,0 +1,38 @@
+<?php
+
+
+namespace Binarcode\LaravelMailator\Models\Concerns;
+
+use Binarcode\LaravelMailator\Constraints\BeforeConstraint;
+use Binarcode\LaravelMailator\Constraints\SendScheduleConstraint;
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+
+/**
+ * Trait ConstraintsResolver
+ * @mixin MailatorSchedule
+ * @package Binarcode\LaravelMailator\Models\Concerns
+ */
+trait ConstraintsResolver
+{
+    public function configurationsPasses(): bool
+    {
+        return collect([
+            BeforeConstraint::class,
+        ])
+            ->map(fn ($class) => app($class))
+            ->every(fn (SendScheduleConstraint $event) => $event->canSend($this, $this->logs));
+    }
+
+    public function whenPasses(): bool
+    {
+        return true;
+    }
+
+    public function eventsPasses(): bool
+    {
+        return collect($this->constraints)
+            ->map(fn (string $event) => unserialize($event))
+            ->filter(fn ($event) => is_subclass_of($event, SendScheduleConstraint::class))
+            ->every(fn (SendScheduleConstraint $event) => $event->canSend($this, $this->logs));
+    }
+}