Add withoutAuditing() for callbacks (#917)

Similar to Laravel's Model::withoutEvents() method

Author: derekmd

src/Auditable.php

@@ -536,6 +536,26 @@ public static function enableAuditing()
         static::$auditingDisabled = false;
     }
 
+    /**
+     * Execute a callback while auditing is disabled.
+     *
+     * @param callable $callback
+     *
+     * @return mixed
+     */
+    public static function withoutAuditing(callable $callback)
+    {
+        $auditingDisabled = static::$auditingDisabled;
+
+        static::disableAuditing();
+
+        try {
+            return $callback();
+        } finally {
+            static::$auditingDisabled = $auditingDisabled;
+        }
+    }
+
     /**
      * Determine whether auditing is enabled.
      *

tests/Functional/AuditingTest.php

@@ -433,6 +433,29 @@ public function itDisablesAndEnablesAuditingBackAgainViaFacade()
         $this->assertSame(1, Audit::count());
     }
 
+    /**
+     * @test
+     */
+    public function itDisablesAndEnablesAuditingBackAgainViaWithoutAuditingMethod()
+    {
+        // Auditing is enabled by default
+        $this->assertFalse(Article::$auditingDisabled);
+
+        Article::withoutAuditing(function () {
+            factory(Article::class)->create();
+        });
+
+        $this->assertSame(1, Article::count());
+        $this->assertSame(0, Audit::count());
+
+        $this->assertFalse(Article::$auditingDisabled);
+
+        factory(Article::class)->create();
+
+        $this->assertSame(2, Article::count());
+        $this->assertSame(1, Audit::count());
+    }
+
     /**
      * @test
      * @return void

tests/Unit/AuditableTest.php

@@ -36,6 +36,40 @@ public function setUp(): void
         Relation::morphMap([], false);
     }
 
+    /**
+     * @group Auditable::withoutAuditing
+     * @test
+     */
+    public function itWillRunCallbackWithAuditingDisabled()
+    {
+        $this->assertFalse(Article::$auditingDisabled);
+
+        $result = Article::withoutAuditing(function () {
+            $this->assertTrue(Article::$auditingDisabled);
+            $this->assertFalse(ArticleExcludes::$auditingDisabled);
+
+            return 'result';
+        });
+
+        $this->assertFalse(Article::$auditingDisabled);
+        $this->assertSame('result', $result);
+    }
+
+    /**
+     * @group Auditable::withoutAuditing
+     * @test
+     */
+    public function itWillRunCallbackThenRestoreAuditingDisabled()
+    {
+        Article::$auditingDisabled = true;
+
+        Article::withoutAuditing(function () {
+            $this->assertTrue(Article::$auditingDisabled);
+        });
+
+        $this->assertTrue(Article::$auditingDisabled);
+    }
+
     /**
      * @group Auditable::isAuditingEnabled
      * @test