Merge pull request cfpb#1140 from schbetsy/reports-metadata

Reports Metadata

Author: Nick Grippin

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

@@ -8,6 +8,12 @@ object ReportTypeEnum extends Enum[ReportTypeEnum] {
 
   val values = findValues
 
+  val byName: Map[String, ReportTypeEnum] = Map(
+    "disclosure" -> Disclosure,
+    "aggregate" -> Aggregate,
+    "national aggregate" -> NationalAggregate
+  )
+
   case object Disclosure extends ReportTypeEnum
   case object Aggregate extends ReportTypeEnum
   case object NationalAggregate extends ReportTypeEnum

publication/src/main/resources/reports-metadata.txt

@@ -0,0 +1,2 @@
+ReportId,Type,ReportNumber,Dispositions,Description
+D51,Disclosure,5-1,Received;Originated;ApprovedButNotAccepted;Denied;Withdrawn;Closed,"Disposition of applications for FHA, FSA/RHS, and VA home-purchase loans, 1- to 4-family and manufactured home dwellings, by income, race and ethnicity of applicant"

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

@@ -8,59 +8,27 @@ import hmda.model.publication.reports.ApplicantIncomeEnum._
 import hmda.publication.reports._
 import hmda.model.publication.reports._
 import hmda.publication.reports.util.DateUtil._
-import hmda.publication.reports.util.DispositionType._
 import hmda.publication.reports.util.ReportUtil._
+import hmda.publication.reports.util.ReportsMetaDataLookup
 import hmda.query.model.filing.LoanApplicationRegisterQuery
 
 import scala.concurrent.Future
 
 case class D51(
   respondentId: String,
   institutionName: String,
-  table: String,
-  description: String,
   year: Int,
   reportDate: String,
   msa: MSAReport,
   applicantIncomes: List[ApplicantIncome],
-  total: List[Disposition]
+  total: List[Disposition],
+  table: String = D51.metaData.reportTable,
+  description: String = D51.metaData.description
 ) extends DisclosureReport
 
 object D51 {
-  def apply(
-    respondentId: String,
-    institutionName: String,
-    year: Int,
-    reportDate: String,
-    msa: MSAReport,
-    applicantIncomes: List[ApplicantIncome],
-    total: List[Disposition]
-  ): D51 = {
-
-    val description = "Disposition of applications for FHA, FSA/RHS, and VA home-purchase loans, 1- to 4-family and manufactured home dwellings, by income, race and ethnicity of applicant"
-
-    D51(
-      respondentId,
-      institutionName,
-      "5-1",
-      description,
-      year,
-      reportDate,
-      msa,
-      applicantIncomes,
-      total
-    )
-  }
-
-  val dispositions: List[DispositionType] =
-    List(
-      ReceivedDisp,
-      OriginatedDisp,
-      ApprovedButNotAcceptedDisp,
-      DeniedDisp,
-      WithdrawnDisp,
-      ClosedDisp
-    )
+  val metaData = ReportsMetaDataLookup.values("D51")
+  val dispositions = metaData.dispositions
 
   // Table filters:
   // Loan Type 2,3,4
@@ -69,12 +37,12 @@ object D51 {
   def generate[ec: EC, mat: MAT, as: AS](
     larSource: Source[LoanApplicationRegisterQuery, NotUsed],
     fipsCode: Int,
-    respId: String,
+    respondentId: String,
     institutionNameF: Future[String]
   ): Future[D51] = {
 
     val lars = larSource
-      .filter(lar => lar.respondentId == respId)
+      .filter(lar => lar.respondentId == respondentId)
       .filter(lar => lar.msa != "NA")
       .filter(lar => lar.msa.toInt == fipsCode)
       .filter { lar =>
@@ -91,7 +59,7 @@ object D51 {
     val larsByIncome = larsByIncomeInterval(larsWithIncome, incomeIntervals)
     val borrowerCharacteristicsByIncomeF = borrowerCharacteristicsByIncomeInterval(larsByIncome, dispositions)
 
-    val dateF = calculateYear(larSource)
+    val yearF = calculateYear(larSource)
     val totalF = calculateDispositions(lars, dispositions)
 
     for {
@@ -102,7 +70,7 @@ object D51 {
       lars120BorrowerCharacteristics <- borrowerCharacteristicsByIncomeF(GreaterThan120PercentOfMSAMedian)
 
       institutionName <- institutionNameF
-      date <- dateF
+      year <- yearF
       total <- totalF
     } yield {
       val income50 = ApplicantIncome(
@@ -126,19 +94,21 @@ object D51 {
         lars120BorrowerCharacteristics
       )
 
+      val applicantIncomes = List(
+        income50,
+        income50To79,
+        income80To99,
+        income100To120,
+        income120
+      )
+
       D51(
-        respId,
+        respondentId,
         institutionName,
-        date,
+        year,
         formatDate(Calendar.getInstance().toInstant),
         msa,
-        List(
-          income50,
-          income50To79,
-          income80To99,
-          income100To120,
-          income120
-        ),
+        applicantIncomes,
         total
       )
     }

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

@@ -13,6 +13,20 @@ import scala.util.Try
 
 object DispositionType {
 
+  val byName: Map[String, DispositionType] = {
+    Map(
+      "received" -> ReceivedDisp,
+      "originated" -> OriginatedDisp,
+      "approvedbutnotaccepted" -> ApprovedButNotAcceptedDisp,
+      "denied" -> DeniedDisp,
+      "withdrawn" -> WithdrawnDisp,
+      "closed" -> ClosedDisp,
+      "purchased" -> PurchasedDisp,
+      "preapprovaldenied" -> PreapprovalDeniedDisp,
+      "preapprovalapproved" -> PreapprovalApprovedDisp
+    )
+  }
+
   sealed trait DispositionType extends SourceUtils {
     def filter(lar: LoanApplicationRegisterQuery): Boolean
 
@@ -67,7 +81,7 @@ object DispositionType {
     override def filter(lar: LoanApplicationRegisterQuery): Boolean = lar.actionTakenType == 7
     override def actionTaken: ActionTakenTypeEnum = PreapprovalDenied
   }
-  object PreapprovalAcceptedDisp extends DispositionType {
+  object PreapprovalApprovedDisp extends DispositionType {
     override def filter(lar: LoanApplicationRegisterQuery): Boolean = lar.actionTakenType == 8
     override def actionTaken: ActionTakenTypeEnum = PreapprovalApprovedButNotAccepted
   }

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

@@ -0,0 +1,47 @@
+package hmda.publication.reports.util
+
+import com.github.tototoshi.csv.CSVParser.parse
+import hmda.model.ResourceUtils
+import hmda.model.publication.reports.ReportTypeEnum
+import hmda.publication.reports.util.DispositionType.DispositionType
+
+object ReportsMetaDataLookup extends ResourceUtils {
+
+  private val lines = resourceLines("/reports-metadata.txt")
+
+  val values: Map[String, ReportMetaData] = lines.drop(1).map { line =>
+    ReportMetaData.fromString(line)
+  }.toMap
+
+}
+
+case class ReportMetaData(
+  reportType: ReportTypeEnum,
+  reportTable: String,
+  dispositions: List[DispositionType],
+  description: String
+)
+
+case object ReportMetaData {
+
+  def fromString(line: String): (String, ReportMetaData) = {
+    val values = parse(line, '\\', ',', '"').getOrElse(List())
+    val reportId = values.head
+    val reportType = ReportTypeEnum.byName(values(1).toLowerCase)
+    val reportNumber = values(2)
+    val description = values(4)
+    val dispositions =
+      values(3).split(";").filter(_.nonEmpty).map { d =>
+        DispositionType.byName(d.toLowerCase)
+      }.toList
+
+    val data = ReportMetaData(
+      reportType,
+      reportNumber,
+      dispositions,
+      description
+    )
+
+    (reportId, data)
+  }
+}

publication/src/test/scala/hmda/publication/reports/util/ReportsMetaDataLookupSpec.scala

@@ -0,0 +1,24 @@
+package hmda.publication.reports.util
+
+import hmda.model.publication.reports.ReportTypeEnum.Disclosure
+import hmda.publication.reports.util.DispositionType._
+import org.scalatest.{ MustMatchers, WordSpec }
+
+class ReportsMetaDataLookupSpec extends WordSpec with MustMatchers {
+
+  "Provide A&D report metadata" in {
+    val d51 = ReportsMetaDataLookup.values("D51")
+    d51 mustBe a[ReportMetaData]
+    d51.reportType mustBe Disclosure
+    d51.reportTable mustBe "5-1"
+    d51.dispositions mustBe List(
+      ReceivedDisp,
+      OriginatedDisp,
+      ApprovedButNotAcceptedDisp,
+      DeniedDisp,
+      WithdrawnDisp,
+      ClosedDisp
+    )
+  }
+
+}