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.

Sign up for GitHub

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

Jump to bottom

Add language/locale #176

Merged
merged 6 commits into from
Oct 9, 2017
Merged

Add language/locale #176

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
68db654
Add language/locale
Sep 15, 2017
fb42875
Update encoding, add default
Sep 16, 2017
29d17ad
fix zh
Sep 16, 2017
fe5a7da
Just append identifier
Oct 6, 2017
2914453
Remove
Oct 6, 2017
8e02238
Update docs
Oct 9, 2017
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
17 changes: 12 additions & 5 deletions MapboxDirections/MBRouteOptions.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,10 @@ open class RouteOptions: NSObject, NSSecureCoding {

includesExitRoundaboutManeuver = decoder.decodeBool(forKey: "includesExitRoundaboutManeuver")

locale = Locale(identifier: decoder.decodeObject(of: NSString.self, forKey: "locale") as String? ?? "")
guard let locale = decoder.decodeObject(of: NSLocale.self, forKey: "locale") as Locale? else {
return nil
}
self.locale = locale
}

open static var supportsSecureCoding = true
Expand All @@ -197,9 +200,7 @@ open class RouteOptions: NSObject, NSSecureCoding {
coder.encode(routeShapeResolution.description, forKey: "routeShapeResolution")
coder.encode(attributeOptions.description, forKey: "attributeOptions")
coder.encode(includesExitRoundaboutManeuver, forKey: "includesExitRoundaboutManeuver")
if let locale = locale, let languageCode = (locale as NSLocale?)?.object(forKey: .languageCode) as? String {
coder.encode(languageCode, forKey: "locale")
}
coder.encode(locale, forKey: "locale")
}

// MARK: Specifying the Path of the Route
Expand Down Expand Up @@ -315,6 +316,8 @@ open class RouteOptions: NSObject, NSSecureCoding {
*/
open var locale: Locale?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It’d be nice to default to Locale.autoupdatingCurrent or Bundle.main.preferredLocalizations.first so the behavior is always what the user would expect, but that can happen as tail work, possibly at the same time that we set a default locale in MapboxGeocoder.swift.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep this optional for now.


private let supportedLocales: [String] = ["de", "en", "es", "fr", "id", "nl", "ru", "sv", "vi", "zh-hans"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the locale is Simplified Chinese, its locale identifier will be zh-Hans, not zh-hans. The Directions API accepts zh-Hans as a language.


/**
An array of URL parameters to include in the request URL.
*/
Expand All @@ -332,7 +335,11 @@ open class RouteOptions: NSObject, NSSecureCoding {
}

if let locale = locale, let languageCode = (locale as NSLocale?)?.object(forKey: .languageCode) as? String {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The language code is only the two-letter ISO 369 code. It doesn’t ever include a region or script code; for that, you need the full locale identifier. Unfortunately, the Directions API currently lacks any sort of fallback mechanism. So this code will fail for Simplified Chinese (zh-Hant), yet if we were to pass in the full locale identifier, the code would break for a Spanish speaker in Mexico (es-MX) instead.

Until the Directions API gains basic language fallback capability, we’ll need to hard-code a whitelist of locales that the Directions API supports.

params.append(URLQueryItem(name: "language", value: languageCode))
if supportedLocales.contains(languageCode) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will fail for a Locale with the identifier zh-Hans, since its languageCode will be just zh.

params.append(URLQueryItem(name: "language", value: languageCode))
} else {
params.append(URLQueryItem(name: "language", value: "en"))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it necessary to append any language parameter in this case?

}
}

// Include headings and heading accuracies if any waypoint has a nonnegative heading.
Expand Down