Merge Feature/2 create knowledge category

.github/workflows/feature-pr-checks.yml

@@ -32,6 +32,6 @@ jobs:
         uses: gradle/actions/setup-gradle@v3
 
       - name: "Build: Assemble and Test entire project"
-        run: ./gradlew build
+        run: ./gradlew jvmTest
 
 #      - run: ./gradlew generate coverage report, upload test/coverage reports

.github/workflows/main-pr-checks.yml

@@ -32,6 +32,6 @@ jobs:
         uses: gradle/actions/setup-gradle@v3
 
       - name: "Build: Assemble and Test entire project"
-        run: ./gradlew build
+        run: ./gradlew jvmTest
 
 #      - run: ./gradlew generate coverage report, upload test/coverage reports

api/build.gradle.kts

@@ -3,7 +3,6 @@ plugins {
     alias(libs.plugins.kotlinJvm)
     alias(libs.plugins.ktor)
     `maven-publish`
-    alias(libs.plugins.artifactRegistry)
 }
 
 tasks.named<Zip>("distZip") {
@@ -33,27 +32,21 @@ kotlin {
 }
 
 application {
-    mainClass = "org.pointyware.replace-me.api.ServerKt"
+    mainClass = "org.pointyware.commonsense.api.ServerKt"
 }
 
 ktor {
     fatJar {
-        archiveFileName = "replace-me-API-${version}.jar"
+        archiveFileName = "Common-Sense-API-${version}.jar"
     }
 }
 
-//publishing {
-//    publications {
-//        create<MavenPublication>("maven") {
-//            groupId = "org.pointyware.replace-me"
-//            artifactId = "replace-me-api"
-//            from(components["java"])
-//        }
-//    }
-//    repositories {
-//        maven {
-//            val releaseURL = "artifactregistry://us-central1-maven.pkg.dev/<project-id>/<repo>"
-//            url = uri(releaseURL)
-//        }
-//    }
-//}
+publishing {
+    publications {
+        create<MavenPublication>("maven") {
+            groupId = "org.pointyware.replace-me"
+            artifactId = "replace-me-api"
+            from(components["java"])
+        }
+    }
+}

app-android/src/main/java/CSApplication.kt

@@ -1,9 +1,9 @@
 package org.pointyware.commonsense.android
 
 import android.app.Application
-import org.koin.core.context.startKoin
+import org.koin.dsl.module
 import org.pointyware.commonsense.android.di.androidModule
-import org.pointyware.commonsense.shared.di.appModule
+import org.pointyware.commonsense.shared.di.setupKoin
 
 /**
  * This is the production Common Sense application; it performs production environment setup.
@@ -12,11 +12,10 @@ class CSApplication: Application() {
     override fun onCreate() {
         super.onCreate()
 
-        startKoin {
-            modules(
-                androidModule(),
-                appModule()
-            )
-        }
+        setupKoin(
+            platformModule = module {
+                includes(androidModule(this@CSApplication))
+            }
+        )
     }
 }

app-android/src/main/java/di/Module.kt

@@ -1,5 +1,7 @@
 package org.pointyware.commonsense.android.di
 
+import android.app.Application
+import android.content.Context
 import org.koin.dsl.module
 import org.pointyware.commonsense.shared.entities.SharedFileResources
 import org.pointyware.commonsense.shared.entities.SharedStringResources
@@ -9,9 +11,12 @@ import org.pointyware.commonsense.shared.ui.SharedFontResources
 /**
  *
  */
-fun androidModule() = module {
+fun androidModule(application: Application) = module {
     single<SharedStringResources> { AndroidStringResources() }
     single<SharedFontResources> { AndroidFontResources() }
     single<SharedDrawableResources> { AndroidDrawableResources() }
     single<SharedFileResources> { AndroidFileResources() }
+
+    single<Application> { application }
+    single<Context> { application }
 }

app-desktop/src/main/kotlin/Main.kt

@@ -15,15 +15,11 @@ import org.pointyware.commonsense.shared.CommonSenseApp
 import org.pointyware.commonsense.shared.FileViewModel
 import org.pointyware.commonsense.shared.di.appModule
 import org.pointyware.commonsense.shared.di.getDependencies
+import org.pointyware.commonsense.shared.di.setupKoin
 
 fun main() = application {
 
-    startKoin {
-        modules(
-            desktopModule(),
-            appModule()
-        )
-    }
+    setupKoin(platformModule = desktopModule())
 
     val appDependencies = remember { getDependencies() }
     val drawableResources = remember { appDependencies.getDrawableResources() }

app-shared/build.gradle.kts

@@ -77,6 +77,8 @@ kotlin {
             dependsOn(commonTest)
             dependencies {
                 implementation(libs.koin.test)
+
+                implementation(libs.mockk)
             }
         }
 

app-shared/src/commonMain/kotlin/di/AppModule.kt

@@ -1,5 +1,6 @@
 package org.pointyware.commonsense.shared.di
 
+import org.koin.core.context.startKoin
 import org.koin.core.module.Module
 import org.koin.dsl.module
 import org.pointyware.commonsense.core.data.di.dataModule
@@ -15,6 +16,13 @@ import org.pointyware.commonsense.shared.FileViewModel
 import org.pointyware.commonsense.shared.home.di.homeModule
 
 
+fun setupKoin(platformModule: Module = module{}) = startKoin {
+    modules(
+        appModule(),
+        platformModule
+    )
+}
+
 fun appModule(): Module = module {
     includes(
         coreModule(),

app-shared/src/jvmSharedTest/kotlin/di/KoinValidationTest.kt

@@ -1,34 +1,32 @@
 package di
 
-import io.ktor.client.HttpClientConfig
-import io.ktor.client.engine.HttpClientEngine
-import org.koin.core.annotation.KoinExperimentalAPI
-import org.koin.core.module.Module
-import org.koin.test.check.checkKoinModules
-import org.koin.test.verify.verify
-import org.pointyware.commonsense.shared.di.appModule
+import org.koin.core.KoinApplication
+import org.koin.test.check.checkModules
+import org.pointyware.commonsense.feature.ontology.di.ontologyJvmSharedModule
+import org.pointyware.commonsense.shared.di.setupKoin
+import kotlin.test.AfterTest
 import kotlin.test.BeforeTest
 import kotlin.test.Test
 
 /**
+ *
  */
 class KoinValidationTest {
 
-    lateinit var topLevelModule: Module
+    lateinit var koinApp: KoinApplication
 
     @BeforeTest
     fun setUp() {
-        topLevelModule = appModule()
+        koinApp = setupKoin(platformModule = ontologyJvmSharedModule())
     }
 
-    @OptIn(KoinExperimentalAPI::class)
-    @Test
-    fun verifyKoinConfiguration() {
-        topLevelModule.verify(extraTypes = listOf(HttpClientEngine::class, HttpClientConfig::class))
+    @AfterTest
+    fun stopKoin() {
+        koinApp.close()
     }
 
     @Test
     fun checkKoinModules() {
-        checkKoinModules(listOf(topLevelModule))
+        koinApp.checkModules()
     }
 }

build.gradle.kts

@@ -17,7 +17,6 @@ plugins {
 
     alias(libs.plugins.commonsense.koin).apply(false)
     alias(libs.plugins.commonsense.kmp).apply(false)
-    alias(libs.plugins.artifactRegistry).apply(false)
 }
 
 tasks.dokkaHtmlMultiModule {

feature/ontology/src/commonMain/kotlin/category/ui/CategoryExplorerScreen.kt

@@ -11,7 +11,9 @@ import androidx.compose.runtime.getValue
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.window.Dialog
+import org.pointyware.commonsense.feature.ontology.category.viewmodels.CategoryExplorerEditorState
 import org.pointyware.commonsense.feature.ontology.category.viewmodels.CategoryExplorerViewModel
+import org.pointyware.commonsense.feature.ontology.ui.CategoryEditor
 import org.pointyware.commonsense.feature.ontology.ui.ConceptEditor
 
 /**
@@ -34,22 +36,6 @@ fun CategoryExplorerScreen(
         modifier = Modifier.fillMaxSize(),
         contentAlignment = Alignment.Center
     ) {
-        state.conceptEditor?.let { conceptEditorUiState ->
-            Dialog(
-                onDismissRequest = {
-                    viewModel.onCancel()
-                }
-            ) {
-                ConceptEditor(
-                    state = conceptEditorUiState,
-                    onNameChange = viewModel::onNameChange,
-                    onDescriptionChange = viewModel::onDescriptionChange,
-                    onConfirm = viewModel::onCommitConcept,
-                    onCancel = viewModel::onCancel
-                )
-            }
-        }
-
         CategoryExplorer(
             state = mappedState,
             modifier = Modifier.fillMaxSize(),
@@ -75,5 +61,38 @@ fun CategoryExplorerScreen(
                 )
             }
         }
+
+        when (val capture = state.editorState) {
+            is CategoryExplorerEditorState.Concept -> {
+                Dialog(
+                    onDismissRequest = {
+                        viewModel.onCancel()
+                    }
+                ) {
+                    ConceptEditor(
+                        state = capture.concept,
+                        onNameChange = viewModel::onConceptNameChange,
+                        onDescriptionChange = viewModel::onDescriptionChange,
+                        onConfirm = viewModel::onCommitConcept,
+                        onCancel = viewModel::onCancel
+                    )
+                }
+            }
+            is CategoryExplorerEditorState.Category -> {
+                Dialog(
+                    onDismissRequest = {
+                        viewModel.onCancel()
+                    }
+                ) {
+                    CategoryEditor(
+                        state = capture.category,
+                        onNameChange = viewModel::onCategoryNameChange,
+                        onConfirm = viewModel::onCommitCategory,
+                        onCancel = viewModel::onCancel
+                    )
+                }
+            }
+            else -> { /* Show Nothing */ }
+        }
     }
 }

feature/ontology/src/commonMain/kotlin/category/viewmodels/CategoryEditorViewModel.kt

@@ -0,0 +1,67 @@
+package org.pointyware.commonsense.feature.ontology.category.viewmodels
+
+import kotlinx.coroutines.flow.MutableSharedFlow
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.SharedFlow
+import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.flow.asSharedFlow
+import kotlinx.coroutines.flow.asStateFlow
+import kotlinx.coroutines.flow.update
+import kotlinx.coroutines.launch
+import org.pointyware.commonsense.core.viewmodels.ViewModel
+import org.pointyware.commonsense.feature.ontology.category.interactors.CreateNewCategoryUseCase
+import org.pointyware.commonsense.feature.ontology.entities.Category
+import org.pointyware.commonsense.feature.ontology.viewmodels.CategoryEditorUiState
+
+/**
+ * Maintains the state of a Category Editor UI, reflected in [state].
+ */
+interface CategoryEditorViewModel {
+    val state: StateFlow<CategoryEditorUiState>
+    val onFinish: SharedFlow<Unit>
+    fun prepareFor(category: Category?)
+    fun onNameChange(newName: String)
+    fun onConfirm()
+    fun onCancel()
+}
+
+/**
+ */
+class CategoryEditorViewModelImpl(
+    private val createNewCategoryUseCase: CreateNewCategoryUseCase,
+): CategoryEditorViewModel, ViewModel() {
+
+    private val mutableState = MutableStateFlow(CategoryEditorUiState.Empty)
+    override val state: StateFlow<CategoryEditorUiState>
+        get() = mutableState.asStateFlow()
+
+    private val mutableFinish = MutableSharedFlow<Unit>()
+    override val onFinish: SharedFlow<Unit>
+        get() = mutableFinish.asSharedFlow()
+
+    override fun prepareFor(category: Category?) {
+        mutableState.update {
+            it.copy(name = category?.name ?: "")
+        }
+    }
+
+    override fun onNameChange(newName: String) {
+        mutableState.update {
+            it.copy(name = newName)
+        }
+    }
+
+    override fun onConfirm() {
+        viewModelScope.launch {
+            val state = state.value
+            createNewCategoryUseCase.invoke(state.name)
+            mutableFinish.emit(Unit)
+        }
+    }
+
+    override fun onCancel() {
+        viewModelScope.launch {
+            mutableFinish.emit(Unit)
+        }
+    }
+}

feature/ontology/src/commonMain/kotlin/category/viewmodels/CategoryExplorerUiState.kt

@@ -2,6 +2,7 @@ package org.pointyware.commonsense.feature.ontology.category.viewmodels
 
 import org.pointyware.commonsense.feature.ontology.Concept
 import org.pointyware.commonsense.feature.ontology.entities.Category
+import org.pointyware.commonsense.feature.ontology.viewmodels.CategoryEditorUiState
 import org.pointyware.commonsense.feature.ontology.viewmodels.ConceptEditorUiState
 
 /**
@@ -14,7 +15,7 @@ import org.pointyware.commonsense.feature.ontology.viewmodels.ConceptEditorUiSta
 data class CategoryExplorerUiState(
     val loading: Boolean = false,
     val currentCategory: CategoryUiState,
-    val conceptEditor: ConceptEditorUiState? = null
+    val editorState: CategoryExplorerEditorState = CategoryExplorerEditorState.Disabled,
 ) {
     companion object {
         val Loading = CategoryExplorerUiState(true, CategoryUiState())
@@ -26,3 +27,13 @@ data class CategoryUiState(
     val subcategories: List<Category> = emptyList(),
     val concepts: List<Concept> = emptyList(),
 )
+
+sealed interface CategoryExplorerEditorState {
+    data object Disabled : CategoryExplorerEditorState
+    data class Concept(
+        val concept: ConceptEditorUiState
+    ) : CategoryExplorerEditorState
+    data class Category(
+        val category: CategoryEditorUiState
+    ) : CategoryExplorerEditorState
+}