Structured road names, codes, destinations

MapboxDirections/MBRouteStep.swift

@@ -371,6 +371,60 @@ public enum ManeuverDirection: Int, CustomStringConvertible {
     }
 }
 
+extension String {
+    internal func tagValuesSeparatedByString(separator: String) -> [String] {
+        return componentsSeparatedByString(separator).map { $0.stringByTrimmingCharactersInSet(.whitespaceCharacterSet()) }.filter { !$0.isEmpty }
+    }
+}
+
+/**
+ Encapsulates all the information about a road.
+ */
+struct Road {
+    let names: [String]?
+    let codes: [String]?
+    let destinations: [String]?
+    let destinationCodes: [String]?
+
+    init(name: String, ref: String?, destination: String?) {
+        var codes: [String]?
+        if !name.isEmpty, let ref = ref {
+            // Mapbox Directions API v5 encodes the ref separately from the name but redundantly includes the ref in the name for backwards compatibility. Remove the ref from the name.
+            let parenthetical = "(\(ref))"
+            if name == ref {
+                self.names = nil
+            } else {
+                self.names = name.stringByReplacingOccurrencesOfString(parenthetical, withString: "").tagValuesSeparatedByString(";")
+            }
+            codes = ref.tagValuesSeparatedByString(";")
+        } else if !name.isEmpty, let codesRange = name.rangeOfString("\\(.+?\\)$", options: .RegularExpressionSearch, range: name.startIndex..<name.endIndex) {
+            // Mapbox Directions API v4 encodes the ref inside a parenthetical. Remove the ref from the name.
+            let parenthetical = name.substringWithRange(codesRange)
+            if name == ref {
+                self.names = nil
+            } else {
+                self.names = name.stringByReplacingOccurrencesOfString(parenthetical, withString: "").tagValuesSeparatedByString(";")
+            }
+            codes = parenthetical.stringByTrimmingCharactersInSet(NSCharacterSet(charactersInString: "()")).tagValuesSeparatedByString(";")
+        } else {
+            self.names = name.isEmpty ? nil : name.tagValuesSeparatedByString(";")
+            codes = nil
+        }
+
+        // Mapbox Directions API v5 combines the destination’s ref and name.
+        if let destination = destination where destination.containsString(": ") {
+            let destinationComponents = destination.componentsSeparatedByString(": ")
+            self.destinationCodes = destinationComponents.first?.tagValuesSeparatedByString(",")
+            self.destinations = destinationComponents.dropFirst().joinWithSeparator(": ").tagValuesSeparatedByString(",")
+        } else {
+            self.destinationCodes = nil
+            self.destinations = destination?.tagValuesSeparatedByString(",")
+        }
+
+        self.codes = codes
+    }
+}
+
 /**
  A `RouteStep` object represents a single distinct maneuver along a route and the approach to the next maneuver. The route step object corresponds to a single instruction the user must follow to complete a portion of the route. For example, a step might require the user to turn then follow a road.
 
@@ -380,9 +434,14 @@ public enum ManeuverDirection: Int, CustomStringConvertible {
 public class RouteStep: NSObject, NSSecureCoding {
     // MARK: Creating a Step
 
-    internal init(finalHeading: CLLocationDirection?, maneuverType: ManeuverType?, maneuverDirection: ManeuverDirection?, maneuverLocation: CLLocationCoordinate2D, name: String?, coordinates: [CLLocationCoordinate2D]?, json: JSONDictionary) {
+    internal init(finalHeading: CLLocationDirection?, maneuverType: ManeuverType?, maneuverDirection: ManeuverDirection?, maneuverLocation: CLLocationCoordinate2D, name: String, coordinates: [CLLocationCoordinate2D]?, json: JSONDictionary) {
         transportType = TransportType(description: json["mode"] as! String)
-        destinations = json["destinations"] as? String
+
+        let road = Road(name: name, ref: json["ref"] as? String, destination: json["destinations"] as? String)
+        names = road.names
+        codes = road.codes
+        destinationCodes = road.destinationCodes
+        destinations = road.destinations
 
         let maneuver = json["maneuver"] as! JSONDictionary
 
@@ -402,16 +461,14 @@ public class RouteStep: NSObject, NSSecureCoding {
         expectedTravelTime = json["duration"] as? Double ?? 0
 
         let intersectionsJSON = json["intersections"] as? [JSONDictionary]
-        self.intersections = intersectionsJSON?.map { Intersection(json: $0) }
+        intersections = intersectionsJSON?.map { Intersection(json: $0) }
 
         initialHeading = maneuver["bearing_before"] as? Double
         self.finalHeading = finalHeading
         self.maneuverType = maneuverType
         self.maneuverDirection = maneuverDirection
         exitIndex = maneuver["exit"] as? Int
 
-        self.name = name
-
         self.maneuverLocation = maneuverLocation
         self.coordinates = coordinates
     }
@@ -430,7 +487,7 @@ public class RouteStep: NSObject, NSSecureCoding {
         let maneuverDirection = ManeuverDirection(description: maneuver["modifier"] as? String ?? "")
         let maneuverLocation = CLLocationCoordinate2D(geoJSON: maneuver["location"] as! [Double])
 
-        let name = json["name"] as? String
+        let name = json["name"] as! String
 
         var coordinates: [CLLocationCoordinate2D]?
         switch json["geometry"] {
@@ -482,14 +539,16 @@ public class RouteStep: NSObject, NSSecureCoding {
         exitIndex = decoder.containsValueForKey("exitIndex") ? decoder.decodeIntegerForKey("exitIndex") : nil
         distance = decoder.decodeDoubleForKey("distance")
         expectedTravelTime = decoder.decodeDoubleForKey("expectedTravelTime")
-        name = decoder.decodeObjectForKey("name") as? String
+        names = decoder.decodeObjectOfClasses([NSArray.self, NSString.self], forKey: "names") as? [String]
 
         guard let transportTypeDescription = decoder.decodeObjectOfClass(NSString.self, forKey: "transportType") as? String else {
             return nil
         }
         transportType = TransportType(description: transportTypeDescription)
 
-        destinations = decoder.decodeObjectOfClass(NSString.self, forKey: "destinations") as? String
+        codes = decoder.decodeObjectOfClasses([NSArray.self, NSString.self], forKey: "codes") as? [String]
+        destinationCodes = decoder.decodeObjectOfClasses([NSArray.self, NSString.self], forKey: "destinationCodes") as? [String]
+        destinations = decoder.decodeObjectOfClasses([NSArray.self, NSString.self], forKey: "destinations") as? [String]
 
         intersections = decoder.decodeObjectOfClasses([NSArray.self, Intersection.self], forKey: "intersections") as? [Intersection]
     }
@@ -530,8 +589,10 @@ public class RouteStep: NSObject, NSSecureCoding {
 
         coder.encodeDouble(distance, forKey: "distance")
         coder.encodeDouble(expectedTravelTime, forKey: "expectedTravelTime")
-        coder.encodeObject(name, forKey: "name")
+        coder.encodeObject(names, forKey: "names")
         coder.encodeObject(transportType?.description, forKey: "transportType")
+        coder.encodeObject(codes, forKey: "codes")
+        coder.encodeObject(destinationCodes, forKey: "destinationCodes")
         coder.encodeObject(destinations, forKey: "destinations")
     }
 
@@ -650,11 +711,20 @@ public class RouteStep: NSObject, NSSecureCoding {
     public let expectedTravelTime: NSTimeInterval
 
     /**
-     The name of the road or path leading from this step’s maneuver to the next step’s maneuver.
+     The names of the road or path leading from this step’s maneuver to the next step’s maneuver.
 
-     If the maneuver is a turning maneuver, the step’s name is the name of the road or path onto which the user turns. The name includes any route designations assigned to the road. If you display the name to the user, you may need to abbreviate common words like “East” or “Boulevard” to ensure that it fits in the allotted space.
+     If the maneuver is a turning maneuver, the step’s name is the name of the road or path onto which the user turns. If you display the name to the user, you may need to abbreviate common words like “East” or “Boulevard” to ensure that it fits in the allotted space.
      */
