fix: #290 supports oneOf polymorphic types with dart_mappable

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

@@ -13,14 +13,28 @@ String dartDartMappableDtoTemplate(
   required bool markFileAsGenerated,
 }) {
   final className = dataClass.name.toPascal;
+
+  final parent = dataClass.discriminatorValue?.parentClass;
+
   return '''
 ${generatedFileComment(markFileAsGenerated: markFileAsGenerated)}
 ${dartImportDtoTemplate(JsonSerializer.dartMappable)}
 ${dartImports(imports: dataClass.imports)}
 part '${dataClass.name.toSnake}.mapper.dart';
 
-${descriptionComment(dataClass.description)}@MappableClass()
-class $className with ${className}Mappable {
+${descriptionComment(dataClass.description)}@MappableClass(${() {
+    if (dataClass.discriminator != null) {
+      return [
+        "discriminatorKey: '${dataClass.discriminator!.propertyName}'",
+        "includeSubClasses: [${dataClass.discriminator!.discriminatorValueToRefMapping.keys.join(', ')}]",
+      ].join(", ");
+    }
+    if (dataClass.discriminatorValue != null) {
+      return "discriminatorValue: '${dataClass.discriminatorValue!.propertyValue}'";
+    }
+    return "";
+  }()})
+class $className ${parent != null ? "extends $parent " : ""}with ${className}Mappable {
 
 ${indentation(2)}const $className(${getParameters(dataClass)});
 
@@ -34,16 +48,26 @@ ${indentation(
 }
 
 String getParameters(UniversalComponentClass dataClass) {
-  if (dataClass.parameters.isNotEmpty) {
-    return '{\n${_parametersToString(dataClass.parameters)}\n${indentation(2)}}';
+  // if this class has discriminated values, don't populate the discriminator field
+  // in the parent class
+  final parameters = dataClass.parameters
+      .where((it) => it.name != dataClass.discriminator?.propertyName)
+      .toList();
+  if (parameters.isNotEmpty) {
+    return '{\n${_parametersToString(parameters)}\n${indentation(2)}}';
   } else {
     return '';
   }
 }
 
 String getFields(UniversalComponentClass dataClass) {
-  if (dataClass.parameters.isNotEmpty) {
-    return '${_fieldsToString(dataClass.parameters)}\n';
+  // if this class has discriminated values, don't populate the discriminator field
+  // in the parent class
+  final parameters = dataClass.parameters
+      .where((it) => it.name != dataClass.discriminator?.propertyName)
+      .toList();
+  if (parameters.isNotEmpty) {
+    return '${_fieldsToString(parameters)}\n';
   } else {
     return '';
   }

swagger_parser/lib/src/parser/model/universal_component_class.dart

@@ -1,22 +1,25 @@
 part of 'universal_data_class.dart';
 
 /// Universal template for containing information about component
-@immutable
 final class UniversalComponentClass extends UniversalDataClass {
   /// Constructor for [UniversalComponentClass]
-  const UniversalComponentClass({
+  UniversalComponentClass({
     required super.name,
     required this.imports,
     required this.parameters,
     this.allOf,
     this.typeDef = false,
     this.discriminator,
+    this.discriminatorValue,
     super.description,
   });
 
   /// List of additional references to components
   final Set<String> imports;
 
+  /// The import of this class
+  String get import => name.toPascal;
+
   /// List of class fields
   final List<UniversalType> parameters;
 
@@ -35,6 +38,13 @@ final class UniversalComponentClass extends UniversalDataClass {
     Map<String, List<UniversalType>> refProperties,
   })? discriminator;
 
+  /// When using a discriminated oneOf, where this class is one of the discriminated values, this field contains the information about the parent
+  ({
+    // The name of the property that is used to discriminate the oneOf variants
+    String propertyValue,
+    String parentClass,
+  })? discriminatorValue;
+
   /// Whether or not this schema is a basic type
   /// "Date": {
   ///   "type": "string",

swagger_parser/lib/src/parser/model/universal_data_class.dart

@@ -1,6 +1,7 @@
 import 'package:collection/collection.dart';
 import 'package:meta/meta.dart';
 
+import '../utils/case_utils.dart';
 import '../utils/type_utils.dart';
 import 'universal_type.dart';
 

swagger_parser/lib/src/parser/parser/open_api_parser.dart

@@ -916,6 +916,13 @@ class OpenApiParser {
         }
         discriminator.refProperties[ref] = refedClass.parameters;
         discriminatedOneOfClass.imports.addAll(refedClass.imports);
+        discriminatedOneOfClass.imports.add(refedClass.import);
+
+        refedClass.imports.add(discriminatedOneOfClass.import);
+        refedClass.discriminatorValue = (
+          propertyValue: ref,
+          parentClass: discriminatedOneOfClass.name,
+        );
       }
     }
 

swagger_parser/test/e2e/e2e_test.dart

@@ -198,6 +198,19 @@ void main() {
       );
     });
 
+    test('discriminated_one_of.3.0_mappable', () async {
+      await e2eTest(
+        'basic/discriminated_one_of.3.0_mappable',
+        (outputDirectory, schemaPath) => SWPConfig(
+          outputDirectory: outputDirectory,
+          schemaPath: schemaPath,
+          jsonSerializer: JsonSerializer.dartMappable,
+          putClientsInFolder: true,
+        ),
+        schemaFileName: 'discriminated_one_of.3.0.json',
+      );
+    });
+
     test('empty_class.2.0', () async {
       await e2eTest(
         'basic/empty_class.2.0',

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0/expected_files/models/cat.dart

@@ -5,6 +5,7 @@
 import 'package:freezed_annotation/freezed_annotation.dart';
 
 import 'cat_type.dart';
+import 'family_members_union.dart';
 
 part 'cat.freezed.dart';
 part 'cat.g.dart';

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0/expected_files/models/dog.dart

@@ -5,6 +5,7 @@
 import 'package:freezed_annotation/freezed_annotation.dart';
 
 import 'dog_type.dart';
+import 'family_members_union.dart';
 
 part 'dog.freezed.dart';
 part 'dog.g.dart';

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0/expected_files/models/family_members_union.dart

@@ -4,8 +4,11 @@
 
 import 'package:freezed_annotation/freezed_annotation.dart';
 
+import 'cat.dart';
 import 'cat_type.dart';
+import 'dog.dart';
 import 'dog_type.dart';
+import 'human.dart';
 import 'human_type.dart';
 
 part 'family_members_union.freezed.dart';

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0/expected_files/models/human.dart

@@ -4,6 +4,7 @@
 
 import 'package:freezed_annotation/freezed_annotation.dart';
 
+import 'family_members_union.dart';
 import 'human_type.dart';
 
 part 'human.freezed.dart';

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0_mappable/discriminated_one_of.3.0.json

@@ -0,0 +1,83 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Family API",
+    "version": "1.0.0"
+  },
+  "paths": {},
+  "components": {
+    "schemas": {
+      "Family": {
+        "type": "object",
+        "properties": {
+          "members": {
+            "type": "array",
+            "items": {
+              "oneOf": [
+                {
+                  "$ref": "#/components/schemas/Cat"
+                },
+                {
+                  "$ref": "#/components/schemas/Dog"
+                },
+                {
+                  "$ref": "#/components/schemas/Human"
+                }
+              ],
+              "discriminator": {
+                "propertyName": "type",
+                "mapping": {
+                  "Cat": "#/components/schemas/Cat",
+                  "Dog": "#/components/schemas/Dog",
+                  "Human": "#/components/schemas/Human"
+                }
+              }
+            }
+          }
+        }
+      },
+      "Cat": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": ["Cat"]
+          },
+          "mewCount": {
+            "type": "integer",
+            "description": "Number of times the cat meows."
+          }
+        },
+        "required": ["type", "mewCount"]
+      },
+      "Dog": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": ["Dog"]
+          },
+          "barkSound": {
+            "type": "string",
+            "description": "The sound of the dog's bark."
+          }
+        },
+        "required": ["type", "barkSound"]
+      },
+      "Human": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": ["Human"]
+          },
+          "job": {
+            "type": "string",
+            "description": "The job of the human."
+          }
+        },
+        "required": ["type", "job"]
+      }
+    }
+  }
+}

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0_mappable/expected_files/export.dart

@@ -0,0 +1,13 @@
+// coverage:ignore-file
+// GENERATED CODE - DO NOT MODIFY BY HAND
+// ignore_for_file: type=lint, unused_import
+
+// Data classes
+export 'models/family.dart';
+export 'models/cat.dart';
+export 'models/dog.dart';
+export 'models/human.dart';
+export 'models/family_members_union.dart';
+export 'models/cat_type.dart';
+export 'models/dog_type.dart';
+export 'models/human_type.dart';

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0_mappable/expected_files/models/cat.dart

@@ -0,0 +1,24 @@
+// coverage:ignore-file
+// GENERATED CODE - DO NOT MODIFY BY HAND
+// ignore_for_file: type=lint, unused_import
+
+import 'package:dart_mappable/dart_mappable.dart';
+
+import 'cat_type.dart';
+import 'family_members_union.dart';
+
+part 'cat.mapper.dart';
+
+@MappableClass(discriminatorValue: 'Cat')
+class Cat extends FamilyMembersUnion with CatMappable {
+  const Cat({
+    required this.type,
+    required this.mewCount,
+  });
+
+  final CatType type;
+  final int mewCount;
+
+  static Cat fromJson(Map<String, dynamic> json) =>
+      CatMapper.ensureInitialized().decodeMap<Cat>(json);
+}

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0_mappable/expected_files/models/cat_type.dart

@@ -0,0 +1,13 @@
+// coverage:ignore-file
+// GENERATED CODE - DO NOT MODIFY BY HAND
+// ignore_for_file: type=lint, unused_import
+
+import 'package:dart_mappable/dart_mappable.dart';
+
+part 'cat_type.mapper.dart';
+
+@MappableEnum()
+enum CatType {
+  @MappableValue('Cat')
+  cat,
+}

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0_mappable/expected_files/models/dog.dart

@@ -0,0 +1,24 @@
+// coverage:ignore-file
+// GENERATED CODE - DO NOT MODIFY BY HAND
+// ignore_for_file: type=lint, unused_import
+
+import 'package:dart_mappable/dart_mappable.dart';
+
+import 'dog_type.dart';
+import 'family_members_union.dart';
+
+part 'dog.mapper.dart';
+
+@MappableClass(discriminatorValue: 'Dog')
+class Dog extends FamilyMembersUnion with DogMappable {
+  const Dog({
+    required this.type,
+    required this.barkSound,
+  });
+
+  final DogType type;
+  final String barkSound;
+
+  static Dog fromJson(Map<String, dynamic> json) =>
+      DogMapper.ensureInitialized().decodeMap<Dog>(json);
+}

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0_mappable/expected_files/models/dog_type.dart

@@ -0,0 +1,13 @@
+// coverage:ignore-file
+// GENERATED CODE - DO NOT MODIFY BY HAND
+// ignore_for_file: type=lint, unused_import
+
+import 'package:dart_mappable/dart_mappable.dart';
+
+part 'dog_type.mapper.dart';
+
+@MappableEnum()
+enum DogType {
+  @MappableValue('Dog')
+  dog,
+}

swagger_parser/test/e2e/tests/basic/discriminated_one_of.3.0_mappable/expected_files/models/family.dart

@@ -0,0 +1,21 @@
+// coverage:ignore-file
+// GENERATED CODE - DO NOT MODIFY BY HAND
+// ignore_for_file: type=lint, unused_import
+
+import 'package:dart_mappable/dart_mappable.dart';
+
+import 'family_members_union.dart';
+
+part 'family.mapper.dart';
+
+@MappableClass()
+class Family with FamilyMappable {
+  const Family({
+    required this.members,
+  });
+
+  final List<FamilyMembersUnion> members;
+
+  static Family fromJson(Map<String, dynamic> json) =>
+      FamilyMapper.ensureInitialized().decodeMap<Family>(json);
+}