Pinned events : minor code quality changes

Author: ganfra

features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/pinned/banner/PinnedMessagesBannerPresenter.kt

@@ -53,7 +53,7 @@ class PinnedMessagesBannerPresenter @Inject constructor(
     @Composable
     override fun present(): PinnedMessagesBannerState {
         val isFeatureEnabled = isFeatureEnabled()
-        val knownPinnedMessagesCount by remember {
+        val expectedPinnedMessagesCount by remember {
             room.roomInfoFlow.map { roomInfo -> roomInfo.pinnedEventIds.size }
         }.collectAsState(initial = 0)
 
@@ -77,19 +77,15 @@ class PinnedMessagesBannerPresenter @Inject constructor(
         fun handleEvent(event: PinnedMessagesBannerEvents) {
             when (event) {
                 is PinnedMessagesBannerEvents.MoveToNextPinned -> {
-                    if (currentPinnedMessageIndex > 0) {
-                        currentPinnedMessageIndex--
-                    } else {
-                        currentPinnedMessageIndex = pinnedItems.value.size - 1
-                    }
+                    currentPinnedMessageIndex = (currentPinnedMessageIndex - 1).mod(pinnedItems.value.size)
                 }
             }
         }
 
         return pinnedMessagesBannerState(
             isFeatureEnabled = isFeatureEnabled,
             hasTimelineFailed = hasTimelineFailedToLoad,
-            realPinnedMessagesCount = knownPinnedMessagesCount,
+            expectedPinnedMessagesCount = expectedPinnedMessagesCount,
             pinnedItems = pinnedItems.value,
             currentPinnedMessageIndex = currentPinnedMessageIndex,
             eventSink = ::handleEvent
@@ -100,7 +96,7 @@ class PinnedMessagesBannerPresenter @Inject constructor(
     private fun pinnedMessagesBannerState(
         isFeatureEnabled: Boolean,
         hasTimelineFailed: Boolean,
-        realPinnedMessagesCount: Int,
+        expectedPinnedMessagesCount: Int,
         pinnedItems: ImmutableList<PinnedMessagesBannerItem>,
         currentPinnedMessageIndex: Int,
         eventSink: (PinnedMessagesBannerEvents) -> Unit
@@ -112,11 +108,11 @@ class PinnedMessagesBannerPresenter @Inject constructor(
             currentPinnedMessage != null -> PinnedMessagesBannerState.Loaded(
                 currentPinnedMessage = currentPinnedMessage,
                 currentPinnedMessageIndex = currentPinnedMessageIndex,
-                knownPinnedMessagesCount = pinnedItems.size,
+                loadedPinnedMessagesCount = pinnedItems.size,
                 eventSink = eventSink
             )
-            realPinnedMessagesCount == 0 -> PinnedMessagesBannerState.Hidden
-            else -> PinnedMessagesBannerState.Loading(realPinnedMessagesCount = realPinnedMessagesCount)
+            expectedPinnedMessagesCount == 0 -> PinnedMessagesBannerState.Hidden
+            else -> PinnedMessagesBannerState.Loading(expectedPinnedMessagesCount = expectedPinnedMessagesCount)
         }
     }
 

features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/pinned/banner/PinnedMessagesBannerState.kt

@@ -27,23 +27,23 @@ import io.element.android.libraries.ui.strings.CommonStrings
 sealed interface PinnedMessagesBannerState {
     data object Hidden : PinnedMessagesBannerState
     sealed interface Visible : PinnedMessagesBannerState
-    data class Loading(val realPinnedMessagesCount: Int) : Visible
+    data class Loading(val expectedPinnedMessagesCount: Int) : Visible
     data class Loaded(
         val currentPinnedMessage: PinnedMessagesBannerItem,
         val currentPinnedMessageIndex: Int,
-        val knownPinnedMessagesCount: Int,
+        val loadedPinnedMessagesCount: Int,
         val eventSink: (PinnedMessagesBannerEvents) -> Unit
     ) : Visible
 
     fun pinnedMessagesCount() = when (this) {
         is Hidden -> 0
-        is Loading -> realPinnedMessagesCount
-        is Loaded -> knownPinnedMessagesCount
+        is Loading -> expectedPinnedMessagesCount
+        is Loaded -> loadedPinnedMessagesCount
     }
 
     fun currentPinnedMessageIndex() = when (this) {
         is Hidden -> 0
-        is Loading -> realPinnedMessagesCount - 1
+        is Loading -> expectedPinnedMessagesCount - 1
         is Loaded -> currentPinnedMessageIndex
     }
 

features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/pinned/banner/PinnedMessagesBannerStateProvider.kt

@@ -42,7 +42,7 @@ internal fun aHiddenPinnedMessagesBannerState() = PinnedMessagesBannerState.Hidd
 internal fun aLoadingPinnedMessagesBannerState(
     knownPinnedMessagesCount: Int = 4
 ) = PinnedMessagesBannerState.Loading(
-    realPinnedMessagesCount = knownPinnedMessagesCount
+    expectedPinnedMessagesCount = knownPinnedMessagesCount
 )
 
 internal fun aLoadedPinnedMessagesBannerState(
@@ -56,6 +56,6 @@ internal fun aLoadedPinnedMessagesBannerState(
 ) = PinnedMessagesBannerState.Loaded(
     currentPinnedMessage = currentPinnedMessage,
     currentPinnedMessageIndex = currentPinnedMessageIndex,
-    knownPinnedMessagesCount = knownPinnedMessagesCount,
+    loadedPinnedMessagesCount = knownPinnedMessagesCount,
     eventSink = eventSink
 )

features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/pinned/banner/PinnedMessagesBannerPresenterTest.kt

@@ -99,7 +99,7 @@ class PinnedMessagesBannerPresenterTest {
             skipItems(2)
             val loadedState = awaitItem() as PinnedMessagesBannerState.Loaded
             assertThat(loadedState.currentPinnedMessageIndex).isEqualTo(0)
-            assertThat(loadedState.knownPinnedMessagesCount).isEqualTo(1)
+            assertThat(loadedState.loadedPinnedMessagesCount).isEqualTo(1)
             assertThat(loadedState.currentPinnedMessage.formatted.text).isEqualTo(messageContent.toString())
         }
     }
@@ -139,23 +139,23 @@ class PinnedMessagesBannerPresenterTest {
             awaitItem().also { loadedState ->
                 loadedState as PinnedMessagesBannerState.Loaded
                 assertThat(loadedState.currentPinnedMessageIndex).isEqualTo(1)
-                assertThat(loadedState.knownPinnedMessagesCount).isEqualTo(2)
+                assertThat(loadedState.loadedPinnedMessagesCount).isEqualTo(2)
                 assertThat(loadedState.currentPinnedMessage.formatted.text).isEqualTo(messageContent2.toString())
                 loadedState.eventSink(PinnedMessagesBannerEvents.MoveToNextPinned)
             }
 
             awaitItem().also { loadedState ->
                 loadedState as PinnedMessagesBannerState.Loaded
                 assertThat(loadedState.currentPinnedMessageIndex).isEqualTo(0)
-                assertThat(loadedState.knownPinnedMessagesCount).isEqualTo(2)
+                assertThat(loadedState.loadedPinnedMessagesCount).isEqualTo(2)
                 assertThat(loadedState.currentPinnedMessage.formatted.text).isEqualTo(messageContent1.toString())
                 loadedState.eventSink(PinnedMessagesBannerEvents.MoveToNextPinned)
             }
 
             awaitItem().also { loadedState ->
                 loadedState as PinnedMessagesBannerState.Loaded
                 assertThat(loadedState.currentPinnedMessageIndex).isEqualTo(1)
-                assertThat(loadedState.knownPinnedMessagesCount).isEqualTo(2)
+                assertThat(loadedState.loadedPinnedMessagesCount).isEqualTo(2)
                 assertThat(loadedState.currentPinnedMessage.formatted.text).isEqualTo(messageContent2.toString())
             }
         }