#444 - overtime application process

app/Actions/OvertimeRequest/AcceptAsTechnicalAction.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Actions\OvertimeRequest;
+
+use Toby\Domain\OvertimeRequestStateManager;
+use Toby\Models\OvertimeRequest;
+use Toby\Models\User;
+
+class AcceptAsTechnicalAction
+{
+    public function __construct(
+        protected OvertimeRequestStateManager $stateManager,
+        protected ApproveAction $approveAction,
+    ) {}
+
+    public function execute(OvertimeRequest $overtimeRequest, User $user): void
+    {
+        $this->stateManager->acceptAsTechnical($overtimeRequest, $user);
+
+        $this->approveAction->execute($overtimeRequest);
+    }
+}

app/Actions/OvertimeRequest/ApproveAction.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Actions\OvertimeRequest;
+
+use Toby\Domain\OvertimeRequestStateManager;
+use Toby\Models\OvertimeRequest;
+use Toby\Models\User;
+
+class ApproveAction
+{
+    public function __construct(
+        protected OvertimeRequestStateManager $stateManager,
+    ) {}
+
+    public function execute(OvertimeRequest $overtimeRequest, ?User $user = null): void
+    {
+        $this->stateManager->approve($overtimeRequest, $user);
+    }
+}

app/Actions/OvertimeRequest/CancelAction.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Actions\OvertimeRequest;
+
+use Toby\Domain\OvertimeRequestStateManager;
+use Toby\Models\OvertimeRequest;
+use Toby\Models\User;
+
+class CancelAction
+{
+    public function __construct(
+        protected OvertimeRequestStateManager $stateManager,
+    ) {}
+
+    public function execute(OvertimeRequest $overtimeRequest, User $user): void
+    {
+        $this->stateManager->cancel($overtimeRequest, $user);
+    }
+}

app/Actions/OvertimeRequest/CreateAction.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Actions\OvertimeRequest;
+
+use Illuminate\Validation\ValidationException;
+use Toby\Domain\OvertimeCalculator;
+use Toby\Domain\OvertimeRequestStateManager;
+use Toby\Models\OvertimeRequest;
+use Toby\Models\User;
+use Toby\Validation\OvertimeRequestValidator;
+
+class CreateAction
+{
+    public function __construct(
+        protected OvertimeRequestStateManager $stateManager,
+        protected WaitForTechApprovalAction $waitForTechApprovalAction,
+        protected OvertimeCalculator $overtimeCalculator,
+        protected OvertimeRequestValidator $overtimeRequestValidator,
+    ) {}
+
+    /**
+     * @throws ValidationException
+     */
+    public function execute(array $data, User $creator): OvertimeRequest
+    {
+        $overtimeRequest = $this->createVacationRequest($data, $creator);
+
+        $this->handleCreatedOvertimeRequest($overtimeRequest);
+
+        return $overtimeRequest;
+    }
+
+    /**
+     * @throws ValidationException
+     */
+    protected function createVacationRequest(array $data, User $creator): OvertimeRequest
+    {
+        /** @var OvertimeRequest $overtimeRequest */
+        $overtimeRequest = $creator->createdOvertimeRequests()->make($data);
+        $overtimeRequest->hours = $this->overtimeCalculator->calculateHours($overtimeRequest->from, $overtimeRequest->to);
+
+        $this->overtimeRequestValidator->validate($overtimeRequest);
+
+        $overtimeRequest->save();
+
+        $this->stateManager->markAsCreated($overtimeRequest);
+
+        return $overtimeRequest;
+    }
+
+    protected function handleCreatedOvertimeRequest(OvertimeRequest $overtimeRequest): void
+    {
+        $this->waitForTechApprovalAction->execute($overtimeRequest);
+    }
+}

app/Actions/OvertimeRequest/RejectAction.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Actions\OvertimeRequest;
+
+use Toby\Domain\OvertimeRequestStateManager;
+use Toby\Models\OvertimeRequest;
+use Toby\Models\User;
+
+class RejectAction
+{
+    public function __construct(
+        protected OvertimeRequestStateManager $stateManager,
+    ) {}
+
+    public function execute(OvertimeRequest $overtimeRequest, User $user): void
+    {
+        $this->stateManager->reject($overtimeRequest, $user);
+    }
+}

app/Actions/OvertimeRequest/SettleAction.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Actions\OvertimeRequest;
+
+use Toby\Domain\OvertimeRequestStateManager;
+use Toby\Models\OvertimeRequest;
+use Toby\Models\User;
+
+class SettleAction
+{
+    public function __construct(
+        protected OvertimeRequestStateManager $stateManager,
+    ) {}
+
+    public function execute(OvertimeRequest $overtimeRequest, User $user): void
+    {
+        $this->stateManager->settle($overtimeRequest, $user);
+    }
+}

app/Actions/OvertimeRequest/WaitForTechApprovalAction.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Actions\OvertimeRequest;
+
+use Toby\Actions\VacationRequest\ApproveAction;
+use Toby\Domain\OvertimeRequestStateManager;
+use Toby\Models\OvertimeRequest;
+
+class WaitForTechApprovalAction
+{
+    public function __construct(
+        protected OvertimeRequestStateManager $stateManager,
+        protected ApproveAction $approveAction,
+    ) {}
+
+    public function execute(OvertimeRequest $overtimeRequest): void
+    {
+        $this->stateManager->waitForTechnical($overtimeRequest);
+    }
+}

