2617: Project forecast report

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+* [PR-175](https://github.com/itk-dev/economics/pull/175)
+  2617: Added forecast report.
 * [PR-173](https://github.com/itk-dev/economics/pull/173)
   2663: Workload report loading speed improvement.
 * [PR-167](https://github.com/itk-dev/economics/pull/167)

reports.md

@@ -0,0 +1,33 @@
+# Reports in Economics
+
+Overview of the various reports found in Economics.
+
+## Reports
+
+### Sprint rapport
+
+This report offers an overview of a project with its name, version, and work hours. It details hours
+spent and remaining. If applicable, project budget details are included. The report shows tables with
+work hours breakdown for each task in current and future sprints. Thus, giving a view of project progress.
+
+### Ledelsesrapport
+
+This financial report provides an itemized overview of an organization's invoices by year and
+quarter. It offers yearly totals and individual quarter breakdowns. There's functionality to export
+data. The report timeframe can be adjusted, aiding comprehensive financial analysis.
+
+### Forecast rapport
+
+This report presents invoiced and recorded work hours for each project and its issues. A
+hierarchical view for clarity is available. It indicates unbilled hours and provides an overall total.
+
+### Timerapport
+
+This report offers an overview of estimated and logged work hours grouped by project tags. Each tag
+represents a project and the detailed hours per ticket. The report concludes with totals.
+
+### Normtidsrapport
+
+This workforce report provides a detailed breakdown of individual workloads over different
+periods. It presents each worker's total workload and specific contribution percentages each period.
+The report also includes an average workload percentage.

src/Controller/ForecastReportController.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace App\Controller;
+
+use App\Form\ForecastReportType;
+use App\Model\Reports\ForecastReportFormData;
+use App\Service\ForecastReportService;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Security\Http\Attribute\IsGranted;
+
+#[Route('/admin/reports/forecast_report')]
+#[IsGranted('ROLE_REPORT')]
+class ForecastReportController extends AbstractController
+{
+    public function __construct(
+        private readonly ForecastReportService $forecastReportService,
+    ) {
+    }
+
+    /**
+     * @throws \Exception
+     */
+    #[Route('/', name: 'app_forecast_report')]
+    public function index(Request $request): Response
+    {
+        $reportData = null;
+        $error = null;
+        $mode = 'forecast_report';
+        $reportFormData = new ForecastReportFormData();
+
+        $form = $this->createForm(ForecastReportType::class, $reportFormData, [
+            'action' => $this->generateUrl('app_forecast_report'),
+            'method' => 'GET',
+            'attr' => [
+                'id' => 'sprint_report',
+            ],
+            'csrf_protection' => false,
+        ]);
+
+        $form->handleRequest($request);
+
+        if ($form->isSubmitted() && $form->isValid()) {
+            $fromDate = $form->get('dateFrom')->getData();
+            $toDate = $form->get('dateTo')->getData();
+
+            $reportData = $this->forecastReportService->getForecastReport($fromDate, $toDate);
+        }
+
+        return $this->render('reports/reports.html.twig', [
+            'controller_name' => 'ForecastReportController',
+            'form' => $form,
+            'error' => $error,
+            'data' => $reportData,
+            'mode' => $mode,
+        ]);
+    }
+}

src/Form/ForecastReportType.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace App\Form;
+
+use App\Model\Reports\ForecastReportFormData;
+use App\Service\ForecastReportService;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\DateType;
+use Symfony\Component\Form\Extension\Core\Type\SubmitType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class ForecastReportType extends AbstractType
+{
+    public function __construct(
+        private readonly ForecastReportService $forecastReportService,
+    ) {
+    }
+
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $builder
+            ->add('dateFrom', DateType::class, [
+                'widget' => 'single_text',
+                'input' => 'datetime',
+                'required' => false,
+                'label' => 'hour_report.from_date',
+                'label_attr' => ['class' => 'label'],
+                'by_reference' => true,
+                'data' => $options['fromDate'] ?? $this->forecastReportService->getDefaultFromDate(),
+                'attr' => [
+                    'class' => 'form-element',
+                ],
+            ])
+            ->add('dateTo', DateType::class, [
+                'widget' => 'single_text',
+                'input' => 'datetime',
+                'required' => false,
+                'label' => 'hour_report.to_date',
+                'label_attr' => ['class' => 'label'],
+                'data' => $options['fromDate'] ?? $this->forecastReportService->getDefaultToDate(),
+                'by_reference' => true,
+                'attr' => [
+                    'class' => 'form-element',
+                ],
+            ])
+            ->add('submit', SubmitType::class, [
+                'label' => 'workload_report.submit',
+                'attr' => [
+                    'class' => 'hour-report-submit button',
+                ],
+            ]
+            );
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'data_class' => ForecastReportFormData::class,
+            'attr' => [
+                'data-sprint-report-target' => 'form',
+            ],
+        ]);
+    }
+}

