Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions app-modules/onboarding/src/Contracts/OnboardingCompletionGate.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php

declare(strict_types=1);

namespace He4rt\Onboarding\Contracts;

use Carbon\CarbonInterface;
use He4rt\Identity\User\Models\User;
use He4rt\Onboarding\Enums\OnboardingType;

interface OnboardingCompletionGate
{
public function isCompleted(User $user, OnboardingType $type): bool;

public function completedAt(User $user, OnboardingType $type): ?CarbonInterface;
}
7 changes: 7 additions & 0 deletions app-modules/onboarding/src/OnboardingServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,17 @@

namespace He4rt\Onboarding;

use He4rt\Onboarding\Contracts\OnboardingCompletionGate;
use He4rt\Onboarding\Services\EloquentOnboardingCompletionGate;
use Illuminate\Support\ServiceProvider;

class OnboardingServiceProvider extends ServiceProvider
{
public function register(): void
{
$this->app->singleton(OnboardingCompletionGate::class, EloquentOnboardingCompletionGate::class);
}

public function boot(): void
{
$this->loadMigrationsFrom(__DIR__.'/../database/migrations');
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?php

declare(strict_types=1);

namespace He4rt\Onboarding\Services;

use Carbon\CarbonInterface;
use He4rt\Identity\User\Models\User;
use He4rt\Onboarding\Contracts\OnboardingCompletionGate;
use He4rt\Onboarding\Enums\OnboardingStatus;
use He4rt\Onboarding\Enums\OnboardingType;
use He4rt\Onboarding\Models\Onboarding;

final class EloquentOnboardingCompletionGate implements OnboardingCompletionGate
{
public function isCompleted(User $user, OnboardingType $type): bool
{
return Onboarding::query()
->whereBelongsTo($user)
->where('type', $type)
->where('status', OnboardingStatus::Completed)
->exists();
}

public function completedAt(User $user, OnboardingType $type): ?CarbonInterface
{
return Onboarding::query()
->whereBelongsTo($user)
->where('type', $type)
->where('status', OnboardingStatus::Completed)
->first(['completed_at'])
?->completed_at;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<?php

declare(strict_types=1);

use He4rt\Identity\User\Models\User;
use He4rt\Onboarding\Contracts\OnboardingCompletionGate;
use He4rt\Onboarding\Enums\OnboardingStatus;
use He4rt\Onboarding\Enums\OnboardingType;
use He4rt\Onboarding\Models\Onboarding;
use Illuminate\Support\Facades\Date;

test('a completed onboarding opens its completion gate', function (): void {
$user = User::factory()->create();

Onboarding::factory()->create([
'user_id' => $user,
'type' => OnboardingType::Welcome,
'status' => OnboardingStatus::Completed,
'completed_at' => now(),
]);

expect(resolve(OnboardingCompletionGate::class)->isCompleted($user, OnboardingType::Welcome))
->toBeTrue();
});

test('a non-completed onboarding keeps its completion gate closed', function (OnboardingStatus $status): void {
$user = User::factory()->create();

Onboarding::factory()->create([
'user_id' => $user,
'type' => OnboardingType::Welcome,
'status' => $status,
]);

expect(resolve(OnboardingCompletionGate::class)->isCompleted($user, OnboardingType::Welcome))
->toBeFalse();
})->with([
OnboardingStatus::InProgress,
OnboardingStatus::Paused,
OnboardingStatus::Rejected,
]);

test('a missing onboarding keeps its completion gate closed', function (): void {
$user = User::factory()->create();

expect(resolve(OnboardingCompletionGate::class)->isCompleted($user, OnboardingType::Welcome))
->toBeFalse();
});

test('completion of another onboarding type does not open the requested gate', function (): void {
$user = User::factory()->create();

Onboarding::factory()->create([
'user_id' => $user,
'type' => OnboardingType::Squads,
'status' => OnboardingStatus::Completed,
'completed_at' => now(),
]);

expect(resolve(OnboardingCompletionGate::class)->isCompleted($user, OnboardingType::Welcome))
->toBeFalse();
});

test('the completion gate exposes when the onboarding was completed', function (): void {
$user = User::factory()->create();
$completedAt = Date::parse('2026-07-26 12:34:56 UTC');

Onboarding::factory()->create([
'user_id' => $user,
'type' => OnboardingType::Welcome,
'status' => OnboardingStatus::Completed,
'completed_at' => $completedAt,
]);

expect(resolve(OnboardingCompletionGate::class)->completedAt($user, OnboardingType::Welcome))
->toEqual($completedAt);
});

test('the completion gate does not expose a timestamp for a non-completed onboarding', function (): void {
$user = User::factory()->create();

Onboarding::factory()->create([
'user_id' => $user,
'type' => OnboardingType::Welcome,
'status' => OnboardingStatus::InProgress,
'completed_at' => now(),
]);

expect(resolve(OnboardingCompletionGate::class)->completedAt($user, OnboardingType::Welcome))
->toBeNull();
});

test('the completion gate has no timestamp when the onboarding is missing', function (): void {
$user = User::factory()->create();

expect(resolve(OnboardingCompletionGate::class)->completedAt($user, OnboardingType::Welcome))
->toBeNull();
});