DTR-3651: Makes content changes and ordering PR-9 (#206)

anthoskountouris · web-flow · commit 55d194b630ec · 2026-03-12T14:24:05.000Z
diff --git a/app/models/purchaser/PurchaserReturnRequests.scala b/app/models/purchaser/PurchaserReturnRequests.scala
@@ -252,7 +252,7 @@ object CreateCompanyDetailsRequest {
             vatReference = purchaserCurrent.registrationNumber,
             compTypeBank = purchaserCurrent.purchaserTypeOfCompany.map(_.bank),
             compTypeBuilder = purchaserCurrent.purchaserTypeOfCompany.map(_.unincorporatedBuilder),
-            compTypeBuildsoc = purchaserCurrent.purchaserTypeOfCompany.map(_.buildingAssociation),
+            compTypeBuildsoc = purchaserCurrent.purchaserTypeOfCompany.map(_.buildingSociety),
             compTypeCentgov = purchaserCurrent.purchaserTypeOfCompany.map(_.centralGovernment),
             compTypeIndividual = purchaserCurrent.purchaserTypeOfCompany.map(_.individualOther),
             compTypeInsurance = purchaserCurrent.purchaserTypeOfCompany.map(_.insuranceAssurance),
@@ -322,7 +322,7 @@ object UpdateCompanyDetailsRequest {
             vatReference = purchaserCurrent.registrationNumber,
             compTypeBank = purchaserCurrent.purchaserTypeOfCompany.map(_.bank),
             compTypeBuilder = purchaserCurrent.purchaserTypeOfCompany.map(_.unincorporatedBuilder),
-            compTypeBuildsoc = purchaserCurrent.purchaserTypeOfCompany.map(_.buildingAssociation),
+            compTypeBuildsoc = purchaserCurrent.purchaserTypeOfCompany.map(_.buildingSociety),
             compTypeCentgov = purchaserCurrent.purchaserTypeOfCompany.map(_.centralGovernment),
             compTypeIndividual = purchaserCurrent.purchaserTypeOfCompany.map(_.individualOther),
             compTypeInsurance = purchaserCurrent.purchaserTypeOfCompany.map(_.insuranceAssurance),
diff --git a/app/models/purchaser/PurchaserTypeOfCompany.scala b/app/models/purchaser/PurchaserTypeOfCompany.scala
@@ -22,29 +22,61 @@ import uk.gov.hmrc.govukfrontend.views.viewmodels.checkboxes.CheckboxItem
 import uk.gov.hmrc.govukfrontend.views.viewmodels.content.Text
 import viewmodels.govuk.checkbox.*
 
-sealed trait PurchaserTypeOfCompany
+sealed trait PurchaserTypeOfCompany {
+  def order: Int
+}
 
 object PurchaserTypeOfCompany extends Enumerable.Implicits {
 
-  case object Bank extends WithName("bank") with PurchaserTypeOfCompany
-  case object BuildingAssociation extends WithName("buildingAssociation") with PurchaserTypeOfCompany
-  case object CentralGovernment extends WithName("centralGovernment") with PurchaserTypeOfCompany
-  case object IndividualOther extends WithName("individualOther") with PurchaserTypeOfCompany
-  case object InsuranceAssurance extends WithName("insuranceAssurance") with PurchaserTypeOfCompany
-  case object LocalAuthority extends WithName("localAuthority") with PurchaserTypeOfCompany
-  case object Partnership extends WithName("partnership") with PurchaserTypeOfCompany
-  case object PropertyCompany extends WithName("propertyCompany") with PurchaserTypeOfCompany
-  case object PublicCorporation extends WithName("publicCorporation") with PurchaserTypeOfCompany
-  case object OtherCompany extends WithName("otherCompany") with PurchaserTypeOfCompany
-  case object OtherFinancialInstitute extends WithName("otherFinancialInstitute") with PurchaserTypeOfCompany
-  case object OtherIncludingCharity extends WithName("otherIncludingCharity") with PurchaserTypeOfCompany
-  case object SuperannuationOrPensionFund extends WithName("superannuationOrPensionFund") with PurchaserTypeOfCompany
-  case object UnincorporatedBuilder extends WithName("unincorporatedBuilder") with PurchaserTypeOfCompany
-  case object UnincorporatedSoleTrader extends WithName("unincorporatedSoleTrader") with PurchaserTypeOfCompany
+  case object UnincorporatedBuilder extends WithName("unincorporatedBuilder") with PurchaserTypeOfCompany {
+    val order = 1
+  }
+  case object UnincorporatedSoleTrader extends WithName("unincorporatedSoleTrader") with PurchaserTypeOfCompany {
+    val order = 2
+  }
+  case object IndividualOther extends WithName("individualOther") with PurchaserTypeOfCompany {
+    val order = 3
+  }
+  case object Partnership extends WithName("partnership") with PurchaserTypeOfCompany {
+    val order = 4
+  }
+  case object LocalAuthority extends WithName("localAuthority") with PurchaserTypeOfCompany {
+    val order = 5
+  }
+  case object CentralGovernment extends WithName("centralGovernment") with PurchaserTypeOfCompany {
+    val order = 6
+  }
+  case object PublicCorporation extends WithName("publicCorporation") with PurchaserTypeOfCompany {
+    val order = 7
+  }
+  case object PropertyCompany extends WithName("propertyCompany") with PurchaserTypeOfCompany {
+    val order = 8
+  }
+  case object Bank extends WithName("bank") with PurchaserTypeOfCompany {
+    val order = 9
+  }
+  case object BuildingSociety extends WithName("buildingSociety") with PurchaserTypeOfCompany {
+    val order = 10
+  }
+  case object InsuranceAssurance extends WithName("insuranceAssurance") with PurchaserTypeOfCompany {
+    val order = 11
+  }
+  case object SuperannuationOrPensionFund extends WithName("superannuationOrPensionFund") with PurchaserTypeOfCompany {
+    val order = 12
+  }
+  case object OtherFinancialInstitute extends WithName("otherFinancialInstitute") with PurchaserTypeOfCompany {
+    val order = 13
+  }
+  case object OtherCompany extends WithName("otherCompany") with PurchaserTypeOfCompany {
+    val order = 14
+  }
+  case object OtherIncludingCharity extends WithName("otherIncludingCharity") with PurchaserTypeOfCompany {
+    val order = 15
+  }
 
   val values: Seq[PurchaserTypeOfCompany] = Seq(
     Bank,
-    BuildingAssociation,
+    BuildingSociety,
     CentralGovernment,
     IndividualOther,
     InsuranceAssurance,
@@ -58,7 +90,7 @@ object PurchaserTypeOfCompany extends Enumerable.Implicits {
     SuperannuationOrPensionFund,
     UnincorporatedBuilder,
     UnincorporatedSoleTrader
-  )
+  ).sortBy(_.order)
 
   def checkboxItems(implicit messages: Messages): Seq[CheckboxItem] =
     values.zipWithIndex.map {
diff --git a/app/models/purchaser/PurchaserTypeOfCompanyAnswers.scala b/app/models/purchaser/PurchaserTypeOfCompanyAnswers.scala
@@ -22,7 +22,7 @@ import play.api.libs.json.{Format, Json}
 
 case class PurchaserTypeOfCompanyAnswers(
                                           bank: String,
-                                          buildingAssociation: String,
+                                          buildingSociety: String,
                                           centralGovernment: String,
                                           individualOther: String,
                                           insuranceAssurance: String,
@@ -44,7 +44,7 @@ object PurchaserTypeOfCompanyAnswers {
   def fromSet(selected: Set[PurchaserTypeOfCompany]): PurchaserTypeOfCompanyAnswers = {
     PurchaserTypeOfCompanyAnswers(
       bank = if (selected.contains(Bank)) "YES" else "NO",
-      buildingAssociation = if (selected.contains(BuildingAssociation)) "YES" else "NO",
+      buildingSociety = if (selected.contains(BuildingSociety)) "YES" else "NO",
       centralGovernment = if (selected.contains(CentralGovernment)) "YES" else "NO",
       individualOther = if (selected.contains(IndividualOther)) "YES" else "NO",
       insuranceAssurance = if (selected.contains(InsuranceAssurance)) "YES" else "NO",
@@ -64,7 +64,7 @@ object PurchaserTypeOfCompanyAnswers {
   def toSet(answers: PurchaserTypeOfCompanyAnswers): Set[PurchaserTypeOfCompany] = {
     val allValues: Map[PurchaserTypeOfCompany, String] = Map(
       Bank -> answers.bank,
-      BuildingAssociation -> answers.buildingAssociation,
+      BuildingSociety -> answers.buildingSociety,
       CentralGovernment -> answers.centralGovernment,
       IndividualOther -> answers.individualOther,
       InsuranceAssurance -> answers.insuranceAssurance,
diff --git a/app/viewmodels/checkAnswers/purchaser/PurchaserTypeOfCompanySummary.scala b/app/viewmodels/checkAnswers/purchaser/PurchaserTypeOfCompanySummary.scala
@@ -32,9 +32,8 @@ object PurchaserTypeOfCompanySummary {
     answers.flatMap(_.get(PurchaserTypeOfCompanyPage)).map {
       answersObject =>
 
-        val selectedItems = PurchaserTypeOfCompanyAnswers.toSet(answersObject)
+        val selectedItems = PurchaserTypeOfCompanyAnswers.toSet(answersObject).toSeq.sortBy(_.order)
           .map(_.toString)
-          .toSeq.sorted
 
         val value = ValueViewModel(
           HtmlContent(
diff --git a/conf/messages.en b/conf/messages.en
@@ -665,21 +665,21 @@ purchaser.companyFormOfId.countryIssued.change.hidden
 purchaser.purchaserTypeOfCompany.title                                              = What type of company is the purchaser? - About the purchaser
 purchaser.purchaserTypeOfCompany.heading                                            = What type of company is {0}?
 purchaser.purchaserTypeOfCompany.hint                                               = Select up to four
-purchaser.purchaserTypeOfCompany.bank                                               = Bank
-purchaser.purchaserTypeOfCompany.buildingAssociation                                = Building association
-purchaser.purchaserTypeOfCompany.centralGovernment                                  = Central government
-purchaser.purchaserTypeOfCompany.individualOther                                    = Individual other than sole trader
-purchaser.purchaserTypeOfCompany.insuranceAssurance                                 = Insurance/Assurance company
-purchaser.purchaserTypeOfCompany.localAuthority                                     = Local authority
-purchaser.purchaserTypeOfCompany.partnership                                        = Partnership
-purchaser.purchaserTypeOfCompany.propertyCompany                                    = Property company
-purchaser.purchaserTypeOfCompany.publicCorporation                                  = Public corporation
-purchaser.purchaserTypeOfCompany.otherCompany                                       = Other company
-purchaser.purchaserTypeOfCompany.otherFinancialInstitute                            = Other financial institute
-purchaser.purchaserTypeOfCompany.otherIncludingCharity                              = Other, including charity
-purchaser.purchaserTypeOfCompany.superannuationOrPensionFund                        = Superannuation or pension fund
-purchaser.purchaserTypeOfCompany.unincorporatedBuilder                              = Unincorporated builder
-purchaser.purchaserTypeOfCompany.unincorporatedSoleTrader                           = Unincorporated sole trader other than builder
+purchaser.purchaserTypeOfCompany.bank                                               = 09 - Bank
+purchaser.purchaserTypeOfCompany.buildingSociety                                    = 10 - Building society
+purchaser.purchaserTypeOfCompany.centralGovernment                                  = 06 - Central government
+purchaser.purchaserTypeOfCompany.individualOther                                    = 03 - Individual other than sole trader
+purchaser.purchaserTypeOfCompany.insuranceAssurance                                 = 11 - Insurance or assurance company
+purchaser.purchaserTypeOfCompany.localAuthority                                     = 05 - Local authority
+purchaser.purchaserTypeOfCompany.partnership                                        = 04 - Partnership
+purchaser.purchaserTypeOfCompany.propertyCompany                                    = 08 - Property company
+purchaser.purchaserTypeOfCompany.publicCorporation                                  = 07 - Public corporation
+purchaser.purchaserTypeOfCompany.otherCompany                                       = 14 - Other company
+purchaser.purchaserTypeOfCompany.otherFinancialInstitute                            = 13 - Other financial institute
+purchaser.purchaserTypeOfCompany.otherIncludingCharity                              = 15 - Other, including charity
+purchaser.purchaserTypeOfCompany.superannuationOrPensionFund                        = 12 - Superannuation or pension fund
+purchaser.purchaserTypeOfCompany.unincorporatedBuilder                              = 01 - Unincorporated builder
+purchaser.purchaserTypeOfCompany.unincorporatedSoleTrader                           = 02 - Unincorporated sole trader other than builder
 purchaser.purchaserTypeOfCompany.checkYourAnswersLabel                              = Type of company
 purchaser.purchaserTypeOfCompany.error.required                                     = Select type of company
 purchaser.purchaserTypeOfCompany.change.hidden                                      = Type of company
diff --git a/test/controllers/purchaser/PurchaserCheckYourAnswersControllerSpec.scala b/test/controllers/purchaser/PurchaserCheckYourAnswersControllerSpec.scala
@@ -92,7 +92,7 @@ class PurchaserCheckYourAnswersControllerSpec extends SpecBase with SummaryListF
         "purchaserFormOfIdCompany" -> JsNull,
         "purchaserTypeOfCompany" -> Json.obj(
           "bank" -> "YES",
-          "buildingAssociation" -> "NO",
+          "buildingSociety" -> "NO",
           "centralGovernment" -> "NO",
           "individualOther" -> "NO",
           "insuranceAssurance" -> "NO",
diff --git a/test/controllers/purchaser/PurchaserTypeOfCompanyControllerSpec.scala b/test/controllers/purchaser/PurchaserTypeOfCompanyControllerSpec.scala
@@ -104,7 +104,7 @@ class PurchaserTypeOfCompanyControllerSpec extends SpecBase with MockitoSugar {
     "must populate the view correctly on a GET when the question has previously been answered" in {
 
       val userAnswers = testUserAnswersCompany.set(PurchaserTypeOfCompanyPage, PurchaserTypeOfCompanyAnswers(bank = "YES",
-        buildingAssociation = "YES",
+        buildingSociety = "YES",
         centralGovernment = "NO",
         individualOther = "NO",
         insuranceAssurance = "NO",
@@ -129,7 +129,7 @@ class PurchaserTypeOfCompanyControllerSpec extends SpecBase with MockitoSugar {
         val result = route(application, request).value
 
         status(result) mustEqual OK
-        contentAsString(result) mustEqual view(form.fill(Set(PurchaserTypeOfCompany.Bank, PurchaserTypeOfCompany.BuildingAssociation)), NormalMode, "John Middle Doe")(request, messages(application)).toString
+        contentAsString(result) mustEqual view(form.fill(Set(PurchaserTypeOfCompany.Bank, PurchaserTypeOfCompany.BuildingSociety)), NormalMode, "John Middle Doe")(request, messages(application)).toString
       }
     }
 
diff --git a/test/models/FullReturnSpec.scala b/test/models/FullReturnSpec.scala
@@ -230,7 +230,7 @@ class FullReturnSpec extends AnyFreeSpec with Matchers with EitherValues with Op
         "purchaserFormOfIdCompany" -> JsNull,
         "purchaserTypeOfCompany" -> Json.obj(
           "bank" -> "YES",
-          "buildingAssociation" -> "YES",
+          "buildingSociety" -> "YES",
           "centralGovernment" -> "NO",
           "individualOther" -> "NO",
           "insuranceAssurance" -> "NO",
diff --git a/test/models/purchaser/PurchaserReturnRequestsSpec.scala b/test/models/purchaser/PurchaserReturnRequestsSpec.scala
@@ -401,7 +401,7 @@ class PurchaserReturnRequestsSpec extends AnyFreeSpec with Matchers with EitherV
         "purchaserFormOfIdCompany" -> JsNull,
         "purchaserTypeOfCompany" -> Json.obj(
           "bank" -> "NO",
-          "buildingAssociation" -> "NO",
+          "buildingSociety" -> "NO",
           "centralGovernment" -> "NO",
           "individualOther" -> "NO",
           "insuranceAssurance" -> "NO",
diff --git a/test/models/purchaser/PurchaserSessionQuestionsSpec.scala b/test/models/purchaser/PurchaserSessionQuestionsSpec.scala
@@ -72,7 +72,7 @@ class PurchaserSessionQuestionsSpec extends AnyFreeSpec with Matchers with Eithe
         ),
         "purchaserTypeOfCompany" -> Json.obj(
           "bank" -> "YES",
-          "buildingAssociation" -> "NO",
+          "buildingSociety" -> "NO",
           "centralGovernment" -> "NO",
           "individualOther" -> "NO",
           "insuranceAssurance" -> "NO",
@@ -171,7 +171,7 @@ class PurchaserSessionQuestionsSpec extends AnyFreeSpec with Matchers with Eithe
               purchaserTypeOfCompany  = Some(
                 PurchaserTypeOfCompanyAnswers(
                   bank = "YES",
-                  buildingAssociation = "NO",
+                  buildingSociety = "NO",
                   centralGovernment = "NO",
                   individualOther = "NO",
                   insuranceAssurance = "NO",
diff --git a/test/services/purchaser/PurchaserCreateOrUpdateServiceSpec.scala b/test/services/purchaser/PurchaserCreateOrUpdateServiceSpec.scala
@@ -101,7 +101,7 @@ class PurchaserCreateOrUpdateServiceSpec extends SpecBase with MockitoSugar {
         "purchaserFormOfIdCompany" -> JsNull,
         "purchaserTypeOfCompany" -> Json.obj(
           "bank" -> "YES",
-          "buildingAssociation" -> "NO",
+          "buildingSociety" -> "NO",
           "centralGovernment" -> "NO",
           "individualOther" -> "NO",
           "insuranceAssurance" -> "NO",
@@ -165,7 +165,7 @@ class PurchaserCreateOrUpdateServiceSpec extends SpecBase with MockitoSugar {
         "purchaserFormOfIdCompany" -> JsNull,
         "purchaserTypeOfCompany" -> Json.obj(
           "bank" -> "YES",
-          "buildingAssociation" -> "NO",
+          "buildingSociety" -> "NO",
           "centralGovernment" -> "NO",
           "individualOther" -> "NO",
           "insuranceAssurance" -> "NO",
@@ -229,7 +229,7 @@ class PurchaserCreateOrUpdateServiceSpec extends SpecBase with MockitoSugar {
         "purchaserFormOfIdCompany" -> JsNull,
         "purchaserTypeOfCompany" -> Json.obj(
           "bank" -> "YES",
-          "buildingAssociation" -> "NO",
+          "buildingSociety" -> "NO",
           "centralGovernment" -> "NO",
           "individualOther" -> "NO",
           "insuranceAssurance" -> "NO",
@@ -292,7 +292,7 @@ class PurchaserCreateOrUpdateServiceSpec extends SpecBase with MockitoSugar {
         "purchaserFormOfIdCompany" -> JsNull,
         "purchaserTypeOfCompany" -> Json.obj(
           "bank" -> "YES",
-          "buildingAssociation" -> "NO",
+          "buildingSociety" -> "NO",
           "centralGovernment" -> "NO",
           "individualOther" -> "NO",
           "insuranceAssurance" -> "NO",
@@ -403,7 +403,7 @@ class PurchaserCreateOrUpdateServiceSpec extends SpecBase with MockitoSugar {
 //        "purchaserFormOfIdCompany" -> JsNull,
 //        "purchaserTypeOfCompany" -> Json.obj(
 //          "bank" -> "YES",
-//          "buildingAssociation" -> "NO",
+//          "buildingSociety" -> "NO",
 //          "centralGovernment" -> "NO",
 //          "individualOther" -> "NO",
 //          "insuranceAssurance" -> "NO",
diff --git a/test/services/purchaser/PurchaserServiceSpec.scala b/test/services/purchaser/PurchaserServiceSpec.scala
diff --git a/test/services/purchaser/PurchaserSessionServiceSpec.scala b/test/services/purchaser/PurchaserSessionServiceSpec.scala
diff --git a/test/viewmodels/checkAnswers/purchaser/PurchaserTypeOfCompanySummarySpec.scala b/test/viewmodels/checkAnswers/purchaser/PurchaserTypeOfCompanySummarySpec.scala

Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ class PurchaserTypeOfCompanyControllerSpec extends SpecBase with MockitoSugar {`
`104`	`104`	`"must populate the view correctly on a GET when the question has previously been answered" in {`
`105`	`105`
`106`	`106`	`val userAnswers = testUserAnswersCompany.set(PurchaserTypeOfCompanyPage, PurchaserTypeOfCompanyAnswers(bank = "YES",`
`107`		`- buildingAssociation = "YES",`
	`107`	`+ buildingSociety = "YES",`
`108`	`108`	`centralGovernment = "NO",`
`109`	`109`	`individualOther = "NO",`
`110`	`110`	`insuranceAssurance = "NO",`
`@@ -129,7 +129,7 @@ class PurchaserTypeOfCompanyControllerSpec extends SpecBase with MockitoSugar {`
`129`	`129`	`val result = route(application, request).value`
`130`	`130`
`131`	`131`	`status(result) mustEqual OK`
`132`		`- contentAsString(result) mustEqual view(form.fill(Set(PurchaserTypeOfCompany.Bank, PurchaserTypeOfCompany.BuildingAssociation)), NormalMode, "John Middle Doe")(request, messages(application)).toString`
	`132`	`+ contentAsString(result) mustEqual view(form.fill(Set(PurchaserTypeOfCompany.Bank, PurchaserTypeOfCompany.BuildingSociety)), NormalMode, "John Middle Doe")(request, messages(application)).toString`
`133`	`133`	`}`
`134`	`134`	`}`
`135`	`135`