Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Allow alternative country name spellings via array #175

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion index.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
export type LocalizedCountryNames = {
[alpha2Key: string]: string
[alpha2Key: string]: string | string[]
};

export type LocaleData = {
Expand Down
47 changes: 37 additions & 10 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,9 @@ exports.toAlpha2 = toAlpha2;
*/
exports.getName = function(code, lang) {
try {
var d = registeredLocales[lang.toLowerCase()];
return d[toAlpha2(code)];
const codeMaps = registeredLocales[lang.toLowerCase()];
const names = codeMaps[toAlpha2(code)];
return Array.isArray(names) ? names[0] : names;
} catch (err) {
return undefined;
}
Expand All @@ -172,14 +173,27 @@ exports.getNames = function(lang) {
* @return ISO 3166-1 alpha-2 or undefined
*/
exports.getAlpha2Code = function(name, lang) {
const normalizeString = (string) => string.toLowerCase();
const areSimilar = (a, b) => normalizeString(a) === normalizeString(b);

try {
var p, codenames = registeredLocales[lang.toLowerCase()];
for (p in codenames) {
if (codenames.hasOwnProperty(p)) {
if (codenames[p].toLowerCase() === name.toLowerCase()) {
const codenames = registeredLocales[lang.toLowerCase()];
for (const p in codenames) {
if (!codenames.hasOwnProperty(p)) {
continue;
}
if (typeof codenames[p] === "string") {
if (areSimilar(codenames[p], name)) {
return p;
}
}
if (Array.isArray(codenames[p])) {
for (const mappedName of codenames[p]) {
if (areSimilar(mappedName, name)) {
return p;
}
}
}
}
return undefined;
} catch (err) {
Expand All @@ -193,14 +207,27 @@ exports.getAlpha2Code = function(name, lang) {
* @return ISO 3166-1 alpha-2 or undefined
*/
exports.getSimpleAlpha2Code = function(name, lang) {
const normalizeString = (string) => removeDiacritics(string.toLowerCase());
const areSimilar = (a, b) => normalizeString(a) === normalizeString(b);

try {
var p, codenames = registeredLocales[lang.toLowerCase()];
for (p in codenames) {
if (codenames.hasOwnProperty(p)) {
if (removeDiacritics(codenames[p].toLowerCase()) === removeDiacritics(name.toLowerCase())) {
const codenames = registeredLocales[lang.toLowerCase()];
for (const p in codenames) {
if (!codenames.hasOwnProperty(p)) {
continue;
}
if (typeof codenames[p] === "string") {
if (areSimilar(codenames[p], name)) {
return p;
}
}
if (Array.isArray(codenames[p])) {
for (const mappedName of codenames[p]) {
if (areSimilar(mappedName, name)) {
return p;
}
}
}
}
return undefined;
} catch (err) {
Expand Down
2 changes: 1 addition & 1 deletion langs/pt.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
"SK": "Eslováquia",
"SI": "Eslovênia",
"ES": "Espanha",
"US": "Estados Unidos",
"US": ["Estados Unidos", "Estados Unidos da América"],
"EE": "Estônia",
"ET": "Etiópia",
"FJ": "Fiji",
Expand Down
51 changes: 43 additions & 8 deletions test/iso-i18n-countries.js
Original file line number Diff line number Diff line change
Expand Up @@ -128,41 +128,47 @@ describe("i18n for iso 3166-1", function () {
it("missing name", function() {
assert.strictEqual(i18niso.getAlpha2Code("XXX", "de"), undefined);
});
it("missing land", function() {
it("missing lang", function() {
assert.strictEqual(i18niso.getAlpha2Code("Deutschland", "xx"), undefined);
});
});
describe("getSimpleAlpha2Code", function() {
it("works", function() {
assert.strictEqual(i18niso.getSimpleAlpha2Code("belgie", "nl"), 'BE');
assert.strictEqual(i18niso.getSimpleAlpha2Code("België", "nl"), 'BE');
assert.strictEqual(i18niso.getSimpleAlpha2Code("belgie", "nl"), "BE");
assert.strictEqual(i18niso.getSimpleAlpha2Code("België", "nl"), "BE");
});
it("missing name", function() {
assert.strictEqual(i18niso.getSimpleAlpha2Code("XXX", "de"), undefined);
});
it("missing land", function() {
it("missing lang", function() {
assert.strictEqual(i18niso.getSimpleAlpha2Code("Deutschland", "xx"), undefined);
});
it("alternative name spellings", function() {
assert.strictEqual(i18niso.getSimpleAlpha2Code("Estados Unidos da América", "pt"), "US");
});
});
describe("getAlpha3Code", function() {
it("missing name", function() {
assert.strictEqual(i18niso.getAlpha3Code("XXX", "de"), undefined);
});
it("missing land", function() {
it("missing lang", function() {
assert.strictEqual(i18niso.getAlpha3Code("Deutschland", "xx"), undefined);
});
});
describe("getSimpleAlpha3Code", function() {
it("works", function() {
assert.strictEqual(i18niso.getSimpleAlpha3Code("belgie", "nl"), 'BEL');
assert.strictEqual(i18niso.getSimpleAlpha3Code("België", "nl"), 'BEL');
assert.strictEqual(i18niso.getSimpleAlpha3Code("belgie", "nl"), "BEL");
assert.strictEqual(i18niso.getSimpleAlpha3Code("België", "nl"), "BEL");
});
it("missing name", function() {
assert.strictEqual(i18niso.getSimpleAlpha3Code("XXX", "de"), undefined);
});
it("missing land", function() {
it("missing lang", function() {
assert.strictEqual(i18niso.getSimpleAlpha3Code("Deutschland", "xx"), undefined);
});
it("alternative name spellings", function() {
assert.strictEqual(i18niso.getSimpleAlpha3Code("Estados Unidos da América", "pt"), "USA");
});
});
describe("isValid", function() {
it("isValid true => false", function() {
Expand Down Expand Up @@ -386,6 +392,35 @@ describe("i18n for iso 3166-1", function () {
});
});
});

describe("pt", function () {
var lang = "pt";
describe("get Alpha-2 code", function() {
it("nameToAlpha2 Estados Unidos => US", function() {
assert.strictEqual(i18niso.getAlpha2Code("Estados Unidos", lang), "US");
});
it("nameToAlpha2 Estados Unidos da América => US", function() {
assert.strictEqual(i18niso.getAlpha2Code("Estados Unidos da América", lang), "US");
});
});
describe("get Alpha-3 code", function() {
it("nameToAlpha3 Estados Unidos => USA", function() {
assert.strictEqual(i18niso.getAlpha3Code("Estados Unidos", lang), "USA");
});
it("nameToAlpha3 Estados Unidos da América => USA", function() {
assert.strictEqual(i18niso.getAlpha3Code("Estados Unidos da América", lang), "USA");
});
});
describe("get name", function () {
it("for br => Brasil", function () {
assert.strictEqual(i18niso.getName("br", lang), "Brasil");
});
it("for us => Estados Unidos", function () {
assert.strictEqual(i18niso.getName("us", lang), "Estados Unidos");
});
});
});

describe("unsupported language", function () {
var lang = "unsupported";
it("get name", function () {
Expand Down