Add poll history scaffolding

RiotSwiftUI/Modules/Room/PollHistory/Coordinator/PollHistoryCoordinator.swift

@@ -0,0 +1,76 @@
+//
+// 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 CommonKit
+import SwiftUI
+
+struct PollHistoryCoordinatorParameters {
+    let promptType: PollHistoryPromptType
+}
+
+final class PollHistoryCoordinator: Coordinator, Presentable {
+    private let parameters: PollHistoryCoordinatorParameters
+    private let pollHistoryHostingController: UIViewController
+    private var pollHistoryViewModel: PollHistoryViewModelProtocol
+    
+    private var indicatorPresenter: UserIndicatorTypePresenterProtocol
+    private var loadingIndicator: UserIndicator?
+
+    // Must be used only internally
+    var childCoordinators: [Coordinator] = []
+    var completion: ((PollHistoryViewModelResult) -> Void)?
+    
+    init(parameters: PollHistoryCoordinatorParameters) {
+        self.parameters = parameters
+        
+        let viewModel = PollHistoryViewModel(promptType: parameters.promptType)
+        let view = PollHistory(viewModel: viewModel.context)
+        pollHistoryViewModel = viewModel
+        pollHistoryHostingController = VectorHostingController(rootView: view)
+        
+        indicatorPresenter = UserIndicatorTypePresenter(presentingViewController: pollHistoryHostingController)
+    }
+    
+    // MARK: - Public
+    
+    func start() {
+        MXLog.debug("[PollHistoryCoordinator] did start.")
+        pollHistoryViewModel.completion = { [weak self] result in
+            guard let self = self else { return }
+            MXLog.debug("[PollHistoryCoordinator] PollHistoryViewModel did complete with result: \(result).")
+            self.completion?(result)
+        }
+    }
+    
+    func toPresentable() -> UIViewController {
+        pollHistoryHostingController
+    }
+    
+    // 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 = VectorL10n.loading, isInteractionBlocking: Bool = true) {
+        loadingIndicator = indicatorPresenter.present(.loading(label: label, isInteractionBlocking: isInteractionBlocking))
+    }
+    
+    /// Hide the currently displayed activity indicator.
+    private func stopLoading() {
+        loadingIndicator = nil
+    }
+}

RiotSwiftUI/Modules/Room/PollHistory/MockPollHistoryScreenState.swift

@@ -0,0 +1,56 @@
+//
+// 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
+import SwiftUI
+
+/// Using an enum for the screen allows you define the different state cases with
+/// the relevant associated data for each case.
+enum MockPollHistoryScreenState: MockScreenState, CaseIterable {
+    // A case for each state you want to represent
+    // with specific, minimal associated data that will allow you
+    // mock that screen.
+    case promptType(PollHistoryPromptType)
+    
+    /// The associated screen
+    var screenType: Any.Type {
+        PollHistory.self
+    }
+    
+    /// A list of screen state definitions
+    static var allCases: [MockPollHistoryScreenState] {
+        // Each of the presence statuses
+        PollHistoryPromptType.allCases.map(MockPollHistoryScreenState.promptType)
+    }
+    
+    /// Generate the view struct for the screen state.
+    var screenView: ([Any], AnyView) {
+        let promptType: PollHistoryPromptType
+        switch self {
+        case .promptType(let type):
+            promptType = type
+        }
+        let viewModel = PollHistoryViewModel(promptType: promptType)
+        
+        // can simulate service and viewModel actions here if needs be.
+        
+        return (
+            [promptType, viewModel],
+            AnyView(PollHistory(viewModel: viewModel.context)
+                .addDependency(MockAvatarService.example))
+        )
+    }
+}

RiotSwiftUI/Modules/Room/PollHistory/PollHistoryModels.swift

@@ -0,0 +1,67 @@
+//
+// 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
+
+enum PollHistoryPromptType {
+    case regular
+    case upgrade
+}
+
+extension PollHistoryPromptType: Identifiable, CaseIterable {
+    var id: Self { self }
+    
+    var title: String {
+        switch self {
+        case .regular:
+            return VectorL10n.roomCreationMakePublicPromptTitle
+        case .upgrade:
+            return VectorL10n.roomDetailsHistorySectionPromptTitle
+        }
+    }
+    
+    var image: ImageAsset {
+        switch self {
+        case .regular:
+            return Asset.Images.appSymbol
+        case .upgrade:
+            return Asset.Images.keyVerificationSuccessShield
+        }
+    }
+}
+
+// MARK: View model
+
+enum PollHistoryViewModelResult {
+    case accept
+    case cancel
+}
+
+// MARK: View
+
+struct PollHistoryViewState: BindableState {
+    var promptType: PollHistoryPromptType
+    var count: Int
+}
+
+enum PollHistoryViewAction {
+    case incrementCount
+    case decrementCount
+    case accept
+    case cancel
+}

RiotSwiftUI/Modules/Room/PollHistory/PollHistoryViewModel.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 SwiftUI
+
+typealias PollHistoryViewModelType = StateStoreViewModel<PollHistoryViewState, PollHistoryViewAction>
+
+class PollHistoryViewModel: PollHistoryViewModelType, PollHistoryViewModelProtocol {
+    var completion: ((PollHistoryViewModelResult) -> Void)?
+
+    init(promptType: PollHistoryPromptType, initialCount: Int = 0) {
+        super.init(initialViewState: PollHistoryViewState(promptType: promptType, count: 0))
+    }
+
+    // MARK: - Public
+
+    override func process(viewAction: PollHistoryViewAction) {
+        switch viewAction {
+        case .accept:
+            completion?(.accept)
+        case .cancel:
+            completion?(.cancel)
+        case .incrementCount:
+            state.count += 1
+        case .decrementCount:
+            state.count -= 1
+        }
+    }
+}

