fill changelog

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## 0.24.9
 
+* `Pagination`:
+  * Make alternative constructor parameter `size` of `PaginationResult` with default value
+  * Add `Pagination.previousPage` extension
+  * `Compose`:
+    * Rework of `InfinityPagedComponentContext`
+    * Rework of `PagedComponent`
+
 ## 0.24.8
 
 * `Versions`:

pagination/common/src/commonMain/kotlin/dev/inmo/micro_utils/pagination/PaginationResult.kt

@@ -32,7 +32,7 @@ data class PaginationResult<T>(
         page: Int,
         results: List<T>,
         pagesNumber: Int,
-        size: Int
+        size: Int = results.size
     ) : this(
         page,
         size,

pagination/common/src/commonMain/kotlin/dev/inmo/micro_utils/pagination/SimplePagination.kt

@@ -26,6 +26,16 @@ inline fun Pagination.nextPage() =
         size
     )
 
+/**
+ * This method DO NOT check [Pagination.page] of receiver. Returns pagination for previous page
+ */
+@Suppress("NOTHING_TO_INLINE")
+inline fun Pagination.previousPage() =
+    SimplePagination(
+        page - 1,
+        size
+    )
+
 /**
  * @param page Current page number
  * @param size Current page size

pagination/compose/src/commonMain/kotlin/InfinityPagedComponent.kt

@@ -1,6 +1,7 @@
 package dev.inmo.micro_utils.pagination.compose
 
 import androidx.compose.runtime.*
+import dev.inmo.micro_utils.coroutines.SpecialMutableStateFlow
 import dev.inmo.micro_utils.pagination.*
 
 /**
@@ -18,32 +19,27 @@ class InfinityPagedComponentContext<T> internal constructor(
     size: Int
 ) {
     internal val startPage = SimplePagination(page, size)
-    internal val iterationState: MutableState<Pagination?> = mutableStateOf(null)
+    internal val currentlyLoadingPage = SpecialMutableStateFlow<Pagination?>(startPage)
-    internal val dataState: MutableState<List<T>?> = mutableStateOf(null)
+    internal val latestLoadedPage = SpecialMutableStateFlow<PaginationResult<T>?>(null)
-    internal var lastPageLoaded = false
+    internal val dataState = SpecialMutableStateFlow<List<T>?>(null)
 
     /**
      * Loads the next page of data. If the current page is the last one, the function returns early.
      */
     fun loadNext() {
-        if (lastPageLoaded) return
+        if (latestLoadedPage.value ?.isLastPage == true) return
-        if (iterationState.value is SimplePagination) return // Data loading has been inited but not loaded yet
+        if (currentlyLoadingPage.value != null) return // Data loading has been inited but not loaded yet
 
-        iterationState.value = iterationState.value.let {
+        currentlyLoadingPage.value = latestLoadedPage.value ?.nextPage() ?: startPage
-            if ((it as? PaginationResult<*>) ?.isLastPage == true) return
-            (it ?: startPage).nextPage()
-        }
     }
 
     /**
      * Reloads the pagination from the first page, clearing previously loaded data.
      */
     fun reload() {
-        dataState.value = null
+        latestLoadedPage.value = null
-        lastPageLoaded = false
+        currentlyLoadingPage.value = null
-        iterationState.value = iterationState.value.let {
+        loadNext()
-            null
-        }
     }
 }
 
