Merge pull request #68 from hmrc/cleanup-rename-files

TECH-DEBT: Rename files from ContactName to FirstContactName
hmrc · Jun 4, 2024 · 442fce4 · 442fce4
2 parents e4d05f3 + fc6b9d6
commit 442fce4
Show file tree

Hide file tree

Showing 26 changed files with 131 additions and 140 deletions.
diff --git a/app/controllers/addFinancialInstitution/FirstContactEmailController.scala b/app/controllers/addFinancialInstitution/FirstContactEmailController.scala
@@ -20,7 +20,7 @@ import controllers.actions._
 import forms.addFinancialInstitution.FirstContactEmailFormProvider
 import models.Mode
 import navigation.Navigator
-import pages.addFinancialInstitution.{ContactNamePage, FirstContactEmailPage}
+import pages.addFinancialInstitution.{FirstContactEmailPage, FirstContactNamePage}
 import play.api.data.Form
 import play.api.i18n.{I18nSupport, MessagesApi}
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
@@ -58,7 +58,7 @@ class FirstContactEmailController @Inject() (
         case None        => form
         case Some(value) => form.fill(value)
       }
-      val contactName = ua.get(ContactNamePage)
+      val contactName = ua.get(FirstContactNamePage)
       contactName match {
         case None       => Redirect(controllers.routes.IndexController.onPageLoad())
         case Some(name) => Ok(view(preparedForm, mode, fi, name))
@@ -70,7 +70,7 @@ class FirstContactEmailController @Inject() (
       val ua = request.userAnswers
       val fi = getFinancialInstitutionName(ua)
 
-      ua.get(ContactNamePage)
+      ua.get(FirstContactNamePage)
         .fold {
           Future.successful(Redirect(controllers.routes.IndexController.onPageLoad()))
         } {

diff --git a/...titution/ContactHavePhoneController.scala → ...ion/FirstContactHavePhoneController.scala b/...titution/ContactHavePhoneController.scala → ...ion/FirstContactHavePhoneController.scala
@@ -17,31 +17,31 @@
 package controllers.addFinancialInstitution
 
 import controllers.actions._
-import forms.addFinancialInstitution.ContactHavePhoneFormProvider
+import forms.addFinancialInstitution._
 import models.Mode
 import navigation.Navigator
-import pages.addFinancialInstitution.{ContactHavePhonePage, ContactNamePage}
+import pages.addFinancialInstitution.{FirstContactHavePhonePage, FirstContactNamePage}
 import play.api.data.Form
 import play.api.i18n.{I18nSupport, MessagesApi}
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
 import repositories.SessionRepository
 import uk.gov.hmrc.play.bootstrap.frontend.controller.FrontendBaseController
 import utils.ContactHelper
-import views.html.addFinancialInstitution.ContactHavePhoneView
+import views.html.addFinancialInstitution.FirstContactHavePhoneView
 
 import javax.inject.Inject
 import scala.concurrent.{ExecutionContext, Future}
 
-class ContactHavePhoneController @Inject() (
+class FirstContactHavePhoneController @Inject() (
   override val messagesApi: MessagesApi,
   sessionRepository: SessionRepository,
   navigator: Navigator,
   identify: IdentifierAction,
   getData: DataRetrievalAction,
   requireData: DataRequiredAction,
-  formProvider: ContactHavePhoneFormProvider,
+  formProvider: FirstContactHavePhoneFormProvider,
   val controllerComponents: MessagesControllerComponents,
-  view: ContactHavePhoneView
+  view: FirstContactHavePhoneView
 )(implicit ec: ExecutionContext)
     extends FrontendBaseController
     with I18nSupport
@@ -52,10 +52,10 @@ class ContactHavePhoneController @Inject() (
   def onPageLoad(mode: Mode): Action[AnyContent] = (identify andThen getData andThen requireData) {
     implicit request =>
       val ua          = request.userAnswers
-      val contactName = ua.get(ContactNamePage)
+      val contactName = ua.get(FirstContactNamePage)
       val fi          = getFinancialInstitutionName(ua)
 
-      val preparedForm = ua.get(ContactHavePhonePage) match {
+      val preparedForm = ua.get(FirstContactHavePhonePage) match {
         case None        => form
         case Some(value) => form.fill(value)
       }
@@ -76,9 +76,9 @@ class ContactHavePhoneController @Inject() (
           formWithErrors => Future.successful(BadRequest(view(formWithErrors, mode, fi, getFirstContactName(ua)))),
           value =>
             for {
-              updatedAnswers <- Future.fromTry(ua.set(ContactHavePhonePage, value))
+              updatedAnswers <- Future.fromTry(ua.set(FirstContactHavePhonePage, value))
               _              <- sessionRepository.set(updatedAnswers)
-            } yield Redirect(navigator.nextPage(ContactHavePhonePage, mode, updatedAnswers))
+            } yield Redirect(navigator.nextPage(FirstContactHavePhonePage, mode, updatedAnswers))
         )
   }
 

diff --git a/...alInstitution/ContactNameController.scala → ...titution/FirstContactNameController.scala b/...alInstitution/ContactNameController.scala → ...titution/FirstContactNameController.scala
@@ -17,30 +17,30 @@
 package controllers.addFinancialInstitution
 
 import controllers.actions._
-import forms.addFinancialInstitution.ContactNameFormProvider
+import forms.addFinancialInstitution.FirstContactNameFormProvider
 import models.Mode
 import navigation.Navigator
-import pages.addFinancialInstitution.ContactNamePage
+import pages.addFinancialInstitution.FirstContactNamePage
 import play.api.i18n.{I18nSupport, MessagesApi}
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
 import repositories.SessionRepository
 import uk.gov.hmrc.play.bootstrap.frontend.controller.FrontendBaseController
 import utils.ContactHelper
-import views.html.addFinancialInstitution.ContactNameView
+import views.html.addFinancialInstitution.FirstContactNameView
 
 import javax.inject.Inject
 import scala.concurrent.{ExecutionContext, Future}
 
-class ContactNameController @Inject() (
+class FirstContactNameController @Inject() (
   override val messagesApi: MessagesApi,
   sessionRepository: SessionRepository,
   navigator: Navigator,
   identify: IdentifierAction,
   getData: DataRetrievalAction,
   requireData: DataRequiredAction,
-  formProvider: ContactNameFormProvider,
+  formProvider: FirstContactNameFormProvider,
   val controllerComponents: MessagesControllerComponents,
-  view: ContactNameView
+  view: FirstContactNameView
 )(implicit ec: ExecutionContext)
     extends FrontendBaseController
     with I18nSupport
@@ -52,7 +52,7 @@ class ContactNameController @Inject() (
     implicit request =>
       val ua = request.userAnswers
 
-      val preparedForm = ua.get(ContactNamePage) match {
+      val preparedForm = ua.get(FirstContactNamePage) match {
         case None        => form
         case Some(value) => form.fill(value)
       }
@@ -69,11 +69,11 @@ class ContactNameController @Inject() (
           value =>
             for {
               updatedAnswers <- Future.fromTry(
-                request.userAnswers.set(ContactNamePage, value)
+                request.userAnswers.set(FirstContactNamePage, value)
               )
               _ <- sessionRepository.set(updatedAnswers)
 
-            } yield Redirect(navigator.nextPage(ContactNamePage, mode, updatedAnswers))
+            } yield Redirect(navigator.nextPage(FirstContactNamePage, mode, updatedAnswers))
         )
   }
 

diff --git a/...tution/ContactHavePhoneFormProvider.scala → ...n/FirstContactHavePhoneFormProvider.scala b/...tution/ContactHavePhoneFormProvider.scala → ...n/FirstContactHavePhoneFormProvider.scala
@@ -21,11 +21,11 @@ import javax.inject.Inject
 import forms.mappings.Mappings
 import play.api.data.Form
 
-class ContactHavePhoneFormProvider @Inject() extends Mappings {
+class FirstContactHavePhoneFormProvider @Inject() extends Mappings {
 
   def apply(): Form[Boolean] =
     Form(
-      "value" -> boolean("contactHavePhone.error.required.business")
+      "value" -> boolean("firstContactHavePhone.error.required.business")
     )
 
 }
diff --git a/...Institution/ContactNameFormProvider.scala → ...tution/FirstContactNameFormProvider.scala b/...Institution/ContactNameFormProvider.scala → ...tution/FirstContactNameFormProvider.scala
@@ -21,16 +21,16 @@ import forms.mappings.Mappings
 import play.api.data.Form
 import utils.RegexConstants
 
-class ContactNameFormProvider @Inject() extends Mappings with RegexConstants {
+class FirstContactNameFormProvider @Inject() extends Mappings with RegexConstants {
 
   val maxLength: Int = 35
 
   def apply(): Form[String] =
     Form(
       "value" -> validatedText(
-        "contactName.error.required",
-        "contactName.error.invalid",
-        "contactName.error.length",
+        "firstContactName.error.required",
+        "firstContactName.error.invalid",
+        "firstContactName.error.length",
         orgNameRegex,
         maxLength
       )

diff --git a/app/navigation/Navigator.scala b/app/navigation/Navigator.scala
@@ -70,14 +70,14 @@ class Navigator @Inject() () {
           routes.WhatIsUniqueTaxpayerReferenceController.onPageLoad(NormalMode),
           routes.SendReportsController.onPageLoad(NormalMode)
         )
-    case ContactNamePage =>
+    case FirstContactNamePage =>
       _ => routes.FirstContactEmailController.onPageLoad(NormalMode)
-    case FirstContactEmailPage => _ => routes.ContactHavePhoneController.onPageLoad(NormalMode)
-    case ContactHavePhonePage =>
+    case FirstContactEmailPage => _ => routes.FirstContactHavePhoneController.onPageLoad(NormalMode)
+    case FirstContactHavePhonePage =>
       userAnswers =>
         yesNoPage(
           userAnswers,
-          ContactHavePhonePage,
+          FirstContactHavePhonePage,
           routes.FirstContactPhoneNumberController.onPageLoad(NormalMode),
           routes.SecondContactExistsController.onPageLoad(NormalMode)
         )
@@ -104,13 +104,13 @@ class Navigator @Inject() () {
         )
     case SecondContactPhoneNumberPage => _ => routes.CheckYourAnswersController.onPageLoad
     case PostcodePage                 => addressLookupNavigation(NormalMode)
-    case SelectAddressPage            => _ => routes.ContactNameController.onPageLoad(NormalMode)
+    case SelectAddressPage            => _ => routes.FirstContactNameController.onPageLoad(NormalMode)
     case IsThisAddressPage =>
       userAnswers =>
         yesNoPage(
           userAnswers,
           IsThisAddressPage,
-          routes.ContactNameController.onPageLoad(NormalMode),
+          routes.FirstContactNameController.onPageLoad(NormalMode),
           routes.UkAddressController.onPageLoad(NormalMode)
         )
     case HaveGIINPage =>
@@ -141,8 +141,8 @@ class Navigator @Inject() () {
           routes.SendReportsController.onPageLoad(NormalMode),
           routes.NameOfFinancialInstitutionController.onPageLoad(NormalMode)
         )
-    case UkAddressPage    => _ => routes.ContactNameController.onPageLoad(NormalMode)
-    case NonUkAddressPage => _ => routes.ContactNameController.onPageLoad(NormalMode)
+    case UkAddressPage    => _ => routes.FirstContactNameController.onPageLoad(NormalMode)
+    case NonUkAddressPage => _ => routes.FirstContactNameController.onPageLoad(NormalMode)
     case _ =>
       _ => controllers.routes.IndexController.onPageLoad()
   }

diff --git a/...ialInstitution/ContactHavePhonePage.scala → ...stitution/FirstContactHavePhonePage.scala b/...ialInstitution/ContactHavePhonePage.scala → ...stitution/FirstContactHavePhonePage.scala
@@ -19,9 +19,9 @@ package pages.addFinancialInstitution
 import pages.QuestionPage
 import play.api.libs.json.JsPath
 
-case object ContactHavePhonePage extends QuestionPage[Boolean] {
+case object FirstContactHavePhonePage extends QuestionPage[Boolean] {
 
   override def path: JsPath = JsPath \ toString
 
-  override def toString: String = "contactHavePhone"
+  override def toString: String = "firstContactHavePhone"
 }
diff --git a/...inancialInstitution/ContactNamePage.scala → ...ialInstitution/FirstContactNamePage.scala b/...inancialInstitution/ContactNamePage.scala → ...ialInstitution/FirstContactNamePage.scala
@@ -19,9 +19,9 @@ package pages.addFinancialInstitution
 import pages.QuestionPage
 import play.api.libs.json.JsPath
 
-case object ContactNamePage extends QuestionPage[String] {
+case object FirstContactNamePage extends QuestionPage[String] {
 
   override def path: JsPath = JsPath \ toString
 
-  override def toString: String = "contactName"
+  override def toString: String = "firstContactName"
 }
diff --git a/app/utils/ContactHelper.scala b/app/utils/ContactHelper.scala
@@ -17,14 +17,14 @@
 package utils
 
 import models.UserAnswers
-import pages.addFinancialInstitution.{ContactNamePage, NameOfFinancialInstitutionPage, SecondContactNamePage}
+import pages.addFinancialInstitution.{FirstContactNamePage, NameOfFinancialInstitutionPage, SecondContactNamePage}
 import play.api.i18n.Messages
 
 trait ContactHelper {
 
   def getFirstContactName(userAnswers: UserAnswers)(implicit messages: Messages): String =
     userAnswers
-      .get(ContactNamePage)
+      .get(FirstContactNamePage)
       .fold(messages("default.firstContact.name"))(
         contactName => contactName
       )

diff --git a/...heckAnswers/ContactHavePhoneSummary.scala → ...nswers/FirstContactHavePhoneSummary.scala b/...heckAnswers/ContactHavePhoneSummary.scala → ...nswers/FirstContactHavePhoneSummary.scala
@@ -17,25 +17,25 @@
 package viewmodels.checkAnswers
 
 import models.{CheckMode, UserAnswers}
-import pages.addFinancialInstitution.ContactHavePhonePage
+import pages.addFinancialInstitution.FirstContactHavePhonePage
 import play.api.i18n.Messages
 import uk.gov.hmrc.govukfrontend.views.viewmodels.summarylist.SummaryListRow
 import viewmodels.govuk.summarylist._
 import viewmodels.implicits._
 
-object ContactHavePhoneSummary {
+object FirstContactHavePhoneSummary {
 
   def row(answers: UserAnswers)(implicit messages: Messages): Option[SummaryListRow] =
-    answers.get(ContactHavePhonePage).map {
+    answers.get(FirstContactHavePhonePage).map {
       answer =>
         val value = if (answer) "site.yes" else "site.no"
 
         SummaryListRowViewModel(
-          key = "contactHavePhone.checkYourAnswersLabel",
+          key = "firstContactHavePhone.checkYourAnswersLabel",
           value = ValueViewModel(value),
           actions = Seq(
-            ActionItemViewModel("site.change", controllers.addFinancialInstitution.routes.ContactHavePhoneController.onPageLoad(CheckMode).url)
-              .withVisuallyHiddenText(messages("contactHavePhone.change.hidden"))
+            ActionItemViewModel("site.change", controllers.addFinancialInstitution.routes.FirstContactHavePhoneController.onPageLoad(CheckMode).url)
+              .withVisuallyHiddenText(messages("firstContactHavePhone.change.hidden"))
           )
         )
     }

diff --git a/...els/checkAnswers/ContactNameSummary.scala → ...heckAnswers/FirstContactNameSummary.scala b/...els/checkAnswers/ContactNameSummary.scala → ...heckAnswers/FirstContactNameSummary.scala
@@ -17,24 +17,24 @@
 package viewmodels.checkAnswers
 
 import models.{CheckMode, UserAnswers}
-import pages.addFinancialInstitution.ContactNamePage
+import pages.addFinancialInstitution.FirstContactNamePage
 import play.api.i18n.Messages
 import play.twirl.api.HtmlFormat
 import uk.gov.hmrc.govukfrontend.views.viewmodels.summarylist.SummaryListRow
 import viewmodels.govuk.summarylist._
 import viewmodels.implicits._
 
-object ContactNameSummary {
+object FirstContactNameSummary {
 
   def row(answers: UserAnswers)(implicit messages: Messages): Option[SummaryListRow] =
-    answers.get(ContactNamePage).map {
+    answers.get(FirstContactNamePage).map {
       answer =>
         SummaryListRowViewModel(
-          key = "contactName.checkYourAnswersLabel",
+          key = "firstContactName.checkYourAnswersLabel",
           value = ValueViewModel(HtmlFormat.escape(answer).toString),
           actions = Seq(
-            ActionItemViewModel("site.change", controllers.addFinancialInstitution.routes.ContactNameController.onPageLoad(CheckMode).url)
-              .withVisuallyHiddenText(messages("contactName.change.hidden"))
+            ActionItemViewModel("site.change", controllers.addFinancialInstitution.routes.FirstContactNameController.onPageLoad(CheckMode).url)
+              .withVisuallyHiddenText(messages("firstContactName.change.hidden"))
           )
         )
     }

diff --git a/...stitution/ContactHavePhoneView.scala.html → ...tion/FirstContactHavePhoneView.scala.html b/...stitution/ContactHavePhoneView.scala.html → ...tion/FirstContactHavePhoneView.scala.html
@@ -24,21 +24,21 @@
 
 @(form: Form[_], mode: Mode , finInstitution: String , contactName: String)(implicit request: Request[_], messages: Messages)
 
-@layout(pageTitle = title(form, messages("contactHavePhone.title.business"))) {
+@layout(pageTitle = title(form, messages("firstContactHavePhone.title.business"))) {
 
-    @formHelper(action = controllers.addFinancialInstitution.routes.ContactHavePhoneController.onSubmit(mode), Symbol("autoComplete") -> "off") {
+    @formHelper(action = controllers.addFinancialInstitution.routes.FirstContactHavePhoneController.onSubmit(mode), Symbol("autoComplete") -> "off") {
 
         @if(form.errors.nonEmpty) {
             @govukErrorSummary(ErrorSummaryViewModel(form))
         }
 
-      <h1 class="govuk-heading-l">@messages(messages(s"contactHavePhone.heading.business" , contactName))</h1>
-      <p class="govuk-body">@messages("contactHavePhone.p1" , finInstitution)</p>
+      <h1 class="govuk-heading-l">@messages(messages(s"firstContactHavePhone.heading.business" , contactName))</h1>
+      <p class="govuk-body">@messages("firstContactHavePhone.p1" , finInstitution)</p>
 
      @govukRadios(
          RadiosViewModel.yesNo(
                field = form("value"),
-               legend = LegendViewModel(messages("contactHavePhone.heading.business")).withCssClass("govuk-visually-hidden")
+               legend = LegendViewModel(messages("firstContactHavePhone.heading.business")).withCssClass("govuk-visually-hidden")
          )
      )
 

diff --git a/...ialInstitution/ContactNameView.scala.html → ...stitution/FirstContactNameView.scala.html b/...ialInstitution/ContactNameView.scala.html → ...stitution/FirstContactNameView.scala.html
@@ -26,9 +26,9 @@
 
 @(form: Form[_], mode: Mode, fiName: String)(implicit request: Request[_], messages: Messages)
 
-@layout(pageTitle = title(form, messages("contactName.title"))) {
+@layout(pageTitle = title(form, messages("firstContactName.title"))) {
 
-    @formHelper(action = controllers.addFinancialInstitution.routes.ContactNameController.onSubmit(mode)) {
+    @formHelper(action = controllers.addFinancialInstitution.routes.FirstContactNameController.onSubmit(mode)) {
 
         @if(form.errors.nonEmpty) {
             @govukErrorSummary(ErrorSummaryViewModel(form))
@@ -37,8 +37,8 @@
         @govukInput(
             InputViewModel(
                 field = form("value"),
-                label = LabelViewModel(messages("contactName.heading", fiName)).asPageHeading()
-            ).withHint(HintViewModel(Text(messages("contactName.hint"))))
+                label = LabelViewModel(messages("firstContactName.heading", fiName)).asPageHeading()
+            ).withHint(HintViewModel(Text(messages("firstContactName.hint"))))
             .withWidth(ThreeQuarters)
         )