README.md

VersionKontrol

Kotlin Version Checker

A tiny Kotlin library to determine if a version string is newer when compared to another.

Example

import uk.co.edgeorgedev.versionkontrol.toVersionCode
import kotlin.io.println as eval

fun main(args: Array<String>) {
    // Basic Example
    val exampleVersion = "1.0.2".toVersionCode()
    val exampleNewVersion = "1.1.0".toVersionCode()
    
    // Comparable using standard ==, !=, <, >, <=, >= operators
    eval ( exampleNewVersion > exampleVersion )
    eval ( exampleNewVersion )
    
    // Helper String extensions are also available
    val rawVersionString = "2.3.1"
    val rawVersionOlderString = "2.3.0"
    
    eval( rawVersionOlderString.isOlderVersionThan(rawVersionString) )
    eval( rawVersionString.isNewerVersionThan(rawVersionOlderString) )
}

Why & when should I use this?

This library is especially helpful in checking if an application requires a force upgrade/update e.g. when a user's current version contains breaking changes

Build

The latest snapshot version can also be found on Jitpack

Gradle

To get the latest build, use the following in your root build.gradle at the end of repositories:

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

dependencies {
    compile 'com.github.ed-george:VersionKontrol:0.1.0'
}

Maven

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.github.ed-george</groupId>
    <artifactId>VersionKontrol</artifactId>
    <version>0.1.0</version>
</dependency>

Advanced usage

The library currently uses \p{Punct}+ as the default delimiter regular expression within a version string, although this can be changed easily

import uk.co.edgeorgedev.versionkontrol.toVersionCode

fun main(args: Array<String>) {

    // The current version
    val myCurrentVersion = "1x0x0".toVersionCode(delimiter = "x")

    // The updated version
    val myUpdatedVersion = "1x0x1".toVersionCode(delimiter = "x")

    //...
}

Please note, the custom delimiter string is converted to a regular expression

Contributing

I welcome contributions and discussion for new features or bug fixes. It is recommended to file an issue first to prevent unnecessary efforts, but feel free to put in pull requests in the case of trivial changes. In any other case, please feel free to open discussion and I will get back to you when possible.