@@ -66,16 +62,17 @@ internal fun <T> InfinityPagedComponent(
 ) {
     val context = remember { InfinityPagedComponentContext<T>(page, size) }
 
-    LaunchedEffect(context.iterationState.value ?.page) {
+    val currentlyLoadingState = context.currentlyLoadingPage.collectAsState()
-        val paginationResult = loader(context, context.iterationState.value ?: context.startPage)
+    LaunchedEffect(currentlyLoadingState.value) {
-        if (paginationResult.isLastPage) {
+        val paginationResult = loader(context, currentlyLoadingState.value ?: return@LaunchedEffect)
-            context.lastPageLoaded = true
+        context.latestLoadedPage.value = paginationResult
-        }
+        context.currentlyLoadingPage.value = null
-        context.iterationState.value = paginationResult
+
         context.dataState.value = (context.dataState.value ?: emptyList()) + paginationResult.results
     }
 
-    context.block(context.dataState.value)
+    val dataState = context.dataState.collectAsState()
+    context.block(dataState.value)
 }
 
 /**

pagination/compose/src/commonMain/kotlin/PagedComponent.kt

@@ -1,9 +1,7 @@
 package dev.inmo.micro_utils.pagination.compose
 
 import androidx.compose.runtime.*
-import dev.inmo.micro_utils.common.Optional
+import dev.inmo.micro_utils.coroutines.SpecialMutableStateFlow
-import dev.inmo.micro_utils.common.dataOrThrow
-import dev.inmo.micro_utils.common.optional
 import dev.inmo.micro_utils.pagination.*
 
 /**
@@ -19,23 +17,21 @@ import dev.inmo.micro_utils.pagination.*
  * @param size Number of items per page.
  */
 class PagedComponentContext<T> internal constructor(
-    preset: PaginationResult<T>? = null,
     initialPage: Int,
     size: Int
 ) {
-    internal val iterationState: MutableState<Pagination> = mutableStateOf(SimplePagination(preset?.page ?: initialPage, preset?.size ?: size))
+    internal val startPage = SimplePagination(initialPage, size)
-    
+    internal val currentlyLoadingPageState = SpecialMutableStateFlow<Pagination?>(startPage)
-    internal var dataOptional: PaginationResult<T>? = preset
+    internal val latestLoadedPage = SpecialMutableStateFlow<PaginationResult<T>?>(null)
-        private set
-    internal val dataState: MutableState<PaginationResult<T>?> = mutableStateOf(dataOptional)
 
     /**
      * Loads the next page of data. If the last page is reached, this function returns early.
      */
     fun loadNext() {
-        iterationState.value = iterationState.value.let {
+        when {
-            if (dataState.value ?.isLastPage == true) return
+            currentlyLoadingPageState.value != null -> return
-            it.nextPage()
+            latestLoadedPage.value ?.isLastPage == true -> return
+            else -> currentlyLoadingPageState.value = (latestLoadedPage.value ?.nextPage()) ?: startPage
         }
     }
 
@@ -43,12 +39,10 @@ class PagedComponentContext<T> internal constructor(
      * Loads the previous page of data if available.
      */
     fun loadPrevious() {
-        iterationState.value = iterationState.value.let {
+        when {
-            if (it.isFirstPage) return
+            currentlyLoadingPageState.value != null -> return
-            SimplePagination(
+            latestLoadedPage.value ?.isFirstPage == true -> return
-                it.page - 1,
+            else -> currentlyLoadingPageState.value = (latestLoadedPage.value ?.previousPage()) ?: startPage
-                it.size
-            )
         }
     }
 
@@ -56,9 +50,7 @@ class PagedComponentContext<T> internal constructor(
      * Reloads the current page, refreshing the data.
      */
     fun reload() {
-        iterationState.value = iterationState.value.let {
+        currentlyLoadingPageState.value = latestLoadedPage.value
-            SimplePagination(it.page, it.size)
-        }
     }
 }
 
@@ -74,46 +66,26 @@ class PagedComponentContext<T> internal constructor(
  */
 @Composable
 internal fun <T> PagedComponent(
-    preload: PaginationResult<T>?,
     initialPage: Int,
     size: Int,
     loader: suspend PagedComponentContext<T>.(Pagination) -> PaginationResult<T>,
     block: @Composable PagedComponentContext<T>.(PaginationResult<T>) -> Unit
 ) {
-    val context = remember { PagedComponentContext(preload, initialPage, size) }
+    val context = remember { PagedComponentContext<T>(initialPage, size) }
 
-    LaunchedEffect(context.iterationState.value.page, context.iterationState.value.hashCode()) {
+    val currentlyLoadingState = context.currentlyLoadingPageState.collectAsState()
-        context.dataState.value = loader(context, context.iterationState.value)
+    LaunchedEffect(currentlyLoadingState.value) {
+        val paginationResult = loader(context, currentlyLoadingState.value ?: return@LaunchedEffect)
+        context.latestLoadedPage.value = paginationResult
+        context.currentlyLoadingPageState.value = null
     }
 
-    context.dataState.value ?.let {
+    val pageState = context.latestLoadedPage.collectAsState()
+    pageState.value ?.let {
         context.block(it)
     }
 }
 
-/**
- * Overloaded composable function for paginated components with preloaded data.
- *
- * @param T The type of paginated data.
- * @param preload Preloaded pagination result.
- * @param loader Suspended function that loads paginated data.
- * @param block Composable function that renders the UI with the loaded data.
- */
-@Composable
-fun <T> PagedComponent(
-    preload: PaginationResult<T>,
-    loader: suspend PagedComponentContext<T>.(Pagination) -> PaginationResult<T>,
-    block: @Composable PagedComponentContext<T>.(PaginationResult<T>) -> Unit
-) {
-    PagedComponent(
-        preload,
-        preload.page,
-        preload.size,
-        loader,
-        block
-    )
-}
-
 /**
  * Overloaded composable function for paginated components with pagination info.
  *
@@ -129,7 +101,6 @@ fun <T> PagedComponent(
     block: @Composable PagedComponentContext<T>.(PaginationResult<T>) -> Unit
 ) {
     PagedComponent(
-        null,
         pageInfo.page,
         pageInfo.size,
         loader,
@@ -137,25 +108,6 @@ fun <T> PagedComponent(
     )
 }
 
-/**
- * Overloaded composable function for paginated components with an initial page.
- *
- * @param T The type of paginated data.
- * @param initialPage Initial page number.
- * @param size Number of items per page.
- * @param loader Suspended function that loads paginated data.
- * @param block Composable function that renders the UI with the loaded data.
- */
-@Composable
-fun <T> PagedComponent(
-    initialPage: Int,
-    size: Int,
-    loader: suspend PagedComponentContext<T>.(Pagination) -> PaginationResult<T>,
-    block: @Composable PagedComponentContext<T>.(PaginationResult<T>) -> Unit
-) {
-    PagedComponent(null, initialPage, size, loader, block)
-}
-
 /**
  * Overloaded composable function for paginated components with only a size parameter.
  *

pagination/compose/src/jvmTest/kotlin/InfinityPagedComponentTests.kt

@@ -30,9 +30,7 @@ class InfinityPagedComponentTests {
                 }
             ) {
                 if (it == null) {
-                    if (this.iterationState.value != null) {
+                    assertEquals(0, this.currentlyLoadingPage.value ?.page)
-                        assertEquals(0, (this.iterationState.value as? SimplePagination) ?.page)
-                    }
                 } else {
                     assertEquals(expectedList, it)
                 }