Make FeedbackViewController public

Cartfile.resolved

@@ -3,7 +3,7 @@ github "Quick/Nimble" "v7.1.3"
 github "Quick/Quick" "v1.3.1"
 github "ceeK/Solar" "2.1.0"
 github "mapbox/MapboxDirections.swift" "v0.22.0"
-github "mapbox/mapbox-events-ios" "v0.4.3"
+github "mapbox/mapbox-events-ios" "v0.4.51"
 github "mapbox/mapbox-voice-swift" "v0.0.1"
 github "mapbox/turf-swift" "v0.2.0"
 github "raphaelmor/Polyline" "v4.2.0"

Examples/Swift/Base.lproj/Main.storyboard

@@ -187,6 +187,13 @@
                                     <constraint firstAttribute="height" constant="125" id="JIN-44-TWV"/>
                                 </constraints>
                             </view>
+                            <button opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="ocq-gm-39c">
+                                <rect key="frame" x="297" y="165" width="68" height="30"/>
+                                <state key="normal" title="Feedback"/>
+                                <connections>
+                                    <action selector="showFeedback:" destination="j9p-fX-jo4" eventType="touchUpInside" id="ZNw-Hv-gpO"/>
+                                </connections>
+                            </button>
                         </subviews>
                         <color key="backgroundColor" white="1" alpha="1" colorSpace="calibratedWhite"/>
                         <constraints>
@@ -196,6 +203,7 @@
                             <constraint firstItem="Zwg-TF-wCY" firstAttribute="top" secondItem="gqy-oH-EyZ" secondAttribute="top" id="Gay-FU-c00"/>
                             <constraint firstAttribute="trailing" secondItem="bFk-po-evo" secondAttribute="trailing" id="Hez-Lc-Zos"/>
                             <constraint firstItem="68P-Cf-VxO" firstAttribute="centerX" secondItem="KG0-bP-EJe" secondAttribute="centerX" id="LWc-VG-K7s"/>
+                            <constraint firstItem="KG0-bP-EJe" firstAttribute="trailing" secondItem="ocq-gm-39c" secondAttribute="trailing" constant="10" id="Rlm-JZ-iLK"/>
                             <constraint firstAttribute="bottom" secondItem="bFk-po-evo" secondAttribute="bottom" id="a3I-5l-ygF"/>
                             <constraint firstItem="KG0-bP-EJe" firstAttribute="trailing" secondItem="Zeb-q8-C2a" secondAttribute="trailing" id="dSH-d3-G8i"/>
                             <constraint firstItem="xEg-9E-ca4" firstAttribute="leading" secondItem="KG0-bP-EJe" secondAttribute="leading" constant="8" id="gq5-Gh-Zua"/>
@@ -204,6 +212,7 @@
                             <constraint firstItem="Zeb-q8-C2a" firstAttribute="top" secondItem="KG0-bP-EJe" secondAttribute="top" id="nSS-iv-xNg"/>
                             <constraint firstAttribute="bottom" secondItem="xEg-9E-ca4" secondAttribute="bottom" constant="60" id="qmg-Mz-8ml"/>
                             <constraint firstItem="Zwg-TF-wCY" firstAttribute="trailing" secondItem="gqy-oH-EyZ" secondAttribute="trailing" id="tkQ-Hu-vZV"/>
+                            <constraint firstItem="ocq-gm-39c" firstAttribute="top" secondItem="Zeb-q8-C2a" secondAttribute="bottom" constant="20" id="yJM-zZ-jVy"/>
                             <constraint firstItem="Zeb-q8-C2a" firstAttribute="leading" secondItem="KG0-bP-EJe" secondAttribute="leading" id="zYT-mW-YMn"/>
                         </constraints>
                         <viewLayoutGuide key="safeArea" id="KG0-bP-EJe"/>

Examples/Swift/CustomViewController.swift

