#50 - CRUD for schools frontend

Makefile

@@ -54,6 +54,9 @@ test-specific:
 fix:
 	@docker compose --file ${DOCKER_COMPOSE_FILE} exec --user "${CURRENT_USER_ID}:${CURRENT_USER_GROUP_ID}" ${DOCKER_COMPOSE_APP_CONTAINER} bash -c 'composer csf'
 
+lintf:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} exec --user "${CURRENT_USER_ID}:${CURRENT_USER_GROUP_ID}" ${DOCKER_COMPOSE_APP_CONTAINER} bash -c 'npm run lintf'
+
 analyse:
 	@docker compose --file ${DOCKER_COMPOSE_FILE} exec --user "${CURRENT_USER_ID}:${CURRENT_USER_GROUP_ID}" ${DOCKER_COMPOSE_APP_CONTAINER} bash -c 'composer analyse'
 

app/DTO/SchoolDTO.php

@@ -8,6 +8,7 @@ class SchoolDTO
 {
     public function __construct(
         public string $name,
+        public string $regon,
         public string $city,
         public string $street,
         public string $buildingNumber,
@@ -19,6 +20,7 @@ public static function createFromArray(array $data): self
     {
         $member = new self(
             $data["nazwa"],
+            $data["regon"],
             $data["miejscowosc"],
             $data["ulica"],
             $data["numerBudynku"],
@@ -28,4 +30,17 @@ public static function createFromArray(array $data): self
 
         return $member;
     }
+
+    public function toArray(): array
+    {
+        return [
+            "name" => $this->name,
+            "regon" => $this->regon,
+            "city" => $this->city,
+            "street" => $this->street,
+            "building_number" => $this->buildingNumber,
+            "apartment_number" => $this->apartmentNumber,
+            "zip_code" => $this->zipCode,
+        ];
+    }
 }

app/Helpers/RegonHelper.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Helpers;
+
+class RegonHelper
+{
+    public const array WEIGHTS_SHORT = [8, 9, 2, 3, 4, 5, 6, 7];
+    public const array WEIGHTS_LONG = [2, 4, 8, 5, 0, 9, 7, 3, 6, 1, 2, 4, 8];
+
+    public static function generateShortRegon()
+    {
+        $digits = "";
+
+        for ($i = 0; $i < 8; $i++) {
+            $digits .= rand(0, 9);
+        }
+
+        $checksum = self::calculateChecksum(str_split($digits), self::WEIGHTS_SHORT);
+
+        return $digits . $checksum;
+    }
+
+    public static function generateLongRegon()
+    {
+        $digits = "";
+
+        for ($i = 0; $i < 13; $i++) {
+            $digits .= rand(0, 9);
+        }
+
+        $checksum = self::calculateChecksum(str_split($digits), self::WEIGHTS_LONG);
+
+        return $digits . $checksum;
+    }
+
+    /***
+     * @param array<string> $number
+     * @param array<int> $wages
+     */
+    public static function calculateChecksum(array $number, array $wages): int
+    {
+        $sum = 0;
+
+        for ($i = 0; $i < count($wages); $i++) {
+            $sum += $wages[$i] * intval($number[$i]);
+        }
+
+        $checksum = $sum % 11;
+
+        if ($checksum === 10) {
+            return 0;
+        }
+
+        return $checksum;
+    }
+}

app/Helpers/SortHelper.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Helpers;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\Request;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Facades\Lang;
+use Symfony\Component\HttpFoundation\Response as Status;
+
+class SortHelper
+{
+    public function __construct(
+        private Request $request,
+    ) {}
+
+    /**
+     * @param array<string> $allowedFields
+     * @param array<string> $ignoredFields
+     */
+    public function sort(Builder $query, array $allowedFields, array $ignoredFields): Builder
+    {
+        [$field, $order] = $this->getSortParameters();
+
+        if (!in_array($field, $allowedFields, true)) {
+            if (in_array($field, $ignoredFields, true)) {
+                return $query;
+            }
+
+            abort(Status::HTTP_BAD_REQUEST, Lang::get("validation.sorting.unsupported_field", ["attribute" => $field]));
+        }
+
+        return $query->orderBy($field, $order);
+    }
+
+    /**
+     * @return array<string>
+     */
+    public function getSortParameters(): array
+    {
+        $field = $this->request->query("sort", "id");
+        $ascending = $this->request->query("order", "asc") === "asc";
+
+        return [$field, $ascending ? "asc" : "desc"];
+    }
+
+    public function search(Builder $query, string $field): Builder
+    {
+        $searchText = $this->request->query("search");
+
+        if ($searchText) {
+            return $query->where($field, "like", "%$searchText%");
+        }
+
+        return $query;
+    }
+
+    public function paginate(Builder $query): LengthAwarePaginator
+    {
+        $limit = (int)$this->request->query("limit", "50");
+
+        if (!$limit || $limit < 0) {
+            $limit = 50;
+        }
+
+        return $query->paginate($limit);
+    }
+}

app/Http/Controllers/QuizController.php

@@ -4,12 +4,14 @@
 
 namespace App\Http\Controllers;
 
+use App\Helpers\SortHelper;
 use App\Http\Requests\QuizRequest;
 use App\Http\Requests\UpdateQuizRequest;
 use App\Http\Resources\QuizResource;
 use App\Models\Quiz;
 use App\Services\QuizUpdateService;
 use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
 use Inertia\Inertia;
@@ -19,11 +21,12 @@
 
 class QuizController extends Controller
 {
-    public function index(): Response
+    public function index(Request $request, SortHelper $sorter): Response
     {
-        $quizzes = Quiz::query()
-            ->with("questions.answers")
-            ->get();
+        $query = $sorter->sort(Quiz::query()->with("questions.answers"), ["id", "title", "updated_at", "created_at"], []);
+        $query = $this->filterArchivedQuizzes($query, $request);
+        $query = $sorter->search($query, "title");
+        $quizzes = $sorter->paginate($query);
 
         return Inertia::render("Admin/Quizzes", ["quizzes" => QuizResource::collection($quizzes)]);
     }
@@ -96,4 +99,15 @@ public function assign(Request $request, Quiz $quiz): RedirectResponse
             ->back()
             ->with("status", "Przypisano do testu");
     }
+
+    private function filterArchivedQuizzes(Builder $query, Request $request): Builder
+    {
+        $showArchived = $request->query("archived", "false") === "true";
+
+        if (!$showArchived) {
+            return $query->whereNull("locked_at")->orWhereDate("scheduled_at", ">", Carbon::now());
+        }
+
+        return $query;
+    }
 }

app/Http/Controllers/SchoolsController.php

@@ -5,11 +5,13 @@
 namespace App\Http\Controllers;
 
 use App\Enums\Voivodeship;
+use App\Helpers\SortHelper;
 use App\Http\Requests\SchoolRequest;
 use App\Http\Resources\SchoolResource;
 use App\Jobs\FetchSchoolsJob;
 use App\Models\School;
 use Illuminate\Bus\Batch;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Support\Facades\Bus;
@@ -24,17 +26,24 @@
 
 class SchoolsController extends Controller
 {
-    public function index(): Response
+    public function index(SortHelper $sorter): Response
     {
-        return Inertia::render("Admin/SchoolsPanel", ["schools" => SchoolResource::collection(School::all())]);
+        $query = $sorter->sort(School::query(), ["id", "name", "regon", "updated_at", "created_at"], ["students", "address"]);
+        $query = $this->sortByStudents($query, $sorter);
+        $query = $this->sortByAddress($query, $sorter);
+        $query = $sorter->search($query, "name");
+        $schools = $sorter->paginate($query);
+
+        return Inertia::render("Admin/SchoolsPanel", ["schools" => SchoolResource::collection($schools)]);
     }
 
     public function store(SchoolRequest $request): RedirectResponse
     {
         School::query()->create($request->validated());
 
         return redirect()
-            ->back();
+            ->back()
+            ->with("status", "Szkoła została dodana.");
     }
 
     public function update(SchoolRequest $request, School $school): RedirectResponse
@@ -67,6 +76,7 @@ public function fetch(): JsonResponse
         $jobs = $voivodeships->map(fn(Voivodeship $voivodeships): FetchSchoolsJob => new FetchSchoolsJob($voivodeships, $schoolTypes));
         $batch = Bus::batch($jobs)->finally(fn(): bool => Cache::delete("fetch_schools"))->dispatch();
         Cache::set("fetch_schools", $batch->id);
+        Cache::forget("fetched_schools");
 
         return response()->json(["message" => "Pobieranie rozpoczęte"], Status::HTTP_OK);
     }
@@ -75,6 +85,7 @@ public function status(): JsonResponse
     {
         return response()->json([
             "done" => !$this->isFetching(),
+            "count" => Cache::get("fetched_schools"),
         ]);
     }
 
@@ -95,4 +106,29 @@ protected function findBatch(): ?Batch
 
         return Bus::findBatch($batchId);
     }
