Support forceDeleted event

Author: youchenlee

config/audit.php

@@ -60,6 +60,7 @@
         'created',
         'updated',
         'deleted',
+        'forceDeleted',
         'restored',
     ],
 

src/Auditable.php

@@ -185,6 +185,16 @@ protected function getDeletedEventAttributes(): array
         ];
     }
 
+/**
+     * Get the old/new attributes of a forceDeleted event.
+     *
+     * @return array
+     */
+    protected function getforceDeletedEventAttributes(): array
+    {
+        return $this->getDeletedEventAttributes();
+    }
+
     /**
      * Get the old/new attributes of a restored event.
      *

src/AuditableObserver.php

@@ -65,6 +65,18 @@ public function deleted(Auditable $model)
         Auditor::execute($model->setAuditEvent('deleted'));
     }
 
+    /**
+     * Handle the forceDeleted event.
+     *
+     * @param \OwenIt\Auditing\Contracts\Auditable $model
+     *
+     * @return void
+     */
+    public function forceDeleted(Auditable $model)
+    {
+        Auditor::execute($model->setAuditEvent('forceDeleted'));
+    }
+
     /**
      * Handle the restoring event.
      *

tests/Functional/AuditingTest.php

@@ -221,6 +221,37 @@ public function itWillAuditTheDeletedEvent()
         $this->assertEmpty($audit->new_values);
     }
 
+    /**
+     * @test
+     */
+    public function itWillAuditTheForceDeletedEvent()
+    {
+        $this->app['config']->set('audit.events', [
+            'forceDeleted',
+        ]);
+
+        $article = factory(Article::class)->create([
+            'title'        => 'How To Audit Eloquent Models',
+            'content'      => 'N/A',
+            'published_at' => null,
+            'reviewed'     => 0,
+        ]);
+
+        $article->forceDelete();
+
+        $audit = Audit::first();
+
+        $this->assertArraySubset([
+            'title'        => 'How To Audit Eloquent Models',
+            'content'      => 'N/A',
+            'published_at' => null,
+            'reviewed'     => 0,
+            'id'           => 1,
+        ], $audit->old_values, true);
+
+        $this->assertEmpty($audit->new_values);
+    }
+
     /**
      * @test
      */

tests/Unit/AuditableObserverTest.php

@@ -60,6 +60,11 @@ public function auditableObserverTestProvider(): array
                 false,
                 false,
             ],
+            [
+                'forceDeleted',
+                false,
+                false,
+            ],
             [
                 'restoring',
                 false,

tests/Unit/AuditableTest.php

@@ -119,6 +119,7 @@ public function itReturnsTheDefaultAuditEvents()
             'created',
             'updated',
             'deleted',
+            'forceDeleted',
             'restored',
         ], $model->getAuditEvents(), true);
     }
@@ -217,6 +218,9 @@ public function itIsReadyForAuditingWithRegularEvents()
         $model->setAuditEvent('deleted');
         $this->assertTrue($model->readyForAuditing());
 
+        $model->setAuditEvent('forceDeleted');
+        $this->assertTrue($model->readyForAuditing());
+
         $model->setAuditEvent('restored');
         $this->assertTrue($model->readyForAuditing());
     }