Merge pull request #2550 from BinarCode/2.x

2.x

Author: binaryk

README.md

@@ -6,7 +6,8 @@
 <a href="https://packagist.org/packages/binarcode/laravel-mailator"><img src="https://poser.pugx.org/binarcode/laravel-mailator/license" alt="License"></a>
 </p>
 
-Laravel Mailator provides a featherweight system for configure email scheduler and email templates based on application events.
+Laravel Mailator provides a featherweight system for configure email scheduler and email templates based on application
+events.
 
 ## Installation
 
@@ -30,7 +31,6 @@ It has mainly 2 directions of usage:
 
 2. Email Scheduler
 
-
 ## Templating
 
 To create an email template:
@@ -58,11 +58,14 @@ $template->placeholders()->create(
 
 To use the template, you simply have to add the `WithMailTemplate` trait to your mailable.
 
-This will enforce you to implement the `getReplacers` method, this should return an array of replacers to your template. The array may contain instances of `Binarcode\LaravelMailator\Replacers\Replacer` or even `Closure` instances.  
+This will enforce you to implement the `getReplacers` method, this should return an array of replacers to your template.
+The array may contain instances of `Binarcode\LaravelMailator\Replacers\Replacer` or even `Closure` instances.
 
-Mailator shipes with a builtin replacer `ModelAttributesReplacer`, it will automaticaly replace attributes from the model you provide to placeholders.
+Mailator shipes with a builtin replacer `ModelAttributesReplacer`, it will automaticaly replace attributes from the
+model you provide to placeholders.
 
-The last step is how to say to your mailable what template to use. This could be done into the build method as shown bellow:
+The last step is how to say to your mailable what template to use. This could be done into the build method as shown
+bellow:
 
 ```php
 class WelcomeMailatorMailable extends Mailable
@@ -94,10 +97,9 @@ class WelcomeMailatorMailable extends Mailable
 }
 ```
 
-
 ## Scheduler
 
-To setup a mail to be sent after or before an event, you can do this by using `MailatorSchedule`. 
+To setup a mail to be sent after or before an event, you can do this by using `MailatorSchedule`.
 
 Firstly lets setup a mail scheduler:
 
@@ -116,7 +118,8 @@ Binarcode\LaravelMailator\Models\MailatorSchedule::init('Invoice reminder.')
     ->save();
 ```
 
-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.
+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:
 
@@ -139,6 +142,18 @@ Binarcode\LaravelMailator\Models\MailatorSchedule::run();
 
 The Mailator will take care of all your mails that needs to be sent, and it will send them.
 
+Using `Scheduler` you can even define your custom action:
+
+```php
+$scheduler = MailatorSchedule::init('Invoice reminder.')
+    ->days(1)
+    ->before(now()->addWeek())
+    ->actionClass(CustomAction::class)
+    ->save();
+```
+
+The `CustomAction` should implement the `Binarcode\LaravelMailator\Actions\Action` class.
+
 ### Testing
 
 ``` bash
@@ -155,7 +170,8 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ### Security
 
-If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+If you discover any security related issues, please email [email protected] instead of using the issue
+tracker.
 
 ## Credits
 

database/migrations/create_mailator_tables.php.stub

@@ -14,7 +14,8 @@ class CreateMailatorTables extends Migration
             $table->bigIncrements('id');
 
             $table->string('name', 100)->nullable();
-            $table->text('mailable_class');
+            $table->text('mailable_class')->nullable();
+            $table->text('action')->nullable();
             $table->unsignedInteger('delay_minutes')->nullable()->comment('Number of hours/days.');
             $table->enum('time_frame_origin', [
                 MailatorSchedule::TIME_FRAME_ORIGIN_BEFORE,
@@ -24,12 +25,7 @@ class CreateMailatorTables extends Migration
             $table->json('constraints')->nullable()->comment('Offset target.');
             $table->json('recipients')->nullable();
             $table->text('when')->nullable();
-            $table->enum('frequency_option', [
-                MailatorSchedule::FREQUENCY_OPTIONS_ONCE,
-                MailatorSchedule::FREQUENCY_OPTIONS_HOURLY,
-                MailatorSchedule::FREQUENCY_OPTIONS_DAILY,
-                MailatorSchedule::FREQUENCY_OPTIONS_WEEKLY,
-            ])->default(MailatorSchedule::FREQUENCY_OPTIONS_ONCE)->comment('How often send email notification.');
+            $table->string('frequency_option')->default(MailatorSchedule::FREQUENCY_OPTIONS_ONCE)->comment('How often send email notification.');
 
             $table->timestamp('last_sent_at')->nullable();
             $table->timestamp('last_failed_at')->nullable();

src/Constraints/AfterConstraint.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Constraints;
+
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Illuminate\Support\Collection;
+
+class AfterConstraint implements SendScheduleConstraint
+{
+    public function canSend(MailatorSchedule $schedule, Collection $logs): bool
+    {
+        if (! $schedule->isAfter()) {
+            return true;
+        }
+
+        if (is_null($schedule->timestamp_target)) {
+            return true;
+        }
+
+        // it's in the future
+        if (now()->lt($schedule->timestamp_target)) {
+            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/Constraints/DailyConstraint.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Constraints;
+
+use Binarcode\LaravelMailator\Models\MailatorLog;
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Illuminate\Support\Collection;
+
+class DailyConstraint implements SendScheduleConstraint
+{
+    public function canSend(MailatorSchedule $schedule, Collection $logs): bool
+    {
+        if (! $schedule->isDaily()) {
+            return true;
+        }
+
+        if ($logs->count() === 0) {
+            return true;
+        }
+
+        $lastLog = $logs
+            ->filter(fn (MailatorLog $log) => $log->isSent())
+            ->last();
+
+        if ($lastLog instanceof MailatorLog) {
+            return $lastLog->created_at->diffInDays(now()) >= 1;
+        } else {
+            return true;
+        }
+    }
+}

src/Constraints/ManyConstraint.php

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

src/Constraints/OnceConstraint.php

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

src/Constraints/WeeklyConstraint.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Constraints;
+
+use Binarcode\LaravelMailator\Models\MailatorLog;
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Illuminate\Support\Collection;
+
+class WeeklyConstraint implements SendScheduleConstraint
+{
+    public function canSend(MailatorSchedule $schedule, Collection $logs): bool
+    {
+        if (! $schedule->isWeekly()) {
+            return true;
+        }
+
+        if ($logs->count() === 0) {
+            return true;
+        }
+
+        $lastLog = $logs
+            ->filter(fn (MailatorLog $log) => $log->isSent())
+            ->last();
+
+        if ($lastLog instanceof MailatorLog) {
+            return $lastLog->created_at->diffInDays(now()) >= 7;
+        } else {
+            return true;
+        }
+    }
+}

src/Jobs/SendMailJob.php

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

src/Models/Concerns/ConstraintsResolver.php

@@ -3,8 +3,13 @@
 
 namespace Binarcode\LaravelMailator\Models\Concerns;
 
+use Binarcode\LaravelMailator\Constraints\AfterConstraint;
 use Binarcode\LaravelMailator\Constraints\BeforeConstraint;
+use Binarcode\LaravelMailator\Constraints\DailyConstraint;
+use Binarcode\LaravelMailator\Constraints\ManyConstraint;
+use Binarcode\LaravelMailator\Constraints\OnceConstraint;
 use Binarcode\LaravelMailator\Constraints\SendScheduleConstraint;
+use Binarcode\LaravelMailator\Constraints\WeeklyConstraint;
 use Binarcode\LaravelMailator\Models\MailatorSchedule;
 
 /**
@@ -18,6 +23,11 @@ public function configurationsPasses(): bool
     {
         return collect([
             BeforeConstraint::class,
+            AfterConstraint::class,
+            OnceConstraint::class,
+            ManyConstraint::class,
+            DailyConstraint::class,
+            WeeklyConstraint::class,
         ])
             ->map(fn ($class) => app($class))
             ->every(fn (SendScheduleConstraint $event) => $event->canSend($this, $this->logs));

src/Models/MailatorLog.php

@@ -2,8 +2,14 @@
 
 namespace Binarcode\LaravelMailator\Models;
 
+use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * Class MailatorLog
+ * @property Carbon $created_at
+ * @package Binarcode\LaravelMailator\Models
+ */
 class MailatorLog extends Model
 {
     public function getTable()
@@ -31,4 +37,9 @@ public function getTable()
         'updated_at' => 'datetime',
         'recipients' => 'array',
     ];
+
+    public function isSent(): bool
+    {
+        return $this->status === static::STATUS_SENT;
+    }
 }