Merge pull request #7867 from vector-im/feature/mna/active-polls-ui

[Poll] Render active polls list of a room (PSG-908)

Author: mnaturel

changelog.d/7864.wip

@@ -0,0 +1 @@
+[Poll] Render active polls list of a room

library/ui-strings/src/main/res/values/strings.xml

@@ -2335,6 +2335,7 @@
         <item quantity="one">"One person"</item>
         <item quantity="other">"%1$d people"</item>
     </plurals>
+    <string name="room_profile_section_more_polls">Poll history</string>
     <string name="room_profile_section_more_uploads">Uploads</string>
     <string name="room_profile_section_more_leave">Leave Room</string>
     <string name="direct_room_profile_section_more_leave">Leave</string>
@@ -3190,6 +3191,8 @@
     <string name="open_poll_option_description">Voters see results as soon as they have voted</string>
     <string name="closed_poll_option_title">Closed poll</string>
     <string name="closed_poll_option_description">Results are only revealed when you end the poll</string>
+    <string name="room_polls_active">Active polls</string>
+    <string name="room_polls_active_no_item">There are no active polls in this room</string>
 
     <!-- Location -->
     <string name="location_activity_title_static_sharing">Share location</string>

vector/src/main/java/im/vector/app/core/di/MavericksViewModelModule.kt

@@ -84,6 +84,7 @@ import im.vector.app.features.roomprofile.banned.RoomBannedMemberListViewModel
 import im.vector.app.features.roomprofile.members.RoomMemberListViewModel
 import im.vector.app.features.roomprofile.notifications.RoomNotificationSettingsViewModel
 import im.vector.app.features.roomprofile.permissions.RoomPermissionsViewModel
+import im.vector.app.features.roomprofile.polls.RoomPollsViewModel
 import im.vector.app.features.roomprofile.settings.RoomSettingsViewModel
 import im.vector.app.features.roomprofile.settings.joinrule.advanced.RoomJoinRuleChooseRestrictedViewModel
 import im.vector.app.features.roomprofile.uploads.RoomUploadsViewModel
@@ -697,4 +698,9 @@ interface MavericksViewModelModule {
     @IntoMap
     @MavericksViewModelKey(SetLinkViewModel::class)
     fun setLinkViewModelFactory(factory: SetLinkViewModel.Factory): MavericksAssistedViewModelFactory<*, *>
+
+    @Binds
+    @IntoMap
+    @MavericksViewModelKey(RoomPollsViewModel::class)
+    fun roomPollsViewModelFactory(factory: RoomPollsViewModel.Factory): MavericksAssistedViewModelFactory<*, *>
 }

vector/src/main/java/im/vector/app/features/roomprofile/RoomProfileActivity.kt

@@ -36,6 +36,7 @@ import im.vector.app.features.roomprofile.banned.RoomBannedMemberListFragment
 import im.vector.app.features.roomprofile.members.RoomMemberListFragment
 import im.vector.app.features.roomprofile.notifications.RoomNotificationSettingsFragment
 import im.vector.app.features.roomprofile.permissions.RoomPermissionsFragment
+import im.vector.app.features.roomprofile.polls.RoomPollsFragment
 import im.vector.app.features.roomprofile.settings.RoomSettingsFragment
 import im.vector.app.features.roomprofile.uploads.RoomUploadsFragment
 import im.vector.lib.core.utils.compat.getParcelableCompat
@@ -98,6 +99,7 @@ class RoomProfileActivity :
                         RoomProfileSharedAction.OpenRoomSettings -> openRoomSettings()
                         RoomProfileSharedAction.OpenRoomAliasesSettings -> openRoomAlias()
                         RoomProfileSharedAction.OpenRoomPermissionsSettings -> openRoomPermissions()
+                        RoomProfileSharedAction.OpenRoomPolls -> openRoomPolls()
                         RoomProfileSharedAction.OpenRoomUploads -> openRoomUploads()
                         RoomProfileSharedAction.OpenBannedRoomMembers -> openBannedRoomMembers()
                         RoomProfileSharedAction.OpenRoomNotificationSettings -> openRoomNotificationSettings()
@@ -126,6 +128,10 @@ class RoomProfileActivity :
         finish()
     }
 
+    private fun openRoomPolls() {
+        addFragmentToBackstack(views.simpleFragmentContainer, RoomPollsFragment::class.java, roomProfileArgs)
+    }
+
     private fun openRoomUploads() {
         addFragmentToBackstack(views.simpleFragmentContainer, RoomUploadsFragment::class.java, roomProfileArgs)
     }

vector/src/main/java/im/vector/app/features/roomprofile/RoomProfileController.kt

@@ -18,6 +18,7 @@
 package im.vector.app.features.roomprofile
 
 import com.airbnb.epoxy.TypedEpoxyController
+import im.vector.app.BuildConfig
 import im.vector.app.R
 import im.vector.app.core.epoxy.expandableTextItem
 import im.vector.app.core.epoxy.profiles.buildProfileAction
