jeziellago/kachej

An alternative to building cache easily backed by Kotlin coroutines 📦.

Kachej

Write objects as files (to cache purpose) backed by Kotlin coroutines.

Why?

• This tool is an alternative to build cache without intermediate format (as JSON, XML or other).
• Why not? 😎

How it works?

Transform objects in files to cache them, to restore after, or make anything.

// Create Serializable object
data class User(val name: String, val lastName: String) : Serializable

val user = User("Jeziel", "Lago")

Put objects

Create Cache instance:

val cache = Cache.of(
    parentDir = File("/cache/users"),
    timeToLive = 60,
    liveUnit = TimeUnit.MINUTES
)

Put single object:

// create file "user_123"
cache.put("user_123", user)
    .catch { error -> /* error */ }
    .collect { /* success */ }

Put Collection:

// create file "user_collection"
val userCollection = cacheOf(user1, user2, ...)

cache.put("user_collection", userCollection)
    .catch { error -> /* error */ }
    .collect { /* success */ }

Put Map:

// create file "user_map"
val userMap = cacheOf(
    "bob" to user1,
    "ana" to user2
)

cache.put("user_map", userMap)
    .catch { error -> /* error */ }
    .collect { /* success */ }

Get objects

Single object

cache.get<User>("user_123")
    .catch { error -> /* error */ }
    .collect { user -> /* success */ }

Collection

cache.get<CacheableList<User>>("user_collection")
    .catch { error -> /* error */ }
    .collect { list -> /* success */ }

Map

cache.get<CacheableMap>("user_map")
    .catch { error -> /* error */ }
    .collect { map -> /* success */ }

Clear

cache.clear("user_collection")
    .catch { error -> /* error */ }
    .collect { /* success */ }

or

cache.clearAll()
    .catch { error -> /* error */ }
    .collect { /* success */ }

Dependency

• Project build.gradle

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

• Module build.gradle

dependencies {
    implementation 'com.github.jeziellago:kachej:VERSION`
}