Merge pull request #120 from lara-zeus/deletes

allow to force delete and restore posts, and finally green phpstan
lara-zeus · Jul 2, 2023 · 850c691 · 850c691
2 parents 6a380c1 + 38981eb
commit 850c691
Show file tree

Hide file tree

Showing 9 changed files with 121 additions and 26 deletions.
diff --git a/src/Classes/TipTapEditor.php b/src/Classes/TipTapEditor.php
@@ -10,6 +10,8 @@
 class TipTapEditor implements ContentEditor
 {
     /**
+     * @phpstan-ignore-next-line
+     *
      * @throws InvalidOutputFormatException
      */
     public static function component(): Component
@@ -27,6 +29,7 @@ public static function component(): Component
     public static function render(string $content): string
     {
         if (class_exists(TipTapEditorAlias::class)) {
+            // @phpstan-ignore-next-line
             return tiptap_converter()->asHTML($content);
             // return tiptap_converter()->asJSON($content);
             // return tiptap_converter()->asText($content);

diff --git a/src/Filament/Resources/LibraryResource.php b/src/Filament/Resources/LibraryResource.php
@@ -19,7 +19,6 @@
 use Filament\Tables\Columns\SpatieTagsColumn;
 use Filament\Tables\Columns\TextColumn;
 use Filament\Tables\Filters\SelectFilter;
-use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Str;
 use LaraZeus\Sky\Filament\Resources\LibraryResource\Pages;
 use LaraZeus\Sky\Models\Library;
@@ -58,7 +57,7 @@ public static function form(Form $form): Form
                     }),
 
                 TextInput::make('slug')
-                    ->unique(ignorable: fn (?Model $record): ?Model => $record)
+                    ->unique(ignorable: fn (?Library $record): ?Library => $record)
                     ->required()
                     ->maxLength(255)
                     ->label(__('Library Slug')),
@@ -75,7 +74,7 @@ public static function form(Form $form): Form
                 Select::make('type')
                     ->label(__('Library Type'))
                     ->visible(config('zeus-sky.library_types') !== null)
-                    ->options(config('zeus-sky.library_types', null)),
+                    ->options(config('zeus-sky.library_types', [])),
 
                 Section::make(__('Library File'))
                     ->schema([
@@ -128,7 +127,7 @@ public static function table(Table $table): Table
                         ->color('warning')
                         ->icon('heroicon-o-external-link')
                         ->label(__('Open'))
-                        ->url(fn (Model $record): string => route('library.item', ['slug' => $record->slug]))
+                        ->url(fn (Library $record): string => route('library.item', ['slug' => $record->slug]))
                         ->openUrlInNewTab(),
                     DeleteAction::make('delete')
                         ->label(__('Delete')),

diff --git a/src/Filament/Resources/PageResource.php b/src/Filament/Resources/PageResource.php
@@ -17,11 +17,18 @@
 use Filament\Tables\Actions\Action;
 use Filament\Tables\Actions\ActionGroup;
 use Filament\Tables\Actions\DeleteAction;
+use Filament\Tables\Actions\DeleteBulkAction;
 use Filament\Tables\Actions\EditAction;
+use Filament\Tables\Actions\ForceDeleteAction;
+use Filament\Tables\Actions\ForceDeleteBulkAction;
+use Filament\Tables\Actions\RestoreAction;
+use Filament\Tables\Actions\RestoreBulkAction;
 use Filament\Tables\Columns\ViewColumn;
 use Filament\Tables\Filters\Filter;
 use Filament\Tables\Filters\SelectFilter;
+use Filament\Tables\Filters\TrashedFilter;
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\SoftDeletingScope;
 use Illuminate\Support\Str;
 use LaraZeus\Sky\Filament\Resources\PageResource\Pages;
 use LaraZeus\Sky\Models\Post;
@@ -42,6 +49,17 @@ protected static function getNavigationBadge(): ?string
         return (string) config('zeus-sky.models.post')::query()->page()->count();
     }
 
+    /**
+     * @return Builder<Post>
+     */
+    public static function getEloquentQuery(): Builder
+    {
+        return parent::getEloquentQuery()
+            ->withoutGlobalScopes([
+                SoftDeletingScope::class,
+            ]);
+    }
+
     public static function form(Form $form): Form
     {
         return $form
@@ -156,11 +174,18 @@ public static function table(Table $table): Table
                         ->label(__('Open'))
                         ->url(fn (Post $record): string => route('page', ['slug' => $record]))
                         ->openUrlInNewTab(),
-                    DeleteAction::make('delete')
-                        ->label(__('Delete')),
+                    DeleteAction::make('delete'),
+                    ForceDeleteAction::make(),
+                    RestoreAction::make(),
                 ]),
             ])
