feat: added erru request to applied penalties (#674)

* feat: added erru request to applied penalties * feat: updated create and update tests for applied penalties * fix: made changes to address PR feedback * fix: fixed broken tests * fix: changes to address PR comments * fix: updated composer lock
dvsa · Mar 5, 2025 · f4e2a42 · f4e2a42
1 parent 7cd8ce8
commit f4e2a42
Show file tree

Hide file tree

Showing 14 changed files with 95 additions and 28 deletions.
diff --git a/app/api/composer.lock b/app/api/composer.lock
diff --git a/app/api/module/Api/src/Domain/CommandHandler/Cases/Si/Applied/Create.php b/app/api/module/Api/src/Domain/CommandHandler/Cases/Si/Applied/Create.php
@@ -9,6 +9,7 @@
 use Dvsa\Olcs\Api\Entity\Si\SeriousInfringement as SiEntity;
 use Dvsa\Olcs\Api\Entity\Si\SiPenalty as SiPenaltyEntity;
 use Dvsa\Olcs\Api\Entity\Si\SiPenaltyType as SiPenaltyTypeEntity;
+use Dvsa\Olcs\Api\Entity\Si\SiPenaltyErruRequested as SiPenaltyErruRequestedEntity;
 use Dvsa\Olcs\Transfer\Command\Cases\Si\Applied\Create as CreatePenaltyCmd;
 use Dvsa\Olcs\Transfer\Command\CommandInterface;
 
@@ -45,6 +46,7 @@ public function handleCommand(CommandInterface $command)
         }
 
         $siPenaltyType = $this->getRepo()->getReference(SiPenaltyTypeEntity::class, $command->getSiPenaltyType());
+        $siRequestedErru = $this->getRepo()->getReference(SiPenaltyErruRequestedEntity::class, $command->getErruPenaltyRequested());
         $startDate
             = ($command->getStartDate() !== null)
                 ? \DateTime::createFromFormat(self::DATE_FORMAT, $command->getStartDate()) : null;
@@ -55,6 +57,7 @@ public function handleCommand(CommandInterface $command)
         $penalty = new SiPenaltyEntity(
             $si,
             $siPenaltyType,
+            $siRequestedErru,
             $command->getImposed(),
             $startDate,
             $endDate,

diff --git a/app/api/module/Api/src/Domain/CommandHandler/Cases/Si/Applied/Update.php b/app/api/module/Api/src/Domain/CommandHandler/Cases/Si/Applied/Update.php
@@ -8,6 +8,7 @@
 use Dvsa\Olcs\Api\Entity\Cases\Cases as CaseEntity;
 use Dvsa\Olcs\Api\Entity\Si\ErruRequest as ErruRequestEntity;
 use Dvsa\Olcs\Api\Entity\Si\SiPenalty as SiPenaltyEntity;
+use Dvsa\Olcs\Api\Entity\Si\SiPenaltyErruRequested as SiPenaltyErruRequestedEntity;
 use Dvsa\Olcs\Api\Entity\Si\SiPenaltyType as SiPenaltyTypeEntity;
 use Dvsa\Olcs\Transfer\Command\Cases\Si\Applied\Update as UpdatePenaltyCmd;
 use Dvsa\Olcs\Transfer\Command\CommandInterface;
@@ -44,6 +45,8 @@ public function handleCommand(CommandInterface $command)
         }
 
         $siPenaltyType = $this->getRepo()->getReference(SiPenaltyTypeEntity::class, $command->getSiPenaltyType());
+        $siRequestedErru = $this->getRepo()->getReference(SiPenaltyErruRequestedEntity::class, $command->getErruPenaltyRequested());
+
         $startDate
             = ($command->getStartDate() !== null)
                 ? \DateTime::createFromFormat(self::DATE_FORMAT, $command->getStartDate()) : null;
@@ -53,6 +56,7 @@ public function handleCommand(CommandInterface $command)
 
         $penalty->update(
             $siPenaltyType,
+            $siRequestedErru,
             $command->getImposed(),
             $startDate,
             $endDate,

diff --git a/app/api/module/Api/src/Domain/QueryHandler/Cases/Si/Applied/Penalty.php b/app/api/module/Api/src/Domain/QueryHandler/Cases/Si/Applied/Penalty.php
@@ -15,6 +15,6 @@ final class Penalty extends AbstractQueryHandler
 
     public function handleQuery(QueryInterface $query)
     {
-        return $this->result($this->getRepo()->fetchUsingId($query), ['siPenaltyType']);
+        return $this->result($this->getRepo()->fetchUsingId($query), ['siPenaltyType', 'erruPenaltyRequested']);
     }
 }
