WIP: default to using toJson function

Author: kevmoo

json_serializable/README.md

@@ -27,12 +27,13 @@ import 'package:json_annotation/json_annotation.dart';
 part 'example.g.dart';
 
 @JsonSerializable(nullable: false)
-class Person extends Object with _$PersonSerializerMixin {
+class Person {
   final String firstName;
   final String lastName;
   final DateTime dateOfBirth;
   Person({this.firstName, this.lastName, this.dateOfBirth});
   factory Person.fromJson(Map<String, dynamic> json) => _$PersonFromJson(json);
+  Map<String, dynamic> toJson() => _$PersonToJson(this);
 }
 ```
 
@@ -48,16 +49,11 @@ Person _$PersonFromJson(Map<String, dynamic> json) {
       dateOfBirth: DateTime.parse(json['dateOfBirth'] as String));
 }
 
-abstract class _$PersonSerializerMixin {
-  String get firstName;
-  String get lastName;
-  DateTime get dateOfBirth;
-  Map<String, dynamic> toJson() => <String, dynamic>{
-        'firstName': firstName,
-        'lastName': lastName,
-        'dateOfBirth': dateOfBirth.toIso8601String()
-      };
-}
+Map<String, dynamic> _$PersonToJson(Person instance) => <String, dynamic>{
+      'firstName': instance.firstName,
+      'lastName': instance.lastName,
+      'dateOfBirth': instance.dateOfBirth.toIso8601String()
+    };
 ```
 
 # Build configuration
@@ -93,7 +89,7 @@ targets:
           any_map: true
           checked: true
           explicit_to_json: true
-          generate_to_json_function: true
+          generate_to_json_mixin: true
 ```
 
 [example]: https://github.com/dart-lang/json_serializable/blob/master/example

json_serializable/example/example.dart

@@ -8,10 +8,11 @@ import 'package:json_annotation/json_annotation.dart';
 part 'example.g.dart';
 
 @JsonSerializable(nullable: false)
-class Person extends Object with _$PersonSerializerMixin {
+class Person {
   final String firstName;
   final String lastName;
   final DateTime dateOfBirth;
   Person({this.firstName, this.lastName, this.dateOfBirth});
   factory Person.fromJson(Map<String, dynamic> json) => _$PersonFromJson(json);
+  Map<String, dynamic> toJson() => _$PersonToJson(this);
 }

json_serializable/example/example.g.dart

@@ -17,13 +17,8 @@ Person _$PersonFromJson(Map<String, dynamic> json) {
       dateOfBirth: DateTime.parse(json['dateOfBirth'] as String));
 }
 
-abstract class _$PersonSerializerMixin {
-  String get firstName;
-  String get lastName;
-  DateTime get dateOfBirth;
-  Map<String, dynamic> toJson() => <String, dynamic>{
-        'firstName': firstName,
-        'lastName': lastName,
-        'dateOfBirth': dateOfBirth.toIso8601String()
-      };
-}
+Map<String, dynamic> _$PersonToJson(Person instance) => <String, dynamic>{
+      'firstName': instance.firstName,
+      'lastName': instance.lastName,
+      'dateOfBirth': instance.dateOfBirth.toIso8601String()
+    };

json_serializable/lib/builder.dart

@@ -31,8 +31,7 @@ Builder jsonSerializable(BuilderOptions options) {
     checked: optionsMap.remove('checked') as bool,
     anyMap: optionsMap.remove('any_map') as bool,
     explicitToJson: optionsMap.remove('explicit_to_json') as bool,
-    generateToJsonFunction:
-        optionsMap.remove('generate_to_json_function') as bool,
+    generateToJsonMixin: optionsMap.remove('generate_to_json_mixin') as bool,
   );
 
   if (optionsMap.isNotEmpty) {

json_serializable/lib/src/encoder_helper.dart

@@ -12,7 +12,7 @@ import 'type_helper.dart';
 abstract class EncodeHelper implements HelperCore {
   String _fieldAccess(FieldElement field) {
     var fieldAccess = field.name;
-    if (generator.generateToJsonFunction) {
+    if (!generator.generateToJsonMixin) {
       fieldAccess = '$_toJsonParamName.$fieldAccess';
     }
     return fieldAccess;
@@ -29,11 +29,7 @@ abstract class EncodeHelper implements HelperCore {
 
     var buffer = new StringBuffer();
 
-    if (generator.generateToJsonFunction) {
-      var functionName = '${prefix}ToJson${genericClassArgumentsImpl(true)}';
-      buffer.write('Map<String, dynamic> $functionName'
-          '($targetClassReference $_toJsonParamName) ');
-    } else {
+    if (generator.generateToJsonMixin) {
       //
       // Generate the mixin class
       //
@@ -47,12 +43,16 @@ abstract class EncodeHelper implements HelperCore {
       }
 
       buffer.write('  Map<String, dynamic> toJson() ');
+    } else {
+      var functionName = '${prefix}ToJson${genericClassArgumentsImpl(true)}';
+      buffer.write('Map<String, dynamic> $functionName'
+          '($targetClassReference $_toJsonParamName) ');
     }
 
     var writeNaive = accessibleFields.every(_writeJsonValueNaive);
 
     if (generator.useWrappers) {
-      var param = generator.generateToJsonFunction ? _toJsonParamName : 'this';
+      var param = generator.generateToJsonMixin ? 'this' : _toJsonParamName;
       buffer.writeln('=> new ${_wrapperClassName(false)}($param);');
     } else {
       if (writeNaive) {
@@ -64,7 +64,7 @@ abstract class EncodeHelper implements HelperCore {
       }
     }
 
-    if (!generator.generateToJsonFunction) {
+    if (generator.generateToJsonMixin) {
       // end of the mixin class
       buffer.writeln('}');
     }
@@ -81,9 +81,9 @@ abstract class EncodeHelper implements HelperCore {
     buffer.writeln();
     // TODO(kevmoo): write JsonMapWrapper if annotation lib is prefix-imported
 
-    var fieldType = generator.generateToJsonFunction
-        ? targetClassReference
-        : _mixinClassName(false);
+    var fieldType = generator.generateToJsonMixin
+        ? _mixinClassName(false)
+        : targetClassReference;
 
     buffer.writeln('''
 class ${_wrapperClassName(true)} extends \$JsonMapWrapper {
@@ -160,7 +160,7 @@ class ${_wrapperClassName(true)} extends \$JsonMapWrapper {
   }
 
   /// Name of the parameter used when generating top-level `toJson` functions
-  /// if [JsonSerializableGenerator.generateToJsonFunction] is `true`.
+  /// if [JsonSerializableGenerator.generateToJsonMixin] is `false`.
   static const _toJsonParamName = 'instance';
 
   void _writeToJsonWithNullChecks(
@@ -183,7 +183,7 @@ class ${_wrapperClassName(true)} extends \$JsonMapWrapper {
       // access with `this.`.
       if (safeFieldAccess == generatedLocalVarName ||
           safeFieldAccess == toJsonMapHelperName) {
-        assert(!generator.generateToJsonFunction,
+        assert(generator.generateToJsonMixin,
             'This code path should only be hit during the mixin codepath.');
         safeFieldAccess = 'this.$safeFieldAccess';
       }

json_serializable/lib/src/json_part_builder.dart

@@ -27,15 +27,15 @@ Builder jsonPartBuilder({
   bool anyMap = false,
   bool checked = false,
   bool explicitToJson = false,
-  bool generateToJsonFunction = false,
+  bool generateToJsonMixin = false,
 }) {
   return new PartBuilder([
     new JsonSerializableGenerator(
       useWrappers: useWrappers,
       anyMap: anyMap,
       checked: checked,
       explicitToJson: explicitToJson,
-      generateToJsonFunction: generateToJsonFunction,
+      generateToJsonMixin: generateToJsonMixin,
     ),
     const JsonLiteralGenerator()
   ], header: header, formatOutput: formatOutput);

json_serializable/lib/src/json_serializable_generator.dart

@@ -95,29 +95,29 @@ class JsonSerializableGenerator
   /// Controls how `toJson` functionality is generated for all types processed
   /// by this generator.
   ///
-  /// If `false` (the default), a private `_$ClassNameSerializerMixin` class is
-  /// created in the generated part file which contains a `toJson` method.
-  ///
-  /// Mix in this class to the source class:
+  /// If `false` (the default), then a top-level function is created that you
+  /// can reference from your class.
   ///
   /// ```dart
   /// @JsonSerializable()
-  /// class Example extends Object with _$ExampleSerializerMixin {
+  /// class Example {
   ///   // ...
+  ///   Map<String, dynamic> toJson() => _$ExampleToJson(this);
   /// }
   /// ```
   ///
-  /// If `true`, then a top-level function is created that you can reference
-  /// from your class.
+  /// If `true`, a private `_$ClassNameSerializerMixin` class is created in the
+  /// generated part file which contains a `toJson` method.
+  ///
+  /// Mix in this class to the source class:
   ///
   /// ```dart
   /// @JsonSerializable()
-  /// class Example {
+  /// class Example extends Object with _$ExampleSerializerMixin {
   ///   // ...
-  ///   Map<String, dynamic> toJson() => _$ExampleToJson(this);
   /// }
   /// ```
-  final bool generateToJsonFunction;
+  final bool generateToJsonMixin;
 
   /// Creates an instance of [JsonSerializableGenerator].
   ///
@@ -129,12 +129,12 @@ class JsonSerializableGenerator
     bool anyMap = false,
     bool checked = false,
     bool explicitToJson = false,
-    bool generateToJsonFunction = false,
+    bool generateToJsonMixin = false,
   })  : this.useWrappers = useWrappers ?? false,
         this.anyMap = anyMap ?? false,
         this.checked = checked ?? false,
         this.explicitToJson = explicitToJson ?? false,
