fix: fix custom morph prefix on user, with tests (#773)

Author: erikn69

src/Audit.php

@@ -44,7 +44,9 @@ public function auditable()
      */
     public function user()
     {
-        return $this->morphTo();
+        $morphPrefix = Config::get('audit.user.morph_prefix', 'user');
+
+        return $this->morphTo(__FUNCTION__, $morphPrefix . '_type', $morphPrefix . '_id');
     }
 
     /**

tests/AuditingTestCase.php

@@ -27,7 +27,7 @@ protected function getEnvironmentSetUp($app)
         // Audit
         $app['config']->set('audit.drivers.database.table', 'audit_testing');
         $app['config']->set('audit.drivers.database.connection', 'testing');
-        $app['config']->set('audit.user.morph_prefix', 'user');
+        $app['config']->set('audit.user.morph_prefix', 'prefix');
         $app['config']->set('audit.user.resolver', UserResolver::class);
         $app['config']->set('audit.user.guards', [
             'web',

tests/Unit/AuditableTest.php

@@ -403,6 +403,7 @@ public function itReturnsTheAuditData()
 
         $this->assertCount(11, $auditData = $model->toAudit());
 
+        $morphPrefix = config('audit.user.morph_prefix', 'user');
         self::Assert()::assertArraySubset([
             'old_values'     => [],
             'new_values'     => [
@@ -411,15 +412,15 @@ public function itReturnsTheAuditData()
                 'reviewed'     => 1,
                 'published_at' => $now->toDateTimeString(),
             ],
-            'event'          => 'created',
-            'auditable_id'   => null,
-            'auditable_type' => Article::class,
-            'user_id'        => null,
-            'user_type'      => null,
-            'url'            => 'console',
-            'ip_address'     => '127.0.0.1',
-            'user_agent'     => 'Symfony',
-            'tags'           => null,
+            'event'                 => 'created',
+            'auditable_id'          => null,
+            'auditable_type'        => Article::class,
+            $morphPrefix . '_id'    => null,
+            $morphPrefix . '_type'  => null,
+            'url'                   => 'console',
+            'ip_address'            => '127.0.0.1',
+            'user_agent'            => 'Symfony',
+            'tags'                  => null,
         ], $auditData, true);
     }
 
@@ -462,6 +463,7 @@ public function itReturnsTheAuditDataIncludingUserAttributes(
 
         $this->assertCount(11, $auditData = $model->toAudit());
 
+        $morphPrefix = config('audit.user.morph_prefix', 'user');
         self::Assert()::assertArraySubset([
             'old_values'     => [],
             'new_values'     => [
@@ -470,15 +472,15 @@ public function itReturnsTheAuditDataIncludingUserAttributes(
                 'reviewed'     => 1,
                 'published_at' => $now->toDateTimeString(),
             ],
-            'event'          => 'created',
-            'auditable_id'   => null,
-            'auditable_type' => Article::class,
-            'user_id'        => $id,
-            'user_type'      => $type,
-            'url'            => 'console',
-            'ip_address'     => '127.0.0.1',
-            'user_agent'     => 'Symfony',
-            'tags'           => null,
+            'event'                 => 'created',
+            'auditable_id'          => null,
+            'auditable_type'        => Article::class,
+            $morphPrefix . '_id'    => $id,
+            $morphPrefix . '_type'  => $type,
+            'url'                   => 'console',
+            'ip_address'            => '127.0.0.1',
+            'user_agent'            => 'Symfony',
+            'tags'                  => null,
         ], $auditData, true);
     }
 
@@ -544,21 +546,22 @@ public function itExcludesAttributesFromTheAuditDataWhenInStrictMode()
 
         $this->assertCount(11, $auditData = $model->toAudit());
 
+        $morphPrefix = config('audit.user.morph_prefix', 'user');
         self::Assert()::assertArraySubset([
             'old_values'     => [],
             'new_values'     => [
                 'title'   => 'How To Audit Eloquent Models',
                 'content' => 'First step: install the laravel-auditing package.',
             ],
-            'event'          => 'created',
-            'auditable_id'   => null,
-            'auditable_type' => Article::class,
-            'user_id'        => null,
-            'user_type'      => null,
-            'url'            => 'console',
-            'ip_address'     => '127.0.0.1',
-            'user_agent'     => 'Symfony',
-            'tags'           => null,
+            'event'                 => 'created',
+            'auditable_id'          => null,
+            'auditable_type'        => Article::class,
+            $morphPrefix . '_id'    => null,
+            $morphPrefix . '_type'  => null,
+            'url'                   => 'console',
+            'ip_address'            => '127.0.0.1',
+            'user_agent'            => 'Symfony',
+            'tags'                  => null,
         ], $auditData, true);
     }
 

tests/database/factories/AuditFactory.php

@@ -13,11 +13,13 @@
 */
 
 $factory->define(Audit::class, function (Faker $faker) {
+    $morphPrefix = Config::get('audit.user.morph_prefix', 'user');
+
     return [
-        'user_id' => function () {
+        $morphPrefix . '_id' => function () {
             return factory(User::class)->create()->id;
         },
-        'user_type'    => User::class,
+        $morphPrefix . '_type'    => User::class,
         'event'        => 'updated',
         'auditable_id' => function () {
             return factory(Article::class)->create()->id;