Add A5-3 report with generic A5X base

Author: schbetsy

publication/src/main/scala/hmda/publication/reports/aggregate/A53.scala

@@ -2,65 +2,21 @@ package hmda.publication.reports.aggregate
 
 import akka.NotUsed
 import akka.stream.scaladsl.Source
-import hmda.model.publication.reports.{ ApplicantIncome, Disposition, MSAReport }
 import hmda.publication.reports._
-import hmda.publication.reports.util.ReportUtil._
-import hmda.publication.reports.util.ReportsMetaDataLookup
 import hmda.query.model.filing.LoanApplicationRegisterQuery
 
 import scala.concurrent.Future
 
-case class A53(
-  year: Int,
-  msa: MSAReport,
-  applicantIncomes: List[ApplicantIncome],
-  total: List[Disposition],
-  reportDate: String = formattedCurrentDate,
-  table: String = A53.metaData.reportTable,
-  description: String = A53.metaData.description
-) extends AggregateReport
-
 object A53 {
-  val metaData = ReportsMetaDataLookup.values("A53")
-  val dispositions = metaData.dispositions
 
-  // Table filters:
-  // Property Type 1,2
-  // Purpose of Loan 3
+  def filters(lar: LoanApplicationRegisterQuery): Boolean = {
+    (lar.propertyType == 1 || lar.propertyType == 2) &&
+      (lar.purpose == 3)
+  }
+
   def generate[ec: EC, mat: MAT, as: AS](
     larSource: Source[LoanApplicationRegisterQuery, NotUsed],
     fipsCode: Int
-  ): Future[A53] = {
-    val lars = larSource
-      .filter(lar => lar.msa != "NA")
-      .filter(lar => lar.msa.toInt == fipsCode)
-      .filter { lar =>
-        (lar.propertyType == 1 || lar.propertyType == 2) &&
-          (lar.purpose == 3)
-      }
-
-    val larsWithIncome = lars.filter(lar => lar.income != "NA")
-
-    val msa = msaReport(fipsCode.toString)
+  ): Future[A5X] = A5X.generate("A53", larSource, fipsCode, filters)
 
-    val incomeIntervals = calculateMedianIncomeIntervals(fipsCode)
-    val applicantIncomesF = applicantIncomesWithBorrowerCharacteristics(larsWithIncome, incomeIntervals, dispositions)
-
-    val yearF = calculateYear(larSource)
-    val totalF = calculateDispositions(lars, dispositions)
-
-    for {
-      applicantIncomes <- applicantIncomesF
-      year <- yearF
-      total <- totalF
-    } yield {
-
-      A53(
-        year,
-        msa,
-        applicantIncomes,
-        total
-      )
-    }
-  }
 }

publication/src/main/scala/hmda/publication/reports/aggregate/A5X.scala

@@ -0,0 +1,65 @@
+package hmda.publication.reports.aggregate
+
+import akka.NotUsed
+import akka.stream.scaladsl.Source
+import hmda.model.publication.reports.{ ApplicantIncome, Disposition, MSAReport }
+import hmda.publication.reports._
+import hmda.publication.reports.util.ReportUtil._
+import hmda.publication.reports.util.ReportsMetaDataLookup
+import hmda.query.model.filing.LoanApplicationRegisterQuery
+
+import scala.concurrent.Future
+
+case class A5X(
+  year: Int,
+  msa: MSAReport,
+  applicantIncomes: List[ApplicantIncome],
+  total: List[Disposition],
+  table: String,
+  description: String,
+  reportDate: String = formattedCurrentDate
+) extends AggregateReport
+
+object A5X {
+  def generate[ec: EC, mat: MAT, as: AS](
+    reportId: String,
+    larSource: Source[LoanApplicationRegisterQuery, NotUsed],
+    fipsCode: Int,
+    filters: LoanApplicationRegisterQuery => Boolean
+  ): Future[A5X] = {
+
+    val metaData = ReportsMetaDataLookup.values(reportId)
+    val dispositions = metaData.dispositions
+
+    val lars = larSource
+      .filter(lar => lar.msa != "NA")
+      .filter(lar => lar.msa.toInt == fipsCode)
+      .filter(filters)
+
+    val larsWithIncome = lars.filter(lar => lar.income != "NA")
+
+    val msa = msaReport(fipsCode.toString)
+
+    val incomeIntervals = calculateMedianIncomeIntervals(fipsCode)
+    val applicantIncomesF = applicantIncomesWithBorrowerCharacteristics(larsWithIncome, incomeIntervals, dispositions)
+
+    val yearF = calculateYear(larSource)
+    val totalF = calculateDispositions(lars, dispositions)
+
+    for {
+      applicantIncomes <- applicantIncomesF
+      year <- yearF
+      total <- totalF
+    } yield {
+
+      A5X(
+        year,
+        msa,
+        applicantIncomes,
+        total,
+        metaData.reportTable,
+        metaData.description
+      )
+    }
+  }
+}

