Surveys Feature UI

OBAKit/Extensions/UIKitExtensions.swift

@@ -9,6 +9,7 @@
 
 import UIKit
 import OBAKitCore
+import SwiftUI
 
 // MARK: - UIButton
 
@@ -75,3 +76,9 @@ extension UIApplication {
         return windows ?? []
     }
 }
+
+extension UIColor {
+    func toColor() -> Color {
+        Color(uiColor: self)
+    }
+}

OBAKit/Mapping/MapViewController.swift

@@ -15,6 +15,7 @@ import FloatingPanel
 import OBAKitCore
 import SwiftUI
 import OTPKit
+import SafariServices
 
 /// Displays a map, a set of stops rendered as annotation views, and the user's location if authorized.
 ///
@@ -28,6 +29,7 @@ class MapViewController: UIViewController,
     MapPanelDelegate,
     UIContextMenuInteractionDelegate,
     UILargeContentViewerInteractionDelegate,
+    SurveyViewHostingProtocol,
     UIGestureRecognizerDelegate {
 
     // MARK: - Hoverbar
@@ -128,6 +130,8 @@ class MapViewController: UIViewController,
         longPressGesture.minimumPressDuration = 0.5
         longPressGesture.delegate = self
         mapView.addGestureRecognizer(longPressGesture)
+
+        surveysVM.onAction(.onAppear)
     }
 
     public override func viewWillAppear(_ animated: Bool) {
@@ -144,6 +148,8 @@ class MapViewController: UIViewController,
 
         updateVisibleMapRect()
         layoutMapMargins()
+
+        observeSurveysState()
     }
 
     public override func viewDidAppear(_ animated: Bool) {
@@ -157,6 +163,7 @@ class MapViewController: UIViewController,
         super.viewWillDisappear(animated)
 
         navigationController?.setNavigationBarHidden(false, animated: false)
+        stopObserveSurveysState()
     }
 
     // MARK: - User Location
@@ -1013,6 +1020,87 @@ class MapViewController: UIViewController,
             didTapMapStatus(interaction)
         }
     }
+
+    // MARK: - Survey
+
+    lazy var surveysVM: SurveysViewModel = SurveysViewModel(
+        stateManager: application.surveyStateManager,
+        service: application.surveyService,
+        prioritizer: application.surveyPrioritizer,
+        externalLinkBuilder: application.externalSurveyURLBuilder
+    )
+
+    var observationActive: Bool = false
+
+    private var surveyPopupController: UIViewController?
+
+    // MARK: - Show/Hide HeroQuestion
+    private func showSurveyHeroQuestionPopup() {
+        guard surveyPopupController == nil else { return }
+
+        let surveyQuestionView = MapHeroQuestionView(viewModel: surveysVM)
+        let hostingController = createPopupHostingController(content: surveyQuestionView)
+
+        addChild(hostingController)
+        view.insertSubview(hostingController.view, aboveSubview: mapRegionManager.mapView)
+
+        hostingController.view.translatesAutoresizingMaskIntoConstraints = false
+
+        NSLayoutConstraint.activate([
+            hostingController.view.trailingAnchor.constraint(equalTo: view.safeAreaLayoutGuide.trailingAnchor, constant: -ThemeMetrics.controllerMargin),
+            hostingController.view.topAnchor.constraint(equalTo: toolbar.bottomAnchor, constant: 24),
+            hostingController.view.leadingAnchor.constraint(equalTo: view.safeAreaLayoutGuide.leadingAnchor, constant: ThemeMetrics.controllerMargin),
+        ])
+
+        hostingController.didMove(toParent: self)
+        surveyPopupController = hostingController
+    }
+
+    private func createPopupHostingController<Content: View>(content: Content) -> UIHostingController<Content> {
+        let controller = UIHostingController(rootView: content)
+        controller.view.backgroundColor = .clear
+        return controller
+    }
+
+    @objc private func dismissSurveyPopup() {
+        surveyPopupController?.willMove(toParent: nil)
+        surveyPopupController?.view.removeFromSuperview()
+        surveyPopupController?.removeFromParent()
+        surveyPopupController = nil
+    }
+
+    // MARK: - Surveys VM Observation
+
+    func observeSurveysState() {
+        observationActive = true
+        observeSurveyLoadingState()
+        observeSurveyHeroQuestion()
+        observeSurveyToastMessage()
+        observeSurveyFullQuestionsState(application.viewRouter)
+        observeSurveyDismissActionSheet()
+        observeOpenExternalSurvey(application.viewRouter)
+    }
+
+    func stopObserveSurveysState() {
+        observationActive = false
+    }
+
+    func observeSurveyHeroQuestion() {
+        withObservationTracking { [weak self] in
+            guard let self else { return }
+            if self.surveysVM.showHeroQuestion {
+                showSurveyHeroQuestionPopup()
+            } else {
+                self.dismissSurveyPopup()
+            }
+        } onChange: {
+            Task { @MainActor [weak self] in
+                guard let self, self.observationActive else { return }
+                self.observeSurveyHeroQuestion()
+            }
+        }
+    }
+
 }
 
 // swiftlint:enable file_length

OBAKit/Stops/StopViewController.swift

@@ -11,6 +11,7 @@ import UIKit
 import OBAKitCore
 import CoreLocation
 import SwiftUI
+import SafariServices
 
 // swiftlint:disable file_length
 
@@ -32,12 +33,14 @@ public class StopViewController: UIViewController,
     OBAListViewCollapsibleSectionsDelegate,
     ModalDelegate,
     Previewable,
