Merge pull request #156 from InsertKoinIO/check_kmp_fix

KMP Code Generation Fix + Revamp Code Generation

examples/android-coffee-maker/build.gradle.kts

@@ -48,5 +48,5 @@ dependencies {
 
 ksp {
     arg("KOIN_CONFIG_CHECK","true")
-    arg("KOIN_DEFAULT_MODULE","false")
+    arg("KOIN_DEFAULT_MODULE","true")
 }

examples/android-coffee-maker/src/main/java/org/koin/sample/androidx/app/MyPresenter.kt

@@ -10,4 +10,7 @@ import org.koin.sample.androidx.data.ProvidedComponent
 class MyProvidedComponent
 
 @Factory
-class MyPresenter(@InjectedParam val mainActivity: MainActivity, val context: Context, @Provided val provided : MyProvidedComponent)
+class MyPresenter(@InjectedParam val mainActivity: MainActivity, val context: Context, @Provided val provided : MyProvidedComponent)
+
+@Factory
+class MyPresenterHolder(val mp : MyPresenter)

examples/android-coffee-maker/src/test/java/AndroidModuleTest.kt

@@ -1,17 +1,16 @@
 package org.koin.sample.androidx
 
 import org.junit.Test
-import org.koin.android.ext.android.getKoin
 import org.koin.core.context.startKoin
 import org.koin.core.context.stopKoin
+import org.koin.core.parameter.parametersOf
 import org.koin.ksp.generated.module
 import org.koin.sample.android.library.CommonRepository
 import org.koin.sample.android.library.MyScope
 import org.koin.sample.androidx.app.MyPresenter
 import org.koin.sample.androidx.app.ScopedStuff
 import org.koin.sample.androidx.data.DataConsumer
 import org.koin.sample.androidx.data.MyDataConsumer
-import org.koin.sample.androidx.data.ProvidedComponent
 import org.koin.sample.androidx.di.AppModule
 import org.koin.sample.androidx.di.DataModule
 import org.koin.sample.androidx.repository.RepositoryModule

examples/android-library/build.gradle.kts

@@ -35,5 +35,5 @@ dependencies {
 
 ksp {
     arg("KOIN_CONFIG_CHECK","true")
-    arg("KOIN_DEFAULT_MODULE","false")
+    arg("KOIN_DEFAULT_MODULE","true")
 }

examples/gradle/libs.versions.toml

@@ -5,7 +5,7 @@
 # Core
 kotlin = "1.9.24"
 koin = "3.5.6"
-koinAnnotations = "1.4.0-RC3"
+koinAnnotations = "1.4.0-RC4"
 ksp = "1.9.24-1.0.20"
 junit = "4.13.2"
 # Android

projects/gradle.properties

@@ -7,7 +7,7 @@ org.gradle.parallel=true
 #Kotlin
 kotlin.code.style=official
 #Koin
-koinAnnotationsVersion=1.4.0-RC3
+koinAnnotationsVersion=1.4.0-RC4
 #Android
 android.useAndroidX=true
 androidMinSDK=14

projects/koin-ksp-compiler/build.gradle.kts

@@ -20,4 +20,10 @@ kotlin {
     }
 }
 
+tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
+    kotlinOptions {
+        freeCompilerArgs += listOf("-Xcontext-receivers")
+    }
+}
+
 apply(from = file("../gradle/publish.gradle.kts"))

projects/koin-ksp-compiler/src/jvmMain/kotlin/org/koin/compiler/BuilderProcessor.kt

@@ -18,22 +18,27 @@ package org.koin.compiler
 import com.google.devtools.ksp.processing.*
 import com.google.devtools.ksp.symbol.KSAnnotated
 import org.koin.compiler.KspOptions.*
-import org.koin.compiler.generator.KoinGenerator
+import org.koin.compiler.generator.KoinCodeGenerator
 import org.koin.compiler.metadata.KoinMetaData
 import org.koin.compiler.scanner.KoinMetaDataScanner
