Merge pull request #2518 from BinarCode/setup

wip

Author: binaryk

.gitignore

@@ -6,3 +6,4 @@ coverage
 output
 docs/node_modules
 docs/.vuepress/dist
+.php_cs.cache

.php_cs.cache

@@ -19,7 +19,8 @@
     "require": {
         "php": "^7.4",
         "illuminate/support": "^7.0",
-        "opis/closure": "^3.5"
+        "opis/closure": "^3.5",
+        "spatie/test-time": "^1.2"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.16",

composer.json

@@ -11,8 +11,22 @@
      */
     'logs_table' => 'mailator_logs',
 
-    /**
-     * > The base model for the mail schedule.
-     */
-    'scheduler_model' => Binarcode\LaravelMailator\Models\MailatorSchedule::class,
+    'scheduler' => [
+        /**
+         * > The base model for the mail schedule.
+         */
+        'model' => Binarcode\LaravelMailator\Models\MailatorSchedule::class,
+
+        /**
+        > The queue used for sending emails.
+         */
+        'send_mail_job_queue' => 'default',
+
+        /**
+        > The email sender class. It will be executed from the sender job.
+         */
+        'send_mail_action' => Binarcode\LaravelMailator\Actions\SendMailAction::class,
+    ],
+
+    'log_model' => Binarcode\LaravelMailator\Models\MailatorLog::class,
 ];

config/mailator.php

@@ -14,13 +14,14 @@ class CreateMailatorTables extends Migration
             $table->bigIncrements('id');
 
             $table->string('name', 100)->nullable();
-            $table->string('mailable_class');
+            $table->text('mailable_class');
             $table->unsignedInteger('delay_minutes')->nullable()->comment('Number of hours/days.');
             $table->enum('time_frame_origin', [
                 MailatorSchedule::TIME_FRAME_ORIGIN_BEFORE,
                 MailatorSchedule::TIME_FRAME_ORIGIN_AFTER,
             ])->nullable()->comment('Before or after event.');
             $table->json('events')->nullable()->comment('Offset target.');
+            $table->json('recipients')->nullable();
             $table->text('when')->nullable();
             $table->enum('frequency_option', [
                 MailatorSchedule::FREQUENCY_OPTIONS_ONCE,
@@ -29,13 +30,16 @@ class CreateMailatorTables extends Migration
                 MailatorSchedule::FREQUENCY_OPTIONS_WEEKLY,
             ])->default(MailatorSchedule::FREQUENCY_OPTIONS_ONCE)->comment('How often send email notification.');
 
+            $table->timestamp('last_sent_at')->nullable();
+            $table->timestamp('last_failed_at')->nullable();
+            $table->text('failure_reason')->nullable();
             $table->timestamps();
         });
 
         Schema::create(config('mailator.logs_table', 'mailator_logs'), function (Blueprint $table) {
             $table->bigIncrements('id');
             $table->string('name')->nullable();
-            $table->string('recipient_email')->nullable();
+            $table->json('recipients')->nullable();
             $table->unsignedInteger('mailator_schedule_id')->nullable();
             $table->enum('status', [
                 MailatorLog::STATUS_FAILED,

database/migrations/create_mailator_tables.php.stub

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Explicabo iusto laudantium molestias quae ratione vitae? Architecto dignissimos inventore laudantium omnis? Beatae blanditiis ex neque obcaecati quos voluptate voluptatem. Ducimus, quo.

resources/views/mails/stub_invoice_reminder_view.blade.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Actions;
+
+use Binarcode\LaravelMailator\Events\ScheduleMailSentEvent;
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Exception;
+use Illuminate\Support\Facades\Mail;
+
+class SendMailAction
+{
+    public function handle(MailatorSchedule $schedule)
+    {
+        try {
+            $this->sendMail($schedule);
+        } catch (Exception $exception) {
+            report($exception);
+
+            $schedule->markAsFailed($exception->getMessage());
+        }
+    }
+
+    protected function sendMail(MailatorSchedule $schedule)
+    {
+        //todo - apply replacers for variables maybe
+        Mail::to($schedule->getRecipients())->send(
+            $schedule->getMailable()
+        );
+
+        $schedule->markAsSent();
+
+        event(new ScheduleMailSentEvent($schedule));
+    }
+}

src/Actions/SendMailAction.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Constraints;
+
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Illuminate\Support\Collection;
+
+interface SendScheduleConstraint
+{
+    public function canSend(MailatorSchedule $mailatorSchedule, Collection $logs): bool;
+}

src/Constraints/SendScheduleConstraint.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Events;
+
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+
+class ScheduleMailSentEvent
+{
+    public MailatorSchedule $schedule;
+
+    public function __construct(MailatorSchedule $schedule)
+    {
+        $this->schedule = $schedule;
+    }
+}

src/Events/ScheduleMailSentEvent.php

@@ -2,13 +2,13 @@
 
 namespace Binarcode\LaravelMailator\Exceptions;
 
-use Binarcode\LaravelMailator\MailatorEvent;
+use Binarcode\LaravelMailator\Constraints\SendScheduleConstraint;
 use Exception;
 
 class InstanceException extends Exception
 {
     public static function throw(string $actual)
     {
-        return new static('Expected instance of '.MailatorEvent::class.", given [$actual].");
+        return new static('Expected instance of ' . SendScheduleConstraint::class . ", given [$actual].");
     }
 }