RiotSwiftUI/Modules/Room/PollHistory/PollHistoryViewModelProtocol.swift

@@ -0,0 +1,22 @@
+//
+// 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
+
+protocol PollHistoryViewModelProtocol {
+    var completion: ((PollHistoryViewModelResult) -> Void)? { get set }
+    var context: PollHistoryViewModelType.Context { get }
+}

RiotSwiftUI/Modules/Room/PollHistory/Test/UI/PollHistoryUITests.swift

@@ -0,0 +1,38 @@
+//
+// 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 RiotSwiftUI
+import XCTest
+
+class PollHistoryUITests: MockScreenTestCase {
+    func testPollHistoryPromptRegular() {
+        let promptType = PollHistoryPromptType.regular
+        app.goToScreenWithIdentifier(MockPollHistoryScreenState.promptType(promptType).title)
+        
+        let title = app.staticTexts["title"]
+        XCTAssert(title.exists)
+        XCTAssertEqual(title.label, promptType.title)
+    }
+    
+    func testPollHistoryPromptUpgrade() {
+        let promptType = PollHistoryPromptType.upgrade
+        app.goToScreenWithIdentifier(MockPollHistoryScreenState.promptType(promptType).title)
+        
+        let title = app.staticTexts["title"]
+        XCTAssert(title.exists)
+        XCTAssertEqual(title.label, promptType.title)
+    }
+}

RiotSwiftUI/Modules/Room/PollHistory/Test/Unit/PollHistoryViewModelTests.swift

@@ -0,0 +1,48 @@
+//
+// 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 XCTest
+
+@testable import RiotSwiftUI
+
+class PollHistoryViewModelTests: XCTestCase {
+    private enum Constants {
+        static let counterInitialValue = 0
+    }
+    
+    var viewModel: PollHistoryViewModelProtocol!
+    var context: PollHistoryViewModelType.Context!
+    
+    override func setUpWithError() throws {
+        viewModel = PollHistoryViewModel(promptType: .regular, initialCount: Constants.counterInitialValue)
+        context = viewModel.context
+    }
+
+    func testInitialState() {
+        XCTAssertEqual(context.viewState.count, Constants.counterInitialValue)
+    }
+
+    func testCounter() throws {
+        context.send(viewAction: .incrementCount)
+        XCTAssertEqual(context.viewState.count, 1)
+        
+        context.send(viewAction: .incrementCount)
+        XCTAssertEqual(context.viewState.count, 2)
+        
+        context.send(viewAction: .decrementCount)
+        XCTAssertEqual(context.viewState.count, 1)
+    }
+}

RiotSwiftUI/Modules/Room/PollHistory/View/PollHistory.swift

@@ -0,0 +1,102 @@
+//
+// 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 PollHistory: View {
+    @Environment(\.theme) private var theme
+    @Environment(\.horizontalSizeClass) private var horizontalSizeClass
+    
+    private var horizontalPadding: CGFloat {
+        horizontalSizeClass == .regular ? 50 : 16
+    }
+    
+    @ObservedObject var viewModel: PollHistoryViewModel.Context
+    
+    var body: some View {
+        GeometryReader { geometry in
+            VStack {
+                ScrollView(showsIndicators: false) {
+                    mainContent
+                        .padding(.top, 50)
+                        .padding(.horizontal, horizontalPadding)
+                }
+                
+                buttons
+                    .padding(.horizontal, horizontalPadding)
+                    .padding(.bottom, geometry.safeAreaInsets.bottom > 0 ? 0 : 16)
+            }
+        }
+        .background(theme.colors.background.ignoresSafeArea())
+        .accentColor(theme.colors.accent)
+    }
+    
+    /// The main content of the view to be shown in a scroll view.
+    var mainContent: some View {
+        VStack(spacing: 36) {
+            Text(viewModel.viewState.promptType.title)
+                .font(theme.fonts.title1B)
+                .foregroundColor(theme.colors.primaryContent)
+                .accessibilityIdentifier("title")
+            
+            Image(viewModel.viewState.promptType.image.name)
+                .resizable()
+                .scaledToFit()
+                .frame(width: 100)
+                .foregroundColor(theme.colors.accent)
+            
+            HStack {
+                Text("Counter: \(viewModel.viewState.count)")
+                    .foregroundColor(theme.colors.primaryContent)
+                
+                Button("-") {
+                    viewModel.send(viewAction: .decrementCount)
+                }
+                
+                Button("+") {
+                    viewModel.send(viewAction: .incrementCount)
+                }
+            }
+            .font(theme.fonts.title3)
+        }
+    }
+    
+    /// The action buttons shown at the bottom of the view.
+    var buttons: some View {
+        VStack {
+            Button { viewModel.send(viewAction: .accept) } label: {
+                Text("Accept")
+                    .font(theme.fonts.bodySB)
+            }
+            .buttonStyle(PrimaryActionButtonStyle())
+            
+            Button { viewModel.send(viewAction: .cancel) } label: {
+                Text("Cancel")
+                    .font(theme.fonts.body)
+                    .padding(.vertical, 12)
+            }
+        }
+    }
+}
+
+// MARK: - Previews
+
+struct PollHistory_Previews: PreviewProvider {
+    static let stateRenderer = MockPollHistoryScreenState.stateRenderer
+    static var previews: some View {
+        stateRenderer.screenGroup()
+    }
+}