-    public let name: String?
+    public let names: [String]?
+
+    /**
+     Any route reference codes assigned to the road or path leading from this step’s maneuver to the next step’s maneuver.
+
+     A route reference code commonly consists of an alphabetic network code, a space or hyphen, and a route number. You should not assume that the network code is globally unique: for example, a network code of “NH” may indicate a “National Highway” or “New Hampshire”. Moreover, a route number may not even uniqely identify a route within a given network.
+
+     If a highway ramp is part of a numbered route, its reference code is contained in this property. On the other hand, guide signage for a highway ramp usually indicates route reference codes of the adjoining road; use the `destinationCodes` property for those route reference codes.
+     */
+    public let codes: [String]?
 
     // MARK: Getting Additional Step Details
 
@@ -666,11 +736,20 @@ public class RouteStep: NSObject, NSSecureCoding {
     public let transportType: TransportType?
 
     /**
-     Destinations, such as [control cities](https://en.wikipedia.org/wiki/Control_city), that appear on guide signage for the road identified in the `name` property.
+     Any route reference codes that appear on guide signage for the road leading from this step’s maneuver to the next step’s maneuver.
+
+     This property is typically available in steps leading to or from a freeway or expressway. This property contains route reference codes associated with a road later in the route. If a highway ramp is itself part of a numbered route, its reference code is contained in the `codes` property.
+
+     A route reference code commonly consists of an alphabetic network code, a space or hyphen, and a route number. You should not assume that the network code is globally unique: for example, a network code of “NH” may indicate a “National Highway” or “New Hampshire”. Moreover, a route number may not even uniqely identify a route within a given network. A destination code for a divided road is often suffixed with the cardinal direction of travel, for example “I 80 East”.
+     */
+    public let destinationCodes: [String]?
+
+    /**
+     Destinations, such as [control cities](https://en.wikipedia.org/wiki/Control_city), that appear on guide signage for the road leading from this step’s maneuver to the next step’s maneuver.
 
      This property is typically available in steps leading to or from a freeway or expressway.
      */
-    public let destinations: String?
+    public let destinations: [String]?
 
     /**
      An array of intersections along the step.
@@ -722,7 +801,7 @@ internal class RouteStepV4: RouteStep {
         let maneuverDirection = ManeuverDirection(v4TypeDescription: maneuver["type"] as! String)
         let maneuverLocation = CLLocationCoordinate2D(geoJSON: maneuver["location"] as! JSONDictionary)
 
-        let name = json["way_name"] as? String
+        let name = json["way_name"] as! String
 
         self.init(finalHeading: heading, maneuverType: maneuverType, maneuverDirection: maneuverDirection, maneuverLocation: maneuverLocation, name: name, coordinates: nil, json: json)
     }

MapboxDirectionsTests/V4Tests.swift

@@ -66,7 +66,8 @@ class V4Tests: XCTestCase {
         XCTAssertEqual(step.distance, 223582.0)
         XCTAssertEqual(step.expectedTravelTime, 7219.0)
         XCTAssertEqual(step.instructions, "Go straight onto I 80;US 93 Alternate, I 80;US 93 ALT becomes I 80;US 93 Alternate")
-        XCTAssertEqual(step.name, "I 80;US 93 Alternate")
+        XCTAssertNotNil(step.names)
+        XCTAssertEqual(step.names ?? [], ["I 80", "US 93 Alternate"])
         XCTAssertEqual(step.maneuverType, ManeuverType.Continue)
         XCTAssertNil(step.maneuverDirection)
         XCTAssertNil(step.initialHeading)

MapboxDirectionsTests/V5Tests.swift

@@ -40,7 +40,7 @@ class V5Tests: XCTestCase {
             XCTAssertNil(error, "Error: \(error)")
 
             XCTAssertNotNil(routes)
-            XCTAssertEqual(routes!.count, 1)
+            XCTAssertEqual(routes!.count, 2)
             route = routes!.first!
 
             expectation.fulfill()
@@ -54,7 +54,7 @@ class V5Tests: XCTestCase {
 
         XCTAssertNotNil(route)
         XCTAssertNotNil(route!.coordinates)
-        XCTAssertEqual(route!.coordinates!.count, 842)
+        XCTAssertEqual(route!.coordinates!.count, 28_442)
 
         // confirming actual decoded values is important because the Directions API
         // uses an atypical precision level for polyline encoding
@@ -63,40 +63,58 @@ class V5Tests: XCTestCase {
         XCTAssertEqual(route!.legs.count, 1)
 
         let leg = route!.legs.first!
-        XCTAssertEqual(leg.name, "CA 24, Camino Tassajara")
-        XCTAssertEqual(leg.steps.count, 22)
+        XCTAssertEqual(leg.name, "I 80, I 80;US 30")
+        XCTAssertEqual(leg.steps.count, 59)
 
-        let step = leg.steps[16]
-        XCTAssertEqual(round(step.distance), 166)
-        XCTAssertEqual(round(step.expectedTravelTime), 13)
-        XCTAssertEqual(step.instructions, "Take the ramp on the right")
+        let step = leg.steps[43]
+        XCTAssertEqual(round(step.distance), 688)
+        XCTAssertEqual(round(step.expectedTravelTime), 30)
+        XCTAssertEqual(step.instructions, "Take the ramp on the right towards Washington")
 
-        XCTAssertEqual(step.name, "")
-        XCTAssertEqual(step.destinations, "Sycamore Valley Road")
+        XCTAssertNil(step.names)
+        XCTAssertNotNil(step.destinations)
+        XCTAssertEqual(step.destinations ?? [], ["Washington"])
         XCTAssertEqual(step.maneuverType, ManeuverType.TakeOffRamp)
         XCTAssertEqual(step.maneuverDirection, ManeuverDirection.SlightRight)
-        XCTAssertEqual(step.initialHeading, 182)
-        XCTAssertEqual(step.finalHeading, 196)
+        XCTAssertEqual(step.initialHeading, 90)
+        XCTAssertEqual(step.finalHeading, 96)
 
         XCTAssertNotNil(step.coordinates)
-        XCTAssertEqual(step.coordinates!.count, 5)
+        XCTAssertEqual(step.coordinates!.count, 17)
         XCTAssertEqual(step.coordinates!.count, Int(step.coordinateCount))
         let coordinate = step.coordinates!.first!
-        XCTAssertEqual(round(coordinate.latitude), 38)
-        XCTAssertEqual(round(coordinate.longitude), -122)
+        XCTAssertEqual(round(coordinate.latitude), 39)
+        XCTAssertEqual(round(coordinate.longitude), -77)
 
-        XCTAssertEqual(leg.steps[18].name, "Sycamore Valley Road West")
+        XCTAssertNil(leg.steps[28].names)
+        XCTAssertEqual(leg.steps[28].codes ?? [], ["I 80"])
+        XCTAssertEqual(leg.steps[28].destinationCodes ?? [], ["I 80 East", "I 90"])
+        XCTAssertEqual(leg.steps[28].destinations ?? [], ["Toll Road"])
 
-        let intersection = step.intersections!.first!
-        XCTAssertEqual(intersection.outletIndexes, NSIndexSet(indexesInRange: NSRange(location: 1, length: 2)))
-        XCTAssertEqual(intersection.approachIndex, 0)
-        XCTAssertEqual(intersection.outletIndex, 2)
-        XCTAssertEqual(intersection.headings, [0, 180, 195])
-        XCTAssertNotNil(intersection.location.latitude)
-        XCTAssertNotNil(intersection.location.longitude)
-        XCTAssertEqual(intersection.usableApproachLanes, NSIndexSet(indexesInRange: NSRange(location: 0, length: 2)))
+        XCTAssertEqual(leg.steps[30].names ?? [], ["Ohio Turnpike"])
+        XCTAssertEqual(leg.steps[30].codes ?? [], ["I 80", "I 90"])
+        XCTAssertNil(leg.steps[30].destinationCodes)
+        XCTAssertNil(leg.steps[30].destinations)
 
-        let lane = intersection.approachLanes?.first
+        let intersections = leg.steps[40].intersections
+        XCTAssertNotNil(intersections)
+        XCTAssertEqual(intersections?.count, 7)
+        let intersection = intersections?[2]
+        XCTAssertEqual(intersection?.outletIndexes.containsIndex(0), true)
+        XCTAssertEqual(intersection?.outletIndexes.containsIndexesInRange(NSRange(location: 2, length: 2)), true)
+        XCTAssertEqual(intersection?.approachIndex, 1)
+        XCTAssertEqual(intersection?.outletIndex, 3)
+        XCTAssertEqual(intersection?.headings ?? [], [15, 90, 195, 270])
+        XCTAssertNotNil(intersection?.location.latitude)
+        XCTAssertNotNil(intersection?.location.longitude)
+        XCTAssertEqual(intersection?.usableApproachLanes ?? [], NSIndexSet(indexesInRange: NSRange(location: 1, length: 3)))
+
+        XCTAssertEqual(leg.steps[57].names ?? [], ["Logan Circle Northwest"])
+        XCTAssertNil(leg.steps[57].codes)
+        XCTAssertNil(leg.steps[57].destinationCodes)
+        XCTAssertNil(leg.steps[57].destinations)
+
+        let lane = intersection?.approachLanes?.first
         let indications = lane?.indications
         XCTAssertNotNil(indications)
         XCTAssertTrue(indications!.contains(.Left))

RouteStepTests.swift

@@ -18,7 +18,7 @@ class RouteStepTests: XCTestCase {
             "duration": 75.6,
         ]
 
-        let step = RouteStep(finalHeading: 59, maneuverType: .ReachFork, maneuverDirection: .Left, maneuverLocation: CLLocationCoordinate2D(latitude: 37.853913, longitude: -122.220694), name: nil, coordinates: coordinates, json: json)
+        let step = RouteStep(finalHeading: 59, maneuverType: .ReachFork, maneuverDirection: .Left, maneuverLocation: CLLocationCoordinate2D(latitude: 37.853913, longitude: -122.220694), name: "", coordinates: coordinates, json: json)
 
         // Encode and decode the route step securely
         // This may raise an Obj-C exception if an error is encountered which will fail the tests
@@ -49,8 +49,8 @@ class RouteStepTests: XCTestCase {
         XCTAssertEqual(unarchivedStep.exitIndex, step.exitIndex)
         XCTAssertEqual(unarchivedStep.distance, step.distance)
         XCTAssertEqual(unarchivedStep.expectedTravelTime, step.expectedTravelTime)
-        XCTAssertEqual(unarchivedStep.name, step.name)
+        XCTAssertEqual(unarchivedStep.names ?? [], step.names ?? [])
         XCTAssertEqual(unarchivedStep.transportType, step.transportType)
-        XCTAssertEqual(unarchivedStep.destinations, step.destinations)
+        XCTAssertEqual(unarchivedStep.destinations ?? [], step.destinations ?? [])
     }
 }