[PoC] Update PHP to 8.1 and use new enum types

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.0
+          php-version: 8.1
           extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite
           coverage: none
 

.styleci.yml

@@ -1,6 +1,6 @@
 php:
   preset: laravel
-  version: 8
+  version: 8.1
   enabled:
     - heredoc_indentation
     - trailing_comma_in_multiline_call

app/Enums/ArticlePolicyAction.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Enums;
+
+enum ArticlePolicyAction: string
+{
+    case UPDATE = 'update';
+    case DELETE = 'delete';
+    case APPROVE = 'approve';
+    case DISAPPROVE = 'disapprove';
+    case DECLINE = 'decline';
+    case PINNED = 'togglePinnedStatus';
+}

app/Enums/NotificationPolicyAction.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace App\Enums;
+
+enum NotificationPolicyAction: string
+{
+    case MARK_AS_READ = 'markAsRead';
+}

app/Enums/ReplyPolicyAction.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Enums;
+
+enum ReplyPolicyAction: string
+{
+    case CREATE = 'create';
+    case UPDATE = 'update';
+    case DELETE = 'delete';
+}

app/Enums/ThreadPolicyAction.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Enums;
+
+enum ThreadPolicyAction: string
+{
+    case UPDATE = 'update';
+    case DELETE = 'delete';
+    case SUBSCRIBE = 'subscribe';
+    case UNSUBSCRIBE = 'unsubscribe';
+}

app/Enums/UserPolicyAction.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Enums;
+
+enum UserPolicyAction: string
+{
+    case ADMIN = 'admin';
+    case BAN = 'ban';
+    case DELETE = 'delete';
+}

app/Http/Controllers/Admin/ArticlesController.php

