test setup

.gitignore

@@ -1,3 +1,4 @@
 composer.lock
 vendor
-.idea
+.idea
+.phpunit.result.cache

composer.json

@@ -18,21 +18,34 @@
     ],
     "require": {
         "illuminate/support": "9.x|10.x|11.x",
-        "citco/carbon": "^2.0"
+        "citco/carbon": "^2.0",
+        "ext-zlib": "*"
+    },
+    "require-dev": {
+        "pestphp/pest": "^2.0",
+        "orchestra/testbench": "^8.22"
     },
     "autoload": {
         "psr-4": {
-            "Dcblogdev\\LaravelSentEmails\\": "src"
+            "Dcblogdev\\LaravelSentEmails\\": "src",
+            "Dcblogdev\\LaravelSentEmails\\Tests\\": "tests"
         }
     },
+    "autoload-dev": {
+        "classmap": [
+            "tests/TestCase.php"
+        ]
+    },
     "extra": {
         "laravel": {
             "providers": [
                 "Dcblogdev\\LaravelSentEmails\\SentEmailsServiceProvider"
-            ],
-            "aliases": {
-                "SentEmails": "Dcblogdev\\LaravelSentEmails\\Facades\\SentEmailsFacade"
-            }
+            ]
+        }
+    },
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
         }
     }
 }

phpunit.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  bootstrap="vendor/autoload.php"
+  backupGlobals="false"
+  backupStaticAttributes="false"
+  colors="true"
+  verbose="true"
+  convertErrorsToExceptions="true"
+  convertNoticesToExceptions="true"
+  convertWarningsToExceptions="true"
+  processIsolation="false"
+  stopOnFailure="false"
+  xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+>
+  <coverage>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="Test">
+      <directory suffix="Test.php">./tests</directory>
+    </testsuite>
+  </testsuites>
+  <php>
+    <env name="DB_CONNECTION" value="testing"/>
+<!--    <env name="APP_KEY" value="base64:2fl+Ktvkfl+Fuz4Qp/A75G2RTiWVA/ZoKZvp6fiiM10="/>-->
+  </php>
+</phpunit>

src/Controllers/SentEmailsController.php

@@ -3,12 +3,12 @@
 namespace Dcblogdev\LaravelSentEmails\Controllers;
 
 use Citco\Carbon;
-use Illuminate\Routing\Controller as BaseController;
+use Illuminate\Contracts\View\View;
 use Dcblogdev\LaravelSentEmails\Models\SentEmail;
 
-class SentEmailsController extends BaseController
+class SentEmailsController
 {
-    public function index()
+    public function index(): View
     {
         $emails = SentEmail::orderby('id', 'desc');
 
@@ -41,15 +41,17 @@ public function index()
         return view('sentemails::index', compact('emails'));
     }
 
-    public function email($id) {
+    public function email(string $id): View
+    {
         $email = SentEmail::findOrFail($id);
 
         return view('sentemails::email', compact('email'));
     }
 
-    public function body($id)
+    public function body(string $id): string
     {
         $email = SentEmail::findOrFail($id);
+
         return $email->body;
     }
 }

src/Listeners/EmailLogger.php

@@ -7,7 +7,7 @@
 
 class EmailLogger
 {
-    public function handle(MessageSending $event)
+    public function handle(MessageSending $event): void
     {
         $message = $event->message;
 
@@ -22,23 +22,21 @@ public function handle(MessageSending $event)
         ]);
     }
 
-    /**
-     * Format address strings for from, to, cc, bcc.
-     *
-     * @param $field
-     * @return null|string
-     */
-    function formatAddressField($field): ?string
+    function formatAddressField(array $field): ?string
     {
         $strings = [];
+
         foreach($field as $row) {
             $email = $row->getAddress();
             $name = $row->getName();
+
             if ($name !='') {
                 $email = $name.' <'.$email.'>';
             }
+
             $strings[] = $email;
         }
+
         return implode(', ', $strings);
     }
 }

src/Models/SentEmail.php

