Add application API and OpenAPI docs
This commit is contained in:
@@ -3,31 +3,40 @@
|
||||
namespace App\Http\Controllers;
|
||||
|
||||
use App\Actions\Permissions\PermissionService;
|
||||
use App\Actions\ProjectBoard\DeleteBoardColumn;
|
||||
use App\Actions\ProjectBoard\DeleteTicketStatus;
|
||||
use App\Actions\ProjectBoard\StoreBoardColumn;
|
||||
use App\Actions\ProjectBoard\StoreTicketStatus;
|
||||
use App\Actions\ProjectBoard\UpdateBoardColumn;
|
||||
use App\Actions\ProjectBoard\UpdateTicketStatus;
|
||||
use App\Actions\ProjectBoard\UpdateTicketStatusTransitions;
|
||||
use App\Actions\Projects\BuildProjectBoardSettingsPayload;
|
||||
use App\Enums\Permission;
|
||||
use App\Http\Requests\StoreBoardColumnRequest;
|
||||
use App\Http\Requests\StoreTicketStatusRequest;
|
||||
use App\Http\Requests\UpdateBoardColumnRequest;
|
||||
use App\Http\Requests\UpdateTicketStatusRequest;
|
||||
use App\Http\Requests\UpdateTicketStatusTransitionsRequest;
|
||||
use App\Http\Resources\BoardColumnResource;
|
||||
use App\Http\Resources\ProjectResource;
|
||||
use App\Http\Resources\TicketStatusResource;
|
||||
use App\Models\BoardColumn;
|
||||
use App\Models\Project;
|
||||
use App\Models\TicketStatus;
|
||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
use Illuminate\Http\RedirectResponse;
|
||||
use Illuminate\Http\Request;
|
||||
use Illuminate\Support\Arr;
|
||||
use Illuminate\Support\Collection;
|
||||
use Illuminate\Support\Facades\DB;
|
||||
use Inertia\Inertia;
|
||||
use Inertia\Response;
|
||||
|
||||
class ProjectBoardSettingsController extends Controller
|
||||
{
|
||||
public function __construct(
|
||||
private readonly BuildProjectBoardSettingsPayload $buildProjectBoardSettingsPayload,
|
||||
private readonly DeleteBoardColumn $deleteBoardColumn,
|
||||
private readonly DeleteTicketStatus $deleteTicketStatus,
|
||||
private readonly PermissionService $permissionService,
|
||||
private readonly StoreBoardColumn $storeBoardColumn,
|
||||
private readonly StoreTicketStatus $storeTicketStatus,
|
||||
private readonly UpdateBoardColumn $updateBoardColumn,
|
||||
private readonly UpdateTicketStatus $updateTicketStatus,
|
||||
private readonly UpdateTicketStatusTransitions $updateTicketStatusTransitions,
|
||||
) {}
|
||||
|
||||
public function show(Request $request, Project $project): Response
|
||||
@@ -37,25 +46,10 @@ class ProjectBoardSettingsController extends Controller
|
||||
403,
|
||||
);
|
||||
|
||||
return Inertia::render('projects/settings/Board', [
|
||||
'backlogTicketStatuses' => TicketStatusResource::collection(
|
||||
$project->ticketStatuses()
|
||||
->whereNull('board_column_id')
|
||||
->get(),
|
||||
)->resolve(),
|
||||
'boardColumns' => BoardColumnResource::collection(
|
||||
$project->boardColumns()
|
||||
->with('ticketStatuses')
|
||||
->get(),
|
||||
)->resolve(),
|
||||
'project' => ProjectResource::make($project)->resolve(),
|
||||
'status' => session('status'),
|
||||
'ticketStatuses' => TicketStatusResource::collection(
|
||||
$project->ticketStatuses()
|
||||
->with(['allowedTargetStatuses.boardColumn', 'boardColumn'])
|
||||
->get(),
|
||||
)->resolve(),
|
||||
]);
|
||||
return Inertia::render(
|
||||
'projects/settings/Board',
|
||||
$this->buildProjectBoardSettingsPayload->handle($project, session('status')),
|
||||
);
|
||||
}
|
||||
|
||||
public function store(
|
||||
@@ -66,25 +60,7 @@ class ProjectBoardSettingsController extends Controller
|
||||
$this->permissionService->allows($request->user(), Permission::ProjectAdmin, $project),
|
||||
403,
|
||||
);
|
||||
$validated = $request->validated();
|
||||
|
||||
$desiredPosition = Arr::get($validated, 'position') ?? $project->boardColumns()->count() + 1;
|
||||
|
||||
$boardColumn = DB::transaction(function () use ($project, $validated, $desiredPosition): BoardColumn {
|
||||
$boardColumn = $project->boardColumns()->create([
|
||||
'name' => Arr::get($validated, 'name'),
|
||||
'position' => $project->boardColumns()->count() + 1,
|
||||
]);
|
||||
$boardColumn->ticketStatuses()->create([
|
||||
'name' => Arr::get($validated, 'name'),
|
||||
'position' => 1,
|
||||
'project_id' => $project->id,
|
||||
]);
|
||||
|
||||
$this->reorderColumns($project, $boardColumn, $desiredPosition);
|
||||
|
||||
return $boardColumn;
|
||||
});
|
||||
$boardColumn = $this->storeBoardColumn->handle($project, $request->validated());
|
||||
|
||||
return to_route('projects.settings.board', $project)
|
||||
->with('status', "{$boardColumn->name} was added to the board workflow.");
|
||||
@@ -99,15 +75,7 @@ class ProjectBoardSettingsController extends Controller
|
||||
$this->permissionService->allows($request->user(), Permission::ProjectAdmin, $project),
|
||||
403,
|
||||
);
|
||||
$validated = $request->validated();
|
||||
|
||||
DB::transaction(function () use ($boardColumn, $project, $validated): void {
|
||||
$boardColumn->update([
|
||||
'name' => Arr::get($validated, 'name'),
|
||||
]);
|
||||
|
||||
$this->reorderColumns($project, $boardColumn, Arr::get($validated, 'position'));
|
||||
});
|
||||
$boardColumn = $this->updateBoardColumn->handle($project, $boardColumn, $request->validated());
|
||||
|
||||
return to_route('projects.settings.board', $project)
|
||||
->with('status', "{$boardColumn->fresh()->name} was updated.");
|
||||
@@ -123,22 +91,7 @@ class ProjectBoardSettingsController extends Controller
|
||||
403,
|
||||
);
|
||||
|
||||
$deletedName = $boardColumn->name;
|
||||
|
||||
DB::transaction(function () use ($boardColumn, $project): void {
|
||||
$boardColumn->ticketStatuses()
|
||||
->get()
|
||||
->each(function (TicketStatus $ticketStatus) use ($project): void {
|
||||
$ticketStatus->update([
|
||||
'board_column_id' => null,
|
||||
'position' => $this->nextStatusPosition($project, null),
|
||||
]);
|
||||
});
|
||||
|
||||
$boardColumn->delete();
|
||||
|
||||
$this->normalizeColumnPositions($project);
|
||||
});
|
||||
$deletedName = $this->deleteBoardColumn->handle($project, $boardColumn);
|
||||
|
||||
return to_route('projects.settings.board', $project)
|
||||
->with('status', "{$deletedName} was removed from the board workflow.");
|
||||
@@ -152,19 +105,7 @@ class ProjectBoardSettingsController extends Controller
|
||||
$this->permissionService->allows($request->user(), Permission::ProjectAdmin, $project),
|
||||
403,
|
||||
);
|
||||
$validated = $request->validated();
|
||||
$boardColumnId = Arr::get($validated, 'board_column_id');
|
||||
$boardColumnId = $boardColumnId === null ? null : (int) $boardColumnId;
|
||||
|
||||
$ticketStatus = DB::transaction(function () use ($boardColumnId, $project, $validated): TicketStatus {
|
||||
return $project->ticketStatuses()->create([
|
||||
'board_column_id' => $boardColumnId,
|
||||
'name' => Arr::get($validated, 'name'),
|
||||
'position' => $this->nextStatusPosition($project, $boardColumnId),
|
||||
]);
|
||||
});
|
||||
|
||||
$ticketStatus->load('boardColumn');
|
||||
$ticketStatus = $this->storeTicketStatus->handle($project, $request->validated());
|
||||
|
||||
return to_route('projects.settings.board', $project)
|
||||
->with('status', "{$ticketStatus->name} was added to {$this->statusContextLabel($ticketStatus)}.");
|
||||
@@ -179,11 +120,7 @@ class ProjectBoardSettingsController extends Controller
|
||||
$this->permissionService->allows($request->user(), Permission::ProjectAdmin, $project),
|
||||
403,
|
||||
);
|
||||
$validated = $request->validated();
|
||||
|
||||
$ticketStatus->update([
|
||||
'name' => Arr::get($validated, 'name'),
|
||||
]);
|
||||
$ticketStatus = $this->updateTicketStatus->handle($ticketStatus, $request->validated());
|
||||
|
||||
return to_route('projects.settings.board', $project)
|
||||
->with('status', "{$ticketStatus->fresh()->name} was updated.");
|
||||
@@ -199,35 +136,10 @@ class ProjectBoardSettingsController extends Controller
|
||||
403,
|
||||
);
|
||||
|
||||
$ticketStatus->load('boardColumn');
|
||||
$boardColumnId = $ticketStatus->board_column_id;
|
||||
|
||||
if ($this->statusContextQuery($project, $boardColumnId)->count() <= 1) {
|
||||
return to_route('projects.settings.board', $project)
|
||||
->withErrors([
|
||||
'ticket_status_id' => "{$this->statusContextLabel($ticketStatus)} needs at least one ticket status.",
|
||||
]);
|
||||
}
|
||||
|
||||
$deletedName = $ticketStatus->name;
|
||||
$contextLabel = $this->statusContextLabel($ticketStatus);
|
||||
|
||||
DB::transaction(function () use ($boardColumnId, $project, $ticketStatus): void {
|
||||
$replacementStatus = $this->statusContextQuery($project, $boardColumnId)
|
||||
->whereKeyNot($ticketStatus->id)
|
||||
->firstOrFail();
|
||||
|
||||
$ticketStatus->tickets()->update([
|
||||
'ticket_status_id' => $replacementStatus->id,
|
||||
]);
|
||||
|
||||
$ticketStatus->delete();
|
||||
|
||||
$this->normalizeStatusPositions($project, $boardColumnId);
|
||||
});
|
||||
$result = $this->deleteTicketStatus->handle($project, $ticketStatus);
|
||||
|
||||
return to_route('projects.settings.board', $project)
|
||||
->with('status', "{$deletedName} was removed from {$contextLabel}.");
|
||||
->with('status', "{$result['deleted_name']} was removed from {$result['context_label']}.");
|
||||
}
|
||||
|
||||
public function updateStatusTransitions(
|
||||
@@ -239,92 +151,14 @@ class ProjectBoardSettingsController extends Controller
|
||||
$this->permissionService->allows($request->user(), Permission::ProjectAdmin, $project),
|
||||
403,
|
||||
);
|
||||
$validated = $request->validated();
|
||||
$allowedTicketStatusIds = collect(Arr::get($validated, 'allowed_ticket_status_ids', []))
|
||||
->map(fn (int|string $ticketStatusId): int => (int) $ticketStatusId)
|
||||
->unique()
|
||||
->values()
|
||||
->all();
|
||||
|
||||
$ticketStatus->allowedTargetStatuses()->sync($allowedTicketStatusIds);
|
||||
$this->updateTicketStatusTransitions->handle($ticketStatus, $request->validated());
|
||||
|
||||
return to_route('projects.settings.board', $project)
|
||||
->with('status', "{$ticketStatus->name} move targets were updated.");
|
||||
}
|
||||
|
||||
private function normalizeColumnPositions(Project $project): void
|
||||
{
|
||||
$this->persistOrderedColumns(
|
||||
$project->boardColumns()
|
||||
->get()
|
||||
->values(),
|
||||
);
|
||||
}
|
||||
|
||||
private function reorderColumns(Project $project, BoardColumn $movingColumn, int $desiredPosition): void
|
||||
{
|
||||
/** @var Collection<int, BoardColumn> $columns */
|
||||
$columns = $project->boardColumns()
|
||||
->whereKeyNot($movingColumn->id)
|
||||
->get()
|
||||
->values();
|
||||
|
||||
$insertAt = max(0, min($desiredPosition - 1, $columns->count()));
|
||||
|
||||
$columns->splice($insertAt, 0, [$movingColumn]);
|
||||
|
||||
$this->persistOrderedColumns($columns->values());
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Collection<int, BoardColumn> $columns
|
||||
*/
|
||||
private function persistOrderedColumns(Collection $columns): void
|
||||
{
|
||||
$temporaryOffset = ((int) $columns->max('position')) + $columns->count() + 1;
|
||||
|
||||
$columns->each(function (BoardColumn $column, int $index) use ($temporaryOffset): void {
|
||||
$column->forceFill([
|
||||
'position' => $temporaryOffset + $index,
|
||||
])->saveQuietly();
|
||||
});
|
||||
|
||||
$columns->each(function (BoardColumn $column, int $index): void {
|
||||
$column->forceFill([
|
||||
'position' => $index + 1,
|
||||
])->saveQuietly();
|
||||
});
|
||||
}
|
||||
|
||||
private function nextStatusPosition(Project $project, ?int $boardColumnId): int
|
||||
{
|
||||
return $this->statusContextQuery($project, $boardColumnId)->count() + 1;
|
||||
}
|
||||
|
||||
private function normalizeStatusPositions(Project $project, ?int $boardColumnId): void
|
||||
{
|
||||
$this->statusContextQuery($project, $boardColumnId)
|
||||
->get()
|
||||
->values()
|
||||
->each(function (TicketStatus $ticketStatus, int $index): void {
|
||||
$ticketStatus->forceFill([
|
||||
'position' => $index + 1,
|
||||
])->saveQuietly();
|
||||
});
|
||||
}
|
||||
|
||||
private function statusContextLabel(TicketStatus $ticketStatus): string
|
||||
{
|
||||
return $ticketStatus->boardColumn?->name ?? 'Backlog';
|
||||
}
|
||||
|
||||
private function statusContextQuery(Project $project, ?int $boardColumnId): HasMany
|
||||
{
|
||||
return $project->ticketStatuses()
|
||||
->when(
|
||||
$boardColumnId === null,
|
||||
fn ($query) => $query->whereNull('board_column_id'),
|
||||
fn ($query) => $query->where('board_column_id', $boardColumnId),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user