fix: fix existing tests

Author: O-Hannonen

json_annotation/lib/src/json_serializable.dart

@@ -182,20 +182,6 @@ class JsonSerializable {
   /// fields annotated with [JsonKey].
   final FieldRename? fieldRename;
 
-  /// Defines the automatic naming strategy when converting class names
-  /// to union type names.
-  ///
-  /// With a value [UnionRename.none] (the default), the name of the class is
-  /// used without modification.
-  ///
-  /// See [UnionRename] for details on the other options.
-  final UnionRename? unionRename;
-
-  /// The discriminator key used to identify the union type.
-  ///
-  /// Defaults to `type`.
-  final String? unionDiscriminator;
-
   /// When `true` on classes with type parameters (generic types), extra
   /// "helper" parameters will be generated for `fromJson` and/or `toJson` to
   /// support serializing values of those types.
@@ -258,6 +244,20 @@ class JsonSerializable {
   /// `includeIfNull`, that value takes precedent.
   final bool? includeIfNull;
 
+  /// The discriminator key used to identify the union type.
+  ///
+  /// Defaults to `type`.
+  final String? unionDiscriminator;
+
+  /// Defines the automatic naming strategy when converting class names
+  /// to union type names.
+  ///
+  /// With a value [UnionRename.none] (the default), the name of the class is
+  /// used without modification.
+  ///
+  /// See [UnionRename] for details on the other options.
+  final UnionRename? unionRename;
+
   /// A list of [JsonConverter] to apply to this class.
   ///
   /// Writing:
@@ -305,13 +305,13 @@ class JsonSerializable {
     this.disallowUnrecognizedKeys,
     this.explicitToJson,
     this.fieldRename,
-    this.unionRename,
-    this.unionDiscriminator,
     this.ignoreUnannotated,
     this.includeIfNull,
     this.converters,
     this.genericArgumentFactories,
     this.createPerFieldToJson,
+    this.unionDiscriminator,
+    this.unionRename,
   });
 
   factory JsonSerializable.fromJson(Map<String, dynamic> json) =>
@@ -329,11 +329,11 @@ class JsonSerializable {
     disallowUnrecognizedKeys: false,
     explicitToJson: false,
     fieldRename: FieldRename.none,
-    unionRename: UnionRename.none,
-    unionDiscriminator: 'type',
     ignoreUnannotated: false,
     includeIfNull: true,
     genericArgumentFactories: false,
+    unionDiscriminator: 'type',
+    unionRename: UnionRename.none,
   );
 
   /// Returns a new [JsonSerializable] instance with fields equal to the
@@ -352,12 +352,12 @@ class JsonSerializable {
         disallowUnrecognizedKeys ?? defaults.disallowUnrecognizedKeys,
     explicitToJson: explicitToJson ?? defaults.explicitToJson,
     fieldRename: fieldRename ?? defaults.fieldRename,
-    unionRename: unionRename ?? defaults.unionRename,
-    unionDiscriminator: unionDiscriminator ?? defaults.unionDiscriminator,
     ignoreUnannotated: ignoreUnannotated ?? defaults.ignoreUnannotated,
     includeIfNull: includeIfNull ?? defaults.includeIfNull,
     genericArgumentFactories:
         genericArgumentFactories ?? defaults.genericArgumentFactories,
+    unionDiscriminator: unionDiscriminator ?? defaults.unionDiscriminator,
+    unionRename: unionRename ?? defaults.unionRename,
   );
 
   Map<String, dynamic> toJson() => _$JsonSerializableToJson(this);

json_annotation/lib/src/json_serializable.g.dart

@@ -282,6 +282,8 @@ targets:
           generic_argument_factories: false
           ignore_unannotated: false
           include_if_null: true
+          union_discriminator: type
+          union_rename: none
 ```
 
 To exclude generated files from coverage, you can further configure `build.yaml`.

json_serializable/README.md

@@ -54,13 +54,13 @@ class ClassConfig {
   final bool disallowUnrecognizedKeys;
   final bool explicitToJson;
   final FieldRename fieldRename;
-  final UnionRename unionRename;
-  final String unionDiscriminator;
   final bool genericArgumentFactories;
   final bool ignoreUnannotated;
   final bool includeIfNull;
   final Map<String, String> ctorParamDefaults;
   final List<DartObject> converters;
+  final String unionDiscriminator;
+  final UnionRename unionRename;
 
   const ClassConfig({
     required this.anyMap,
@@ -74,11 +74,11 @@ class ClassConfig {
     required this.disallowUnrecognizedKeys,
     required this.explicitToJson,
     required this.fieldRename,
-    required this.unionRename,
-    required this.unionDiscriminator,
     required this.genericArgumentFactories,
     required this.ignoreUnannotated,
     required this.includeIfNull,
+    required this.unionDiscriminator,
+    required this.unionRename,
     this.converters = const [],
     this.ctorParamDefaults = const {},
   });
@@ -109,13 +109,13 @@ class ClassConfig {
             config.genericArgumentFactories ??
             ClassConfig.defaults.genericArgumentFactories,
         fieldRename: config.fieldRename ?? ClassConfig.defaults.fieldRename,
-        unionRename: config.unionRename ?? ClassConfig.defaults.unionRename,
-        unionDiscriminator:
-            config.unionDiscriminator ??
-            ClassConfig.defaults.unionDiscriminator,
         disallowUnrecognizedKeys:
             config.disallowUnrecognizedKeys ??
             ClassConfig.defaults.disallowUnrecognizedKeys,
+        unionDiscriminator:
+            config.unionDiscriminator ??
+            ClassConfig.defaults.unionDiscriminator,
+        unionRename: config.unionRename ?? ClassConfig.defaults.unionRename,
         // TODO typeConverters = []
       );
 
@@ -133,11 +133,11 @@ class ClassConfig {
     disallowUnrecognizedKeys: false,
     explicitToJson: false,
     fieldRename: FieldRename.none,
-    unionRename: UnionRename.none,
-    unionDiscriminator: 'type',
     genericArgumentFactories: false,
     ignoreUnannotated: false,
     includeIfNull: true,
+    unionDiscriminator: 'type',
+    unionRename: UnionRename.none,
   );
 
   JsonSerializable toJsonSerializable() => JsonSerializable(
@@ -154,9 +154,9 @@ class ClassConfig {
     includeIfNull: includeIfNull,
     genericArgumentFactories: genericArgumentFactories,
     fieldRename: fieldRename,
-    unionRename: unionRename,
-    unionDiscriminator: unionDiscriminator,
     disallowUnrecognizedKeys: disallowUnrecognizedKeys,
+    unionDiscriminator: unionDiscriminator,
+    unionRename: unionRename,
     // TODO typeConverters = []
   );
 }

json_serializable/lib/src/type_helpers/config_types.dart

@@ -61,12 +61,12 @@ JsonSerializable _valueForAnnotation(ConstantReader reader) => JsonSerializable(
       reader.read('disallowUnrecognizedKeys').literalValue as bool?,
   explicitToJson: reader.read('explicitToJson').literalValue as bool?,
   fieldRename: readEnum(reader.read('fieldRename'), FieldRename.values),
-  unionRename: readEnum(reader.read('unionRename'), UnionRename.values),
-  unionDiscriminator: reader.read('unionDiscriminator').literalValue as String?,
   genericArgumentFactories:
       reader.read('genericArgumentFactories').literalValue as bool?,
   ignoreUnannotated: reader.read('ignoreUnannotated').literalValue as bool?,
   includeIfNull: reader.read('includeIfNull').literalValue as bool?,
+  unionDiscriminator: reader.read('unionDiscriminator').literalValue as String?,
+  unionRename: readEnum(reader.read('unionRename'), UnionRename.values),
 );
 
 /// Returns a [ClassConfig] with values from the [JsonSerializable]
@@ -116,9 +116,6 @@ ClassConfig mergeConfig(
         annotation.disallowUnrecognizedKeys ?? config.disallowUnrecognizedKeys,
     explicitToJson: annotation.explicitToJson ?? config.explicitToJson,
     fieldRename: annotation.fieldRename ?? config.fieldRename,
-    unionRename: annotation.unionRename ?? config.unionRename,
-    unionDiscriminator:
-        annotation.unionDiscriminator ?? config.unionDiscriminator,
     genericArgumentFactories:
         annotation.genericArgumentFactories ??
         (classElement.typeParameters.isNotEmpty &&
@@ -127,6 +124,9 @@ ClassConfig mergeConfig(
     includeIfNull: annotation.includeIfNull ?? config.includeIfNull,
     ctorParamDefaults: paramDefaultValueMap,
     converters: converters.isNull ? const [] : converters.listValue,
+    unionDiscriminator:
+        annotation.unionDiscriminator ?? config.unionDiscriminator,
+    unionRename: annotation.unionRename ?? config.unionRename,
   );
 }
 

json_serializable/lib/src/utils.dart

@@ -43,6 +43,12 @@ void main() {
     );
 
     for (var entry in generatorConfigDefaultJson.entries) {
+      expect(
+        generatorConfigNonDefaultJson[entry.key],
+        isNotNull,
+        reason: 'should have explicitly set non default value',
+      );
+
       expect(
         generatorConfigNonDefaultJson,
         containsPair(entry.key, isNot(entry.value)),
@@ -91,7 +97,7 @@ void main() {
       configMap.keys,
       unorderedEquals(generatorConfigDefaultJson.keys),
       reason:
-          'All supported keys are documented. '
+          'All supported keys are not documented. '
           'Did you forget to change README.md?',
     );
 
@@ -133,6 +139,12 @@ void main() {
           'field_rename' =>
             '`42` is not one of the supported values: none, kebab, snake, '
                 'pascal, screamingSnake',
+          'union_rename' =>
+            '`42` is not one of the supported values: none, kebab, snake, '
+                'pascal, screamingSnake',
+          'union_discriminator' =>
+            "type 'int' is not a subtype of type 'String?' in type "
+                'cast',
           'constructor' =>
             "type 'int' is not a subtype of type 'String?' in type "
                 'cast',
@@ -175,4 +187,6 @@ const _invalidConfig = {
   'generic_argument_factories': 42,
   'ignore_unannotated': 42,
   'include_if_null': 42,
+  'union_discriminator': 42,
+  'union_rename': 42,
 };

json_serializable/test/config_test.dart

@@ -28,5 +28,7 @@ final generatorConfigNonDefaultJson = Map<String, dynamic>.unmodifiable(
     ignoreUnannotated: true,
     includeIfNull: false,
     genericArgumentFactories: true,
+    unionDiscriminator: 'runtimeType',
+    unionRename: UnionRename.kebab,
   ).toJson(),
 );

json_serializable/test/shared_config.dart

@@ -24,6 +24,8 @@ class ConfigurationImplicitDefaults {
   ignoreUnannotated: false,
   includeIfNull: true,
   genericArgumentFactories: false,
+  unionDiscriminator: 'type',
+  unionRename: UnionRename.none,
 )
 class ConfigurationExplicitDefaults {
   int? field;

json_serializable/test/test_sources/test_sources.dart

@@ -150,6 +150,8 @@ targets:
           generic_argument_factories: false
           ignore_unannotated: false
           include_if_null: true
+          union_discriminator: type
+          union_rename: none
 ```
 
 To exclude generated files from coverage, you can further configure `build.yaml`.