@@ -6,15 +6,25 @@
 
 class SentEmail extends Model
 {
-    protected $guarded = [];
+    protected $fillable = [
+        'date',
+        'from',
+        'to',
+        'cc',
+        'bcc',
+        'subject',
+        'body'
+    ];
 
-    public function getBodyAttribute($compressed) {
+    public function getBodyAttribute($compressed): string
+    {
         return config('sentemails.compressBody')
                 ? gzinflate(base64_decode($compressed))
                 : $compressed;
     }
 
-    public function setBodyAttribute($raw) {
+    public function setBodyAttribute($raw): void
+    {
         $body = config('sentemails.compressBody')
                 ? base64_encode(gzdeflate($raw, 9))
                 : $raw;

src/SentEmailsServiceProvider.php

@@ -2,22 +2,23 @@
 
 namespace Dcblogdev\LaravelSentEmails;
 
-use Illuminate\Support\ServiceProvider;
 use Illuminate\Mail\Events\MessageSending;
-use Dcblogdev\LaravelSentEmails\Listeners\EmailLogger;
 use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Facades\Route;
+use Illuminate\Support\ServiceProvider;
+use Dcblogdev\LaravelSentEmails\Listeners\EmailLogger;
 
 class SentEmailsServiceProvider extends ServiceProvider
 {
-    public function boot()
+    public function boot(): void
     {
         Event::listen(
             MessageSending::class,
             EmailLogger::class
         );
 
         $this->loadViewsFrom(__DIR__.'/resources/views', 'sentemails');
-        $this->loadRoutesFrom(__DIR__.'/routes.php');
+        $this->loadRoutesFrom(__DIR__ . '/routes/web.php');
 
         if ($this->app->runningInConsole()) {
 
@@ -38,17 +39,8 @@ public function boot()
         }
     }
 
-    /**
-     * Register the application services.
-     */
-    public function register()
+    public function register(): void
     {
-        // Automatically apply the package configuration
         $this->mergeConfigFrom(__DIR__. '/../config/sentemails.php', 'sentemails');
-
-        // Register the main class to use with the facade
-        $this->app->singleton('sent-emails', function () {
-            return new SentEmails;
-        });
     }
 }

src/routes/web.php

@@ -0,0 +1,10 @@
+<?php
+
+use Dcblogdev\LaravelSentEmails\Controllers\SentEmailsController;
+use Illuminate\Support\Facades\Route;
+
+Route::middleware(config('sentemails.middleware'))->group(function () {
+    Route::get(config('sentemails.routepath'), [SentEmailsController::class, 'index'])->name('sentemails.index');
+    Route::get(config('sentemails.routepath').'/email/{id}', [SentEmailsController::class, 'email'])->name('sentemails.email');
+    Route::get(config('sentemails.routepath').'/body/{id}', [SentEmailsController::class, 'body'])->name('sentemails.body');
+});

tests/Pest.php

@@ -0,0 +1,5 @@
+<?php
+
+use Dcblogdev\LaravelSentEmails\Tests\TestCase;
+
+uses(TestCase::class)->in(__DIR__);

tests/SentEmailsTest.php

@@ -0,0 +1,8 @@
+<?php
+
+use Symfony\Component\Routing\Exception\RouteNotFoundException;
+
+//fails due to login route not existing directly in package
+test('guests cannot access the sent emails page', function () {
+    $this->get(route('sentemails.index'))->assertStatus(500);
+});

tests/TestCase.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Dcblogdev\LaravelSentEmails\Tests;
+
+use Dcblogdev\LaravelSentEmails\SentEmailsServiceProvider;
+use Illuminate\Support\Str;
+use Orchestra\Testbench\TestCase as Orchestra;
+
+class TestCase extends Orchestra
+{
+    protected function getPackageProviders($app): array
+    {
+        return [
+            SentEmailsServiceProvider::class,
+        ];
+    }
+
+    protected function defineEnvironment($app)
+    {
+        $app['config']->set('app.key', 'base64:'.base64_encode(Str::random(32)));
+
+        // Setup default database to use sqlite :memory:
+        $app['config']->set('database.default', 'mysql');
+        $app['config']->set('database.connections.mysql', [
+            'driver'   => 'sqlite',
+            'database' => ':memory:',
+            'prefix'   => '',
+        ]);
+    }
+}