diff --git a/app/api/module/Api/src/Domain/QueryHandler/Cases/Si/Si.php b/app/api/module/Api/src/Domain/QueryHandler/Cases/Si/Si.php
@@ -34,7 +34,7 @@ public function handleQuery(QueryInterface $query)
                 'memberStateCode',
                 'siCategory',
                 'siCategoryType',
-                'appliedPenalties' => ['siPenaltyType', 'seriousInfringement'],
+                'appliedPenalties' => ['siPenaltyType', 'seriousInfringement', 'erruPenaltyRequested'],
                 'imposedErrus' => ['executed', 'siPenaltyImposedType'],
                 'requestedErrus' => ['siPenaltyRequestedType'],
                 'case' => [

diff --git a/app/api/module/Api/src/Entity/Si/SiPenalty.php b/app/api/module/Api/src/Entity/Si/SiPenalty.php
@@ -5,6 +5,7 @@
 use Doctrine\ORM\Mapping as ORM;
 use Dvsa\Olcs\Api\Entity\Si\SeriousInfringement as SiEntity;
 use Dvsa\Olcs\Api\Entity\Si\SiPenaltyType as SiPenaltyTypeEntity;
+use Dvsa\Olcs\Api\Entity\Si\SiPenaltyErruRequested as SiPenaltyErruRequestedEntity;
 
 /**
  * SiPenalty Entity
@@ -21,36 +22,30 @@
  */
 class SiPenalty extends AbstractSiPenalty
 {
-    /**
-     * SiPenalty constructor.
-     * @param string $imposed
-     * @param string $reasonNotImposed
-     */
     public function __construct(
         SiEntity $seriousInfringement,
         SiPenaltyTypeEntity $siPenaltyType,
-        $imposed,
+        SiPenaltyErruRequestedEntity $requestedErru,
+        string $imposed,
         \DateTime $startDate = null,
         \DateTime $endDate = null,
-        $reasonNotImposed = null
+        string $reasonNotImposed = null
     ) {
         $this->seriousInfringement = $seriousInfringement;
-        $this->update($siPenaltyType, $imposed, $startDate, $endDate, $reasonNotImposed);
+        $this->update($siPenaltyType, $requestedErru, $imposed, $startDate, $endDate, $reasonNotImposed);
     }
 
-    /**
-     * @param string $imposed
-     * @param string $reasonNotImposed
-     */
     public function update(
         SiPenaltyTypeEntity $siPenaltyType,
-        $imposed,
+        SiPenaltyErruRequestedEntity $requestedErru,
+        string $imposed,
         \DateTime $startDate = null,
         \DateTime $endDate = null,
-        $reasonNotImposed = null
+        string $reasonNotImposed = null
     ) {
         $this->siPenaltyType = $siPenaltyType;
         $this->imposed = $imposed;
+        $this->erruPenaltyRequested = $requestedErru;
 
         if ($startDate !== null) {
             $this->startDate = $startDate;

diff --git a/app/api/test/module/Api/src/Domain/CommandHandler/Cases/Si/Applied/CreateTest.php b/app/api/test/module/Api/src/Domain/CommandHandler/Cases/Si/Applied/CreateTest.php
@@ -6,7 +6,7 @@
 use Dvsa\Olcs\Api\Domain\Repository\SeriousInfringement as SiRepo;
 use Dvsa\Olcs\Api\Domain\Repository\SiPenalty as SiPenaltyRepo;
 use Dvsa\Olcs\Api\Entity\Cases\Cases as CaseEntity;
-use Dvsa\Olcs\Api\Entity\Si\ErruRequest as ErruRequestEntity;
+use Dvsa\Olcs\Api\Entity\Si\SiPenaltyErruRequested as SiPenaltyErruRequestedEntity;
 use Dvsa\Olcs\Api\Entity\Si\SeriousInfringement as SiEntity;
 use Dvsa\Olcs\Api\Entity\Si\SiPenalty as SiPenaltyEntity;
 use Dvsa\Olcs\Api\Entity\Si\SiPenaltyType as SiPenaltyTypeEntity;
@@ -33,7 +33,11 @@ protected function initReferences()
         $this->references = [
             SiPenaltyTypeEntity::class => [
                 999 => m::mock(SiPenaltyTypeEntity::class)
+            ],
+            SiPenaltyErruRequestedEntity::class => [
+                888 => m::mock(SiPenaltyErruRequestedEntity::class)
             ]
+
         ];
 
         parent::initReferences();
@@ -44,6 +48,7 @@ public function testHandleCommand()
         $siPenaltyType = 999;
         $siId = 333;
         $penaltyId = 111;
+        $erruRequested = 888;
         $startDate = '2015-12-25';
         $endDate = '2015-12-26';
         $imposed = 'Y';
@@ -56,7 +61,8 @@ public function testHandleCommand()
                 'imposed' => $imposed,
                 'startDate' => $startDate,
                 'endDate' => $endDate,
-                'imposedReason' => $imposedReason
+                'imposedReason' => $imposedReason,
+                'erruPenaltyRequested' => $erruRequested
             ]
         );
 

diff --git a/app/api/test/module/Api/src/Domain/CommandHandler/Cases/Si/Applied/UpdateTest.php b/app/api/test/module/Api/src/Domain/CommandHandler/Cases/Si/Applied/UpdateTest.php
@@ -5,6 +5,7 @@
 use Dvsa\Olcs\Api\Domain\CommandHandler\Cases\Si\Applied\Update as UpdatePenalty;
 use Dvsa\Olcs\Api\Domain\Repository\SiPenalty as SiPenaltyRepo;
 use Dvsa\Olcs\Api\Entity\Si\SiPenalty as SiPenaltyEntity;
+use Dvsa\Olcs\Api\Entity\Si\SiPenaltyErruRequested as SiPenaltyErruRequestedEntity;
 use Dvsa\Olcs\Api\Entity\Si\SiPenaltyType as SiPenaltyTypeEntity;
 use Dvsa\Olcs\Transfer\Command\Cases\Si\Applied\Update as Cmd;
 use Dvsa\OlcsTest\Api\Domain\CommandHandler\AbstractCommandHandlerTestCase;
@@ -28,6 +29,9 @@ protected function initReferences()
         $this->references = [
             SiPenaltyTypeEntity::class => [
                 999 => m::mock(SiPenaltyTypeEntity::class)
+            ],
+            SiPenaltyErruRequestedEntity::class => [
+                888 => m::mock(SiPenaltyErruRequestedEntity::class)
             ]
         ];
 
@@ -37,6 +41,7 @@ protected function initReferences()
     public function testHandleCommand()
     {
         $siPenaltyType = 999;
+        $erruRequested = 888;
         $penaltyId = 111;
         $startDate = '2015-12-25';
         $endDate = '2015-12-26';
@@ -50,7 +55,8 @@ public function testHandleCommand()
                 'imposed' => $imposed,
                 'startDate' => $startDate,
                 'endDate' => $endDate,
-                'imposedReason' => $imposedReason
+                'imposedReason' => $imposedReason,
+                'erruPenaltyRequested' => $erruRequested
             ]
         );
 

diff --git a/app/api/test/module/Api/src/Entity/Si/SiPenaltyEntityTest.php b/app/api/test/module/Api/src/Entity/Si/SiPenaltyEntityTest.php
@@ -2,6 +2,7 @@
 
 namespace Dvsa\OlcsTest\Api\Entity\Si;
 
+use Dvsa\Olcs\Api\Entity\Si\SiPenaltyErruRequested;
 use Dvsa\OlcsTest\Api\Entity\Abstracts\EntityTester;
 use Dvsa\Olcs\Api\Entity\Si\SiPenalty as Entity;
 use Dvsa\Olcs\Api\Entity\Si\SeriousInfringement;
@@ -29,18 +30,20 @@ public function testCreateAndUpdate()
     {
         $si = m::mock(SeriousInfringement::class);
         $penaltyType = m::mock(SiPenaltyType::class);
+        $erruRequested = m::mock(SiPenaltyErruRequested::class);
         $startDate = new \DateTime('2015-12-25');
         $endDate = new \DateTime('2015-12-26');
         $imposed = 'Y';
         $reasonNotImposed = 'reason not imposed';
 
-        $entity = new Entity($si, $penaltyType, $imposed, $startDate, $endDate, $reasonNotImposed);
+        $entity = new Entity($si, $penaltyType, $erruRequested, $imposed, $startDate, $endDate, $reasonNotImposed);
 
         $this->assertEquals($si, $entity->getSeriousInfringement());
         $this->assertEquals($penaltyType, $entity->getSiPenaltyType());
         $this->assertEquals($startDate, $entity->getStartDate());
         $this->assertEquals($endDate, $entity->getEndDate());
         $this->assertEquals($imposed, $entity->getImposed());
         $this->assertEquals($reasonNotImposed, $entity->getReasonNotImposed());
+        $this->assertEquals($erruRequested, $entity->getErruPenaltyRequested());
     }
 }
