license: built full stack, test and documentation
Some checks failed
docs / build (push) Has been cancelled
docs / deploy (push) Has been cancelled

This commit is contained in:
Giuseppe Naponiello
2026-07-03 12:47:47 +02:00
parent f8206b5840
commit 271acacb1d
39 changed files with 4078 additions and 57 deletions

View File

@@ -0,0 +1,96 @@
<?php
namespace App\Http\Controllers;
use App\Http\Requests\IndexLicenseRequest;
use App\Http\Requests\StoreLicenseRequest;
use App\Http\Requests\UpdateLicenseRequest;
use App\Http\Traits\ApiResponse;
use App\Models\Lists\License;
use Illuminate\Http\JsonResponse;
/**
* CRUD del vocabolario licenze (scrittura riservata agli Admin).
*
* NB gli id 1-3 sono allineati al legacy e verranno usati dall'ETL per
* mappare le FK di artifact/media: per ritirare una licenza usare
* `active = false`, non la cancellazione. Nessun soft delete su questo lookup.
*/
class LicenseController extends Controller
{
use ApiResponse;
/**
* Elenco delle licenze, ordinate per `sort_order` (dalla più aperta alla
* più restrittiva). Filtri: `scope=record|media` (select dei form),
* `active=1` (esclude le licenze ritirate).
*/
public function index(IndexLicenseRequest $request): JsonResponse
{
$query = License::query()->orderBy('sort_order')->orderBy('acronym');
match ($request->input('scope')) {
'record' => $query->forRecord(),
'media' => $query->forMedia(),
default => null,
};
if ($request->filled('active')) {
$query->where('active', $request->boolean('active'));
}
return $this->collectionResponse($query->get());
}
/**
* Crea una licenza.
*/
public function store(StoreLicenseRequest $request): JsonResponse
{
$license = License::create($request->validated());
return $this->createdResponse($license);
}
/**
* Dettaglio di una licenza.
*/
public function show(License $license): JsonResponse
{
return $this->okResponse($license);
}
/**
* Aggiorna una licenza (anche parzialmente, es. solo `active`).
*/
public function update(UpdateLicenseRequest $request, License $license): JsonResponse
{
$license->update($request->validated());
return $this->updatedResponse($license);
}
/**
* Elimina una licenza (se non assegnata ad alcun contenuto).
*/
public function destroy(License $license): JsonResponse
{
if ($license->isInUse()) {
return $this->conflictResponse('Cannot delete: license assigned to at least one record or media file.');
}
$license->delete();
return $this->deletedResponse();
}
/**
* Indica se la licenza è in uso (bloccata per l'eliminazione).
*/
public function usage(License $license): JsonResponse
{
return response()->json([
'in_use' => $license->isInUse(),
]);
}
}

View File

@@ -0,0 +1,33 @@
<?php
namespace App\Http\Requests;
use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rule;
class IndexLicenseRequest extends FormRequest
{
/**
* Rotta pubblica: l'elenco delle licenze è informazione pubblica.
*/
public function authorize(): bool
{
return true;
}
/**
* `scope` filtra le select dei form: `record` per artifact/model (solo
* licenze aperte), `media` per i file caricati (tutte). `active` esclude
* le licenze ritirate dagli admin.
*
* @return array<string, ValidationRule|array<mixed>|string>
*/
public function rules(): array
{
return [
'scope' => ['nullable', Rule::in(['record', 'media'])],
'active' => ['nullable', 'boolean'],
];
}
}

View File

@@ -0,0 +1,41 @@
<?php
namespace App\Http\Requests;
use App\Enums\LicenseKind;
use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rule;
class StoreLicenseRequest extends FormRequest
{
/**
* L'autorizzazione (solo Admin) è gestita dal middleware di rotta.
*/
public function authorize(): bool
{
return true;
}
/**
* @return array<string, ValidationRule|array<mixed>|string>
*/
public function rules(): array
{
return [
'name' => ['required', 'string', 'max:200', 'unique:licenses,name'],
'acronym' => ['required', 'string', 'max:50', 'unique:licenses,acronym'],
// Solo id della SPDX License List ufficiale: per marchi e rights
// statement (che non vi compaiono) deve restare NULL.
'spdx_id' => ['nullable', 'string', 'max:50', 'unique:licenses,spdx_id'],
'kind' => ['required', Rule::enum(LicenseKind::class)],
'description' => ['nullable', 'string'],
'uri' => ['nullable', 'url', 'max:2000'],
'file' => ['nullable', 'string', 'max:512'],
'for_record' => ['sometimes', 'boolean'],
'for_media' => ['sometimes', 'boolean'],
'sort_order' => ['sometimes', 'integer', 'min:0'],
'active' => ['sometimes', 'boolean'],
];
}
}

View File

@@ -0,0 +1,43 @@
<?php
namespace App\Http\Requests;
use App\Enums\LicenseKind;
use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rule;
class UpdateLicenseRequest extends FormRequest
{
/**
* L'autorizzazione (solo Admin) è gestita dal middleware di rotta.
*/
public function authorize(): bool
{
return true;
}
/**
* Aggiornamento parziale: ogni campo è validato solo se presente.
*
* @return array<string, ValidationRule|array<mixed>|string>
*/
public function rules(): array
{
$id = $this->route('license')->id;
return [
'name' => ['sometimes', 'required', 'string', 'max:200', Rule::unique('licenses', 'name')->ignore($id)],
'acronym' => ['sometimes', 'required', 'string', 'max:50', Rule::unique('licenses', 'acronym')->ignore($id)],
'spdx_id' => ['nullable', 'string', 'max:50', Rule::unique('licenses', 'spdx_id')->ignore($id)],
'kind' => ['sometimes', 'required', Rule::enum(LicenseKind::class)],
'description' => ['nullable', 'string'],
'uri' => ['nullable', 'url', 'max:2000'],
'file' => ['nullable', 'string', 'max:512'],
'for_record' => ['sometimes', 'boolean'],
'for_media' => ['sometimes', 'boolean'],
'sort_order' => ['sometimes', 'integer', 'min:0'],
'active' => ['sometimes', 'boolean'],
];
}
}