From 541cc8d788ed05c324782ceb1a0dc69e18e12422 Mon Sep 17 00:00:00 2001
From: Peter Johnson <insomnia@rcpt.at>
Date: Wed, 3 Oct 2018 17:39:58 +0200
Subject: [PATCH] feat(fields): import all potentially useful fields from CSV
 in to model

---
 lib/streams/documentStream.js  | 17 ++++++-
 test/streams/documentStream.js | 84 ++++++++++++++++++++++++++++++++++
 2 files changed, 100 insertions(+), 1 deletion(-)

diff --git a/lib/streams/documentStream.js b/lib/streams/documentStream.js
index d3ad4d8d1..76be1d4ac 100644
--- a/lib/streams/documentStream.js
+++ b/lib/streams/documentStream.js
@@ -26,13 +26,28 @@ function createDocumentStream(id_prefix, stats) {
         .setName( 'default', (record.NUMBER + ' ' + record.STREET) )
         .setCentroid( { lon: record.LON, lat: record.LAT } );
 
+        // mandatory address data
         addrDoc.setAddress( 'number', record.NUMBER );
-
         addrDoc.setAddress( 'street', record.STREET );
 
+        // extended address data
         if (record.POSTCODE) {
           addrDoc.setAddress( 'zip', record.POSTCODE );
         }
+        if (record.UNIT) {
+          addrDoc.setAddress( 'unit', record.UNIT );
+        }
+
+        // additional document metadata which may be useful downstream
+        if (record.CITY) {
+          addrDoc.setMeta( 'city', record.CITY );
+        }
+        if (record.DISTRICT) {
+          addrDoc.setMeta( 'district', record.DISTRICT );
+        }
+        if (record.REGION) {
+          addrDoc.setMeta( 'region', record.REGION );
+        }
 
         this.push( addrDoc );
       }
diff --git a/test/streams/documentStream.js b/test/streams/documentStream.js
index ac6876f2a..b34b4a0dc 100644
--- a/test/streams/documentStream.js
+++ b/test/streams/documentStream.js
@@ -26,6 +26,20 @@ tape( 'documentStream catches records with no street', function(test) {
   });
 });
 
+tape( 'documentStream catches records with no house number', function(test) {
+  const input = {
+    STREET: '101st Avenue'
+  };
+  const stats = { badRecordCount: 0 };
+  const documentStream = DocumentStream.create('prefix', stats);
+
+  test_stream([input], documentStream, function(err, actual) {
+    test.equal(actual.length, 0, 'no documents should be pushed' );
+    test.equal(stats.badRecordCount, 1, 'bad record count updated');
+    test.end();
+  });
+});
+
 tape( 'documentStream does not set zipcode if zipcode is emptystring', function(test) {
   const input = {
     NUMBER: '5',
@@ -45,6 +59,44 @@ tape( 'documentStream does not set zipcode if zipcode is emptystring', function(
   });
 });
 
+tape( 'documentStream does not set unit if unit is emptystring', function(test) {
+  const input = {
+    NUMBER: '5',
+    STREET: '101st Avenue',
+    LAT: 5,
+    LON: 6,
+    UNIT: ''
+  };
+  const stats = { badRecordCount: 0 };
+  const documentStream = DocumentStream.create('prefix', stats);
+
+  test_stream([input], documentStream, function(err, actual) {
+    test.equal(actual.length, 1, 'the document should be pushed' );
+    test.equal(stats.badRecordCount, 0, 'bad record count unchanged');
+    test.equal(actual[0].getAddress('unit', undefined));
+    test.end();
+  });
+});
+
+tape( 'documentStream accepts null island', function(test) {
+  const input = {
+    NUMBER: '5',
+    STREET: '101st Avenue',
+    LAT: 0,
+    LON: 0
+  };
+
+  const stats = { badRecordCount: 0 };
+  const documentStream = DocumentStream.create('prefix', stats);
+
+  test_stream([input], documentStream, function(err, actual) {
+    test.equal(actual.length, 1, 'the document should be pushed' );
+    test.equal(stats.badRecordCount, 0, 'bad record count unchanged');
+    test.equal(actual[0].getId(), 'prefix:0');
+    test.end();
+  });
+});
+
 tape( 'documentStream creates id with filename-based prefix', function(test) {
   const input = {
     NUMBER: '5',
@@ -84,3 +136,35 @@ tape('documentStream uses HASH value if present', function(test) {
     test.end();
   });
 });
+
+tape('documentStream with all properties set', function(test) {
+  const input = {
+    NUMBER: '5',
+    STREET: '101st Avenue',
+    LAT: 5,
+    LON: 6,
+    HASH: 'abcd',
+    POSTCODE: '10000',
+    UNIT: '1E',
+    CITY: 'Test City',
+    DISTRICT: 'Test District',
+    REGION: 'Test Region'
+  };
+
+  const stats = { badRecordCount: 0 };
+  const documentStream = DocumentStream.create('prefix', stats);
+
+  test_stream([input], documentStream, function(err, actual) {
+    test.equal(actual.length, 1, 'the document should be pushed' );
+    test.equal(stats.badRecordCount, 0, 'bad record count unchanged');
+    test.equal(actual[0].getId(), 'prefix:abcd');
+    test.deepEqual(actual[0].getCentroid(), { lon: 6, lat: 5 });
+    test.equal(actual[0].getAddress('street'), '101st Avenue');
+    test.equal(actual[0].getAddress('zip'), '10000');
+    test.equal(actual[0].getAddress('unit'), '1E');
+    test.equal(actual[0].getMeta('city'), 'Test City');
+    test.equal(actual[0].getMeta('district'), 'Test District');
+    test.equal(actual[0].getMeta('region'), 'Test Region');
+    test.end();
+  });
+});