mirror of https://github.com/pelias/api.git
Stephen K Hess
9 years ago
12 changed files with 819 additions and 1352 deletions
@ -1,66 +1,62 @@ |
|||||||
var _ = require('lodash'), |
var _ = require('lodash'); |
||||||
check = require('check-types'); |
|
||||||
|
|
||||||
module.exports = { |
module.exports = { |
||||||
'USA': { |
'default': { |
||||||
'local': getFirstProperty(['borough', 'localadmin', 'locality', 'neighbourhood', 'county']), |
'local': getFirstProperty(['locality', 'localadmin']), |
||||||
'regional': getUsState, |
'country': getFirstProperty(['country']) |
||||||
'country': getFirstProperty(['country_a']) |
|
||||||
}, |
}, |
||||||
'GBR': { |
'GBR': { |
||||||
'local': getFirstProperty(['neighbourhood', 'county', 'localadmin', 'locality', 'macroregion', 'region']), |
'local': getFirstProperty(['locality', 'localadmin']), |
||||||
'regional': getFirstProperty(['county','country','region']) |
'regional': getFirstProperty(['macroregion']), |
||||||
}, |
'country': getFirstProperty(['country']) |
||||||
'SGP': { |
|
||||||
'local': getFirstProperty(['neighbourhood', 'region', 'county', 'localadmin', 'locality']), |
|
||||||
'regional': getFirstProperty(['county','country','region']) |
|
||||||
}, |
}, |
||||||
'SWE': { |
'USA': { |
||||||
'local': getFirstProperty(['neighbourhood', 'region', 'county', 'localadmin', 'locality']), |
'borough': getFirstProperty(['borough']), |
||||||
'regional': getFirstProperty(['country']) |
'local': getFirstProperty(['locality', 'localadmin']), |
||||||
|
'regional': getUsOrCaState, |
||||||
|
'country': getFirstProperty(['country']) |
||||||
}, |
}, |
||||||
'default': { |
'CAN': { |
||||||
'local': getFirstProperty(['localadmin', 'locality', 'neighbourhood', 'county', 'macroregion', 'region']), |
'local': getFirstProperty(['locality']), // no localadmins in CAN
|
||||||
'regional': getFirstProperty(['country']) |
'regional': getUsOrCaState, |
||||||
|
'country': getFirstProperty(['country']) |
||||||
} |
} |
||||||
}; |
}; |
||||||
|
|
||||||
// find the first field of record that has a non-empty value that's not already in labelParts
|
// find the first field of record that has a non-empty value that's not already in labelParts
|
||||||
function getFirstProperty(fields) { |
function getFirstProperty(fields) { |
||||||
return function(record, labelParts) { |
return function(record) { |
||||||
for (var i = 0; i < fields.length; i++) { |
for (var i = 0; i < fields.length; i++) { |
||||||
var fieldValue = record[fields[i]]; |
var fieldValue = record[fields[i]]; |
||||||
|
|
||||||
if (check.nonEmptyString(fieldValue) && !_.includes(labelParts, fieldValue)) { |
if (!_.isEmpty(fieldValue)) { |
||||||
labelParts.push( fieldValue ); |
return fieldValue; |
||||||
return labelParts; |
|
||||||
} |
} |
||||||
|
|
||||||
} |
} |
||||||
|
|
||||||
return labelParts; |
|
||||||
|
|
||||||
}; |
}; |
||||||
|
|
||||||
} |
} |
||||||
|
|
||||||
// this function is exclusively used for figuring out which field to use for US States
|
// this function is exclusively used for figuring out which field to use for US/CA States
|
||||||
// 1. if a US state is the most granular bit of info entered, the label should contain
|
// 1. if a US/CA state is the most granular bit of info entered, the label should contain
|
||||||
// the full state name, eg: Pennsylvania, USA
|
// the full state name, eg: Pennsylvania, USA and Ontario, CA
|
||||||
// 2. otherwise, the state abbreviation should be used, eg: Lancaster, PA, USA
|
// 2. otherwise, the state abbreviation should be used, eg: Lancaster, PA, USA and Bruce, ON, CA
|
||||||
// 3. if for some reason the abbreviation isn't available, use the full state name
|
// 3. if for some reason the abbreviation isn't available, use the full state name
|
||||||
function getUsState(record, labelParts) { |
function getUsOrCaState(record) { |
||||||
if ('region' === record.layer && record.region) { |
if ('region' === record.layer && record.region) { |
||||||
// add full state name when state is the most granular piece of info
|
// return full state name when state is the most granular piece of info
|
||||||
labelParts.push(record.region); |
return record.region; |
||||||
|
|
||||||
} else if (record.region_a) { |
} else if (record.region_a) { |
||||||
// otherwise just add the region code when available
|
// otherwise just return the region code when available
|
||||||
labelParts.push(record.region_a); |
return record.region_a; |
||||||
|
|
||||||
} else if (record.region) { |
} else if (record.region) { |
||||||
// add the full name when there's no region code available ()
|
// return the full name when there's no region code available
|
||||||
labelParts.push(record.region); |
return record.region; |
||||||
} |
|
||||||
|
|
||||||
return labelParts; |
} |
||||||
|
|
||||||
} |
} |
||||||
|
@ -0,0 +1,205 @@ |
|||||||
|
var generator = require('../../../helper/labelGenerator'); |
||||||
|
|
||||||
|
module.exports.tests = {}; |
||||||
|
|
||||||
|
module.exports.tests.interface = function(test, common) { |
||||||
|
test('interface', function(t) { |
||||||
|
t.equal(typeof generator, 'function', 'valid function'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.tests.canada = function(test, common) { |
||||||
|
test('venue', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'venue name', |
||||||
|
'layer': 'venue', |
||||||
|
'housenumber': 'house number', |
||||||
|
'street': 'street name', |
||||||
|
'neighbourhood': 'neighbourhood name', |
||||||
|
'locality': 'locality name', |
||||||
|
'localadmin': 'localadmin name', |
||||||
|
'county': 'county name', |
||||||
|
'macrocounty': 'macrocounty name', |
||||||
|
'region_a': 'region abbr', |
||||||
|
'region': 'region name', |
||||||
|
'macroregion': 'macroregion name', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'venue name, locality name, region abbr, Canada'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('street', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'house number street name', |
||||||
|
'layer': 'address', |
||||||
|
'housenumber': 'house number', |
||||||
|
'street': 'street name', |
||||||
|
'neighbourhood': 'neighbourhood name', |
||||||
|
'locality': 'locality name', |
||||||
|
'localadmin': 'localadmin name', |
||||||
|
'county': 'county name', |
||||||
|
'macrocounty': 'macrocounty name', |
||||||
|
'region_a': 'region abbr', |
||||||
|
'region': 'region name', |
||||||
|
'macroregion': 'macroregion name', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'house number street name, locality name, region abbr, Canada'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('neighbourhood', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'neighbourhood name', |
||||||
|
'layer': 'neighbourhood', |
||||||
|
'neighbourhood': 'neighbourhood name', |
||||||
|
'locality': 'locality name', |
||||||
|
'localadmin': 'localadmin name', |
||||||
|
'county': 'county name', |
||||||
|
'macrocounty': 'macrocounty name', |
||||||
|
'region_a': 'region abbr', |
||||||
|
'region': 'region name', |
||||||
|
'macroregion': 'macroregion name', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'neighbourhood name, locality name, region abbr, Canada'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('locality', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'locality name', |
||||||
|
'layer': 'locality', |
||||||
|
'locality': 'locality name', |
||||||
|
'localadmin': 'localadmin name', |
||||||
|
'county': 'county name', |
||||||
|
'macrocounty': 'macrocounty name', |
||||||
|
'region_a': 'region abbr', |
||||||
|
'region': 'region name', |
||||||
|
'macroregion': 'macroregion name', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'locality name, region abbr, Canada'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('localadmin', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'localadmin name', |
||||||
|
'layer': 'localadmin', |
||||||
|
'localadmin': 'localadmin name', |
||||||
|
'county': 'county name', |
||||||
|
'macrocounty': 'macrocounty name', |
||||||
|
'region_a': 'region abbr', |
||||||
|
'region': 'region name', |
||||||
|
'macroregion': 'macroregion name', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'localadmin name, region abbr, Canada'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('county', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'county name', |
||||||
|
'layer': 'county', |
||||||
|
'county': 'county name', |
||||||
|
'macrocounty': 'macrocounty name', |
||||||
|
'region_a': 'region abbr', |
||||||
|
'region': 'region name', |
||||||
|
'macroregion': 'macroregion name', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'county name, region abbr, Canada'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('macrocounty', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'macrocounty name', |
||||||
|
'layer': 'macrocounty', |
||||||
|
'macrocounty': 'macrocounty name', |
||||||
|
'region_a': 'region abbr', |
||||||
|
'region': 'region name', |
||||||
|
'macroregion': 'macroregion name', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'macrocounty name, region abbr, Canada'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('region', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'region name', |
||||||
|
'layer': 'region', |
||||||
|
'region_a': 'region abbr', |
||||||
|
'region': 'region name', |
||||||
|
'macroregion': 'macroregion name', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'region name, Canada'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('macroregion', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'macroregion name', |
||||||
|
'layer': 'macroregion', |
||||||
|
'macroregion': 'macroregion name', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'macroregion name, Canada'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('country', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'Canada', |
||||||
|
'layer': 'country', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'Canada'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('region should be used when region_a is not available', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'locality name', |
||||||
|
'layer': 'region', |
||||||
|
'locality': 'locality name', |
||||||
|
'localadmin': 'localadmin name', |
||||||
|
'county': 'county name', |
||||||
|
'macrocounty': 'macrocounty name', |
||||||
|
'region': 'region name', |
||||||
|
'macroregion': 'macroregion name', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'locality name, region name, Canada', 'region should be used'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.all = function (tape, common) { |
||||||
|
|
||||||
|
function test(name, testFunction) { |
||||||
|
return tape('label generator (CAN): ' + name, testFunction); |
||||||
|
} |
||||||
|
|
||||||
|
for( var testCase in module.exports.tests ){ |
||||||
|
module.exports.tests[testCase](test, common); |
||||||
|
} |
||||||
|
}; |
@ -1,51 +0,0 @@ |
|||||||
|
|
||||||
var generator = require('../../../helper/labelGenerator'); |
|
||||||
|
|
||||||
module.exports.tests = {}; |
|
||||||
|
|
||||||
module.exports.tests.interface = function(test, common) { |
|
||||||
test('interface', function(t) { |
|
||||||
t.equal(typeof generator, 'function', 'valid function'); |
|
||||||
t.end(); |
|
||||||
}); |
|
||||||
}; |
|
||||||
|
|
||||||
// SGP region
|
|
||||||
module.exports.tests.north_west_singapore = function(test, common) { |
|
||||||
test('north west singapore', function(t) { |
|
||||||
var doc = { |
|
||||||
'name': 'North West', |
|
||||||
'country_a': 'SGP', |
|
||||||
'country': 'Singapore', |
|
||||||
'region': 'North West' |
|
||||||
}; |
|
||||||
t.equal(generator(doc),'North West, Singapore'); |
|
||||||
t.end(); |
|
||||||
}); |
|
||||||
}; |
|
||||||
|
|
||||||
// SGP venue
|
|
||||||
module.exports.tests.singapore_mcdonalds = function(test, common) { |
|
||||||
test('singapore_mcdonalds', function(t) { |
|
||||||
var doc = { |
|
||||||
'name': 'McDonald\'s', |
|
||||||
'country_a': 'SGP', |
|
||||||
'country': 'Singapore', |
|
||||||
'region': 'Central Singapore', |
|
||||||
'locality': 'Singapore' |
|
||||||
}; |
|
||||||
t.equal(generator(doc),'McDonald\'s, Central Singapore, Singapore'); |
|
||||||
t.end(); |
|
||||||
}); |
|
||||||
}; |
|
||||||
|
|
||||||
module.exports.all = function (tape, common) { |
|
||||||
|
|
||||||
function test(name, testFunction) { |
|
||||||
return tape('label generator: ' + name, testFunction); |
|
||||||
} |
|
||||||
|
|
||||||
for( var testCase in module.exports.tests ){ |
|
||||||
module.exports.tests[testCase](test, common); |
|
||||||
} |
|
||||||
}; |
|
@ -1,53 +0,0 @@ |
|||||||
|
|
||||||
var generator = require('../../../helper/labelGenerator'); |
|
||||||
|
|
||||||
module.exports.tests = {}; |
|
||||||
|
|
||||||
module.exports.tests.interface = function(test, common) { |
|
||||||
test('interface', function(t) { |
|
||||||
t.equal(typeof generator, 'function', 'valid function'); |
|
||||||
t.end(); |
|
||||||
}); |
|
||||||
}; |
|
||||||
|
|
||||||
// SWE city
|
|
||||||
module.exports.tests.skane1 = function(test, common) { |
|
||||||
test('skĂĄne 1', function(t) { |
|
||||||
var doc = { |
|
||||||
'name': 'Malmö', |
|
||||||
'country_a': 'SWE', |
|
||||||
'country': 'Sweden', |
|
||||||
'region': 'SkĂĄne', |
|
||||||
'county': 'Malmö' |
|
||||||
}; |
|
||||||
t.equal(generator(doc),'Malmö, Skåne, Sweden'); |
|
||||||
t.end(); |
|
||||||
}); |
|
||||||
}; |
|
||||||
|
|
||||||
// SWE city
|
|
||||||
module.exports.tests.skane2 = function(test, common) { |
|
||||||
test('skĂĄne 2', function(t) { |
|
||||||
var doc = { |
|
||||||
'name': 'Malmö', |
|
||||||
'country_a': 'SWE', |
|
||||||
'country': 'Sweden', |
|
||||||
'region': 'SkĂĄne', |
|
||||||
'county': 'Malmö', |
|
||||||
'locality': 'Malmö' |
|
||||||
}; |
|
||||||
t.equal(generator(doc),'Malmö, Skåne, Sweden'); |
|
||||||
t.end(); |
|
||||||
}); |
|
||||||
}; |
|
||||||
|
|
||||||
module.exports.all = function (tape, common) { |
|
||||||
|
|
||||||
function test(name, testFunction) { |
|
||||||
return tape('label generator: ' + name, testFunction); |
|
||||||
} |
|
||||||
|
|
||||||
for( var testCase in module.exports.tests ){ |
|
||||||
module.exports.tests[testCase](test, common); |
|
||||||
} |
|
||||||
}; |
|
@ -0,0 +1,116 @@ |
|||||||
|
var generator = require('../../../helper/labelGenerator'); |
||||||
|
|
||||||
|
module.exports.tests = {}; |
||||||
|
|
||||||
|
module.exports.tests.interface = function(test, common) { |
||||||
|
test('interface', function(t) { |
||||||
|
t.equal(typeof generator, 'function', 'valid function'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.tests.canada = function(test, common) { |
||||||
|
test('venue', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'Tim Horton\'s', |
||||||
|
'layer': 'venue', |
||||||
|
'housenumber': '1', |
||||||
|
'street': 'Main St', |
||||||
|
'neighbourhood': 'College Heights', |
||||||
|
'locality': 'Thunder Bay', |
||||||
|
'region_a': 'ON', |
||||||
|
'region': 'Ontario', |
||||||
|
'country_a': 'CAN', |
||||||
|
'country': 'Canada' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'Tim Horton\'s, Thunder Bay, ON, Canada'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('address', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': '1 Main St', |
||||||
|
'layer': 'venue', |
||||||
|
'housenumber': '1', |
||||||
|
'street': 'Main St', |
||||||
|
'locality': 'Truth or Consequences', |
||||||
|
'region_a': 'NM', |
||||||
|
'region': 'New Mexico', |
||||||
|
'country_a': 'USA', |
||||||
|
'country': 'United States' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'1 Main St, Truth or Consequences, NM, United States'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.tests.france = function(test, common) { |
||||||
|
test('eiffel tower', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'Tour Eiffel', |
||||||
|
'layer': 'venue', |
||||||
|
'neighbourhood': 'Quartier du Gros-Caillou', |
||||||
|
'locality': 'Paris', |
||||||
|
'region': 'Paris', |
||||||
|
'country_a': 'FRA', |
||||||
|
'country': 'France' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'Tour Eiffel, Paris, France'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('France street address', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': '74 rue de rivoli', |
||||||
|
'layer': 'address', |
||||||
|
'housenumber': '74', |
||||||
|
'street': 'Rue de Rivoli', |
||||||
|
'neighbourhood': 'Quartier Saint-Merri', |
||||||
|
'locality': 'Paris', |
||||||
|
'region': 'Paris', |
||||||
|
'country_a': 'FRA', |
||||||
|
'country': 'France' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'74 rue de rivoli, Paris, France'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('France neighbourhood', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'Grange aux Belles Terrage', |
||||||
|
'layer': 'neighbourhood', |
||||||
|
'neighbourhood': 'Grange aux Belles Terrage', |
||||||
|
'locality': 'Paris', |
||||||
|
'region': 'Paris', |
||||||
|
'country_a': 'FRA', |
||||||
|
'country': 'France' |
||||||
|
}; |
||||||
|
t.equal(generator(doc),'Grange aux Belles Terrage, Paris, France'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
test('Luxembourg (the city) in Luxembourg', function(t) { |
||||||
|
var doc = { |
||||||
|
'name': 'Luxembourg', |
||||||
|
'layer': 'locality', |
||||||
|
'locality': 'Luxembourg', |
||||||
|
'country_a': 'LUX', |
||||||
|
'country': 'Luxembourg' |
||||||
|
}; |
||||||
|
// console.error(generator(doc));
|
||||||
|
t.equal(generator(doc),'Luxembourg, Luxembourg'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.all = function (tape, common) { |
||||||
|
|
||||||
|
function test(name, testFunction) { |
||||||
|
return tape('label generator (CAN): ' + name, testFunction); |
||||||
|
} |
||||||
|
|
||||||
|
for( var testCase in module.exports.tests ){ |
||||||
|
module.exports.tests[testCase](test, common); |
||||||
|
} |
||||||
|
}; |
Loading…
Reference in new issue