Merge pull request #3 from lara-zeus/improvements

atmonshi · web-flow · commit ad80a33dfcc2 · 2024-09-05T18:32:52.000+03:00
Improvements
diff --git a/config/zeus-delia.php b/config/zeus-delia.php
@@ -12,6 +12,11 @@
         'bookmark_toggle_icon' => TablesRenderHook::TOOLBAR_TOGGLE_COLUMN_TRIGGER_AFTER,
     ],
 
+    'dropdown' => [
+        'title' => 'Bookmarks',
+        'icon' => 'heroicon-m-bookmark-square',
+    ],
+
     /**
      * set  the database tables prefix
      */
diff --git a/database/migrations/create_bookmarks_table.php.stub b/database/migrations/create_bookmarks_table.php.stub
@@ -15,11 +15,9 @@ return new class extends Migration
     {
         Schema::create(config('zeus-delia.table-prefix').'bookmarks', function (Blueprint $table) {
             $table->bigIncrements('id');
-
-            $table->string('bookmarkable_resource');
-            $table->string('bookmarkable_page')->nullable();
-            $table->integer('bookmarkable_id')->nullable();
-
+            $table->text('url');
+            $table->text('title');
+            $table->string('icon');
             $table->integer('user_id');
 
             $table->timestamps();
diff --git a/docs/getting-started/usage.md b/docs/getting-started/usage.md
@@ -0,0 +1,17 @@
+---
+title: Usage
+weight: 3
+---
+
+## Use the bookmark as a header action
+
+to add the bookmark action to any filament page:
+
+```php
+protected function getHeaderActions(): array
+{
+    return [
+        BookmarkHeaderAction::make()
+    ];
+}
+```
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -12,3 +12,5 @@ parameters:
     ignoreErrors:
         -
             identifier: missingType.iterableValue
+        -
+            identifier: missingType.generics
diff --git a/resources/lang/en/bookmark.php b/resources/lang/en/bookmark.php
@@ -4,8 +4,8 @@
     'model_label' => 'Bookmark',
     'plural_model_label' => 'Bookmarks',
     'navigation_label' => 'Bookmarks',
-    'bookmarkable_type' => 'Resource',
-    'bookmarkable_id' => 'ID',
+    'title' => 'Page',
+    'created_at' => 'Added at',
     'add' => 'Bookmark This Page',
     'added' => 'Bookmark Saved Successfully',
     'remove' => 'Remove This Bookmark',
diff --git a/resources/views/components/bookmark.blade.php b/resources/views/components/bookmark.blade.php
@@ -1,6 +1,8 @@
 <div>
     {{ ($this->bookmarkAction)([
-        'resource' => $resource
+        'url' => $url,
+        'title' => $title,
+        'icon' => $icon,
     ]) }}
 
     <x-filament-actions::modals />
diff --git a/resources/views/filament/hooks/table-column-bookmark.blade.php b/resources/views/filament/hooks/table-column-bookmark.blade.php
@@ -1,7 +1,19 @@
 <div>
-    @if(!is_bool(\Livewire\Livewire::current()) && method_exists(\Livewire\Livewire::current(),'getResource'))
-        <livewire:delia-bookmarks
-            :resource="\Livewire\Livewire::current()->getResource()"
-        />
+    @if(!is_bool(\Livewire\Livewire::current()))
+        @if(method_exists(\Livewire\Livewire::current(),'getResource'))
+            @php
+                $class = \Livewire\Livewire::current()->getResource();
+            @endphp
+        @else
+            @php
+                $class = \Livewire\Livewire::current();
+            @endphp
+        @endif
     @endif
+
+    <livewire:delia-bookmarks
+        :url="request()->fullUrl()"
+        :title="$class::getNavigationLabel()"
+        :icon="$class::getNavigationIcon()"
+    />
 </div>
diff --git a/resources/views/filament/hooks/topbar.blade.php b/resources/views/filament/hooks/topbar.blade.php
@@ -7,27 +7,28 @@
     <x-filament::dropdown>
         <x-slot name="trigger">
             <x-filament::icon-button size="lg"
-                icon="heroicon-m-bookmark-square"
+                :icon="config('zeus-delia.dropdown.icon')"
             >
-                More actions
+                {{ config('zeus-delia.dropdown.title') }}
             </x-filament::icon-button>
         </x-slot>
 
-        <x-filament::dropdown.list>
-            @foreach($bookmarks as $bookmark)
-                @if(class_exists($bookmark->bookmarkable_resource))
-                    @php
-                        $resourceClass = app($bookmark->bookmarkable_resource);
-                    @endphp
+        @if($bookmarks->isEmpty())
+            <x-filament::dropdown.header icon="tabler-bookmark-off">
+                No Bookmarks found
+            </x-filament::dropdown.header>
+        @else
+            <x-filament::dropdown.list>
+                @foreach($bookmarks as $bookmark)
                     <x-filament::dropdown.list.item
-                        tag="a"
-                        :icon="$resourceClass->getNavigationIcon()"
-                        :href="$resourceClass->getUrl()"
+                            tag="a"
+                            :icon="$bookmark->icon"
+                            :href="$bookmark->url"
                     >
-                        {{ $resourceClass->getNavigationLabel() }}
+                        {{ $bookmark->title }}
                     </x-filament::dropdown.list.item>
-                    @endif
-            @endforeach
-        </x-filament::dropdown.list>
+                @endforeach
+            </x-filament::dropdown.list>
+        @endif
     </x-filament::dropdown>
 </div>
diff --git a/src/Delia.php b/src/Delia.php
@@ -6,36 +6,48 @@
 
 class Delia
 {
-    public static function exist(string $class): bool
+    public static function exist(string $url): bool
     {
         return config('zeus-delia.models.Bookmark')::query()
-            ->where('bookmarkable_resource', $class)
+            ->where('url', $url)
             ->where('user_id', auth()->user()->id)
             ->exists();
     }
 
-    public static function toggle(string $class): void
+    public static function toggle(string $url, string $title, string $icon): void
     {
-        if (static::exist($class)) {
-            config('zeus-delia.models.Bookmark')::query()
-                ->where('bookmarkable_resource', $class)
-                ->where('user_id', auth()->user()->id)
-                ->delete();
-
-            Notification::make()
-                ->title(__('zeus-delia::bookmark.removed'))
-                ->info()
-                ->send();
+        if (static::exist($url)) {
+            static::remove($url);
         } else {
-            config('zeus-delia.models.Bookmark')::create([
-                'bookmarkable_resource' => $class,
-                'user_id' => auth()->user()->id,
-            ]);
-
-            Notification::make()
-                ->title(__('zeus-delia::bookmark.added'))
-                ->success()
-                ->send();
+            static::add($url, $title, $icon);
         }
     }
+
+    public static function add(string $url, string $title, string $icon): void
+    {
+        config('zeus-delia.models.Bookmark')::create([
+            'url' => $url,
+            'title' => $title,
+            'icon' => $icon,
+            'user_id' => auth()->user()->id,
+        ]);
+
+        Notification::make()
+            ->title(__('zeus-delia::bookmark.added'))
+            ->success()
+            ->send();
+    }
+
+    public static function remove(string $url): void
+    {
+        config('zeus-delia.models.Bookmark')::query()
+            ->where('url', $url)
+            ->where('user_id', auth()->user()->id)
+            ->delete();
+
+        Notification::make()
+            ->title(__('zeus-delia::bookmark.removed'))
+            ->info()
+            ->send();
+    }
 }
diff --git a/src/Filament/Actions/BookmarkAction.php b/src/Filament/Actions/BookmarkAction.php
diff --git a/src/Filament/Actions/BookmarkHeaderAction.php b/src/Filament/Actions/BookmarkHeaderAction.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace LaraZeus\Delia\Filament\Actions;
+
+use Filament\Actions\Action;
+
+class BookmarkHeaderAction extends Action
+{
+    use HasDefaultAttributes;
+}
diff --git a/src/Filament/Actions/HasDefaultAttributes.php b/src/Filament/Actions/HasDefaultAttributes.php
@@ -0,0 +1,45 @@
+<?php
+
+namespace LaraZeus\Delia\Filament\Actions;
+
+use LaraZeus\Delia\Delia;
+use Livewire\Component;
+
+trait HasDefaultAttributes
+{
+    public static function getDefaultName(): ?string
+    {
+        return 'bookmark';
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this
+            ->iconButton()
+            ->color('gray')
+            ->tooltip(
+                /** @phpstan-ignore-next-line */
+                fn (Component $livewire) => Delia::exist($livewire->url ?? $livewire->getUrl())
+                    ? __('zeus-delia::bookmark.remove')
+                    : __('zeus-delia::bookmark.add')
+            )
+            ->icon(
+                /** @phpstan-ignore-next-line */
+                fn (Component $livewire) => Delia::exist($livewire->url ?? $livewire->getUrl())
+                    ? 'heroicon-s-bookmark'
+                    : 'heroicon-o-bookmark'
+            )
+            ->action(
+                fn (Component $livewire) => Delia::toggle(
+                    /** @phpstan-ignore-next-line */
+                    $livewire->url ?? $livewire->getUrl(),
+                    /** @phpstan-ignore-next-line */
+                    $livewire->title ?? $livewire->getHeading(),
+                    /** @phpstan-ignore-next-line */
+                    $livewire->icon ?? $livewire->getNavigationIcon()
+                )
+            );
+    }
+}
diff --git a/src/Filament/Resources/BookmarkResource.php b/src/Filament/Resources/BookmarkResource.php
@@ -6,6 +6,7 @@
 use Filament\Tables\Actions\Action;
 use Filament\Tables\Columns\TextColumn;
 use Filament\Tables\Table;
+use Illuminate\Database\Eloquent\Builder;
 use LaraZeus\Delia\Delia;
 use LaraZeus\Delia\DeliaPlugin;
 use LaraZeus\Delia\Filament\Resources\BookmarkResource\Pages\ListBookmarks;
@@ -38,21 +39,33 @@ public static function getNavigationLabel(): string
     public static function table(Table $table): Table
     {
         return $table
+            ->modifyQueryUsing(function (Builder $query) {
+                /** @var Bookmark $query */
+                return $query->user();
+            })
             ->actions([
                 Action::make('bookmark')
                     ->iconButton()
                     ->tooltip(__('zeus-delia::bookmark.remove'))
                     ->color('gray')
                     ->icon('heroicon-s-bookmark')
-                    ->action(fn (Bookmark $record) => Delia::toggle($record->bookmarkable_resource)),
+                    ->action(fn (Bookmark $record) => Delia::remove($record->url)),
             ])
             ->columns([
-                TextColumn::make('bookmarkable_resource')
+                TextColumn::make('title')
                     ->searchable()
                     ->toggleable()
                     ->sortable()
-                    ->formatStateUsing(fn (Bookmark $record) => app($record->bookmarkable_resource)->getNavigationLabel())
-                    ->label(__('zeus-delia::bookmark.bookmarkable_type')),
+                    ->icon(fn (Bookmark $record) => $record->icon)
+                    ->url(fn (Bookmark $record) => $record->url)
+                    ->label(__('zeus-delia::bookmark.title')),
+
+                TextColumn::make('created_at')
+                    ->searchable()
+                    ->toggleable()
+                    ->sortable()
+                    ->dateTime()
+                    ->label(__('zeus-delia::bookmark.created_at')),
             ]);
     }
 
diff --git a/src/Livewire/BookmarkComponent.php b/src/Livewire/BookmarkComponent.php
@@ -2,6 +2,7 @@
 
 namespace LaraZeus\Delia\Livewire;
 
+use Filament\Actions\Action;
 use Filament\Actions\Concerns\InteractsWithActions;
 use Filament\Actions\Contracts\HasActions;
 use Filament\Forms\Concerns\InteractsWithForms;
@@ -10,20 +11,28 @@
 use Illuminate\Contracts\View\Factory;
 use Illuminate\Contracts\View\View;
 use Illuminate\Foundation\Application;
-use LaraZeus\Delia\Filament\Actions\BookmarkAction;
+use LaraZeus\Delia\Filament\Actions\BookmarkHeaderAction;
 use Livewire\Component;
 
 /**
  * @property mixed $form
  */
 class BookmarkComponent extends Component implements HasActions, HasForms
 {
-    use BookmarkAction;
     use InteractsWithActions;
     use InteractsWithForms;
     use InteractsWithForms;
 
-    public string $resource;
+    public string $url;
+
+    public string $title;
+
+    public string $icon;
+
+    public function bookmarkAction(): Action
+    {
+        return BookmarkHeaderAction::make('bookmark');
+    }
 
     public function render(): View | Application | Factory | ApplicationAlias
     {
diff --git a/src/Models/Bookmark.php b/src/Models/Bookmark.php
diff --git a/tests/TestCase.php b/tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -12,3 +12,5 @@ parameters:`
`12`	`12`	`ignoreErrors:`
`13`	`13`	`-`
`14`	`14`	`identifier: missingType.iterableValue`
	`15`	`+ -`
	`16`	`+ identifier: missingType.generics`