app/Domain/OvertimeCalculator.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Domain;
+
+use Carbon\Carbon;
+use Carbon\CarbonInterface;
+
+class OvertimeCalculator
+{
+    public function calculateHours(CarbonInterface $from, CarbonInterface $to): int
+    {
+        $hours = Carbon::create($from)->diffInMinutes($to);
+
+        return (int)ceil($hours / 60);
+    }
+}

app/Domain/OvertimeRequestStateManager.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Domain;
+
+use Illuminate\Contracts\Events\Dispatcher;
+use Toby\Models\OvertimeRequest;
+use Toby\Models\User;
+use Toby\States\OvertimeRequest\AcceptedByTechnical;
+use Toby\States\OvertimeRequest\Approved;
+use Toby\States\OvertimeRequest\Cancelled;
+use Toby\States\OvertimeRequest\OvertimeRequestState;
+use Toby\States\OvertimeRequest\Rejected;
+use Toby\States\OvertimeRequest\Settled;
+use Toby\States\OvertimeRequest\WaitingForTechnical;
+
+class OvertimeRequestStateManager
+{
+    public function __construct(
+        protected Dispatcher $dispatcher,
+    ) {}
+
+    public function markAsCreated(OvertimeRequest $overtimeRequest): void
+    {
+        $this->createActivity($overtimeRequest, null, $overtimeRequest->state, $overtimeRequest->creator);
+    }
+
+    public function approve(OvertimeRequest $overtimeRequest, ?User $user = null): void
+    {
+        $this->changeState($overtimeRequest, Approved::class, $user);
+    }
+
+    public function reject(OvertimeRequest $overtimeRequest, User $user): void
+    {
+        $this->changeState($overtimeRequest, Rejected::class, $user);
+    }
+
+    public function cancel(OvertimeRequest $overtimeRequest, User $user): void
+    {
+        $this->changeState($overtimeRequest, Cancelled::class, $user);
+    }
+
+    public function acceptAsTechnical(OvertimeRequest $overtimeRequest, User $user): void
+    {
+        $this->changeState($overtimeRequest, AcceptedByTechnical::class, $user);
+    }
+
+    public function waitForTechnical(OvertimeRequest $overtimeRequest): void
+    {
+        $this->changeState($overtimeRequest, WaitingForTechnical::class);
+    }
+
+    public function settle(OvertimeRequest $overtimeRequest, User $user): void
+    {
+        $this->changeState($overtimeRequest, Settled::class, $user);
+    }
+
+    protected function changeState(OvertimeRequest $overtimeRequest, string $state, ?User $user = null): void
+    {
+        $previousState = $overtimeRequest->state;
+        $overtimeRequest->state->transitionTo($state);
+        $overtimeRequest->save();
+
+        $this->createActivity($overtimeRequest, $previousState, $overtimeRequest->state, $user);
+    }
+
+    protected function createActivity(
+        OvertimeRequest $overtimeRequest,
+        ?OvertimeRequestState $from,
+        OvertimeRequestState $to,
+        ?User $user = null,
+    ): void {
+        $overtimeRequest->activities()->create([
+            "from" => $from,
+            "to" => $to,
+            "user_id" => $user?->id,
+        ]);
+    }
+}

app/Domain/OvertimeRequestStatesRetriever.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Domain;
+
+use Toby\Enums\Role;
+use Toby\Models\User;
+use Toby\States\OvertimeRequest\AcceptedByTechnical;
+use Toby\States\OvertimeRequest\Approved;
+use Toby\States\OvertimeRequest\Cancelled;
+use Toby\States\OvertimeRequest\Created;
+use Toby\States\OvertimeRequest\Rejected;
+use Toby\States\OvertimeRequest\Settled;
+use Toby\States\OvertimeRequest\WaitingForTechnical;
+
+class OvertimeRequestStatesRetriever
+{
+    public static function pendingStates(): array
+    {
+        return [
+            Created::class,
+            WaitingForTechnical::class,
+            AcceptedByTechnical::class,
+        ];
+    }
+
+    public static function successStates(): array
+    {
+        return [Approved::class];
+    }
+
+    public static function settledStates(): array
+    {
+        return [Settled::class];
+    }
+
+    public static function failedStates(): array
+    {
+        return [
+            Rejected::class,
+            Cancelled::class,
+        ];
+    }
+
+    public static function waitingForUserActionStates(User $user): array
+    {
+        return match ($user->role) {
+            Role::TechnicalApprover, Role::Administrator => [WaitingForTechnical::class],
+            default => [],
+        };
+    }
+
+    public static function all(): array
+    {
+        return [
+            ...self::pendingStates(),
+            ...self::successStates(),
+            ...self::failedStates(),
+            ...self::settledStates(),
+        ];
+    }
+
+    public static function filterByStatusGroup(string $filter, ?User $user = null): array
+    {
+        return match ($filter) {
+            "pending" => self::pendingStates(),
+            "success" => self::successStates(),
+            "failed" => self::failedStates(),
+            "waiting_for_action" => self::waitingForUserActionStates($user),
+            "settled" => self::settledStates(),
+            default => self::all(),
+        };
+    }
+}

app/Enums/SettlementType.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Enums;
+
+enum SettlementType: string
+{
+    case Hours = "hours";
+    case Money = "money";
+
+    public function label(): string
+    {
+        return __($this->value);
+    }
+
+    public static function casesToSelect(): array
+    {
+        return array_map(
+            fn(SettlementType $enum): array => [
+                "label" => $enum->label(),
+                "value" => $enum->value,
+            ],
+            SettlementType::cases(),
+        );
+    }
+}