refactoring month year error message logic

Author: anna-shen-hmrc

app/uk/gov/hmrc/ngrraldfrontend/controllers/InterimRentSetByTheCourtController.scala

@@ -29,6 +29,7 @@ import uk.gov.hmrc.ngrraldfrontend.models.forms.InterimRentSetByTheCourtForm.for
 import uk.gov.hmrc.ngrraldfrontend.navigation.Navigator
 import uk.gov.hmrc.ngrraldfrontend.pages.InterimSetByTheCourtPage
 import uk.gov.hmrc.ngrraldfrontend.repo.SessionRepository
+import uk.gov.hmrc.ngrraldfrontend.utils.DateKeyFinder
 import uk.gov.hmrc.ngrraldfrontend.views.html.InterimRentSetByTheCourtView
 import uk.gov.hmrc.ngrraldfrontend.views.html.components.InputText
 import uk.gov.hmrc.play.bootstrap.frontend.controller.FrontendController
@@ -43,7 +44,7 @@ class InterimRentSetByTheCourtController @Inject()(interimRentSetByTheCourtView:
                                                    sessionRepository: SessionRepository,
                                                    navigator: Navigator,
                                                    mcc: MessagesControllerComponents)(implicit appConfig: AppConfig, ec: ExecutionContext)
-  extends FrontendController(mcc) with I18nSupport {
+  extends FrontendController(mcc) with I18nSupport with DateKeyFinder {
 
   def generateInputText(form: Form[InterimRentSetByTheCourtForm], inputFieldName: String)(implicit messages: Messages): HtmlFormat.Appendable = {
     inputText(
@@ -80,13 +81,8 @@ class InterimRentSetByTheCourtController @Inject()(interimRentSetByTheCourtView:
         formWithErrors => {
           val correctedFormErrors = formWithErrors.errors.map { formError =>
             (formError.key, formError.messages) match
-              case (key, messages) if messages.contains("interimRentSetByTheCourt.startDate.before.1900.error") ||
-                messages.contains("interimRentSetByTheCourt.year.required.error") =>
-                formError.copy(key = "date.year")
-              case ("date", messages) if messages.contains("interimRentSetByTheCourt.year.format.error") =>
-                formError.copy(key = "date.year")
-              case ("date", messages) =>
-                formError.copy(key = "date.month")
+              case (key, messages) if messages.head.contains("interimRentSetByTheCourt.date") =>
+                setCorrectKey(formError, "interimRentSetByTheCourt", "date")
               case _ =>
                 formError
           }

app/uk/gov/hmrc/ngrraldfrontend/models/forms/CommonFormValidators.scala

@@ -94,10 +94,10 @@ trait CommonFormValidators {
       monthYearEmptyValidation(input.asInstanceOf[NGRMonthYear], errorKeys)
     )
 
-  protected def isMonthYearValid[A](monthError: String, yearError: String) : Constraint[A] =
+  protected def isMonthYearValid[A](errorKey: String) : Constraint[A] =
     Constraint((input: A) =>
       val date = input.asInstanceOf[NGRMonthYear]
-      monthYearValidation(date, monthError, yearError)
+      monthYearValidation(date, errorKey)
     )
 
   protected def isMonthYearAfter1900[A](errorKey: String): Constraint[A] =
@@ -146,8 +146,7 @@ trait CommonFormValidators {
       Invalid(errorKey)
     else
       Valid
-
-
+  
   private def monthYearAfter1900Validation(date: NGRMonthYear, errorKey: String) =
     val maybeYear = date.year.toIntOption
     maybeYear match {
@@ -165,16 +164,14 @@ trait CommonFormValidators {
     else
       Valid
 
-  protected def monthYearValidation(date: NGRMonthYear, monthError: String, yearError:String) = {
+  private def monthYearValidation(date: NGRMonthYear, errorKey: String) = {
     val maybeMonth = date.month.toIntOption
     val maybeYear = date.year.toIntOption
     (maybeMonth, maybeYear) match {
-      case (Some(month), Some(year)) if month > 0 && month <= 12 =>
+      case (Some(month), Some(year)) if month > 0 && month <= 12 && year.toString.length == 4 =>
         Valid
-      case (_, None) =>  
-        Invalid(yearError)
       case (_, _) => 
-        Invalid(monthError)
+        Invalid(errorKey)
     }
   }
 }

app/uk/gov/hmrc/ngrraldfrontend/models/forms/InterimRentSetByTheCourtForm.scala

@@ -37,12 +37,6 @@ object InterimRentSetByTheCourtForm extends CommonFormValidators with MonthYearM
 
   def unapply(interimRentSetByTheCourtForm: InterimRentSetByTheCourtForm): Option[(BigDecimal, NGRMonthYear)] = Some(interimRentSetByTheCourtForm.amount, interimRentSetByTheCourtForm.date)
 
-  private def errorKeys(whichDate: String): Map[DateErrorKeys, String] = Map(
-    Required -> s"$whichDate.required.error",
-    Month -> s"$whichDate.month.required.error",
-    Year -> s"$whichDate.year.required.error"
-  )
-
   val form: Form[InterimRentSetByTheCourtForm] = Form(
     mapping(
       "interimAmount" -> text()
@@ -60,9 +54,9 @@ object InterimRentSetByTheCourtForm extends CommonFormValidators with MonthYearM
       "date" -> monthYearMapping
         .verifying(
           firstError(
-            isMonthYearEmpty(errorKeys("interimRentSetByTheCourt")),
-            isMonthYearValid(monthError = "interimRentSetByTheCourt.month.format.error", yearError = "interimRentSetByTheCourt.year.format.error"),
-            isMonthYearAfter1900("interimRentSetByTheCourt.startDate.before.1900.error")
+            isMonthYearEmpty(errorKeys("interimRentSetByTheCourt", "date")),
+            isMonthYearValid("interimRentSetByTheCourt.date.invalid.error"),
+            isMonthYearAfter1900("interimRentSetByTheCourt.date.before.1900.error")
           )
         ),
     )(InterimRentSetByTheCourtForm.apply)(InterimRentSetByTheCourtForm.unapply)

app/uk/gov/hmrc/ngrraldfrontend/views/InterimRentSetByTheCourtView.scala.html

@@ -34,7 +34,7 @@
 @layout(pageTitle = Some(messages("interimRentSetByTheCourt.title")), showBackLink = true, fullWidth = false) {
   @formHelper(action = uk.gov.hmrc.ngrraldfrontend.controllers.routes.InterimRentSetByTheCourtController.submit(mode), Symbol("autoComplete") -> "off") {
     @if(form.errors.nonEmpty) {
-      @govukErrorSummary(ErrorSummaryViewModel(form))
+      @govukErrorSummary(ErrorSummaryViewModel(form, Some("interimRentSetByTheCourt"), Some(Seq("date"))))
     }
     <span class="govuk-caption-m">@propertyAddress</span>
     <h1 class="govuk-heading-l">@messages("interimRentSetByTheCourt.title")</h1>

app/uk/gov/hmrc/ngrraldfrontend/views/components/InputDateForMonthYear.scala.html

@@ -42,8 +42,7 @@
       id = s"$id.month",
       classes = s"govuk-input--width-2${if(
       form(s"$id.month").hasErrors
-      || form.errors.exists(_.key.contains("date"))
-      || form.errors.exists(_.args.contains("month")))" govuk-input--error" else ""}",
+      || form.errors.exists(_.key.equals("date")))" govuk-input--error" else ""}",
       name = s"$id.month",
       label = Some(messages("date.month")),
       value = form(s"$id.month").value
@@ -52,8 +51,7 @@
       id = s"$id.year",
       classes = s"govuk-input--width-4${if(
       form(s"$id.year").hasErrors
-      || form.errors.exists(_.key.contains("date"))
-      || form.errors.exists(_.args.contains("year")))" govuk-input--error" else ""}",
+      || form.errors.exists(_.key.equals("date")))" govuk-input--error" else ""}",
       name = s"$id.year",
       label = Some(messages("date.year")),
       value = form(s"$id.year").value

conf/messages

@@ -364,12 +364,11 @@ date.year = Year
 interimRentSetByTheCourt.interimAmount.required.error = Enter how much the interim rent was, in pounds
 interimRentSetByTheCourt.interimAmount.tooLarge.error = Interim rent must be £9,999,999.99 or less
 interimRentSetByTheCourt.interimAmount.format.error = Interim rent must be a number, like 50,000
-interimRentSetByTheCourt.month.format.error = Date your interim rent started must be a real date
-interimRentSetByTheCourt.year.format.error = Date your interim rent started must be a real date
-interimRentSetByTheCourt.required.error = Date you started paying the interim rent must include a month and year
-interimRentSetByTheCourt.month.required.error = Date you started paying the interim rent must include a month
-interimRentSetByTheCourt.year.required.error = Date you started paying the interim rent must include a year
-interimRentSetByTheCourt.startDate.before.1900.error = The date you started paying interim rent must be 1900 or after
+interimRentSetByTheCourt.date.invalid.error = Date your interim rent started must be a real date
+interimRentSetByTheCourt.date.required.error = Date you started paying the interim rent must include a month and year
+interimRentSetByTheCourt.date.month.required.error = Date you started paying the interim rent must include a month
+interimRentSetByTheCourt.date.year.required.error = Date you started paying the interim rent must include a year
+interimRentSetByTheCourt.date.before.1900.error = The date you started paying interim rent must be 1900 or after
 
 #RentFreePeriod
 rentFreePeriod.title = Rent-free period

test/uk/gov/hmrc/ngrraldfrontend/models/forms/InterimRentSetByTheCourtFormSpec.scala

@@ -157,7 +157,7 @@ class InterimRentSetByTheCourtFormSpec extends AnyWordSpec with Matchers {
       )
       val boundForm = InterimRentSetByTheCourtForm.form.bind(data)
 
-      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.month.format.error"))
+      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.date.invalid.error"))
     }
     "fail to bind year before 1900 for year input field" in {
       val data = Map(
@@ -167,7 +167,7 @@ class InterimRentSetByTheCourtFormSpec extends AnyWordSpec with Matchers {
       )
       val boundForm = InterimRentSetByTheCourtForm.form.bind(data)
 
-      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.startDate.before.1900.error"))
+      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.date.before.1900.error"))
     }
 
     "fail to bind missing month input" in {
@@ -178,7 +178,7 @@ class InterimRentSetByTheCourtFormSpec extends AnyWordSpec with Matchers {
       )
       val boundForm = InterimRentSetByTheCourtForm.form.bind(data)
 
-      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.month.required.error"))
+      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.date.month.required.error"))
     }
 
     "fail to bind missing year input" in {
@@ -189,7 +189,7 @@ class InterimRentSetByTheCourtFormSpec extends AnyWordSpec with Matchers {
       )
       val boundForm = InterimRentSetByTheCourtForm.form.bind(data)
 
-      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.year.required.error"))
+      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.date.year.required.error"))
     }
 
     "fail to bind non numeric format for month input" in {
@@ -200,7 +200,7 @@ class InterimRentSetByTheCourtFormSpec extends AnyWordSpec with Matchers {
       )
       val boundForm = InterimRentSetByTheCourtForm.form.bind(data)
 
-      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.month.format.error"))
+      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.date.invalid.error"))
     }
 
     "fail to bind non numeric format for year input" in {
@@ -211,7 +211,7 @@ class InterimRentSetByTheCourtFormSpec extends AnyWordSpec with Matchers {
       )
       val boundForm = InterimRentSetByTheCourtForm.form.bind(data)
 
-      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.year.format.error"))
+      boundForm.errors should contain(FormError("date", "interimRentSetByTheCourt.date.invalid.error"))
     }
 
   }