Introduce CrudRepositoryWithContextParameters interface, refactor RepositoryProcessor for context parameter support, and update Gradle build with language feature enablement.

Author: smyrgeorge

sqlx4k-codegen/src/jvmMain/kotlin/io/github/smyrgeorge/sqlx4k/processor/RepositoryProcessor.kt

@@ -181,20 +181,24 @@ class RepositoryProcessor(
      */
     private fun parseRepositoryAnnotation(repo: KSClassDeclaration): Pair<KSClassDeclaration, String> {
         fun implementsCrudRepository(repo: KSClassDeclaration): KSClassDeclaration {
-            // find CrudRepository<T>
+            val repoTypeName =
+                if (ENABLE_CONTEXT_PARAMETERS) TypeNames.CRUD_REPOSITORY_WITH_CONTEXT_PARAMETERS
+                else TypeNames.CRUD_REPOSITORY
+            val repoSimpleName = repoTypeName.substringAfterLast(".")
+            // find CrudRepository<T> or CrudRepositoryWithContextParameters<T>
             val st = repo.superTypes.map { it.resolve() }
-                .firstOrNull { it.declaration.qualifiedName() == TypeNames.CRUD_REPOSITORY }
-                ?: error("@Repository interface ${repo.qualifiedName()} must extend ${TypeNames.CRUD_REPOSITORY}<T>")
+                .firstOrNull { it.declaration.qualifiedName() == repoTypeName }
+                ?: error("@Repository interface ${repo.qualifiedName()} must extend $repoTypeName<T>")
             val typeArg = st.arguments.firstOrNull()?.type?.resolve()
-                ?: error("${repo.qualifiedName()} implements CrudRepository without type argument; expected CrudRepository<T>")
+                ?: error("${repo.qualifiedName()} implements $repoSimpleName without type argument; expected $repoSimpleName<T>")
             val domainDecl = typeArg.declaration as? KSClassDeclaration
-                ?: error("CrudRepository type argument must be a class on ${repo.qualifiedName()}")
+                ?: error("$repoSimpleName type argument must be a class on ${repo.qualifiedName()}")
             // ensure @Table
             val hasTable = domainDecl.annotations.any {
                 val qn = it.qualifiedName()
                 qn == TypeNames.TABLE_ANNOTATION
             }
-            if (!hasTable) error("CrudRepository generic parameter must be @Table-annotated (${domainDecl.qualifiedName()})")
+            if (!hasTable) error("$repoSimpleName generic parameter must be @Table-annotated (${domainDecl.qualifiedName()})")
             return domainDecl
         }
 
@@ -510,7 +514,11 @@ class RepositoryProcessor(
             when (val idQn = idProp.type.resolve().declaration.qualifiedName()) {
                 TypeNames.KOTLIN_INT, TypeNames.KOTLIN_LONG -> {
                     val zeroLiteral = if (idQn == TypeNames.KOTLIN_INT) "0" else "0L"
-                    file += "        if (entity.$idName == $zeroLiteral) insert(context, entity) else update(context, entity)\n"
+                    file += if (ENABLE_CONTEXT_PARAMETERS) {
+                        "        if (entity.$idName == $zeroLiteral) insert(entity) else update(entity)\n"
+                    } else {
+                        "        if (entity.$idName == $zeroLiteral) insert(context, entity) else update(context, entity)\n"
+                    }
                     file += "    }\n"
                 }
 

sqlx4k-codegen/src/jvmMain/kotlin/io/github/smyrgeorge/sqlx4k/processor/TypeNames.kt

@@ -13,6 +13,7 @@ object TypeNames {
 
     // Core interfaces/classes
     const val CRUD_REPOSITORY = "io.github.smyrgeorge.sqlx4k.CrudRepository"
+    const val CRUD_REPOSITORY_WITH_CONTEXT_PARAMETERS = "io.github.smyrgeorge.sqlx4k.CrudRepositoryWithContextParameters"
     const val QUERY_EXECUTOR = "io.github.smyrgeorge.sqlx4k.QueryExecutor"
     const val STATEMENT = "io.github.smyrgeorge.sqlx4k.Statement"
 

sqlx4k/build.gradle.kts

@@ -7,6 +7,9 @@ plugins {
 kotlin {
     @Suppress("unused")
     sourceSets {
+        all {
+            languageSettings.enableLanguageFeature("ContextParameters")
+        }
         configureEach {
             languageSettings.progressiveMode = true
         }

sqlx4k/src/commonMain/kotlin/io/github/smyrgeorge/sqlx4k/CrudRepository.kt

@@ -53,10 +53,16 @@ interface CrudRepository<T> {
     suspend fun delete(context: QueryExecutor, entity: T): Result<Unit>
 
     /**
-     * Saves the given entity using the specified driver context.
+     * Saves the given entity to the data source using the specified driver context.
      *
-     * Performs an insert or an update depending on the value of the `@Id` property.
-     * Implementations decide whether to insert or update.
+     * This method determines whether to perform an insert or update operation based on the entity's state.
+     * If the operation is successful, the result will contain the saved entity.
+     * In case of failure, the result contains the error details.
+     *
+     * @param context The database driver context used to execute the save operation.
+     * @param entity The entity of type [T] to be saved in the data source.
+     * @return A [Result] containing the saved entity of type [T] if the operation is successful,
+     *         or an error if the operation fails.
      */
     suspend fun save(context: QueryExecutor, entity: T): Result<T>
 }

sqlx4k/src/commonMain/kotlin/io/github/smyrgeorge/sqlx4k/CrudRepositoryWithContextParameters.kt

@@ -0,0 +1,68 @@
+package io.github.smyrgeorge.sqlx4k
+
+/**
+ * Interface defining a contract for basic CRUD (Create, Read, Update, Delete) operations on a data source.
+ *
+ * This interface abstracts common operations to be implemented for handling entities of type [T].
+ * Each operation is asynchronous and returns a [Result], encapsulating either the successful result
+ * or an error in case of failure.
+ *
+ * @param T The type of the entity managed by the repository.
+ */
+interface CrudRepositoryWithContextParameters<T> {
+    /**
+     * Inserts the given entity into the data source using the specified driver context.
+     *
+     * This method performs an asynchronous insert operation and returns the result.
+     * If the operation is successful, the result will contain the inserted entity.
+     * In case of failure, the result contains the error details.
+     *
+     * @param entity The entity of type [T] to be inserted into the data source.
+     * @return A [Result] containing the inserted entity of type [T] if the operation is successful,
+     *         or an error if the operation fails.
+     */
+    context(context: QueryExecutor)
+    suspend fun insert(entity: T): Result<T>
+
+    /**
+     * Updates the given entity in the data source using the specified driver context.
+     *
+     * This method performs an asynchronous update operation and returns the result.
+     * If the operation is successful, the result will contain the updated entity.
+     * In case of failure, the result contains the error details.
+     *
+     * @param entity The entity of type [T] to be updated in the data source.
+     * @return A [Result] containing the updated entity of type [T] if the operation is successful,
+     *         or an error if the operation fails.
+     */
+    context(context: QueryExecutor)
+    suspend fun update(entity: T): Result<T>
+
+    /**
+     * Deletes the given entity from the data source using the specified driver context.
+     *
+     * This method performs an asynchronous delete operation and returns the result.
+     * If the operation is successful, the result will contain a successful unit value.
+     * In case of failure, the result contains the error details.
+     *
+     * @param entity The entity of type [T] to be deleted from the data source.
+     * @return A [Result] containing a [Unit] value if the operation is successful,
+     *         or an error if the operation fails.
+     */
+    context(context: QueryExecutor)
+    suspend fun delete(entity: T): Result<Unit>
+
+    /**
+     * Saves the given entity to the data source using the specified driver context.
+     *
+     * This method determines whether to perform an insert or update operation based on the entity's state.
+     * If the operation is successful, the result will contain the saved entity.
+     * In case of failure, the result contains the error details.
+     *
+     * @param entity The entity of type [T] to be saved in the data source.
+     * @return A [Result] containing the saved entity of type [T] if the operation is successful,
+     *         or an error if the operation fails.
+     */
+    context(context: QueryExecutor)
+    suspend fun save(entity: T): Result<T>
+}