diff --git a/app/api/test/module/Api/src/Service/Submission/Sections/AbstractSubmissionSectionTest.php b/app/api/test/module/Api/src/Service/Submission/Sections/AbstractSubmissionSectionTest.php
@@ -896,6 +896,7 @@ protected function generateAppliedPenalty($id)
         $entity = new SiPenalty(
             m::mock(SeriousInfringement::class)->makePartial(),
             $this->generateSiPenaltyType(533),
+            $this->generateRequestedErru(),
             'imposed',
             new \DateTime('2013-06-31'),
             new \DateTime('2013-08-31'),

diff --git a/app/internal/module/Olcs/src/Controller/Cases/Penalty/PenaltyController.php b/app/internal/module/Olcs/src/Controller/Cases/Penalty/PenaltyController.php
@@ -5,7 +5,7 @@
 use Common\Service\Helper\FlashMessengerHelperService;
 use Common\Service\Helper\FormHelperService;
 use Common\Service\Helper\TranslationHelperService;
-use Common\Service\Table\TableBuilderFactory;
+use Laminas\Form\Form;
 use Common\Service\Table\TableFactory;
 use Dvsa\Olcs\Transfer\Command\Cases\Si\Applied\Create as CreateDto;
 use Dvsa\Olcs\Transfer\Command\Cases\Si\Applied\Delete as DeleteDto;
@@ -158,4 +158,34 @@ private function getPenaltyData()
 
         return $response->getResult();
     }
