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

CHANGELOG.md

@@ -11,8 +11,7 @@
 * Fixed an issue when selecting a step from the steps list, you could be brought to the wrong step. [#1524](https://github.com/mapbox/mapbox-navigation-ios/pull/1524/)
 * `StyleManager.locationFor(styleManager:)` now allows for an optional CLLocation to be returned. [#1523](https://github.com/mapbox/mapbox-navigation-ios/pull/1523)
 * NavigationViewController now uses the recommended way `.preferredStatusBarStyle` to set the style of the status bar. [#1535](https://github.com/mapbox/mapbox-navigation-ios/pull/1535)
-* Deleted `InstructionsBannerView.update(_:)`, which previously updated the banner instruction and the current distance.
-* This is replaced with `InstructionsBannerView.updateDistance(for:)` and `InstructionsBannerView.updateInstruction(_:)`. `InstructionsBannerView.updateDistance(for:)` should be called on every location update, while `InstructionsBannerView.updateInstruction(_:)` should be called when `NSNotification.Name. routeControllerDidPassVisualInstructionPoint` is emitted.
+* Replaced `InstructionsBannerView.update(_:)`, which previously updated the banner instruction and the current distance, with `InstructionsBannerView.updateDistance(for:)` and `InstructionsBannerView.update(for:)`. Hence, `InstructionsBannerView.updateDistance(for:)` should be called on every location update, while `InstructionsBannerView.update(for:)` should be called when `NSNotification.Name.routeControllerDidPassVisualInstructionPoint` is emitted. [#1514](https://github.com/mapbox/mapbox-navigation-ios/pull/1514)
 
 ## v0.18.1 (June 19, 2018)
 

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" ~> 0.22.0
 github "mapbox/turf-swift" ~> 0.2
 github "mapbox/mapbox-events-ios" ~> 0.4
 github "ceeK/Solar" ~> 2.1.0

Cartfile.resolved

@@ -1,8 +1,8 @@
 binary "https://www.mapbox.com/ios-sdk/Mapbox-iOS-SDK.json" "4.1.1"
-github "Quick/Nimble" "v7.1.2"
+github "Quick/Nimble" "v7.1.3"
 github "Quick/Quick" "v1.3.0"
 github "ceeK/Solar" "2.1.0"
-github "mapbox/MapboxDirections.swift" "v0.21.0"
+github "mapbox/MapboxDirections.swift" "v0.22.0"
 github "mapbox/mapbox-events-ios" "v0.4.2"
 github "mapbox/mapbox-voice-swift" "v0.0.1"
 github "mapbox/turf-swift" "v0.2.0"

Examples/Swift/CustomViewController.swift

@@ -90,7 +90,7 @@ class CustomViewController: UIViewController, MGLMapViewDelegate {
 
     @objc func updateInstructionsBanner(notification: NSNotification) {
         guard let routeProgress = notification.userInfo?[RouteControllerNotificationUserInfoKey.routeProgressKey] as? RouteProgress else { return }
-        instructionsBannerView.updateInstruction(routeProgress.currentLegProgress.currentStepProgress.currentVisualInstruction)
+        instructionsBannerView.update(for: routeProgress.currentLegProgress.currentStepProgress.currentVisualInstruction)
     }
 
     // Fired when the user is no longer on the route.

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", "~> 0.22.0"
   s.dependency "MapboxMobileEvents", "~> 0.4"
   s.dependency "Turf", "~> 0.2"
 

MapboxCoreNavigationTests/MapboxCoreNavigationTests.swift

@@ -8,7 +8,7 @@ let jsonRoute = (response["routes"] as! [AnyObject]).first as! [String : Any]
 let waypoint1 = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 37.795042, longitude: -122.413165))
 let waypoint2 = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 37.7727, longitude: -122.433378))
 let directions = Directions(accessToken: "pk.feedCafeDeadBeefBadeBede")
-let route = Route(json: jsonRoute, waypoints: [waypoint1, waypoint2], routeOptions: NavigationRouteOptions(waypoints: [waypoint1, waypoint2]))
+let route = Route(json: jsonRoute, waypoints: [waypoint1, waypoint2], options: NavigationRouteOptions(waypoints: [waypoint1, waypoint2]))
 
 let waitForInterval: TimeInterval = 5
 
@@ -108,7 +108,7 @@ class MapboxCoreNavigationTests: XCTestCase {
 
     func testArrive() {
         route.accessToken = "foo"
-        let locations: [CLLocation] = route.coordinates!.map { CLLocation(latitude: $0.latitude, longitude: $0.longitude) }
+        let locations: [CLLocation] = route.legs.first!.steps.first!.coordinates!.map { CLLocation(latitude: $0.latitude, longitude: $0.longitude) }
         let locationManager = ReplayLocationManager(locations: locations)
         locationManager.speedMultiplier = 20
 

MapboxCoreNavigationTests/RouteControllerTests.swift

@@ -43,15 +43,15 @@ class RouteControllerTests: XCTestCase {
     lazy var initialRoute: Route = {
         let waypoint1 = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 37.795042, longitude: -122.413165))
         let waypoint2 = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 37.7727, longitude: -122.433378))
-        let route = Route(json: Constants.jsonRoute, waypoints: [waypoint1, waypoint2], routeOptions: NavigationRouteOptions(waypoints: [waypoint1, waypoint2]))
+        let route = Route(json: Constants.jsonRoute, waypoints: [waypoint1, waypoint2], options: NavigationRouteOptions(waypoints: [waypoint1, waypoint2]))
         route.accessToken = Constants.accessToken
         return route
     }()
 
     lazy var alternateRoute: Route = {
         let waypoint1 = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 38.893922, longitude: -77.023900))
         let waypoint2 = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 38.880727, longitude: -77.024888))
