TenantAtlas/app/Models/EvidenceSnapshot.php

<?php

declare(strict_types=1);

namespace App\Models;

use App\Support\Concerns\DerivesWorkspaceIdFromTenant;
use App\Support\Evidence\EvidenceCompletenessState;
use App\Support\Evidence\EvidenceSnapshotStatus;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;

class EvidenceSnapshot extends Model
{
    use DerivesWorkspaceIdFromTenant;
    use HasFactory;

    protected $guarded = [];

    /**
     * @return array<string, string>
     */
    protected function casts(): array
    {
        return [
            'summary' => 'array',
            'generated_at' => 'datetime',
            'expires_at' => 'datetime',
        ];
    }

    /**
     * @return BelongsTo<Workspace, $this>
     */
    public function workspace(): BelongsTo
    {
        return $this->belongsTo(Workspace::class);
    }

    /**
     * @return BelongsTo<Tenant, $this>
     */
    public function tenant(): BelongsTo
    {
        return $this->belongsTo(Tenant::class);
    }

    /**
     * @return BelongsTo<OperationRun, $this>
     */
    public function operationRun(): BelongsTo
    {
        return $this->belongsTo(OperationRun::class);
    }

    /**
     * @return BelongsTo<User, $this>
     */
    public function initiator(): BelongsTo
    {
        return $this->belongsTo(User::class, 'initiated_by_user_id');
    }

    /**
     * @return HasMany<EvidenceSnapshotItem, $this>
     */
    public function items(): HasMany
    {
        return $this->hasMany(EvidenceSnapshotItem::class)->orderBy('sort_order')->orderBy('id');
    }

    /**
     * @return HasMany<ReviewPack, $this>
     */
    public function reviewPacks(): HasMany
    {
        return $this->hasMany(ReviewPack::class);
    }

    /**
     * @return HasMany<TenantReview, $this>
     */
    public function tenantReviews(): HasMany
    {
        return $this->hasMany(TenantReview::class);
    }

    /**
     * @param  Builder<self>  $query
     * @return Builder<self>
     */
    public function scopeForTenant(Builder $query, int $tenantId): Builder
    {
        return $query->where('tenant_id', $tenantId);
    }

    /**
     * @param  Builder<self>  $query
     * @return Builder<self>
     */
    public function scopeActive(Builder $query): Builder
    {
        return $query->where('status', EvidenceSnapshotStatus::Active->value);
    }

    /**
     * @param  Builder<self>  $query
     * @return Builder<self>
     */
    public function scopeCurrent(Builder $query): Builder
    {
        return $query
            ->whereIn('status', [
                EvidenceSnapshotStatus::Queued->value,
                EvidenceSnapshotStatus::Generating->value,
                EvidenceSnapshotStatus::Active->value,
            ]);
    }

    public function isCurrent(): bool
    {
        return in_array((string) $this->status, [
            EvidenceSnapshotStatus::Queued->value,
            EvidenceSnapshotStatus::Generating->value,
            EvidenceSnapshotStatus::Active->value,
        ], true);
    }

    public function completenessState(): EvidenceCompletenessState
    {
        return EvidenceCompletenessState::tryFrom((string) $this->completeness_state)
            ?? EvidenceCompletenessState::Missing;
    }
}