Merge pull request #39 from noxoua/develop

Develop
noxoua · Nov 5, 2023 · 5f0d3b2 · 5f0d3b2
2 parents 59b14d4 + eca5b17
commit 5f0d3b2
Show file tree

Hide file tree

Showing 22 changed files with 184 additions and 57 deletions.
diff --git a/docs/004-fields.md b/docs/004-fields.md
@@ -104,7 +104,7 @@ ____
 ```php
 $logger->fields([
    Field::make('meta')
-         ->view('key-value')
+         ->keyValue(differenceOnly: true)
          ->label('Attributes'),
 ])
 ```
@@ -118,13 +118,49 @@ ____
 ```php
 $logger->fields([
    // 'categories' => 'relation:name',
-   Field::make('categories')
-         ->relation('name') // get names only
-         ->badge('info')
+   Field::make('categories.name') // hasMany
+         ->relation()
          ->label('Categories'),
+
+   // 'category.name',
+   Field::make('category.name') // hasOne
+         ->relation()
+         ->label('Category'),
+])
+```
+
+{: .note }
+If you have `preloadRelations`, you can skip `relation`, and vice versa.
+
+
+#### With preload relations
+
+When you use `preloadRelations`, you can directly define the relation field without the need for `relation`:
+
+```php
+$logger
+   ->preloadRelations('categories')
+   ->fields([
+      Field::make('categories.name')->label('Categories'),
+   ])
+```
+
+#### With relation
+
+If you prefer to use `relation`, it works similarly to `preloadRelations`:
+
+```php
+$logger->fields([
+   Field::make('categories.name')
+      ->relation()
+      ->label('Categories'),
 ])
 ```
 
+{: .info }
+`preloadRelations` and `relation` work similarly to Laravel's eager loading.
+
+
 ![Screenshot](./assets/images/relation-screenshot.png)
 
 ____

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -21,6 +21,8 @@ callouts:
     color: yellow
   note:
     color: purple
+  info:
+    color: blue
 
 
 compress_html:

