Fix BigInt, DateTime, Uri JsonKey.defaultValue w/ a function (#1220)

Fixes #1219 Prepare to release v6.5.1
google · Oct 10, 2022 · a79c6b7 · a79c6b7
1 parent 0e89d96
commit a79c6b7
Show file tree

Hide file tree

Showing 18 changed files with 123 additions and 15 deletions.
diff --git a/json_serializable/CHANGELOG.md b/json_serializable/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 6.5.1
+
+- Fixed `BigInt`, `DateTime`, and `Uri` support for `JsonKey.defaultValue` with
+  a function value.
+
 ## 6.5.0
 
 - Allow constructors to be passed to `JsonKey` parameters that support

diff --git a/json_serializable/lib/src/type_helpers/big_int_helper.dart b/json_serializable/lib/src/type_helpers/big_int_helper.dart
@@ -5,6 +5,7 @@
 import 'package:analyzer/dart/element/type.dart';
 import 'package:source_helper/source_helper.dart';
 
+import '../default_container.dart';
 import '../type_helper.dart';
 import 'to_from_string.dart';
 
@@ -24,7 +25,7 @@ class BigIntHelper extends TypeHelper {
       );
 
   @override
-  String? deserialize(
+  DefaultContainer? deserialize(
     DartType targetType,
     String expression,
     TypeHelperContext context,

diff --git a/json_serializable/lib/src/type_helpers/date_time_helper.dart b/json_serializable/lib/src/type_helpers/date_time_helper.dart
@@ -5,6 +5,7 @@
 import 'package:analyzer/dart/element/type.dart';
 import 'package:source_helper/source_helper.dart';
 
+import '../default_container.dart';
 import '../type_helper.dart';
 import 'to_from_string.dart';
 
@@ -24,7 +25,7 @@ class DateTimeHelper extends TypeHelper {
       );
 
   @override
-  String? deserialize(
+  DefaultContainer? deserialize(
     DartType targetType,
     String expression,
     TypeHelperContext context,

diff --git a/json_serializable/lib/src/type_helpers/map_helper.dart b/json_serializable/lib/src/type_helpers/map_helper.dart
@@ -126,7 +126,8 @@ class MapHelper extends TypeHelper<TypeHelperContextWithConfig> {
 
     final toFromString = _forType(keyArg);
     if (toFromString != null) {
-      keyUsage = toFromString.deserialize(keyArg, keyUsage, false, true)!;
+      keyUsage =
+          toFromString.deserialize(keyArg, keyUsage, false, true).toString();
     }
 
     return '($expression $mapCast)$optionalQuestion.map( '

diff --git a/json_serializable/lib/src/type_helpers/to_from_string.dart b/json_serializable/lib/src/type_helpers/to_from_string.dart
@@ -5,7 +5,7 @@
 import 'package:analyzer/dart/element/type.dart';
 import 'package:source_gen/source_gen.dart';
 
-import '../utils.dart';
+import '../default_container.dart';
 
 final bigIntString = ToFromStringHelper(
   'BigInt.parse',
@@ -64,7 +64,7 @@ class ToFromStringHelper {
     return '$expression.$_toString';
   }
 
-  String? deserialize(
+  DefaultContainer? deserialize(
     DartType type,
     String expression,
     bool nullable,
@@ -78,6 +78,9 @@ class ToFromStringHelper {
 
     final output = '$_parse($parseParam)';
 
-    return nullable ? ifNullOrElse(expression, 'null', output) : output;
+    return DefaultContainer(
+      expression,
+      output,
+    );
   }
 }
diff --git a/json_serializable/lib/src/type_helpers/uri_helper.dart b/json_serializable/lib/src/type_helpers/uri_helper.dart
@@ -5,6 +5,7 @@
 import 'package:analyzer/dart/element/type.dart';
 import 'package:source_helper/source_helper.dart';
 
+import '../default_container.dart';
 import '../type_helper.dart';
 import 'to_from_string.dart';
 
@@ -24,7 +25,7 @@ class UriHelper extends TypeHelper {
       );
 
   @override
-  String? deserialize(
+  DefaultContainer? deserialize(
     DartType targetType,
     String expression,
     TypeHelperContext context,

diff --git a/json_serializable/pubspec.yaml b/json_serializable/pubspec.yaml
@@ -1,5 +1,5 @@
 name: json_serializable
-version: 6.5.0
+version: 6.5.1
 description: >-
   Automatically generate code for converting to and from JSON by annotating
   Dart classes.

diff --git a/json_serializable/test/supported_types/input.type_bigint.dart b/json_serializable/test/supported_types/input.type_bigint.dart
@@ -10,8 +10,12 @@ part 'input.type_bigint.g.dart';
 class SimpleClass {
   final BigInt value;
 
+  @JsonKey(defaultValue: _defaultValueFunc)
+  BigInt withDefault;
+
   SimpleClass(
     this.value,
+    this.withDefault,
   );
 
   factory SimpleClass.fromJson(Map<String, Object?> json) =>
@@ -24,12 +28,18 @@ class SimpleClass {
 class SimpleClassNullable {
   final BigInt? value;
 
+  @JsonKey(defaultValue: _defaultValueFunc)
+  BigInt? withDefault;
+
   SimpleClassNullable(
     this.value,
+    this.withDefault,
   );
 
   factory SimpleClassNullable.fromJson(Map<String, Object?> json) =>
       _$SimpleClassNullableFromJson(json);
 
   Map<String, Object?> toJson() => _$SimpleClassNullableToJson(this);
 }
+
+BigInt _defaultValueFunc() => BigInt.parse('12345');
diff --git a/json_serializable/test/supported_types/input.type_bigint.g.dart b/json_serializable/test/supported_types/input.type_bigint.g.dart
diff --git a/json_serializable/test/supported_types/input.type_datetime.dart b/json_serializable/test/supported_types/input.type_datetime.dart
@@ -10,8 +10,12 @@ part 'input.type_datetime.g.dart';
 class SimpleClass {
   final DateTime value;
 
+  @JsonKey(defaultValue: _defaultValueFunc)
+  DateTime withDefault;
+
   SimpleClass(
     this.value,
+    this.withDefault,
   );
 
   factory SimpleClass.fromJson(Map<String, Object?> json) =>
@@ -24,12 +28,18 @@ class SimpleClass {
 class SimpleClassNullable {
   final DateTime? value;
 
+  @JsonKey(defaultValue: _defaultValueFunc)
+  DateTime? withDefault;
+
   SimpleClassNullable(
     this.value,
+    this.withDefault,
   );
 
   factory SimpleClassNullable.fromJson(Map<String, Object?> json) =>
       _$SimpleClassNullableFromJson(json);
 
   Map<String, Object?> toJson() => _$SimpleClassNullableToJson(this);
 }
+
+DateTime _defaultValueFunc() => DateTime.parse('2020-01-01T00:00:00.000');
diff --git a/json_serializable/test/supported_types/input.type_datetime.g.dart b/json_serializable/test/supported_types/input.type_datetime.g.dart
diff --git a/json_serializable/test/supported_types/input.type_uri.dart b/json_serializable/test/supported_types/input.type_uri.dart
@@ -10,8 +10,12 @@ part 'input.type_uri.g.dart';
 class SimpleClass {
   final Uri value;
 
+  @JsonKey(defaultValue: _defaultValueFunc)
+  Uri withDefault;
+
   SimpleClass(
     this.value,
+    this.withDefault,
   );
 
   factory SimpleClass.fromJson(Map<String, Object?> json) =>
@@ -24,12 +28,18 @@ class SimpleClass {
 class SimpleClassNullable {
   final Uri? value;
 
+  @JsonKey(defaultValue: _defaultValueFunc)
+  Uri? withDefault;
+
   SimpleClassNullable(
     this.value,
+    this.withDefault,
   );
 
   factory SimpleClassNullable.fromJson(Map<String, Object?> json) =>
       _$SimpleClassNullableFromJson(json);
 
   Map<String, Object?> toJson() => _$SimpleClassNullableToJson(this);
 }
+
+Uri _defaultValueFunc() => Uri.parse('https://example.com');
diff --git a/json_serializable/test/supported_types/input.type_uri.g.dart b/json_serializable/test/supported_types/input.type_uri.g.dart
diff --git a/json_serializable/test/supported_types/type_test.bigint_test.dart b/json_serializable/test/supported_types/type_test.bigint_test.dart
@@ -95,12 +95,15 @@ final _defaultInput = <String, Object?>{
 
 final _defaultOutput = {
   'value': _defaultValue,
+  'withDefault': _defaultValue,
 };
 
 final _nullableDefaultOutput = {
   'value': null,
+  'withDefault': _defaultValue,
 };
 
 final _nonDefaultJson = {
   'value': _altValue,
+  'withDefault': _altValue,
 };
diff --git a/json_serializable/test/supported_types/type_test.datetime_test.dart b/json_serializable/test/supported_types/type_test.datetime_test.dart
@@ -95,12 +95,15 @@ final _defaultInput = <String, Object?>{
 
 final _defaultOutput = {
   'value': _defaultValue,
+  'withDefault': _defaultValue,
 };
 
 final _nullableDefaultOutput = {
   'value': null,
+  'withDefault': _defaultValue,
 };
 
 final _nonDefaultJson = {
   'value': _altValue,
+  'withDefault': _altValue,
 };
diff --git a/json_serializable/test/supported_types/type_test.uri_test.dart b/json_serializable/test/supported_types/type_test.uri_test.dart
@@ -95,12 +95,15 @@ final _defaultInput = <String, Object?>{
 
 final _defaultOutput = {
   'value': _defaultValue,
+  'withDefault': _defaultValue,
 };
 
 final _nullableDefaultOutput = {
   'value': null,
+  'withDefault': _defaultValue,
 };
 
 final _nonDefaultJson = {
   'value': _altValue,
+  'withDefault': _altValue,
 };
diff --git a/json_serializable/tool/test_type_builder.dart b/json_serializable/tool/test_type_builder.dart
@@ -15,15 +15,15 @@ import 'test_type_data.dart';
 final _formatter = DartFormatter();
 
 const _trivialTypesToTest = {
-  'BigInt': TestTypeData(
+  'BigInt': TestTypeData.defaultFunc(
     jsonExpression: "'12345'",
     altJsonExpression: "'67890'",
   ),
   'bool': TestTypeData(
     defaultExpression: 'true',
     altJsonExpression: 'false',
   ),
-  'DateTime': TestTypeData(
+  'DateTime': TestTypeData.defaultFunc(
     jsonExpression: "'2020-01-01T00:00:00.000'",
     altJsonExpression: "'2018-01-01T00:00:00.000'",
   ),
@@ -56,7 +56,7 @@ const _trivialTypesToTest = {
     defaultExpression: "'a string'",
     altJsonExpression: "'another string'",
   ),
-  'Uri': TestTypeData(
+  'Uri': TestTypeData.defaultFunc(
     jsonExpression: "'https://example.com'",
     altJsonExpression: "'https://dart.dev'",
   ),