#137 - Ranking Disqualification

app/Actions/DisqualifyUserAction.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions;
+
+use App\Models\Disqualification;
+use App\Models\UserQuiz;
+use App\Notifications\DisqualificationNotification;
+
+class DisqualifyUserAction
+{
+    public function __construct() {}
+
+    public function execute(UserQuiz $userQuiz, String $reason, bool $sendEmail = false): Disqualification
+    {
+        $disqualification = new Disqualification();
+        $disqualification->reason = $reason;
+        $disqualification->userQuiz()->associate($userQuiz);
+        $disqualification->save();
+
+        if ($sendEmail) {
+            $userQuiz->user->notify(new DisqualificationNotification($userQuiz, $reason));
+        }
+
+        return $disqualification;
+    }
+}

app/Actions/UndisqualifyUserAction.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions;
+
+use App\Models\UserQuiz;
+
+class UndisqualifyUserAction
+{
+    public function __construct() {}
+
+    public function execute(UserQuiz $userQuiz): void
+    {
+        $userQuiz->disqualification()->delete();
+    }
+}

app/Http/Controllers/RankingController.php

@@ -4,8 +4,11 @@
 
 namespace App\Http\Controllers;
 
+use App\Actions\DisqualifyUserAction;
 use App\Actions\PublishQuizRankingAction;
+use App\Actions\UndisqualifyUserAction;
 use App\Actions\UnpublishQuizRankingAction;
+use App\Http\Requests\DisqualifyUserRequest;
 use App\Http\Resources\QuizResource;
 use App\Http\Resources\RankingResource;
 use App\Models\Quiz;
@@ -69,4 +72,26 @@ public function unpublish(Quiz $quiz, UnpublishQuizRankingAction $unpublishQuizR
             ->back()
             ->with("status", "Ranking został wycofany.");
     }
+
+    public function disqualify(DisqualifyUserAction $action, UserQuiz $userQuiz, DisqualifyUserRequest $request): RedirectResponse
+    {
+        $this->authorize("disqualify", $userQuiz);
+
+        $action->execute($userQuiz, $request->validated()["reason"], $request->validated()["sendEmail"]);
+
+        return redirect()
+            ->back()
+            ->with("status", "Użytkownik został zdyskwalifikowany.");
+    }
+
+    public function undisqualify(UndisqualifyUserAction $action, UserQuiz $userQuiz): RedirectResponse
+    {
+        $this->authorize("undisqualify", $userQuiz);
+
+        $action->execute($userQuiz);
+
+        return redirect()
+            ->back()
+            ->with("status", "Dyskwalifikacją użytkownika została cofnięta.");
+    }
 }

app/Http/Requests/DisqualifyUserRequest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Requests;
+
+use Illuminate\Contracts\Validation\ValidationRule;
+use Illuminate\Foundation\Http\FormRequest;
+
+class DisqualifyUserRequest extends FormRequest
+{
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    /**
+     * @return array<string, ValidationRule|array|string>
+     */
+    public function rules(): array
+    {
+        return [
+            "reason" => ["required", "string"],
+            "sendEmail" => ["required", "boolean"],
+        ];
+    }
+}

app/Models/Disqualification.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Models;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+
+/**
+ * @property int $id
+ * @property Carbon $created_at
+ * @property Carbon $updated_at
+ * @property string $reason
+ * @property int $user_quiz_id
+ * @property UserQuiz $userQuiz
+ */
+class Disqualification extends Model
+{
+    use HasFactory;
+
+    public function userQuiz(): BelongsTo
+    {
+        return $this->belongsTo(UserQuiz::class);
+    }
+}

app/Models/User.php

@@ -14,6 +14,7 @@
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasManyThrough;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;
 use Spatie\Permission\Traits\HasRoles;
@@ -33,6 +34,7 @@
  * @property boolean $is_anonymized
  * @property boolean $force_password_change
  * @property Collection<UserQuiz> $userQuizzes
+ * @property Collection<Disqualification> $disqualifications
  * @property Collection<Quiz> $assignedQuizzes
  */
 class User extends Authenticatable implements MustVerifyEmail, CanResetPassword
@@ -73,6 +75,11 @@ public function userQuizzes(): HasMany
         return $this->hasMany(UserQuiz::class);
     }
 
+    public function disqualifications(): HasManyThrough
+    {
+        return $this->hasManyThrough(Disqualification::class, UserQuiz::class);
+    }
+
     public function assignedQuizzes(): BelongsToMany
     {
         return $this->belongsToMany(Quiz::class, "quiz_assignments");

app/Models/UserQuestion.php

@@ -9,6 +9,7 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasOne;
 
 /**
  * @property int $id
@@ -21,6 +22,7 @@
  * @property bool $isCorrect
  * @property UserQuiz $userQuiz
  * @property Question $question
+ * @property ?Disqualification $disqualification
  * @property ?Answer $answer
  */
 class UserQuestion extends Model
@@ -46,6 +48,11 @@ public function question(): BelongsTo
         return $this->belongsTo(Question::class);
     }
 