src/Model/Reports/ForecastReportData.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Model\Reports;
+
+use Doctrine\Common\Collections\ArrayCollection;
+
+class ForecastReportData
+{
+    public float $totalInvoiced = 0;
+    public float $totalInvoicedAndRecorded = 0;
+    /** @var ArrayCollection<string, ForecastReportProjectData> */
+    public ArrayCollection $projects;
+
+    public function __construct()
+    {
+        $this->projects = new ArrayCollection();
+    }
+}

src/Model/Reports/ForecastReportFormData.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace App\Model\Reports;
+
+class ForecastReportFormData
+{
+    public \DateTimeInterface $dateFrom;
+    public \DateTimeInterface $dateTo;
+}

src/Model/Reports/ForecastReportIssueData.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Model\Reports;
+
+class ForecastReportIssueData
+{
+    public string $issueId;
+    public string $issueTag;
+    public string $issueLink;
+    public float $invoiced = 0.0;
+    public float $invoicedAndRecorded = 0.0;
+    /** @var array<string, ForecastReportIssueVersionData> */
+    public array $versions = [];
+
+    public function __construct(string $issueTag)
+    {
+        $this->issueTag = $issueTag;
+    }
+}

src/Model/Reports/ForecastReportIssueVersionData.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Model\Reports;
+
+class ForecastReportIssueVersionData
+{
+    public string $issueVersion;
+    public string $issueVersionIdentifier;
+    public float $invoiced = 0.0;
+    public float $invoicedAndRecorded = 0.0;
+    /** @var array<string, ForecastReportWorklogData> */
+    public array $worklogs = [];
+
+    public function __construct(string $issueVersion)
+    {
+        $this->issueVersion = $issueVersion;
+    }
+}

src/Model/Reports/ForecastReportProjectData.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Model\Reports;
+
+class ForecastReportProjectData
+{
+    public string $projectId;
+    public string $projectName;
+    public float $invoiced = 0.0;
+    public float $invoicedAndRecorded = 0.0;
+    /** @var array<string, ForecastReportIssueData> */
+    public array $issues = [];
+
+    public function __construct(string $projectId)
+    {
+        $this->projectId = $projectId;
+    }
+}

src/Model/Reports/ForecastReportWorklogData.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Model\Reports;
+
+class ForecastReportWorklogData
+{
+    public string $description;
+    public string $worker;
+    public float $invoiced = 0.0;
+    public float $invoicedAndRecorded = 0.0;
+
+    /**
+     * @param $worklogId
+     * @param $description
+     */
+    public function __construct($worklogId, $description)
+    {
+    }
+}

src/Repository/WorklogRepository.php

@@ -9,6 +9,7 @@
 use App\Enum\BillableKindsEnum;
 use App\Model\Invoices\InvoiceEntryWorklogsFilterData;
 use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+use Doctrine\ORM\Tools\Pagination\Paginator;
 use Doctrine\Persistence\ManagerRegistry;
 
 /**
@@ -133,4 +134,37 @@ public function findBillableWorklogsByWorkerAndDateRange(string $workerIdentifie
             ])
             ->getQuery()->getResult();
     }
+
+    /**
+     * @throws \Exception
+     */
+    public function getWorklogsAttachedToInvoiceInDateRange(\DateTimeInterface $periodStart, \DateTimeInterface $periodEnd, int $page = 1, int $pageSize = 50): array
+    {
+        $from = new \DateTimeImmutable($periodStart->format('Y-m-d').' 00:00:00');
+        $to = new \DateTimeImmutable($periodEnd->format('Y-m-d').' 23:59:59');
+
+        $query = $this->createQueryBuilder('worklog')
+            ->leftJoin(Issue::class, 'issue', 'WITH', 'worklog.issue = issue.id')
+            ->leftJoin(Project::class, 'project', 'WITH', 'issue.project = project.id')
+            ->where('worklog.invoiceEntry IS NOT NULL')
+            ->andWhere('worklog.started BETWEEN :from AND :to')
+            ->setParameter('from', $from)
+            ->setParameter('to', $to)
+            ->getQuery()
+            ->setFirstResult(($page - 1) * $pageSize)
+            ->setMaxResults($pageSize);
+
+        $paginator = new Paginator($query, true);
+
+        $totalItemCount = count($paginator);
+        $pagesCount = ceil($totalItemCount / $pageSize);
+
+        return [
+            'total_count' => $totalItemCount,
+            'pages_count' => $pagesCount,
+            'current_page' => $page,
+            'page_size' => $pageSize,
+            'paginator' => $paginator,
+        ];
+    }
 }