-import org.koin.compiler.verify.KoinConfigVerification
+import org.koin.compiler.verify.KoinConfigChecker
+import org.koin.compiler.verify.KoinTagWriter
 
 class BuilderProcessor(
-    private val codeGenerator: CodeGenerator,
+    codeGenerator: CodeGenerator,
     private val logger: KSPLogger,
     private val options: Map<String, String>
 ) : SymbolProcessor {
 
-    private val koinCodeGenerator = KoinGenerator(codeGenerator, logger, isComposeViewModelActive() || isKoinComposeViewModelActive())
+    private val isComposeViewModelActive = isComposeViewModelActive() || isKoinComposeViewModelActive()
+    private val koinCodeGenerator = KoinCodeGenerator(codeGenerator, logger, isComposeViewModelActive)
     private val koinMetaDataScanner = KoinMetaDataScanner(logger)
-    private val koinConfigVerification = KoinConfigVerification(codeGenerator, logger)
+    private val koinTagWriter = KoinTagWriter(codeGenerator,logger)
+    private val koinConfigChecker = KoinConfigChecker(codeGenerator, logger)
 
     override fun process(resolver: Resolver): List<KSAnnotated> {
+        initComponents(resolver)
+
         logger.logging("Scan symbols ...")
 
         val invalidSymbols = koinMetaDataScanner.scanSymbols(resolver)
@@ -48,33 +53,41 @@ class BuilderProcessor(
             isDefault = true,
         )
 
-        logger.logging("Scan metadata ...")
+        logger.logging("Build metadata ...")
         val moduleList = koinMetaDataScanner.scanKoinModules(defaultModule)
 
         logger.logging("Generate code ...")
         koinCodeGenerator.generateModules(moduleList, defaultModule, isDefaultModuleActive())
 
+        val allModules = moduleList + defaultModule
+        koinTagWriter.writeAllTags(moduleList, defaultModule)
+
         if (isConfigCheckActive()) {
-            logger.warn("Koin Configuration Check")
-            koinConfigVerification.verifyDefinitionDeclarations(moduleList + defaultModule, resolver)
-            koinConfigVerification.verifyModuleIncludes(moduleList + defaultModule, resolver)
+            logger.warn("Check Configuration ...")
+            koinConfigChecker.verifyDefinitionDeclarations(allModules, resolver)
+            koinConfigChecker.verifyModuleIncludes(allModules, resolver)
         }
         return emptyList()
     }
 
+    private fun initComponents(resolver: Resolver) {
+        koinCodeGenerator.resolver = resolver
+        koinTagWriter.resolver = resolver
+    }
+
     private fun isConfigCheckActive(): Boolean {
         return options.getOrDefault(KOIN_CONFIG_CHECK.name, "false") == true.toString()
     }
 
     //TODO Use Koin 4.0 ViewModel DSL
     @Deprecated("use isKoinComposeViewModelActive")
     private fun isComposeViewModelActive(): Boolean {
-        logger.warn("[Deprecated] Please use KOIN_USE_COMPOSE_VIEWMODEL arg")
+        logger.warn("[Deprecated] 'USE_COMPOSE_VIEWMODEL' arg is deprecated. Please use 'KOIN_USE_COMPOSE_VIEWMODEL'")
         return options.getOrDefault(USE_COMPOSE_VIEWMODEL.name, "false") == true.toString()
     }
 
     private fun isKoinComposeViewModelActive(): Boolean {
-        logger.warn("Use Compose ViewModel for @KoinViewModel generation")
+        logger.warn("Activate Compose ViewModel for @KoinViewModel generation")
         return options.getOrDefault(KOIN_USE_COMPOSE_VIEWMODEL.name, "false") == true.toString()
     }
 

projects/koin-ksp-compiler/src/jvmMain/kotlin/org/koin/compiler/generator/ClassModuleWriter.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2017-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.koin.compiler.generator
+
+import com.google.devtools.ksp.processing.CodeGenerator
+import com.google.devtools.ksp.processing.Resolver
+import org.koin.compiler.metadata.KoinMetaData
+
+class ClassModuleWriter(
+    codeGenerator: CodeGenerator,
+    resolver: Resolver,
+    module: KoinMetaData.Module
+) : ModuleWriter(codeGenerator, resolver, module) {
+
+    override val fileName : String = generateModuleFileName(module)
+    private fun generateModuleFileName(m: KoinMetaData.Module): String {
+        val extensionName = m.packageName("$")
+        return "${m.name}Gen${extensionName}"
+    }
+}

projects/koin-ksp-compiler/src/jvmMain/kotlin/org/koin/compiler/generator/DefaultModuleWriter.kt

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2017-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.koin.compiler.generator
+
+import com.google.devtools.ksp.processing.CodeGenerator
+import com.google.devtools.ksp.processing.Resolver
+import org.koin.compiler.metadata.KoinMetaData
+
+class DefaultModuleWriter(
+    codeGenerator: CodeGenerator,
+    resolver: Resolver,
+    defaultModule: KoinMetaData.Module,
+    generateDefaultModule: Boolean
+) : ModuleWriter(codeGenerator, resolver, defaultModule) {
+
+    override val fileName : String = "KoinDefault-${defaultModule.hashCode()}"
+    override val hasExternalDefinitions: Boolean = true
+    override val generateModuleBody: Boolean = generateDefaultModule
+
+    override fun writeModuleFooter() {
+        writeln(DEFAULT_MODULE_FOOTER)
+    }
+}