-    StopPreferencesViewDelegate {
+    StopPreferencesViewDelegate,
+    SurveyViewHostingProtocol {
 
     /// The available sections in this view controller.
     enum ListSections {
         case stopHeader
         case donations
+        case surveys
         case emptyData
         case serviceAlerts
         case arrivalDepartures(suffix: String)
@@ -84,12 +87,22 @@ public class StopViewController: UIViewController,
     /// The amount of time that must elapse before `timerFired()` will update data.
     private static let defaultTimerReloadInterval: TimeInterval = 30.0
 
+    lazy var surveysVM = SurveysViewModel(
+        stopContext: true,
+        stop: stop,
+        stateManager: application.surveyStateManager,
+        service: application.surveyService,
+        prioritizer: application.surveyPrioritizer,
+        externalLinkBuilder: application.externalSurveyURLBuilder
+    )
+
     // MARK: - Data
     /// The stop displayed by this controller.
     var stop: Stop? {
         didSet {
             if stop != oldValue, let stop = stop {
                 stopUpdated(stop)
+                surveysVM.updateCurrentStop(stop)
             }
         }
     }
@@ -189,6 +202,7 @@ public class StopViewController: UIViewController,
         listView.register(listViewItem: MessageButtonItem.self)
         listView.register(listViewItem: StopArrivalWalkItem.self)
         listView.register(listViewItem: StopHeaderItem.self)
+        listView.register(listViewItem: HeroQuestionListItem.self)
 
         view.addSubview(listView)
         listView.pinToSuperview(.edges)
@@ -197,6 +211,8 @@ public class StopViewController: UIViewController,
         if !stopViewShowsServiceAlerts {
             collapsedSections = [ListSections.serviceAlerts.sectionID]
         }
+
+        surveysVM.onAction(.onAppear)
     }
 
     public override func viewWillAppear(_ animated: Bool) {
@@ -211,6 +227,8 @@ public class StopViewController: UIViewController,
         Task {
             await updateData()
         }
+
+        observeSurveysState()
     }
 
     public override func viewDidAppear(_ animated: Bool) {
@@ -231,8 +249,8 @@ public class StopViewController: UIViewController,
 
     public override func viewWillDisappear(_ animated: Bool) {
         super.viewWillDisappear(animated)
-
         enableIdleTimer()
+        stopObserveSurveysState()
     }
 
     // MARK: - Tips
@@ -580,6 +598,10 @@ public class StopViewController: UIViewController,
 
         sections.append(stopHeaderSection)
 
+        if let surveySection {
+            sections.append(surveySection)
+        }
+
         if let donationsSection {
             sections.append(donationsSection)
         }
@@ -1280,4 +1302,56 @@ public class StopViewController: UIViewController,
             return "User Distance: 03200-INFINITY"
         }
     }
+
+    // MARK: - Survey Section
+    private var surveySection: OBAListViewSection? {
+        guard let model = surveysVM.heroQuestion, surveysVM.showHeroQuestion else { return nil }
+
+        let heroQuestion = HeroQuestionListItem(
+            question: model,
+            answer: surveysVM.heroQuestionAnswer
+        ) { [weak self] answer in
+            self?.surveysVM.onAction(.updateHeroAnswer(answer))
+        } onSubmitAction: { [weak self] in
+            guard let self else { return }
+            surveysVM.onAction(.onTapNextHeroQuestion)
+        } onCloseAction: { [weak self] in
+            self?.surveysVM.onAction(.onCloseSurveyHeroQuestion)
+        }
+
+        return listViewSection(for: .surveys, title: nil, items: [heroQuestion])
+    }
+
+    // MARK: - Survey Observation
+
+    var observationActive: Bool = false
+
+    func observeSurveysState() {
+        observationActive = true
+        observeSurveyLoadingState()
+        observeSurveyHeroQuestion()
+        observeSurveyToastMessage()
+        observeSurveyFullQuestionsState(application.viewRouter)
+        observeSurveyDismissActionSheet()
+        observeOpenExternalSurvey(application.viewRouter)
+    }
+
+    func observeSurveyHeroQuestion() {
+        withObservationTracking { [weak self] in
+            guard let self else { return }
+            _ = self.surveysVM.heroQuestion
+            self.listView.applyData()
+        } onChange: {
+            Task { @MainActor [weak self] in
+                guard let self, self.observationActive else { return }
+                self.observeSurveyHeroQuestion()
+            }
+        }
+    }
+
+    func stopObserveSurveysState() {
+        observationActive = false
+    }
+
 }
+// swiftlint:enable file_length

OBAKit/Surveys/Model/SurveyQuestionAnswer.swift

@@ -0,0 +1,37 @@
+//
+//  SurveyAnswer.swift
+//  OBAKit
+//
+//  Copyright © Open Transit Software Foundation
+//  This source code is licensed under the Apache 2.0 license found in the
+//  LICENSE file in the root directory of this source tree.
+//
+
+import Foundation
+
+public enum SurveyQuestionAnswer: Hashable {
+
+    case text(String)
+
+    case radio(_ selectedOption: String)
+
+    case checkbox(_ selectedOptions: Set<String>)
+
+}
+
+extension SurveyQuestionAnswer {
+    var stringValue: String {
+        switch self {
+
+        case .text(let value):
+            return value
+
+        case .radio(let option):
+            return option
+
+        case .checkbox(let options):
+            return options.sorted().joined(separator: ", ")
+
+        }
+    }
+}