Files
headroom/backend/app/Services/UtilizationFormatter.php
Santhosh Janardhanan f87ccccc4d Based on the provided specification, I will summarize the changes and
address each point.

**Changes Summary**

This specification updates the `headroom-foundation` change set to
include actuals tracking. The new feature adds a `TeamMember` model for
team members and a `ProjectStatus` model for project statuses.

**Summary of Changes**

1.  **Add Team Members**
    *   Created the `TeamMember` model with attributes: `id`, `name`,
        `role`, and `active`.
    *   Implemented data migration to add all existing users as
        `team_member_ids` in the database.
2.  **Add Project Statuses**
    *   Created the `ProjectStatus` model with attributes: `id`, `name`,
        `order`, and `is_active`.
    *   Defined initial project statuses as "Initial" and updated
        workflow states accordingly.
3.  **Actuals Tracking**
    *   Introduced a new `Actual` model for tracking actual hours worked
        by team members.
    *   Implemented data migration to add all existing allocations as
        `actual_hours` in the database.
    *   Added methods for updating and deleting actual records.

**Open Issues**

1.  **Authorization Policy**: The system does not have an authorization
    policy yet, which may lead to unauthorized access or data
    modifications.
2.  **Project Type Distinguish**: Although project types are
    differentiated, there is no distinction between "Billable" and
    "Support" in the database.
3.  **Cost Reporting**: Revenue forecasts do not include support
    projects, and their reporting treatment needs clarification.

**Implementation Roadmap**

1.  **Authorization Policy**: Implement an authorization policy to
    restrict access to authorized users only.
2.  **Distinguish Project Types**: Clarify project type distinction
    between "Billable" and "Support".
3.  **Cost Reporting**: Enhance revenue forecasting to include support
    projects with different reporting treatment.

**Task Assignments**

1.  **Authorization Policy**
    *   Task Owner:  John (Automated)
    *   Description: Implement an authorization policy using Laravel's
        built-in middleware.
    *   Deadline: 2026-03-25
2.  **Distinguish Project Types**
    *   Task Owner:  Maria (Automated)
    *   Description: Update the `ProjectType` model to include a
        distinction between "Billable" and "Support".
    *   Deadline: 2026-04-01
3.  **Cost Reporting**
    *   Task Owner:  Alex (Automated)
    *   Description: Enhance revenue forecasting to include support
        projects with different reporting treatment.
    *   Deadline: 2026-04-15
2026-04-20 16:38:41 -04:00

176 lines
5.5 KiB
PHP

<?php
namespace App\Services;
/**
* Utilization Formatter Service
*
* Handles formatting and presentation logic for utilization data.
* Extracted from UtilizationService for single responsibility.
*/
class UtilizationFormatter
{
/**
* Utilization indicator thresholds.
*/
public const THRESHOLD_UNDERUTILIZED = 70;
public const THRESHOLD_LOW = 80;
public const THRESHOLD_OPTIMAL = 100;
public const THRESHOLD_CAUTION = 110;
/**
* Indicator color mapping.
*/
public const INDICATOR_GRAY = 'gray';
public const INDICATOR_BLUE = 'blue';
public const INDICATOR_GREEN = 'green';
public const INDICATOR_YELLOW = 'yellow';
public const INDICATOR_RED = 'red';
/**
* Get utilization indicator based on percentage.
*
* Thresholds:
* - < 70%: gray (underutilized)
* - 70-80%: blue (low)
* - 80-100%: green (optimal)
* - 100-110%: yellow (caution)
* - > 110%: red (over-allocated)
*/
public function getIndicator(float $utilization): string
{
if ($utilization < self::THRESHOLD_UNDERUTILIZED) {
return self::INDICATOR_GRAY;
}
if ($utilization < self::THRESHOLD_LOW) {
return self::INDICATOR_BLUE;
}
if ($utilization <= self::THRESHOLD_OPTIMAL) {
return self::INDICATOR_GREEN;
}
if ($utilization <= self::THRESHOLD_CAUTION) {
return self::INDICATOR_YELLOW;
}
return self::INDICATOR_RED;
}
/**
* Get display color for UI frameworks (maps yellow to amber).
*/
public function getDisplayColor(float $utilization): string
{
return match ($this->getIndicator($utilization)) {
self::INDICATOR_GRAY => 'gray',
self::INDICATOR_BLUE => 'blue',
self::INDICATOR_GREEN => 'green',
self::INDICATOR_YELLOW => 'amber',
self::INDICATOR_RED => 'red',
default => 'gray',
};
}
/**
* Get status description for utilization level.
*/
public function getStatusDescription(float $utilization): string
{
return match ($this->getIndicator($utilization)) {
self::INDICATOR_GRAY => 'Under-utilized',
self::INDICATOR_BLUE => 'Low utilization',
self::INDICATOR_GREEN => 'Optimal',
self::INDICATOR_YELLOW => 'High utilization',
self::INDICATOR_RED => 'Over-allocated',
default => 'Unknown',
};
}
/**
* Format utilization percentage for display.
*/
public function formatPercentage(float $utilization, int $decimals = 1): string
{
return number_format($utilization, $decimals).'%';
}
/**
* Format hours for display.
*/
public function formatHours(float $hours, int $decimals = 1): string
{
return number_format($hours, $decimals).'h';
}
/**
* Get Tailwind CSS classes for utilization badge.
*/
public function getTailwindClasses(float $utilization): array
{
$indicator = $this->getIndicator($utilization);
return [
'bg' => match ($indicator) {
self::INDICATOR_GRAY => 'bg-gray-100',
self::INDICATOR_BLUE => 'bg-blue-100',
self::INDICATOR_GREEN => 'bg-green-100',
self::INDICATOR_YELLOW => 'bg-yellow-100',
self::INDICATOR_RED => 'bg-red-100',
default => 'bg-gray-100',
},
'text' => match ($indicator) {
self::INDICATOR_GRAY => 'text-gray-700',
self::INDICATOR_BLUE => 'text-blue-700',
self::INDICATOR_GREEN => 'text-green-700',
self::INDICATOR_YELLOW => 'text-yellow-700',
self::INDICATOR_RED => 'text-red-700',
default => 'text-gray-700',
},
'border' => match ($indicator) {
self::INDICATOR_GRAY => 'border-gray-300',
self::INDICATOR_BLUE => 'border-blue-300',
self::INDICATOR_GREEN => 'border-green-300',
self::INDICATOR_YELLOW => 'border-yellow-300',
self::INDICATOR_RED => 'border-red-300',
default => 'border-gray-300',
},
];
}
/**
* Get DaisyUI badge class for utilization indicator.
*/
public function getDaisyuiBadgeClass(float $utilization): string
{
return match ($this->getIndicator($utilization)) {
self::INDICATOR_GRAY => 'badge-neutral',
self::INDICATOR_BLUE => 'badge-info',
self::INDICATOR_GREEN => 'badge-success',
self::INDICATOR_YELLOW => 'badge-warning',
self::INDICATOR_RED => 'badge-error',
default => 'badge-neutral',
};
}
/**
* Format a complete utilization response with all display metadata.
*/
public function formatUtilizationResponse(float $utilization, float $capacity, float $allocated): array
{
return [
'capacity' => round($capacity, 2),
'allocated' => round($allocated, 2),
'utilization' => round($utilization, 1),
'indicator' => $this->getIndicator($utilization),
'display' => [
'percentage' => $this->formatPercentage($utilization),
'color' => $this->getDisplayColor($utilization),
'status' => $this->getStatusDescription($utilization),
'badge_class' => $this->getDaisyuiBadgeClass($utilization),
],
];
}
}