Refactored token substitution

Added some cases for phrase tokens to TokenType. Extracted token replacement code for a String extension method. Added tests for token substitution in phrases. Simplified test code.

Author: 1ec5

OSRMTextInstructions/OSRMTextInstructions.swift

@@ -8,6 +8,61 @@ extension String {
     public var sentenceCased: String {
         return String(characters.prefix(1)).uppercased() + String(characters.dropFirst())
     }
+    
+    /**
+     Replaces `{tokens}` in the receiver using the given closure.
+     */
+    public func replacingTokens(using interpolator: ((TokenType) -> String)) -> String {
+        let scanner = Scanner(string: self)
+        scanner.charactersToBeSkipped = nil
+        var result = ""
+        while !scanner.isAtEnd {
+            var buffer: NSString?
+            
+            if scanner.scanUpTo("{", into: &buffer) {
+                result += buffer! as String
+            }
+            guard scanner.scanString("{", into: nil) else {
+                continue
+            }
+            
+            var token: NSString?
+            guard scanner.scanUpTo("}", into: &token) else {
+                continue
+            }
+            
+            if scanner.scanString("}", into: nil) {
+                if let tokenType = TokenType(description: token! as String) {
+                    result += interpolator(tokenType)
+                }
+            } else {
+                result += token! as String
+            }
+        }
+        
+        // remove excess spaces
+        result = result.replacingOccurrences(of: "\\s\\s", with: " ", options: .regularExpression)
+        
+        // capitalize
+        let meta = OSRMTextInstructionsStrings["meta"] as! [String: Any]
+        if meta["capitalizeFirstLetter"] as? Bool ?? false {
+            result = result.sentenceCased
+        }
+        return result
+    }
+}
+
+public enum Phrase: String {
+    case linkedInstructionsWithDistance = "two linked by distance"
+    case linkedInstructions = "two linked"
+    case instructionWithDistance = "one in distance"
+    case nameWithRef = "name and ref"
+}
+
+public struct PhraseOption {
+    static let firstInstruction = "instruction_one"
+    static let secondInstruction = "instruction_two"
+    static let distance = "distance"
 }
 
 public class OSRMInstructionFormatter: Formatter {
@@ -254,58 +309,27 @@ public class OSRMInstructionFormatter: Formatter {
         if step.finalHeading != nil { bearing = Int(step.finalHeading! as Double) }
 
         // Replace tokens
-        let scanner = Scanner(string: instruction)
-        scanner.charactersToBeSkipped = nil
-        var result = ""
-        while !scanner.isAtEnd {
-            var buffer: NSString?
-
-            if scanner.scanUpTo("{", into: &buffer) {
-                result += buffer! as String
-            }
-            guard scanner.scanString("{", into: nil) else {
-                continue
-            }
-
-            var token: NSString?
-            guard scanner.scanUpTo("}", into: &token) else {
-                continue
+        let result = instruction.replacingTokens { (tokenType) -> String in
+            var replacement: String
+            switch tokenType {
+            case .code: replacement = step.codes?.first ?? ""
+            case .wayName: replacement = wayName
+            case .destination: replacement = destination
+            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 .firstInstruction, .secondInstruction, .distance:
+                fatalError("Unexpected token type \(tokenType) in individual instruction")
             }
-            
-            if scanner.scanString("}", into: nil) {
-                if let tokenType = TokenType(description: token! as String) {
-                    var replacement: String
-                    switch tokenType {
-                    case .code: replacement = step.codes?.first ?? ""
-                    case .wayName: replacement = wayName
-                    case .destination: replacement = destination
-                    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 ?? ""
-                    }
-                    if tokenType == .wayName {
-                        result += replacement // already modified above
-                    } else {
-                        result += modifyValueByKey?(tokenType, replacement) ?? replacement
-                    }
-                }
+            if tokenType == .wayName {
+                return replacement // already modified above
             } else {
-                result += token! as String
+                return modifyValueByKey?(tokenType, replacement) ?? replacement
             }
-            
-        }
-
-        // remove excess spaces
-        result = result.replacingOccurrences(of: "\\s\\s", with: " ", options: .regularExpression)
-
-        // capitalize
-        let meta = OSRMTextInstructionsStrings["meta"] as! [String: Any]
-        if meta["capitalizeFirstLetter"] as? Bool ?? false {
-            result = result.sentenceCased
         }
 
         return result

OSRMTextInstructions/TokenType.swift

@@ -2,7 +2,7 @@ import Foundation
 
 @objc(OSRMTokenType)
 public enum TokenType: Int, CustomStringConvertible {
-    
+    // For individual instructions
     case wayName
     case destination
     case rotaryName
@@ -14,6 +14,11 @@ public enum TokenType: Int, CustomStringConvertible {
     case wayPoint
     case code
 
+    // For phrases
+    case firstInstruction
+    case secondInstruction
+    case distance
+    
     public init?(description: String) {
         let type: TokenType
         switch description {
@@ -37,6 +42,12 @@ public enum TokenType: Int, CustomStringConvertible {
             type = .wayPoint
         case "ref":
             type = .code
+        case "instruction_one":
+            type = .firstInstruction
+        case "instruction_two":
+            type = .secondInstruction
+        case "distance":
+            type = .distance
         default:
             return nil
         }
@@ -65,6 +76,12 @@ public enum TokenType: Int, CustomStringConvertible {
             return "nth"
         case .code:
             return "ref"
+        case .firstInstruction:
+            return "instruction_one"
+        case .secondInstruction:
+            return "instruction_two"
+        case .distance:
+            return "distance"
         }
     }
 }

OSRMTextInstructionsTests/OSRMTextInstructionsTests.swift

@@ -21,31 +21,60 @@ class OSRMTextInstructionsTests: XCTestCase {
     }
 
     func testFixtures() {
-        do {
-            let bundle = Bundle(for: OSRMTextInstructionsTests.self)
-            let url = bundle.url(forResource: "v5", withExtension: nil, subdirectory: "osrm-text-instructions/test/fixtures/")!
-            
-            let directoryContents = try FileManager.default.contentsOfDirectory(at: url, includingPropertiesForKeys: nil, options: [])
-            for type in directoryContents {
-                let typeDirectoryContents = try FileManager.default.contentsOfDirectory(at: type, includingPropertiesForKeys: nil, options: [])
-                for fixture in typeDirectoryContents {
+        let bundle = Bundle(for: OSRMTextInstructionsTests.self)
+        let url = bundle.url(forResource: "v5", withExtension: nil, subdirectory: "osrm-text-instructions/test/fixtures/")!
+        
+        let v5 = OSRMTextInstructionsStrings["v5"] as! [String: Any]
+        let phrases = v5["phrase"] as! [String: String]
+        
+        var directoryContents: [URL] = []
+        XCTAssertNoThrow(directoryContents = try FileManager.default.contentsOfDirectory(at: url, includingPropertiesForKeys: nil, options: []))
+        for type in directoryContents {
+            var typeDirectoryContents: [URL] = []
+            XCTAssertNoThrow(typeDirectoryContents = try FileManager.default.contentsOfDirectory(at: type, includingPropertiesForKeys: nil, options: []))
+            for fixture in typeDirectoryContents {
+                if type.lastPathComponent == "phrase" {
+                    var rawJSON = Data()
+                    XCTAssertNoThrow(rawJSON = try Data(contentsOf: fixture, options: []))
+                    
+                    var json: [String: Any] = [:]
+                    XCTAssertNoThrow(json = try JSONSerialization.jsonObject(with: rawJSON, options: []) as! [String: Any])
+                    
+                    let phrase = fixture.deletingPathExtension().lastPathComponent.replacingOccurrences(of: "_", with: " ")
+                    let fixtureOptions = json["options"] as! [String: String]
+                    
+                    let expectedValue = (json["phrases"] as! [String: String])["en"]
+                    let actualValue = phrases[phrase]?.replacingTokens(using: { (tokenType) -> String in
+                        var replacement: String?
+                        switch tokenType {
+                        case .firstInstruction:
+                            replacement = fixtureOptions["instruction_one"]
+                        case .secondInstruction:
+                            replacement = fixtureOptions["instruction_two"]
+                        case .distance:
+                            replacement = fixtureOptions["distance"]
+                        default:
+                            XCTFail("Unexpected token type \(tokenType) in phrase \(phrase)")
+                        }
+                        XCTAssertNotNil(replacement, "Missing fixture option for \(tokenType)")
+                        return replacement ?? ""
+                    })
+                    XCTAssertEqual(expectedValue, actualValue, fixture.path)
+                } else {
                     // parse fixture
-                    guard let json = getFixture(url: fixture) else {
-                        XCTAssert(false, "invalid json")
-                        return
-                    }
+                    let json = getFixture(url: fixture)
                     let options = json["options"] as? [String: Any]
-
+                    
                     let step = RouteStep(json: json["step"] as! [String: Any])
 
                     var roadClasses: RoadClasses? = nil
                     if let classes = options?["classes"] as? [String] {
                         roadClasses = RoadClasses(descriptions: classes)
                     }
-
+                    
                     // compile instruction
                     let instruction = instructions.string(for: step, legIndex: options?["legIndex"] as? Int, numberOfLegs: options?["legCount"] as? Int, roadClasses: roadClasses, modifyValueByKey: nil)
-
+                    
                     // check generated instruction against fixture
                     XCTAssertEqual(
                         json["instruction"] as? String,
@@ -54,35 +83,23 @@ class OSRMTextInstructionsTests: XCTestCase {
                     )
                 }
             }
-        } catch let error as NSError {
-            print(error.localizedDescription)
-            XCTAssert(false)
         }
     }
 
-    func getFixture(url: URL) -> NSMutableDictionary? {
+    func getFixture(url: URL) -> [String: Any] {
         var rawJSON = Data()
-        do {
-            rawJSON = try Data(contentsOf: url, options: [])
-        } catch {
-            XCTAssert(false)
-        }
+        XCTAssertNoThrow(rawJSON = try Data(contentsOf: url, options: []))
 
-        let json: NSDictionary
-        do {
-            json = try JSONSerialization.jsonObject(with: rawJSON, options: []) as! NSDictionary
-        } catch {
-            XCTAssert(false)
-            return nil
-        }
+        var json: [String: Any] = [:]
+        XCTAssertNoThrow(json = try JSONSerialization.jsonObject(with: rawJSON, options: []) as! [String: Any])
 
         // provide default values for properties that RouteStep
         // needs, but that our not in the fixtures
-        let fixture: NSMutableDictionary = [:]
-        let maneuver: NSMutableDictionary = [
+        var fixture: [String: Any] = [:]
+        var maneuver: [String: Any] = [
             "location": [ 1.0, 1.0 ]
         ]
-        let step: NSMutableDictionary = [
+        var step: [String: Any] = [
             "mode": "driving"
         ]