diff --git a/docs/get-started/003.3-logger-example.md b/docs/get-started/003.3-logger-example.md
@@ -35,14 +35,18 @@ class ProductLogger extends Logger
     public static function resource(ResourceLogger $logger): ResourceLogger
     {
         return $logger
+            ->preloadRelations(
+                // Preload your relationships,
+                // this is necessary to log the data correctly.
+                'categories',
+            )
             // Resource Fields
             ->fields([
                 Field::make('title')
                     ->label(__('Title')),
 
-                Field::make('categories')
-                    ->label(__('Categories'))
-                    ->relation('name'),
+                Field::make('categories.name')
+                    ->label(__('Categories')),
 
                 Field::make('media')
                     ->label(__('Images'))
@@ -62,8 +66,9 @@ class ProductLogger extends Logger
             ])
             // Relation Managers
             ->relationManagers([
-                'accessories' => fn (RelationManager $relationManager) => $relationManager
+                RelationManager::make('accessories')
                     ->label('Accessory')
+                    // ->preloadRelations()
                     ->fields([
                         Field::make('name')
                             ->label(__('Label')),

diff --git a/resources/views/components/badge.blade.php b/resources/views/components/badge.blade.php
@@ -5,17 +5,20 @@
 @endphp
 
 <div class="flex flex-wrap gap-2">
-    @if (is_string($value) || $field->is('enum'))
+    @if (is_array($value))
+        @foreach ($value as $label)
+            <x-filament::badge
+                :color="$field->badgeColor"
+                class="w-fit"
+            >
+                {{ $label }}
+            </x-filament::badge>
+        @endforeach
+    @elseif($field->is('enum'))
         @php
-            if (is_string($value)) {
-                $label = $value;
-                $color = $field->badgeColor;
-                $icon = null;
-            } else {
-                $label = $value instanceof HasLabel ? $value->getLabel() : $value;
-                $color = $value instanceof HasColor ? $value->getColor() : $field->badgeColor;
-                $icon = $value instanceof HasIcon ? $value->getIcon() : null;
-            }
+            $label = $value instanceof HasLabel ? $value->getLabel() : $value;
+            $color = $value instanceof HasColor ? $value->getColor() : $field->badgeColor;
+            $icon = $value instanceof HasIcon ? $value->getIcon() : null;
         @endphp
 
         <x-filament::badge
@@ -25,14 +28,13 @@ class="w-fit"
         >
             {{ $label }}
         </x-filament::badge>
-    @elseif(is_array($value))
-        @foreach ($value as $label)
-            <x-filament::badge
-                :color="$field->badgeColor"
-                class="w-fit"
-            >
-                {{ $label }}
-            </x-filament::badge>
-        @endforeach
+    @else
+        <x-filament::badge
+            :color="$field->badgeColor"
+            class="w-fit"
+        >
+            {{ $value }}
+        </x-filament::badge>
     @endif
+
 </div>
diff --git a/resources/views/components/table.blade.php b/resources/views/components/table.blade.php
@@ -1,20 +1,22 @@
-<x-filament-tables::table class="w-full overflow-hidden text-sm">
-    <x-slot:header>
-        @foreach (array_keys($value[0]) as $key)
-            <x-filament-tables::header-cell class="!py-2">
-                {{ $key }}
-            </x-filament-tables::header-cell>
-        @endforeach
-    </x-slot:header>
+@if (!empty($value))
+    <x-filament-tables::table class="w-full overflow-hidden text-sm">
+        <x-slot:header>
+            @foreach (array_keys($value[0]) as $key)
+                <x-filament-tables::header-cell class="!py-2">
+                    {{ $key }}
+                </x-filament-tables::header-cell>
+            @endforeach
+        </x-slot:header>
 
 
-    @foreach ($value as $item)
-        <x-filament-tables::row @class(['bg-gray-100/30 dark:bg-gray-900' => $loop->even])>
-            @foreach ($item as $_value)
-                <x-filament-tables::cell class="px-4 py-2 align-top sm:first-of-type:ps-6 sm:last-of-type:pe-6">
-                    {{ $_value }}
-                </x-filament-tables::cell>
-            @endforeach
-        </x-filament-tables::row>
-    @endforeach
-</x-filament-tables::table>
+        @foreach ($value as $item)
+            <x-filament-tables::row @class(['bg-gray-100/30 dark:bg-gray-900' => $loop->even])>
+                @foreach ($item as $_value)
+                    <x-filament-tables::cell class="px-4 py-2 align-top sm:first-of-type:ps-6 sm:last-of-type:pe-6">
+                        {{ $_value }}
+                    </x-filament-tables::cell>
+                @endforeach
+            </x-filament-tables::row>
+        @endforeach
+    </x-filament-tables::table>
+@endif
diff --git a/src/Extensions/LogActions.php b/src/Extensions/LogActions.php
@@ -17,17 +17,24 @@ public static function mount(): void
     {
         $self = new static;
 
+        // TODO:
+
         // * Table Actions
         // TableActions\AssociateAction::configureUsing(fn ($action) => $self->associate($action));
         // TableActions\AttachAction::configureUsing(fn ($action) => $self->attach($action));
         TableActions\CreateAction::configureUsing(fn ($action) => $self->create($action));
         TableActions\DeleteAction::configureUsing(fn ($action) => $self->delete($action));
+        // TableActions\DeleteBulkAction::configureUsing(fn ($action) => $self->delete($action));
         // TableActions\DetachAction::configureUsing(fn ($action) => $self->detach($action));
+        // TableActions\DetachBulkAction::configureUsing(fn ($action) => $self->detach($action));
         // TableActions\DissociateAction::configureUsing(fn ($action) => $self->dissociate($action));
+        // TableActions\DissociateBulkAction::configureUsing(fn ($action) => $self->dissociate($action));
         TableActions\EditAction::configureUsing(fn ($action) => $self->edit($action));
         TableActions\ForceDeleteAction::configureUsing(fn ($action) => $self->delete($action));
+        // TableActions\ForceDeleteBulkAction::configureUsing(fn ($action) => $self->delete($action));
         TableActions\ReplicateAction::configureUsing(fn ($action) => $self->create($action));
         TableActions\RestoreAction::configureUsing(fn ($action) => $self->restore($action));
+        // TableActions\RestoreBulkAction::configureUsing(fn ($action) => $self->restore($action));
 
         // * Page Actions
         PageActions\CreateAction::configureUsing(fn ($action) => $self->create($action));

diff --git a/src/Loggers/Concerns/HasEvents.php b/src/Loggers/Concerns/HasEvents.php
@@ -41,6 +41,10 @@ public function updated(): void
                 [$beforeValue, $afterValue] = $field->resolveTableDifference($beforeValue, $afterValue);
             }
 
+            if ($field->is('key-value') && $field->keyValueDifferenceOnly) {
+                [$beforeValue, $afterValue] = $field->resolveKeyValueDifference($beforeValue, $afterValue);
+            }
+
             if ($beforeValue !== $afterValue) {
                 $old[$field->name] = $beforeValue;
                 $new[$field->name] = $afterValue;

diff --git a/src/ResourceLogger/Concerns/CanStore.php b/src/ResourceLogger/Concerns/CanStore.php
@@ -12,6 +12,6 @@ public function getStorableValue(Model $record): mixed
             return call_user_func($this->resolveStateCallback, $record);
         }
 
-        return $record->{$this->name};
+        return data_get($record, $this->name);
     }
 }
diff --git a/src/ResourceLogger/Concerns/HasFields.php b/src/ResourceLogger/Concerns/HasFields.php
@@ -51,7 +51,7 @@ public function getRelationNames(): array
             }
         }
 
-        return $relations;
+        return array_merge($relations, $this->preloadRelations);
     }
 
     public function getFieldByName(string $name): ?Field

