build(actions): centralized business logic for value resolver

Author: Stiven Katuuk

src/Actions/ResolveForPropertyValueAction.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Spatie\Activitylog\Actions;
+
+class ResolveForPropertyValueAction
+{
+    /**
+     * Action that resolve property value of log
+     * that cannot be handled by PHP or This Package
+     *
+     * @param mixed $value
+     * @return mixed
+     */
+    public static function execute(mixed $value): mixed
+    {
+        $instance = new static;
+
+        if ($instance->isValueAreEnum($value)) {
+            return $value->value ?? $value->name;
+        }
+
+        return $value;
+    }
+
+    protected function isValueAreEnum($value): bool
+    {
+        if (! function_exists('enum_exists')){
+            return false;
+        }
+
+        $enumNamespace = is_object($value)
+            ? get_class($value)
+            : $value;
+
+        return enum_exists($enumNamespace);
+    }
+}

src/ActivityLogger.php

@@ -10,6 +10,7 @@
 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
@@ -102,16 +103,14 @@ public function setEvent(string $event): static
 
     public function withProperties(mixed $properties): static
     {
-        $this->getActivity()->properties = collect($properties);
+        $this->getActivity()->properties = collect($properties)->map(fn ($value) => ResolveForPropertyValueAction::execute($value));
 
         return $this;
     }
 
     public function withProperty(string $key, mixed $value): static
     {
-        if (is_object($value) && function_exists('enum_exists') && enum_exists(get_class($value))) {
-            $value = $value->value ?? $value->name;
-        }
+        $value = ResolveForPropertyValueAction::execute($value);
 
         $this->getActivity()->properties = $this->getActivity()->properties->put($key, $value);
 

tests/AbleStoreNonBackedEnumTest.php

@@ -6,12 +6,30 @@
 use Spatie\Activitylog\Test\Models\Activity;
 use Spatie\Activitylog\Test\Models\User;
 
-it('can store non backed enum', function () {
+afterEach(fn() => Activity::query()->latest()->first()->delete());
+
+it('can store non backed only a property', function () {
     $description = 'ROLE LOG';
 
     activity()
         ->performedOn(User::first())
         ->withProperty('role', NonBackedEnum::User)->log($description);
 
-    expect(Activity::query()->latest()->first()->description)->toEqual($description);
+    $latestActivity = Activity::query()->latest()->first();
+
+    expect($latestActivity->description)->toEqual($description)
+        ->and($latestActivity->properties['role'])->toEqual('User');
+});
+
+it('can store non backed with properties', function () {
+    $description = 'ROLE LOG';
+
+    activity()
+        ->performedOn(User::first())
+        ->withProperties(['role' => NonBackedEnum::User])->log($description);
+
+    $latestActivity = Activity::query()->latest()->first();
+
+    expect($latestActivity->description)->toEqual($description)
+        ->and($latestActivity->properties['role'])->toEqual('User');
 });