Number destination upon arrival

Added optional arguments to OSRMInstructionFormatter.string(for:modifyValueByKey:) to track which leg the instruction is on. When there are multiple waypoints in the route, indicate the ordinal number of the waypoint in the arrival instruction.

Fixed the raw value of TokenType.wayPoint.

Updated tests. Ensure that formatted ordinals match the fixture language (English) rather than the test machine’s language.

Author: 1ec5

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
         }
@@ -221,7 +221,10 @@ 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 destination = step.destinations?.first ?? ""
         var exit: String = ""
         if let exitIndex = step.exitIndex, exitIndex <= 10 {
@@ -262,7 +265,7 @@ public class OSRMInstructionFormatter: Formatter {
                     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

@@ -29,7 +29,7 @@ public enum TokenType: Int, CustomStringConvertible {
             type = .modifier
         case "direction":
             type = .direction
-        case "way_point":
+        case "nth":
             type = .wayPoint
         default:
             return nil
@@ -54,7 +54,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(
@@ -107,6 +115,7 @@ class OSRMTextInstructionsTests: XCTestCase {
         fixture["step"] = step
         fixture["instruction"] = (json["instructions"] as! [ String: Any ])["en"] as! String
 
+        fixture["options"] = json["options"]
         return fixture
     }
 }