Integrated new directions API fields with the tertiary instruction and lane indications

Cartfile

@@ -1,5 +1,5 @@
 binary "https://www.mapbox.com/ios-sdk/Mapbox-iOS-SDK.json" ~> 4.1
-github "mapbox/MapboxDirections.swift" ~> 0.21.0
+github "mapbox/MapboxDirections.swift" "then"
 github "mapbox/turf-swift" ~> 0.2
 github "mapbox/mapbox-events-ios" ~> 0.4
 github "ceeK/Solar" ~> 2.1.0

Cartfile.resolved

@@ -2,7 +2,7 @@ binary "https://www.mapbox.com/ios-sdk/Mapbox-iOS-SDK.json" "4.1.0"
 github "Quick/Nimble" "v7.1.2"
 github "Quick/Quick" "v1.3.0"
 github "ceeK/Solar" "2.1.0"
-github "mapbox/MapboxDirections.swift" "v0.21.0"
+github "mapbox/MapboxDirections.swift" "75818163ea4a6b611eb60746a948a298a2b20bab"
 github "mapbox/mapbox-events-ios" "v0.4.1"
 github "mapbox/mapbox-voice-swift" "v0.0.1"
 github "mapbox/turf-swift" "v0.2.0"

MapboxCoreNavigation.podspec

@@ -40,7 +40,7 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.module_name = "MapboxCoreNavigation"
 
-  s.dependency "MapboxDirections.swift", "~> 0.21.0"
+  s.dependency "MapboxDirections.swift", :git => "https://github.com/mapbox/MapboxDirections.swift.git", :branch => "then"
   s.dependency "MapboxMobileEvents", "~> 0.4"
   s.dependency "Turf", "~> 0.2"
 

MapboxNavigation-Documentation.podspec

@@ -43,7 +43,7 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.module_name = "MapboxNavigation"
 
-  s.dependency "MapboxDirections.swift", "~> 0.21.0"
+  s.dependency "MapboxDirections.swift", :git => "https://github.com/mapbox/MapboxDirections.swift.git", :branch => "then"
   s.dependency "Mapbox-iOS-SDK", "~> 4.1"
   s.dependency "MapboxMobileEvents", "~> 0.4"
   s.dependency "Solar", "~> 2.1"

MapboxNavigation/InstructionPresenter.swift

