Feat: Ability to disable auditable

Author: GoatFreezy

src/AuditableTrait.php

@@ -12,6 +12,9 @@
  */
 trait AuditableTrait
 {
+
+    public $auditable = true;
+    
     /**
      * Boot the audit trait for a model.
      */

src/AuditableTraitObserver.php

@@ -11,15 +11,15 @@ class AuditableTraitObserver
      */
     public function creating(Model $model): void
     {
-        if (method_exists($model, 'getCreatedByColumn')) {
+        if (method_exists($model, 'getCreatedByColumn') && $model->auditable) {
             $createdBy = $model->getCreatedByColumn();
 
             if (! $model->$createdBy) {
                 $model->$createdBy = $this->getAuthenticatedUserId();
             }
         }
 
-        if (method_exists($model, 'getUpdatedByColumn')) {
+        if (method_exists($model, 'getUpdatedByColumn') && $model->auditable) {
             $updatedBy = $model->getUpdatedByColumn();
 
             if (! $model->$updatedBy) {
@@ -41,7 +41,7 @@ protected function getAuthenticatedUserId(): int|string|null
      */
     public function updating(Model $model): void
     {
-        if (method_exists($model, 'getUpdatedByColumn')) {
+        if (method_exists($model, 'getUpdatedByColumn') && $model->auditable) {
             $updatedBy = $model->getUpdatedByColumn();
 
             if (! $model->isDirty($updatedBy)) {
@@ -55,7 +55,7 @@ public function updating(Model $model): void
      */
     public function saved(Model $model): void
     {
-        if (method_exists($model, 'getUpdatedByColumn')) {
+        if (method_exists($model, 'getUpdatedByColumn') && $model->auditable) {
             $updatedBy = $model->getUpdatedByColumn();
 
             if ($this->getAuthenticatedUserId() && $this->getAuthenticatedUserId() != $model->$updatedBy && $model->isDirty()) {

tests/Feature/AuditableModelTest.php

@@ -48,32 +48,27 @@
     expect($post->deleted_by)->toBe($user->id);
 });
 
-test('a model wont be updated if edited by another user without it being dirty', function () {
-    $user = User::create([
+test('a post can be created without audit', function () {
+    $user = User::forceCreate([
         'name' => 'John Doe',
         'email' => '[email protected]',
     ]);
 
     actingAs($user);
 
-    $anotherUser = User::create([
-        'name' => 'Jane Doe',
-        'email' => '[email protected]',
-    ]);
+    $post = new Post();
+    $post->title = 'Hello World';
+    $post->auditable = false;
+    $post->save();
 
-    DB::table('posts')->insert([
-        'title' => 'Hello World',
-        'created_by' => $anotherUser->id,
-        'updated_by' => $anotherUser->id,
-    ]);
-
-    $model = Post::first();
-
-    expect($model->created_by)->toBe($anotherUser->id);
-    expect($model->updated_by)->toBe($anotherUser->id);
+    expect($post->created_by)->toBe(null);
+    expect($post->updated_by)->toBe(null);
+    expect($post->deleted_by)->toBe(null);
 
-    $model->save();
+    $post->auditable = true;
+    $post->title = 'Hello World 2';
+    $post->save();
 
-    expect($model->created_by)->toBe($anotherUser->id);
-    expect($model->updated_by)->toBe($anotherUser->id);
+    expect($post->updated_by)->toBe($user->id);
+    expect($post->deleted_by)->toBe(null);
 });