+
+    private function sortByStudents(Builder $query, SortHelper $sorter): Builder
+    {
+        [$field, $order] = $sorter->getSortParameters();
+
+        if ($field === "students") {
+            return $query->withCount("users")->orderBy("users_count", $order);
+        }
+
+        return $query;
+    }
+
+    private function sortByAddress(Builder $query, SortHelper $sorter): Builder
+    {
+        [$field, $order] = $sorter->getSortParameters();
+
+        if ($field === "address") {
+            return $query->orderBy("city", $order)
+                ->orderBy("zip_code", $order)
+                ->orderBy("street", $order)
+                ->orderBy("name", $order);
+        }
+
+        return $query;
+    }
 }

app/Http/Requests/QuizRequest.php

@@ -27,7 +27,7 @@ public function prepareForValidation(): void
     public function rules(): array
     {
         return [
-            "title" => ["required", "string"],
+            "title" => ["required", "string", "max:255"],
             "scheduled_at" => ["date", "after:now"],
             "duration" => ["numeric", "min:1", "max:2147483647"],
         ];

app/Http/Requests/SchoolRequest.php

@@ -4,6 +4,7 @@
 
 namespace App\Http\Requests;
 
+use App\Rules\Regon;
 use Illuminate\Contracts\Validation\ValidationRule;
 use Illuminate\Foundation\Http\FormRequest;
 
@@ -14,18 +15,34 @@ public function authorize(): bool
         return true;
     }
 