-        this.generateToJsonFunction = generateToJsonFunction ?? false,
+        this.generateToJsonMixin = generateToJsonMixin ?? false,
         this._typeHelpers = typeHelpers ?? _defaultHelpers;
 
   /// Creates an instance of [JsonSerializableGenerator].
@@ -147,13 +147,13 @@ class JsonSerializableGenerator
     bool useWrappers = false,
     bool anyMap = false,
     bool checked = false,
-    bool generateToJsonFunction = false,
+    bool generateToJsonMixin = false,
   }) =>
       new JsonSerializableGenerator(
           useWrappers: useWrappers,
           anyMap: anyMap,
           checked: checked,
-          generateToJsonFunction: generateToJsonFunction,
+          generateToJsonMixin: generateToJsonMixin,
           typeHelpers:
               new List.unmodifiable(typeHelpers.followedBy(_defaultHelpers)));
 

json_serializable/test/config_test.dart

@@ -102,7 +102,7 @@ const _validConfig = const {
   'any_map': true,
   'checked': true,
   'explicit_to_json': true,
-  'generate_to_json_function': true,
+  'generate_to_json_mixin': true,
 };
 
 const _invalidConfig = const {
@@ -111,5 +111,5 @@ const _invalidConfig = const {
   'any_map': 42,
   'checked': 42,
   'explicit_to_json': 42,
-  'generate_to_json_function': 42,
+  'generate_to_json_mixin': 42,
 };

json_serializable/test/integration/json_test_example.dart

@@ -11,7 +11,7 @@ import 'json_test_common.dart';
 part 'json_test_example.g.dart';
 
 @JsonSerializable()
-class Person extends Object with _$PersonSerializerMixin {
+class Person {
   final String firstName, middleName, lastName;
   final DateTime dateOfBirth;
   @JsonKey(name: '\$house')
@@ -26,6 +26,8 @@ class Person extends Object with _$PersonSerializerMixin {
 
   factory Person.fromJson(Map<String, dynamic> json) => _$PersonFromJson(json);
 
+  Map<String, dynamic> toJson() => _$PersonToJson(this);
+
   bool operator ==(Object other) =>
       other is Person &&
       firstName == other.firstName &&
@@ -37,7 +39,7 @@ class Person extends Object with _$PersonSerializerMixin {
 }
 
 @JsonSerializable()
-class Order extends Object with _$OrderSerializerMixin {
+class Order {
   /// Used to test that `disallowNullValues: true` forces `includeIfNull: false`
   @JsonKey(disallowNullValue: true)
   int count;
@@ -74,6 +76,8 @@ class Order extends Object with _$OrderSerializerMixin {
 
   factory Order.fromJson(Map<String, dynamic> json) => _$OrderFromJson(json);
 
+  Map<String, dynamic> toJson() => _$OrderToJson(this);
+
   bool operator ==(Object other) =>
       other is Order &&
       count == other.count &&
@@ -83,7 +87,7 @@ class Order extends Object with _$OrderSerializerMixin {
 }
 
 @JsonSerializable()
-class Item extends ItemCore with _$ItemSerializerMixin {
+class Item extends ItemCore {
   @JsonKey(includeIfNull: false, name: 'item-number')
   int itemNumber;
   List<DateTime> saleDates;
@@ -93,6 +97,8 @@ class Item extends ItemCore with _$ItemSerializerMixin {
 
   factory Item.fromJson(Map<String, dynamic> json) => _$ItemFromJson(json);
 
+  Map<String, dynamic> toJson() => _$ItemToJson(this);
+
   bool operator ==(Object other) =>
       other is Item &&
       price == other.price &&
@@ -101,7 +107,7 @@ class Item extends ItemCore with _$ItemSerializerMixin {
 }
 
 @JsonSerializable()
-class Numbers extends Object with _$NumbersSerializerMixin {
+class Numbers {
   List<int> ints;
   List<num> nums;
   List<double> doubles;
@@ -120,6 +126,8 @@ class Numbers extends Object with _$NumbersSerializerMixin {
   factory Numbers.fromJson(Map<String, dynamic> json) =>
       _$NumbersFromJson(json);
 
+  Map<String, dynamic> toJson() => _$NumbersToJson(this);
+
   bool operator ==(Object other) =>
       other is Numbers &&
       deepEquals(ints, other.ints) &&