Use generic D5-X report structure instead of specific D5-3

Author: schbetsy

publication/src/main/scala/hmda/publication/reports/disclosure/D53.scala

@@ -2,74 +2,26 @@ package hmda.publication.reports.disclosure
 
 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 D53(
-  respondentId: String,
-  institutionName: String,
-  year: Int,
-  msa: MSAReport,
-  applicantIncomes: List[ApplicantIncome],
-  total: List[Disposition],
-  reportDate: String = formattedCurrentDate,
-  table: String = D53.metaData.reportTable,
-  description: String = D53.metaData.description
-) extends DisclosureReport
-
 object D53 {
-  val metaData = ReportsMetaDataLookup.values("D53")
-  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,
     respondentId: String,
     institutionNameF: Future[String]
-  ): Future[D53] = {
-
-    val lars = larSource
-      .filter(lar => lar.respondentId == respondentId)
-      .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)
-
-    val incomeIntervals = calculateMedianIncomeIntervals(fipsCode)
-    val applicantIncomesF = applicantIncomesWithBorrowerCharacteristics(larsWithIncome, incomeIntervals, dispositions)
-
-    val yearF = calculateYear(larSource)
-    val totalF = calculateDispositions(lars, dispositions)
-
-    for {
-      institutionName <- institutionNameF
-      year <- yearF
-      applicantIncomes <- applicantIncomesF
-      total <- totalF
-    } yield {
+  ): Future[Series5DisclosureReport] = {
 
-      D53(
-        respondentId,
-        institutionName,
-        year,
-        msa,
-        applicantIncomes,
-        total
-      )
-    }
+    D5X.generate("D53", filters, larSource, fipsCode, respondentId, institutionNameF)
 
   }
 

publication/src/main/scala/hmda/publication/reports/disclosure/DisclosureReport.scala

@@ -1,7 +1,15 @@
 package hmda.publication.reports.disclosure
 
-import hmda.model.publication.reports.{ MSAReport, ReportTypeEnum }
+import hmda.publication.reports._
+import hmda.model.publication.reports.{ ApplicantIncome, Disposition, MSAReport, ReportTypeEnum }
 import hmda.model.publication.reports.ReportTypeEnum.Disclosure
