From 01785ed49416dad42597c9c46589794528dd7d7a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julien=20Fastr=C3=A9?= <julien.fastre@champs-libres.coop>
Date: Mon, 29 Jan 2024 12:13:23 +0100
Subject: [PATCH] Add ByStepAggregator to
 AccompanyingPeriodStepHistoryAggregators

Added a new ByStepAggregator to the AccompanyingPeriodStepHistoryAggregators, allowing to group status changes in the course by step. The corresponding test suite ensures the correct operation of this new class. Updates in the translations file have also been made as part of this addition.
---
 .../ByStepAggregator.php                      | 86 +++++++++++++++++++
 .../ByStepAggregatorTest.php                  | 58 +++++++++++++
 .../translations/messages.fr.yml              |  5 ++
 3 files changed, 149 insertions(+)
 create mode 100644 src/Bundle/ChillPersonBundle/Export/Aggregator/AccompanyingPeriodStepHistoryAggregators/ByStepAggregator.php
 create mode 100644 src/Bundle/ChillPersonBundle/Tests/Export/Aggregator/AccompanyingPeriodStepHistoryAggregators/ByStepAggregatorTest.php

diff --git a/src/Bundle/ChillPersonBundle/Export/Aggregator/AccompanyingPeriodStepHistoryAggregators/ByStepAggregator.php b/src/Bundle/ChillPersonBundle/Export/Aggregator/AccompanyingPeriodStepHistoryAggregators/ByStepAggregator.php
new file mode 100644
index 000000000..005d012f9
--- /dev/null
+++ b/src/Bundle/ChillPersonBundle/Export/Aggregator/AccompanyingPeriodStepHistoryAggregators/ByStepAggregator.php
@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\PersonBundle\Export\Aggregator\AccompanyingPeriodStepHistoryAggregators;
+
+use Chill\MainBundle\Export\AggregatorInterface;
+use Chill\PersonBundle\Export\Declarations;
+use Chill\PersonBundle\Tests\Export\Aggregator\AccompanyingPeriodStepHistoryAggregators\ByStepAggregatorTest;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+/**
+ * @see ByStepAggregatorTest
+ */
+final readonly class ByStepAggregator implements AggregatorInterface
+{
+    private const KEY = 'acpstephistory_step_agg';
+
+    public function __construct(
+        private TranslatorInterface $translator
+    ) {
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+        // nothing in this form
+    }
+
+    public function getFormDefaultData(): array
+    {
+        return [];
+    }
+
+    public function getLabels($key, array $values, mixed $data)
+    {
+        return function (?string $step): string {
+            if ('_header' === $step) {
+                return 'export.aggregator.step_history.by_step.header';
+            }
+
+            if (null === $step || '' === $step) {
+                return '';
+            }
+
+            return $this->translator->trans('accompanying_period.'.$step);
+        };
+    }
+
+    public function getQueryKeys($data)
+    {
+        return [
+            self::KEY,
+        ];
+    }
+
+    public function getTitle()
+    {
+        return 'export.aggregator.step_history.by_step.title';
+    }
+
+    public function addRole(): ?string
+    {
+        return null;
+    }
+
+    public function alterQuery(QueryBuilder $qb, $data)
+    {
+        $qb
+            ->addSelect('acpstephistory.step AS '.self::KEY)
+            ->addGroupBy(self::KEY);
+    }
+
+    public function applyOn()
+    {
+        return Declarations::ACP_STEP_HISTORY;
+    }
+}
diff --git a/src/Bundle/ChillPersonBundle/Tests/Export/Aggregator/AccompanyingPeriodStepHistoryAggregators/ByStepAggregatorTest.php b/src/Bundle/ChillPersonBundle/Tests/Export/Aggregator/AccompanyingPeriodStepHistoryAggregators/ByStepAggregatorTest.php
new file mode 100644
index 000000000..f71b06351
--- /dev/null
+++ b/src/Bundle/ChillPersonBundle/Tests/Export/Aggregator/AccompanyingPeriodStepHistoryAggregators/ByStepAggregatorTest.php
@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\PersonBundle\Tests\Export\Aggregator\AccompanyingPeriodStepHistoryAggregators;
+
+use Chill\MainBundle\Test\Export\AbstractAggregatorTest;
+use Chill\PersonBundle\Entity\AccompanyingPeriod\AccompanyingPeriodStepHistory;
+use Chill\PersonBundle\Export\Aggregator\AccompanyingPeriodStepHistoryAggregators\ByStepAggregator;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class ByStepAggregatorTest extends AbstractAggregatorTest
+{
+    public function getAggregator()
+    {
+        $translator = new class () implements TranslatorInterface {
+            public function trans(string $id, array $parameters = [], string $domain = null, string $locale = null)
+            {
+                return $id;
+            }
+        };
+
+        return new ByStepAggregator($translator);
+    }
+
+    public function getFormData()
+    {
+        return [[]];
+    }
+
+    public function getQueryBuilders()
+    {
+        self::bootKernel();
+        $em = self::$container->get(EntityManagerInterface::class);
+
+        $qb = $em->createQueryBuilder()
+            ->select('COUNT(DISTINCT acpstephistory.id) As export_result')
+            ->from(AccompanyingPeriodStepHistory::class, 'acpstephistory')
+            ->join('acpstephistory.period', 'acp');
+
+        return [
+            $qb,
+        ];
+    }
+}
diff --git a/src/Bundle/ChillPersonBundle/translations/messages.fr.yml b/src/Bundle/ChillPersonBundle/translations/messages.fr.yml
index e865cab76..8614a00db 100644
--- a/src/Bundle/ChillPersonBundle/translations/messages.fr.yml
+++ b/src/Bundle/ChillPersonBundle/translations/messages.fr.yml
@@ -1042,6 +1042,11 @@ export:
                 at_date: Date de calcul de l'adresse
                 header: Code postal
 
+        step_history:
+            by_step:
+                title: Grouper les changements de statut du parcours par étape
+                header: Nouveau statut du parcours
+
         course:
             by-user:
                 title: Grouper les parcours par usager participant