Merge pull request #28 from Project-OSRM/wayname-class

Author: Bobby Sudekum

Cartfile.resolved

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

OSRMTextInstructions/OSRMTextInstructions.swift

@@ -121,10 +121,20 @@ public class OSRMInstructionFormatter: Formatter {
     typealias InstructionsByModifier = [String: InstructionsByToken]
 
     override public func string(for obj: Any?) -> String? {
-        return string(for: obj, legIndex: nil, numberOfLegs: nil, modifyValueByKey: nil)
+        return string(for: obj, legIndex: nil, numberOfLegs: nil, roadClasses: nil, modifyValueByKey: nil)
     }
 
-    public func string(for obj: Any?, legIndex: Int?, numberOfLegs: Int?, modifyValueByKey: ((TokenType, String) -> String)?) -> String? {
+    /**
+     Creates an instruction given a step and options.
+     
+     - parameter step: 
+     - parameter legIndex: Current leg index the user is currently on.
+     - parameter numberOfLegs: Total number of `RouteLeg` for the given `Route`.
+     - parameter roadClasses: Option set representing the classes of road for the `RouteStep`.
+     - parameter modifyValueByKey: Allows for mutating the instruction at given parts of the instruction.
+     - returns: An instruction as a `String`.
+     */
+    public func string(for obj: Any?, legIndex: Int?, numberOfLegs: Int?, roadClasses: RoadClasses? = RoadClasses([]), modifyValueByKey: ((TokenType, String) -> String)?) -> String? {
         guard let step = obj as? RouteStep else {
             return nil
         }
@@ -179,9 +189,12 @@ public class OSRMInstructionFormatter: Formatter {
             // Set wayName
             let name = step.names?.first
             let ref = step.codes?.first
+            let isMotorway = roadClasses?.contains(.motorway) ?? false
 
-            if let name = name, let ref = ref, name != ref {
+            if let name = name, let ref = ref, name != ref, !isMotorway {
                 wayName = modifyValueByKey != nil ? "\(modifyValueByKey!(.wayName, name)) (\(modifyValueByKey!(.wayName, ref)))" : "\(name) (\(ref))"
+            } else if let ref = ref, isMotorway, let decimalRange = ref.rangeOfCharacter(from: .decimalDigits), !decimalRange.isEmpty {
+                wayName = modifyValueByKey != nil ? "\(modifyValueByKey!(.wayName, ref))" : ref
             } else if name == nil, let ref = ref {
                 wayName = modifyValueByKey != nil ? "\(modifyValueByKey!(.wayName, ref))" : ref
             } else {

OSRMTextInstructionsTests/OSRMTextInstructionsTests.swift

@@ -34,12 +34,17 @@ class OSRMTextInstructionsTests: XCTestCase {
                         XCTAssert(false, "invalid json")
                         return
                     }
-                    let options = json["options"] as? [String: Int]
+                    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"], numberOfLegs: options?["legCount"], modifyValueByKey: nil)
+                    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(