Rageshake Service (#70)

ElementX/Sources/Screens/Settings/SettingsCoordinator.swift

@@ -0,0 +1,109 @@
+//
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import SwiftUI
+
+struct SettingsCoordinatorParameters {
+    let navigationRouter: NavigationRouterType
+    let bugReportService: BugReportServiceProtocol
+}
+
+final class SettingsCoordinator: Coordinator, Presentable {
+    
+    // MARK: - Properties
+    
+    // MARK: Private
+    
+    private let parameters: SettingsCoordinatorParameters
+    private let settingsHostingController: UIViewController
+    private var settingsViewModel: SettingsViewModelProtocol
+    
+    private var indicatorPresenter: UserIndicatorTypePresenterProtocol
+    private var loadingIndicator: UserIndicator?
+    
+    // MARK: Public
+
+    // Must be used only internally
+    var childCoordinators: [Coordinator] = []
+    
+    // MARK: - Setup
+    
+    init(parameters: SettingsCoordinatorParameters) {
+        self.parameters = parameters
+        
+        let viewModel = SettingsViewModel()
+        let view = Settings(context: viewModel.context)
+        settingsViewModel = viewModel
+        settingsHostingController = UIHostingController(rootView: view)
+        
+        indicatorPresenter = UserIndicatorTypePresenter(presentingViewController: settingsHostingController)
+
+        settingsViewModel.callback = { [weak self] result in
+            guard let self = self else { return }
+            MXLog.debug("[SettingsCoordinator] SettingsViewModel did complete with result: \(result).")
+            switch result {
+            case .reportBug:
+                self.presentBugReportScreen()
+            case .crash:
+                self.parameters.bugReportService.crash()
+            }
+        }
+    }
+    
+    // MARK: - Public
+    
+    func start() {
+        // no-op
+    }
+    
+    func toPresentable() -> UIViewController {
+        settingsHostingController
+    }
+    
+    // MARK: - Private
+    
+    /// Show an activity indicator whilst loading.
+    /// - Parameters:
+    ///   - label: The label to show on the indicator.
+    ///   - isInteractionBlocking: Whether the indicator should block any user interaction.
+    private func startLoading(label: String = ElementL10n.loading, isInteractionBlocking: Bool = true) {
+        loadingIndicator = indicatorPresenter.present(.loading(label: label, isInteractionBlocking: isInteractionBlocking))
+    }
+    
+    /// Hide the currently displayed activity indicator.
+    private func stopLoading() {
+        loadingIndicator = nil
+    }
+
+    private func presentBugReportScreen() {
+        let params = BugReportCoordinatorParameters(bugReportService: parameters.bugReportService,
+                                                    screenshot: nil)
+        let coordinator = BugReportCoordinator(parameters: params)
+        coordinator.completion = { [weak self, weak coordinator] in
+            guard let self = self, let coordinator = coordinator else { return }
+            self.parameters.navigationRouter.popModule(animated: true)
+            self.remove(childCoordinator: coordinator)
+        }
+
+        add(childCoordinator: coordinator)
+        coordinator.start()
+        self.parameters.navigationRouter.push(coordinator, animated: true) { [weak self] in
+            guard let self = self else { return }
+
+            self.remove(childCoordinator: coordinator)
+        }
+    }
+}

ElementX/Sources/Screens/Settings/SettingsModels.swift

@@ -0,0 +1,42 @@
+// 
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+
+// MARK: - Coordinator
+
+// MARK: View model
+
+enum SettingsViewModelAction {
+    case reportBug
+    case crash
+}
+
+// MARK: View
+
+struct SettingsViewState: BindableState {
+    var crashButtonVisible: Bool
+    var bindings: SettingsViewStateBindings
+}
+
+struct SettingsViewStateBindings {
+    
+}
+
+enum SettingsViewAction {
+    case reportBug
+    case crash
+}

ElementX/Sources/Screens/Settings/SettingsViewModel.swift

@@ -0,0 +1,50 @@
+//
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import SwiftUI
+
+@available(iOS 14, *)
+typealias SettingsViewModelType = StateStoreViewModel<SettingsViewState,
+                                                      SettingsViewAction>
+@available(iOS 14, *)
+class SettingsViewModel: SettingsViewModelType, SettingsViewModelProtocol {
+
+    // MARK: - Properties
+
+    // MARK: Private
+
+    // MARK: Public
+
+    var callback: ((SettingsViewModelAction) -> Void)?
+
+    // MARK: - Setup
+
+    init() {
+        let bindings = SettingsViewStateBindings()
+        super.init(initialViewState: .init(crashButtonVisible: true, bindings: bindings))
+    }
+
+    // MARK: - Public
+
+    override func process(viewAction: SettingsViewAction) async {
+        switch viewAction {
+        case .reportBug:
+            callback?(.reportBug)
+        case .crash:
+            callback?(.crash)
+        }
+    }
+}

ElementX/Sources/Screens/Settings/SettingsViewModelProtocol.swift

@@ -0,0 +1,25 @@
+// 
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+
+@MainActor
+protocol SettingsViewModelProtocol {
+    
+    var callback: ((SettingsViewModelAction) -> Void)? { get set }
+    @available(iOS 14, *)
+    var context: SettingsViewModelType.Context { get }
+}

ElementX/Sources/Screens/Settings/View/Settings.swift

@@ -0,0 +1,61 @@
+// 
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import SwiftUI
+
+struct Settings: View {
+
+    // MARK: Private
+    
+    // MARK: Public
+    
+    @ObservedObject var context: SettingsViewModel.Context
+    
+    // MARK: Views
+    
+    var body: some View {
+        Form {
+            Button { context.send(viewAction: .reportBug) } label: {
+                Text(ElementL10n.sendBugReport)
+            }
+            .frame(maxWidth: .infinity)
+            .padding(.vertical, 16)
+            .accessibilityIdentifier("reportBugButton")
+
+            if context.viewState.crashButtonVisible {
+                Button { context.send(viewAction: .crash) } label: {
+                    Text("Crash the app")
+                }
+                .frame(maxWidth: .infinity)
+                .padding(.vertical, 16)
+                .accessibilityIdentifier("crashButton")
+            }
+        }
+        .navigationTitle(ElementL10n.settings)
+    }
+}
+
+// MARK: - Previews
+
+struct Settings_Previews: PreviewProvider {
+    static var previews: some View {
+        Group {
+            let viewModel = SettingsViewModel()
+            Settings(context: viewModel.context)
+                .previewInterfaceOrientation(.portrait)
+        }
+    }
+}