Pretty UI

.github/workflows/laravel.yml → .github/workflows/feature-tests.yml

@@ -47,7 +47,7 @@ jobs:
       - name: Set up PHP & Composer
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.3
+          php-version: 8.4
           extensions: mbstring, pdo, mysql, bcmath, tokenizer
           tools: composer
 

.github/workflows/review-dog.yml

@@ -0,0 +1,39 @@
+name: Laravel Pint Code Review
+
+on:
+  pull_request:
+    paths:
+      - '**.php'
+
+jobs:
+  reviewdog:
+    name: Laravel Pint Review
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.4'
+          tools: composer
+          extensions: mbstring, dom, curl
+
+      - name: Install Dependencies
+        run: composer install --no-interaction --no-progress --prefer-dist
+
+      - name: Install Pint
+        run: composer global require laravel/pint
+
+      - name: Run Pint with ReviewDog
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          ~/.composer/vendor/bin/pint --test --format=checkstyle \
+            | npx reviewdog -f=checkstyle \
+                -name="Laravel Pint" \
+                -reporter=github-pr-review \
+                -fail-on-error=false \
+                -level=info

app/Actions/Fortify/UpdateUserProfileInformation.php

@@ -20,7 +20,7 @@ public function update(User $user, array $input): void
         Validator::make($input, [
             'name' => ['required', 'string', 'max:255'],
             'email' => ['required', 'email', 'max:255', Rule::unique('users')->ignore($user->id)],
-            'photo' => ['nullable', 'mimes:jpg,jpeg,png', 'max:1024'],
+            'photo' => ['nullable', 'image', 'max:400'],
         ])->validateWithBag('updateProfileInformation');
 
         if (isset($input['photo'])) {

app/Events/ResourceReviewProcessed.php

@@ -2,11 +2,8 @@
 
 namespace App\Events;
 
-use Illuminate\Broadcasting\Channel;
 use Illuminate\Broadcasting\InteractsWithSockets;
-use Illuminate\Broadcasting\PresenceChannel;
 use Illuminate\Broadcasting\PrivateChannel;
-use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
 use Illuminate\Contracts\Events\ShouldDispatchAfterCommit;
 use Illuminate\Foundation\Events\Dispatchable;
 use Illuminate\Queue\SerializesModels;
@@ -20,8 +17,8 @@ class ResourceReviewProcessed implements ShouldDispatchAfterCommit
      */
     public function __construct(
         public int $resource,
-        public array|null $oldReview,
-        public array|null $newReview,
+        public ?array $oldReview,
+        public ?array $newReview,
     ) {}
 
     /**

app/Events/TagFrequencyChanged.php

@@ -2,11 +2,8 @@
 
 namespace App\Events;
 
-use Illuminate\Broadcasting\Channel;
 use Illuminate\Broadcasting\InteractsWithSockets;
-use Illuminate\Broadcasting\PresenceChannel;
 use Illuminate\Broadcasting\PrivateChannel;
-use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
 use Illuminate\Foundation\Events\Dispatchable;
 use Illuminate\Queue\SerializesModels;
 
@@ -17,7 +14,7 @@ class TagFrequencyChanged
     /**
      * Create a new event instance.
      */
-    public function __construct(public array|null $oldTags, public array|null $newTags) { }
+    public function __construct(public ?array $oldTags, public ?array $newTags) {}
 
     /**
      * Get the channels the event should broadcast on.

app/Events/UpvoteProcessed.php

@@ -2,26 +2,20 @@
 
 namespace App\Events;
 
-use App\Models\Upvote;
-use Illuminate\Broadcasting\Channel;
 use Illuminate\Broadcasting\InteractsWithSockets;
-use Illuminate\Broadcasting\PresenceChannel;
-use Illuminate\Contracts\Events\ShouldDispatchAfterCommit;
 use Illuminate\Broadcasting\PrivateChannel;
-use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
+use Illuminate\Contracts\Events\ShouldDispatchAfterCommit;
 use Illuminate\Foundation\Events\Dispatchable;
 use Illuminate\Queue\SerializesModels;
 
-class UpvoteProcessed implements ShouldDispatchAfterCommit 
+class UpvoteProcessed implements ShouldDispatchAfterCommit
 {
     use Dispatchable, InteractsWithSockets, SerializesModels;
 
     /**
      * Create a new event instance.
      */
-    public function __construct(public string $type, public int $id, public int $previousValue, public int $newValue)
-    {
-    }
+    public function __construct(public string $type, public int $id, public int $previousValue, public int $newValue) {}
 
     /**
      * Get the channels the event should broadcast on.

app/Http/Controllers/CommentController.php

@@ -2,13 +2,12 @@
 
 namespace App\Http\Controllers;
 
-use App\Events\CommentCreated;
 use App\Http\Requests\Comment\StoreCommentRequest;
 use App\Http\Resources\CommentResource;
-use App\Models\Comment;
-use App\Services\ModelResolverService;
 use App\Http\Resources\UserResource;
+use App\Models\Comment;
 use App\Services\CommentService;
+use App\Services\ModelResolverService;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Validator;
@@ -18,6 +17,7 @@
 class CommentController extends Controller
 {
     protected $modelResolver;
+
     protected $commentService;
 
     public function __construct(ModelResolverService $modelResolver, CommentService $commentService)
@@ -31,10 +31,9 @@ public function __construct(ModelResolverService $modelResolver, CommentService
      */
     public function store(StoreCommentRequest $request)
     {
-        Log::debug("Called store on comment controller");
         $validatedData = $request->validated();
+        Log::debug('Comment Controller Store', ['validated data' => $validatedData]);
 
-        Log::debug("Data validated and is " . json_encode($validatedData));
         $comment = new Comment;
         $comment->content = $validatedData['content'];
         $comment->user_id = Auth::id();
@@ -44,18 +43,17 @@ public function store(StoreCommentRequest $request)
 
         // Ensure that the model exists
         $model = $this->modelResolver->resolve($validatedData['commentable_key'], $commentableId);
-        if (!$model) {
+        if (! $model) {
             return response()->json(['message' => 'Model not found'], 404);
         }
-        Log::debug("Resolved model class: " . $commentableType);
 
         // Set the commentable type
         $comment->commentable_type = $commentableType;
         $comment->commentable_id = $commentableId;
 
         // Top level comment
         $parentCommentId = $validatedData['parent_comment_id'];
-        if (!$parentCommentId) {
+        if (! $parentCommentId) {
             $comment->parent_comment_id = null;
             $comment->depth = 1;
             $comment->children_count = 0;
@@ -84,7 +82,7 @@ public function store(StoreCommentRequest $request)
                     'commentable_id' => $commentableId,
                     'commentable_type' => $commentableType,
                     'depth' => $new_comment_depth,
-                    'replies_count' => $replies_count
+                    'replies_count' => $replies_count,
                 ],
                 [
                     'commentable_id' => [
@@ -99,14 +97,14 @@ public function store(StoreCommentRequest $request)
                     'depth' => [
                         'required',
                         'integer',
-                        'lte:' . (config('comment.max_depth'))
+                        'lte:'.(config('comment.max_depth')),
                     ],
                     // Cannot exceed max replies
                     'replies_count' => [
                         'required',
                         'integer',
-                        'lt:' . (config('comment.max_replies'))
-                    ]
+                        'lt:'.(config('comment.max_replies')),
+                    ],
                 ]
             );
 
@@ -125,31 +123,39 @@ public function store(StoreCommentRequest $request)
         }
 
         $comment->save();
-        CommentCreated::dispatch(
-            $commentableId,
-            $commentableType
-        );
 
-        Log::debug("New saved comment is " . json_encode($comment));
+        Log::debug('New comment saved', [
+            'comment_id' => $comment->id,
+            'user_id' => $comment->user_id,
+            'commentable_type' => $comment->commentable_type,
+            'commentable_id' => $comment->commentable_id,
+            'depth' => $comment->depth,
+        ]);
+
         return response()->json([
             'new_comment' => new CommentResource($comment),
             'user' => new UserResource(Auth::user()),
-        ]);;
+        ]);
     }
 
     /**
      * Display the specified comment, with pagination.
      */
     public function show(Request $request, string $commentableKey, int $commentableId, int $index, int $paginationLimit = -1)
     {
-        if ($paginationLimit == -1)
-        {
+        if ($paginationLimit == -1) {
             $paginationLimit = config('comment.default_pagination_limit');
         }
 
         $sortBy = $request->query('sort_by', 'top');
 
-        Log::debug("Request is, commentable_type: " .  $commentableKey . ". id: " . $commentableId . ". index: " . $index . ". Sorting: " . $sortBy);
+        Log::debug('Processing comment show request', [
+            'commentable_key' => $commentableKey,
+            'commentable_id' => $commentableId,
+            'index' => $index,
+            'sort_by' => $sortBy,
+            'pagination_limit' => $paginationLimit,
+        ]);
         $paginatedResults = $this->commentService->getPaginatedComments($commentableKey, $commentableId, $index, $paginationLimit, $sortBy);
 
         return $paginatedResults;