-        let route = Route(json: Constants.jsonRoute, waypoints: [waypoint1, waypoint2], routeOptions: NavigationRouteOptions(waypoints: [waypoint1, waypoint2]))
+        let route = Route(json: Constants.jsonRoute, waypoints: [waypoint1, waypoint2], options: NavigationRouteOptions(waypoints: [waypoint1, waypoint2]))
         route.accessToken = Constants.accessToken
         return route
     }()
@@ -162,7 +162,7 @@ class RouteControllerTests: XCTestCase {
         let waypoint1 = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 37.795042, longitude: -122.413165))
         let waypoint2 = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 37.7727, longitude: -122.433378))
         let directions = Directions(accessToken: "pk.feedCafeDeadBeefBadeBede")
-        let route = Route(json: jsonRoute, waypoints: [waypoint1, waypoint2], routeOptions: NavigationRouteOptions(waypoints: [waypoint1, waypoint2]))
+        let route = Route(json: jsonRoute, waypoints: [waypoint1, waypoint2], options: NavigationRouteOptions(waypoints: [waypoint1, waypoint2]))
 
         route.accessToken = "foo"
         let navigation = RouteController(along: route, directions: directions)

MapboxCoreNavigationTests/TunnelIntersectionManagerTests.swift

@@ -14,7 +14,7 @@ let tunnelResponse = Fixture.JSONFromFileNamed(name: TunnelDetectorTestData.nint
 let tunnelJsonRoute = (tunnelResponse[TunnelDetectorTestData.kRouteKey] as! [AnyObject]).first as! [String: Any]
 let tunnelWayPoint1 = Waypoint(coordinate: TunnelDetectorTestData.startLocation)
 let tunnelWaypoint2 = Waypoint(coordinate: TunnelDetectorTestData.endLocation)
-let tunnelRoute = Route(json: tunnelJsonRoute, waypoints: [tunnelWayPoint1, tunnelWaypoint2], routeOptions: NavigationRouteOptions(waypoints: [tunnelWayPoint1, tunnelWaypoint2]))
+let tunnelRoute = Route(json: tunnelJsonRoute, waypoints: [tunnelWayPoint1, tunnelWaypoint2], options: NavigationRouteOptions(waypoints: [tunnelWayPoint1, tunnelWaypoint2]))
 
 class TunnelIntersectionManagerTests: XCTestCase {
 

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", "~> 0.22.0"
   s.dependency "Mapbox-iOS-SDK", "~> 4.1"
   s.dependency "MapboxMobileEvents", "~> 0.4"
   s.dependency "Solar", "~> 2.1"

MapboxNavigation.xcodeproj/project.pbxproj

@@ -196,6 +196,7 @@
 		8DF399B21FB257B30034904C /* UIGestureRecognizer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8DF399B11FB257B30034904C /* UIGestureRecognizer.swift */; };
 		AE00A73A209A2C38006A3DC7 /* StepsViewControllerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = AE00A739209A2C38006A3DC7 /* StepsViewControllerTests.swift */; };
 		AE291FFF20975A7E00F23DFC /* NavigationViewControllerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = AED2156E208F7FEA009AA673 /* NavigationViewControllerTests.swift */; };
+		AE46F95520EA735B00537AC2 /* VisualInstruction.swift in Sources */ = {isa = PBXBuildFile; fileRef = AE46F95420EA735B00537AC2 /* VisualInstruction.swift */; };
 		AE5F8771209A082500F58FDB /* route-with-banner-instructions.json in Resources */ = {isa = PBXBuildFile; fileRef = AE5F8770209A082500F58FDB /* route-with-banner-instructions.json */; };
 		AE8B1B95207BFAEF003050F6 /* TunnelIntersectionManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = AE09EC13207BD88200782A33 /* TunnelIntersectionManager.swift */; };
 		AE8B1B97207D2B2B003050F6 /* TunnelIntersectionManagerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = AE8B1B96207D2B2B003050F6 /* TunnelIntersectionManagerTests.swift */; };