@@ -34,7 +34,7 @@ public function index()
 
     public function approve(Article $article)
     {
-        $this->authorize(ArticlePolicy::APPROVE, $article);
+        $this->authorize(ArticlePolicy::APPROVE->value, $article);
 
         $this->dispatchNow(new ApproveArticle($article));
 
@@ -45,7 +45,7 @@ public function approve(Article $article)
 
     public function disapprove(Article $article)
     {
-        $this->authorize(ArticlePolicy::DISAPPROVE, $article);
+        $this->authorize(ArticlePolicy::DISAPPROVE->value, $article);
 
         $this->dispatchNow(new DisapproveArticle($article));
 
@@ -56,7 +56,7 @@ public function disapprove(Article $article)
 
     public function decline(Article $article)
     {
-        $this->authorize(ArticlePolicy::DECLINE, $article);
+        $this->authorize(ArticlePolicy::DECLINE->value, $article);
 
         $this->dispatchNow(new DeclineArticle($article));
 
@@ -67,7 +67,7 @@ public function decline(Article $article)
 
     public function togglePinnedStatus(Article $article)
     {
-        $this->authorize(ArticlePolicy::PINNED, $article);
+        $this->authorize(ArticlePolicy::PINNED->value, $article);
 
         $article->is_pinned = ! $article->isPinned();
         $article->save();

app/Http/Controllers/Admin/UsersController.php

@@ -32,7 +32,7 @@ public function index()
 
     public function ban(User $user)
     {
-        $this->authorize(UserPolicy::BAN, $user);
+        $this->authorize(UserPolicy::BAN->value, $user);
 
         $this->dispatchNow(new BanUser($user));
 
@@ -43,7 +43,7 @@ public function ban(User $user)
 
     public function unban(User $user)
     {
-        $this->authorize(UserPolicy::BAN, $user);
+        $this->authorize(UserPolicy::BAN->value, $user);
 
         $this->dispatchNow(new UnbanUser($user));
 
@@ -54,7 +54,7 @@ public function unban(User $user)
 
     public function delete(User $user)
     {
-        $this->authorize(UserPolicy::DELETE, $user);
+        $this->authorize(UserPolicy::DELETE->value, $user);
 
         $this->dispatchNow(new DeleteUser($user));
 

app/Http/Controllers/Articles/ArticlesController.php

@@ -110,7 +110,7 @@ public function store(ArticleRequest $request)
 
     public function edit(Article $article)
     {
-        $this->authorize(ArticlePolicy::UPDATE, $article);
+        $this->authorize(ArticlePolicy::UPDATE->value, $article);
 
         return view('articles.edit', [
             'article' => $article,
@@ -121,7 +121,7 @@ public function edit(Article $article)
 
     public function update(ArticleRequest $request, Article $article)
     {
-        $this->authorize(ArticlePolicy::UPDATE, $article);
+        $this->authorize(ArticlePolicy::UPDATE->value, $article);
 
         $wasNotPreviouslySubmitted = $article->isNotSubmitted();
 
@@ -138,7 +138,7 @@ public function update(ArticleRequest $request, Article $article)
 
     public function delete(Article $article)
     {
-        $this->authorize(ArticlePolicy::DELETE, $article);
+        $this->authorize(ArticlePolicy::DELETE->value, $article);
 
         $this->dispatchNow(new DeleteArticle($article));
 

app/Http/Controllers/Forum/ThreadsController.php

@@ -93,15 +93,15 @@ public function store(ThreadRequest $request)
 
     public function edit(Thread $thread)
     {
-        $this->authorize(ThreadPolicy::UPDATE, $thread);
+        $this->authorize(ThreadPolicy::UPDATE->value, $thread);
         $selectedTags = $thread->tags()->pluck('id')->toArray();
 
         return view('forum.threads.edit', ['thread' => $thread, 'tags' => Tag::all(), 'selectedTags' => $selectedTags]);
     }
 
     public function update(ThreadRequest $request, Thread $thread)
     {
-        $this->authorize(ThreadPolicy::UPDATE, $thread);
+        $this->authorize(ThreadPolicy::UPDATE->value, $thread);
 
         $thread = $this->dispatchNow(UpdateThread::fromRequest($thread, $request));
 
@@ -112,7 +112,7 @@ public function update(ThreadRequest $request, Thread $thread)
 
     public function delete(Thread $thread)
     {
-        $this->authorize(ThreadPolicy::DELETE, $thread);
+        $this->authorize(ThreadPolicy::DELETE->value, $thread);
 
         $this->dispatchNow(new DeleteThread($thread));
 
@@ -123,7 +123,7 @@ public function delete(Thread $thread)
 
     public function markSolution(Thread $thread, Reply $reply)
     {
-        $this->authorize(ThreadPolicy::UPDATE, $thread);
+        $this->authorize(ThreadPolicy::UPDATE->value, $thread);
 
         $this->dispatchNow(new MarkThreadSolution($thread, $reply, Auth::user()));
 
@@ -132,7 +132,7 @@ public function markSolution(Thread $thread, Reply $reply)
 
     public function unmarkSolution(Thread $thread)
     {
-        $this->authorize(ThreadPolicy::UPDATE, $thread);
+        $this->authorize(ThreadPolicy::UPDATE->value, $thread);
 
         $this->dispatchNow(new UnmarkThreadSolution($thread));
 
@@ -141,7 +141,7 @@ public function unmarkSolution(Thread $thread)
 
     public function subscribe(Request $request, Thread $thread)
     {
-        $this->authorize(ThreadPolicy::SUBSCRIBE, $thread);
+        $this->authorize(ThreadPolicy::SUBSCRIBE->value, $thread);
 
         $this->dispatchNow(new SubscribeToSubscriptionAble($request->user(), $thread));
 
@@ -152,7 +152,7 @@ public function subscribe(Request $request, Thread $thread)
 
     public function unsubscribe(Request $request, Thread $thread)
     {
-        $this->authorize(ThreadPolicy::UNSUBSCRIBE, $thread);
+        $this->authorize(ThreadPolicy::UNSUBSCRIBE->value, $thread);
 
         $this->dispatchNow(new UnsubscribeFromSubscriptionAble($request->user(), $thread));
 

app/Http/Controllers/ReplyController.php

@@ -24,7 +24,7 @@ public function __construct()
 
     public function store(CreateReplyRequest $request)
     {
-        $this->authorize(ReplyPolicy::CREATE, Reply::class);
+        $this->authorize(ReplyPolicy::CREATE->value, Reply::class);
 
         $reply = $this->dispatchNow(CreateReply::fromRequest($request));
 
@@ -35,14 +35,14 @@ public function store(CreateReplyRequest $request)
 
     public function edit(Reply $reply)
     {
-        $this->authorize(ReplyPolicy::UPDATE, $reply);
+        $this->authorize(ReplyPolicy::UPDATE->value, $reply);
 
         return view('replies.edit', compact('reply'));
     }
 
     public function update(UpdateReplyRequest $request, Reply $reply)
     {
-        $this->authorize(ReplyPolicy::UPDATE, $reply);
+        $this->authorize(ReplyPolicy::UPDATE->value, $reply);
 
         $this->dispatchNow(new UpdateReply($reply, $request->user(), $request->body()));
 
@@ -53,7 +53,7 @@ public function update(UpdateReplyRequest $request, Reply $reply)
 
     public function delete(Reply $reply)
     {
-        $this->authorize(ReplyPolicy::DELETE, $reply);
+        $this->authorize(ReplyPolicy::DELETE->value, $reply);
 
         $this->dispatchNow(new DeleteReply($reply));
 

app/Http/Controllers/Settings/ProfileController.php

@@ -34,7 +34,7 @@ public function update(UpdateProfileRequest $request)
 
     public function destroy(Request $request)
     {
-        $this->authorize(UserPolicy::DELETE, $user = $request->user());
+        $this->authorize(UserPolicy::DELETE->value, $user = $request->user());
 
         $this->dispatchNow(new DeleteUser($user));
 

app/Http/Livewire/Notifications.php

@@ -38,7 +38,7 @@ public function markAsRead(string $notificationId): void
     {
         $this->notificationId = $notificationId;
 
-        $this->authorize(NotificationPolicy::MARK_AS_READ, $this->notification);
+        $this->authorize(NotificationPolicy::MARK_AS_READ->value, $this->notification);
 
         $this->notification->markAsRead();
 

app/Http/Middleware/VerifyAdmins.php

@@ -13,7 +13,7 @@ class VerifyAdmins
 {
     public function handle(Request $request, Closure $next, $guard = null)
     {
-        if (Auth::guard($guard)->user()->can(UserPolicy::ADMIN, User::class)) {
+        if (Auth::guard($guard)->user()->can(UserPolicy::ADMIN->value, User::class)) {
             return $next($request);
         }
 

app/Policies/ArticlePolicy.php

@@ -2,17 +2,18 @@
 
 namespace App\Policies;
 
+use App\Enums\ArticlePolicyAction;
 use App\Models\Article;
 use App\Models\User;
 
 final class ArticlePolicy
 {
-    const UPDATE = 'update';
-    const DELETE = 'delete';
-    const APPROVE = 'approve';
-    const DISAPPROVE = 'disapprove';
-    const DECLINE = 'decline';
-    const PINNED = 'togglePinnedStatus';
+    const UPDATE = ArticlePolicyAction::UPDATE;
+    const DELETE = ArticlePolicyAction::DELETE;
+    const APPROVE = ArticlePolicyAction::APPROVE;
+    const DISAPPROVE = ArticlePolicyAction::DISAPPROVE;
+    const DECLINE = ArticlePolicyAction::DECLINE;
+    const PINNED = ArticlePolicyAction::PINNED;
 
     public function update(User $user, Article $article): bool
     {

app/Policies/NotificationPolicy.php

@@ -2,12 +2,13 @@
 
 namespace App\Policies;
 
+use App\Enums\NotificationPolicyAction;
 use App\Models\User;
 use Illuminate\Notifications\DatabaseNotification;
 
 final class NotificationPolicy
 {
-    const MARK_AS_READ = 'markAsRead';
+    const MARK_AS_READ = NotificationPolicyAction::MARK_AS_READ;
 
     /**
      * Determine if the given notification can be marked as read by the user.

app/Policies/ReplyPolicy.php

@@ -2,14 +2,15 @@
 
 namespace App\Policies;
 
+use App\Enums\ReplyPolicyAction;
 use App\Models\Reply;
 use App\Models\User;
 
 final class ReplyPolicy
 {
-    const CREATE = 'create';
-    const UPDATE = 'update';
-    const DELETE = 'delete';
+    const CREATE = ReplyPolicyAction::CREATE;
+    const UPDATE = ReplyPolicyAction::UPDATE;
+    const DELETE = ReplyPolicyAction::DELETE;
 
     /**
      * Determine if replies can be created by the user.

app/Policies/ThreadPolicy.php

@@ -2,15 +2,16 @@
 
 namespace App\Policies;
 
+use App\Enums\ThreadPolicyAction;
 use App\Models\Thread;
 use App\Models\User;
 
 final class ThreadPolicy
 {
-    const UPDATE = 'update';
-    const DELETE = 'delete';
-    const SUBSCRIBE = 'subscribe';
-    const UNSUBSCRIBE = 'unsubscribe';
+    const UPDATE = ThreadPolicyAction::UPDATE;
+    const DELETE = ThreadPolicyAction::DELETE;
+    const SUBSCRIBE = ThreadPolicyAction::SUBSCRIBE;
+    const UNSUBSCRIBE = ThreadPolicyAction::UNSUBSCRIBE;
 
     public function update(User $user, Thread $thread): bool
     {

app/Policies/UserPolicy.php

@@ -2,13 +2,14 @@
 
 namespace App\Policies;
 
+use App\Enums\UserPolicyAction;
 use App\Models\User;
 
 final class UserPolicy
 {
-    const ADMIN = 'admin';
-    const BAN = 'ban';
-    const DELETE = 'delete';
+    const ADMIN = UserPolicyAction::ADMIN;
+    const BAN = UserPolicyAction::BAN;
+    const DELETE = UserPolicyAction::DELETE;
 
     public function admin(User $user): bool
     {

composer.json

@@ -4,7 +4,7 @@
     "license": "MIT",
     "type": "project",
     "require": {
-        "php": "^8.0",
+        "php": "^8.1",
         "algolia/scout-extended": "^1.10",
         "blade-ui-kit/blade-heroicons": "^1.0",
         "blade-ui-kit/blade-icons": "^1.0",