+import hmda.publication.reports.util.ReportsMetaDataLookup
+import hmda.publication.reports.util.ReportUtil._
+import akka.NotUsed
+import akka.stream.scaladsl.Source
+import hmda.query.model.filing.LoanApplicationRegisterQuery
+
+import scala.concurrent.Future
 
 trait DisclosureReport {
 
@@ -11,7 +19,71 @@ trait DisclosureReport {
   val table: String
   val year: Int
   val msa: MSAReport
+  val reportDate: String
 
   val reportType: ReportTypeEnum = Disclosure
 
 }
+
+case class Series5DisclosureReport(
+  respondentId: String,
+  institutionName: String,
+  year: Int,
+  msa: MSAReport,
+  applicantIncomes: List[ApplicantIncome],
+  total: List[Disposition],
+  table: String,
+  description: String,
+  reportDate: String = formattedCurrentDate
+) extends DisclosureReport
+
+object D5X {
+  def generate[ec: EC, mat: MAT, as: AS](
+    reportId: String,
+    filters: LoanApplicationRegisterQuery => Boolean,
+    larSource: Source[LoanApplicationRegisterQuery, NotUsed],
+    fipsCode: Int,
+    respondentId: String,
+    institutionNameF: Future[String]
+  ): Future[Series5DisclosureReport] = {
+
+    val metaData = ReportsMetaDataLookup.values(reportId)
+    val dispositions = metaData.dispositions
+
+    val lars = larSource
+      .filter(lar => lar.respondentId == respondentId)
+      .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 = incomeIntervalsForMsa(fipsCode)
+    val applicantIncomesF = applicantIncomesByInterval(larsWithIncome, incomeIntervals, dispositions)
+
+    val yearF = reportYear(larSource)
+    val totalF = calculateDispositions(lars, dispositions)
+
+    for {
+      institutionName <- institutionNameF
+      year <- yearF
+      applicantIncomes <- applicantIncomesF
+      total <- totalF
+    } yield {
+
+      Series5DisclosureReport(
+        respondentId,
+        institutionName,
+        year,
+        msa,
+        applicantIncomes,
+        total,
+        metaData.reportTable,
+        metaData.description
+      )
+    }
+
+  }
+}

publication/src/main/scala/hmda/publication/reports/protocol/disclosure/D53Protocol.scala renamed to publication/src/main/scala/hmda/publication/reports/protocol/disclosure/D5XProtocol.scala

@@ -2,25 +2,24 @@ package hmda.publication.reports.protocol.disclosure
 
 import hmda.model.publication.reports.{ ApplicantIncome, Disposition, MSAReport }
 import hmda.model.publication.reports.ReportTypeEnum.Disclosure
-import hmda.publication.reports.disclosure.D53
+import hmda.publication.reports.disclosure.Series5DisclosureReport
 import hmda.publication.reports.protocol.{ ApplicantIncomeProtocol, MSAReportProtocol, ReportTypeEnumProtocol }
-
 import spray.json._
 import spray.json.DefaultJsonProtocol
 
-object D53Protocol
+object D5XProtocol
     extends DefaultJsonProtocol
     with ReportTypeEnumProtocol
     with MSAReportProtocol
     with ApplicantIncomeProtocol {
 
-  implicit object D53Format extends RootJsonFormat[D53] {
+  implicit object D5XFormat extends RootJsonFormat[Series5DisclosureReport] {
 
-    override def write(obj: D53): JsValue = {
+    override def write(obj: Series5DisclosureReport): JsValue = {
       JsObject(
         "respondentId" -> JsString(obj.respondentId),
         "institutionName" -> JsString(obj.institutionName),
-        "table" -> JsString("5-3"),
+        "table" -> JsString(obj.table),
         "type" -> JsString(Disclosure.toString),
         "desc" -> JsString(obj.description),
         "year" -> JsNumber(obj.year),
@@ -31,23 +30,27 @@ object D53Protocol
       )
     }
 
-    override def read(json: JsValue): D53 = json.asJsObject.getFields(
+    override def read(json: JsValue): Series5DisclosureReport = json.asJsObject.getFields(
       "respondentId",
       "institutionName",
       "year",
       "reportDate",
       "msa",
       "applicantIncomes",
-      "total"
+      "total",
+      "table",
+      "desc"
     ) match {
-        case Seq(respondentId, institutionName, year, reportDate, msa, applicantIncomes, total) =>
-          D53(
+        case Seq(respondentId, institutionName, year, reportDate, msa, applicantIncomes, total, table, desc) =>
+          Series5DisclosureReport(
             respondentId.convertTo[String],
             institutionName.convertTo[String],
             year.convertTo[Int],
             msa.convertTo[MSAReport],
             applicantIncomes.convertTo[List[ApplicantIncome]],
             total.convertTo[List[Disposition]],
+            table.convertTo[String],
+            desc.convertTo[String],
             reportDate.convertTo[String]
           )
       }

publication/src/test/scala/hmda/publication/reports/disclosure/D53ProtocolSpec.scala

@@ -0,0 +1,33 @@
+package hmda.publication.reports.disclosure
+
+import hmda.publication.reports.protocol.disclosure.D5XProtocol._
+import org.scalatest.prop.PropertyChecks
+import org.scalatest.{ MustMatchers, PropSpec }
+import spray.json._
+import DisclosureReportGenerators._
+
+class D5XProtocolSpec extends PropSpec with PropertyChecks with MustMatchers {
+
+  property("D5X Report must convert to and from JSON") {
+    forAll(d5XGen) { d5X =>
+      d5X.toJson.convertTo[Series5DisclosureReport] mustBe d5X
+    }
+  }
+
+  property("D5X Report must serialize to the correct JSON format") {
+    forAll(d5XGen) { d5X =>
+      d5X.toJson mustBe JsObject(
+        "respondentId" -> JsString(d5X.respondentId),
+        "institutionName" -> JsString(d5X.institutionName),
+        "table" -> JsString("D5-X"),
+        "type" -> JsString("Disclosure"),
+        "desc" -> JsString("description"),
+        "year" -> JsNumber(d5X.year),
+        "reportDate" -> JsString(d5X.reportDate),
+        "msa" -> d5X.msa.toJson,
+        "applicantIncomes" -> d5X.applicantIncomes.toJson,
+        "total" -> d5X.total.toJson
+      )
+    }
+  }
+}

publication/src/test/scala/hmda/publication/reports/disclosure/D5XProtocolSpec.scala

@@ -7,19 +7,18 @@ import hmda.publication.reports.util.DateUtil._
 
 object DisclosureReportGenerators {
 
-  def d51Gen: Gen[D51] = {
+  def d5XGen: Gen[Series5DisclosureReport] = {
     for {
       respId <- Gen.alphaStr
       instName <- Gen.alphaStr
       year = Calendar.getInstance().get(Calendar.YEAR)
-      reportDate = formatDate(Calendar.getInstance().toInstant)
       msa <- msaReportGen
       applicantIncomes <- Gen.listOfN(5, applicantIncomeGen)
       total <- totalDispositionGen
-    } yield D51(respId, instName, year, msa, applicantIncomes, total, reportDate)
+    } yield Series5DisclosureReport(respId, instName, year, msa, applicantIncomes, total, "D5-X", "description")
   }
 
-  def d53Gen: Gen[D53] = {
+  def d51Gen: Gen[D51] = {
     for {
       respId <- Gen.alphaStr
       instName <- Gen.alphaStr
@@ -28,7 +27,7 @@ object DisclosureReportGenerators {
       msa <- msaReportGen
       applicantIncomes <- Gen.listOfN(5, applicantIncomeGen)
       total <- totalDispositionGen
-    } yield D53(respId, instName, year, msa, applicantIncomes, total, reportDate)
+    } yield D51(respId, instName, year, msa, applicantIncomes, total, reportDate)
   }
 
 }