#39 add test, flow, core modules + up version

README.md

@@ -18,7 +18,7 @@ This is a Kotlin MultiPlatform library that contains pagination logic for kotlin
 - **Pagination** implements pagination logic for the data from abstract `PagedListDataSource`.
 - Managing a data loading process using **Pagination** asynchronous functions: `loadFirstPage`, `loadNextPage`,
 `refresh` or their duplicates with `suspend` modifier.
-- Observing states of **Pagination** using `LiveData` from **moko-mvvm**.
+- Observing states of **Pagination** using `LiveData` from **moko-mvvm** or `Flow` from **kotlinx.coroutines**.
 
 ## Requirements
 - Gradle version 6.8+
@@ -38,12 +38,18 @@ allprojects {
 project build.gradle
 ```groovy
 dependencies {
-    commonMainApi("dev.icerock.moko:paging:0.7.1")
+    commonMainApi("dev.icerock.moko:paging-core:0.8.0")
+    commonMainApi("dev.icerock.moko:paging-livedata:0.8.0")
+    commonMainApi("dev.icerock.moko:paging-flow:0.8.0")
+    commonMainApi("dev.icerock.moko:paging-state:0.8.0")
+    commonMainApi("dev.icerock.moko:paging-test:0.8.0")
 }
 ```
 
 ## Usage
 
+### LiveData
+
 You can use **Pagination** in `commonMain` sourceset.
 
 **Pagination** creation:
@@ -110,11 +116,35 @@ pagination.refreshLoading.addObserver { isRefreshing: Boolean ->
 }
 ```
 
+### Flow
+
+```kotlin
+// Observing the state of the pagination
+pagination.state
+    .onEach { /* ... */ }
+    .launchIn(coroutineScope)
+
+// Observing the next page loading process
+pagination.nextPageLoading
+    .onEach { /* ... */ }
+    .launchIn(coroutineScope)
+
+// Observing the refresh process
+pagination.refreshLoading
+    .onEach { /* ... */ }
+    .launchIn(coroutineScope)
+```
+
+
 ## Samples
-Please see more examples in the [sample directory](sample).
+Please see more examples in the [sample directory](sample) or [sample-declarative-ui](sample-declarative-ui)
 
 ## Set Up Locally 
-- The [paging directory](paging) contains the `paging` library;
+- The [paging-core directory](paging-core) contains the core - pagination logic & data sources;
+- The [paging-livedata directory](paging-livedata) contains implementation of the Pagination using `moko-mvvv-livedata`;
+- The [paging-flow directory](paging-flow) contains implementation of the Pagination using `kotlinx.coroutines`;
+- The [paging-state directory](paging-state) contains a set of code for working with the state of resources;
+- The [paging-test directory](paging-test) contains a set of tests for pagination;
 - The [sample directory](sample) contains sample apps for Android and iOS; plus the mpp-library connected to the apps.
 
 ## Contributing

build.gradle.kts

@@ -18,6 +18,7 @@ buildscript {
         classpath(libs.mobileMultiplatformGradlePlugin)
         classpath(libs.kotlinSerializationGradlePlugin)
         classpath(libs.mokoUnitsGeneratorGradlePlugin)
+        classpath(libs.mokoKSwiftGradle)
     }
 }
 

gradle/libs.versions.toml

@@ -7,10 +7,11 @@ recyclerViewVersion = "1.1.0"
 swipeRefreshLayoutVersion = "1.1.0"
 ktorClientVersion = "2.0.0"
 coroutinesVersion = "1.6.0-native-mt"
-mokoMvvmVersion = "0.12.0"
-mokoResourcesVersion = "0.18.0"
+mokoMvvmVersion = "0.13.0"
+mokoResourcesVersion = "0.20.1"
 mokoUnitsVersion = "0.8.0"
-mokoPagingVersion = "0.7.1"
+mokoKSwiftVersion = "0.5.0"
+mokoPagingVersion = "0.8.0"
 
 [libraries]
 appCompat = { module = "androidx.appcompat:appcompat", version.ref = "androidAppCompatVersion" }
@@ -24,6 +25,9 @@ mokoUnits = { module = "dev.icerock.moko:units", version.ref = "mokoUnitsVersion
 mokoUnitsDataBinding = { module = "dev.icerock.moko:units-databinding", version.ref = "mokoUnitsVersion" }
 mokoMvvmLiveData = { module = "dev.icerock.moko:mvvm-livedata", version.ref = "mokoMvvmVersion" }
 mokoMvvmState = { module = "dev.icerock.moko:mvvm-state", version.ref = "mokoMvvmVersion" }
+mokoMvvmFlow = { module = "dev.icerock.moko:mvvm-flow", version.ref = "mokoMvvmVersion" }
+mokoMvvmCore = { module = "dev.icerock.moko:mvvm-core", version.ref = "mokoMvvmVersion" }
+mokoMvvmFlowCompose = { module = "dev.icerock.moko:mvvm-flow-compose", version.ref = "mokoMvvmVersion" }
 kotlinTestJUnit = { module = "org.jetbrains.kotlin:kotlin-test-junit", version.ref = "kotlinVersion" }
 androidCoreTesting = { module = "androidx.arch.core:core-testing", version.ref = "androidCoreTestingVersion" }
 ktorClientMock = { module = "io.ktor:ktor-client-mock", version.ref = "ktorClientVersion" }
@@ -36,3 +40,5 @@ mokoGradlePlugin = { module = "dev.icerock.moko:moko-gradle-plugin", version = "
 mobileMultiplatformGradlePlugin = { module = "dev.icerock:mobile-multiplatform", version = "0.14.1" }
 kotlinSerializationGradlePlugin = { module = "org.jetbrains.kotlin:kotlin-serialization", version.ref = "kotlinVersion" }
 mokoUnitsGeneratorGradlePlugin = { module = "dev.icerock.moko:units-generator", version.ref = "mokoUnitsVersion" }
+
+mokoKSwiftGradle = { module = "dev.icerock.moko:kswift-gradle-plugin", version.ref = "mokoKSwiftVersion" }

paging-core/build.gradle.kts

@@ -0,0 +1,14 @@
+/*
+ * Copyright 2022 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+plugins {
+    id("dev.icerock.moko.gradle.multiplatform.mobile")
+    id("dev.icerock.moko.gradle.publication")
+    id("dev.icerock.moko.gradle.stub.javadoc")
+    id("dev.icerock.moko.gradle.detekt")
+}
+
+dependencies {
+    commonMainApi(libs.coroutines)
+}

paging-core/src/androidMain/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest package="dev.icerock.moko.paging.core" />

paging-core/src/commonMain/kotlin/dev/icerock/moko/paging/PagingDeprecated.kt

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2022 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.paging
+
+@Deprecated(
+    message = "deprecated due to package renaming",
+    replaceWith = ReplaceWith("IdEntity", "dev.icerock.moko.paging.core"),
+    level = DeprecationLevel.WARNING
+)
+typealias IdEntity = dev.icerock.moko.paging.core.IdEntity
+
+@Deprecated(
+    message = "deprecated due to package renaming",
+    replaceWith = ReplaceWith("IdComparator", "dev.icerock.moko.paging.core"),
+    level = DeprecationLevel.WARNING
+)
+typealias IdComparator<T> = dev.icerock.moko.paging.core.IdComparator<T>
+
+@Deprecated(
+    message = "deprecated due to package renaming",
+    replaceWith = ReplaceWith("LambdaPagedListDataSource", "dev.icerock.moko.paging.core"),
+    level = DeprecationLevel.WARNING
+)
+typealias LambdaPagedListDataSource<T> = dev.icerock.moko.paging.core.LambdaPagedListDataSource<T>
+
+@Deprecated(
+    message = "deprecated due to package renaming",
+    replaceWith = ReplaceWith("PagedListDataSource", "dev.icerock.moko.paging.core"),
+    level = DeprecationLevel.WARNING
+)
+typealias PagedListDataSource<T> = dev.icerock.moko.paging.core.PagedListDataSource<T>
+
+@Deprecated(
+    message = "deprecated due to package renaming",
+    replaceWith = ReplaceWith("ReachEndNotifierList", "dev.icerock.moko.paging.core"),
+    level = DeprecationLevel.WARNING
+)
+typealias ReachEndNotifierList<T> = dev.icerock.moko.paging.core.ReachEndNotifierList<T>

paging-core/src/commonMain/kotlin/dev/icerock/moko/paging/core/Identify.kt

@@ -0,0 +1,15 @@
+/*
+ * Copyright 2022 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.paging.core
+
+interface IdEntity {
+    val id: Long
+}
+
+class IdComparator<T : IdEntity> : Comparator<T> {
+    override fun compare(a: T, b: T): Int {
+        return if (a.id == b.id) 0 else 1
+    }
+}

paging/src/commonMain/kotlin/dev/icerock/moko/paging/LambdaPagedListDataSource.kt → paging-core/src/commonMain/kotlin/dev/icerock/moko/paging/core/LambdaPagedListDataSource.kt

@@ -2,7 +2,7 @@
  * Copyright 2020 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
  */
 
-package dev.icerock.moko.paging
+package dev.icerock.moko.paging.core
 
 class LambdaPagedListDataSource<T>(
     private val loadPageLambda: suspend (List<T>?) -> List<T>

paging/src/commonMain/kotlin/dev/icerock/moko/paging/PagedListDataSource.kt → paging-core/src/commonMain/kotlin/dev/icerock/moko/paging/core/PagedListDataSource.kt

@@ -2,7 +2,7 @@
  * Copyright 2020 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
  */
 
-package dev.icerock.moko.paging
+package dev.icerock.moko.paging.core
 
 interface PagedListDataSource<T> {
     suspend fun loadPage(currentList: List<T>?): List<T>