@@ -22,6 +22,10 @@ class CustomViewController: UIViewController, MGLMapViewDelegate {
     @IBOutlet var mapView: NavigationMapView!
     @IBOutlet weak var cancelButton: UIButton!
     @IBOutlet weak var instructionsBannerView: InstructionsBannerView!
+
+    lazy var feedbackViewController: FeedbackViewController = {
+        return FeedbackViewController(eventsManager: routeController.eventsManager)
+    }()
 
     override func viewDidLoad() {
         super.viewDidLoad()
@@ -106,4 +110,8 @@ class CustomViewController: UIViewController, MGLMapViewDelegate {
     @IBAction func recenterMap(_ sender: Any) {
         mapView.recenterMap()
     }
+
+    @IBAction func showFeedback(_ sender: Any) {
+        present(feedbackViewController, animated: true, completion: nil)
+    }
 }

MapboxNavigation/FeedbackItem.swift

@@ -7,12 +7,30 @@ extension UIImage {
     }
 }
 
-struct FeedbackItem {
-    var title: String
-    var image: UIImage
-    var feedbackType: FeedbackType
+/**
+ A single feedback item displayed on an instance of `FeedbackViewController`.
+ */
+@objc(MBFeedbackItem)
+public class FeedbackItem: NSObject {
+    /**
+     The title of feedback item. This will be rendered directly below the image.
+     */
+    @objc public var title: String
 
-    init(title: String, image: UIImage, feedbackType: FeedbackType) {
+    /**
+     An image representation of the feedback.
+     */
+    @objc public var image: UIImage
+
+    /**
+     The type of feedback that best describes the event.
+     */
+    @objc public var feedbackType: FeedbackType
+
+    /**
+     Creates a new `FeedbackItem`.
+     */
+    @objc public init(title: String, image: UIImage, feedbackType: FeedbackType) {
         self.title = title
         self.image = image
         self.feedbackType = feedbackType

MapboxNavigation/FeedbackViewController.swift

@@ -3,29 +3,46 @@ import MapboxCoreNavigation
 import AVFoundation
 
 extension FeedbackViewController: UIViewControllerTransitioningDelegate {
-    func animationController(forDismissed dismissed: UIViewController) -> UIViewControllerAnimatedTransitioning? {
+    @objc public func animationController(forDismissed dismissed: UIViewController) -> UIViewControllerAnimatedTransitioning? {
         abortAutodismiss()
         return DismissAnimator()
     }
 
-    func animationController(forPresented presented: UIViewController, presenting: UIViewController, source: UIViewController) -> UIViewControllerAnimatedTransitioning? {
+    @objc public func animationController(forPresented presented: UIViewController, presenting: UIViewController, source: UIViewController) -> UIViewControllerAnimatedTransitioning? {
         return PresentAnimator()
     }
 
-    func interactionControllerForDismissal(using animator: UIViewControllerAnimatedTransitioning) -> UIViewControllerInteractiveTransitioning? {
+    @objc public func interactionControllerForDismissal(using animator: UIViewControllerAnimatedTransitioning) -> UIViewControllerInteractiveTransitioning? {
         return interactor.hasStarted ? interactor : nil
     }
 }
 
-typealias FeedbackSection = [FeedbackItem]
-
-class FeedbackViewController: UIViewController, DismissDraggable, UIGestureRecognizerDelegate {
+/**
+ The `FeedbackViewControllerDelegate` protocol provides methods for responding to feedback events.
+ */
+@objc public protocol FeedbackViewControllerDelegate {
+
+    /**
+     Called when the user opens the feedback form.
+     */
+    @objc optional func  feedbackViewControllerDidOpenFeedback(_ feedbackViewController: FeedbackViewController)
 
-    typealias SendFeedbackHandler = (FeedbackItem) -> Void
+    /**
+     Called when the user submits a feedback event.
+     */
+    @objc optional func feedbackViewController(_ feedbackViewController: FeedbackViewController, didSendFeedbackAssigned: UUID, feedback: FeedbackItem)
 
-    var sendFeedbackHandler: SendFeedbackHandler?
-    var dismissFeedbackHandler: (() -> Void)?
-    var sections = [FeedbackSection]()
+    /**
+     Called when a `FeedbackViewController` is dismissed for any reason without giving explicit feedback.
+     */
+    @objc optional func feedbackViewControllerDidCancelFeedback(_ feedbackViewController: FeedbackViewController)
+}
+
+/**
+ A view controller containing a grid of buttons the user can use to denote an issue their current navigation experience.
+ */
+@objc(MBFeedbackViewController)
+public class FeedbackViewController: UIViewController, DismissDraggable, UIGestureRecognizerDelegate {
     var activeFeedbackItem: FeedbackItem?
 
     static let sceneTitle = NSLocalizedString("FEEDBACK_TITLE", value: "Report Problem", comment: "Title of view controller for sending feedback")
@@ -35,6 +52,13 @@ class FeedbackViewController: UIViewController, DismissDraggable, UIGestureRecog
 
     let interactor = Interactor()
 
+    /**
+     The feedback items that are visible and selectable by the user.
+     */
+    public var sections: [FeedbackItem] = [.turnNotAllowed, .closure, .reportTraffic, .confusingInstructions, .generalMapError, .badRoute]
+
+    public var delegate: FeedbackViewControllerDelegate?
+
     lazy var collectionView: UICollectionView = {
         let view: UICollectionView = UICollectionView(frame: .zero, collectionViewLayout: flowLayout)
         view.translatesAutoresizingMaskIntoConstraints = false
@@ -71,7 +95,40 @@ class FeedbackViewController: UIViewController, DismissDraggable, UIGestureRecog
         return fullHeight
     }
 
-    override func viewDidLoad() {
+    /**
+     The events manager used to send feedback events.
+     */
+    public var eventsManager: EventsManager
+
+    var uuid: UUID {
+        return eventsManager.recordFeedback()
+    }
+
+    /**
+     Initialize a new FeedbackViewController from an `EventsManager`.
+     */
+    @objc public init(eventsManager: EventsManager) {
+        self.eventsManager = eventsManager
+        super.init(nibName: nil, bundle: nil)
+        commonInit()
+    }
+
+    public override func encode(with aCoder: NSCoder) {
+        aCoder.encode(eventsManager, forKey: "EventsManager")
+    }
+
+    required public init?(coder aDecoder: NSCoder) {
+        eventsManager = aDecoder.decodeObject(of: [EventsManager.self], forKey: "EventsManager") as? EventsManager ?? EventsManager(accessToken: nil)
+        super.init(coder: aDecoder)
+        commonInit()
+    }
+
+    func commonInit() {
+        self.modalPresentationStyle = .custom
+        self.transitioningDelegate = self
+    }
+
+    override public func viewDidLoad() {
         super.viewDidLoad()
         setupViews()
         setupConstraints()
@@ -82,22 +139,24 @@ class FeedbackViewController: UIViewController, DismissDraggable, UIGestureRecog
         enableDraggableDismiss()
     }
 
-    override func viewWillAppear(_ animated: Bool) {
+    override public func viewWillAppear(_ animated: Bool) {
         super.viewWillAppear(animated)
         progressBar.progress = 1
     }
 
-    override func viewDidAppear(_ animated: Bool) {
+    override public func viewDidAppear(_ animated: Bool) {
         super.viewDidAppear(animated)
 
+        delegate?.feedbackViewControllerDidOpenFeedback?(self)
+
         UIView.animate(withDuration: FeedbackViewController.autoDismissInterval) {
             self.progressBar.progress = 0
         }
 
         enableAutoDismiss()
     }
 
-    override func willTransition(to newCollection: UITraitCollection, with coordinator: UIViewControllerTransitionCoordinator) {
+    override public func willTransition(to newCollection: UITraitCollection, with coordinator: UIViewControllerTransitionCoordinator) {
         super.willTransition(to: newCollection, with: coordinator)
 
         // Dismiss the feedback view when switching between landscape and portrait mode.
@@ -126,12 +185,15 @@ class FeedbackViewController: UIViewController, DismissDraggable, UIGestureRecog
         NSObject.cancelPreviousPerformRequests(withTarget: self, selector: #selector(dismissFeedback), object: nil)
     }
 
-    @objc func dismissFeedback() {
+    /**
+     Instantly dismisses the FeedbackViewController if it is currently presented.
+     */
+    @objc public func dismissFeedback() {
         abortAutodismiss()
-        dismissFeedbackHandler?()
+        defaultDismissFeedback()
     }
 
-    func gestureRecognizer(_ gestureRecognizer: UIGestureRecognizer, shouldReceive touch: UITouch) -> Bool {
+    public func gestureRecognizer(_ gestureRecognizer: UIGestureRecognizer, shouldReceive touch: UITouch) -> Bool {
         // Only respond to touches outside/behind the view
         let isDescendant = touch.view?.isDescendant(of: view) ?? true
         return !isDescendant
@@ -165,12 +227,32 @@ class FeedbackViewController: UIViewController, DismissDraggable, UIGestureRecog
         progressBar.trailingAnchor.constraint(equalTo: view.trailingAnchor).isActive = true
         progressBar.bottomAnchor.constraint(equalTo: view.safeBottomAnchor).isActive = true
     }
+
+    func sendFeedback(_ item: FeedbackItem) {
+        delegate?.feedbackViewController?(self, didSendFeedbackAssigned: uuid, feedback: item)
+        eventsManager.updateFeedback(uuid: uuid, type: item.feedbackType, source: .user, description: nil)
+
+        guard let parent = presentingViewController else {
+            dismiss(animated: true)
+            return
+        }
+
+        dismiss(animated: true) {
+            DialogViewController().present(on: parent)
+        }
+    }
+
+    func defaultDismissFeedback() {
+        delegate?.feedbackViewControllerDidCancelFeedback?(self)
+        eventsManager.cancelFeedback(uuid: uuid)
+        dismiss(animated: true, completion: nil)
+    }
 }
 
 extension FeedbackViewController: UICollectionViewDataSource {
-    func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
+    @objc public func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
         let cell = collectionView.dequeueReusableCell(withReuseIdentifier: FeedbackCollectionViewCell.defaultIdentifier, for: indexPath) as! FeedbackCollectionViewCell
-        let item = sections[indexPath.section][indexPath.row]
+        let item = sections[indexPath.row]
 
         cell.titleLabel.text = item.title
         cell.imageView.tintColor = .clear
@@ -179,15 +261,15 @@ extension FeedbackViewController: UICollectionViewDataSource {
         return cell
     }
 
-    func numberOfSections(in collectionView: UICollectionView) -> Int {
-        return sections.count
+    @objc public func numberOfSections(in collectionView: UICollectionView) -> Int {
+        return 1
     }
 
-    func collectionView(_ collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
-        return sections[section].count
+    @objc public func collectionView(_ collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
+        return sections.count
     }
 
-    func scrollViewDidScroll(_ scrollView: UIScrollView) {
+    @objc public func scrollViewDidScroll(_ scrollView: UIScrollView) {
         // In case the view is scrolled, dismiss the feedback window immediately
         // and reset the `progressBar` back to a full progress.
         abortAutodismiss()
@@ -196,24 +278,22 @@ extension FeedbackViewController: UICollectionViewDataSource {
 }
 
 extension FeedbackViewController: UICollectionViewDelegate {
-    func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
+    @objc public func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
         abortAutodismiss()
-        let item = sections[indexPath.section][indexPath.row]
-        sendFeedbackHandler?(item)
+        let item = sections[indexPath.row]
+        sendFeedback(item)
     }
 }
 
 extension FeedbackViewController: UICollectionViewDelegateFlowLayout {
-
-    func collectionView(_ collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, sizeForItemAt indexPath: IndexPath) -> CGSize {
+    @objc public func collectionView(_ collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, sizeForItemAt indexPath: IndexPath) -> CGSize {
         let availableWidth = collectionView.bounds.width
         // 3 columns and 2 rows in portrait mode.
         // 6 columns and 1 row in landscape mode.
-        let items = sections[indexPath.section]
         let width = traitCollection.verticalSizeClass == .compact
-            ? floor(availableWidth / CGFloat(items.count))
-            : floor(availableWidth / CGFloat(items.count / 2))
-        let item = sections[indexPath.section][indexPath.row]
+            ? floor(availableWidth / CGFloat(sections.count))
+            : floor(availableWidth / CGFloat(sections.count / 2))
+        let item = sections[indexPath.row]
         let titleHeight = item.title.height(constrainedTo: width, font: FeedbackCollectionViewCell.Constants.titleFont)
         let cellHeight: CGFloat = FeedbackCollectionViewCell.Constants.imageSize.height
                                   + FeedbackCollectionViewCell.Constants.padding

MapboxNavigation/NavigationViewController.swift

@@ -150,26 +150,6 @@ public protocol NavigationViewControllerDelegate: VisualInstructionDelegate {
     @objc(navigationViewController:viewForAnnotation:)
     optional func navigationViewController(_ navigationViewController: NavigationViewController, viewFor annotation: MGLAnnotation) -> MGLAnnotationView?
 
-    /**
-     Called when the user opens the feedback form.
-     */
-    @objc optional func navigationViewControllerDidOpenFeedback(_ viewController: NavigationViewController)
-
-    /**
-     Called when the user dismisses the feedback form.
-     */
-    @objc optional func navigationViewControllerDidCancelFeedback(_ viewController: NavigationViewController)
-
-    /**
-     Called when the user sends feedback.
-
-     - parameter viewController: The navigation view controller that reported the feedback.
-     - parameter uuid: The feedback event’s unique identifier.
-     - parameter feedbackType: The type of feedback event that was sent.
-     */
-    @objc(navigationViewController:didSendFeedbackAssignedUUID:feedbackType:)
-    optional func navigationViewController(_ viewController: NavigationViewController, didSendFeedbackAssigned uuid: UUID, feedbackType: FeedbackType)
-
     /**
      Returns the center point of the user course view in screen coordinates relative to the map view.
      */
@@ -525,14 +505,6 @@ extension NavigationViewController: RouteMapViewControllerDelegate {
         return delegate?.navigationViewController?(self, viewFor: annotation)
     }
 
-    func mapViewControllerDidOpenFeedback(_ mapViewController: RouteMapViewController) {
-        delegate?.navigationViewControllerDidOpenFeedback?(self)
-    }
-
-    func mapViewControllerDidCancelFeedback(_ mapViewController: RouteMapViewController) {
-        delegate?.navigationViewControllerDidCancelFeedback?(self)
-    }
-
     func mapViewControllerDidDismiss(_ mapViewController: RouteMapViewController, byCanceling canceled: Bool) {
         if delegate?.navigationViewControllerDidDismiss?(self, byCanceling: canceled) != nil {
             // The receiver should handle dismissal of the NavigationViewController
@@ -541,10 +513,6 @@ extension NavigationViewController: RouteMapViewControllerDelegate {
         }
     }
 
-    func mapViewController(_ mapViewController: RouteMapViewController, didSendFeedbackAssigned uuid: UUID, feedbackType: FeedbackType) {
-        delegate?.navigationViewController?(self, didSendFeedbackAssigned: uuid, feedbackType: feedbackType)
-    }
-
     public func navigationMapViewUserAnchorPoint(_ mapView: NavigationMapView) -> CGPoint {
         return delegate?.navigationViewController?(self, mapViewUserAnchorPoint: mapView) ?? .zero
     }