diff --git a/app/Http/Controllers/Api/V1/TimeEntryController.php b/app/Http/Controllers/Api/V1/TimeEntryController.php index 48a0e23e..3cfb25dc 100644 --- a/app/Http/Controllers/Api/V1/TimeEntryController.php +++ b/app/Http/Controllers/Api/V1/TimeEntryController.php @@ -428,6 +428,7 @@ class TimeEntryController extends Controller 'end' => $request->getEnd()->timezone($timezone), 'debug' => $debug, 'localization' => $localizationService, + 'showBillableRate' => $showBillableRate, ]); $footerViewFile = file_get_contents(resource_path('views/reports/time-entry-aggregate/pdf-footer.blade.php')); if ($footerViewFile === false) { @@ -456,7 +457,7 @@ class TimeEntryController extends Controller ->putFileAs($folderPath, new File($tempFolder->path($filenameTemp)), $filename); } else { Excel::store( - new TimeEntriesReportExport($aggregatedData, $format, $currency, $group, $subGroup), + new TimeEntriesReportExport($aggregatedData, $format, $currency, $group, $subGroup, $showBillableRate), $path, config('filesystems.private'), $format->getExportPackageType(), diff --git a/app/Http/Requests/V1/BaseFormRequest.php b/app/Http/Requests/V1/BaseFormRequest.php index 9a02db66..d68459a3 100644 --- a/app/Http/Requests/V1/BaseFormRequest.php +++ b/app/Http/Requests/V1/BaseFormRequest.php @@ -8,9 +8,7 @@ use Illuminate\Foundation\Http\FormRequest; class BaseFormRequest extends FormRequest { - /** - * @param bool $bigInt * @return list */ protected function moneyRules(bool $bigInt = false): array diff --git a/app/Service/ReportExport/TimeEntriesReportExport.php b/app/Service/ReportExport/TimeEntriesReportExport.php index f22e164a..5b6f3048 100644 --- a/app/Service/ReportExport/TimeEntriesReportExport.php +++ b/app/Service/ReportExport/TimeEntriesReportExport.php @@ -46,6 +46,8 @@ class TimeEntriesReportExport implements FromView, ShouldAutoSize, WithCustomCsv private TimeEntryAggregationType $subGroup; + private bool $showBillableRate; + /** * @param array{ * grouped_type: string|null, @@ -66,13 +68,14 @@ class TimeEntriesReportExport implements FromView, ShouldAutoSize, WithCustomCsv * cost: int|null * } $data */ - public function __construct(array $data, ExportFormat $exportFormat, string $currency, TimeEntryAggregationType $group, TimeEntryAggregationType $subGroup) + public function __construct(array $data, ExportFormat $exportFormat, string $currency, TimeEntryAggregationType $group, TimeEntryAggregationType $subGroup, bool $showBillableRate) { $this->data = $data; $this->exportFormat = $exportFormat; $this->currency = $currency; $this->group = $group; $this->subGroup = $subGroup; + $this->showBillableRate = $showBillableRate; } public function view(): View @@ -83,6 +86,7 @@ class TimeEntriesReportExport implements FromView, ShouldAutoSize, WithCustomCsv 'group' => $this->group, 'subGroup' => $this->subGroup, 'exportFormat' => $this->exportFormat, + 'showBillableRate' => $this->showBillableRate, ]); } diff --git a/resources/views/reports/time-entry-aggregate/pdf.blade.php b/resources/views/reports/time-entry-aggregate/pdf.blade.php index 11e9e2e6..c8f0c1d2 100644 --- a/resources/views/reports/time-entry-aggregate/pdf.blade.php +++ b/resources/views/reports/time-entry-aggregate/pdf.blade.php @@ -152,12 +152,13 @@
{{ $localization->formatInterval(CarbonInterval::seconds($aggregatedData['seconds'])) }}
+ @if($showBillableRate)
Total cost
{{ $localization->formatCurrency(Money::of(BigDecimal::ofUnscaledValue($aggregatedData['cost'], 2)->__toString(), $currency)) }}
- + @endif
@@ -177,7 +178,9 @@ {{ $group->description() }} Duration + @if($showBillableRate) Cost + @endif @foreach($aggregatedData['grouped_data'] as $group1Entry) @@ -188,23 +191,21 @@ }};"> - @if($group->is(\App\Enums\TimeEntryAggregationType::Billable)) {{ $group1Entry['key'] === '1' ? 'Billable' : 'Non-billable' }} @else {{ $group1Entry['description'] ?? $group1Entry['key'] ?? 'No '.Str::lower($group->description()) }} @endif - - - + {{ $localization->formatInterval(CarbonInterval::seconds($group1Entry['seconds'])) }} + @if($showBillableRate) {{ $localization->formatCurrency(Money::of(BigDecimal::ofUnscaledValue($group1Entry['cost'], 2)->__toString(), $currency)) }} - + @endif @endforeach @@ -215,9 +216,11 @@ {{ $localization->formatInterval(CarbonInterval::seconds($aggregatedData['seconds'])) }} + @if($showBillableRate) {{ $localization->formatCurrency(Money::of(BigDecimal::ofUnscaledValue($aggregatedData['cost'], 2)->__toString(), $currency)) }} + @endif @@ -253,9 +256,11 @@ Duration (h) + @if($showBillableRate) Cost + @endif @@ -282,13 +287,17 @@ {{ $localization->formatNumber($duration->totalHours) }} + @if($showBillableRate) {{ $localization->formatCurrency(Money::of(BigDecimal::ofUnscaledValue($group2Entry['cost'], 2)->__toString(), $currency)) }} + @endif @php $totalDuration += $group2Entry['seconds']; - $totalCost += $group2Entry['cost']; + if ($showBillableRate) { + $totalCost += $group2Entry['cost']; + } @endphp @endforeach diff --git a/resources/views/reports/time-entry-aggregate/spreadsheet.blade.php b/resources/views/reports/time-entry-aggregate/spreadsheet.blade.php index e31478ae..18e152ca 100644 --- a/resources/views/reports/time-entry-aggregate/spreadsheet.blade.php +++ b/resources/views/reports/time-entry-aggregate/spreadsheet.blade.php @@ -62,9 +62,11 @@ {{ round($duration->totalHours, 2) }} + @if($showBillableRate) {{ round(BigDecimal::ofUnscaledValue($group2Entry['cost'], 2)->toFloat(), 2) }} + @endif @else @if ($group === TimeEntryAggregationType::Billable) @@ -92,16 +94,20 @@ data-format="{{ NumberFormat::FORMAT_NUMBER_00 }}"> {{ $duration->totalHours }} + @if($showBillableRate) {{ BigDecimal::ofUnscaledValue($group2Entry['cost'], 2)->__toString() }} + @endif @endif @php ++$counter; $totalDuration += $group2Entry['seconds']; - $totalCost += $group2Entry['cost']; + if ($showBillableRate) { + $totalCost += $group2Entry['cost']; + } @endphp @endforeach @endforeach @@ -120,9 +126,11 @@ {{ round($totalDurationInterval->totalHours, 2) }} + @if($showBillableRate) {{ round(BigDecimal::ofUnscaledValue($totalCost, 2)->toFloat(), 2) }} + @endif @else diff --git a/tests/TestCaseWithDatabase.php b/tests/TestCaseWithDatabase.php index e252ad2f..1929c2d9 100644 --- a/tests/TestCaseWithDatabase.php +++ b/tests/TestCaseWithDatabase.php @@ -56,10 +56,12 @@ abstract class TestCaseWithDatabase extends TestCase /** * @return object{user: User, organization: Organization, member: Member, owner: User, ownerMember: Member} */ - public function createUserWithRole(Role $role): object + public function createUserWithRole(Role $role, bool $employeesCanSeeBillableRates = false): object { $owner = User::factory()->create(); - $organization = Organization::factory()->withOwner($owner)->create(); + $organization = Organization::factory()->withOwner($owner)->create([ + 'employees_can_see_billable_rates' => $employeesCanSeeBillableRates, + ]); $ownerMember = Member::factory()->forUser($owner)->forOrganization($organization)->role(Role::Owner)->create(); $owner->currentOrganization()->associate($organization); $owner->save(); diff --git a/tests/Unit/Endpoint/Api/V1/TimeEntryEndpointTest.php b/tests/Unit/Endpoint/Api/V1/TimeEntryEndpointTest.php index 22b8773b..d1b1acd6 100644 --- a/tests/Unit/Endpoint/Api/V1/TimeEntryEndpointTest.php +++ b/tests/Unit/Endpoint/Api/V1/TimeEntryEndpointTest.php @@ -815,6 +815,58 @@ class TimeEntryEndpointTest extends ApiEndpointTestAbstract $this->assertResponseCode($response, 200); } + public function test_aggregate_export_endpoints_can_create_a_csv_report_as_employee_role_with_show_billable_rate(): void + { + // Arrange + $data = $this->createUserWithRole(Role::Employee, true); + $client = Client::factory()->forOrganization($data->organization)->create(); + $project = Project::factory()->forOrganization($data->organization)->forClient($client)->create(); + $timeEntry1 = TimeEntry::factory()->forOrganization($data->organization)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + $timeEntry2 = TimeEntry::factory()->forOrganization($data->organization)->forProject($project)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + Passport::actingAs($data->user); + + // Act + $response = $this->getJson(route('api.v1.time-entries.aggregate-export', [ + $data->organization->getKey(), + 'format' => ExportFormat::CSV, + 'group' => TimeEntryAggregationType::Client, + 'sub_group' => TimeEntryAggregationType::Project, + 'history_group' => TimeEntryAggregationTypeInterval::Month, + 'start' => Carbon::now()->startOfYear()->toIso8601ZuluString(), + 'end' => Carbon::now()->endOfYear()->toIso8601ZuluString(), + 'member_id' => $data->member->getKey(), + ])); + + // Assert + $this->assertResponseCode($response, 200); + } + + public function test_aggregate_export_endpoints_can_create_a_csv_report_as_employee_role_without_show_billable_rate(): void + { + // Arrange + $data = $this->createUserWithRole(Role::Employee, false); + $client = Client::factory()->forOrganization($data->organization)->create(); + $project = Project::factory()->forOrganization($data->organization)->forClient($client)->create(); + $timeEntry1 = TimeEntry::factory()->forOrganization($data->organization)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + $timeEntry2 = TimeEntry::factory()->forOrganization($data->organization)->forProject($project)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + Passport::actingAs($data->user); + + // Act + $response = $this->getJson(route('api.v1.time-entries.aggregate-export', [ + $data->organization->getKey(), + 'format' => ExportFormat::CSV, + 'group' => TimeEntryAggregationType::Client, + 'sub_group' => TimeEntryAggregationType::Project, + 'history_group' => TimeEntryAggregationTypeInterval::Month, + 'start' => Carbon::now()->startOfYear()->toIso8601ZuluString(), + 'end' => Carbon::now()->endOfYear()->toIso8601ZuluString(), + 'member_id' => $data->member->getKey(), + ])); + + // Assert + $this->assertResponseCode($response, 200); + } + public function test_aggregate_export_endpoints_can_create_a_xlsx_report(): void { // Arrange @@ -842,6 +894,58 @@ class TimeEntryEndpointTest extends ApiEndpointTestAbstract $this->assertResponseCode($response, 200); } + public function test_aggregate_export_endpoints_can_create_a_xlsx_report_as_employee_role_with_show_billable_rate(): void + { + // Arrange + $data = $this->createUserWithRole(Role::Employee, true); + $client = Client::factory()->forOrganization($data->organization)->create(); + $project = Project::factory()->forOrganization($data->organization)->forClient($client)->create(); + $timeEntry1 = TimeEntry::factory()->forOrganization($data->organization)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + $timeEntry2 = TimeEntry::factory()->forOrganization($data->organization)->forProject($project)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + Passport::actingAs($data->user); + + // Act + $response = $this->getJson(route('api.v1.time-entries.aggregate-export', [ + $data->organization->getKey(), + 'format' => ExportFormat::XLSX, + 'group' => TimeEntryAggregationType::Client, + 'sub_group' => TimeEntryAggregationType::Project, + 'history_group' => TimeEntryAggregationTypeInterval::Month, + 'start' => Carbon::now()->startOfYear()->toIso8601ZuluString(), + 'end' => Carbon::now()->endOfYear()->toIso8601ZuluString(), + 'member_id' => $data->member->getKey(), + ])); + + // Assert + $this->assertResponseCode($response, 200); + } + + public function test_aggregate_export_endpoints_can_create_a_xlsx_report_as_employee_role_without_show_billable_rate(): void + { + // Arrange + $data = $this->createUserWithRole(Role::Employee, false); + $client = Client::factory()->forOrganization($data->organization)->create(); + $project = Project::factory()->forOrganization($data->organization)->forClient($client)->create(); + $timeEntry1 = TimeEntry::factory()->forOrganization($data->organization)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + $timeEntry2 = TimeEntry::factory()->forOrganization($data->organization)->forProject($project)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + Passport::actingAs($data->user); + + // Act + $response = $this->getJson(route('api.v1.time-entries.aggregate-export', [ + $data->organization->getKey(), + 'format' => ExportFormat::XLSX, + 'group' => TimeEntryAggregationType::Client, + 'sub_group' => TimeEntryAggregationType::Project, + 'history_group' => TimeEntryAggregationTypeInterval::Month, + 'start' => Carbon::now()->startOfYear()->toIso8601ZuluString(), + 'end' => Carbon::now()->endOfYear()->toIso8601ZuluString(), + 'member_id' => $data->member->getKey(), + ])); + + // Assert + $this->assertResponseCode($response, 200); + } + public function test_aggregate_export_endpoints_can_create_a_ods_report(): void { // Arrange @@ -869,6 +973,58 @@ class TimeEntryEndpointTest extends ApiEndpointTestAbstract $this->assertResponseCode($response, 200); } + public function test_aggregate_export_endpoints_can_create_a_ods_report_as_employee_role_with_show_billable_rate(): void + { + // Arrange + $data = $this->createUserWithRole(Role::Employee, true); + $client = Client::factory()->forOrganization($data->organization)->create(); + $project = Project::factory()->forOrganization($data->organization)->forClient($client)->create(); + $timeEntry1 = TimeEntry::factory()->forOrganization($data->organization)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + $timeEntry2 = TimeEntry::factory()->forOrganization($data->organization)->forProject($project)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + Passport::actingAs($data->user); + + // Act + $response = $this->getJson(route('api.v1.time-entries.aggregate-export', [ + $data->organization->getKey(), + 'format' => ExportFormat::ODS, + 'group' => TimeEntryAggregationType::User, + 'sub_group' => TimeEntryAggregationType::Project, + 'history_group' => TimeEntryAggregationTypeInterval::Month, + 'start' => Carbon::now()->startOfYear()->toIso8601ZuluString(), + 'end' => Carbon::now()->endOfYear()->toIso8601ZuluString(), + 'member_id' => $data->member->getKey(), + ])); + + // Assert + $this->assertResponseCode($response, 200); + } + + public function test_aggregate_export_endpoints_can_create_a_ods_report_as_employee_role_without_show_billable_rate(): void + { + // Arrange + $data = $this->createUserWithRole(Role::Employee, false); + $client = Client::factory()->forOrganization($data->organization)->create(); + $project = Project::factory()->forOrganization($data->organization)->forClient($client)->create(); + $timeEntry1 = TimeEntry::factory()->forOrganization($data->organization)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + $timeEntry2 = TimeEntry::factory()->forOrganization($data->organization)->forProject($project)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + Passport::actingAs($data->user); + + // Act + $response = $this->getJson(route('api.v1.time-entries.aggregate-export', [ + $data->organization->getKey(), + 'format' => ExportFormat::ODS, + 'group' => TimeEntryAggregationType::User, + 'sub_group' => TimeEntryAggregationType::Project, + 'history_group' => TimeEntryAggregationTypeInterval::Month, + 'start' => Carbon::now()->startOfYear()->toIso8601ZuluString(), + 'end' => Carbon::now()->endOfYear()->toIso8601ZuluString(), + 'member_id' => $data->member->getKey(), + ])); + + // Assert + $this->assertResponseCode($response, 200); + } + public function test_aggregate_export_endpoint_fails_if_pdf_renderer_is_not_configured_but_a_user_want_a_pdf_report(): void { // Arrange @@ -927,6 +1083,60 @@ class TimeEntryEndpointTest extends ApiEndpointTestAbstract $this->assertResponseCode($response, 200); } + public function test_aggregate_export_endpoints_can_create_a_pdf_report_as_employee_role_with_show_billable_rate(): void + { + // Arrange + $data = $this->createUserWithRole(Role::Employee, true); + $client = Client::factory()->forOrganization($data->organization)->create(); + $project = Project::factory()->forOrganization($data->organization)->forClient($client)->create(); + $timeEntry1 = TimeEntry::factory()->forOrganization($data->organization)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + $timeEntry2 = TimeEntry::factory()->forOrganization($data->organization)->forProject($project)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + Passport::actingAs($data->user); + $this->actAsOrganizationWithSubscription(); + + // Act + $response = $this->getJson(route('api.v1.time-entries.aggregate-export', [ + $data->organization->getKey(), + 'format' => ExportFormat::PDF, + 'group' => TimeEntryAggregationType::User, + 'sub_group' => TimeEntryAggregationType::Project, + 'history_group' => TimeEntryAggregationTypeInterval::Month, + 'start' => Carbon::now()->startOfYear()->toIso8601ZuluString(), + 'end' => Carbon::now()->endOfYear()->toIso8601ZuluString(), + 'member_id' => $data->member->getKey(), + ])); + + // Assert + $this->assertResponseCode($response, 200); + } + + public function test_aggregate_export_endpoints_can_create_a_pdf_report_as_employee_role_without_show_billable_rate(): void + { + // Arrange + $data = $this->createUserWithRole(Role::Employee, false); + $client = Client::factory()->forOrganization($data->organization)->create(); + $project = Project::factory()->forOrganization($data->organization)->forClient($client)->create(); + $timeEntry1 = TimeEntry::factory()->forOrganization($data->organization)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + $timeEntry2 = TimeEntry::factory()->forOrganization($data->organization)->forProject($project)->forMember($data->member)->startWithDuration(Carbon::now(), 100)->create(); + Passport::actingAs($data->user); + $this->actAsOrganizationWithSubscription(); + + // Act + $response = $this->getJson(route('api.v1.time-entries.aggregate-export', [ + $data->organization->getKey(), + 'format' => ExportFormat::PDF, + 'group' => TimeEntryAggregationType::User, + 'sub_group' => TimeEntryAggregationType::Project, + 'history_group' => TimeEntryAggregationTypeInterval::Month, + 'start' => Carbon::now()->startOfYear()->toIso8601ZuluString(), + 'end' => Carbon::now()->endOfYear()->toIso8601ZuluString(), + 'member_id' => $data->member->getKey(), + ])); + + // Assert + $this->assertResponseCode($response, 200); + } + public function test_aggregate_endpoint_fails_if_user_has_only_access_to_own_time_entries_but_does_not_filter_for_this(): void { // Arrange