Merge pull request spatie#1121 from spatie/fix-enum-casting

Gummibeer · web-flow · commit eee61436e298 · 2022-11-14T13:16:46.000+01:00
Fix enum casting
diff --git a/composer.json b/composer.json
@@ -33,7 +33,7 @@
     "require": {
         "php": "^8.0",
         "illuminate/config": "^8.0 || ^9.0",
-        "illuminate/database": "^8.53 || ^9.0",
+        "illuminate/database": "^8.69 || ^9.27",
         "illuminate/support": "^8.0 || ^9.0",
         "spatie/laravel-package-tools": "^1.6.3"
     },
diff --git a/src/Actions/ResolveForPropertyValueAction.php b/src/Actions/ResolveForPropertyValueAction.php
diff --git a/src/ActivityLogger.php b/src/ActivityLogger.php
@@ -10,7 +10,6 @@
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Conditionable;
 use Illuminate\Support\Traits\Macroable;
-use Spatie\Activitylog\Actions\ResolveForPropertyValueAction;
 use Spatie\Activitylog\Contracts\Activity as ActivityContract;
 
 class ActivityLogger
@@ -103,15 +102,13 @@ public function setEvent(string $event): static
 
     public function withProperties(mixed $properties): static
     {
-        $this->getActivity()->properties = collect($properties)->map(fn ($value) => ResolveForPropertyValueAction::execute($value));
+        $this->getActivity()->properties = collect($properties);
 
         return $this;
     }
 
     public function withProperty(string $key, mixed $value): static
     {
-        $value = ResolveForPropertyValueAction::execute($value);
-
         $this->getActivity()->properties = $this->getActivity()->properties->put($key, $value);
 
         return $this;
diff --git a/src/Traits/LogsActivity.php b/src/Traits/LogsActivity.php
@@ -367,7 +367,14 @@ public static function logChanges(Model $model): array
                 $cast = $model->getCasts()[$attribute];
 
                 if (function_exists('enum_exists') && enum_exists($cast)) {
-                    $changes[$attribute] = $model->getStorableEnumValue($changes[$attribute]);
+                    if (method_exists($model, 'getStorableEnumValue')) {
+                        $changes[$attribute] = $model->getStorableEnumValue($changes[$attribute]);
+                    } else {
+                        // ToDo: DEPRECATED - only here for Laravel 8 support
+                        $changes[$attribute] = $changes[$attribute] instanceof \BackedEnum
+                            ? $changes[$attribute]->value
+                            : $changes[$attribute]->name;
+                    }
                 }
 
                 if ($model->isCustomDateTimeCast($cast) || $model->isImmutableCustomDateTimeCast($cast)) {
diff --git a/tests/AbleStoreNonBackedEnumTest.php b/tests/AbleStoreNonBackedEnumTest.php
diff --git a/tests/ActivityLoggerTest.php b/tests/ActivityLoggerTest.php
@@ -1,11 +1,13 @@
 <?php
 
 use Carbon\Carbon;
+use Illuminate\Database\Eloquent\JsonEncodingException;
 use Illuminate\Support\Collection;
 use Spatie\Activitylog\Exceptions\CouldNotLogActivity;
 use Spatie\Activitylog\Facades\CauserResolver;
 use Spatie\Activitylog\LogOptions;
 use Spatie\Activitylog\Models\Activity;
+use Spatie\Activitylog\Test\Enums\NonBackedEnum;
 use Spatie\Activitylog\Test\Models\Article;
 use Spatie\Activitylog\Test\Models\User;
 use Spatie\Activitylog\Traits\LogsActivity;
@@ -431,10 +433,20 @@ public function tapActivity(Activity $activity, string $eventName)
     expect($this->getLastActivity())->toBeNull();
 });
 