+            ->bulkActions([
+                DeleteBulkAction::make(),
+                ForceDeleteBulkAction::make(),
+                RestoreBulkAction::make(),
+            ])
             ->filters([
+                TrashedFilter::make(),
                 SelectFilter::make('status')
                     ->multiple()
                     ->label(__('Status'))

diff --git a/src/Filament/Resources/PageResource/Pages/ListPosts.php b/src/Filament/Resources/PageResource/Pages/ListPosts.php
@@ -4,6 +4,7 @@
 
 use Filament\Resources\Pages\ListRecords;
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\SoftDeletingScope;
 use LaraZeus\Sky\Filament\Resources\PageResource;
 
 class ListPosts extends ListRecords
@@ -14,6 +15,10 @@ class ListPosts extends ListRecords
 
     protected function getTableQuery(): Builder
     {
-        return config('zeus-sky.models.post')::where('post_type', 'page');
+        return config('zeus-sky.models.post')::query()
+            ->where('post_type', 'page')
+            ->withoutGlobalScopes([
+                SoftDeletingScope::class,
+            ]);
     }
 }
diff --git a/src/Filament/Resources/PostResource.php b/src/Filament/Resources/PostResource.php
@@ -19,16 +19,24 @@
 use Filament\Tables\Actions\Action;
 use Filament\Tables\Actions\ActionGroup;
 use Filament\Tables\Actions\DeleteAction;
+use Filament\Tables\Actions\DeleteBulkAction;
 use Filament\Tables\Actions\EditAction;
+use Filament\Tables\Actions\ForceDeleteAction;
+use Filament\Tables\Actions\ForceDeleteBulkAction;
+use Filament\Tables\Actions\RestoreAction;
+use Filament\Tables\Actions\RestoreBulkAction;
 use Filament\Tables\Columns\SpatieTagsColumn;
 use Filament\Tables\Columns\ViewColumn;
 use Filament\Tables\Filters\Filter;
 use Filament\Tables\Filters\SelectFilter;
+use Filament\Tables\Filters\TrashedFilter;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Support\Str;
 use LaraZeus\Sky\Filament\Resources\PostResource\Pages;
 use LaraZeus\Sky\Models\Post;
+use LaraZeus\Sky\Models\PostScope;
 
+// @mixin Builder<PostScope>
 class PostResource extends SkyResource
 {
     public static function getModel(): string
@@ -199,11 +207,18 @@ public static function table(Table $table): Table
                         ->label(__('Open'))
                         ->url(fn (Post $record): string => route('post', ['slug' => $record]))
                         ->openUrlInNewTab(),
-                    DeleteAction::make('delete')
-                        ->label(__('Delete')),
+                    DeleteAction::make('delete'),
+                    ForceDeleteAction::make(),
+                    RestoreAction::make(),
                 ]),
             ])
