Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tetraquark/myersdiffkt
Kotlin Multiplatform library implements Myers algorithm for diff calculations.
https://github.com/tetraquark/myersdiffkt
diff diff-calculations kotlin kotlin-multiplatform kotlin-multiplatform-library myers-algorithm
Last synced: 2 months ago
JSON representation
Kotlin Multiplatform library implements Myers algorithm for diff calculations.
- Host: GitHub
- URL: https://github.com/tetraquark/myersdiffkt
- Owner: Tetraquark
- License: mit
- Created: 2020-02-19T14:27:52.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-23T14:56:08.000Z (over 4 years ago)
- Last Synced: 2023-09-13T06:28:55.179Z (over 1 year ago)
- Topics: diff, diff-calculations, kotlin, kotlin-multiplatform, kotlin-multiplatform-library, myers-algorithm
- Language: Kotlin
- Homepage:
- Size: 145 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## MyersDiffKt
[  ](https://bintray.com/tetraquark/kmplibs/MyersDiffKt/_latestVersion)
Kotlin Multiplatform library implements iterative Myers algorithm for diff calculations without the second pass for moves detection.
The algorithm is implemented in common source set, so it can be used in any supported platform.
The main part of the algorithm implementation is rewritten to Kotlin from the Android Java library - [DiffUtil](https://developer.android.com/reference/android/support/v7/util/DiffUtil).
### Versions
Library version | Kotlin version
------------ | -------------
1.2.0 | 1.4.0
1.1.0 | 1.3.72
1.0.0 | 1.3.61
## Setup
In root **build.gradle.kts** add the maven repository url:
```kotlin
allprojects {
repositories {
maven { url = uri("https://dl.bintray.com/tetraquark/kmplibs") }
}
}
```
or in root **build.gradle**
```groovy
allprojects {
repositories {
maven { url "https://dl.bintray.com/tetraquark/kmplibs" }
}
}
```
Then in a project **build.gradle.kts**:
```kotlin
dependencies {
implementation("ru.tetraquark.kmplibs:MyersDiffKt:1.2.0")
}
```
or in a project **build.gradle**:
```groovy
dependencies {
implementation "ru.tetraquark.kmplibs:MyersDiffKt:1.2.0"
}
```
## Usage
To calculate difference for two lists, use `DiffUtil` singleton object. There are two public functions:
```kotlin
suspend fun diffFlow(
oldListSize: Int,
newListSize: Int,
comparator: (oldItemIndex: Int, newItemIndex: Int) -> Boolean
): Flow
```
```kotlin
fun diffCallback(
oldListSize: Int,
newListSize: Int,
comparator: (oldItemIndex: Int, newItemIndex: Int) -> Boolean
): DiffResult
```
`diffFlow` function is suspendable and returns `Flow` instance, so difference calculations can be implemented in asynchronus style using Kotlin coroutines.
`diffCallback` function returns `DiffResult` object that holds a calculation results.
Use example for `diffFlow` function:
```kotlin
launch {
DiffUtil.diffFlow(oldList.size, newList.size) { oldItemIndex, newItemIndex ->
oldList[oldItemIndex] == newList[newItemIndex]
}
.flowOn(Dispatchers.Default)
.collect { change ->
applyChangeToLists(resultList, newList, change)
}
}
```
There is simple example of Android application in **sample-android** module that uses the library to calculating and applying differences for RecyclerView content.