@@ -56,6 +57,7 @@ class RoomProfileController @Inject constructor(
         fun onMemberListClicked()
         fun onBannedMemberListClicked()
         fun onNotificationsClicked()
+        fun onPollHistoryClicked()
         fun onUploadsClicked()
         fun createShortcut()
         fun onSettingsClicked()
@@ -263,6 +265,15 @@ class RoomProfileController @Inject constructor(
                     action = { callback?.onBannedMemberListClicked() }
             )
         }
+        if (BuildConfig.DEBUG) {
+            // WIP, will be in release when related screens will be finished
+            buildProfileAction(
+                    id = "poll_history",
+                    title = stringProvider.getString(R.string.room_profile_section_more_polls),
+                    icon = R.drawable.ic_attachment_poll,
+                    action = { callback?.onPollHistoryClicked() }
+            )
+        }
         buildProfileAction(
                 id = "uploads",
                 title = stringProvider.getString(R.string.room_profile_section_more_uploads),

vector/src/main/java/im/vector/app/features/roomprofile/RoomProfileFragment.kt

@@ -269,6 +269,10 @@ class RoomProfileFragment :
         roomProfileSharedActionViewModel.post(RoomProfileSharedAction.OpenRoomNotificationSettings)
     }
 
+    override fun onPollHistoryClicked() {
+        roomProfileSharedActionViewModel.post(RoomProfileSharedAction.OpenRoomPolls)
+    }
+
     override fun onUploadsClicked() {
         roomProfileSharedActionViewModel.post(RoomProfileSharedAction.OpenRoomUploads)
     }

vector/src/main/java/im/vector/app/features/roomprofile/RoomProfileSharedAction.kt

@@ -25,6 +25,7 @@ sealed class RoomProfileSharedAction : VectorSharedAction {
     object OpenRoomSettings : RoomProfileSharedAction()
     object OpenRoomAliasesSettings : RoomProfileSharedAction()
     object OpenRoomPermissionsSettings : RoomProfileSharedAction()
+    object OpenRoomPolls : RoomProfileSharedAction()
     object OpenRoomUploads : RoomProfileSharedAction()
     object OpenRoomMembers : RoomProfileSharedAction()
     object OpenBannedRoomMembers : RoomProfileSharedAction()

vector/src/main/java/im/vector/app/features/roomprofile/polls/GetPollsUseCase.kt

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2022 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.
+ */
+
+package im.vector.app.features.roomprofile.polls
+
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.emptyFlow
+import kotlinx.coroutines.flow.flowOf
+import kotlinx.coroutines.flow.map
+import javax.inject.Inject
+
+class GetPollsUseCase @Inject constructor() {
+
+    fun execute(filter: RoomPollsFilterType): Flow<List<PollSummary>> {
+        // TODO unmock and add unit tests
+        return when (filter) {
+            RoomPollsFilterType.ACTIVE -> getActivePolls()
+            RoomPollsFilterType.ENDED -> emptyFlow()
+        }.map { it.sortedByDescending { poll -> poll.creationTimestamp } }
+    }
+
+    private fun getActivePolls(): Flow<List<PollSummary.ActivePoll>> {
+        return flowOf(
+                listOf(
+                        PollSummary.ActivePoll(
+                                id = "id1",
+                                // 2022/06/28 UTC+1
+                                creationTimestamp = 1656367200000,
+                                title = "Which charity would you like to support?"
+                        ),
+                        PollSummary.ActivePoll(
+                                id = "id2",
+                                // 2022/06/26 UTC+1
+                                creationTimestamp = 1656194400000,
+                                title = "Which sport should the pupils do this year?"
+                        ),
+                        PollSummary.ActivePoll(
+                                id = "id3",
+                                // 2022/06/24 UTC+1
+                                creationTimestamp = 1656021600000,
+                                title = "What type of food should we have at the party?"
+                        ),
+                        PollSummary.ActivePoll(
+                                id = "id4",
+                                // 2022/06/22 UTC+1
+                                creationTimestamp = 1655848800000,
+                                title = "What film should we show at the end of the year party?"
+                        ),
+                )
+        )
+    }
+}

vector/src/main/java/im/vector/app/features/roomprofile/polls/PollSummary.kt

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2022 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.
+ */
+
+package im.vector.app.features.roomprofile.polls
+
+sealed interface PollSummary {
+    data class ActivePoll(
+            val id: String,
+            val creationTimestamp: Long,
+            val title: String,
+    ) : PollSummary
+}

vector/src/main/java/im/vector/app/features/roomprofile/polls/RoomPollsAction.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2022 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.
+ */
+
+package im.vector.app.features.roomprofile.polls
+
+import im.vector.app.core.platform.VectorViewModelAction
+
+sealed interface RoomPollsAction : VectorViewModelAction {
+    data class SetFilter(val filter: RoomPollsFilterType) : RoomPollsAction
+}