Feat: Ability to disable auditable

src/AuditableTrait.php

@@ -9,9 +9,12 @@
 /**
  * @property Model $creator
  * @property Model $updater
+ * @property bool $auditing
  */
 trait AuditableTrait
 {
+    protected static bool $auditing = true;
+
     /**
      * Boot the audit trait for a model.
      */
@@ -20,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 @@
      */
     public function creating(Model $model): void
     {
-        if (method_exists($model, 'getCreatedByColumn')) {
+        if (method_exists($model, 'getCreatedByColumn') && $model->isAuditable()) {
             $createdBy = $model->getCreatedByColumn();
 
             if (! $model->$createdBy) {
                 $model->$createdBy = $this->getAuthenticatedUserId();
             }
         }
 
-        if (method_exists($model, 'getUpdatedByColumn')) {
+        if (method_exists($model, 'getUpdatedByColumn') && $model->isAuditable()) {
             $updatedBy = $model->getUpdatedByColumn();
 
             if (! $model->$updatedBy) {
@@ -41,7 +41,7 @@
      */
     public function updating(Model $model): void
     {
-        if (method_exists($model, 'getUpdatedByColumn')) {
+        if (method_exists($model, 'getUpdatedByColumn') && $model->isAuditable()) {
             $updatedBy = $model->getUpdatedByColumn();
 
             if (! $model->isDirty($updatedBy)) {
@@ -55,7 +55,7 @@
      */
     public function saved(Model $model): void
     {
-        if (method_exists($model, 'getUpdatedByColumn')) {
+        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 @@
      */
     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 @@
      */
     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

@@ -77,3 +77,29 @@
     expect($model->created_by)->toBe($anotherUser->id);
     expect($model->updated_by)->toBe($anotherUser->id);
 });
+
+test('a post can be created without audit', function () {
+    $user = User::forceCreate([
+        'name' => 'John Doe',
+        'email' => '[email protected]',
+    ]);
+
+    actingAs($user);
+
+    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);
+    });
+
+    $post = Post::first();
+    $post->title = 'Hello World 2';
+    $post->save();
+
+    expect($post->updated_by)->toBe($user->id);
+    expect($post->deleted_by)->toBe(null);
+});