fix: remove form unit tests (#9)

* fix: remove form unit tests * fix: migrate to PSR-4 * fix: remove global constant `DATE*_FORMAT` dependency * fix: allow datetime formats to be configurable * chore: bump `olcs-common` to `5.0.0-alpha.3`
dvsa · Jan 9, 2024 · 2b2acea · 2b2acea
1 parent 7135aff
commit 2b2acea
Show file tree

Hide file tree

Showing 189 changed files with 81 additions and 16,789 deletions.
diff --git a/composer.json b/composer.json
@@ -42,13 +42,9 @@
         "bamarni/composer-bin-plugin": "^1.8"
     },
     "autoload": {
-        "classmap": [
-            "module/Admin/src",
-            "module/Olcs/src",
-            "vendor/olcs/olcs-common/Common/src/Common",
-            "vendor/olcs/olcs-common/test/Common"
-        ],
         "psr-4": {
+            "Olcs\\": "module/Olcs/src",
+            "Admin\\": "module/Admin/src",
             "Common\\": "vendor/olcs/olcs-common/Common/src/Common",
             "CommonTest\\": "vendor/olcs/olcs-common/test/Common/src/"
         }

diff --git a/composer.lock b/composer.lock
diff --git a/module/Admin/Module.php → module/Admin/src/Module.php b/module/Admin/Module.php → module/Admin/src/Module.php
@@ -27,6 +27,6 @@ public function onBootstrap(MvcEvent $event)
 
     public function getConfig()
     {
-        return include __DIR__ . '/config/module.config.php';
+        return include __DIR__ . '/../config/module.config.php';
     }
 }
diff --git a/module/Olcs/src/Controller/Cases/Opposition/OppositionController.php b/module/Olcs/src/Controller/Cases/Opposition/OppositionController.php
@@ -15,6 +15,7 @@
 use Olcs\Controller\Interfaces\CaseControllerInterface;
 use Olcs\Data\Mapper\Opposition as Mapper;
 use Olcs\Form\Model\Form\Opposition as Form;
+use Olcs\Module;
 use Olcs\Mvc\Controller\ParameterProvider\GenericItem;
 use Olcs\Mvc\Controller\ParameterProvider\GenericList;
 
