Change fun newBuilder to operator fun invoke (#7)

* Change `fun newBuilder` to `operator fun invoke`

* Cleanup README.md format and CHANGLOG.

Co-authored-by: Yang <[email protected]>

.editorconfig

@@ -0,0 +1,19 @@
+root = true
+
+[*]
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+
+[*.yml]
+indent_size = 2
+
+[*.kts]
+max_line_length = 200
+
+[*.md]
+max_line_length = 200
+
+[*.kt]
+ij_kotlin_name_count_to_use_star_import = 2147483647
+ij_kotlin_name_count_to_use_star_import_for_members = 2147483647

CHANGELOG.md

@@ -1,14 +1,23 @@
 # Change Log
 
+## Unreleased
+
+### Changed
+
+- Change `fun newBuilder()` to `operator fun invoke()` - [#7](https://github.com/ReactiveCircus/cache4k/pull/7).
+- Compile with Kotlin 1.5.21.
+
 ## 0.2.0
 
 ### Changed
+
 - Support Kotlin 1.5.0.
 - Stately to 1.1.7.
 
 ## 0.1.1
 
 ### Changed
+
 - Disable IR.
 
 ## 0.1.0

README.md

@@ -55,7 +55,7 @@ kotlin {
 To create a new `Cache` instance using `Long` for the key and `String` for the value:
 
 ```kotlin
-val cache = Cache.Builder.newBuilder().build<Long, String>()
+val cache = Cache.Builder().build<Long, String>()
 ```
 
 To start writing entries to the cache:
@@ -87,7 +87,7 @@ cache.get(1) // returns "bird"
 
 ```kotlin
 runBlockingTest {
-    val cache = Cache.Builder.newBuilder().build<Long, User>()
+    val cache = Cache.Builder().build<Long, User>()
 
     val userId = 1L
     val user = cache.get(userId) {
@@ -111,10 +111,12 @@ Expiration time can be specified for entries in the cache.
 
 ##### Expire after access
 
-To set the maximum time an entry can live in the cache since the last access (also known as **time-to-idle**), where "access" means **reading the cache**, **adding a new cache entry**, or **replacing an existing entry with a new one**:
+To set the maximum time an entry can live in the cache since the last access (also known as **
+time-to-idle**), where "access" means **reading the cache**, **adding a new cache entry**, or **
+replacing an existing entry with a new one**:
 
 ```kotlin
-val cache = Cache.Builder.newBuilder()
+val cache = Cache.Builder()
     .expireAfterAccess(24.hours)
     .build<Long, String>()
 ```
@@ -123,10 +125,11 @@ An entry in this cache will be removed if it has not been read or replaced **aft
 
 ##### Expire after write
 
-To set the maximum time an entry can live in the cache since the last write (also known as **time-to-live**), where "write" means **adding a new cache entry** or **replacing an existing entry with a new one**:
+To set the maximum time an entry can live in the cache since the last write (also known as **
+time-to-live**), where "write" means **adding a new cache entry** or **replacing an existing entry with a new one**:
 
 ```kotlin
-val cache = Cache.Builder.newBuilder()
+val cache = Cache.Builder()
     .expireAfterWrite(30.minutes)
     .build<Long, String>()
 ```
@@ -140,21 +143,22 @@ _Note that cache entries are **not** removed immediately upon expiration at exac
 To set the maximum number of entries to be kept in the cache:
 
 ```kotlin
-val cache = Cache.Builder.newBuilder()
+val cache = Cache.Builder()
     .maximumCacheSize(100)
     .build<Long, String>()
 ```
 
-Once there are more than **100** entries in this cache, the **least recently used one** will be removed, where "used" means **reading the cache**, **adding a new cache entry**, or **replacing an existing entry with a new one**.
+Once there are more than **100** entries in this cache, the **least recently used one** will be removed, where "used" means **reading the cache**, **adding a new cache entry**, or **replacing an
+existing entry with a new one**.
 
 ### Getting all cache entries as a Map
 
 To get a copy of the current cache entries as a `Map`:
 
 ```kotlin
-val cache = Cache.Builder.newBuilder()
+val cache = Cache.Builder()
     .build<Long, String>()
-    
+
 cache.put(1, "dog")
 cache.put(2, "cat")
 
@@ -171,7 +175,7 @@ Cache entries can also be deleted explicitly.
 To delete a cache entry for a given key:
 
 ```kotlin
-val cache = Cache.Builder.newBuilder().build<Long, String>()
+val cache = Cache.Builder().build<Long, String>()
 cache.put(1, "dog")
 
 cache.invalidate(1)
@@ -187,13 +191,14 @@ cache.invalidateAll()
 
 ### Unit testing cache expirations
 
-To test logic that depends on cache expiration, pass in a `FakeTimeSource` when building a `Cache` so you can programmatically advance the reading of the time source:
+To test logic that depends on cache expiration, pass in a `FakeTimeSource` when building a `Cache`
+so you can programmatically advance the reading of the time source:
 
 ```kotlin
 @Test
 fun cacheEntryEvictedAfterExpiration() {
     private val fakeTimeSource = FakeTimeSource()
-    val cache = Cache.Builder.newBuilder()
+    val cache = Cache.Builder()
         .fakeTimeSource(fakeTimeSource)
         .expireAfterWrite(1.minutes)
         .build<Long, String>()
@@ -216,7 +221,8 @@ fun cacheEntryEvictedAfterExpiration() {
 
 ## Credits
 
-The library was ported from a kotlin / JVM cache which I contributed to [dropbox/Store](https://github.com/dropbox/Store) to help unblock Store's multiplatform support (it was reverted before the 1.0 release as multiplatform wasn't a priority). Many thanks to Store's owners and contributors for reviewing and improving the original implementation.
+The library was ported from a kotlin / JVM cache which I contributed to [dropbox/Store](https://github.com/dropbox/Store) to help unblock Store's multiplatform support (
+it was reverted before the 1.0 release as multiplatform wasn't a priority). Many thanks to Store's owners and contributors for reviewing and improving the original implementation.
 
 Native concurrency support of the library is powered by [touchlab/Stately](https://github.com/touchlab/Stately). Many thanks to Stately's authors and contributors for the great library.
 

cache4k/api/cache4k.api

@@ -17,7 +17,7 @@ public abstract interface class io/github/reactivecircus/cache4k/Cache$Builder {
 }
 
 public final class io/github/reactivecircus/cache4k/Cache$Builder$Companion {
-	public final fun newBuilder ()Lio/github/reactivecircus/cache4k/Cache$Builder;
+	public final fun invoke ()Lio/github/reactivecircus/cache4k/Cache$Builder;
 }
 
 public final class io/github/reactivecircus/cache4k/FakeTimeSource : kotlin/time/AbstractLongTimeSource {

cache4k/src/commonMain/kotlin/io/github/reactivecircus/cache4k/Cache.kt

@@ -96,7 +96,7 @@ public interface Cache<in Key : Any, Value : Any> {
             /**
              * Returns a new [Cache.Builder] instance.
              */
-            public fun newBuilder(): Builder = CacheBuilderImpl()
+            public operator fun invoke(): Builder = CacheBuilderImpl()
         }
     }
 }

cache4k/src/commonTest/kotlin/io/github/reactivecircus/cache4k/CacheBuilderTest.kt

@@ -6,14 +6,13 @@ import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 import kotlin.time.Duration
 import kotlin.time.TimeSource
-import kotlin.time.hours
 
 class CacheBuilderTest {
 
     @Test
     fun expireAfterWrite_zeroDuration() {
         val exception = assertFailsWith<IllegalArgumentException> {
-            Cache.Builder.newBuilder()
+            Cache.Builder()
                 .expireAfterWrite(Duration.nanoseconds(0))
                 .build<Any, Any>()
         }
@@ -23,7 +22,7 @@ class CacheBuilderTest {
 
     @Test
     fun expireAfterWrite_positiveDuration() {
-        val cache = Cache.Builder.newBuilder()
+        val cache = Cache.Builder()
             .expireAfterWrite(Duration.hours(24))
             .build<Any, Any>() as RealCache
 
@@ -33,7 +32,7 @@ class CacheBuilderTest {
     @Test
     fun expireAfterWrite_negativeDuration() {
         val exception = assertFailsWith<IllegalArgumentException> {
-            Cache.Builder.newBuilder()
+            Cache.Builder()
                 .expireAfterWrite(Duration.nanoseconds((-1)))
                 .build<Any, Any>() as RealCache
         }
@@ -44,7 +43,7 @@ class CacheBuilderTest {
     @Test
     fun expireAfterAccess_zeroDuration() {
         val exception = assertFailsWith<IllegalArgumentException> {
-            Cache.Builder.newBuilder()
+            Cache.Builder()
                 .expireAfterAccess(Duration.nanoseconds(0))
                 .build<Any, Any>() as RealCache
         }
@@ -54,7 +53,7 @@ class CacheBuilderTest {
 
     @Test
     fun expireAfterAccess_positiveDuration() {
-        val cache = Cache.Builder.newBuilder()
+        val cache = Cache.Builder()
             .expireAfterAccess(Duration.hours(24))
             .build<Any, Any>() as RealCache
 
@@ -64,7 +63,7 @@ class CacheBuilderTest {
     @Test
     fun expireAfterAccess_negativeDuration() {
         val exception = assertFailsWith<IllegalArgumentException> {
-            Cache.Builder.newBuilder()
+            Cache.Builder()
                 .expireAfterAccess(Duration.nanoseconds(-1))
                 .build<Any, Any>() as RealCache
         }
@@ -74,7 +73,7 @@ class CacheBuilderTest {
 
     @Test
     fun maximumCacheSize_zero() {
-        val cache = Cache.Builder.newBuilder()
+        val cache = Cache.Builder()
             .maximumCacheSize(0)
             .build<Any, Any>() as RealCache
 
@@ -83,7 +82,7 @@ class CacheBuilderTest {
 
     @Test
     fun maximumCacheSize_positiveValue() {
-        val cache = Cache.Builder.newBuilder()
+        val cache = Cache.Builder()
             .maximumCacheSize(10)
             .build<Any, Any>() as RealCache
 
@@ -93,7 +92,7 @@ class CacheBuilderTest {
     @Test
     fun maximumCacheSize_negativeValue() {
         val exception = assertFailsWith<IllegalArgumentException> {
-            Cache.Builder.newBuilder()
+            Cache.Builder()
                 .maximumCacheSize(-1)
                 .build<Any, Any>() as RealCache
         }
@@ -104,7 +103,7 @@ class CacheBuilderTest {
     @Test
     fun fakeTimeSource() {
         val fakeTimeSource = FakeTimeSource()
-        val cache = Cache.Builder.newBuilder()
+        val cache = Cache.Builder()
             .fakeTimeSource(fakeTimeSource)
             .build<Any, Any>() as RealCache
 
@@ -113,7 +112,7 @@ class CacheBuilderTest {
 
     @Test
     fun buildWithDefaults() {
-        val cache = Cache.Builder.newBuilder().build<Any, Any>() as RealCache
+        val cache = Cache.Builder().build<Any, Any>() as RealCache
 
         assertEquals(Duration.INFINITE, cache.expireAfterWriteDuration)
         assertEquals(Duration.INFINITE, cache.expireAfterAccessDuration)

cache4k/src/commonTest/kotlin/io/github/reactivecircus/cache4k/CacheEvictionTest.kt

@@ -8,7 +8,7 @@ class CacheEvictionTest {
 
     @Test
     fun maxSizeLimitReached_addNewEntry_oldEntryEvicted() {
-        val cache = Cache.Builder.newBuilder()
+        val cache = Cache.Builder()
             .maximumCacheSize(2)
             .build<Long, String>()
 
@@ -33,7 +33,7 @@ class CacheEvictionTest {
 
     @Test
     fun maxSizeLimitReached_replaceCacheEntry_doesNotEvict() {
-        val cache = Cache.Builder.newBuilder()
+        val cache = Cache.Builder()
             .maximumCacheSize(2)
             .build<Long, String>()
 
@@ -50,7 +50,7 @@ class CacheEvictionTest {
 
     @Test
     fun readCacheEntry_accessOrderChanged() {
-        val cache = Cache.Builder.newBuilder()
+        val cache = Cache.Builder()
             .maximumCacheSize(3)
             .build<Long, String>()
 
@@ -73,7 +73,7 @@ class CacheEvictionTest {
 
     @Test
     fun replaceCacheValue_accessOrderChanged() {
-        val cache = Cache.Builder.newBuilder()
+        val cache = Cache.Builder()
             .maximumCacheSize(3)
             .build<Long, String>()
 
@@ -99,7 +99,7 @@ class CacheEvictionTest {
 
     @Test
     fun maximumCacheSizeIsOne_addNewEntry_existingEntryEvicted() {
-        val cache = Cache.Builder.newBuilder()
+        val cache = Cache.Builder()
             .maximumCacheSize(1)
             .build<Long, String>()
 
@@ -121,7 +121,7 @@ class CacheEvictionTest {
 
     @Test
     fun maximumCacheSizeIsZero_noValuesCached() {
-        val cache = Cache.Builder.newBuilder()
+        val cache = Cache.Builder()
             .maximumCacheSize(0)
             .build<Long, String>()