Merge pull request #131 from grische/fix/duplicate-top-level-structs

fix duplicate top-level structs

Author: mholt

json-to-go.js

@@ -19,6 +19,8 @@ function jsonToGo(json, typename, flatten = true, example = false, allOmitempty
 	let accumulator = "";
 	let innerTabs = 0;
 	let parent = "";
+	let globallySeenTypeNames = [];
+	let previousParents = "";
 
 	try
 	{
@@ -128,7 +130,7 @@ function jsonToGo(json, typename, flatten = true, example = false, allOmitempty
 						struct[keyname] = elem.value;
 						omitempty[keyname] = elem.count != scopeLength;
 					}
-					parseStruct(depth + 1, innerTabs, struct, omitempty); // finally parse the struct !!
+					parseStruct(depth + 1, innerTabs, struct, omitempty, previousParents); // finally parse the struct !!
 				}
 				else if (sliceType == "slice") {
 					parseScope(scope[0], depth)
@@ -151,7 +153,7 @@ function jsonToGo(json, typename, flatten = true, example = false, allOmitempty
 						append(parent)
 					}
 				}
-				parseStruct(depth + 1, innerTabs, scope);
+				parseStruct(depth + 1, innerTabs, scope, false, previousParents);
 			}
 		}
 		else {
@@ -164,7 +166,7 @@ function jsonToGo(json, typename, flatten = true, example = false, allOmitempty
 		}
 	}
 
