Merge pull request #235 from Project-OSRM/arrive-waypoint-name-instru…

…ction Arrival instruction includes an optional named waypoint
Project-OSRM · Apr 11, 2018 · 37339f7 · 37339f7
2 parents d0e8a96 + 7f79f09
commit 37339f7
Show file tree

Hide file tree

Showing 36 changed files with 727 additions and 175 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file. For change
 - Added a European Portuguese localization. [#229](https://github.com/Project-OSRM/osrm-text-instructions/pull/229)
 - The Spanish localization now uses the informal imperative form instead of the formal imperative form, for consistency with the Castillian Spanish localization. [#230](https://github.com/Project-OSRM/osrm-text-instructions/pull/230)
 - Added some abbreviations in German, Hebrew, Hungarian, Slovenian, and Ukrainian. [#226](https://github.com/Project-OSRM/osrm-text-instructions/pull/226)
+- Added support for named waypoints in arrival instructions. [#235](https://github.com/Project-OSRM/osrm-text-instructions/pull/235)
 
 ## 0.12.0 2018-02-26
 

diff --git a/README.md b/README.md
@@ -45,8 +45,9 @@ parameter | required? | values | description
 key | type | description
 ----|----|----
 `legCount` | integer | Number of legs in the route
-`legIndex` | integer | Zero-based index of the leg containing the step; together with `legIndex`, this option determines whether an arrival instruction indicates which waypoint the user has arrived at
+`legIndex` | integer | Zero-based index of the leg containing the step; together with `legCount`, this option determines which waypoint the user has arrived at
 `formatToken` | function | Function that formats the given token value after grammaticalization and capitalization but before the value is inserted into the instruction string; useful for wrapping tokens in markup
+`waypointName` | string | Optional custom name for the leg's destination, replaces `"your {nth} destination"`
 
 `formatToken` takes two parameters:
 

diff --git a/index.js b/index.js
@@ -106,10 +106,25 @@ module.exports = function(version) {
 
             return wayName;
         },
-        compile: function(language, step, options) {
+
+        /**
+         * Formulate a localized text instruction from a step.
+         *
+         * @param  {string} language           Language code.
+         * @param  {object} step               Step including maneuver property.
+         * @param  {object} opts               Additional options.
+         * @param  {string} opts.legIndex      Index of leg in the route.
+         * @param  {string} opts.legCount      Total number of legs in the route.
+         * @param  {array}  opts.classes       List of road classes.
+         * @param  {string} opts.waypointName  Name of waypoint for arrival instruction.
+         *
+         * @return {string} Localized text instruction.
+         */
+        compile: function(language, step, opts) {
             if (!language) throw new Error('No language code provided');
             if (languages.supportedCodes.indexOf(language) === -1) throw new Error('language code ' + language + ' not loaded');
             if (!step.maneuver) throw new Error('No step maneuver provided');
+            var options = opts || {};
 
             var type = step.maneuver.type;
             var modifier = step.maneuver.modifier;
@@ -185,6 +200,8 @@ module.exports = function(version) {
                 instruction = instructionObject.exit;
             } else if (wayName && instructionObject.name) {
                 instruction = instructionObject.name;
+            } else if (options.waypointName && instructionObject.named) {
+                instruction = instructionObject.named;
             } else {
                 instruction = instructionObject.default;
             }
@@ -199,7 +216,7 @@ module.exports = function(version) {
                 firstDestination = destinationRef || destination || '';
             }
 
-            var nthWaypoint = options && options.legIndex >= 0 && options.legIndex !== options.legCount - 1 ? this.ordinalize(language, options.legIndex + 1) : '';
+            var nthWaypoint = options.legIndex >= 0 && options.legIndex !== options.legCount - 1 ? this.ordinalize(language, options.legIndex + 1) : '';
 
             // Replace tokens
             // NOOP if they don't exist
@@ -212,7 +229,8 @@ module.exports = function(version) {
                 'lane_instruction': laneInstruction,
                 'modifier': instructions[language][version].constants.modifier[modifier],
                 'direction': this.directionFromDegree(language, step.maneuver.bearing_after),
-                'nth': nthWaypoint
+                'nth': nthWaypoint,
+                'waypoint_name': options.waypointName
             };
 
             return this.tokenize(language, instruction, replaceTokens, options);

diff --git a/languages/overrides/ru.js b/languages/overrides/ru.js
@@ -15,8 +15,9 @@ function optionize(phrase) {
         var re = new RegExp(pattern[0], 'gi');
         result = result.replace(re, pattern[1]);
     });
+
     return result;
-};
+}
 
 function iterate(values) {
     Object.keys(values).forEach(function (key) {
@@ -27,10 +28,11 @@ function iterate(values) {
             iterate(value);
         }
     });
-};
+}
 
 module.exports = function(content) {
     // Iterate all content string values recursively
     iterate(content.v5);
+
     return content;
 };
diff --git a/languages/translations/da.json b/languages/translations/da.json
@@ -62,49 +62,57 @@
                 "default": "Du er ankommet til din {nth} destination",
                 "upcoming": "Du vil ankomme til din {nth} destination",
                 "short": "Du er ankommet",
-                "short-upcoming": "Du vil ankomme"
+                "short-upcoming": "Du vil ankomme",
+                "named": "Du er ankommet til {waypoint_name}"
             },
             "left": {
                 "default": "Du er ankommet til din {nth} destination, som befinder sig til venstre",
                 "upcoming": "Du vil ankomme til din {nth} destination på venstre hånd",
                 "short": "Du er ankommet",
-                "short-upcoming": "Du vil ankomme"
+                "short-upcoming": "Du vil ankomme",
+                "named": "Du er ankommet til {waypoint_name}, som befinder sig til venstre"
             },
             "right": {
                 "default": "Du er ankommet til din {nth} destination, som befinder sig til højre",
                 "upcoming": "Du vil ankomme til din {nth} destination på højre hånd",
                 "short": "Du er ankommet",
-                "short-upcoming": "Du vil ankomme"
+                "short-upcoming": "Du vil ankomme",
+                "named": "Du er ankommet til {waypoint_name}, som befinder sig til højre"
             },
             "sharp left": {
                 "default": "Du er ankommet til din {nth} destination, som befinder sig til venstre",
                 "upcoming": "Du vil ankomme til din {nth} destination på venstre hånd",
                 "short": "Du er ankommet",
-                "short-upcoming": "Du vil ankomme"
+                "short-upcoming": "Du vil ankomme",
+                "named": "Du er ankommet til {waypoint_name}, som befinder sig til venstre"
             },
             "sharp right": {
                 "default": "Du er ankommet til din {nth} destination, som befinder sig til højre",
                 "upcoming": "Du vil ankomme til din {nth} destination på højre hånd",
                 "short": "Du er ankommet",
-                "short-upcoming": "Du vil ankomme"
+                "short-upcoming": "Du vil ankomme",
+                "named": "Du er ankommet til {waypoint_name}, som befinder sig til højre"
             },
             "slight right": {
                 "default": "Du er ankommet til din {nth} destination, som befinder sig til højre",
                 "upcoming": "Du vil ankomme til din {nth} destination på højre hånd",
                 "short": "Du er ankommet",
-                "short-upcoming": "Du vil ankomme"
+                "short-upcoming": "Du vil ankomme",
+                "named": "Du er ankommet til {waypoint_name}, som befinder sig til højre"
             },
             "slight left": {
                 "default": "Du er ankommet til din {nth} destination, som befinder sig til venstre",
                 "upcoming": "Du vil ankomme til din {nth} destination på venstre hånd",
                 "short": "Du er ankommet",
-                "short-upcoming": "Du vil ankomme"
+                "short-upcoming": "Du vil ankomme",
+                "named": "Du er ankommet til {waypoint_name}, som befinder sig til venstre"
             },
             "straight": {
                 "default": "Du er ankommet til din {nth} destination, der befinder sig lige frem",
                 "upcoming": "Du vil ankomme til din {nth} destination foran dig",
                 "short": "Du er ankommet",
-                "short-upcoming": "Du vil ankomme"
+                "short-upcoming": "Du vil ankomme",
+                "named": "Du er ankommet til {waypoint_name}, der befinder sig lige frem"
             }
         },
         "continue": {

diff --git a/languages/translations/de.json b/languages/translations/de.json
@@ -62,49 +62,57 @@
                 "default": "Sie haben Ihr {nth} Ziel erreicht",
                 "upcoming": "Sie haben Ihr {nth} Ziel erreicht",
                 "short": "Sie haben Ihr {nth} Ziel erreicht",
-                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
+                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
+                "named": "Sie haben Ihr {waypoint_name}"
             },
             "left": {
                 "default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
                 "upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
                 "short": "Sie haben Ihr {nth} Ziel erreicht",
-                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
+                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
+                "named": "Sie haben Ihr {waypoint_name}, es befindet sich links"
             },
             "right": {
                 "default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
                 "upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
                 "short": "Sie haben Ihr {nth} Ziel erreicht",
-                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
+                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
+                "named": "Sie haben Ihr {waypoint_name}, es befindet sich rechts"
             },
             "sharp left": {
                 "default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
                 "upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
                 "short": "Sie haben Ihr {nth} Ziel erreicht",
-                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
+                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
+                "named": "Sie haben Ihr {waypoint_name}, es befindet sich links"
             },
             "sharp right": {
                 "default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
                 "upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
                 "short": "Sie haben Ihr {nth} Ziel erreicht",
-                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
+                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
+                "named": "Sie haben Ihr {waypoint_name}, es befindet sich rechts"
             },
             "slight right": {
                 "default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
                 "upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
                 "short": "Sie haben Ihr {nth} Ziel erreicht",
-                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
+                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
+                "named": "Sie haben Ihr {waypoint_name}, es befindet sich rechts"
             },
             "slight left": {
                 "default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
                 "upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
                 "short": "Sie haben Ihr {nth} Ziel erreicht",
-                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
+                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
+                "named": "Sie haben Ihr {waypoint_name}, es befindet sich links"
             },
             "straight": {
                 "default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich geradeaus",
                 "upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich geradeaus",
                 "short": "Sie haben Ihr {nth} Ziel erreicht",
-                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
+                "short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
+                "named": "Sie haben Ihr {waypoint_name}, es befindet sich geradeaus"
             }
         },
         "continue": {

diff --git a/languages/translations/en.json b/languages/translations/en.json
@@ -62,49 +62,57 @@
                 "default": "You have arrived at your {nth} destination",
                 "upcoming": "You will arrive at your {nth} destination",
                 "short": "You have arrived",
-                "short-upcoming": "You will arrive"
+                "short-upcoming": "You will arrive",
+                "named": "You have arrived at {waypoint_name}"
             },
             "left": {
                 "default": "You have arrived at your {nth} destination, on the left",
                 "upcoming": "You will arrive at your {nth} destination, on the left",
                 "short": "You have arrived",
-                "short-upcoming": "You will arrive"
+                "short-upcoming": "You will arrive",
+                "named": "You have arrived at {waypoint_name}, on the left"
             },
             "right": {
                 "default": "You have arrived at your {nth} destination, on the right",
                 "upcoming": "You will arrive at your {nth} destination, on the right",
                 "short": "You have arrived",
-                "short-upcoming": "You will arrive"
+                "short-upcoming": "You will arrive",
+                "named": "You have arrived at {waypoint_name}, on the right"
             },
             "sharp left": {
                 "default": "You have arrived at your {nth} destination, on the left",
                 "upcoming": "You will arrive at your {nth} destination, on the left",
                 "short": "You have arrived",
-                "short-upcoming": "You will arrive"
+                "short-upcoming": "You will arrive",
+                "named": "You have arrived at {waypoint_name}, on the left"
             },
             "sharp right": {
                 "default": "You have arrived at your {nth} destination, on the right",
                 "upcoming": "You will arrive at your {nth} destination, on the right",
                 "short": "You have arrived",
-                "short-upcoming": "You will arrive"
+                "short-upcoming": "You will arrive",
+                "named": "You have arrived at {waypoint_name}, on the right"
             },
             "slight right": {
                 "default": "You have arrived at your {nth} destination, on the right",
                 "upcoming": "You will arrive at your {nth} destination, on the right",
                 "short": "You have arrived",
-                "short-upcoming": "You will arrive"
+                "short-upcoming": "You will arrive",
+                "named": "You have arrived at {waypoint_name}, on the right"
             },
             "slight left": {
                 "default": "You have arrived at your {nth} destination, on the left",
                 "upcoming": "You will arrive at your {nth} destination, on the left",
                 "short": "You have arrived",
-                "short-upcoming": "You will arrive"
+                "short-upcoming": "You will arrive",
+                "named": "You have arrived at {waypoint_name}, on the left"
             },
             "straight": {
                 "default": "You have arrived at your {nth} destination, straight ahead",
                 "upcoming": "You will arrive at your {nth} destination, straight ahead",
                 "short": "You have arrived",
-                "short-upcoming": "You will arrive"
+                "short-upcoming": "You will arrive",
+                "named": "You have arrived at {waypoint_name}, straight ahead"
             }
         },
         "continue": {

diff --git a/languages/translations/eo.json b/languages/translations/eo.json
@@ -62,49 +62,57 @@
                 "default": "Vi atingis vian {nth} celon",
                 "upcoming": "Vi atingos vian {nth} celon",
                 "short": "Vi atingis",
-                "short-upcoming": "Vi atingos"
+                "short-upcoming": "Vi atingos",
+                "named": "Vi atingis {waypoint_name}"
             },
             "left": {
                 "default": "Vi atingis vian {nth} celon ĉe maldekstre",
                 "upcoming": "Vi atingos vian {nth} celon ĉe maldekstre",
                 "short": "Vi atingis",
-                "short-upcoming": "Vi atingos"
+                "short-upcoming": "Vi atingos",
+                "named": "Vi atingis {waypoint_name} ĉe maldekstre"
             },
             "right": {
                 "default": "Vi atingis vian {nth} celon ĉe dekstre",
                 "upcoming": "Vi atingos vian {nth} celon ĉe dekstre",
                 "short": "Vi atingis",
-                "short-upcoming": "Vi atingos"
+                "short-upcoming": "Vi atingos",
+                "named": "Vi atingis {waypoint_name} ĉe dekstre"
             },
             "sharp left": {
                 "default": "Vi atingis vian {nth} celon ĉe maldekstre",
                 "upcoming": "Vi atingos vian {nth} celon ĉe maldekstre",
                 "short": "Vi atingis",
-                "short-upcoming": "Vi atingos"
+                "short-upcoming": "Vi atingos",
+                "named": "Vi atingis {waypoint_name} ĉe maldekstre"
             },
             "sharp right": {
                 "default": "Vi atingis vian {nth} celon ĉe dekstre",
                 "upcoming": "Vi atingos vian {nth} celon ĉe dekstre",
                 "short": "Vi atingis",
-                "short-upcoming": "Vi atingos"
+                "short-upcoming": "Vi atingos",
+                "named": "Vi atingis {waypoint_name} ĉe dekstre"
             },
             "slight right": {
                 "default": "Vi atingis vian {nth} celon ĉe dekstre",
                 "upcoming": "Vi atingos vian {nth} celon ĉe dekstre",
                 "short": "Vi atingis",
-                "short-upcoming": "Vi atingos"
+                "short-upcoming": "Vi atingos",
+                "named": "Vi atingis {waypoint_name} ĉe dekstre"
             },
             "slight left": {
                 "default": "Vi atingis vian {nth} celon ĉe maldekstre",
                 "upcoming": "Vi atingos vian {nth} celon ĉe maldekstre",
                 "short": "Vi atingis",
-                "short-upcoming": "Vi atingos"
+                "short-upcoming": "Vi atingos",
+                "named": "Vi atingis {waypoint_name} ĉe maldekstre"
             },
             "straight": {
                 "default": "Vi atingis vian {nth} celon",
                 "upcoming": "Vi atingos vian {nth} celon rekte",
                 "short": "Vi atingis",
-                "short-upcoming": "Vi atingos"
+                "short-upcoming": "Vi atingos",
+                "named": "Vi atingis {waypoint_name}"
             }
         },
         "continue": {