@@ -605,6 +606,7 @@
 		8DF399B11FB257B30034904C /* UIGestureRecognizer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UIGestureRecognizer.swift; sourceTree = "<group>"; };
 		AE00A739209A2C38006A3DC7 /* StepsViewControllerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StepsViewControllerTests.swift; sourceTree = "<group>"; };
 		AE09EC13207BD88200782A33 /* TunnelIntersectionManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TunnelIntersectionManager.swift; sourceTree = "<group>"; };
+		AE46F95420EA735B00537AC2 /* VisualInstruction.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VisualInstruction.swift; sourceTree = "<group>"; };
 		AE5F8770209A082500F58FDB /* route-with-banner-instructions.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "route-with-banner-instructions.json"; sourceTree = "<group>"; };
 		AE8B1B96207D2B2B003050F6 /* TunnelIntersectionManagerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TunnelIntersectionManagerTests.swift; sourceTree = "<group>"; };
 		AED2156E208F7FEA009AA673 /* NavigationViewControllerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NavigationViewControllerTests.swift; sourceTree = "<group>"; };
@@ -1134,6 +1136,7 @@
 				351BEBF01E5BCC63006FE110 /* UIView.swift */,
 				3512C7C71FB0A0C100CDD2A3 /* UIViewController.swift */,
 				C5A7EC5B1FD610A80008B9BA /* VisualInstructionComponent.swift */,
+				AE46F95420EA735B00537AC2 /* VisualInstruction.swift */,
 				8D391CE11FD71E78006BB91F /* Waypoint.swift */,
 				35ECAF2C2092275100DC3BC3 /* UIImage.swift */,
 				353E3C8E20A3501C00FD1789 /* MGLStyle.swift */,
@@ -1849,6 +1852,7 @@
 				3531C2701F9E095400D92F9A /* InstructionsBannerView.swift in Sources */,
 				C5F2DCA1206DBF5E002F99F6 /* Sequence.swift in Sources */,
 				35DA85791FC45787004092EC /* StatusView.swift in Sources */,
+				AE46F95520EA735B00537AC2 /* VisualInstruction.swift in Sources */,
 				35025F3F1F051DD2002BA3EA /* DialogViewController.swift in Sources */,
 				359A8AEF1FA7B25B00BDB486 /* LanesStyleKit.swift in Sources */,
 				355ED3701FAB724F00BCE1B8 /* BottomBannerViewLayout.swift in Sources */,

MapboxNavigation/ExitView.swift

@@ -141,4 +141,13 @@ class ExitView: StylableView {
         let labelTrailing = trailingAnchor.constraint(equalTo: exitNumberLabel.trailingAnchor, constant: 8)
         return [imageLeading, imageLabelSpacing, labelTrailing]
     }
+
+    /**
+     This generates the cache key needed to hold the `ExitView`'s `imageRepresentation` in the `ImageCache` caching engine.
+     */
+    static func criticalHash(side: ExitSide, dataSource: DataSource) -> String {
+        let proxy = ExitView.appearance()
+        let criticalProperties: [AnyHashable?] = [side, dataSource.font.pointSize, proxy.backgroundColor, proxy.foregroundColor, proxy.borderWidth, proxy.cornerRadius]
+        return String(describing: criticalProperties.reduce(0, { $0 ^ ($1?.hashValue ?? 0)}))
+    }
 }

MapboxNavigation/GenericRouteShield.swift

@@ -90,4 +90,13 @@ public class GenericRouteShield: StylableView {
 
         addConstraints(constraints)
     }
+
+    /**
+     This generates the cache key needed to hold the `GenericRouteShield`'s `imageRepresentation` in the `ImageCache` caching engine.
+     */
+    static func criticalHash(dataSource: DataSource) -> String {
+        let proxy = GenericRouteShield.appearance()
+        let criticalProperties: [AnyHashable?] = [dataSource.font.pointSize, proxy.backgroundColor, proxy.foregroundColor, proxy.borderWidth, proxy.cornerRadius]
+        return String(describing: criticalProperties.reduce(0, { $0 ^ ($1?.hashValue ?? 0)}))
+    }
 }

MapboxNavigation/InstructionPresenter.swift

@@ -8,8 +8,9 @@ protocol InstructionPresenterDataSource: class {
     var shieldHeight: CGFloat { get }
 }
 
+typealias DataSource = InstructionPresenterDataSource
+
 class InstructionPresenter {
-    typealias DataSource = InstructionPresenterDataSource
 
     private let instruction: VisualInstruction
     private weak var dataSource: DataSource?
@@ -66,7 +67,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] = []
 
