add package name as conversion arg option

fractalwrench · fractalwrench · commit 329a46e85a97 · 2018-02-25T09:35:39.000Z
diff --git a/core/src/main/kotlin/com/fractalwrench/json2kotlin/ClassTypeHolder.kt b/core/src/main/kotlin/com/fractalwrench/json2kotlin/ClassTypeHolder.kt
@@ -4,7 +4,7 @@ import com.squareup.kotlinpoet.*
 import java.util.*
 
 
-internal class ClassTypeHolder(val delegate: SourceBuildDelegate) : TraversalDelegate { // TODO rename, bad ontology
+internal class ClassTypeHolder(val delegate: SourceBuildDelegate) { // TODO rename, bad ontology
 
     internal val stack = Stack<TypeSpec>()
     private val jsonProcessor = JsonProcessor()
@@ -38,7 +38,7 @@ internal class ClassTypeHolder(val delegate: SourceBuildDelegate) : TraversalDel
     /**
      * Processes a single level in the tree
      */
-    override fun processTreeLevel(levelQueue: LinkedList<TypedJsonElement>) { // FIXME not ll, generify?
+    fun processTreeLevel(levelQueue: LinkedList<TypedJsonElement>) { // FIXME not ll, generify?
         val fieldValues = levelQueue.filter { it.isJsonObject }.toMutableList()
 
         jsonFieldGrouper.groupCommonFieldValues(fieldValues)
diff --git a/core/src/main/kotlin/com/fractalwrench/json2kotlin/ConversionArgs.kt b/core/src/main/kotlin/com/fractalwrench/json2kotlin/ConversionArgs.kt
@@ -1,3 +1,3 @@
 package com.fractalwrench.json2kotlin
 
-class ConversionArgs(val rootClassName: String = "Example") // TODO support a few other options (package name, build delegate)
+class ConversionArgs(val rootClassName: String = "Example", val packageName: String? = null)
diff --git a/core/src/main/kotlin/com/fractalwrench/json2kotlin/Kotlin2JsonConverter.kt b/core/src/main/kotlin/com/fractalwrench/json2kotlin/Kotlin2JsonConverter.kt
@@ -10,7 +10,7 @@ class Kotlin2JsonConverter(val buildDelegate: SourceBuildDelegate = GsonBuildDel
 
     // TODO (general: update KDocs!)
 
-    // TODO expose grouping class as a parameter, add to config
+    // TODO expose grouping class as a parameter
 
     private val jsonReader = JsonReader(JsonParser())
     private val sourceFileWriter = SourceFileWriter()
diff --git a/core/src/main/kotlin/com/fractalwrench/json2kotlin/ReverseJsonTreeTraverser.kt b/core/src/main/kotlin/com/fractalwrench/json2kotlin/ReverseJsonTreeTraverser.kt
@@ -56,9 +56,6 @@ internal class ReverseJsonTreeTraverser {
                 .map { TypedJsonElement(it.value, it.key, depth) }
     }
 
-    private fun nameForArrayField(index: Int, identifier: String): String =
-            if (index == 0) identifier else "$identifier${index + 1}" // FIXME duplication
-
     private fun shouldAddToStack(element: JsonElement) = element.isJsonArray || element.isJsonObject
 
 }
diff --git a/core/src/main/kotlin/com/fractalwrench/json2kotlin/SourceFileWriter.kt b/core/src/main/kotlin/com/fractalwrench/json2kotlin/SourceFileWriter.kt
@@ -14,7 +14,8 @@ internal class SourceFileWriter { // TODO rename once functionality has changed
      * Writes a collection of types to a source file OutputStream.
      */
     fun writeSourceFile(stack: Stack<TypeSpec>, args: ConversionArgs, output: OutputStream) {
-        val sourceFile = FileSpec.builder("", args.rootClassName) // FIXME set package name
+        val packageName = args.packageName ?: ""
+        val sourceFile = FileSpec.builder(packageName, args.rootClassName)
 
         while (stack.isNotEmpty()) {
             sourceFile.addType(stack.pop())
diff --git a/core/src/main/kotlin/com/fractalwrench/json2kotlin/TraversalDelegate.kt b/core/src/main/kotlin/com/fractalwrench/json2kotlin/TraversalDelegate.kt
diff --git a/core/src/test/kotlin/com/fractalwrench/json2kotlin/ConverterArgsTest.kt b/core/src/test/kotlin/com/fractalwrench/json2kotlin/ConverterArgsTest.kt
@@ -0,0 +1,31 @@
+package com.fractalwrench.json2kotlin
+
+import org.junit.Assert
+import org.junit.Test
+import java.io.ByteArrayOutputStream
+import java.io.File
+
+class ConverterArgsTest {
+
+    private val fileReader = ResourceFileReader()
+    private val jsonConverter = Kotlin2JsonConverter()
+
+    /**
+     * Takes a JSON file and converts it into the equivalent Kotlin class, then compares to expected output.
+     */
+    @Test
+    fun testPackageName() {
+        val jsonFilename = "args/Package.json"
+        val expectedFilename = "args/PackageExample.kt"
+        val json = fileReader.readContents(jsonFilename)
+
+        val outputStream = ByteArrayOutputStream()
+        jsonConverter.convert(json, outputStream, ConversionArgs("PackageExample", "com.fractalwrench.foo"))
+
+        val generatedSource = String(outputStream.toByteArray()).standardiseNewline()
+        val expectedContents = fileReader.readContents(expectedFilename).standardiseNewline()
+        val msg = "Generated file doesn't match expected file \'$expectedFilename\'"
+        Assert.assertEquals(msg, expectedContents, generatedSource)
+    }
+
+}
diff --git a/core/src/test/resources/args/Package.json b/core/src/test/resources/args/Package.json
@@ -0,0 +1,3 @@
+{
+  "firstField": "test"
+}
diff --git a/core/src/test/resources/args/PackageExample.kt b/core/src/test/resources/args/PackageExample.kt
@@ -0,0 +1,5 @@
+package com.fractalwrench.foo
+
+import kotlin.String
+
+data class PackageExample(val firstField: String)

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`package com.fractalwrench.json2kotlin`
`2`	`2`
`3`		`-class ConversionArgs(val rootClassName: String = "Example") // TODO support a few other options (package name, build delegate)`
	`3`	`+class ConversionArgs(val rootClassName: String = "Example", val packageName: String? = null)`
Original file line number	Diff line number	Diff line change
`@@ -56,9 +56,6 @@ internal class ReverseJsonTreeTraverser {`
`56`	`56`	`.map { TypedJsonElement(it.value, it.key, depth) }`
`57`	`57`	`}`
`58`	`58`
`59`		`- private fun nameForArrayField(index: Int, identifier: String): String =`
`60`		`- if (index == 0) identifier else "$identifier${index + 1}" // FIXME duplication`
`61`		`-`
`62`	`59`	`private fun shouldAddToStack(element: JsonElement) = element.isJsonArray \|\| element.isJsonObject`
`63`	`60`
`64`	`61`	`}`