Add include_if_null (#333)

Author: vasilich6107

.gitignore

@@ -1 +1,2 @@
-.vscode
+.vscode
+.idea/

swagger_parser/.gitignore

@@ -2,7 +2,7 @@
 .packages
 build/
 pubspec.lock
-.idea/
+.idea
 swagger_parser.yaml
 !example/swagger_parser.yaml
 **/generated_files/**

swagger_parser/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.34.0
+- includeIfNull handling, turned off by default, use include_if_null=true to enable
+
 ## 1.33.0
 - Support correct processing of nested allOf classes
 

swagger_parser/README.md

@@ -195,6 +195,11 @@ swagger_parser:
   # This is useful when using swagger_parser together with build_runner, which needs to map
   # input files to output files 1-to-1.
   merge_outputs: false
+
+  # DART ONLY
+  # Optional. Set `true` to generate includeIfNull annotations for nullable fields.
+  # If set to `false`, includeIfNull annotations will not be generated.
+  include_if_null: false
 ```
 
 For multiple schemes:

swagger_parser/lib/src/config/swp_config.dart

@@ -43,6 +43,7 @@ class SWPConfig {
     this.includeTags = const <String>[],
     this.fallbackClient = 'fallback',
     this.mergeOutputs = false,
+    this.includeIfNull = false,
   });
 
   /// Internal constructor of [SWPConfig]
@@ -79,6 +80,7 @@ class SWPConfig {
     required this.fallbackClient,
     required this.mergeOutputs,
     required this.dartMappableConvenientWhen,
+    required this.includeIfNull,
     this.fallbackUnion,
   });
 
@@ -277,6 +279,9 @@ class SWPConfig {
     final mergeOutputs =
         yamlMap['merge_outputs'] as bool? ?? rootConfig?.mergeOutputs;
 
+    final includeIfNull =
+        yamlMap['include_if_null'] as bool? ?? rootConfig?.includeIfNull;
+
     // Default config
     final dc = SWPConfig(name: name, outputDirectory: outputDirectory);
 
@@ -316,6 +321,7 @@ class SWPConfig {
       fallbackClient: fallbackClient ?? dc.fallbackClient,
       mergeOutputs: mergeOutputs ?? dc.mergeOutputs,
       dartMappableConvenientWhen: dartMappableConvenientWhen,
+      includeIfNull: includeIfNull ?? dc.includeIfNull,
     );
   }
 
@@ -495,6 +501,11 @@ class SWPConfig {
   /// input files to output files 1-to-1.
   final bool mergeOutputs;
 
+  /// DART ONLY
+  /// Optional. Set `true` to generate includeIfNull annotations for nullable fields.
+  /// If set to `false`, includeIfNull annotations will not be generated.
+  final bool includeIfNull;
+
   /// Convert [SWPConfig] to [GeneratorConfig]
   GeneratorConfig toGeneratorConfig() {
     return GeneratorConfig(
@@ -521,6 +532,7 @@ class SWPConfig {
       fallbackUnion: fallbackUnion,
       dartMappableConvenientWhen: dartMappableConvenientWhen,
       mergeOutputs: mergeOutputs,
+      includeIfNull: includeIfNull,
     );
   }
 

swagger_parser/lib/src/generator/config/generator_config.dart

@@ -29,6 +29,7 @@ class GeneratorConfig {
     this.fallbackUnion,
     this.dartMappableConvenientWhen = true,
     this.mergeOutputs = false,
+    this.includeIfNull = false,
   });
 
   /// Optional. Set API name for folder and export file or merged output file
@@ -137,4 +138,9 @@ class GeneratorConfig {
   /// This is useful when using swagger_parser together with build_runner, which needs to map
   /// input files to output files 1-to-1.
   final bool mergeOutputs;
+
+  /// DART ONLY
+  /// Optional. Set `true` to generate includeIfNull annotations for nullable fields.
+  /// If set to `false`, includeIfNull annotations will not be generated.
+  final bool includeIfNull;
 }

swagger_parser/lib/src/generator/generator/fill_controller.dart

@@ -34,6 +34,7 @@ final class FillController {
           useFreezed3: config.useFreezed3,
           useMultipartFile: config.useMultipartFile,
           dartMappableConvenientWhen: config.dartMappableConvenientWhen,
+          includeIfNull: config.includeIfNull,
           fallbackUnion: config.fallbackUnion,
         ),
       );

swagger_parser/lib/src/generator/model/programming_language.dart

@@ -50,6 +50,7 @@ enum ProgrammingLanguage {
     required bool useFreezed3,
     required bool useMultipartFile,
     required bool dartMappableConvenientWhen,
+    required bool includeIfNull,
     String? fallbackUnion,
   }) {
     switch (this) {
@@ -73,12 +74,14 @@ enum ProgrammingLanguage {
                 generateValidator: generateValidator,
                 isV3: useFreezed3,
                 useMultipartFile: useMultipartFile,
+                includeIfNull: includeIfNull,
                 fallbackUnion: fallbackUnion,
               ),
             JsonSerializer.jsonSerializable => dartJsonSerializableDtoTemplate(
                 dataClass,
                 markFileAsGenerated: markFilesAsGenerated,
                 useMultipartFile: useMultipartFile,
+                includeIfNull: includeIfNull,
                 fallbackUnion: fallbackUnion,
               ),
             JsonSerializer.dartMappable => dartDartMappableDtoTemplate(

swagger_parser/lib/src/generator/templates/dart_freezed_dto_template.dart

@@ -9,6 +9,7 @@ import 'package:swagger_parser/src/utils/type_utils.dart';
 String dartFreezedDtoTemplate(
   UniversalComponentClass dataClass, {
   required bool useMultipartFile,
+  required bool includeIfNull,
   bool generateValidator = false,
   bool isV3 = false,
   String? fallbackUnion,
@@ -32,7 +33,7 @@ ${descriptionComment(dataClass.description)}@Freezed(${[
       "fallbackUnion: '$fallbackUnion'",
   ].join(', ')})
 ${_classModifier(isUnion: isUnion, isV3: isV3)}class $className with _\$$className {
-${_factories(dataClass, className, useMultipartFile, fallbackUnion, isUnion: isUnion)}
+${_factories(dataClass, className, useMultipartFile, includeIfNull, fallbackUnion, isUnion: isUnion)}
 ${_jsonFactories(className, dataClass.undiscriminatedUnionVariants)}
 ${generateValidator ? dataClass.parameters.map(_validationString).nonNulls.join() : ''}}
 ${generateValidator ? _validateMethod(className, dataClass.parameters) : ''}''';
@@ -170,11 +171,11 @@ String _validateMethod(String className, Set<UniversalType> types) {
 }
 
 String _factories(UniversalComponentClass dataClass, String className,
-    bool useMultipartFile, String? fallbackUnion,
+    bool useMultipartFile, bool includeIfNull, String? fallbackUnion,
     {required bool isUnion}) {
   if (!isUnion) {
     return '''
-  const factory $className(${dataClass.parameters.isNotEmpty ? '{' : ''}${_parametersToString(dataClass.parameters, useMultipartFile)}${dataClass.parameters.isNotEmpty ? '\n  }' : ''}) = _$className;''';
+  const factory $className(${dataClass.parameters.isNotEmpty ? '{' : ''}${_parametersToString(dataClass.parameters, useMultipartFile, includeIfNull)}${dataClass.parameters.isNotEmpty ? '\n  }' : ''}) = _$className;''';
   }
 
   if (dataClass.undiscriminatedUnionVariants case final variants?
@@ -183,6 +184,7 @@ String _factories(UniversalComponentClass dataClass, String className,
       className,
       variants,
       useMultipartFile,
+      includeIfNull,
     );
   }
 
@@ -198,7 +200,7 @@ String _factories(UniversalComponentClass dataClass, String className,
 
     factories.add('''
   @FreezedUnionValue('$discriminatorValue')
-  const factory $className.$factoryName(${factoryParameters.isNotEmpty ? '{' : ''}${_parametersToString(factoryParameters, useMultipartFile)}${factoryParameters.isNotEmpty ? '\n  }' : ''}) = $unionItemClassName;
+  const factory $className.$factoryName(${factoryParameters.isNotEmpty ? '{' : ''}${_parametersToString(factoryParameters, useMultipartFile, includeIfNull)}${factoryParameters.isNotEmpty ? '\n  }' : ''}) = $unionItemClassName;
 ''');
   }
 
@@ -212,16 +214,19 @@ String _factories(UniversalComponentClass dataClass, String className,
   return factories.join('\n');
 }
 
-String _createFactoriesForUndiscriminatedUnion(String className,
-    Map<String, Set<UniversalType>> variants, bool useMultipartFile) {
+String _createFactoriesForUndiscriminatedUnion(
+    String className,
+    Map<String, Set<UniversalType>> variants,
+    bool useMultipartFile,
+    bool includeIfNull) {
   final factories = <String>[];
   for (final MapEntry(key: variantName, value: factoryParameters)
       in variants.entries) {
     final factoryName = variantName.toCamel;
     final unionItemClassName = className + variantName.toPascal;
     factories.add('''
   @JsonSerializable()
-  const factory $className.$factoryName(${factoryParameters.isNotEmpty ? '{' : ''}${_parametersToString(factoryParameters, useMultipartFile)}${factoryParameters.isNotEmpty ? '\n  }' : ''}) = $unionItemClassName;
+  const factory $className.$factoryName(${factoryParameters.isNotEmpty ? '{' : ''}${_parametersToString(factoryParameters, useMultipartFile, includeIfNull)}${factoryParameters.isNotEmpty ? '\n  }' : ''}) = $unionItemClassName;
   ''');
   }
   return factories.join('\n');
@@ -307,37 +312,49 @@ String? _validationString(UniversalType type) {
 }
 
 String _parametersToString(
-    Set<UniversalType> parameters, bool useMultipartFile) {
+    Set<UniversalType> parameters, bool useMultipartFile, bool includeIfNull) {
   final sortedByRequired = Set<UniversalType>.from(
     parameters.sorted((a, b) => a.compareTo(b)),
   );
   return sortedByRequired
       .mapIndexed(
         (i, e) =>
             '\n${i != 0 && (e.description?.isNotEmpty ?? false) ? '\n' : ''}${descriptionComment(e.description, tab: '    ')}'
-            '${_jsonKey(e)}    ${_required(e)}'
+            '${_jsonKey(e, includeIfNull)}    ${_required(e)}'
             '${e.toSuitableType(ProgrammingLanguage.dart, useMultipartFile: useMultipartFile)} ${e.name},',
       )
       .join();
 }
 
-String _jsonKey(UniversalType t) {
+String _jsonKey(UniversalType t, bool includeIfNull) {
   final sb = StringBuffer();
-  if ((t.jsonKey == null || t.name == t.jsonKey) &&
-      t.defaultValue == null &&
-      !t.deprecated) {
-    return '';
-  }
-  if (t.deprecated) {
-    sb.write("    @Deprecated('This is marked as deprecated')\n");
+  final jsonKeyParams = <String, String?>{};
+
+  if (includeIfNull) {
+    if (t.isRequired && (t.nullable || t.referencedNullable)) {
+      jsonKeyParams['includeIfNull'] = 'true';
+    } else if (!t.isRequired && (t.nullable || t.referencedNullable)) {
+      jsonKeyParams['includeIfNull'] = 'false';
+    }
   }
+
   if (t.jsonKey != null && t.name != t.jsonKey) {
-    sb.write("    @JsonKey(name: '${protectJsonKey(t.jsonKey)}')\n");
+    jsonKeyParams['name'] = "'${protectJsonKey(t.jsonKey)}'";
   }
+
+  if (jsonKeyParams.isNotEmpty) {
+    sb.write(
+        "    @JsonKey(${jsonKeyParams.entries.map((e) => '${e.key}: ${e.value}').join(',')})\n");
+  }
+
   if (t.defaultValue != null) {
     sb.write('    @Default(${_defaultValue(t)})\n');
   }
 
+  if (t.deprecated) {
+    sb.write("    @Deprecated('This is marked as deprecated')\n");
+  }
+
   return sb.toString();
 }