diff --git a/src/ResourceLogger/Concerns/HasRelationLoader.php b/src/ResourceLogger/Concerns/HasRelationLoader.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Noxo\FilamentActivityLog\ResourceLogger\Concerns;
+
+trait HasRelationLoader
+{
+    /**
+     * @var array<string>
+     */
+    protected array $preloadRelations = [];
+
+    public function preloadRelations($relations): static
+    {
+        $this->preloadRelations = is_string($relations) ? func_get_args() : $relations;
+
+        return $this;
+    }
+}
diff --git a/src/ResourceLogger/Concerns/HasRelationManagers.php b/src/ResourceLogger/Concerns/HasRelationManagers.php
@@ -15,7 +15,13 @@ trait HasRelationManagers
     public function relationManagers(array $relationManagers): static
     {
         $this->relationManagers = array_map(
-            static fn (Closure $closure, string $name) => $closure(new RelationManager($name)),
+            function (Closure|RelationManager $closure, ?string $name) {
+                if ($closure instanceof RelationManager) {
+                    return $closure;
+                }
+
+                return $closure(new RelationManager($name));
+            },
             $relationManagers,
             array_keys($relationManagers),
         );

diff --git a/src/ResourceLogger/Concerns/Types/Boolean.php b/src/ResourceLogger/Concerns/Types/Boolean.php
@@ -11,7 +11,7 @@ public function boolean(): static
         $this->enum(config('filament-activity-log.boolean'));
         $this->view('badge');
 
-        $this->resolveStateUsing(fn (Model $model) => $model->{$this->name} ? 'true' : 'false');
+        $this->resolveStateUsing(fn (Model $record) => data_get($record, $this->name) ? 'true' : 'false');
 
         return $this;
     }

diff --git a/src/ResourceLogger/Concerns/Types/Date.php b/src/ResourceLogger/Concerns/Types/Date.php
@@ -27,7 +27,7 @@ public function datetime(string $format = null): static
         $format ??= 'j F, Y H:i:s';
         $this->type('datetime', $format);
 
