Merge pull request #34 from mori-atsushi/v0.0.3

Prepar for v0.0.3

Author: mori-atsushi

README.md

@@ -29,7 +29,7 @@ Enable the Gradle plugin for the module where you want to use this library.
 // build.gradle.kts
 plugins {
     kotlin(/* ... */)
-    id("com.moriatsushi.cacheable") version "0.0.2"
+    id("com.moriatsushi.cacheable") version "0.0.3"
 }
 ```
 
@@ -38,11 +38,11 @@ You also need to add the `cacheable-core` dependency to the module.
 ```kotlin
 // build.gradle.kts
 dependencies {
-    implementation("com.moriatsushi.cacheable:cacheable-core:0.0.2")
+    implementation("com.moriatsushi.cacheable:cacheable-core:0.0.3")
 }
 ```
 
-## Usage
+## Basic Usage
 
 You can use `@Cacheable` annotation to cache the result of specified functions.
 When you call a function with this annotation, it will return the cached value if the function is
@@ -69,26 +69,32 @@ fun getSomething(key: String): Something =
 If you use the cacheable function within a class, the cache is only shared within an instance of the
 class.
 
-In addition, if you specify `maxCount` parameter, the number of cached values will be limited to the
-specified value.
-If the number of cached values exceeds the specified value, the cache with the oldest access time
-will be removed.
+You can also use `@Cacheable` annotation for a suspend function.
 
 ```kotlin
-class SomeClass {
-    @Cacheable(maxCount = 10)
-    fun getSomething(key: String): Something {
-        // ...
-    }
+class Repository(private val api: Api) {
+    @Cacheable
+    suspend fun getUser(id: String): User =
+        api.getUser(id)
 }
 ```
 
-You can also use `@Cacheable` annotation for a suspend function.
+## APIs
+There are 2 parameters you can specify to `@Cacheable` annotation.
+
+* `maxCount`: The maximum number of cached values. If the number of cached values exceeds this
+  value, the cache with the oldest access time will be removed. If you don't specify this parameter,
+  the number of cached values will be unlimited.
+* `lock`: When this is `true`, the function is guaranteed to be called only once even if the
+  function is called multiple times with the same arguments at the same time. Otherwise, the
+  function may be called multiple times with the same arguments at the same time. The default value
+  is false.
 
 ```kotlin
-class Repository(private val api: Api) {
-    @Cacheable(maxCount = 10)
-    suspend fun getUser(id: String): User =
-        api.getUser(id)
+class SomeClass {
+    @Cacheable(maxCount = 10, lock = true)
+    fun getSomething(key: String): Something {
+        // ...
+    }
 }
 ```

cacheable-gradle-plugin/src/main/kotlin/com/moriatsushi/cacheable/gradle/plugin/CacheableCompilerPluginSupportPlugin.kt

@@ -17,7 +17,7 @@ class CacheableCompilerPluginSupportPlugin : KotlinCompilerPluginSupportPlugin {
     override fun getPluginArtifact(): SubpluginArtifact = SubpluginArtifact(
         groupId = "com.moriatsushi.cacheable",
         artifactId = "cacheable-compiler",
-        version = "0.0.2",
+        version = "0.0.3",
     )
 
     override fun isApplicable(kotlinCompilation: KotlinCompilation<*>): Boolean = true

gradle.properties

@@ -10,7 +10,7 @@ kotlin.mpp.androidSourceSetLayoutVersion=2
 SONATYPE_HOST=S01
 RELEASE_SIGNING_ENABLED=false
 GROUP=com.moriatsushi.cacheable
-VERSION_NAME=0.0.2
+VERSION_NAME=0.0.3
 
 POM_NAME=Kotlin Cacheable
 POM_DESCRIPTION=An annotation-based cache library for Kotlin Multiplatform.

test/build.gradle.kts

@@ -2,7 +2,7 @@ import org.jetbrains.kotlin.gradle.dsl.KotlinCompile
 
 plugins {
     alias(libs.plugins.kotlin.multiplatform)
-    id("com.moriatsushi.cacheable") version "0.0.2"
+    id("com.moriatsushi.cacheable") version "0.0.3"
 }
 
 kotlin {