+            ->bulkActions([
+                DeleteBulkAction::make(),
+                ForceDeleteBulkAction::make(),
+                RestoreBulkAction::make(),
+            ])
             ->filters([
+                TrashedFilter::make(),
                 SelectFilter::make('status')
                     ->multiple()
                     ->label(__('Status'))
@@ -215,6 +230,7 @@ public static function table(Table $table): Table
 
                 Filter::make('sticky')
                     ->label(__('Still Sticky'))
+                    // @phpstan-ignore-next-line
                     ->query(fn (Builder $query): Builder => $query->sticky()),
 
                 Filter::make('not_sticky')

diff --git a/src/Filament/Resources/PostResource/Pages/ListPosts.php b/src/Filament/Resources/PostResource/Pages/ListPosts.php
@@ -4,6 +4,7 @@
 
 use Filament\Resources\Pages\ListRecords;
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\SoftDeletingScope;
 use LaraZeus\Sky\Filament\Resources\PostResource;
 
 class ListPosts extends ListRecords
@@ -14,6 +15,10 @@ class ListPosts extends ListRecords
 
     protected function getTableQuery(): Builder
     {
-        return config('zeus-sky.models.post')::where('post_type', 'post');
+        return config('zeus-sky.models.post')::query()
+            ->where('post_type', 'post')
+            ->withoutGlobalScopes([
+                SoftDeletingScope::class,
+            ]);
     }
 }
diff --git a/src/Models/Post.php b/src/Models/Post.php
@@ -3,9 +3,11 @@
 namespace LaraZeus\Sky\Models;
 
 use Database\Factories\PostFactory;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\Blade;
 use Spatie\MediaLibrary\HasMedia;
@@ -24,9 +26,15 @@
  * @property int $user_id
  * @property bool $require_password
  * @property string $password
+ *
+ * @method Builder|static sticky()
+ * @method Builder|static published()
+ * @method Builder|static query()
+ * @method Builder|static withAnyTags()
  */
 class Post extends Model implements HasMedia
 {
+    use SoftDeletes;
     use HasFactory;
     use HasTags;
     use InteractsWithMedia;

diff --git a/src/Models/PostScope.php b/src/Models/PostScope.php
@@ -7,64 +7,91 @@
 
 trait PostScope
 {
-    public function scopeSticky(Builder $query): void
+    /**
+     * @param  Builder<Post>  $query
+     */
+    public function scopeSticky(Builder $query): Builder
     {
-        $query->where('post_type', 'post')
+        return $query->where('post_type', 'post')
             ->whereNotNull('sticky_until')
             ->whereDate('sticky_until', '>=', now())
             ->whereDate('published_at', '<=', now());
     }
 
-    public function scopeNotSticky(Builder $query): void
+    /**
+     * @param  Builder<Post>  $query
+     */
+    public function scopeNotSticky(Builder $query): Builder
     {
-        $query->where('post_type', 'post')->where(function ($q) {
+        return $query->where('post_type', 'post')->where(function ($q) {
             return $q->whereDate('sticky_until', '<=', now())->orWhereNull('sticky_until');
         })
             ->whereDate('published_at', '<=', now());
     }
 
-    public function scopePublished(Builder $query): void
+    /**
+     * @param  Builder<Post>  $query
+     */
+    public function scopePublished(Builder $query): Builder
     {
-        $query->where('post_type', 'post')
+        return $query->where('post_type', 'post')
             ->where('status', 'publish')
             ->whereDate('published_at', '<=', now());
     }
 
-    public function scopeRelated(Builder $query, Post $post): void
+    /**
+     * @param  Builder<Post>  $query
+     */
+    public function scopeRelated(Builder $query, Post $post): Builder
     {
-        $query->where('post_type', 'post')
+        return $query->where('post_type', 'post')
             ->withAnyTags($post->tags->pluck('name')->toArray(), 'category');
     }
 
-    public function scopePage(Builder $query): void
+    /**
+     * @param  Builder<Post>  $query
+     */
+    public function scopePage(Builder $query): Builder
     {
-        $query->where('post_type', 'page')
+        return $query->where('post_type', 'page')
             ->whereDate('published_at', '<=', now());
     }
 
-    public function scopePosts(Builder $query): void
+    /**
+     * @param  Builder<Post>  $query
+     */
+    public function scopePosts(Builder $query): Builder
     {
-        $query->where('post_type', 'post')
+        return $query->where('post_type', 'post')
             ->whereDate('published_at', '<=', now());
     }
 
-    public function scopeForCategory(Builder $query, $category = null): void
+    /**
+     * @param  Builder<Post>  $query
+     * @param  ?string  $category
+     */
+    public function scopeForCategory(Builder $query, string $category = null): Builder
     {
         if ($category !== null) {
-            $query->where(
+            return $query->where(
                 function ($query) use ($category) {
                     $query->withAnyTags([$category], 'category');
 
                     return $query;
                 }
             );
         }
+
+        return $query;
     }
 
-    public function scopeSearch(Builder $query, $term): void
+    /**
+     * @param  Builder<Post>  $query
+     */
+    public function scopeSearch(Builder $query, $term): Builder
     {
         if ($term !== null) {
-            $query->where(
+            return $query->where(
                 function ($query) use ($term) {
                     foreach (['title', 'slug', 'content', 'description'] as $attribute) {
                         $query->orWhere(DB::raw("lower({$attribute})"), 'like', "%{$term}%");
@@ -74,5 +101,7 @@ function ($query) use ($term) {
                 }
             );
         }
+
+        return $query;
     }
 }
diff --git a/src/Models/Tag.php b/src/Models/Tag.php
@@ -2,13 +2,16 @@
 
 namespace LaraZeus\Sky\Models;
 
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphToMany;
 
 /**
  * @property string $slug
  * @property string $type
  * @property string $name
+ *
+ * @method Builder|static published()
  */
 class Tag extends \Spatie\Tags\Tag
 {
@@ -32,8 +35,10 @@ public function tag(): MorphToMany
         return $this->morphedByMany(config('zeus-sky.models.post'), 'taggable');
     }
 
+    /** @return MorphToMany<Post> */
     public function postsPublished(): MorphToMany
     {
+        // @phpstan-ignore-next-line
         return $this->morphedByMany(config('zeus-sky.models.post'), 'taggable')->published();
     }