+
+    /**
+     * Alters the form by setting value options for the erruPenaltyRequested field.
+     */
+    private function alterForm($form): Form
+    {
+        $optionData = [];
+        foreach ($this->getPenaltyData()['requestedErrus'] as $datum) {
+            $optionData[$datum['id']] = $datum['siPenaltyRequestedType']['id'].' - '.$datum['siPenaltyRequestedType']['description'];
+        }
+        $form->get('fields')->get('erruPenaltyRequested')->setValueOptions($optionData);
+
+        return $form;
+    }
+
+    /**
+     * Alters the form for adding a new penalty.
+     */
+    public function alterFormForAdd($form, $initialData): Form
+    {
+        return $this->alterForm($form);
+    }
+
+    /**
+     * Alters the form for editing an existing penalty.
+     */
+    public function alterFormForEdit($form, $initialData): Form
+    {
+        return $this->alterForm($form);
+    }
 }
diff --git a/app/internal/module/Olcs/src/Form/Model/Fieldset/ErruPenalty.php b/app/internal/module/Olcs/src/Form/Model/Fieldset/ErruPenalty.php
@@ -21,6 +21,17 @@ class ErruPenalty extends CaseBase
      */
     public $siPenaltyType;
 
+
+    /**
+     * @Form\Options({
+     *     "label": "Requested Penalty",
+     *     "disable_inarray_validator": false,
+     *     "empty_option": "Please Select",
+     * })
+     * @Form\Type("DynamicSelect")
+     */
+    public $erruPenaltyRequested;
+
     /**
      * @Form\Attributes({"id":"startDate"})
      * @Form\Options({

diff --git a/app/internal/module/Olcs/src/Table/Tables/erru-applied.table.php b/app/internal/module/Olcs/src/Table/Tables/erru-applied.table.php
@@ -48,6 +48,10 @@
             'title' => 'Penalty type',
             'formatter' => fn($data) => $data['siPenaltyType']['id'] . ' - ' . $data['siPenaltyType']['description'],
         ],
+        [
+            'title' => 'Requested Identifier',
+            'formatter' => fn($data) => $data['erruPenaltyRequested']['penaltyRequestedIdentifier'],
+        ],
         [
             'title' => 'Start date',
             'formatter' => function ($data, $column) {

diff --git a/app/internal/module/Olcs/src/Table/Tables/erru-requested.table.php b/app/internal/module/Olcs/src/Table/Tables/erru-requested.table.php
@@ -13,6 +13,10 @@
             'title' => 'Penalty type',
             'formatter' => fn($data) => $data['siPenaltyRequestedType']['id'] . ' - ' . $data['siPenaltyRequestedType']['description'],
         ],
+        [
+            'title' => 'Requested Identifier',
+            'formatter' => fn($data) => $data['penaltyRequestedIdentifier'],
+        ],
         [
             'title' => 'Duration',
             'name' => 'duration',