-// Helpers
-function it_returns_an_instance_of_the_activity_after_logging()
-{
-    $activityModel = activity()->log('test');
+it('logs backed enums in properties', function () {
+    activity()
+        ->withProperties(['int_backed_enum' => \Spatie\Activitylog\Test\Enums\IntBackedEnum::Draft])
+        ->withProperty('string_backed_enum', \Spatie\Activitylog\Test\Enums\StringBackedEnum::Published)
+        ->log($this->activityDescription);
 
-    expect($activityModel)->toBeInstanceOf(Activity::class);
-}
+    $this->assertSame(0, $this->getLastActivity()->properties['int_backed_enum']);
+    $this->assertSame('published', $this->getLastActivity()->properties['string_backed_enum']);
+})->skip(version_compare(PHP_VERSION, '8.1', '<'), "PHP < 8.1 doesn't support enum");
+
+it('does not log non backed enums in properties', function () {
+    activity()
+        ->withProperty('non_backed_enum', NonBackedEnum::Published)
+        ->log($this->activityDescription);
+})
+    ->throws(JsonEncodingException::class)
+    ->skip(version_compare(PHP_VERSION, '8.1', '<'), "PHP < 8.1 doesn't support enum");
diff --git a/tests/DetectsChangesTest.php b/tests/DetectsChangesTest.php
@@ -1073,6 +1073,7 @@ public function getActivitylogOptions(): LogOptions
             'json' => null,
             'price' => null,
             'interval' => null,
+            'status' => null,
             'created_at' =>  '2017-01-01T12:00:00.000000Z',
             'updated_at' =>  '2017-01-01T12:00:00.000000Z',
         ],
@@ -1117,6 +1118,7 @@ public function getActivitylogOptions(): LogOptions
             'updated_at' =>  '2017-01-01T12:00:00.000000Z',
             'user.name' => 'user name',
             'interval' => null,
+            'status' => null,
         ],
     ];
 
@@ -1237,6 +1239,7 @@ public function getActivitylogOptions(): LogOptions
             'json' => null,
             'price' => null,
             'interval' => null,
+            'status' => null,
             'created_at' =>  '2017-01-01T12:00:00.000000Z',
         ],
     ];
@@ -1269,6 +1272,7 @@ public function getActivitylogOptions(): LogOptions
             'user_id' => null,
             'price' => null,
             'interval' => null,
+            'status' => null,
         ],
     ];
 
diff --git a/tests/Enum/NonBackedEnum.php b/tests/Enum/NonBackedEnum.php
diff --git a/tests/Enums/IntBackedEnum.php b/tests/Enums/IntBackedEnum.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Spatie\Activitylog\Test\Enums;
+
+enum IntBackedEnum: int
+{
+    case Published = 1;
+    case Draft = 0;
+}
diff --git a/tests/Enums/NonBackedEnum.php b/tests/Enums/NonBackedEnum.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Spatie\Activitylog\Test\Enums;
+
+enum NonBackedEnum
+{
+    case Published;
+    case Draft;
+}
diff --git a/tests/Enums/StringBackedEnum.php b/tests/Enums/StringBackedEnum.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Spatie\Activitylog\Test\Enums;
+
+enum StringBackedEnum: string
+{
+    case Published = 'published';
+    case Draft = 'draft';
+}
diff --git a/tests/LogsActivitySerializationTest.php b/tests/LogsActivitySerializationTest.php
diff --git a/tests/LogsActivityTest.php b/tests/LogsActivityTest.php
@@ -2,10 +2,13 @@
 
 use Carbon\Carbon;
 use Illuminate\Database\Eloquent\SoftDeletes;
+use Illuminate\Foundation\Application;
 use Illuminate\Support\Collection;
 use Spatie\Activitylog\LogOptions;
 use Spatie\Activitylog\Models\Activity;
+use Spatie\Activitylog\Test\Enums\NonBackedEnum;
 use Spatie\Activitylog\Test\Models\Article;
+use Spatie\Activitylog\Test\Models\ArticleWithLogDescriptionClosure;
 use Spatie\Activitylog\Test\Models\Issue733;
 use Spatie\Activitylog\Test\Models\User;
 use Spatie\Activitylog\Traits\LogsActivity;
@@ -494,3 +497,87 @@ public function getActivitylogOptions(): LogOptions
     $this->assertEquals('created', $this->getLastActivity()->description);
     $this->assertEquals('created', $this->getLastActivity()->event);
 });
