added support for mailables

Author: marickvantuil

composer.json

@@ -8,11 +8,6 @@
             "email": "info@marickvantuil.nl"
         }
     ],
-    "require": {
-        "illuminate/database": "^5.2",
-        "illuminate/console": "^5.2",
-        "illuminate/validation": "^5.2"
-    },
     "autoload": {
         "psr-4": {
             "Buildcode\\LaravelDatabaseEmails\\": "src/"
@@ -31,8 +26,12 @@
         }
     },
     "require-dev": {
-        "orchestra/testbench": "~3.4",
-        "phpunit/phpunit": "^5.7",
-        "orchestra/database": "~3.4"
+        "illuminate/database": "^5.5",
+        "illuminate/console": "^5.5",
+        "illuminate/validation": "^5.5",
+        "orchestra/testbench": "^3.5",
+        "orchestra/database": "^3.5",
+        "phpunit/phpunit": "^6.0",
+        "mockery/mockery": "^1.0"
     }
 }

src/EmailComposer.php

@@ -2,6 +2,8 @@
 
 namespace Buildcode\LaravelDatabaseEmails;
 
+use Illuminate\Mail\Mailable;
+
 class EmailComposer
 {
     /**
@@ -45,7 +47,7 @@ public function getEmail()
      * @param mixed $value
      * @return static
      */
-    protected function setData($key, $value)
+    public function setData($key, $value)
     {
         $this->data[$key] = $value;
 
@@ -175,6 +177,21 @@ public function later($scheduledAt)
         return $this->send();
     }
 
+    /**
+     * Set the Mailable.
+     *
+     * @param Mailable $mailable
+     * @return static
+     */
+    public function mailable(Mailable $mailable)
+    {
+        $this->setData('mailable', $mailable);
+
+        (new MailableReader)->read($this);
+
+        return $this;
+    }
+
     /**
      * Send the e-mail.
      *

src/Encrypter.php

@@ -69,6 +69,10 @@ private function encryptSubject(EmailComposer $composer)
      */
     private function encryptVariables(EmailComposer $composer)
     {
+        if (!$composer->hasData('variables')) {
+            return;
+        }
+
         $email = $composer->getEmail();
 
         $email->fill([

src/MailableReader.php

@@ -0,0 +1,109 @@
+<?php
+
+namespace Buildcode\LaravelDatabaseEmails;
+
+use Exception;
+use Illuminate\Mail\Mailable;
+
+class MailableReader
+{
+    /**
+     * Read the mailable and pass the data to the email composer.
+     *
+     * @param EmailComposer $composer
+     */
+    public function read(EmailComposer $composer)
+    {
+        $this->readRecipient($composer);
+
+        $this->readCc($composer);
+
+        $this->readBcc($composer);
+
+        $this->readSubject($composer);
+
+        $this->readBody($composer);
+    }
+
+    /**
+     * Convert the mailable addresses array into a array with only e-mails.
+     *
+     * @param string $from
+     * @return array
+     */
+    private function convertMailableAddresses($from)
+    {
+        return collect($from)->map(function ($recipient) {
+            return $recipient['address'];
+        })->toArray();
+    }
+
+    /**
+     * Read the mailable recipient to the email composer.
+     *
+     * @param EmailComposer $composer
+     */
+    private function readRecipient(EmailComposer $composer)
+    {
+        $to = $this->convertMailableAddresses(
+            $composer->getData('mailable')->to
+        );
+
+        $composer->recipient($to);
+    }
+
+    /**
+     * Read the mailable cc to the email composer.
+     *
+     * @param EmailComposer $composer
+     */
+    private function readCc(EmailComposer $composer)
+    {
+        $cc = $this->convertMailableAddresses(
+            $composer->getData('mailable')->cc
+        );
+
+        $composer->cc($cc);
+    }
+
+    /**
+     * Read the mailable bcc to the email composer.
+     *
+     * @param EmailComposer $composer
+     */
+    private function readBcc(EmailComposer $composer)
+    {
+        $bcc = $this->convertMailableAddresses(
+            $composer->getData('mailable')->bcc
+        );
+
+        $composer->bcc($bcc);
+    }
+
+    /**
+     * Read the mailable subject to the email composer.
+     *
+     * @param EmailComposer $composer
+     */
+    private function readSubject(EmailComposer $composer)
+    {
+        $composer->subject($composer->getData('mailable')->subject);
+    }
+
+    /**
+     * Read the mailable body to the email composer.
+     *
+     * @param EmailComposer $composer
+     * @throws Exception
+     */
+    private function readBody(EmailComposer $composer)
+    {
+        if (app()->version() < '5.5') {
+            throw new Exception('Mailables cannot be read by Laravel 5.4 and below. Sorry.');
+        }
+
+        $composer->setData('view', '');
+
+        $composer->setData('body', $composer->getData('mailable')->render());
+    }
+}

src/Preparer.php

@@ -151,12 +151,17 @@ private function prepareVariables(EmailComposer $composer)
      */
     private function prepareBody(EmailComposer $composer)
     {
-        $composer->getEmail()->fill([
-            'body' => view(
+        // If the body was predefined (by for example a mailable), use that.
+        if ($composer->hasData('body')) {
+            $body = $composer->getData('body');
+        } else {
+            $body = view(
                 $composer->getData('view'),
                 $composer->hasData('variables') ? $composer->getData('variables') : []
-            )->render(),
-        ]);
+            )->render();
+        }
+
+        $composer->getEmail()->fill(compact('body'));
     }
 
     /**

src/Validator.php

@@ -133,6 +133,10 @@ private function validateSubject(EmailComposer $composer)
      */
     private function validateView(EmailComposer $composer)
     {
+        if ($composer->hasData('mailable')) {
+            return;
+        }
+
         if (!$composer->hasData('view')) {
             throw new InvalidArgumentException('No view specified');
         }

tests/MailableReaderTest.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace Tests;
+
+use Buildcode\LaravelDatabaseEmails\Email;
+use Illuminate\Mail\Mailable;
+
+class MailableReaderTest extends TestCase
+{
+    /** @test */
+    function it_extracts_the_recipient()
+    {
+        $composer = Email::compose()
+            ->mailable(new TestMailable());
+
+        $this->assertEquals(['john@doe.com'], $composer->getData('recipient'));
+
+        $composer = Email::compose()
+            ->mailable(
+                (new TestMailable())->to(['jane@doe.com'])
+            );
+
+        $this->assertEquals(['john@doe.com', 'jane@doe.com'], $composer->getData('recipient'));
+    }
+
+    /** @test */
+    function it_extracts_cc_addresses()
+    {
+        $composer = Email::compose()->mailable(new TestMailable());
+
+        $this->assertEquals(['john+cc@doe.com', 'john+cc2@doe.com'], $composer->getData('cc'));
+    }
+
+    /** @test */
+    function it_extracts_bcc_addresses()
+    {
+        $composer = Email::compose()->mailable(new TestMailable());
+
+        $this->assertEquals(['john+bcc@doe.com', 'john+bcc2@doe.com'], $composer->getData('bcc'));
+    }
+
+    /** @test */
+    function it_extracts_the_subject()
+    {
+        $composer = Email::compose()->mailable(new TestMailable());
+
+        $this->assertEquals('Your order has shipped!', $composer->getData('subject'));
+    }
+
+    /** @test */
+    function it_extracts_the_body()
+    {
+        $composer = Email::compose()->mailable(new TestMailable());
+
+        $this->assertEquals("Name: John Doe\n", $composer->getData('body'));
+    }
+}
+
+class TestMailable extends Mailable
+{
+    /**
+     * Create a new message instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        $this->to('john@doe.com')
+            ->cc(['john+cc@doe.com', 'john+cc2@doe.com'])
+            ->bcc(['john+bcc@doe.com', 'john+bcc2@doe.com'])
+            ->subject('Your order has shipped!');
+    }
+
+    /**
+     * Build the message.
+     *
+     * @return $this
+     */
+    public function build()
+    {
+        return $this->view('tests::dummy', ['name' => 'John Doe']);
+    }
+}