cleanup and json format

Author: Nick Grippin

model/shared/src/main/scala/hmda/model/publication/reports/ApplicantIncome.scala

@@ -2,5 +2,19 @@ package hmda.model.publication.reports
 
 case class ApplicantIncome(
   applicantIncome: ApplicantIncomeEnum,
-  borrowerCharacteristics: List[BorrowerCharacteristic]
+  characteristics: Characteristics
 )
+
+case class Characteristics(
+    raceBorrowerCharacteristic: RaceBorrowerCharacteristic,
+    ethnicityBorrowerCharacteristic: EthnicityBorrowerCharacteristic,
+    minorityStatusBorrowerCharacteristic: MinorityStatusBorrowerCharacteristic
+) {
+  def +(other: Characteristics): Characteristics = {
+    Characteristics(
+      raceBorrowerCharacteristic + other.raceBorrowerCharacteristic,
+      ethnicityBorrowerCharacteristic + other.ethnicityBorrowerCharacteristic,
+      minorityStatusBorrowerCharacteristic + other.minorityStatusBorrowerCharacteristic
+    )
+  }
+}

model/shared/src/main/scala/hmda/model/publication/reports/Characteristic.scala

@@ -20,7 +20,6 @@ case class EthnicityCharacteristic(ethnicity: EthnicityEnum, dispositions: List[
   }
 }
 