-        $this->resolveStateUsing(fn (Model $model) => $model->{$this->name}?->toISOString());
+        $this->resolveStateUsing(fn (Model $record) => data_get($record, $this->name)?->toISOString());
 
         $this->formatStateUsing(function ($state): ?string {
             if (blank($state)) {

diff --git a/src/ResourceLogger/Concerns/Types/Difference.php b/src/ResourceLogger/Concerns/Types/Difference.php
@@ -28,6 +28,10 @@ public function difference(string $method = 'diffWords', array $options = []): s
         $this->type('difference', compact('method', 'options'));
 
         $this->formatStateUsing(function ($state) {
+            if (is_null($state)) {
+                $state = '';
+            }
+
             // TODO: not working with array
             // * resources/views/components/difference.blade.php
             return json_encode($state);

diff --git a/src/ResourceLogger/Concerns/Types/Enum.php b/src/ResourceLogger/Concerns/Types/Enum.php
@@ -13,7 +13,7 @@ public function enum(string $enum): static
         $this->type('enum', $enum);
         $this->view('badge');
 
-        $this->resolveStateUsing(fn (Model $model) => $model->{$this->name}?->name);
+        $this->resolveStateUsing(fn (Model $record) => data_get($record, $this->name)?->name);
 
         $this->formatStateUsing(fn ($state): ?UnitEnum => Helper::resolveEnum($this->options, $state));
 

diff --git a/src/ResourceLogger/Concerns/Types/KeyValue.php b/src/ResourceLogger/Concerns/Types/KeyValue.php
@@ -0,0 +1,35 @@
+<?php
+
+namespace Noxo\FilamentActivityLog\ResourceLogger\Concerns\Types;
+
+trait KeyValue
+{
+    public bool $keyValueDifferenceOnly = true;
+
+    public function keyValue(bool $differenceOnly = true): static
+    {
+        $this->type('key-value');
+        $this->view('key-value');
+        $this->keyValueDifferenceOnly = $differenceOnly;
+
+        return $this;
+    }
+
+    public function resolveKeyValueDifference(mixed $array1, mixed $array2): array
+    {
+        if (! is_array($array1) || ! is_array($array2)) {
+            return [$array1, $array2];
+        }
+
+        foreach ($array1 as $key1 => $row1) {
+            foreach ($array2 as $key2 => $row2) {
+                if ($row1 === $row2) {
+                    unset($array1[$key1]);
+                    unset($array2[$key2]);
+                }
+            }
+        }
+
+        return [$array1, $array2];
+    }
+}
diff --git a/src/ResourceLogger/Concerns/Types/Media.php b/src/ResourceLogger/Concerns/Types/Media.php
@@ -21,8 +21,8 @@ public function media(?bool $gallery = false): static
             $this->square();
         }
 
-        $this->resolveStateUsing(function (Model $model): mixed {
-            $relation = $model->{$this->name};
+        $this->resolveStateUsing(function (Model $record): mixed {
+            $relation = data_get($record, $this->name);
 
             if ($this->gallery) {
                 return $relation->pluck('original_url')->toArray();

diff --git a/src/ResourceLogger/Concerns/Types/Money.php b/src/ResourceLogger/Concerns/Types/Money.php
@@ -11,7 +11,7 @@ public function money(string $currency = 'EUR'): static
         $this->type('money', $currency);
         $this->view('badge');
 
-        $this->formatStateUsing(fn ($state): ?string => format_money($state, $this->options));
+        $this->formatStateUsing(fn ($state): ?string => format_money((float) $state, $this->options));
 
         return $this;
     }

diff --git a/src/ResourceLogger/Concerns/Types/Relation.php b/src/ResourceLogger/Concerns/Types/Relation.php
@@ -14,14 +14,14 @@ public function relation(string $column = null): static
         $this->isRelation = true;
 
         if ($column) {
-            $this->resolveStateUsing(function (Model $model) use ($column): mixed {
-                $relation = $model->{$this->name};
+            $this->resolveStateUsing(function (Model $record) use ($column): mixed {
+                $relation = data_get($record, $this->name);
 
                 if ($relation instanceof Collection) {
                     return $relation->pluck($column)->toArray();
                 }
 
-                return $relation->{$column};
+                return data_get($relation, $column);
             });
         }