Remove getBestMatchingLanguage() and parseLanguageIntoCodes() (#212)

* Remove getBestMatchingLanguage

* Remove getBestMatchingLanguage() and parseLanguageIntoCodes()

* add comment

* rm

* readme

Author: Bobby Sudekum

README.md

@@ -17,16 +17,15 @@ OSRM Text Instructions is a Node.js library that transforms route data generated
 var version = 'v5';
 var osrmTextInstructions = require('osrm-text-instructions')(version);
 
-// If you’re unsure if the user’s locale is supported, use `getBestMatchingLanguage` method to find an appropriate language.
-var language = osrmTextInstructions.getBestMatchingLanguage('en-US');
-
 response.legs.forEach(function(leg) {
   leg.steps.forEach(function(step) {
-    instruction = osrmTextInstructions.compile(language, step, options)
+    instruction = osrmTextInstructions.compile('en', step, options)
   });
 });
 ```
 
+If you are unsure if the user's locale is supported by osrm-text-inustrctions, use [@mapbox/locale-utils](https://github.com/mapbox/locale-utils) for finding the best fitting language.
+
 #### Parameters `require('osrm-text-instructions')(version)`
 
 parameter | required? | values | description

index.js

@@ -272,47 +272,6 @@ module.exports = function(version) {
             }
 
             return output;
-        },
-        getBestMatchingLanguage: function(language) {
-            if (languages.instructions[language]) return language;
-
-            var codes = languages.parseLanguageIntoCodes(language);
-            var languageCode = codes.language;
-            var scriptCode = codes.script;
-            var regionCode = codes.region;
-
-            // Same language code and script code (lng-Scpt)
-            if (languages.instructions[languageCode + '-' + scriptCode]) {
-                return languageCode + '-' + scriptCode;
-            }
-
-            // Same language code and region code (lng-CC)
-            if (languages.instructions[languageCode + '-' + regionCode]) {
-                return languageCode + '-' + regionCode;
-            }
-
-            // Same language code (lng)
-            if (languages.instructions[languageCode]) {
-                return languageCode;
-            }
-
-            // Same language code and any script code (lng-Scpx) and the found language contains a script
-            var anyScript = languages.parsedSupportedCodes.find(function (language) {
-                return language.language === languageCode && language.script;
-            });
-            if (anyScript) {
-                return anyScript.locale;
-            }
-
-            // Same language code and any region code (lng-CX)
-            var anyCountry = languages.parsedSupportedCodes.find(function (language) {
-                return language.language === languageCode && language.region;
-            });
-            if (anyCountry) {
-                return anyCountry.locale;
-            }
-
-            return 'en';
         }
     };
 };

languages.js

@@ -92,38 +92,9 @@ var abbreviations = {
     'uk': abbreviationsUk,
     'vi': abbreviationsVi
 };
-
-function parseLanguageIntoCodes (language) {
-    var match = language.match(/(\w\w)(?:-(\w\w\w\w))?(?:-(\w\w))?/i);
-    var locale = [];
-    if (match[1]) {
-        match[1] = match[1].toLowerCase();
-        locale.push(match[1]);
-    }
-    if (match[2]) {
-        match[2] = match[2][0].toUpperCase() + match[2].substring(1).toLowerCase();
-        locale.push(match[2]);
-    }
-    if (match[3]) {
-        match[3] = match[3].toUpperCase();
-        locale.push(match[3]);
-    }
-
-    return {
-        locale: locale.join('-'),
-        language: match[1],
-        script: match[2],
-        region: match[3]
-    };
-}
-
 module.exports = {
     supportedCodes: Object.keys(instructions),
-    parsedSupportedCodes: Object.keys(instructions).map(function(language) {
-        return parseLanguageIntoCodes(language);
-    }),
     instructions: instructions,
     grammars: grammars,
-    abbreviations: abbreviations,
-    parseLanguageIntoCodes: parseLanguageIntoCodes
+    abbreviations: abbreviations
 };

test/index_test.js

@@ -249,93 +249,6 @@ tape.test('v5 compile', function(t) {
 
         assert.end();
     });
-
-    t.test('en-US fallback to en', function(assert) {
-        var language = v5Compiler.getBestMatchingLanguage('en-us');
-
-        assert.equal(v5Compiler.compile(language, {
-            maneuver: {
-                type: 'turn',
-                modifier: 'left'
-            },
-            name: 'Way Name'
-        }), 'Turn left onto Way Name');
-
-        assert.end();
-    });
-
-    t.test('zh-CN fallback to zh-Hans', function(assert) {
-        var language = v5Compiler.getBestMatchingLanguage('zh-CN');
-
-        assert.equal(v5Compiler.compile(language, {
-            maneuver: {
-                type: 'turn',
-                modifier: 'left'
-            },
-            name: 'Way Name'
-        }), '左转，上Way Name');
-
-        assert.end();
-    });
-
-    t.test('zh-Hant fallback to zh-Hanz', function(assert) {
-        var language = v5Compiler.getBestMatchingLanguage('zh-Hant');
-
-        assert.equal(v5Compiler.compile(language, {
-            maneuver: {
-                type: 'turn',
-                modifier: 'left'
-            },
-            name: 'Way Name'
-        }), '左转，上Way Name');
-
-        assert.end();
-    });
-
-    t.test('zh-Hant-TW fallback to zh-Hant', function(assert) {
-        var language = v5Compiler.getBestMatchingLanguage('zh-Hant-TW');
-
-        assert.equal(v5Compiler.compile(language, {
-            maneuver: {
-                type: 'turn',
-                modifier: 'left'
-            },
-            name: 'Way Name'
-        }), '左转，上Way Name');
-
-        assert.end();
-    });
-
-    t.test('es-MX fallback to es', function(assert) {
-        var language = v5Compiler.getBestMatchingLanguage('es-MX');
-
-        assert.equal(v5Compiler.compile(language, {
-            maneuver: {
-                type: 'turn',
-                modifier: 'straight'
-            },
-            name: 'Way Name'
-        }), 'Ve recto en Way Name');
-
-        assert.end();
-    });
-
-    t.test('getBestMatchingLanguage', function(t) {
-        t.equal(v5Compiler.getBestMatchingLanguage('foo'), 'en');
-        t.equal(v5Compiler.getBestMatchingLanguage('en-US'), 'en');
-        t.equal(v5Compiler.getBestMatchingLanguage('zh-CN'), 'zh-Hans');
-        t.equal(v5Compiler.getBestMatchingLanguage('zh-Hant'), 'zh-Hans');
-        t.equal(v5Compiler.getBestMatchingLanguage('zh-Hant-TW'), 'zh-Hans');
-        t.equal(v5Compiler.getBestMatchingLanguage('zh'), 'zh-Hans');
-        t.equal(v5Compiler.getBestMatchingLanguage('es-MX'), 'es');
-        t.equal(v5Compiler.getBestMatchingLanguage('es-ES'), 'es-ES');
-        t.equal(v5Compiler.getBestMatchingLanguage('pt'), 'pt-BR');
-        t.equal(v5Compiler.getBestMatchingLanguage('pt-AO'), 'pt-BR');
-        t.equal(v5Compiler.getBestMatchingLanguage('pt-PT'), 'pt-PT');
-        t.equal(v5Compiler.getBestMatchingLanguage('pt-pt'), 'pt-PT');
-        t.end();
-    });
-
     t.test('fixtures match generated instructions', function(assert) {
         // pre-load instructions
         var version = 'v5';

test/languages_test.js

@@ -68,19 +68,3 @@ tape.test('verify language files structure', function(assert) {
 
     assert.end();
 });
-
-/* eslint-disable */
-tape.test('parseLanguageIntoCodes', function(t) {
-    t.deepEqual(languages.parseLanguageIntoCodes('foo'), { region: undefined, language: 'fo', locale: 'fo', script: undefined });
-    t.deepEqual(languages.parseLanguageIntoCodes('en-US'), { region: 'US', language: 'en', locale: 'en-US', script: undefined });
-    t.deepEqual(languages.parseLanguageIntoCodes('zh-CN'), { region: 'CN', language: 'zh', locale: 'zh-CN', script: undefined });
-    t.deepEqual(languages.parseLanguageIntoCodes('zh-Hant'),  { region: undefined, language: 'zh', locale: 'zh-Hant', script: 'Hant' });
-    t.deepEqual(languages.parseLanguageIntoCodes('zh-Hant-TW'),  { region: 'TW', language: 'zh', locale: 'zh-Hant-TW', script: 'Hant' });
-    t.deepEqual(languages.parseLanguageIntoCodes('zh'), { region: undefined, language: 'zh', locale: 'zh', script: undefined });
-    t.deepEqual(languages.parseLanguageIntoCodes('es-MX'), { region: 'MX', language: 'es', locale: 'es-MX', script: undefined });
-    t.deepEqual(languages.parseLanguageIntoCodes('es-ES'), { region: 'ES', language: 'es', locale: 'es-ES', script: undefined });
-    t.deepEqual(languages.parseLanguageIntoCodes('pt-PT'),  { region: 'PT', language: 'pt', locale: 'pt-PT', script: undefined });
-    t.deepEqual(languages.parseLanguageIntoCodes('pt'), { region: undefined, language: 'pt', locale: 'pt', script: undefined });
-    t.end();
-});
-/* eslint-enable */