-
 case class MinorityStatusCharacteristic(minorityStatus: MinorityStatusEnum, dispositions: List[Disposition]) extends Characteristic {
   def +(msc: MinorityStatusCharacteristic) = {
     val combined = dispositions.map(d =>

model/shared/src/main/scala/hmda/model/publication/reports/Disposition.scala

@@ -1,9 +1,9 @@
 package hmda.model.publication.reports
 
 case class Disposition(
-  disposition: ActionTakenTypeEnum,
-  count: Int,
-  value: Int
+    disposition: ActionTakenTypeEnum,
+    count: Int,
+    value: Int
 ) {
   def +(disp: Disposition): Disposition = {
     Disposition(disposition, count + disp.count, value + disp.value)

publication/src/main/scala/hmda/publication/reports/national/N52.scala

@@ -3,41 +3,30 @@ package hmda.publication.reports.national
 import akka.NotUsed
 import akka.stream.scaladsl.Source
 import hmda.census.model.MsaIncomeLookup
-import hmda.model.publication.reports.ApplicantIncomeEnum._
 import hmda.model.publication.reports._
 import hmda.publication.reports._
 import hmda.publication.reports.aggregate.A52
+import hmda.publication.reports.util.ReportUtil._
 import hmda.publication.reports.util.ReportsMetaDataLookup
 import hmda.query.model.filing.LoanApplicationRegisterQuery
 
 import scala.concurrent.Future
 
 case class N52(
-                year: Int = 0,
-                reportDate: String = "",
-                applicantIncomes: List[ApplicantIncome] = List(),
-                total: List[Disposition] = List(),
-                table: String = N52.metaData.reportTable,
-                description: String = N52.metaData.description
-              ) extends NationalAggregateReport {
+    year: Int = 0,
+    reportDate: String = formattedCurrentDate,
+    applicantIncomes: List[ApplicantIncome] = List(),
+    total: List[Disposition] = List(),
+    table: String = N52.metaData.reportTable,
+    description: String = N52.metaData.description
+) extends NationalAggregateReport {
   def +(a52: A52): N52 = {
-    val combinedIncomes = a52.applicantIncomes.map(income => {
-      val bc = applicantIncomes.find(i => i.applicantIncome == income.applicantIncome).get.borrowerCharacteristics
-
-      val originalRc = bc.find(_.isInstanceOf[RaceBorrowerCharacteristic]).get.asInstanceOf[RaceBorrowerCharacteristic]
-      val additionalRc = income.borrowerCharacteristics.find(_.isInstanceOf[RaceBorrowerCharacteristic]).get.asInstanceOf[RaceBorrowerCharacteristic]
-
-      val originalEc = bc.find(_.isInstanceOf[EthnicityBorrowerCharacteristic]).get.asInstanceOf[EthnicityBorrowerCharacteristic]
-      val additionalEc = income.borrowerCharacteristics.find(_.isInstanceOf[EthnicityBorrowerCharacteristic]).get.asInstanceOf[EthnicityBorrowerCharacteristic]
 
-      val originalMsc = bc.find(_.isInstanceOf[MinorityStatusBorrowerCharacteristic]).get.asInstanceOf[MinorityStatusBorrowerCharacteristic]
-      val additionalMsc = income.borrowerCharacteristics.find(_.isInstanceOf[MinorityStatusBorrowerCharacteristic]).get.asInstanceOf[MinorityStatusBorrowerCharacteristic]
+    val combinedIncomes = a52.applicantIncomes.map(income => {
+      val newC = applicantIncomes.find(i => i.applicantIncome == income.applicantIncome).get.characteristics
+      val originalC = income.characteristics
 
-      ApplicantIncome(income.applicantIncome, List(
-        originalRc + additionalRc,
-        originalEc + additionalEc,
-        originalMsc + additionalMsc
-      ))
+      ApplicantIncome(income.applicantIncome, newC + originalC)
     })
 
     val combinedDispositions = a52.total.map(disposition => {
@@ -60,9 +49,14 @@ object N52 {
   def generate[ec: EC, mat: MAT, as: AS](larSource: Source[LoanApplicationRegisterQuery, NotUsed]): Future[N52] = {
     val fipsList = MsaIncomeLookup.values.map(_.fips)
 
-    fipsList.foldLeft(N52())((n, f) => {
-      val a52 = A52.generate(larSource, f)
-      a52.map{report => n + report}
+    val a52List = fipsList.map(fipsCode => A52.generate(larSource, fipsCode))
+    val n52f = Future.sequence(a52List).map(seq => {
+      seq.foldLeft(N52())((n52, a52) => n52 + a52)
     })
+
+    for {
+      n <- n52f
+      y <- calculateYear(larSource)
+    } yield N52(y, n.reportDate, n.applicantIncomes, n.total)
   }
 }

publication/src/main/scala/hmda/publication/reports/protocol/ApplicantIncomeProtocol.scala

@@ -1,7 +1,11 @@
 package hmda.publication.reports.protocol
 
-import hmda.model.publication.reports.ApplicantIncome
+import hmda.model.publication.reports.{ ApplicantIncome, Characteristics }
 
-trait ApplicantIncomeProtocol extends ApplicantIncomeEnumProtocol with BorrowerCharacteristicProtocol {
+trait ApplicantIncomeProtocol extends ApplicantIncomeEnumProtocol with CharacteristicsProtocol {
   implicit val applicantIncomeFormat = jsonFormat2(ApplicantIncome.apply)
 }
+
+trait CharacteristicsProtocol extends BorrowerCharacteristicProtocol {
+  implicit val characteristicsProtocol = jsonFormat3(Characteristics.apply)
+}

publication/src/main/scala/hmda/publication/reports/protocol/BorrowerCharacteristicProtocol.scala

@@ -5,45 +5,48 @@ import spray.json._
 
 trait BorrowerCharacteristicProtocol extends CharacteristicProtocol {
 
-  implicit object BorrowerCharacteristicFormat extends RootJsonFormat[BorrowerCharacteristic] {
-    override def write(obj: BorrowerCharacteristic): JsValue = obj match {
-
-      case RaceBorrowerCharacteristic(races) =>
-        JsObject(
-          "characteristic" -> JsString("Race"),
-          "races" -> races.toJson
-        )
-
-      case EthnicityBorrowerCharacteristic(ethnicities) =>
-        JsObject(
-          "characteristic" -> JsString("Ethnicity"),
-          "ethnicities" -> ethnicities.toJson
-        )
-
-      case MinorityStatusBorrowerCharacteristic(minorityStatus) =>
-        JsObject(
-          "characteristic" -> JsString("Minority Status"),
-          "minorityStatus" -> minorityStatus.toJson
-        )
-
-    }
-
-    override def read(json: JsValue): BorrowerCharacteristic = json match {
+  implicit object RaceBorrowerCharacteristicFormat extends RootJsonFormat[RaceBorrowerCharacteristic] {
+    override def write(obj: RaceBorrowerCharacteristic): JsValue =
+      JsObject(
+        "characteristic" -> JsString("Race"),
+        "races" -> obj.toJson
+      )
+
+    override def read(json: JsValue): RaceBorrowerCharacteristic = json match {
       case JsObject(fields) if fields.isDefinedAt("races") =>
         RaceBorrowerCharacteristic(
           fields("races").convertTo[List[RaceCharacteristic]]
         )
+    }
+  }
+
+  implicit object EthnicityBorrowerCharacteristicFormat extends RootJsonFormat[EthnicityBorrowerCharacteristic] {
+    override def write(obj: EthnicityBorrowerCharacteristic): JsValue =
+      JsObject(
+        "characteristic" -> JsString("Ethnicity"),
+        "ethnicities" -> obj.toJson
+      )
 
+    override def read(json: JsValue): EthnicityBorrowerCharacteristic = json match {
       case JsObject(fields) if fields.isDefinedAt("ethnicities") =>
         EthnicityBorrowerCharacteristic(
           fields("ethnicities").convertTo[List[EthnicityCharacteristic]]
         )
+    }
+  }
 
+  implicit object MinorityStatusBorrowerCharacteristicFormat extends RootJsonFormat[MinorityStatusBorrowerCharacteristic] {
+    override def write(obj: MinorityStatusBorrowerCharacteristic): JsValue =
+      JsObject(
+        "characteristic" -> JsString("Minority Status"),
+        "minorityStatus" -> obj.toJson
+      )
+
+    override def read(json: JsValue): MinorityStatusBorrowerCharacteristic = json match {
       case JsObject(fields) if fields.isDefinedAt("minorityStatus") =>
         MinorityStatusBorrowerCharacteristic(
           fields("minorityStatus").convertTo[List[MinorityStatusCharacteristic]]
         )
     }
-
   }
 }

publication/src/main/scala/hmda/publication/reports/util/ReportUtil.scala

@@ -118,16 +118,15 @@ object ReportUtil extends SourceUtils {
   def borrowerCharacteristicsByIncomeInterval[ec: EC, mat: MAT, as: AS](
     larsByIncome: Map[ApplicantIncomeEnum, Source[LoanApplicationRegisterQuery, NotUsed]],
     dispositions: List[DispositionType]
-  ): Map[ApplicantIncomeEnum, Future[List[BorrowerCharacteristic]]] = {
+  ): Map[ApplicantIncomeEnum, Future[Characteristics]] = {
     larsByIncome.map {
       case (income, lars) =>
-        val characteristics = Future.sequence(
-          List(
-            raceBorrowerCharacteristic(lars, dispositions),
-            ethnicityBorrowerCharacteristic(lars, dispositions),
-            minorityStatusBorrowerCharacteristic(lars, dispositions)
-          )
-        )
+        val characteristics =
+          for {
+            r <- raceBorrowerCharacteristic(lars, dispositions)
+            e <- ethnicityBorrowerCharacteristic(lars, dispositions)
+            m <- minorityStatusBorrowerCharacteristic(lars, dispositions)
+          } yield Characteristics(r, e, m)
         income -> characteristics
     }
   }