vector-im/element-ios/issues/5114 - Added UI for creating undisclosed polls and logic for displaying them in the timeline.

This commit is contained in:
Stefan Ceriu
2022-01-13 15:57:26 +02:00
committed by Stefan Ceriu
parent 3e3719d13a
commit eff1d8c81c
27 changed files with 443 additions and 157 deletions

View File

@@ -56,12 +56,14 @@ final class PollEditFormCoordinator: Coordinator, Presentable {
if let startEvent = parameters.pollStartEvent,
let pollContent = MXEventContentPollStart(fromJSON: startEvent.content) {
viewModel = PollEditFormViewModel(parameters: PollEditFormViewModelParameters(mode: .editing,
pollDetails: PollDetails(question: pollContent.question,
pollDetails: PollDetails(type: Self.pollKindKeyToDetailsType(pollContent.kind),
question: pollContent.question,
answerOptions: pollContent.answerOptions.map { $0.text })))
} else {
viewModel = PollEditFormViewModel(parameters: PollEditFormViewModelParameters(mode: .creation,
pollDetails: PollDetails(question: "",
pollDetails: PollDetails(type: .disclosed,
question: "",
answerOptions: ["", ""])))
}
@@ -147,9 +149,23 @@ final class PollEditFormCoordinator: Coordinator, Presentable {
}
return MXEventContentPollStart(question: details.question,
kind: (details.disclosed ? kMXMessageContentKeyExtensiblePollKindDisclosed : kMXMessageContentKeyExtensiblePollKindUndisclosed) ,
kind: Self.pollDetailsTypeToKindKey(details.type),
maxSelections: NSNumber(value: details.maxSelections),
answerOptions: options)
}
private static func pollDetailsTypeToKindKey(_ type: PollEditFormType) -> String {
let mapping = [PollEditFormType.disclosed : kMXMessageContentKeyExtensiblePollKindDisclosed,
PollEditFormType.undisclosed : kMXMessageContentKeyExtensiblePollKindUndisclosed]
return mapping[type] ?? kMXMessageContentKeyExtensiblePollKindDisclosed
}
private static func pollKindKeyToDetailsType(_ key: String) -> PollEditFormType {
let mapping = [kMXMessageContentKeyExtensiblePollKindDisclosed : PollEditFormType.disclosed,
kMXMessageContentKeyExtensiblePollKindUndisclosed : PollEditFormType.undisclosed]
return mapping[key] ?? PollEditFormType.disclosed
}
}

View File

@@ -20,10 +20,10 @@ import Foundation
import SwiftUI
struct PollDetails {
let type: PollEditFormType
let question: String
let answerOptions: [String]
let maxSelections: UInt = 1
let disclosed: Bool = true
}
enum PollEditFormMode {
@@ -51,6 +51,11 @@ enum PollEditFormViewModelResult {
case update(PollDetails)
}
enum PollEditFormType {
case disclosed
case undisclosed
}
struct PollEditFormQuestion {
var text: String {
didSet {
@@ -93,6 +98,7 @@ struct PollEditFormViewState: BindableState {
struct PollEditFormViewStateBindings {
var question: PollEditFormQuestion
var answerOptions: [PollEditFormAnswerOption]
var type: PollEditFormType
var alertInfo: PollEditFormErrorAlertInfo?
}

View File

@@ -28,8 +28,10 @@ enum MockPollEditFormScreenState: MockScreenState, CaseIterable {
}
var screenView: ([Any], AnyView) {
let viewModel = PollEditFormViewModel(parameters: PollEditFormViewModelParameters(mode: .editing,
pollDetails: PollDetails(question: "", answerOptions: ["", ""])))
let viewModel = PollEditFormViewModel(parameters: PollEditFormViewModelParameters(mode: .creation,
pollDetails: PollDetails(type: .disclosed,
question: "",
answerOptions: ["", ""])))
return ([viewModel], AnyView(PollEditForm(viewModel: viewModel.context)))
}
}

View File

@@ -53,7 +53,8 @@ class PollEditFormViewModel: PollEditFormViewModelType {
mode: parameters.mode,
bindings: PollEditFormViewStateBindings(
question: PollEditFormQuestion(text: parameters.pollDetails.question, maxLength: Constants.maxQuestionLength),
answerOptions: parameters.pollDetails.answerOptions.map { PollEditFormAnswerOption(text: $0, maxLength: Constants.maxAnswerOptionLength) }
answerOptions: parameters.pollDetails.answerOptions.map { PollEditFormAnswerOption(text: $0, maxLength: Constants.maxAnswerOptionLength) },
type: parameters.pollDetails.type
)
)
@@ -111,7 +112,8 @@ class PollEditFormViewModel: PollEditFormViewModelType {
// MARK: - Private
private func buildPollDetails() -> PollDetails {
return PollDetails(question: state.bindings.question.text.trimmingCharacters(in: .whitespacesAndNewlines),
return PollDetails(type: state.bindings.type,
question: state.bindings.question.text.trimmingCharacters(in: .whitespacesAndNewlines),
answerOptions: state.bindings.answerOptions.compactMap({ answerOption in
let text = answerOption.text.trimmingCharacters(in: .whitespacesAndNewlines)
return text.isEmpty ? nil : text

View File

@@ -28,10 +28,11 @@ class PollEditFormViewModelTests: XCTestCase {
var cancellables = Set<AnyCancellable>()
override func setUpWithError() throws {
viewModel = PollEditFormViewModel()
viewModel = PollEditFormViewModel(parameters: PollEditFormViewModelParameters(mode: .creation,
pollDetails: PollDetails(question: "", answerOptions: ["", ""])))
context = viewModel.context
}
func testInitialState() {
XCTAssertTrue(context.question.text.isEmpty)
XCTAssertFalse(context.viewState.confirmationButtonEnabled)
@@ -100,14 +101,14 @@ class PollEditFormViewModelTests: XCTestCase {
let thirdAnswer = " "
viewModel.completion = { result in
if case PollEditFormViewModelResult.create(let resultQuestion, let resultAnswerOptions) = result {
XCTAssertEqual(question.trimmingCharacters(in: .whitespacesAndNewlines), resultQuestion)
if case PollEditFormViewModelResult.create(let result) = result {
XCTAssertEqual(question.trimmingCharacters(in: .whitespacesAndNewlines), result.question)
// The last answer option should be automatically dropped as it's empty
XCTAssertEqual(resultAnswerOptions.count, 2)
XCTAssertEqual(result.answerOptions.count, 2)
XCTAssertEqual(resultAnswerOptions[0], firstAnswer.trimmingCharacters(in: .whitespacesAndNewlines))
XCTAssertEqual(resultAnswerOptions[1], secondAnswer.trimmingCharacters(in: .whitespacesAndNewlines))
XCTAssertEqual(result.answerOptions[0], firstAnswer.trimmingCharacters(in: .whitespacesAndNewlines))
XCTAssertEqual(result.answerOptions[1], secondAnswer.trimmingCharacters(in: .whitespacesAndNewlines))
}
}

View File

@@ -37,6 +37,8 @@ struct PollEditForm: View {
ScrollView {
VStack(alignment: .leading, spacing: 32.0) {
PollEditFormTypeView(selectedType: $viewModel.type)
VStack(alignment: .leading, spacing: 16.0) {
Text(VectorL10n.pollEditFormPollQuestionOrTopic)
.font(theme.fonts.title3SB)
@@ -58,7 +60,7 @@ struct PollEditForm: View {
ForEach(0..<viewModel.answerOptions.count, id: \.self) { index in
SafeBindingCollectionEnumerator($viewModel.answerOptions, index: index) { binding in
AnswerOptionGroup(text: binding.text, index: index) {
PollEditFormAnswerOptionView(text: binding.text, index: index) {
withAnimation(.easeInOut(duration: 0.2)) {
viewModel.send(viewAction: .deleteAnswerOption(viewModel.answerOptions[index]))
}
@@ -84,7 +86,8 @@ struct PollEditForm: View {
.disabled(!viewModel.viewState.confirmationButtonEnabled)
}
}
.padding()
.padding(.vertical, 24.0)
.padding(.horizontal, 16.0)
.activityIndicator(show: viewModel.viewState.showLoadingIndicator)
.alert(item: $viewModel.alertInfo) { info in
Alert(title: Text(info.title),
@@ -122,40 +125,6 @@ struct PollEditForm: View {
}
}
@available(iOS 14.0, *)
private struct AnswerOptionGroup: View {
@Environment(\.theme) private var theme: ThemeSwiftUI
@State private var focused = false
@Binding var text: String
let index: Int
let onDelete: () -> Void
var body: some View {
VStack(alignment: .leading, spacing: 8.0) {
Text(VectorL10n.pollEditFormOptionNumber(index + 1))
.font(theme.fonts.subheadline)
.foregroundColor(theme.colors.primaryContent)
HStack(spacing: 16.0) {
TextField(VectorL10n.pollEditFormInputPlaceholder, text: $text, onEditingChanged: { edit in
self.focused = edit
})
.textFieldStyle(BorderedInputFieldStyle(theme: _theme, isEditing: focused))
Button {
onDelete()
} label: {
Image(uiImage:Asset.Images.pollDeleteOptionIcon.image)
}
.accessibilityIdentifier("Delete answer option")
}
}
}
}
// MARK: - Previews
@available(iOS 14.0, *)

View File

@@ -0,0 +1,64 @@
//
// 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.0, *)
struct PollEditFormAnswerOptionView: View {
@Environment(\.theme) private var theme: ThemeSwiftUI
@State private var focused = false
@Binding var text: String
let index: Int
let onDelete: () -> Void
var body: some View {
VStack(alignment: .leading, spacing: 8.0) {
Text(VectorL10n.pollEditFormOptionNumber(index + 1))
.font(theme.fonts.subheadline)
.foregroundColor(theme.colors.primaryContent)
HStack(spacing: 16.0) {
TextField(VectorL10n.pollEditFormInputPlaceholder, text: $text, onEditingChanged: { edit in
self.focused = edit
})
.textFieldStyle(BorderedInputFieldStyle(theme: _theme, isEditing: focused))
Button {
onDelete()
} label: {
Image(uiImage:Asset.Images.pollDeleteOptionIcon.image)
}
}
}
}
}
@available(iOS 14.0, *)
struct PollEditFormAnswerOptionView_Previews: PreviewProvider {
static var previews: some View {
VStack(spacing: 32.0) {
PollEditFormAnswerOptionView(text: Binding.constant(""), index: 0) {
}
PollEditFormAnswerOptionView(text: Binding.constant("Test"), index: 5) {
}
}
}
}

View File

@@ -0,0 +1,94 @@
//
// 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.0, *)
struct PollEditFormTypeView: View {
@Environment(\.theme) private var theme: ThemeSwiftUI
@Binding var selectedType: PollEditFormType
var body: some View {
VStack(alignment: .leading, spacing: 16.0) {
Text(VectorL10n.pollEditFormPollType)
.font(theme.fonts.title3SB)
.foregroundColor(theme.colors.primaryContent)
PollTypeViewButton(type: .disclosed, selectedType: $selectedType)
PollTypeViewButton(type: .undisclosed, selectedType: $selectedType)
}
}
}
@available(iOS 14.0, *)
private struct PollTypeViewButton: View {
@Environment(\.theme) private var theme: ThemeSwiftUI
var type: PollEditFormType
@Binding var selectedType: PollEditFormType
var body: some View {
Button {
selectedType = type
} label: {
HStack(alignment: .top, spacing: 8.0) {
if type == selectedType {
Image(uiImage: Asset.Images.pollTypeCheckboxSelected.image)
} else {
Image(uiImage: Asset.Images.pollTypeCheckboxDefault.image)
}
VStack(alignment: .leading, spacing: 2) {
Text(title)
.font(theme.fonts.body)
.foregroundColor(theme.colors.primaryContent)
Text(description)
.font(theme.fonts.footnote)
.foregroundColor(theme.colors.secondaryContent)
}
}
}
}
private var title: String {
switch type {
case .disclosed:
return VectorL10n.pollEditFormPollTypeOpen
case .undisclosed:
return VectorL10n.pollEditFormPollTypeClosed
}
}
private var description: String {
switch type {
case .disclosed:
return VectorL10n.pollEditFormPollTypeOpenDescription
case .undisclosed:
return VectorL10n.pollEditFormPollTypeClosedDescription
}
}
}
@available(iOS 14.0, *)
struct PollEditFormTypeView_Previews: PreviewProvider {
static var previews: some View {
VStack {
PollEditFormTypeView(selectedType: Binding.constant(.disclosed))
PollEditFormTypeView(selectedType: Binding.constant(.undisclosed))
}
}
}