Reintroduce NullDriver From v4 (#323)

* Reintroduce NullDriver From v4

* Update composer.json

---------

Co-authored-by: Keller Martin <kellerm@schwebdesign.com>
Co-authored-by: Freek Van der Herten <freek@spatie.be>

composer.json

@@ -19,7 +19,8 @@
     ],
     "require": {
         "php": "^8.1",
-        "spatie/laravel-package-tools": "^1.13"
+        "spatie/laravel-package-tools": "^1.13",
+        "illuminate/log": "^9|^10|^11"
     },
     "suggest": {
         "spatie/mailcoach-sdk-php": "For working with Mailcoach",

src/Drivers/NullDriver.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Spatie\Newsletter\Drivers;
+
+use Illuminate\Support\Facades\Log;
+
+class NullDriver
+{
+    /**
+     * @var bool
+     */
+    private $logCalls;
+
+    public function __construct(bool $logCalls = false)
+    {
+        $this->logCalls = $logCalls;
+    }
+
+    public function __call($name, $arguments)
+    {
+        if ($this->logCalls) {
+            Log::debug('Called Spatie Newsletter facade method: '.$name.' with:', $arguments);
+        }
+    }
+}

src/NewsletterServiceProvider.php

@@ -5,6 +5,7 @@
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 use Spatie\Newsletter\Drivers\Driver;
+use Spatie\Newsletter\Drivers\NullDriver;
 use Spatie\Newsletter\Support\Lists;
 
 class NewsletterServiceProvider extends PackageServiceProvider
@@ -22,6 +23,14 @@ public function bootingPackage()
             /** @var class-string<Driver> $driverClass */
             $driverClass = config('newsletter.driver');
 
+            if (
+                is_null($driverClass)
+                || $driverClass === 'log'
+                || $driverClass === NullDriver::class
+            ) {
+                return new NullDriver($driverClass === 'log');
+            }
+
             $arguments = config('newsletter.driver_arguments');
             $lists = Lists::createFromConfig(config('newsletter'));
 

tests/Drivers/NullDriverTest.php

@@ -0,0 +1,27 @@
+<?php
+
+use Spatie\Newsletter\Drivers\NullDriver;
+
+it('uses the NullDriver with null config value', function () {
+    config()->set('newsletter.driver', null);
+
+    expect(app('newsletter'))->toBeInstanceOf(NullDriver::class);
+});
+
+it('uses the NullDriver with log config value', function () {
+    config()->set('newsletter.driver', 'log');
+
+    expect(app('newsletter'))->toBeInstanceOf(NullDriver::class);
+});
+
+it('uses the NullDriver with NullDriver::class config', function () {
+    config()->set('newsletter.driver', NullDriver::class);
+
+    expect(app('newsletter'))->toBeInstanceOf(NullDriver::class);
+});
+
+it('accepts calls to the NullDriver', function () {
+    config()->set('newsletter.driver', null);
+
+    expect(app('newsletter')->subscribe('example@example.org'))->toBeNull();
+});