Implement withoutAudits to match laravel behavior

Author: GoatFreezy

src/AuditableTrait.php

@@ -9,11 +9,11 @@
 /**
  * @property Model $creator
  * @property Model $updater
- * @property bool $auditable
+ * @property bool $auditing
  */
 trait AuditableTrait
 {
-    public bool $auditable = true;
+    protected static bool $auditing = true;
 
     /**
      * Boot the audit trait for a model.
@@ -23,6 +23,29 @@ public static function bootAuditableTrait(): void
         static::observe(new AuditableTraitObserver);
     }
 
+    /**
+     * Disable auditing.
+     */
+    public static function withoutAudits(callable $callback)
+    {
+        $previousState = static::$auditing;
+        static::$auditing = false;
+
+        try {
+            return $callback();
+        } finally {
+            static::$auditing = $previousState;
+        }
+    }
+
+    /**
+     * Check is auditing is enabled.
+     */
+    public function isAuditable(): bool
+    {
+        return static::$auditing;
+    }
+
     /**
      * Get user model who created the record.
      */

src/AuditableTraitObserver.php

@@ -11,15 +11,15 @@ class AuditableTraitObserver
      */
     public function creating(Model $model): void
     {
-        if (method_exists($model, 'getCreatedByColumn') && $model->auditable) {
+        if (method_exists($model, 'getCreatedByColumn') && $model->isAuditable()) {
             $createdBy = $model->getCreatedByColumn();
 
             if (! $model->$createdBy) {
                 $model->$createdBy = $this->getAuthenticatedUserId();
             }
         }
 
-        if (method_exists($model, 'getUpdatedByColumn') && $model->auditable) {
+        if (method_exists($model, 'getUpdatedByColumn') && $model->isAuditable()) {
             $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') && $model->auditable) {
+        if (method_exists($model, 'getUpdatedByColumn') && $model->isAuditable()) {
             $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') && $model->auditable) {
+        if (method_exists($model, 'getUpdatedByColumn') && $model->isAuditable()) {
             $updatedBy = $model->getUpdatedByColumn();
 
             if ($this->getAuthenticatedUserId() && $this->getAuthenticatedUserId() != $model->$updatedBy && $model->isDirty()) {

src/AuditableWithDeletesTraitObserver.php

@@ -11,7 +11,7 @@ class AuditableWithDeletesTraitObserver
      */
     public function deleting(Model $model): void
     {
-        if (method_exists($model, 'getDeletedByColumn')) {
+        if (method_exists($model, 'getDeletedByColumn') && $model->isAuditable()) {
             $deletedBy = $model->getDeletedByColumn();
 
             $model->$deletedBy = $this->getAuthenticatedUserId();
@@ -32,7 +32,7 @@ protected function getAuthenticatedUserId(): int|string|null
      */
     public function restoring(Model $model): void
     {
-        if (method_exists($model, 'getDeletedByColumn')) {
+        if (method_exists($model, 'getDeletedByColumn') && $model->isAuditable()) {
             $deletedBy = $model->getDeletedByColumn();
 
             $model->$deletedBy = null;

tests/Feature/AuditableModelTest.php

@@ -56,16 +56,17 @@
 
     actingAs($user);
 
-    $post = new Post;
-    $post->title = 'Hello World';
-    $post->auditable = false;
-    $post->save();
+    Post::withoutAudits(function () {
+        $post = new Post;
+        $post->title = 'Hello World';
+        $post->save();
 
-    expect($post->created_by)->toBe(null);
-    expect($post->updated_by)->toBe(null);
-    expect($post->deleted_by)->toBe(null);
+        expect($post->created_by)->toBe(null);
+        expect($post->updated_by)->toBe(null);
+        expect($post->deleted_by)->toBe(null);
+    });
 
-    $post->auditable = true;
+    $post = Post::first();
     $post->title = 'Hello World 2';
     $post->save();