From 26cf5ea75d526ec8227fc71541b47c81fdb02b0b Mon Sep 17 00:00:00 2001
From: Julian Simioni <julian@simioni.org>
Date: Wed, 19 Sep 2018 17:19:47 -0400
Subject: [PATCH] feat(abbreviation): use wof:shortcode if available

The `wof:shortcode` properly is coming to replace the `wof:abbreviation`
field.

This PR allows either field to work, with `wof:shortcode` preferred, to
account for people who have not yet updated their data.

Connects https://github.com/pelias/whosonfirst/issues/398
Connects https://github.com/pelias/pelias/issues/645
Connects https://github.com/whosonfirst/whosonfirst-properties/issues/78
Connects https://github.com/pelias/whosonfirst/pull/399
---
 src/pip/components/extractFields.js      |  2 +
 test/pip/components/extractFieldsTest.js | 51 ++++++++++++++++++++++++
 2 files changed, 53 insertions(+)

diff --git a/src/pip/components/extractFields.js b/src/pip/components/extractFields.js
index 2506855..04a31ee 100644
--- a/src/pip/components/extractFields.js
+++ b/src/pip/components/extractFields.js
@@ -44,6 +44,8 @@ module.exports.create = function(enableLocalizedNames) {
     // use different abbreviation field for country
     if (res.properties.Placetype === 'country') {
       res.properties.Abbrev = wofData.properties['wof:country_alpha3'];
+    } else if(wofData.properties['wof:shortcode']) {
+      res.properties.Abbrev = wofData.properties['wof:shortcode'];
     } else {
       res.properties.Abbrev = wofData.properties['wof:abbreviation'];
     }
diff --git a/test/pip/components/extractFieldsTest.js b/test/pip/components/extractFieldsTest.js
index 675c2bb..786f58c 100644
--- a/test/pip/components/extractFieldsTest.js
+++ b/test/pip/components/extractFieldsTest.js
@@ -10,6 +10,57 @@ function test_stream(input, testedStream, callback) {
 
 tape('extractFields tests', function(test) {
   test.test('non-special case record', function(t) {
+    var input = {
+      properties: {},
+      geometry: 'Geometry'
+    };
+    input.properties['wof:id'] = 17;
+    input.properties['wof:name'] = 'Feature name';
+    input.properties['wof:abbreviation'] = 'Feature abbreviation';
+    input.properties['wof:shortcode'] = 'Feature shortcode, preferred';
+    input.properties['wof:placetype'] = 'Feature placetype';
+    input.properties['wof:hierarchy'] = [
+      {
+        placetype1: 12,
+        placetype2: 34
+      },
+      {
+        placetype3: 56
+      }
+    ];
+    input.properties['geom:latitude'] = 12.121212;
+    input.properties['geom:longitude'] = 21.212121;
+    input.properties['geom:bbox'] = 'Feature boundingbox';
+
+    var expected = {
+      properties: {
+        Id: 17,
+        Name: 'Feature name',
+        Abbrev: 'Feature shortcode, preferred',
+        Placetype: 'Feature placetype',
+        Hierarchy: [
+          [ 12, 34 ],
+          [ 56 ]
+        ],
+        Centroid: {
+          lat: 12.121212,
+          lon: 21.212121
+        },
+        BoundingBox: 'Feature boundingbox'
+      },
+      geometry: 'Geometry'
+    };
+
+    var extractFields = require('../../../src/pip/components/extractFields').create();
+
+    test_stream([input], extractFields, function(err, actual) {
+      t.deepEqual(actual, [expected], 'should be equal');
+      t.end();
+    });
+
+  });
+
+  test.test('wof:abbreviation is used if wof:shortcode is not found', function(t) {
     var input = {
       properties: {},
       geometry: 'Geometry'