@@ -211,7 +212,7 @@ private function alterFormForCase($form, $initialData)
 
         if (!empty($caseWithOppositionDates['oorDate'])) {
             // set oor date
-            $oorString = (new \DateTime($caseWithOppositionDates['oorDate']))->format(\DATE_FORMAT);
+            $oorString = (new \DateTime($caseWithOppositionDates['oorDate']))->format(Module::$dateFormat);
 
             $form->get('fields')
                 ->get('outOfRepresentationDate')
@@ -220,7 +221,7 @@ private function alterFormForCase($form, $initialData)
 
         if (!empty($caseWithOppositionDates['oooDate'])) {
             // set ooo date
-            $oooString = (new \DateTime($caseWithOppositionDates['oooDate']))->format(\DATE_FORMAT);
+            $oooString = (new \DateTime($caseWithOppositionDates['oooDate']))->format(Module::$dateFormat);
 
             $form->get('fields')
                 ->get('outOfObjectionDate')

diff --git a/module/Olcs/src/Controller/Lva/Application/DeclarationsInternalController.php b/module/Olcs/src/Controller/Lva/Application/DeclarationsInternalController.php
@@ -10,6 +10,7 @@
 use Dvsa\Olcs\Utils\Translation\NiTextTranslation;
 use Laminas\Form\Form;
 use Olcs\Controller\Lva\Traits\ApplicationControllerTrait;
+use Olcs\Module;
 use ZfcRbac\Service\AuthorizationService;
 
 /**
@@ -82,9 +83,9 @@ protected function alterFormForLva(Form $form, $data = null)
             $form->get('declarations')->get('verifySignatureText')->setValue(
                 sprintf(
                     'This application has been digitally signed on %s by %s with date of birth %s',
-                    (new \DateTime($signatureDetails['date']))->format(\DATE_FORMAT),
+                    (new \DateTime($signatureDetails['date']))->format(Module::$dateFormat),
                     $signatureDetails['name'],
-                    (new \DateTime($signatureDetails['dob']))->format(\DATE_FORMAT)
+                    (new \DateTime($signatureDetails['dob']))->format(Module::$dateFormat)
                 )
             );
 

diff --git a/module/Olcs/src/Controller/TaskController.php b/module/Olcs/src/Controller/TaskController.php
@@ -20,6 +20,7 @@
 use Laminas\View\Model\ViewModel;
 use Olcs\Controller\Traits as ControllerTraits;
 use Olcs\Data\Mapper;
+use Olcs\Module;
 use Olcs\Service\Data\SubCategory;
 use Olcs\Service\Data\UserListInternalExcludingLimitedReadOnlyUsers;
 
@@ -319,7 +320,7 @@ protected function prepareInfoColumns($data)
     {
         if (isset($data['lastModifiedOn']) && isset($data['lastModifiedByDetails'])) {
             $data['lastModifiedByDetails'] .=
-                ' (' . (new \DateTime($data['lastModifiedOn']))->format(\DATETIMESEC_FORMAT) . ')';
+                ' (' . (new \DateTime($data['lastModifiedOn']))->format(Module::$dateTimeSecFormat) . ')';
         }
         return $data;
     }

diff --git a/module/Olcs/src/Data/Mapper/EventHistory.php b/module/Olcs/src/Data/Mapper/EventHistory.php
@@ -3,6 +3,7 @@
 namespace Olcs\Data\Mapper;
 
 use Dvsa\Olcs\Utils\Helper\DateTimeHelper;
+use Olcs\Module;
 
 /**
  * Event History
@@ -23,7 +24,7 @@ public static function mapFromResult(array $data)
         $result['details'] = $data['eventHistoryType']['description'];
         $result['info'] = $data['eventData'];
 
-        $result['date'] = date(\DATETIME_FORMAT, strtotime($data['eventDatetime']));
+        $result['date'] = date(Module::$dateTimeFormat, strtotime($data['eventDatetime']));
 
         $result['by'] = isset($data['user']['contactDetails']['person']['forename']) &&
             isset($data['user']['contactDetails']['person']['familyName']) ?
@@ -43,7 +44,7 @@ function (&$item) use ($dateFields) {
 
                 foreach (['newValue', 'oldValue'] as $key) {
                     if (!empty($item[$key])) {
-                        $item[$key] = DateTimeHelper::format($item[$key], \DATETIME_FORMAT);
+                        $item[$key] = DateTimeHelper::format($item[$key], Module::$dateTimeFormat);
                     }
                 }
             }

diff --git a/module/Olcs/src/Data/Mapper/IrfoPsvAuth.php b/module/Olcs/src/Data/Mapper/IrfoPsvAuth.php
@@ -4,6 +4,7 @@
 
 use Common\Data\Mapper\MapperInterface;
 use Laminas\Form\FormInterface;
+use Olcs\Module;
 
 /**
  * Class IrfoPsvAuth Mapper
@@ -35,7 +36,7 @@ public static function mapFromResult(array $data)
         if (!empty($formData['fields']['createdOn'])) {
             // format createOn date
             $createdOn = new \DateTime($formData['fields']['createdOn']);
-            $formData['fields']['createdOnHtml'] = $createdOn->format(\DATE_FORMAT);
+            $formData['fields']['createdOnHtml'] = $createdOn->format(Module::$dateFormat);
         }
 
         // default all copies fields to 0

diff --git a/module/Olcs/src/Data/Mapper/Pi.php b/module/Olcs/src/Data/Mapper/Pi.php
@@ -5,6 +5,7 @@
 use Common\Data\Mapper\MapperInterface;
 use Dvsa\Olcs\Utils\Helper\DateTimeHelper;
 use Laminas\Form\FormInterface;
+use Olcs\Module;
 
 /**
  * Class Pi
@@ -72,7 +73,7 @@ public static function mapFromErrors(FormInterface $form, array $errors)
             foreach ($errors['messages'] as $key => $value) {
                 if ($key === 'DECISION_DATE_BEFORE_HEARING_DATE') {
                     /** @var DateTimeSelect $e */
-                    $hearingDate = DateTimeHelper::format($value, DATE_FORMAT);
+                    $hearingDate = DateTimeHelper::format($value, Module::$dateFormat);
                     $form->get('fields')->get('decisionDate')->setMessages(
                         ['Decision date must be after or the same as the PI hearing date '. $hearingDate]
                     );

diff --git a/module/Olcs/src/Data/Mapper/PiHearing.php b/module/Olcs/src/Data/Mapper/PiHearing.php
@@ -6,6 +6,7 @@
 use Common\Form\Elements\Custom\DateTimeSelect;
 use Dvsa\Olcs\Utils\Helper\DateTimeHelper;
 use Laminas\Form\FormInterface;
+use Olcs\Module;
 
 /**
  * Class PiHearing
@@ -104,7 +105,7 @@ public static function mapFromErrors(FormInterface $form, array $errors)
             foreach ($errors['messages'] as $key => $value) {
                 if ($key === 'HEARING_DATE_BEFORE_PI') {
                     /** @var DateTimeSelect $e */
-                    $piDate = DateTimeHelper::format($value, DATE_FORMAT);
+                    $piDate = DateTimeHelper::format($value, Module::$dateFormat);
                     $form->get('fields')->get('hearingDate')->setMessages(
                         ['Hearing date must be after or the same as the PI agreed date '. $piDate]
                     );

diff --git a/module/Olcs/src/Data/Mapper/PublicationLink.php b/module/Olcs/src/Data/Mapper/PublicationLink.php
@@ -4,6 +4,7 @@
 
 use Common\Data\Mapper\MapperInterface;
 use Laminas\Form\FormInterface;
+use Olcs\Module;
 
 /**
  * Class Generic Mapper for forms with Fields field set
@@ -25,7 +26,7 @@ public static function mapFromResult(array $data)
             'status' => $data['publication']['pubStatus']['description'],
             'section' => $data['publicationSection']['description'],
             'trafficArea' => $data['publication']['trafficArea']['name'],
-            'publicationDate' => date(\DATE_FORMAT, strtotime($data['publication']['pubDate']))
+            'publicationDate' => date(Module::$dateFormat, strtotime($data['publication']['pubDate']))
         ];
 
         $textFields = [

diff --git a/module/Olcs/src/Data/Mapper/User.php b/module/Olcs/src/Data/Mapper/User.php
@@ -4,8 +4,9 @@
 
 use Common\Data\Mapper\MapperInterface;
 use Dvsa\Olcs\Utils\Helper\DateTimeHelper;
-use Olcs\Data\Mapper\Traits as MapperTraits;
 use Laminas\Form\FormInterface;
+use Olcs\Data\Mapper\Traits as MapperTraits;
+use Olcs\Module;
 
 /**
  * Class User Mapper
@@ -46,15 +47,15 @@ public static function mapFromResult(array $data)
                 = !empty($data['lockedOn'])
                     ? sprintf(
                         'Yes on %s',
-                        (new \DateTime($data['lockedOn']))->format(\DATETIMESEC_FORMAT)
+                        (new \DateTime($data['lockedOn']))->format(Module::$dateTimeSecFormat)
                     )
                     : 'No';
 
             if (!empty($data['latestPasswordResetEvent'])) {
                 $formData['userLoginSecurity']['passwordLastReset'] = sprintf(
                     '%s on %s',
                     $data['latestPasswordResetEvent']['eventData'],
-                    DateTimeHelper::format($data['latestPasswordResetEvent']['eventDatetime'], \DATETIMESEC_FORMAT)
+                    DateTimeHelper::format($data['latestPasswordResetEvent']['eventDatetime'], Module::$dateTimeSecFormat)
                 );
             }
 

diff --git a/module/Olcs/Module.php → module/Olcs/src/Module.php b/module/Olcs/Module.php → module/Olcs/src/Module.php
@@ -8,10 +8,10 @@
 
 namespace Olcs;
 
+use Common\Exception\ResourceNotFoundException;
 use Laminas\Mvc\ModuleRouteListener;
 use Laminas\Mvc\MvcEvent;
 use Laminas\View\Model\ViewModel;
-use Common\Exception\ResourceNotFoundException;
 use Olcs\Listener\HeaderSearch;
 use Olcs\Listener\RouteParams;
 
@@ -22,6 +22,10 @@
  */
 class Module
 {
+    public static string $dateFormat = 'd/m/Y';
+    public static string $dateTimeFormat = 'd/m/Y H:i';
+    public static string $dateTimeSecFormat = 'd/m/Y H:i:s';
+
     /**
      * Event to Bootstrap the module
      *
@@ -31,6 +35,11 @@ class Module
      */
     public function onBootstrap(MvcEvent $e)
     {
+        $config = $e->getApplication()->getServiceManager()->get('Config');
+
+        self::$dateFormat = $config['date_settings']['date_format'] ?? self::$dateFormat;
+        self::$dateTimeFormat = $config['date_settings']['datetime_format'] ?? self::$dateTimeFormat;
+        self::$dateTimeSecFormat = $config['date_settings']['datetimesec_format'] ?? self::$dateTimeSecFormat;
 
         $eventManager = $e->getApplication()->getEventManager();
         $moduleRouteListener = new ModuleRouteListener();
@@ -109,6 +118,6 @@ function (MvcEvent $e) {
      */
     public function getConfig()
     {
-        return include __DIR__ . '/config/module.config.php';
+        return include __DIR__ . '/../config/module.config.php';
     }
 }
diff --git a/module/Olcs/src/Table/Tables/NonPi.table.php b/module/Olcs/src/Table/Tables/NonPi.table.php
@@ -1,6 +1,7 @@
 <?php
 
 use Common\Service\Table\Formatter\Date;
+use Olcs\Module;
 
 return array(
     'variables' => array(
@@ -33,7 +34,7 @@
                     'case_non_pi', true
                 );
                 $column['formatter'] = Date::class;
-                return '<a class="govuk-link" href="' . $url . '">' . date(\DATETIMESEC_FORMAT, strtotime($data['hearingDate'])) . '</a>';
+                return '<a class="govuk-link" href="' . $url . '">' . date(Module::$dateTimeSecFormat, strtotime($data['hearingDate'])) . '</a>';
             },
             'name' => 'id'
         ),

diff --git a/module/Olcs/src/Table/Tables/hearings.table.php b/module/Olcs/src/Table/Tables/hearings.table.php
@@ -1,6 +1,7 @@
 <?php
 
 use Common\Service\Table\Formatter\Date;
+use Olcs\Module;
 
 return array(
     'variables' => array(
@@ -37,7 +38,7 @@
                 $url = $this->generateUrl(['action' => 'edit', 'id' => $data['id']], 'case_pi', true);
 
                 $column['formatter'] = Date::class;
-                return '<a class="govuk-link" href="' . $url . '">' . date(\DATE_FORMAT, strtotime($data['hearingDate'])) . '</a>';
+                return '<a class="govuk-link" href="' . $url . '">' . date(Module::$dateFormat, strtotime($data['hearingDate'])) . '</a>';
             },
             'name' => 'id'
         ),

diff --git a/module/Olcs/src/Table/Tables/piHearing.table.php b/module/Olcs/src/Table/Tables/piHearing.table.php
@@ -1,5 +1,7 @@
 <?php
 
+use Olcs\Module;
+
 return array(
     'variables' => array(
         'titleSingular' => 'Hearing',
@@ -40,7 +42,7 @@
         array(
             'title' => 'Date of PI',
             'formatter' => function ($data) {
-                $date = date(\DATE_FORMAT, strtotime($data['hearingDate']));
+                $date = date(Module::$dateFormat, strtotime($data['hearingDate']));
                 if (!empty($data['pi']['closedDate'])) {
                     return $date;
                 } else {

diff --git a/module/Olcs/src/Table/Tables/publication.table.php b/module/Olcs/src/Table/Tables/publication.table.php
@@ -1,6 +1,7 @@
 <?php
 
 use Common\Service\Table\Formatter\Date;
+use Olcs\Module;
 
 return array(
     'variables' => array(
@@ -65,7 +66,7 @@
             'title' => 'Publication date',
             'formatter' => function ($data) {
                 $date = new DateTime($data['publication']['pubDate']);
-                return $date->format(\DATE_FORMAT);
+                return $date->format(Module::$dateFormat);
             }
         ),
         array(

diff --git a/module/Olcs/src/Table/Tables/submission.table.php b/module/Olcs/src/Table/Tables/submission.table.php
@@ -4,6 +4,7 @@
 use Common\Service\Table\Formatter\HideIfClosedRadio;
 use Common\Service\Table\Formatter\Name;
 use Common\Service\Table\Formatter\YesNo;
+use Olcs\Module;
 
 return array(
     'variables' => array(
@@ -62,7 +63,7 @@
         array(
             'title' => 'Date created',
             'formatter' => function ($row) {
-                return date(\DATETIMESEC_FORMAT, strtotime($row['createdOn']));
+                return date(Module::$dateTimeSecFormat, strtotime($row['createdOn']));
             },
             'sort' => 'createdOn'
         ),