Allow the use of multiple status banners

CHANGELOG.md

@@ -3,12 +3,13 @@
 ## v1.3.0
 
 * MapboxCoreNavigation can now be installed using Swift Package Manager. ([#2771](https://github.com/mapbox/mapbox-navigation-ios/pull/2771))
-* The CarPlay guidance panel now shows lane guidance. ([#2798](https://github.com/mapbox/mapbox-navigation-ios/pull/2798))
+* The CarPlay guidance panel now shows lane guidance. ([#1885](https://github.com/mapbox/mapbox-navigation-ios/pull/1885))
 * Old versions of routing tiles are automatically deleted from the cache to save storage space. ([#2807](https://github.com/mapbox/mapbox-navigation-ios/pull/2807))
 * Fixed an issue where lane guidance icons would indicate the wrong arrow for certain maneuvers. ([#2796](https://github.com/mapbox/mapbox-navigation-ios/pull/2796), [#2809](https://github.com/mapbox/mapbox-navigation-ios/pull/2809))
 * Fixed a crash showing a junction view. ([#2805](https://github.com/mapbox/mapbox-navigation-ios/pull/2805))
 * Fixed an issue with CarPlay visual instructions where U-Turn maneuver icons were not being flipped properly based on regional driving side ([#2803](https://github.com/mapbox/mapbox-navigation-ios/pull/2803)) 
 * Fixed swiping for right-to-left languages for the Guidance Card UI to be more intuitive. ([#2724](https://github.com/mapbox/mapbox-navigation-ios/pull/2724))
+* `NavigationViewController` can now manage multiple status banners one after another. Renamed the `NavigationViewController.showStatus(title:spinner:duration:animated:interactive:)` method to `NavigationViewController.show(_:)` and added a corresponding `NavigationViewController.hide(_:)` method. Renamed the `NavigationStatusPresenter.showStatus(title:spinner:duration:animated:interactive:)` method to `NavigationStatusPresenter.show(_:)` and added a `NavigationStatusPresenter.hide(_:)` method. ([#2747](https://github.com/mapbox/mapbox-navigation-ios/pull/2747))
 
 ## v1.2.1
 

MapboxNavigation.xcodeproj/project.pbxproj

@@ -302,6 +302,7 @@
 		B430D2FA25534FDC0088CC23 /* UserHaloCourseView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B430D2F925534FDC0088CC23 /* UserHaloCourseView.swift */; };
 		B48CEFC125796FD300696BB3 /* route-for-vanishing-route-line.json in Resources */ = {isa = PBXBuildFile; fileRef = B48CEFAB25796F5A00696BB3 /* route-for-vanishing-route-line.json */; };
 		B4F7631C2578751300177B33 /* VanishingRouteLine.swift in Sources */ = {isa = PBXBuildFile; fileRef = B4F7631B2578751300177B33 /* VanishingRouteLine.swift */; };
+		C3D225512587F411007DBCDF /* StatusViewTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = C3D225502587F411007DBCDF /* StatusViewTests.swift */; };
 		C51511D120EAC89D00372A91 /* CPMapTemplate.swift in Sources */ = {isa = PBXBuildFile; fileRef = C51511D020EAC89D00372A91 /* CPMapTemplate.swift */; };
 		C51DF8661F38C31C006C6A15 /* Locale.swift in Sources */ = {isa = PBXBuildFile; fileRef = C51DF8651F38C31C006C6A15 /* Locale.swift */; };
 		C51FC31720F689F800400CE7 /* CustomStyles.swift in Sources */ = {isa = PBXBuildFile; fileRef = C51FC31620F689F800400CE7 /* CustomStyles.swift */; };
@@ -884,9 +885,10 @@
 		AED2156E208F7FEA009AA673 /* NavigationViewControllerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NavigationViewControllerTests.swift; sourceTree = "<group>"; };
 		AED6285522CBE4CE00058A51 /* ViewController+GuidanceCards.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = "ViewController+GuidanceCards.swift"; path = "Example/ViewController+GuidanceCards.swift"; sourceTree = "<group>"; };
 		AEF2C8F12072B603007B061F /* routeWithTunnels_9thStreetDC.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = routeWithTunnels_9thStreetDC.json; sourceTree = "<group>"; };
-		B430D2F925534FDC0088CC23 /* UserHaloCourseView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UserHaloCourseView.swift; sourceTree = "<group>"; };
+        B430D2F925534FDC0088CC23 /* UserHaloCourseView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UserHaloCourseView.swift; sourceTree = "<group>"; };
 		B48CEFAB25796F5A00696BB3 /* route-for-vanishing-route-line.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "route-for-vanishing-route-line.json"; sourceTree = "<group>"; };
 		B4F7631B2578751300177B33 /* VanishingRouteLine.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = VanishingRouteLine.swift; sourceTree = "<group>"; };
+		C3D225502587F411007DBCDF /* StatusViewTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StatusViewTests.swift; sourceTree = "<group>"; };
 		C51511D020EAC89D00372A91 /* CPMapTemplate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CPMapTemplate.swift; sourceTree = "<group>"; };
 		C51DF8651F38C31C006C6A15 /* Locale.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Locale.swift; sourceTree = "<group>"; };
 		C51FC31620F689F800400CE7 /* CustomStyles.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = CustomStyles.swift; path = Example/CustomStyles.swift; sourceTree = "<group>"; };
@@ -1369,6 +1371,7 @@
 		35B711D01E5E7AD2001EDA8D /* MapboxNavigationTests */ = {
 			isa = PBXGroup;
 			children = (
+				C3D225502587F411007DBCDF /* StatusViewTests.swift */,
 				16E11B53212B3D4700027CD3 /* Extensions and Categories */,
 				355DB5731EFA73410091BFB7 /* Fixtures */,
 				3527D2B61EC45FBD00C07FC9 /* Fixtures.xcassets */,
@@ -2677,6 +2680,7 @@
 				8D9CD7FF20880581004DC4B3 /* XCTestCase.swift in Sources */,
 				35DC585D1FABC61100B5A956 /* InstructionsBannerViewIntegrationTests.swift in Sources */,
 				3502231A205BC94E00E1449A /* Constants.swift in Sources */,
+				C3D225512587F411007DBCDF /* StatusViewTests.swift in Sources */,
 				DA0557252155040700A1F2AA /* RouteTests.swift in Sources */,
 				C55C299920D2E2F600B0406C /* NavigationMapViewTests.swift in Sources */,
 				4341758423061666004264A9 /* SnapshotTest+Mapbox.swift in Sources */,

Sources/MapboxNavigation/NavigationComponent.swift

@@ -36,8 +36,20 @@ public protocol CarPlayConnectionObserver: class {
  This protocol defines a UI Component that is capable of presenting a status message.
  */
 public protocol NavigationStatusPresenter: class {
+    /**
+     Shows a Status for a specified amount of time.
+     */
+    func show(_: StatusView.Status)
+
+    /**
+     Hides a given Status without hiding the status view.
+     */
+    func hide(_: StatusView.Status)
+
     /**
      Shows the status view for a specified amount of time.
+     `showStatus()` uses a default value for priority and the title input as identifier. To use these variables, use `show(_:)`
      */
-    func showStatus(title: String, spinner: Bool, duration: TimeInterval, animated: Bool, interactive: Bool)
+    @available(*, deprecated, message: "Add a status using show(_:) instead")
+    func showStatus(title: String, spinner spin: Bool, duration: TimeInterval, animated: Bool, interactive: Bool)
 }

Sources/MapboxNavigation/NavigationViewController.swift

@@ -33,6 +33,7 @@ public enum MapOrnamentPosition {
  `CarPlayNavigationViewController` manages the corresponding user interface on a CarPlay screen.
  */
 open class NavigationViewController: UIViewController, NavigationStatusPresenter {
+
     /**
      A `Route` object constructed by [MapboxDirections](https://docs.mapbox.com/ios/api/directions/) along with its index in a `RouteResponse`.
 
@@ -51,6 +52,8 @@ open class NavigationViewController: UIViewController, NavigationStatusPresenter
         }
     }
 
+    var didChangeAuthorizationIsFirstCalled = true
+
     /**
      A `Route` object constructed by [MapboxDirections](https://docs.mapbox.com/ios/api/directions/).
      */
@@ -401,7 +404,10 @@ open class NavigationViewController: UIViewController, NavigationStatusPresenter
         guard AVAudioSession.sharedInstance().outputVolume <= NavigationViewMinimumVolumeForWarning else { return }
 
         let title = NSLocalizedString("INAUDIBLE_INSTRUCTIONS_CTA", bundle: .mapboxNavigation, value: "Adjust Volume to Hear Instructions", comment: "Label indicating the device volume is too low to hear spoken instructions and needs to be manually increased")
-        showStatus(title: title, spinner: false, duration: 3, animated: true, interactive: false)
+
+        // create low volume notification status and append to array of statuses
+        let lowVolumeStatus = StatusView.Status(identifier: "INAUDIBLE_INSTRUCTIONS_CTA", title: title, duration: 3, animated: true, priority: StatusView.Priority(rawValue: 3))
+        show(lowVolumeStatus)
     }
 
 
@@ -462,9 +468,28 @@ open class NavigationViewController: UIViewController, NavigationStatusPresenter
         UNUserNotificationCenter.current().add(notificationRequest, withCompletionHandler: nil)
     }
 
-    public func showStatus(title: String, spinner: Bool, duration: TimeInterval, animated: Bool, interactive: Bool) {
+    /**
+     Shows a Status for a specified amount of time.
+     */
+    public func show(_ status: StatusView.Status) {
+        navigationComponents.compactMap({ $0 as? NavigationStatusPresenter }).forEach {
+            $0.show(status)
+        }
+    }
+
+    /**
+     Hides a given Status without hiding the status view.
+     */
+    public func hide(_ status: StatusView.Status) {
         navigationComponents.compactMap({ $0 as? NavigationStatusPresenter }).forEach {
-            $0.showStatus(title: title, spinner: spinner, duration: duration, animated: animated, interactive: interactive)
+            $0.hide(status)
+        }
+    }
+
+    @available(*, deprecated, message: "Add a status using show(_:) instead")
+    public func showStatus(title: String, spinner spin: Bool, duration: TimeInterval, animated: Bool, interactive: Bool) {
+        navigationComponents.compactMap({ $0 as? NavigationStatusPresenter }).forEach {
+            $0.showStatus(title: title, spinner: spin, duration: duration, animated: animated, interactive: interactive)
         }
     }
 }
@@ -724,21 +749,29 @@ extension NavigationViewController: NavigationServiceDelegate {
     public func navigationServiceShouldDisableBatteryMonitoring(_ service: NavigationService) -> Bool {
         return navigationComponents.allSatisfy { $0.navigationServiceShouldDisableBatteryMonitoring(service) }
     }
-
+        
     public func navigationServiceDidChangeAuthorization(_ service: NavigationService, didChangeAuthorizationFor locationManager: CLLocationManager) {
         // CLLocationManager.accuracyAuthorization was introduced in the iOS 14 SDK in Xcode 12, so Xcode 11 doesn’t recognize it.
         guard let accuracyAuthorizationValue = locationManager.value(forKey: "accuracyAuthorization") as? Int else { return }
         let accuracyAuthorization = MBNavigationAccuracyAuthorization(rawValue: accuracyAuthorizationValue)
+        let previousAuthorizationValue = 1 - accuracyAuthorizationValue
+
+        // create authorization status
+        let title = NSLocalizedString("ENABLE_PRECISE_LOCATION", bundle: .mapboxNavigation, value: "Enable precise location to navigate", comment: "Label indicating precise location is off and needs to be turned on to navigate")
+        let authorizationStatus = StatusView.Status(identifier: "ENABLE_PRECISE_LOCATION", title: title, duration: .infinity, priority: StatusView.Priority(rawValue: 1))
 
         if #available(iOS 14.0, *), accuracyAuthorization == .reducedAccuracy {
-            let title = NSLocalizedString("ENABLE_PRECISE_LOCATION", bundle: .mapboxNavigation, value: "Enable precise location to navigate", comment: "Label indicating precise location is off and needs to be turned on to navigate")
-            showStatus(title: title, spinner: false, duration: 20, animated: true, interactive: false)
+            show(authorizationStatus)
             mapView?.reducedAccuracyActivatedMode = true
+        } else if #available(iOS 14.0, *), previousAuthorizationValue == 1, didChangeAuthorizationIsFirstCalled == false {
+            hide(authorizationStatus)
+            mapView?.reducedAccuracyActivatedMode = false
         } else {
             //Fallback on earlier versions
             mapView?.reducedAccuracyActivatedMode = false
             return
         }
+        didChangeAuthorizationIsFirstCalled = false
     }
 
     // MARK: - Building Extrusion Highlighting

Sources/MapboxNavigation/StatusView.swift

@@ -46,6 +46,39 @@ public class StatusView: UIControl {
         }
     }
 
+    var statuses: [Status] = []
+
+    /**
+    `Status` is a struct which stores information to be displayed by the `StatusView`
+     */
+    public struct Status {
+        public var identifier: String
+        let title: String
+        var spinner: Bool = false
+        let duration: TimeInterval
+        var animated: Bool = true
+        var interactive: Bool = false
+        var priority: Priority
+    }
+
+    /**
+     `Priority` is used to display `Status`es by importance
+     */
+    public struct Priority: RawRepresentable {
+        public typealias RawValue = Int
+
+        public var rawValue: Int
+
+        public init(rawValue: Int) {
+            self.rawValue = rawValue
+        }
+//        — Highest Priority —
+//            rerouting (rawValue = 0)
+//            enable precise location (rawValue = 1)
+//            simulation banner (rawValue = 2)
+//        — Lowest Priority —
+    }
+
     public override init(frame: CGRect) {
         super.init(frame: frame)
         commonInit()
@@ -84,6 +117,7 @@ public class StatusView: UIControl {
 
         let tapRecognizer = UITapGestureRecognizer(target: self, action: #selector(StatusView.tap(_:)))
         addGestureRecognizer(tapRecognizer)
+
     }
 
     @objc func pan(_ sender: UIPanGestureRecognizer) {
@@ -117,62 +151,111 @@ public class StatusView: UIControl {
         }
     }
 
+    /**
+     Shows the status view for a specified amount of time.
+     `showStatus()` uses a default value for priority and the title input as identifier. To use these variables, use `show(_:)`
+     */
+    @available(*, deprecated, message: "Add a status using show(_:) instead")
     public func showStatus(title: String, spinner spin: Bool = false, duration: TimeInterval, animated: Bool = true, interactive: Bool = false) {
-        show(title, showSpinner: spin, interactive: interactive)
-        guard duration < .infinity else { return }
-        hide(delay: duration, animated: animated)
+        let status = Status(identifier: title, title: title, spinner: spin, duration: duration, animated: animated, interactive: interactive, priority: StatusView.Priority(rawValue: 1))
+        show(status)
+    }
+
+    /**
+     Adds a new status to statuses array.
+     */
+    func show(_ status: Status) {
+        if let row = statuses.firstIndex(where: {$0.identifier.contains(status.identifier)}) {
+            statuses[row] = status
+        } else {
+            statuses.append(status)
+        }
+        manageStatuses()
+    }
+
+    /**
+     Manages showing and hiding Statuses and the status view itself.
+     */
+    func manageStatuses(status: Status? = nil) {
+        if statuses.isEmpty {
+            hide(delay: status?.duration ?? 0, animated: status?.animated ?? true)
+        } else {
+            // if we hide a Status and there are Statuses left in the statuses array, show the Status with highest priority
+            guard let highestPriorityStatus = statuses.min(by: {$0.priority.rawValue < $1.priority.rawValue}) else { return }
+            show(status: highestPriorityStatus)
+            hide(with: highestPriorityStatus, delay: highestPriorityStatus.duration)
+        }
+    }
+
+    /**
+     Hides a given Status without hiding the status view.
+     */
+    func hide(_ status: Status?) {
+        guard let identifier = status?.identifier else { return }
+        guard let row = statuses.firstIndex(where: {$0.identifier.contains(identifier)}) else { return }
+        let removedStatus = statuses.remove(at: row)
+        manageStatuses(status: removedStatus)
     }
 
     func showSimulationStatus(speed: Int) {
         let format = NSLocalizedString("USER_IN_SIMULATION_MODE", bundle: .mapboxNavigation, value: "Simulating Navigation at %@×", comment: "The text of a banner that appears during turn-by-turn navigation when route simulation is enabled.")
         let title = String.localizedStringWithFormat(format, NumberFormatter.localizedString(from: speed as NSNumber, number: .decimal))
-        showStatus(title: title, duration: .infinity, interactive: true)
+        let simulationStatus = Status(identifier: "USER_IN_SIMULATION_MODE", title: title, duration: .infinity, interactive: true, priority: StatusView.Priority(rawValue: 2))
+        show(simulationStatus)
     }
 
     /**
      Shows the status view with an optional spinner.
      */
-    public func show(_ title: String, showSpinner: Bool, interactive: Bool = false) {
-        isEnabled = interactive
-        textLabel.text = title
+    public func show(status: Status) {
+        isEnabled = status.interactive
+        textLabel.text = status.title
         activityIndicatorView.hidesWhenStopped = true
-        if (!showSpinner) { activityIndicatorView.stopAnimating() }
+        if (!status.spinner) { activityIndicatorView.stopAnimating() }
 
         guard !isCurrentlyVisible, isHidden else { return }
 
         let show = {
             self.isHidden = false
             self.textLabel.alpha = 1
-            if (showSpinner) { self.activityIndicatorView.isHidden = false }
+            if (status.spinner) { self.activityIndicatorView.isHidden = false }
             self.superview?.layoutIfNeeded()
         }
 
         UIView.defaultAnimation(0.3, animations:show, completion:{ _ in
             self.isCurrentlyVisible = true
-            guard showSpinner else { return }
+            guard status.spinner else { return }
             self.activityIndicatorView.startAnimating()
         })
     }
 
     /**
      Hides the status view.
      */
-    public func hide(delay: TimeInterval = 0, animated: Bool = true) {
+    public func hide(with status: Status? = nil, delay: TimeInterval = 0, animated: Bool = true) {
         let hide = {
-            self.isHidden = true
-            self.textLabel.alpha = 0
-            self.activityIndicatorView.isHidden = true
+            if status == nil {
+                self.isHidden = true
+                self.textLabel.alpha = 0
+                self.activityIndicatorView.isHidden = true
+            } else {
+                self.hide(status)
+            }
         }
 
         let animate = {
             let fireTime = DispatchTime.now() + delay
             DispatchQueue.main.asyncAfter(deadline: fireTime, execute: {
-                guard !self.isHidden, self.isCurrentlyVisible else { return }
-
-                self.activityIndicatorView.stopAnimating()
-                UIView.defaultAnimation(0.3, delay: 0, animations: hide, completion: { _ in
-                    self.isCurrentlyVisible = false
-                })
+                if status == nil {
+                    guard !self.isHidden, self.isCurrentlyVisible else { return }
+
+                    self.activityIndicatorView.stopAnimating()
+                    UIView.defaultAnimation(0.3, delay: 0, animations: hide, completion: { _ in
+                        self.isCurrentlyVisible = false
+                    })
+                } else {
+                    self.hide(status)
+                }
             })
         }