Merge pull request #996 from Backbase/MF-2088-BOAT-ios-content-services-not-compiling

Fix: Nested freeform objects generating broken models

Author: DevAgani

README.md

@@ -14,6 +14,8 @@ It currently consists of
 
 # Release Notes
 BOAT is still under development and subject to change.
+## 0.17.55
+* Enhanced `boat-swift5` generator to cater for nested freeformObjects. This issue was identified in `ContentServicesApi`
 ## 0.17.54 and later
 Starting from 0.17.54 the release notes are available at https://github.com/Backbase/backbase-openapi-tools/releases
 ## 0.17.53

boat-scaffold/src/main/java/org/openapitools/codegen/languages/BoatSwift5Codegen.java

@@ -21,6 +21,8 @@ public class BoatSwift5Codegen extends Swift5ClientCodegen implements CodegenCon
     protected static final String DEPENDENCY_MANAGEMENT_CARTFILE = "Cartfile";
     protected static final String[] DEPENDENCY_MANAGEMENT_OPTIONS = {DEPENDENCY_MANAGEMENT_CARTFILE, DEPENDENCY_MANAGEMENT_PODFILE};
     protected static final String MODULE_NAME = "moduleName";
+    protected static final String NESTED_STRING_ANY_DICTIONARY = "[String: [String: Any]]";
+    protected static final String STRING_ANY_DICTIONARY = "[String: Any]";
     protected String[] dependenciesAs = new String[0];
 
     /**
@@ -143,6 +145,12 @@ private void fixFreeFormObject(List<CodegenProperty> codegenProperties) {
                     codegenProperty.isMap = false;
                 }
             }
+
+            if (hasNestedStringAnyDictionary(codegenProperty)) {
+                codegenProperty.isFreeFormObject = true;
+                codegenProperty.setDataType(STRING_ANY_DICTIONARY);
+                codegenProperty.setDatatypeWithEnum(STRING_ANY_DICTIONARY);
+            }
         }
     }
 
@@ -211,6 +219,20 @@ private String sanitize(String projectName) {
         return projName;
     }
 
+    /*
+    Helper method to check whether a codegenProperty has nested additional properties
+     */
+    private boolean hasNestedAdditionalProperties(CodegenProperty codegenProperty) {
+        return codegenProperty.isMap
+                && codegenProperty.additionalProperties != null
+                && codegenProperty.getAdditionalProperties().isContainer
+                && !codegenProperty.getAdditionalProperties().isArray;
+    }
+
+    private boolean hasNestedStringAnyDictionary(CodegenProperty codegenProperty) {
+        return hasNestedAdditionalProperties(codegenProperty) && codegenProperty.getDataType().equals(NESTED_STRING_ANY_DICTIONARY);
+    }
+
     @Override
     public void postProcess() {
         System.out.println("################################################################################");

boat-scaffold/src/test/java/org/openapitools/codegen/languages/BoatSwift5CodegenTests.java

@@ -204,7 +204,7 @@ void testFromModelCodegenModel() {
         assertEquals(cm.name, "sample");
         assertEquals(cm.classname, "Sample");
         assertEquals(cm.description, "a sample model");
-        assertEquals(cm.vars.size(), 6);
+        assertEquals(cm.vars.size(), 7);
         assertEquals(cm.getDiscriminatorName(), "test");
     }
 
@@ -380,6 +380,12 @@ private CodegenModel prepareForModelTests() {
         mapSchema1.setDescription("Sample ObjectSchema");
         mapSchema1.additionalProperties(new StringSchema());
 
+        final ObjectSchema oneLevelNestedObjectSchema = new ObjectSchema();
+        final ObjectSchema nestedObjectSchema = new ObjectSchema();
+        nestedObjectSchema.additionalProperties(oneLevelNestedObjectSchema);
+        final ObjectSchema objectSchema1 = new ObjectSchema();
+        objectSchema1.additionalProperties(nestedObjectSchema);
+
         final Schema schema = new Schema()
                 .description("a sample model")
                 .addProperty("id", new IntegerSchema().format(SchemaTypeUtil.INTEGER64_FORMAT))
@@ -388,6 +394,7 @@ private CodegenModel prepareForModelTests() {
                 .addProperty("nested", nestedArraySchema)
                 .addProperty("map", mapSchema)
                 .addProperty("secondMap", mapSchema1)
+                .addProperty("link", objectSchema1)
                 .addRequiredItem("id")
                 .addRequiredItem("name")
                 .name("sample")