Add nullable support to Swift4

docs/generators/swift4.md

@@ -13,7 +13,6 @@ sidebar_label: swift4
 |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
 |projectName|Project name in Xcode| |null|
 |responseAs|Optionally use libraries to manage response.  Currently PromiseKit, RxSwift are available.| |null|
-|unwrapRequired|Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema| |null|
 |objcCompatible|Add additional properties and methods for Objective-C compatibility (default: false)| |null|
 |podSource|Source information used for Podspec| |null|
 |podVersion|Version used for Podspec| |null|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java

@@ -41,7 +41,6 @@ public class Swift4Codegen extends DefaultCodegen implements CodegenConfig {
 
     public static final String PROJECT_NAME = "projectName";
     public static final String RESPONSE_AS = "responseAs";
-    public static final String UNWRAP_REQUIRED = "unwrapRequired";
     public static final String OBJC_COMPATIBLE = "objcCompatible";
     public static final String POD_SOURCE = "podSource";
     public static final String POD_AUTHORS = "podAuthors";
@@ -125,8 +124,8 @@ public Swift4Codegen() {
                         // Added for Objective-C compatibility
                         "id", "description", "NSArray", "NSURL", "CGFloat", "NSSet", "NSString", "NSInteger", "NSUInteger",
                         "NSError", "NSDictionary"
-                        )
-                );
+                )
+        );
 
         reservedWords = new HashSet<>(
                 Arrays.asList(
@@ -209,10 +208,6 @@ public Swift4Codegen() {
                 "Optionally use libraries to manage response.  Currently "
                         + StringUtils.join(RESPONSE_LIBRARIES, ", ")
                         + " are available."));
-        cliOptions.add(new CliOption(UNWRAP_REQUIRED,
-                "Treat 'required' properties in response as non-optional "
-                        + "(which would crash the app if api returns null as opposed "
-                        + "to required option specified in json schema"));
         cliOptions.add(new CliOption(OBJC_COMPATIBLE,
                 "Add additional properties and methods for Objective-C "
                         + "compatibility (default: false)"));
@@ -330,13 +325,6 @@ public void processOpts() {
         }
         sourceFolder = projectName + File.separator + sourceFolder;
 
-        // Setup unwrapRequired option, which makes all the
-        // properties with "required" non-optional
-        if (additionalProperties.containsKey(UNWRAP_REQUIRED)) {
-            setUnwrapRequired(convertPropertyToBooleanAndWriteBack(UNWRAP_REQUIRED));
-        }
-        additionalProperties.put(UNWRAP_REQUIRED, unwrapRequired);
-
         // Setup objcCompatible option, which adds additional properties
         // and methods for Objective-C compatibility
         if (additionalProperties.containsKey(OBJC_COMPATIBLE)) {
@@ -712,10 +700,6 @@ public void setProjectName(String projectName) {
         this.projectName = projectName;
     }
 
-    public void setUnwrapRequired(boolean unwrapRequired) {
-        this.unwrapRequired = unwrapRequired;
-    }
-
     public void setObjcCompatible(boolean objcCompatible) {
         this.objcCompatible = objcCompatible;
     }
@@ -863,22 +847,9 @@ public Map<String, Object> postProcessModels(Map<String, Object> objs) {
     public void postProcessModelProperty(CodegenModel model, CodegenProperty property) {
         super.postProcessModelProperty(model, property);
 
-        // The default template code has the following logic for
-        // assigning a type as Swift Optional:
-        //
-        // {{^unwrapRequired}}?{{/unwrapRequired}}
-        // {{#unwrapRequired}}{{^required}}?{{/required}}{{/unwrapRequired}}
-        //
-        // which means:
-        //
-        // boolean isSwiftOptional = !unwrapRequired || (unwrapRequired && !property.required);
-        //
-        // We can drop the check for unwrapRequired in (unwrapRequired && !property.required)
-        // due to short-circuit evaluation of the || operator.
-        boolean isSwiftOptional = !unwrapRequired || !property.required;
         boolean isSwiftScalarType = property.isInteger || property.isLong || property.isFloat
                 || property.isDouble || property.isBoolean;
-        if (isSwiftOptional && isSwiftScalarType) {
+        if ((!property.required || property.isNullable) && isSwiftScalarType) {
             // Optional scalar types like Int?, Int64?, Float?, Double?, and Bool?
             // do not translate to Objective-C. So we want to flag those
             // properties in case we want to put special code in the templates

modules/openapi-generator/src/main/resources/swift4/modelObject.mustache

@@ -13,12 +13,16 @@ public struct {{classname}}: Codable {
 {{/isEnum}}
 {{^isEnum}}
     {{#description}}/** {{description}} */
-    {{/description}}public var {{name}}: {{{datatype}}}{{#unwrapRequired}}?{{/unwrapRequired}}{{^unwrapRequired}}{{^required}}?{{/required}}{{/unwrapRequired}}{{#defaultValue}} = {{{defaultValue}}}{{/defaultValue}}{{#objcCompatible}}{{#vendorExtensions.x-swift-optional-scalar}}
+    {{/description}}public var {{name}}: {{{datatype}}}{{#required}}{{#isNullable}}?{{/isNullable}}{{/required}}{{^required}}?{{/required}}{{#defaultValue}} = {{{defaultValue}}}{{/defaultValue}}
+    {{#objcCompatible}}
+    {{#vendorExtensions.x-swift-optional-scalar}}
     public var {{name}}Num: NSNumber? {
         get {
             return {{name}}.map({ return NSNumber(value: $0) })
         }
-    }{{/vendorExtensions.x-swift-optional-scalar}}{{/objcCompatible}}
+    }
+    {{/vendorExtensions.x-swift-optional-scalar}}
+    {{/objcCompatible}}
 {{/isEnum}}
 {{/allVars}}
 

modules/openapi-generator/src/test/java/org/openapitools/codegen/options/Swift4OptionsProvider.java

@@ -59,7 +59,6 @@ public Map<String, String> createOptions() {
                 .put(CodegenConstants.ENSURE_UNIQUE_PARAMS, ENSURE_UNIQUE_PARAMS_VALUE)
                 .put(Swift4Codegen.PROJECT_NAME, PROJECT_NAME_VALUE)
                 .put(Swift4Codegen.RESPONSE_AS, RESPONSE_AS_VALUE)
-                .put(Swift4Codegen.UNWRAP_REQUIRED, UNWRAP_REQUIRED_VALUE)
                 .put(Swift4Codegen.OBJC_COMPATIBLE, OBJC_COMPATIBLE_VALUE)
                 .put(Swift4Codegen.LENIENT_TYPE_CAST, LENIENT_TYPE_CAST_VALUE)
                 .put(Swift4Codegen.POD_SOURCE, POD_SOURCE_VALUE)

modules/openapi-generator/src/test/java/org/openapitools/codegen/swift4/Swift4OptionsTest.java

@@ -48,8 +48,6 @@ protected void setExpectations() {
             times = 1;
             clientCodegen.setResponseAs(Swift4OptionsProvider.RESPONSE_AS_VALUE.split(","));
             times = 1;
-            clientCodegen.setUnwrapRequired(Boolean.valueOf(Swift4OptionsProvider.UNWRAP_REQUIRED_VALUE));
-            times = 1;
             clientCodegen.setObjcCompatible(Boolean.valueOf(Swift4OptionsProvider.OBJC_COMPATIBLE_VALUE));
             times = 1;
             clientCodegen.setLenientTypeCast(Boolean.valueOf(Swift4OptionsProvider.LENIENT_TYPE_CAST_VALUE));