publication/src/main/scala/hmda/publication/reports/aggregate/AggregateReport.scala

@@ -9,6 +9,7 @@ trait AggregateReport {
   val description: String
   val year: Int
   val msa: MSAReport
+  val reportDate: String
 
   val reportType: ReportTypeEnum = Aggregate
 }

publication/src/main/scala/hmda/publication/reports/protocol/aggregate/A53Protocol.scala renamed to publication/src/main/scala/hmda/publication/reports/protocol/aggregate/A5XProtocol.scala

@@ -2,20 +2,20 @@ package hmda.publication.reports.protocol.aggregate
 
 import hmda.model.publication.reports.{ ApplicantIncome, Disposition, MSAReport }
 import hmda.model.publication.reports.ReportTypeEnum._
-import hmda.publication.reports.aggregate.A53
+import hmda.publication.reports.aggregate.A5X
 import hmda.publication.reports.protocol.{ ApplicantIncomeProtocol, MSAReportProtocol, ReportTypeEnumProtocol }
 import spray.json._
 
-object A53Protocol
+object A5XProtocol
     extends DefaultJsonProtocol
     with ReportTypeEnumProtocol
     with MSAReportProtocol
     with ApplicantIncomeProtocol {
 
-  implicit object A53Format extends RootJsonFormat[A53] {
-    override def write(obj: A53): JsValue = {
+  implicit object A5XFormat extends RootJsonFormat[A5X] {
+    override def write(obj: A5X): JsValue = {
       JsObject(
-        "table" -> JsString("5-3"),
+        "table" -> JsString(obj.table),
         "type" -> JsString(Aggregate.toString),
         "desc" -> JsString(obj.description),
         "year" -> JsNumber(obj.year),
@@ -26,7 +26,7 @@ object A53Protocol
       )
     }
 
-    override def read(json: JsValue): A53 = json.asJsObject.getFields(
+    override def read(json: JsValue): A5X = json.asJsObject.getFields(
       "table",
       "type",
       "desc",
@@ -37,11 +37,13 @@ object A53Protocol
       "total"
     ) match {
         case Seq(table, reportType, description, year, reportDate, msa, applicantIncomes, total) =>
-          A53(
+          A5X(
             year.convertTo[Int],
             msa.convertTo[MSAReport],
             applicantIncomes.convertTo[List[ApplicantIncome]],
             total.convertTo[List[Disposition]],
+            table.convertTo[String],
+            description.convertTo[String],
             reportDate.convertTo[String]
           )
       }

publication/src/test/scala/hmda/publication/reports/aggregate/A53ProtocolSpec.scala

@@ -0,0 +1,31 @@
+package hmda.publication.reports.aggregate
+
+import hmda.publication.reports.protocol.aggregate.A5XProtocol._
+import org.scalatest.{ MustMatchers, PropSpec }
+import org.scalatest.prop.PropertyChecks
+import spray.json._
+import AggregateReportGenerators._
+
+class A5XProtocolSpec extends PropSpec with PropertyChecks with MustMatchers {
+
+  property("A5X Report must convert to and from JSON") {
+    forAll(a5XGen) { a5X =>
+      a5X.toJson.convertTo[A5X] mustBe a5X
+    }
+  }
+
+  property("A5X Report must serialize to the correct JSON format") {
+    forAll(a5XGen) { a5X =>
+      a5X.toJson mustBe JsObject(
+        "table" -> JsString(a5X.table),
+        "type" -> JsString("Aggregate"),
+        "desc" -> JsString(a5X.description),
+        "year" -> JsNumber(a5X.year),
+        "reportDate" -> JsString(a5X.reportDate),
+        "msa" -> a5X.msa.toJson,
+        "applicantIncomes" -> a5X.applicantIncomes.toJson,
+        "total" -> a5X.total.toJson
+      )
+    }
+  }
+}

publication/src/test/scala/hmda/publication/reports/aggregate/A5XProtocolSpec.scala

@@ -17,13 +17,15 @@ object AggregateReportGenerators {
     } yield A52(year, msa, applicantIncomes, total, reportDate)
   }
 
-  implicit def a53Gen: Gen[A53] = {
+  implicit def a5XGen: Gen[A5X] = {
     for {
       msa <- msaReportGen
       year = Calendar.getInstance().get(Calendar.YEAR)
       reportDate = formatDate(Calendar.getInstance().toInstant)
       applicantIncomes <- Gen.listOfN(5, applicantIncomeGen)
+      table <- Gen.alphaStr
+      description <- Gen.alphaStr
       total <- totalDispositionGen
-    } yield A53(year, msa, applicantIncomes, total, reportDate)
+    } yield A5X(year, msa, applicantIncomes, total, table, description, reportDate)
   }
 }