chore: add ability to exclude user email

this can be used for PII compliance.
i have chosen to keep the existing functionality as it is for compatibility reasons.

README.md

@@ -65,7 +65,7 @@ return [
             'excludePathSegments' => [],
             'useRelativePath' => false,
         ],
-        Spatie\SqlCommenter\Commenters\CurrentUserCommenter::class,
+        Spatie\SqlCommenter\Commenters\CurrentUserCommenter::class => ['includeEmail' => true],
         // Spatie\SqlCommenter\Commenters\FrameworkVersionCommenter::class,
         // Spatie\SqlCommenter\Commenters\DbDriverCommenter::class,
     ],

config/sql-commenter.php

@@ -18,7 +18,7 @@
             'excludePathSegments' => [],
             'useRelativePath' => false,
         ],
-        Spatie\SqlCommenter\Commenters\CurrentUserCommenter::class,
+        Spatie\SqlCommenter\Commenters\CurrentUserCommenter::class => ['includeEmail' => true],
         // Spatie\SqlCommenter\Commenters\FrameworkVersionCommenter::class,
         // Spatie\SqlCommenter\Commenters\DbDriverCommenter::class,
     ],

src/Commenters/CurrentUserCommenter.php

@@ -8,6 +8,10 @@
 
 class CurrentUserCommenter implements Commenter
 {
+    public function __construct(protected bool $includeEmail = false)
+    {
+    }
+
     public function comments(string $query, Connection $connection): Comment|array|null
     {
         SqlCommenter::disable();
@@ -23,7 +27,7 @@ public function comments(string $query, Connection $connection): Comment|array|n
 
         return [
             Comment::make('user_id', $user->getKey()),
-            Comment::make('user_email', $user->email ?? ''),
+            $this->includeEmail ? Comment::make('user_email', $user->email ?? '') : null,
         ];
     }
 }

tests/Commenters/CurrentUserCommenterTest.php

@@ -2,6 +2,7 @@
 
 use Illuminate\Database\Events\QueryExecuted;
 use Illuminate\Support\Facades\Event;
+use Spatie\SqlCommenter\Commenters\CurrentUserCommenter;
 use Spatie\SqlCommenter\Tests\TestSupport\TestClasses\User;
 
 it('logs the current user', function () {
@@ -20,3 +21,23 @@
 
     User::all();
 });
+
+
+it('can exclude the user email', function () {
+    $user = User::create([
+        'name' => 'John',
+        'password' => 'dummy',
+        'email' => '[email protected]',
+    ]);
+
+    auth()->login($user);
+
+    $this->addCommenterToConfig(CurrentUserCommenter::class, ['includeEmail' => false]);
+
+    Event::listen(QueryExecuted::class, function (QueryExecuted $event) use ($user) {
+        expect($event->sql)->toContainComment('user_id', $user->id)
+            ->and($event->sql)->notToContainComment('user_email', $user->email);
+    });
+
+    User::all();
+});

tests/Pest.php

@@ -10,3 +10,9 @@
 
     return $this;
 });
+
+expect()->extend('notToContainComment', function (string $key, string|int|null $value) {
+    expect($this->value)->not->toContain((string)Comment::make($key, $value));
+
+    return $this;
+});