Skip to content

Commit 37339f7

Browse files
danpazdanpaz
authored
Merge pull request #235 from Project-OSRM/arrive-waypoint-name-instruction
Arrival instruction includes an optional named waypoint
2 parents d0e8a96 + 7f79f09 commit 37339f7

36 files changed

+727
-175
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file. For change
66
- Added a European Portuguese localization. [#229](https://github.com/Project-OSRM/osrm-text-instructions/pull/229)
77
- 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)
88
- Added some abbreviations in German, Hebrew, Hungarian, Slovenian, and Ukrainian. [#226](https://github.com/Project-OSRM/osrm-text-instructions/pull/226)
9+
- Added support for named waypoints in arrival instructions. [#235](https://github.com/Project-OSRM/osrm-text-instructions/pull/235)
910

1011
## 0.12.0 2018-02-26
1112

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ parameter | required? | values | description
4545
key | type | description
4646
----|----|----
4747
`legCount` | integer | Number of legs in the route
48-
`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
48+
`legIndex` | integer | Zero-based index of the leg containing the step; together with `legCount`, this option determines which waypoint the user has arrived at
4949
`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
50+
`waypointName` | string | Optional custom name for the leg's destination, replaces `"your {nth} destination"`
5051

5152
`formatToken` takes two parameters:
5253

‎index.js‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,25 @@ module.exports = function(version) {
106106

107107
return wayName;
108108
},
109-
compile: function(language, step, options) {
109+
110+
/**
111+
* Formulate a localized text instruction from a step.
112+
*
113+
* @param {string} language Language code.
114+
* @param {object} step Step including maneuver property.
115+
* @param {object} opts Additional options.
116+
* @param {string} opts.legIndex Index of leg in the route.
117+
* @param {string} opts.legCount Total number of legs in the route.
118+
* @param {array} opts.classes List of road classes.
119+
* @param {string} opts.waypointName Name of waypoint for arrival instruction.
120+
*
121+
* @return {string} Localized text instruction.
122+
*/
123+
compile: function(language, step, opts) {
110124
if (!language) throw new Error('No language code provided');
111125
if (languages.supportedCodes.indexOf(language) === -1) throw new Error('language code ' + language + ' not loaded');
112126
if (!step.maneuver) throw new Error('No step maneuver provided');
127+
var options = opts || {};
113128

114129
var type = step.maneuver.type;
115130
var modifier = step.maneuver.modifier;
@@ -185,6 +200,8 @@ module.exports = function(version) {
185200
instruction = instructionObject.exit;
186201
} else if (wayName && instructionObject.name) {
187202
instruction = instructionObject.name;
203+
} else if (options.waypointName && instructionObject.named) {
204+
instruction = instructionObject.named;
188205
} else {
189206
instruction = instructionObject.default;
190207
}
@@ -199,7 +216,7 @@ module.exports = function(version) {
199216
firstDestination = destinationRef || destination || '';
200217
}
201218

202-
var nthWaypoint = options && options.legIndex >= 0 && options.legIndex !== options.legCount - 1 ? this.ordinalize(language, options.legIndex + 1) : '';
219+
var nthWaypoint = options.legIndex >= 0 && options.legIndex !== options.legCount - 1 ? this.ordinalize(language, options.legIndex + 1) : '';
203220

204221
// Replace tokens
205222
// NOOP if they don't exist
@@ -212,7 +229,8 @@ module.exports = function(version) {
212229
'lane_instruction': laneInstruction,
213230
'modifier': instructions[language][version].constants.modifier[modifier],
214231
'direction': this.directionFromDegree(language, step.maneuver.bearing_after),
215-
'nth': nthWaypoint
232+
'nth': nthWaypoint,
233+
'waypoint_name': options.waypointName
216234
};
217235

218236
return this.tokenize(language, instruction, replaceTokens, options);

‎languages/overrides/ru.js‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ function optionize(phrase) {
1515
var re = new RegExp(pattern[0], 'gi');
1616
result = result.replace(re, pattern[1]);
1717
});
18+
1819
return result;
19-
};
20+
}
2021

2122
function iterate(values) {
2223
Object.keys(values).forEach(function (key) {
@@ -27,10 +28,11 @@ function iterate(values) {
2728
iterate(value);
2829
}
2930
});
30-
};
31+
}
3132