@@ -134,7 +135,7 @@ class InstructionPresenter {
 
     func attributedString(forGenericShield component: VisualInstructionComponent, dataSource: DataSource) -> NSAttributedString? {
         guard component.type == .image, let text = component.text else { return nil }
-        return genericShield(text: text, cacheKey: component.genericCacheKey, dataSource: dataSource)
+        return genericShield(text: text, component: component, dataSource: dataSource)
     }
 
     func attributedString(forShieldComponent shield: VisualInstructionComponent, repository:ImageRepository, dataSource: DataSource, onImageDownload: @escaping ImageDownloadCompletion) -> NSAttributedString? {
@@ -166,7 +167,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
             }
@@ -189,11 +193,10 @@ class InstructionPresenter {
         return NSAttributedString(attachment: attachment)
     }
 
-    private func genericShield(text: String, cacheKey: String, dataSource: DataSource) -> NSAttributedString? {
-        let proxy = GenericRouteShield.appearance()
-        let criticalProperties: [AnyHashable?] = [dataSource.font.pointSize, proxy.backgroundColor, proxy.foregroundColor, proxy.borderWidth, proxy.cornerRadius]
-        let additionalKey = String(describing: criticalProperties.reduce(0, { $0 ^ ($1?.hashValue ?? 0)}))
+    private func genericShield(text: String, component: VisualInstructionComponent, dataSource: DataSource) -> NSAttributedString? {
+        guard let cacheKey = component.cacheKey else { return nil }
 
+        let additionalKey = GenericRouteShield.criticalHash(dataSource: dataSource)
         let attachment = GenericShieldAttachment()
 
         let key = [cacheKey, additionalKey].joined(separator: "-")
@@ -212,19 +215,18 @@ class InstructionPresenter {
     }
 
     private func exitShield(side: ExitSide = .right, text: String, component: VisualInstructionComponent, dataSource: DataSource) -> NSAttributedString? {
+        guard let cacheKey = component.cacheKey else { return nil }
 
-        let proxy = ExitView.appearance()
-        let criticalProperties: [AnyHashable?] = [side, dataSource.font.pointSize, proxy.backgroundColor, proxy.foregroundColor, proxy.borderWidth, proxy.cornerRadius]
-        let additionalKey = String(describing: criticalProperties.reduce(0, { $0 ^ ($1?.hashValue ?? 0)}))
+        let additionalKey = ExitView.criticalHash(side: side, dataSource: dataSource)
         let attachment = ExitAttachment()
-        guard let cacheKey = component.cacheKey else { return nil }
 
-        if let image = imageRepository.cachedImageForKey(cacheKey) {
+        let key = [cacheKey, additionalKey].joined(separator: "-")
+        if let image = imageRepository.cachedImageForKey(key) {
             attachment.image = image
         } else {
             let view = ExitView(pointSize: dataSource.font.pointSize, side: side, text: text)
             guard let image = takeSnapshot(on: view) else { return nil }
-            imageRepository.storeImage(image, forKey: [cacheKey, additionalKey].joined(separator: "-"), toDisk: false)
+            imageRepository.storeImage(image, forKey: key, toDisk: false)
             attachment.image = image
         }
 

MapboxNavigation/InstructionsBannerView.swift

@@ -93,7 +93,8 @@ open class BaseInstructionsBannerView: UIControl {
     /**
      Updates the instructions banner info with a given `VisualInstructionBanner`.
      */
-    public func updateInstruction(_ instruction: VisualInstructionBanner?) {
+    @objc(updateForVisualInstructionBanner:)
+    public func update(for instruction: VisualInstructionBanner?) {
         let secondaryInstruction = instruction?.secondaryInstruction
         primaryLabel.numberOfLines = secondaryInstruction == nil ? 2 : 1
 
@@ -104,15 +105,16 @@ open class BaseInstructionsBannerView: UIControl {
         }
 
         primaryLabel.instruction = instruction?.primaryInstruction
+        maneuverView.visualInstruction = instruction?.primaryInstruction
+        maneuverView.drivingSide = instruction?.drivingSide ?? .right
         secondaryLabel.instruction = secondaryInstruction
-        maneuverView.visualInstruction = instruction
     }
 
     override open func prepareForInterfaceBuilder() {
         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) {
+        self.init(frame: LaneView.defaultFrame)
+        backgroundColor = .clear
+        lane = Lane(indications: component.indications)
+        maneuverDirection = ManeuverDirection(description: component.indications.description)
+        isValid = component.isUsable
+    }
+
     override open func draw(_ rect: CGRect) {
         super.draw(rect)
         if let lane = lane {