Port OSRM Text Instructions to v0.5.0

Cartfile

@@ -1 +1 @@
-github "mapbox/MapboxDirections.swift" ~> 0.9
+github "mapbox/MapboxDirections.swift" ~> 0.10

Cartfile.resolved

@@ -1,2 +1,2 @@
-github "mapbox/MapboxDirections.swift" "v0.9.0"
+github "mapbox/MapboxDirections.swift" "v0.10.0"
 github "raphaelmor/Polyline" "v4.1.1"

OSRMTextInstructions.podspec

@@ -46,7 +46,7 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.module_name = "OSRMTextInstructions"
 
-  s.dependency "MapboxDirections.swift", "~> 0.9"
+  s.dependency "MapboxDirections.swift", "~> 0.10"
 
   s.prepare_command = "./json2plist.sh"
 

OSRMTextInstructions/OSRMTextInstructions.swift

@@ -121,10 +121,10 @@ public class OSRMInstructionFormatter: Formatter {
     typealias InstructionsByModifier = [String: InstructionsByToken]
 
     override public func string(for obj: Any?) -> String? {
-        return string(for: obj, modifyValueByKey: nil)
+        return string(for: obj, legIndex: nil, numberOfLegs: nil, modifyValueByKey: nil)
     }
 
-    public func string(for obj: Any?, modifyValueByKey: ((TokenType, String) -> String)?) -> String? {
+    public func string(for obj: Any?, legIndex: Int?, numberOfLegs: Int?, modifyValueByKey: ((TokenType, String) -> String)?) -> String? {
         guard let step = obj as? RouteStep else {
             return nil
         }
@@ -212,7 +212,11 @@ public class OSRMInstructionFormatter: Formatter {
         // Decide which instruction string to use
         // Destination takes precedence over name
         var instruction: String
-        if let _ = step.destinations, let obj = instructionObject["destination"] {
+        if let _ = step.destinations, let _ = step.exitCodes?.first, let obj = instructionObject["exit_destination"] {
+            instruction = obj
+        } else if let _ = step.destinations, let obj = instructionObject["destination"] {
+            instruction = obj
+        } else if let _ = step.exitCodes?.first, let obj = instructionObject["exit"] {
             instruction = obj
         } else if !wayName.isEmpty, let obj = instructionObject["name"] {
             instruction = obj
@@ -221,11 +225,15 @@ public class OSRMInstructionFormatter: Formatter {
         }
 
         // Prepare token replacements
-        let nthWaypoint = "" // TODO: add correct waypoint counting
+        var nthWaypoint: String? = nil
+        if let legIndex = legIndex, let numberOfLegs = numberOfLegs, legIndex != numberOfLegs - 1 {
+            nthWaypoint = ordinalFormatter.string(from: (legIndex + 1) as NSNumber)
+        }
+        let exitCode = step.exitCodes?.first ?? ""
         let destination = step.destinations?.first ?? ""
-        var exit: String = ""
+        var exitOrdinal: String = ""
         if let exitIndex = step.exitIndex, exitIndex <= 10 {
-            exit = ordinalFormatter.string(from: exitIndex as NSNumber)!
+            exitOrdinal = ordinalFormatter.string(from: exitIndex as NSNumber)!
         }
         let modifierConstants = constants["modifier"] as! [String: String]
         let modifierConstant = modifierConstants[modifier ?? "straight"]!
@@ -257,12 +265,13 @@ public class OSRMInstructionFormatter: Formatter {
                     switch tokenType {
                     case .wayName: replacement = wayName
                     case .destination: replacement = destination
-                    case .exit: replacement = exit
+                    case .exitCode: replacement = exitCode
+                    case .exitIndex: replacement = exitOrdinal
                     case .rotaryName: replacement = rotaryName
                     case .laneInstruction: replacement = laneInstruction ?? ""
                     case .modifier: replacement = modifierConstant
                     case .direction: replacement = directionFromDegree(degree: bearing)
-                    case .wayPoint: replacement = nthWaypoint
+                    case .wayPoint: replacement = nthWaypoint ?? ""
                     }
                     if tokenType == .wayName {
                         result += replacement // already modified above

OSRMTextInstructions/TokenType.swift

@@ -6,7 +6,8 @@ public enum TokenType: Int, CustomStringConvertible {
     case wayName
     case destination
     case rotaryName
-    case exit
+    case exitCode
+    case exitIndex
     case laneInstruction
     case modifier
     case direction
@@ -21,15 +22,17 @@ public enum TokenType: Int, CustomStringConvertible {
             type = .destination
         case "rotary_name":
             type = .rotaryName
+        case "exit":
+            type = .exitCode
         case "exit_number":
-            type = .exit
+            type = .exitIndex
         case "lane_instruction":
             type = .laneInstruction
         case "modifier":
             type = .modifier
         case "direction":
             type = .direction
-        case "way_point":
+        case "nth":
             type = .wayPoint
         default:
             return nil
@@ -45,7 +48,9 @@ public enum TokenType: Int, CustomStringConvertible {
             return "destination"
         case .rotaryName:
             return "rotary_name"
-        case .exit:
+        case .exitCode:
+            return "exit"
+        case .exitIndex:
             return "exit_number"
         case .laneInstruction:
             return "lane_instruction"
@@ -54,7 +59,7 @@ public enum TokenType: Int, CustomStringConvertible {
         case .direction:
             return "direction"
         case .wayPoint:
-            return "way_point"
+            return "nth"
         }
     }
 }

OSRMTextInstructionsTests/OSRMTextInstructionsTests.swift

@@ -1,9 +1,16 @@
 import XCTest
 import MapboxDirections
-import OSRMTextInstructions
+@testable import OSRMTextInstructions
 
 class OSRMTextInstructionsTests: XCTestCase {
     let instructions = OSRMInstructionFormatter(version: "v5")
+
+    override func setUp() {
+        super.setUp()
+
+        // Force an English locale to match the fixture language rather than the test machine’s language.
+        instructions.ordinalFormatter.locale = Locale(identifier: "en-US")
+    }
 
     func testSentenceCasing() {
         XCTAssertEqual("Capitalized String", "capitalized String".sentenceCased)
@@ -27,11 +34,12 @@ class OSRMTextInstructionsTests: XCTestCase {
                         XCTAssert(false, "invalid json")
                         return
                     }
+                    let options = json["options"] as? [String: Int]
 
                     let step = RouteStep(json: json["step"] as! [String: Any])
 
                     // compile instruction
-                    let instruction = instructions.string(for: step)
+                    let instruction = instructions.string(for: step, legIndex: options?["legIndex"], numberOfLegs: options?["legCount"], modifyValueByKey: nil)
 
                     // check generated instruction against fixture
                     XCTAssertEqual(
@@ -78,6 +86,9 @@ class OSRMTextInstructionsTests: XCTestCase {
         if let ref = jsonStep["ref"] {
             step["ref"] = ref
         }
+        if let exits = jsonStep["exits"] {
+            step["exits"] = exits
+        }
         if let destinations = jsonStep["destinations"] {
             step["destinations"] = destinations
         }
@@ -107,6 +118,7 @@ class OSRMTextInstructionsTests: XCTestCase {
         fixture["step"] = step
         fixture["instruction"] = (json["instructions"] as! [ String: Any ])["en"] as! String
 
+        fixture["options"] = json["options"]
         return fixture
     }
 }