3233
module.exports = function(content) {
3334
// Iterate all content string values recursively
3435
iterate(content.v5);
36+
3537
return content;
3638
};

‎languages/translations/da.json‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,49 +62,57 @@
6262
"default": "Du er ankommet til din {nth} destination",
6363
"upcoming": "Du vil ankomme til din {nth} destination",
6464
"short": "Du er ankommet",
65-
"short-upcoming": "Du vil ankomme"
65+
"short-upcoming": "Du vil ankomme",
66+
"named": "Du er ankommet til {waypoint_name}"
6667
},
6768
"left": {
6869
"default": "Du er ankommet til din {nth} destination, som befinder sig til venstre",
6970
"upcoming": "Du vil ankomme til din {nth} destination på venstre hånd",
7071
"short": "Du er ankommet",
71-
"short-upcoming": "Du vil ankomme"
72+
"short-upcoming": "Du vil ankomme",
73+
"named": "Du er ankommet til {waypoint_name}, som befinder sig til venstre"
7274
},
7375
"right": {
7476
"default": "Du er ankommet til din {nth} destination, som befinder sig til højre",
7577
"upcoming": "Du vil ankomme til din {nth} destination på højre hånd",
7678
"short": "Du er ankommet",
77-
"short-upcoming": "Du vil ankomme"
79+
"short-upcoming": "Du vil ankomme",
80+
"named": "Du er ankommet til {waypoint_name}, som befinder sig til højre"
7881
},
7982
"sharp left": {
8083
"default": "Du er ankommet til din {nth} destination, som befinder sig til venstre",
8184
"upcoming": "Du vil ankomme til din {nth} destination på venstre hånd",
8285
"short": "Du er ankommet",
83-
"short-upcoming": "Du vil ankomme"
86+
"short-upcoming": "Du vil ankomme",
87+
"named": "Du er ankommet til {waypoint_name}, som befinder sig til venstre"
8488
},
8589
"sharp right": {
8690
"default": "Du er ankommet til din {nth} destination, som befinder sig til højre",
8791
"upcoming": "Du vil ankomme til din {nth} destination på højre hånd",
8892
"short": "Du er ankommet",
89-
"short-upcoming": "Du vil ankomme"
93+
"short-upcoming": "Du vil ankomme",
94+
"named": "Du er ankommet til {waypoint_name}, som befinder sig til højre"
9095
},
9196
"slight right": {
9297
"default": "Du er ankommet til din {nth} destination, som befinder sig til højre",
9398
"upcoming": "Du vil ankomme til din {nth} destination på højre hånd",
9499
"short": "Du er ankommet",
95-
"short-upcoming": "Du vil ankomme"
100+
"short-upcoming": "Du vil ankomme",
101+
"named": "Du er ankommet til {waypoint_name}, som befinder sig til højre"
96102
},
97103
"slight left": {
98104
"default": "Du er ankommet til din {nth} destination, som befinder sig til venstre",
99105
"upcoming": "Du vil ankomme til din {nth} destination på venstre hånd",
100106
"short": "Du er ankommet",
101-
"short-upcoming": "Du vil ankomme"
107+
"short-upcoming": "Du vil ankomme",
108+
"named": "Du er ankommet til {waypoint_name}, som befinder sig til venstre"
102109
},
103110
"straight": {
104111
"default": "Du er ankommet til din {nth} destination, der befinder sig lige frem",
105112
"upcoming": "Du vil ankomme til din {nth} destination foran dig",
106113
"short": "Du er ankommet",
107-
"short-upcoming": "Du vil ankomme"
114+
"short-upcoming": "Du vil ankomme",
115+
"named": "Du er ankommet til {waypoint_name}, der befinder sig lige frem"
108116
}
109117
},
110118
"continue": {

‎languages/translations/de.json‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,49 +62,57 @@
6262
"default": "Sie haben Ihr {nth} Ziel erreicht",
6363
"upcoming": "Sie haben Ihr {nth} Ziel erreicht",
6464
"short": "Sie haben Ihr {nth} Ziel erreicht",
65-
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
65+
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
66+
"named": "Sie haben Ihr {waypoint_name}"
6667
},
6768
"left": {
6869
"default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
6970
"upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
7071
"short": "Sie haben Ihr {nth} Ziel erreicht",
71-
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
72+
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
73+
"named": "Sie haben Ihr {waypoint_name}, es befindet sich links"
7274
},
7375
"right": {
7476
"default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
7577
"upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
7678
"short": "Sie haben Ihr {nth} Ziel erreicht",
77-
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
79+
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
80+
"named": "Sie haben Ihr {waypoint_name}, es befindet sich rechts"
7881
},
7982
"sharp left": {
8083
"default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
8184
"upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
8285
"short": "Sie haben Ihr {nth} Ziel erreicht",
83-
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
86+
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
87+
"named": "Sie haben Ihr {waypoint_name}, es befindet sich links"
8488
},
8589
"sharp right": {
8690
"default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
8791
"upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
8892
"short": "Sie haben Ihr {nth} Ziel erreicht",
89-
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
93+
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
94+
"named": "Sie haben Ihr {waypoint_name}, es befindet sich rechts"
9095
},
9196
"slight right": {
9297
"default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
9398
"upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich rechts",
9499
"short": "Sie haben Ihr {nth} Ziel erreicht",
95-
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
100+
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
101+
"named": "Sie haben Ihr {waypoint_name}, es befindet sich rechts"
96102
},
97103
"slight left": {
98104
"default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
99105
"upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich links",
100106
"short": "Sie haben Ihr {nth} Ziel erreicht",
101-
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
107+
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
108+
"named": "Sie haben Ihr {waypoint_name}, es befindet sich links"
102109
},
103110
"straight": {
104111
"default": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich geradeaus",
105112
"upcoming": "Sie haben Ihr {nth} Ziel erreicht, es befindet sich geradeaus",
106113
"short": "Sie haben Ihr {nth} Ziel erreicht",
107-
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht"
114+
"short-upcoming": "Sie haben Ihr {nth} Ziel erreicht",
115+
"named": "Sie haben Ihr {waypoint_name}, es befindet sich geradeaus"
108116
}
109117
},
110118
"continue": {

‎languages/translations/en.json‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,49 +62,57 @@
6262
"default": "You have arrived at your {nth} destination",
6363
"upcoming": "You will arrive at your {nth} destination",
6464
"short": "You have arrived",
65-
"short-upcoming": "You will arrive"
65+
"short-upcoming": "You will arrive",
66+
"named": "You have arrived at {waypoint_name}"
6667
},
6768
"left": {
6869
"default": "You have arrived at your {nth} destination, on the left",
6970
"upcoming": "You will arrive at your {nth} destination, on the left",
7071
"short": "You have arrived",
71-
"short-upcoming": "You will arrive"
72+
"short-upcoming": "You will arrive",
73+
"named": "You have arrived at {waypoint_name}, on the left"
7274
},
7375
"right": {
7476
"default": "You have arrived at your {nth} destination, on the right",
7577
"upcoming": "You will arrive at your {nth} destination, on the right",
7678
"short": "You have arrived",
77-
"short-upcoming": "You will arrive"
79+
"short-upcoming": "You will arrive",
80+
"named": "You have arrived at {waypoint_name}, on the right"
7881
},
7982
"sharp left": {
8083
"default": "You have arrived at your {nth} destination, on the left",
8184
"upcoming": "You will arrive at your {nth} destination, on the left",
8285
"short": "You have arrived",
83-
"short-upcoming": "You will arrive"
86+
"short-upcoming": "You will arrive",
87+
"named": "You have arrived at {waypoint_name}, on the left"
8488
},
8589
"sharp right": {
8690
"default": "You have arrived at your {nth} destination, on the right",
8791
"upcoming": "You will arrive at your {nth} destination, on the right",
8892
"short": "You have arrived",
89-
"short-upcoming": "You will arrive"
93+
"short-upcoming": "You will arrive",
94+
"named": "You have arrived at {waypoint_name}, on the right"
9095
},
9196
"slight right": {
9297
"default": "You have arrived at your {nth} destination, on the right",
9398
"upcoming": "You will arrive at your {nth} destination, on the right",
9499
"short": "You have arrived",
95-
"short-upcoming": "You will arrive"
100+
"short-upcoming": "You will arrive",
101+
"named": "You have arrived at {waypoint_name}, on the right"
96102
},
97103
"slight left": {
98104
"default": "You have arrived at your {nth} destination, on the left",
99105
"upcoming": "You will arrive at your {nth} destination, on the left",
100106
"short": "You have arrived",
101-
"short-upcoming": "You will arrive"
107+
"short-upcoming": "You will arrive",
108+
"named": "You have arrived at {waypoint_name}, on the left"
102109
},
103110
"straight": {
104111
"default": "You have arrived at your {nth} destination, straight ahead",
105112
"upcoming": "You will arrive at your {nth} destination, straight ahead",
106113
"short": "You have arrived",
107-
"short-upcoming": "You will arrive"
114+
"short-upcoming": "You will arrive",
115+
"named": "You have arrived at {waypoint_name}, straight ahead"
108116
}
109117
},
110118
"continue": {

‎languages/translations/eo.json‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,49 +62,57 @@
6262
"default": "Vi atingis vian {nth} celon",
6363
"upcoming": "Vi atingos vian {nth} celon",
6464
"short": "Vi atingis",
65-
"short-upcoming": "Vi atingos"
65+
"short-upcoming": "Vi atingos",
66+
"named": "Vi atingis {waypoint_name}"
6667
},
6768
"left": {
6869
"default": "Vi atingis vian {nth} celon ĉe maldekstre",
6970
"upcoming": "Vi atingos vian {nth} celon ĉe maldekstre",
7071
"short": "Vi atingis",
71-
"short-upcoming": "Vi atingos"
72+
"short-upcoming": "Vi atingos",
73+
"named": "Vi atingis {waypoint_name} ĉe maldekstre"
7274
},
7375
"right": {
7476
"default": "Vi atingis vian {nth} celon ĉe dekstre",
7577
"upcoming": "Vi atingos vian {nth} celon ĉe dekstre",
7678
"short": "Vi atingis",
77-
"short-upcoming": "Vi atingos"
79+
"short-upcoming": "Vi atingos",
80+
"named": "Vi atingis {waypoint_name} ĉe dekstre"
7881
},
7982
"sharp left": {
8083
"default": "Vi atingis vian {nth} celon ĉe maldekstre",
8184
"upcoming": "Vi atingos vian {nth} celon ĉe maldekstre",
8285
"short": "Vi atingis",
83-
"short-upcoming": "Vi atingos"
86+
"short-upcoming": "Vi atingos",
87+
"named": "Vi atingis {waypoint_name} ĉe maldekstre"
8488
},
8589
"sharp right": {
8690
"default": "Vi atingis vian {nth} celon ĉe dekstre",
8791
"upcoming": "Vi atingos vian {nth} celon ĉe dekstre",
8892
"short": "Vi atingis",
89-
"short-upcoming": "Vi atingos"
93+
"short-upcoming": "Vi atingos",
94+
"named": "Vi atingis {waypoint_name} ĉe dekstre"
9095
},
9196
"slight right": {
9297
"default": "Vi atingis vian {nth} celon ĉe dekstre",
9398
"upcoming": "Vi atingos vian {nth} celon ĉe dekstre",
9499
"short": "Vi atingis",
95-
"short-upcoming": "Vi atingos"
100+
"short-upcoming": "Vi atingos",
101+
"named": "Vi atingis {waypoint_name} ĉe dekstre"
96102
},
97103
"slight left": {
98104
"default": "Vi atingis vian {nth} celon ĉe maldekstre",
99105
"upcoming": "Vi atingos vian {nth} celon ĉe maldekstre",
100106
"short": "Vi atingis",
101-
"short-upcoming": "Vi atingos"
107+
"short-upcoming": "Vi atingos",
108+
"named": "Vi atingis {waypoint_name} ĉe maldekstre"
102109
},
103110
"straight": {
104111
"default": "Vi atingis vian {nth} celon",
105112
"upcoming": "Vi atingos vian {nth} celon rekte",
106113
"short": "Vi atingis",
107-
"short-upcoming": "Vi atingos"
114+
"short-upcoming": "Vi atingos",
115+
"named": "Vi atingis {waypoint_name}"
108116
}
109117
},
110118
"continue": {

0 commit comments

Comments
 (0)