+
+it('can be serialized', function () {
+    $model = ArticleWithLogDescriptionClosure::create(['name' => 'foo']);
+
+    $this->assertNotNull(serialize($model));
+});
+
+it('logs non backed enum casted attribute', function () {
+    $articleClass = new class() extends Article {
+        use LogsActivity;
+
+        protected $casts = [
+            'status' => NonBackedEnum::class,
+        ];
+
+        public function getActivitylogOptions(): LogOptions
+        {
+            return LogOptions::defaults()->logOnly(['status']);
+        }
+    };
+
+    $article = new $articleClass();
+    $article->status = NonBackedEnum::Draft;
+    $article->save();
+
+    $this->assertInstanceOf(get_class($articleClass), $this->getLastActivity()->subject);
+    $this->assertEquals($article->id, $this->getLastActivity()->subject->id);
+    $this->assertSame('Draft', $this->getLastActivity()->properties['attributes']['status']);
+    $this->assertEquals('created', $this->getLastActivity()->description);
+    $this->assertEquals('created', $this->getLastActivity()->event);
+})->skip(
+    version_compare(PHP_VERSION, '8.1', '<') || version_compare(Application::VERSION, '9.0', '<'),
+    "PHP < 8.1 doesn't support enums && Laravel < 9.0 doesn't support non-backed-enum casting"
+);
+
+it('logs int backed enum casted attribute', function () {
+    $articleClass = new class() extends Article {
+        use LogsActivity;
+
+        protected $casts = [
+            'status' => \Spatie\Activitylog\Test\Enums\IntBackedEnum::class,
+        ];
+
+        public function getActivitylogOptions(): LogOptions
+        {
+            return LogOptions::defaults()->logOnly(['status']);
+        }
+    };
+
+    $article = new $articleClass();
+    $article->status = \Spatie\Activitylog\Test\Enums\IntBackedEnum::Published;
+    $article->save();
+
+    $this->assertInstanceOf(get_class($articleClass), $this->getLastActivity()->subject);
+    $this->assertEquals($article->id, $this->getLastActivity()->subject->id);
+    $this->assertSame(1, $this->getLastActivity()->properties['attributes']['status']);
+    $this->assertEquals('created', $this->getLastActivity()->description);
+    $this->assertEquals('created', $this->getLastActivity()->event);
+})->skip(version_compare(PHP_VERSION, '8.1', '<'), "PHP < 8.1 doesn't support enum");
+
+it('logs string backed enum casted attribute', function () {
+    $articleClass = new class() extends Article {
+        use LogsActivity;
+
+        protected $casts = [
+            'status' => \Spatie\Activitylog\Test\Enums\StringBackedEnum::class,
+        ];
+
+        public function getActivitylogOptions(): LogOptions
+        {
+            return LogOptions::defaults()->logOnly(['status']);
+        }
+    };
+
+    $article = new $articleClass();
+    $article->status = \Spatie\Activitylog\Test\Enums\StringBackedEnum::Draft;
+    $article->save();
+
+    $this->assertInstanceOf(get_class($articleClass), $this->getLastActivity()->subject);
+    $this->assertEquals($article->id, $this->getLastActivity()->subject->id);
+    $this->assertSame('draft', $this->getLastActivity()->properties['attributes']['status']);
+    $this->assertEquals('created', $this->getLastActivity()->description);
+    $this->assertEquals('created', $this->getLastActivity()->event);
+})->skip(version_compare(PHP_VERSION, '8.1', '<'), "PHP < 8.1 doesn't support enum");
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -80,6 +80,7 @@ protected function createTables(...$tableNames)
                     $table->text('json')->nullable();
                     $table->string('interval')->nullable();
                     $table->decimal('price')->nullable();
+                    $table->string('status')->nullable();
                 }
             });
         });

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@`
`10`	`10`	`use Illuminate\Support\Str;`
`11`	`11`	`use Illuminate\Support\Traits\Conditionable;`
`12`	`12`	`use Illuminate\Support\Traits\Macroable;`
`13`		`-use Spatie\Activitylog\Actions\ResolveForPropertyValueAction;`
`14`	`13`	`use Spatie\Activitylog\Contracts\Activity as ActivityContract;`
`15`	`14`
`16`	`15`	`class ActivityLogger`
`@@ -103,15 +102,13 @@ public function setEvent(string $event): static`
`103`	`102`
`104`	`103`	`public function withProperties(mixed $properties): static`
`105`	`104`	`{`
`106`		`- $this->getActivity()->properties = collect($properties)->map(fn ($value) => ResolveForPropertyValueAction::execute($value));`
	`105`	`+ $this->getActivity()->properties = collect($properties);`
`107`	`106`
`108`	`107`	`return $this;`
`109`	`108`	`}`
`110`	`109`
`111`	`110`	`public function withProperty(string $key, mixed $value): static`
`112`	`111`	`{`
`113`		`- $value = ResolveForPropertyValueAction::execute($value);`
`114`		`-`
`115`	`112`	`$this->getActivity()->properties = $this->getActivity()->properties->put($key, $value);`
`116`	`113`
`117`	`114`	`return $this;`