geo: make sure that locations w/o matching ISO-3 return *false*

- instead of null feature
- add geojson / topojson test to geo_test.js

Author: etpinard

src/lib/geo_location_utils.js

@@ -24,18 +24,21 @@ var locationmodeToIdFinder = {
 
 exports.locationToFeature = function(locationmode, location, features) {
     var locationId = getLocationId(locationmode, location);
-    var feature;
 
-    for(var i = 0; i < features.length; i++) {
-        feature = features[i];
+    if(locationId) {
+        for(var i = 0; i < features.length; i++) {
+            var feature = features[i];
 
-        if(feature.id === locationId) return feature;
+            if(feature.id === locationId) return feature;
+        }
+
+        Lib.warn([
+            'Location with id', locationId,
+            'does not have a matching topojson feature at this resolution.'
+        ].join(' '));
     }
 
-    Lib.warn([
-        'Location with id', locationId,
-        'does not have a matching topojson feature at this resolution.'
-    ].join(' '));
+    return false;
 };
 
 function getLocationId(locationmode, location) {
@@ -44,14 +47,14 @@ function getLocationId(locationmode, location) {
 }
 
 function countryNameToISO3(countryName) {
-    var iso3, regex;
-
     for(var i = 0; i < countryIds.length; i++) {
-        iso3 = countryIds[i];
-        regex = new RegExp(countryRegex[iso3]);
+        var iso3 = countryIds[i],
+            regex = new RegExp(countryRegex[iso3]);
 
         if(regex.test(countryName.toLowerCase())) return iso3;
     }
 
     Lib.warn('Unrecognized country name: ' + countryName + '.');
+
+    return false;
 }

src/traces/choropleth/plot.js

@@ -40,7 +40,7 @@ plotChoropleth.calcGeoJSON = function(trace, topojson) {
     for(var i = 0; i < len; i++) {
         feature = locationToFeature(trace.locationmode, locations[i], features);
 
-        if(feature === undefined) continue;  // filter the blank features here
+        if(!feature) continue;  // filter the blank features here
 
         // 'data_array' attributes
         feature.z = trace.z[i];

test/jasmine/tests/geo_test.js

@@ -2,8 +2,11 @@ var Plotly = require('@lib/index');
 var Lib = require('@src/lib');
 
 var Geo = require('@src/plots/geo');
+var GeoAssets = require('@src/assets/geo_assets');
 var params = require('@src/plots/geo/constants');
 var supplyLayoutDefaults = require('@src/plots/geo/layout/axis_defaults');
+var geoLocationUtils = require('@src/lib/geo_location_utils');
+var topojsonUtils = require('@src/lib/topojson_utils');
 
 var d3 = require('d3');
 var createGraphDiv = require('../assets/create_graph_div');
@@ -336,6 +339,49 @@ describe('Test Geo layout defaults', function() {
     });
 });
 
+describe('geojson / topojson utils', function() {
+    'use strict';
+
+    function _locationToFeature(topojson, loc, locationmode) {
+        var trace = { locationmode: locationmode };
+        var features = topojsonUtils.getTopojsonFeatures(trace, topojson);
+
+        var feature = geoLocationUtils.locationToFeature(locationmode, loc, features);
+        return feature;
+    }
+
+    describe('should be able to extract topojson feature from *locations* items', function() {
+        var topojsonName = 'world_110m';
+        var topojson = GeoAssets.topojson[topojsonName];
+
+        it('with *ISO-3* locationmode', function() {
+            var out = _locationToFeature(topojson, 'CAN', 'ISO-3');
+
+            expect(Object.keys(out)).toEqual(['type', 'id', 'properties', 'geometry']);
+            expect(out.id).toEqual('CAN');
+        });
+
+        it('with *ISO-3* locationmode (not-found case)', function() {
+            var out = _locationToFeature(topojson, 'XXX', 'ISO-3');
+
+            expect(out).toEqual(false);
+        });
+
+        it('with *country names* locationmode', function() {
+            var out = _locationToFeature(topojson, 'United States', 'country names');
+
+            expect(Object.keys(out)).toEqual(['type', 'id', 'properties', 'geometry']);
+            expect(out.id).toEqual('USA');
+        });
+
+        it('with *country names* locationmode (not-found case)', function() {
+            var out = _locationToFeature(topojson, 'XXX', 'country names');
+
+            expect(out).toEqual(false);
+        });
+    });
+});
+
 describe('Test geo interactions', function() {
     'use strict';