Update docs (#32)

be-hase · Jun 27, 2024 · 424bb85 · 424bb85
1 parent 37b2da3
commit 424bb85
Show file tree

Hide file tree

Showing 6 changed files with 90 additions and 108 deletions.
diff --git a/README.md b/README.md
@@ -44,34 +44,30 @@ writing is almost the same.
 data class User(...)
 
 class UserRepository(private val kueryClient: KueryClient) {
-    suspend fun findById(userId: Int): User? {
-        return kueryClient
-            .sql { +"SELECT * FROM users WHERE user_id = $userId" }
-            .singleOrNull()
-    }
-
-    suspend fun search(status: String, vip: Boolean?): List<User> {
-        return kueryClient
-            .sql {
-                +"SELECT * FROM users"
-                +"WHERE"
-                +"status = $status"
-                if (vip != null) {
-                    +"vip = $vip"
-                }
+    suspend fun findById(userId: Int): User? = kueryClient
+        .sql { +"SELECT * FROM users WHERE user_id = $userId" }
+        .singleOrNull()
+
+    suspend fun search(status: String, vip: Boolean?): List<User> = kueryClient
+        .sql {
+            +"""
+            SELECT * FROM users
+            WHERE
+            status = $status
+            """
+            if (vip != null) {
+                +"vip = $vip"
             }
-            .list()
-    }
-
-    suspend fun insertMany(users: List<User>): Long {
-        return kueryClient
-            .sql {
-                +"INSERT INTO users (username, email)"
-                // useful helper function
-                values(users) { listOf(it.username, it.email) }
-            }
-            .rowsUpdated()
-    }
+        }
+        .list()
+
+    suspend fun insertMany(users: List<User>): Long = kueryClient
+        .sql {
+            +"INSERT INTO users (username, email)"
+            // useful helper function
+            values(users) { listOf(it.username, it.email) }
+        }
+        .rowsUpdated()
 }
 ```
 

diff --git a/docs/detekt.md b/docs/detekt.md
@@ -42,7 +42,7 @@ Therefore, if you write it incorrectly as follows, problems may arise.
 #### Noncompliant Code:
 
 ```kotlin
-client.sql {
+kueryClient.sql {
     // BAD !!
     val sql = "SELECT * FROM user WHERE id = $id"
     +sql
@@ -52,7 +52,7 @@ client.sql {
 #### Compliant Code:
 
 ```kotlin
-client.sql {
+kueryClient.sql {
     +"SELECT * FROM user WHERE id = ${bind(id)}"
 }
 ```
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -35,69 +35,61 @@ writing is almost the same.
 data class User(...)
 
 class UserRepository(private val kueryClient: KueryClient) {
-    suspend fun findById(userId: Int): User? {
-        return kueryClient
-            .sql { +"SELECT * FROM users WHERE user_id = $userId" }
-            .singleOrNull()
-    }
-
-    suspend fun search(status: String, vip: Boolean?): List<User> {
-        return kueryClient
-            .sql {
-                +"SELECT * FROM users"
-                +"WHERE"
-                +"status = $status"
-                if (vip != null) {
-                    +"vip = $vip"
-                }
+    suspend fun findById(userId: Int): User? = kueryClient
+        .sql { +"SELECT * FROM users WHERE user_id = $userId" }
+        .singleOrNull()
+
+    suspend fun search(status: String, vip: Boolean?): List<User> = kueryClient
+        .sql {
+            +"""
+            SELECT * FROM users
+            WHERE
+            status = $status
+            """
+            if (vip != null) {
+                +"vip = $vip"
             }
-            .list()
-    }
-
-    suspend fun insertMany(users: List<User>): Long {
-        return kueryClient
-            .sql {
-                +"INSERT INTO users (username, email)"
-                // useful helper function
-                values(users) { listOf(it.username, it.email) }
-            }
-            .rowsUpdated()
-    }
+        }
+        .list()
+
+    suspend fun insertMany(users: List<User>): Long = kueryClient
+        .sql {
+            +"INSERT INTO users (username, email)"
+            // useful helper function
+            values(users) { listOf(it.username, it.email) }
+        }
+        .rowsUpdated()
 }
 ```
 
 ```kotlin [kuery-client-spring-data-jdbc]
 data class User(...)
 
 class UserRepository(private val kueryClient: KueryBlockingClient) {
-    fun findById(userId: Int): User? {
-        return kueryClient
-            .sql { +"SELECT * FROM users WHERE user_id = $userId" }
-            .singleOrNull()
-    }
-
-    fun search(status: String, vip: Boolean?): List<User> {
-        return kueryClient
-            .sql {
-                +"SELECT * FROM users"
-                +"WHERE"
-                +"status = $status"
-                if (vip != null) {
-                    +"vip = $vip"
-                }
-            }
-            .list()
-    }
-
-    fun insertMany(users: List<User>): Long {
-        return kueryClient
-            .sql {
-                +"INSERT INTO users (username, email)"
-                // useful helper function
-                values(users) { listOf(it.username, it.email) }
+    fun findById(userId: Int): User? = kueryClient
+        .sql { +"SELECT * FROM users WHERE user_id = $userId" }
+        .singleOrNull()
+
+    fun search(status: String, vip: Boolean?): List<User> = kueryClient
+        .sql {
+            +"""
+            SELECT * FROM users
+            WHERE
+            status = $status
+            """
+            if (vip != null) {
+                +"vip = $vip"
             }
-            .rowsUpdated()
-    }
+        }
+        .list()
+
+    fun insertMany(users: List<User>): Long = kueryClient
+        .sql {
+            +"INSERT INTO users (username, email)"
+            // useful helper function
+            values(users) { listOf(it.username, it.email) }
+        }
+        .rowsUpdated()
 }
 ```
 

diff --git a/docs/observation.md b/docs/observation.md
@@ -72,13 +72,11 @@ package com.example.spring.data.r2dbc
 
 @Repository
 class UserRepository(private val kueryClient: KueryClient) {
-    suspend fun selectByUserId(userId: Int): User? {
-        return kueryClient
-            .sql {
-                +"SELECT * FROM users WHERE user_id = $userId"
-            }
-            .singleOrNull()
-    }
+    suspend fun selectByUserId(userId: Int): User? = kueryClient
+        .sql {
+            +"SELECT * FROM users WHERE user_id = $userId"
+        }
+        .singleOrNull()
 }
 ```
 

diff --git a/docs/transaction.md b/docs/transaction.md
@@ -35,7 +35,7 @@ class UserService(
 }
 
 @Repository
-class UserRepository(private val client: KueryClient) {
+class UserRepository(private val kueryClient: KueryClient) {
     suspend fun insert(
         username: String,
         email: Email,
@@ -66,7 +66,7 @@ class UserService(
 }
 
 @Repository
-class UserRepository(private val client: KueryClient) {
+class UserRepository(private val kueryClient: KueryClient) {
     suspend fun insert(
         username: String,
         email: Email,
@@ -107,7 +107,7 @@ class UserService(
 }
 
 @Repository
-class UserRepository(private val client: KueryClient) {
+class UserRepository(private val kueryClient: KueryClient) {
     fun insert(
         username: String,
         email: Email,
@@ -138,7 +138,7 @@ class UserService(
 }
 
 @Repository
-class UserRepository(private val client: KueryClient) {
+class UserRepository(private val kueryClient: KueryClient) {
     fun insert(
         username: String,
         email: Email,

diff --git a/docs/type-conversion.md b/docs/type-conversion.md
@@ -45,23 +45,19 @@ val kueryClient = SpringR2dbcKueryClient.builder()
 ### Let's Try
 
 ```kotlin
-suspend fun write(str: StringWrapper) {
-    kueryClient
-        .sql {
-            +"INSERT INTO test_table (text) VALUES ($str)"
-        }
-        .rowsUpdated()
-}
+suspend fun write(str: StringWrapper): Long = kueryClient
+    .sql {
+        +"INSERT INTO test_table (text) VALUES ($str)"
+    }
+    .rowsUpdated()
 
 data class Record(
     val text: StringWrapper,
 )
 
-suspend fun read(): List<Record> {
-    return kueryClient
-        .sql {
-            +"SELECT * FROM test_table"
-        }
-        .list()
-}
+suspend fun read(): List<Record> = kueryClient
+    .sql {
+        +"SELECT * FROM test_table"
+    }
+    .list()
 ```