-	function parseStruct(depth, innerTabs, scope, omitempty)
+	function parseStruct(depth, innerTabs, scope, omitempty, oldParents)
 	{
 		if (flatten) {
 			stack.push(
@@ -193,12 +195,20 @@ function jsonToGo(json, typename, flatten = true, example = false, allOmitempty
 			appender(`${parentType} struct {\n`);
 			++innerTabs;
 			const keys = Object.keys(scope);
+			previousParents = parent
 			for (let i in keys)
 			{
 				const keyname = getOriginalName(keys[i]);
 				indenter(innerTabs)
-				const typename = uniqueTypeName(format(keyname), seenTypeNames)
-				seenTypeNames.push(typename)
+				let typename
+				// structs will be defined on the top level of the go file, so they need to be globally unique
+				if (typeof scope[keys[i]] === "object" && scope[keys[i]] !== null) {
+					typename = uniqueTypeName(format(keyname), globallySeenTypeNames, previousParents)
+					globallySeenTypeNames.push(typename)
+				} else {
+					typename = uniqueTypeName(format(keyname), seenTypeNames)
+					seenTypeNames.push(typename)
+				}
 
 				appender(typename+" ");
 				parent = typename
@@ -212,18 +222,28 @@ function jsonToGo(json, typename, flatten = true, example = false, allOmitempty
 			}
 			indenter(--innerTabs);
 			appender("}");
+			previousParents = oldParents;
 		}
 		else
 		{
 			append("struct {\n");
 			++tabs;
 			const keys = Object.keys(scope);
+			previousParents = parent
 			for (let i in keys)
 			{
 				const keyname = getOriginalName(keys[i]);
 				indent(tabs);
-				const typename = uniqueTypeName(format(keyname), seenTypeNames)
-				seenTypeNames.push(typename)
+				let typename
+				// structs will be defined on the top level of the go file, so they need to be globally unique
+				if (typeof scope[keys[i]] === "object" && scope[keys[i]] !== null) {
+					typename = uniqueTypeName(format(keyname), globallySeenTypeNames, previousParents)
+					globallySeenTypeNames.push(typename)
+				} else {
+					typename = uniqueTypeName(format(keyname), seenTypeNames)
+					seenTypeNames.push(typename)
+				}
+
 				append(typename+" ");
 				parent = typename
 				parseScope(scope[keys[i]], depth);
@@ -240,6 +260,7 @@ function jsonToGo(json, typename, flatten = true, example = false, allOmitempty
 			}
 			indent(--tabs);
 			append("}");
+			previousParents = oldParents;
 		}
 		if (flatten)
 			accumulator += stack.pop();
@@ -269,11 +290,19 @@ function jsonToGo(json, typename, flatten = true, example = false, allOmitempty
 
 	// Generate a unique name to avoid duplicate struct field names.
 	// This function appends a number at the end of the field name.
-	function uniqueTypeName(name, seen) {
+	function uniqueTypeName(name, seen, prefix=null) {
 		if (seen.indexOf(name) === -1) {
 			return name;
 		}
 
+		// check if we can get a unique name by prefixing it
+		if(prefix) {
+			name = prefix+name
+			if (seen.indexOf(name) === -1) {
+				return name;
+			}
+		}
+
 		let i = 0;
 		while (true) {
 			let newName = name + i.toString();

json-to-go.test.js

@@ -149,9 +149,39 @@ function test(includeExampleData) {
       );
     }
   }
+  console.log(includeExampleData ? "done testing samples with data" : "done testing samples without data")
+}
+
+function testFiles() {
+  const fs = require('fs');
+  const path = require('path');
+
+  const testCases = [
+    "duplicate-top-level-structs",
+    "double-nested-objects",
+  ];
 
-  console.log("done")
+  for (const testCase of testCases) {
+
+    try {
+      const jsonData = fs.readFileSync(path.join('tests', testCase + '.json'), 'utf8');
+      const expectedGoData = fs.readFileSync(path.join('tests', testCase + '.go'), 'utf8');
+      const got = jsonToGo(jsonData);
+      if (got.error) {
+        console.assert(!got.error, `format('${jsonData}'): ${got.error}`);
+      } else {
+        console.assert(
+          got.go === expectedGoData,
+          `format('${jsonData}'): \n\tgot:  ${quote(got.go)}\n\twant: ${quote(expectedGoData)}`
+        );
+      }
+    } catch (err) {
+      console.error(err);
+    }
+  }
+  console.log("done testing files")
 }
 
 test(false);
 test(true)
+testFiles()

tests/double-nested-objects.go

@@ -0,0 +1,19 @@
+type AutoGenerated struct {
+	First First `json:"first"`
+	Second Second `json:"second"`
+}
+type Type struct {
+	Short string `json:"short"`
+	Long string `json:"long"`
+}
+type First struct {
+	ID int `json:"id"`
+	Type Type `json:"type"`
+}
+type SecondType struct {
+	Long string `json:"long"`
+}
+type Second struct {
+	ID int `json:"id"`
+	SecondType SecondType `json:"type"`
+}

tests/double-nested-objects.json

@@ -0,0 +1,15 @@
+{
+    "first": {
+        "id": 1,
+        "type": {
+            "short": "owa",
+            "long": "objectwitharray"
+        }
+    },
+    "second": {
+        "id": 2,
+        "type": {
+            "long": "object"
+        }
+    }
+}

tests/duplicate-top-level-structs.go

@@ -0,0 +1,35 @@
+type AutoGenerated struct {
+	Region Region `json:"region"`
+	Municipality Municipality `json:"municipality"`
+	Building Building `json:"building"`
+}
+type Identifier struct {
+	Type string `json:"type"`
+	ID int `json:"id"`
+}
+type Region struct {
+	Identifier Identifier `json:"identifier"`
+	Autonomous bool `json:"autonomous"`
+}
+type MunicipalityIdentifier struct {
+	Type string `json:"type"`
+	Name string `json:"name"`
+}
+type Municipality struct {
+	MunicipalityIdentifier MunicipalityIdentifier `json:"identifier"`
+}
+type Postal struct {
+	Type string `json:"type"`
+	ID int `json:"id"`
+}
+type Road struct {
+	Name string `json:"name"`
+	ID int `json:"id"`
+}
+type BuildingIdentifier struct {
+	Postal Postal `json:"postal"`
+	Road Road `json:"road"`
+}
+type Building struct {
+	BuildingIdentifier BuildingIdentifier `json:"identifier"`
+}

tests/duplicate-top-level-structs.json

@@ -0,0 +1,27 @@
+{
+  "region": {
+      "identifier": {
+          "type": "ISO 3166-1",
+          "id": 234
+      },
+      "autonomous": true
+  },
+  "municipality": {
+      "identifier": {
+          "type": "local",
+          "name": "Tórshavn"
+      }
+  },
+  "building": {
+      "identifier": {
+          "postal": {
+              "type": "local",
+              "id": 100
+          },
+          "road": {
+              "name": "Gríms Kambansgøta",
+              "id": 1
+          }
+      }
+  }
+}