@@ -66,7 +66,7 @@ class InstructionPresenter {
     typealias AttributedInstructionComponents = (components: [VisualInstructionComponent], attributedStrings: [NSAttributedString])
 
     func attributedPairs(for instruction: VisualInstruction, dataSource: DataSource, imageRepository: ImageRepository, onImageDownload: @escaping ImageDownloadCompletion) -> AttributedInstructionComponents {
-        let components = instruction.textComponents
+        let components = instruction.components.compactMap { $0 as? VisualInstructionComponent }
         var strings: [NSAttributedString] = []
         var processedComponents: [VisualInstructionComponent] = []
 
@@ -166,7 +166,10 @@ class InstructionPresenter {
     }
 
     private func instructionHasDownloadedAllShields() -> Bool {
-        for component in instruction.textComponents {
+        let textComponents = instruction.components.compactMap { $0 as? VisualInstructionComponent }
+        guard !textComponents.isEmpty else { return false }
+
+        for component in textComponents {
             guard let key = component.cacheKey else {
                 continue
             }

MapboxNavigation/InstructionsBannerView.swift

@@ -102,7 +102,7 @@ open class BaseInstructionsBannerView: UIControl {
         super.prepareForInterfaceBuilder()
         maneuverView.isStart = true
         let component = VisualInstructionComponent(type: .text, text: "Primary text label", imageURL: nil, abbreviation: nil, abbreviationPriority: NSNotFound)
-        let instruction = VisualInstruction(text: nil, maneuverType: .none, maneuverDirection: .none, textComponents: [component])
+        let instruction = VisualInstruction(text: nil, maneuverType: .none, maneuverDirection: .none, components: [component])
         primaryLabel.instruction = instruction
 
         distance = 100

MapboxNavigation/LaneView.swift

@@ -32,6 +32,16 @@ open class LaneView: UIView {
         return isValid ? primaryColor : secondaryColor
     }
 
+    static let defaultFrame: CGRect = CGRect(origin: .zero, size: 30.0)
+
+    convenience init(component: LaneIndicationComponent, direction: ManeuverDirection) {
+        self.init(frame: LaneView.defaultFrame)
+        backgroundColor = .clear
+        lane = Lane(indications: component.indications)
+        maneuverDirection = direction
+        isValid = component.isUsable
+    }
+
     override open func draw(_ rect: CGRect) {
         super.draw(rect)
         if let lane = lane {

MapboxNavigation/LanesView.swift

@@ -67,30 +67,28 @@ open class LanesView: UIView {
     }
 
     func update(for currentLegProgress: RouteLegProgress) {
-        guard let step = currentLegProgress.upComingStep else { return }
-        guard !currentLegProgress.userHasArrivedAtWaypoint else { return }
-        let durationRemaining = currentLegProgress.currentStepProgress.durationRemaining
-
         clearLaneViews()
 
-        if let allLanes = step.intersections?.first?.approachLanes,
-            let usableLanes = step.intersections?.first?.usableApproachLanes,
-            durationRemaining < RouteControllerMediumAlertInterval {
-
-            for (i, lane) in allLanes.enumerated() {
-                let laneView = laneArrowView()
-                laneView.lane = lane
-                laneView.maneuverDirection = step.maneuverDirection
-                laneView.isValid = usableLanes.contains(i as Int)
-                stackView.addArrangedSubview(laneView)
-            }
+        let step = currentLegProgress.currentStep
+        let spokenInstructionIndex = currentLegProgress.currentStepProgress.spokenInstructionIndex
+        guard let visualInstructions = step.instructionsDisplayedAlongStep, spokenInstructionIndex < visualInstructions.count else {
+            hide()
+            return
         }
 
-        if stackView.arrangedSubviews.count > 0 {
-            show()
-        } else {
-            hide()
+        let currentInstruction = visualInstructions[spokenInstructionIndex]
+        guard let lanes: [LaneIndicationComponent] = currentInstruction.tertiaryInstruction?.components.compactMap({ component in
+                guard let lane = component as? LaneIndicationComponent else { return nil }
+                return lane
+            }), !lanes.isEmpty
+            else {
+                hide()
+                return
         }
+
+        let subviews = lanes.map { LaneView(component: $0, direction: step.maneuverDirection) }
+        stackView.addArrangedSubviews(subviews)
+        show()
     }
 
     public func show(animated: Bool = true) {

MapboxNavigation/NextBannerView.swift

@@ -60,7 +60,7 @@ open class NextBannerView: UIView {
         super.prepareForInterfaceBuilder()
         maneuverView.isEnd = true
         let component = VisualInstructionComponent(type: .text, text: "Next step", imageURL: nil, abbreviation: nil, abbreviationPriority: NSNotFound)
-        let instruction = VisualInstruction(text: nil, maneuverType: .none, maneuverDirection: .none, textComponents: [component])
+        let instruction = VisualInstruction(text: nil, maneuverType: .none, maneuverDirection: .none, components: [component])
         instructionLabel.instruction = instruction
     }
 

MapboxNavigationTests/Fixtures/route-for-lane-testing.json

@@ -1 +1 @@
-{"waypoints":[{"name":"16th Street Northwest","location":[-77.036548,38.901166]},{"name":"H Street Northwest","location":[-77.033792,38.900206]}],"routes":[{"legs":[{"steps":[{"intersections":[{"out":1,"in":0,"lanes":[{"valid":true,"indications":["right"]},{"valid":true,"indications":["right"]}],"entry":[false,true,false],"location":[-77.036554,38.900201],"bearings":[0,90,270]},{"out":1,"in":2,"entry":[true,true,false],"location":[-77.035129,38.900202],"bearings":[30,90,270]}],"geometry":{"coordinates":[[-77.036554,38.900201]],"type":"LineString"},"duration":41.3,"distance":239.1,"name":"H Street Northwest","weight":45.3,"mode":"driving","driving_side":"right","maneuver":{"bearing_after":88,"location":[-77.036554,38.900201],"type":"turn","bearing_before":180,"modifier":"left","instruction":"Turn left onto H Street Northwest"}},{"intersections":[{"out":1,"in":0,"lanes":[{"valid":true,"indications":["right"]},{"valid":true,"indications":["none"]}],"entry":[false,true,false],"location":[-77.036554,38.900201],"bearings":[0,90,270]},{"out":1,"in":2,"entry":[true,true,false],"location":[-77.035129,38.900202],"bearings":[30,90,270]}],"geometry":{"coordinates":[[-77.036554,38.900201]],"type":"LineString"},"duration":41.3,"distance":239.1,"name":"H Street Northwest","weight":45.3,"mode":"driving","driving_side":"right","maneuver":{"bearing_after":88,"location":[-77.036554,38.900201],"type":"turn","bearing_before":180,"modifier":"left","instruction":"Turn left onto H Street Northwest"}}],"weight":196.3,"distance":346.4,"summary":"16th Street Northwest, H Street Northwest","duration":177.5}],"weight_name":"routability","geometry":{"coordinates":[[-77.036548,38.901166],[-77.036551,38.900663],[-77.036554,38.900201],[-77.03643,38.900201],[-77.035534,38.900202],[-77.035388,38.900202],[-77.035276,38.900203],[-77.035204,38.900203],[-77.035129,38.900202],[-77.034948,38.900206],[-77.034433,38.900204],[-77.033792,38.900206]],"type":"LineString"},"weight":196.3,"distance":346.4,"duration":177.5}],"code":"Ok"}
+{"routes":[{"geometry":"k~ymFd~|bOIdBcD~AmRh@gBZmDtAeBPiE?","legs":[{"summary":"Marshall Avenue, Central Parkway","weight":89.5,"duration":63.4,"steps":[{"intersections":[{"out":0,"entry":[true],"bearings":[275],"location":[-84.531074,39.132063]}],"driving_side":"right","geometry":"k~ymFd~|bOARCp@C^","mode":"driving","maneuver":{"bearing_after":275,"bearing_before":0,"location":[-84.531074,39.132063],"type":"depart","instruction":"Head west on Marshall Avenue"},"weight":24.7,"duration":10.9,"name":"Marshall Avenue","distance":44.1,"bannerInstructions":[{"distanceAlongGeometry":44.1,"primary":{"text":"Central Parkway","components":[{"text":"Central Parkway","type":"text","abbr":"Central Pky","abbr_priority":0}],"type":"turn","modifier":"right"},"secondary":{"text":"US 127 / I-75 Alt North / US 27 / US 52","components":[{"text":"US 127","type":"icon","imageBaseURL":"https://s3.amazonaws.com/mapbox/shields/v3/us-127"},{"text":"/","type":"delimiter","delimiter":true},{"text":"I-75","type":"icon","imageBaseURL":"https://s3.amazonaws.com/mapbox/shields/v3/i-75"},{"text":"Alt","type":"text"},{"text":"North","type":"text","abbr":"N","abbr_priority":0},{"text":"/","type":"delimiter","delimiter":true},{"text":"US 27","type":"icon","imageBaseURL":"https://s3.amazonaws.com/mapbox/shields/v3/us-27"},{"text":"/","type":"delimiter","delimiter":true},{"text":"US 52","type":"icon","imageBaseURL":"https://s3.amazonaws.com/mapbox/shields/v3/us-52"}],"type":"turn","modifier":"right"},"sub":{"text":"","components":[{"text":"","type":"lane","active":false,"directions":["straight"]},{"text":"","type":"lane","active":true,"directions":["right"]}]}}]},{"intersections":[{"lanes":[{"valid":false,"indications":["straight"]},{"valid":true,"indications":["right"]}],"out":3,"in":0,"entry":[false,false,true,true],"bearings":[90,150,270,330],"location":[-84.531582,39.132105]},{"out":0,"in":2,"entry":[true,true,false],"bearings":[0,75,180],"location":[-84.532938,39.138135]}],"driving_side":"right","geometry":"u~ymFja}bOcAn@a@TOFKDMDSD[DuAH{NXaALe@L_@Po@^c@NSDe@L]DSBUB]Bg@@aDA","mode":"driving","maneuver":{"bearing_after":331,"bearing_before":275,"location":[-84.531582,39.132105],"modifier":"right","type":"turn","instruction":"Turn right onto Central Parkway (US 127)"},"ref":"US 127; I-75 Alt North; US 27; US 52","weight":64.8,"duration":52.5,"name":"Central Parkway (US 127; I-75 Alt North; US 27; US 52)","distance":780.5,"bannerInstructions":[{"distanceAlongGeometry":780.5,"primary":{"text":"You will arrive","components":[{"text":"You will arrive","type":"text"}],"type":"arrive","modifier":"straight"},"secondary":null,"sub":{"text":"","components":[{"text":"","type":"lane","active":true,"directions":["right"]},{"text":"","type":"lane","active":true,"directions":["right"]}]}},{"distanceAlongGeometry":148.7,"primary":{"text":"You have arrived","components":[{"text":"You have arrived","type":"text"}],"type":"arrive","modifier":"straight"},"secondary":null}]},{"intersections":[{"in":0,"entry":[true],"bearings":[180],"location":[-84.532934,39.138953]}],"driving_side":"right","geometry":"mi{mFxi}bO","mode":"driving","maneuver":{"bearing_after":0,"bearing_before":0,"location":[-84.532934,39.138953],"type":"arrive","instruction":"You have arrived at your destination"},"ref":"US 127; I-75 Alt North","weight":0,"duration":0,"name":"Central Parkway (US 127; I-75 Alt North)","distance":0,"bannerInstructions":[]}],"distance":824.6}],"weight_name":"routability","weight":89.5,"duration":63.4,"distance":824.6}],"waypoints":[{"name":"Marshall Avenue","location":[-84.531074,39.132063]},{"name":"Central Parkway","location":[-84.532934,39.138953]}],"code":"Ok"}

MapboxNavigationTests/InstructionPresenterTests.swift

@@ -9,7 +9,7 @@ class InstructionPresenterTests: XCTestCase {
 
         let exitAttribute = VisualInstructionComponent(type: .exit, text: "Exit", imageURL: nil, abbreviation: nil, abbreviationPriority: 0)
         let exitCodeAttribute = VisualInstructionComponent(type: .exitCode, text: "123A", imageURL: nil, abbreviation: nil, abbreviationPriority: 0)
-        let exitInstruction = VisualInstruction(text: nil, maneuverType: .takeOffRamp, maneuverDirection: .right, textComponents: [exitAttribute, exitCodeAttribute])
+        let exitInstruction = VisualInstruction(text: nil, maneuverType: .takeOffRamp, maneuverDirection: .right, components: [exitAttribute, exitCodeAttribute])
 
         let label = InstructionLabel(frame: CGRect(origin: .zero, size:CGSize(width: 50, height: 50)))
 

MapboxNavigationTests/InstructionsBannerViewIntegrationTests.swift

@@ -14,13 +14,13 @@ func makeVisualInstruction(_ maneuverType: ManeuverType = .arrive,
                            primaryInstruction: [VisualInstructionComponent],
                            secondaryInstruction: [VisualInstructionComponent]?) -> VisualInstructionBanner {
 
-    let primary = VisualInstruction(text: "Instruction", maneuverType: maneuverType, maneuverDirection: maneuverDirection, textComponents: primaryInstruction)
+    let primary = VisualInstruction(text: "Instruction", maneuverType: maneuverType, maneuverDirection: maneuverDirection, components: primaryInstruction)
     var secondary: VisualInstruction? = nil
     if let secondaryInstruction = secondaryInstruction {
-        secondary = VisualInstruction(text: "Instruction", maneuverType: maneuverType, maneuverDirection: maneuverDirection, textComponents: secondaryInstruction)
+        secondary = VisualInstruction(text: "Instruction", maneuverType: maneuverType, maneuverDirection: maneuverDirection, components: secondaryInstruction)
     }
 
-    return VisualInstructionBanner(distanceAlongStep: 482.803, primaryInstruction: primary, secondaryInstruction: secondary, drivingSide: .right)
+    return  VisualInstructionBanner(distanceAlongStep: 482.803, primaryInstruction: primary, secondaryInstruction: secondary, tertiaryInstruction: nil, drivingSide: .right)
 }
 
 class InstructionsBannerViewIntegrationTests: XCTestCase {
@@ -261,7 +261,7 @@ class InstructionsBannerViewIntegrationTests: XCTestCase {
         let exitAttribute = VisualInstructionComponent(type: .exit, text: "Exit", imageURL: nil,  abbreviation: nil, abbreviationPriority: 0)
         let exitCodeAttribute = VisualInstructionComponent(type: .exitCode, text: "123A", imageURL: nil, abbreviation: nil, abbreviationPriority: 0)
         let mainStreetString = VisualInstructionComponent(type: .text, text: "Main Street", imageURL: nil, abbreviation: "Main St", abbreviationPriority: 0)
-        let exitInstruction = VisualInstruction(text: nil, maneuverType: .takeOffRamp, maneuverDirection: .right, textComponents: [exitAttribute, exitCodeAttribute, mainStreetString])
+        let exitInstruction = VisualInstruction(text: nil, maneuverType: .takeOffRamp, maneuverDirection: .right, components: [exitAttribute, exitCodeAttribute, mainStreetString])
 
         let label = InstructionLabel(frame: CGRect(origin: .zero, size:CGSize(width: 375, height: 100)))
 

MapboxNavigationTests/InstructionsBannerViewSnapshotTests.swift

@@ -203,7 +203,7 @@ class InstructionsBannerViewSnapshotTests: FBSnapshotTestCase {
         let primaryThen = [
             VisualInstructionComponent(type: .image, text: "I 280", imageURL: ShieldImage.i280.url, abbreviation: nil, abbreviationPriority: 0)
         ]
-        let primaryThenInstruction = VisualInstruction(text: nil, maneuverType: .none, maneuverDirection: .none, textComponents: primaryThen)
+        let primaryThenInstruction = VisualInstruction(text: nil, maneuverType: .none, maneuverDirection: .none, components: primaryThen)
 
         nextBannerView.instructionLabel.instruction = primaryThenInstruction
         nextBannerView.maneuverView.backgroundColor = .clear

MapboxNavigationTests/LaneTests.swift

@@ -10,39 +10,42 @@ let directions = Directions(accessToken: bogusToken)
 
 class LaneTests: FBSnapshotTestCase {
 
-    let route = Fixture.route(from: "route-for-lane-testing", waypoints: [Waypoint(coordinate: CLLocationCoordinate2D(latitude: 37.795042, longitude: -122.413165)), Waypoint(coordinate: CLLocationCoordinate2D(latitude: 37.7727, longitude: -122.433378))])
+    let route = Fixture.route(from: "route-for-lane-testing", waypoints: [Waypoint(coordinate: CLLocationCoordinate2D(latitude: 39.132063, longitude: -84.531074)), Waypoint(coordinate: CLLocationCoordinate2D(latitude: 39.138953, longitude: -84.532934))])
 
     var steps: [RouteStep]!
     var routeProgress: RouteProgress!
+    var routeController: RouteController!
 
     override func setUp() {
         super.setUp()
         recordMode = false
         isDeviceAgnostic = true
 
         route.accessToken = bogusToken
-        let routeController = RouteController(along: route, directions: directions)
+        routeController = RouteController(along: route, directions: directions)
 
         steps = routeController.routeProgress.currentLeg.steps
         routeProgress = routeController.routeProgress
     }
 
-    func assertLanes(step: RouteStep) {
+    func assertLanes(stepIndex: Array<RouteStep>.Index) {
         let rect = CGRect(origin: .zero, size: .iPhone6Plus)
         let navigationView = NavigationView(frame: rect)
 
-        navigationView.lanesView.update(for: routeProgress.currentLegProgress)
+        routeController.advanceStepIndex(to: stepIndex)
+
+        navigationView.lanesView.update(for: routeController.routeProgress.currentLegProgress)
         navigationView.lanesView.show(animated: false)
 
         FBSnapshotVerifyView(navigationView.lanesView)
     }
 
-    func testRightRight() {
-        assertLanes(step: steps[0])
+    func testStraightRight() {
+        assertLanes(stepIndex: 0)
     }
 
-    func testRightNone() {
-        assertLanes(step: steps[1])
+    func testRightRight() {
+        assertLanes(stepIndex: 1)
     }
 
     func testSlightRight() {

MapboxNavigationTests/ManeuverViewTests.swift

@@ -22,8 +22,8 @@ class ManeuverViewTests: FBSnapshotTestCase {
 
     func maneuverInstruction(_ maneuverType: ManeuverType, _ maneuverDirection: ManeuverDirection, _ drivingSide: DrivingSide, _ degrees: CLLocationDegrees = 180) -> VisualInstructionBanner {
         let component = VisualInstructionComponent(type: .delimiter, text: "", imageURL: nil, abbreviation: nil, abbreviationPriority: 0)
-        let primary = VisualInstruction(text: "", maneuverType: maneuverType, maneuverDirection: maneuverDirection, textComponents: [component], degrees: degrees)
-        return VisualInstructionBanner(distanceAlongStep: 0, primaryInstruction: primary, secondaryInstruction: nil, drivingSide: drivingSide)
+        let primary = VisualInstruction(text: "", maneuverType: maneuverType, maneuverDirection: maneuverDirection, components: [component], degrees: degrees)
+        return VisualInstructionBanner(distanceAlongStep: 0, primaryInstruction: primary, secondaryInstruction: nil, tertiaryInstruction: nil, drivingSide: drivingSide)
     }
 
     func testStraightRoundabout() {