+    public function prepareForValidation(): void
+    {
+        if ($this->has("buildingNumber")) {
+            $this->merge(["building_number" => $this->input("buildingNumber")]);
+        }
+
+        if ($this->has("apartmentNumber")) {
+            $this->merge(["apartment_number" => $this->input("apartmentNumber")]);
+        }
+
+        if ($this->has("zipCode")) {
+            $this->merge(["zip_code" => $this->input("zipCode")]);
+        }
+    }
+
     /**
      * @return array<string, ValidationRule|array|string>
      */
     public function rules(): array
     {
         return [
-            "name" => ["required", "string"],
-            "city" => ["required", "string"],
-            "street" => ["required", "string"],
-            "building_number" => ["required", "string"],
-            "apartment_number" => ["string"],
-            "zip_code" => ["required", "string"],
+            "name" => ["required", "string", "max:255"],
+            "city" => ["required", "string", "max:255"],
+            "regon" => ["required", "string", new Regon()],
+            "street" => ["required", "string", "max:255"],
+            "building_number" => ["required", "string", "max:255"],
+            "apartment_number" => ["string", "nullable", "max:255"],
+            "zip_code" => ["required", "string", "regex:/^\d{2}-\d{3}$/"],
         ];
     }
 }

app/Http/Requests/UpdateQuizRequest.php

@@ -28,7 +28,7 @@ public function prepareForValidation(): void
     public function rules(): array
     {
         return [
-            "title" => ["required", "string"],
+            "title" => ["required", "string", "max:255"],
             "scheduled_at" => ["date", "after:now"],
             "duration" => ["integer", "min:1", "max:2147483647"],
             "questions" => ["array"],

app/Http/Resources/SchoolResource.php

@@ -17,7 +17,15 @@ public function toArray(Request $request): array
         return [
             "id" => $this->id,
             "name" => $this->name,
+            "regon" => $this->regon,
             "city" => $this->city,
+            "street" => $this->street,
+            "buildingNumber" => $this->building_number,
+            "apartmentNumber" => $this->apartment_number,
+            "zipCode" => $this->zip_code,
+            "numberOfStudents" => $this->users()->count(),
+            "createdAt" => $this->created_at,
+            "updatedAt" => $this->updated_at,
         ];
     }
 }