Merge pull request #178 from modelix/issue/MODELIX-473

MODELIX-473 Add javascript target for model-sync-lib

Author: mhuster23

model-sync-lib/build.gradle.kts

@@ -7,6 +7,9 @@ repositories {
 }
 
 kotlin {
+    js(IR) {
+        browser()
+    }
     jvm {
         jvmToolchain(11)
         testRuns["test"].executionTask.configure {
@@ -21,7 +24,7 @@ kotlin {
             }
         }
 
-        val commonTest by getting {
+        val jvmTest by getting {
             dependencies {
                 implementation(project(":model-api"))
                 implementation(libs.kotlin.serialization.json)
@@ -31,11 +34,3 @@ kotlin {
         }
     }
 }
-
-publishing {
-    publications {
-        create<MavenPublication>("maven") {
-            from(components["kotlin"])
-        }
-    }
-}

model-sync-lib/src/commonMain/kotlin/org/modelix/model/sync/ModelExporter.kt

@@ -2,20 +2,18 @@ package org.modelix.model.sync
 
 import org.modelix.model.api.INode
 import org.modelix.model.api.serialize
-import org.modelix.model.data.ModelData
 import org.modelix.model.data.NodeData
 import org.modelix.model.data.associateWithNotNull
-import java.io.File
 
-class ModelExporter(private val root: INode) {
-
-    fun export(outputFile: File) {
-        val modelData = ModelData(root = root.asExported())
-        outputFile.parentFile.mkdirs()
-        outputFile.writeText(modelData.toJson())
-    }
-}
+/**
+ * A ModelExporter exports a node and its subtree in bulk.
+ */
+expect class ModelExporter(root: INode)
 
+/**
+ * Returns a [NodeData] representation of the receiver node as it would be exported by a [ModelExporter].
+ * This function is recursively called on the node's children.
+ */
 fun INode.asExported() : NodeData {
     val idKey = NodeData.idPropertyKey
     return NodeData(

model-sync-lib/src/commonMain/kotlin/org/modelix/model/sync/ModelImporter.kt

@@ -3,22 +3,28 @@ package org.modelix.model.sync
 import org.modelix.model.api.*
 import org.modelix.model.data.ModelData
 import org.modelix.model.data.NodeData
-import java.io.File
 
+/**
+ * A ModelImporter updates an existing [INode] and its subtree based on a [ModelData] specification.
+ *
+ * The import is incremental.
+ * Instead of simply overwriting the existing model, only a minimal amount of operations is used.
+ *
+ * Properties, references, and child links are synchronized for this node and all of its (in-)direct children.
+ *
+ * @param root the root node to be updated
+ */
 class ModelImporter(private val root: INode) {
 
     private val originalIdToExisting: MutableMap<String, INode> = mutableMapOf()
     private val postponedReferences = ArrayList<() -> Unit>()
     private val nodesToRemove = HashSet<INode>()
 
-    fun import(jsonFile: File) {
-        require(jsonFile.exists())
-        require(jsonFile.extension == "json")
-
-        val data = ModelData.fromJson(jsonFile.readText())
-        import(data)
-    }
-    
+    /**
+     * Incrementally updates this importers root based on the provided [ModelData] specification.
+     *
+     * @param data the model specification
+     */
     fun import(data: ModelData) {
         originalIdToExisting.clear()
         postponedReferences.clear()

model-sync-lib/src/jsMain/kotlin/org/modelix/model/sync/ModelExporter.kt

@@ -0,0 +1,13 @@
+package org.modelix.model.sync
+
+import org.modelix.model.api.INode
+
+actual class ModelExporter actual constructor(private val root: INode) {
+
+    /**
+     * Triggers a bulk export of this ModelExporter's root node and its (in-)direct children.
+     *
+     * @return exported node
+     */
+    fun export() = root.asExported()
+}

model-sync-lib/src/jvmMain/kotlin/org/modelix/model/sync/ModelExporter.kt

@@ -0,0 +1,19 @@
+package org.modelix.model.sync
+
+import org.modelix.model.api.INode
+import org.modelix.model.data.ModelData
+import java.io.File
+
+actual class ModelExporter actual constructor(private val root: INode) {
+
+    /**
+     * Triggers a bulk export of this ModelExporter's root node and its (in-)direct children into the specified file.
+     *
+     * @param outputFile target file of the export
+     */
+    fun export(outputFile: File) {
+        val modelData = ModelData(root = root.asExported())
+        outputFile.parentFile.mkdirs()
+        outputFile.writeText(modelData.toJson())
+    }
+}

model-sync-lib/src/jvmMain/kotlin/org/modelix/model/sync/PlatformSpecific.kt

@@ -0,0 +1,20 @@
+package org.modelix.model.sync
+
+import org.modelix.model.data.ModelData
+import java.io.File
+
+/**
+ * Incrementally updates the root of the receiver [ModelImporter]
+ * based on the [ModelData] specification contained in the given file.
+ *
+ * @param jsonFile json file containing the model specification
+ *
+ * @throws IllegalArgumentException if the file is not a json file or the file does not exist.
+ */
+fun ModelImporter.import(jsonFile: File) {
+    require(jsonFile.exists())
+    require(jsonFile.extension == "json")
+
+    val data = ModelData.fromJson(jsonFile.readText())
+    import(data)
+}