+    public function disqualifications(): HasOne
+    {
+        return $this->hasOne(Disqualification::class);
+    }
+
     public function isClosed(): Attribute
     {
         return Attribute::get(fn(): bool => $this->userQuiz->isClosed);

app/Models/UserQuiz.php

@@ -10,6 +10,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Support\Collection;
 
 /**
@@ -24,6 +25,7 @@
  * @property bool $isClosed
  * @property Quiz $quiz
  * @property User $user
+ * @property ?Disqualification $disqualification
  * @property Collection<UserQuestion> $userQuestions
  */
 class UserQuiz extends Model
@@ -40,6 +42,11 @@ public function user(): BelongsTo
         return $this->belongsTo(User::class);
     }
 
+    public function disqualification(): HasOne
+    {
+        return $this->hasOne(Disqualification::class);
+    }
+
     public function userQuestions(): HasMany
     {
         return $this->hasMany(UserQuestion::class);

app/Notifications/DisqualificationNotification.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Notifications;
+
+use App\Models\UserQuiz;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+
+class DisqualificationNotification extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    public function __construct(
+        public UserQuiz $userQuiz,
+        public String $reason,
+    ) {}
+
+    public function via(object $notifiable): array
+    {
+        return ["mail"];
+    }
+
+    public function toMail(object $notifiable): MailMessage
+    {
+        return (new MailMessage())
+            ->subject("Dyskwalifikacja z konkursu " . $this->userQuiz->quiz->title)
+            ->view("emails.disqualification", [
+                "user" => $notifiable,
+                "userQuiz" => $this->userQuiz,
+                "reason" => $this->reason,
+            ]);
+    }
+}

app/Policies/UserQuizPolicy.php

@@ -23,4 +23,14 @@ public function result(User $user, UserQuiz $userQuiz): bool
     {
         return $user->id === $userQuiz->user_id && $userQuiz->isClosed;
     }
+
+    public function disqualify(User $user, UserQuiz $userQuiz): bool
+    {
+        return $userQuiz->disqualification()->doesntExist();
+    }
+
+    public function undisqualify(User $user, UserQuiz $userQuiz): bool
+    {
+        return $userQuiz->disqualification()->exists();
+    }
 }

database/migrations/2025_01_17_184724_create_disqualifications_table.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+use App\Models\UserQuiz;
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration {
+    public function up(): void
+    {
+        Schema::create("disqualifications", function (Blueprint $table): void {
+            $table->id();
+            $table->string("reason");
+            $table->foreignIdFor(UserQuiz::class)->constrained()->cascadeOnDelete();
+            $table->timestamps();
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropIfExists("disqualifications");
+    }
+};

resources/views/emails/disqualification.blade.php

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html lang="pl">
+<style>
+    * { margin: 0; padding: 0; }
+    a { text-decoration: none; }
+    p { margin: 48px 0; line-height: 24px; }
+    table { width: 100%; border-spacing: 0; }
+</style>
+
+<div style="font-family: sans-serif; color: #3D4852; padding: 0 48px;">
+    <div style="margin: 40px 0 80px 0;">
+        <img src="{{ asset('logo.png') }}" alt="interns2024b Logo" height="50" width="50">
+    </div>
+
+    <div>
+        <h2>Cześć, {{ $user->firstname }}!</h2>
+
+        <p>
+            Z przykrością informujemy, że zostałeś/-aś zdyskwalifikowany/-a z konkursu {{ $userQuiz->quiz->title }}. <br>
+            Powodem tej decyzji jest {{ $reason }}.
+        <p>
+
+        <p style="margin-top: 16px; ">Pozdrawiamy,<br><span style="color: #E4007D;">{{ config('app.name') }}</span></p>
+
+        <hr style="border: 1px solid #e8ebf1">
+
+        <table><tr><td style="padding-top: 32px; text-align: center;">
+            © 2024 {{ config('app.name') }}. Wszelkie prawa zastrzeżone.
+        </td></tr></table>
+    </div>
+</div>
+</html>

routes/web.php

@@ -64,6 +64,8 @@
 
     Route::post("/quizzes/{quiz}/ranking/publish", [RankingController::class, "publish"])->can("publish,quiz")->name("admin.quizzes.ranking.publish");
     Route::post("/quizzes/{quiz}/ranking/unpublish", [RankingController::class, "unpublish"])->can("publish,quiz")->name("admin.quizzes.ranking.unpublish");
+    Route::post("/quizzes/ranking/disqualify/{userQuiz}", [RankingController::class, "disqualify"])->name("admin.quizzes.ranking.disqualify");
+    Route::post("/quizzes/ranking/undisqualify/{userQuiz}", [RankingController::class, "undisqualify"])->name("admin.quizzes.ranking.undisqualify");
 
     Route::post("/quizzes/{quiz}/questions", [QuizQuestionController::class, "store"])->can("create," . Question::class . ",quiz")->name("admin.questions.store");
     Route::patch("/questions/{question}", [QuizQuestionController::class, "update"])->can("update,question")->name("admin.questions.update");