Merge pull request #26 from davidmorgan/try-unknown

Allow non-serializable static types provided runtime types are serializable.

Author: davidmorgan

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.0.7
+
+- Allow non-serializable static types provided runtime types are serializable.
+
 ## 0.0.6
 
 - Fix serialization of null @nullable fields: omit them entirely.

built_json/lib/src/built_json_serializers.dart

@@ -48,7 +48,8 @@ class BuiltJsonSerializers implements Serializers {
     } else {
       final serializer = _getSerializerByType(specifiedType.root);
       if (serializer == null) {
-        throw new StateError("No serializer for '${specifiedType.root}'.");
+        // Might be an interface; try resolving using the runtime type.
+        return serialize(object);
       }
       if (serializer is StructuredSerializer) {
         return serializer
@@ -85,7 +86,8 @@ class BuiltJsonSerializers implements Serializers {
     } else {
       final serializer = _getSerializerByType(specifiedType.root);
       if (serializer == null) {
-        throw new StateError("No serializer for '${specifiedType.root}'.");
+        // Might be an interface; try resolving using the runtime type.
+        return deserialize(object);
       }
 
       if (serializer is StructuredSerializer) {

built_json/pubspec.yaml

@@ -1,5 +1,5 @@
 name: built_json
-version: 0.0.6
+version: 0.0.7
 description: >
   JSON serialization for Built Collections, Built Values and Enum Classes.
   This library is the runtime dependency.

built_json_generator/lib/src/source_field.dart

@@ -63,14 +63,6 @@ abstract class SourceField implements Built<SourceField, SourceFieldBuilder> {
   }
 
   static String _generateFullType(String type) {
-    // TODO(davidmorgan): Object or any abstract class that is not a Built
-    // Value should return 'unspecified'; serialization will have to use the
-    // runtime type as the static type is not specific enough. Add detection
-    // for the abstract class case.
-    if (type == 'Object') {
-      return 'FullType.unspecified';
-    }
-
     // TODO(davidmorgan): support more than one level of nesting.
     final bareType = _getBareType(type);
     final generics = _getGenerics(type);

built_json_generator/pubspec.yaml

@@ -1,5 +1,5 @@
 name: built_json_generator
-version: 0.0.6
+version: 0.0.7
 description: >
   JSON serialization for Built Collections, Built Values and Enum Classes.
   This library is the dev dependency.
@@ -13,7 +13,7 @@ environment:
 dependencies:
   analyzer: '>=0.27.1 <0.28.0'
   built_collection: '^1.0.1'
-  built_json: '^0.0.6'
+  built_json: '^0.0.7'
   source_gen: '>=0.4.3 <0.5.0'
   quiver: '>=0.21.0 <0.22.0'
 

example/lib/compound_value.dart

@@ -6,8 +6,9 @@ library compound_value;
 
 import 'package:built_json/built_json.dart';
 import 'package:built_value/built_value.dart';
-import 'package:example/value.dart';
+import 'package:example/has_int.dart';
 import 'package:example/test_enum.dart';
+import 'package:example/value.dart';
 
 part 'compound_value.g.dart';
 
@@ -22,6 +23,7 @@ abstract class CompoundValue
   static final Serializer<CompoundValue> serializer = _$compoundValueSerializer;
 
   Value get aValue;
+  HasInt get aHasInt;
   TestEnum get aTestEnum;
 
   CompoundValue._();
@@ -32,6 +34,7 @@ abstract class CompoundValue
 abstract class CompoundValueBuilder
     implements Builder<CompoundValue, CompoundValueBuilder> {
   ValueBuilder aValue = new ValueBuilder();
+  HasInt aHasInt;
   TestEnum aTestEnum;
 
   CompoundValueBuilder._();

example/lib/compound_value.g.dart

@@ -0,0 +1,85 @@
+// Copyright (c) 2016, Google Inc. Please see the AUTHORS file for details.
+
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+library has_int;
+
+import 'package:built_json/built_json.dart';
+import 'package:built_value/built_value.dart';
+import 'package:enum_class/enum_class.dart';
+
+part 'has_int.g.dart';
+
+/// Example "serializable" interface.
+///
+/// In fact it is the implementations of the interface that must be
+/// serializable. See examples below.
+abstract class HasInt {
+  int get anInt;
+}
+
+/// Example [HasInt] implementation that is not serializable.
+///
+/// To be serializable it must use built_value or enum_class.
+abstract class WrongHasInt implements HasInt {
+  int anInt = 4;
+}
+
+/// Example [HasInt] that is serializable because it uses built_value.
+abstract class ValueWithInt
+    implements Built<ValueWithInt, ValueWithIntBuilder>, HasInt {
+  /// Serializer field makes the built_value serializable.
+  static final Serializer<ValueWithInt> serializer = _$valueWithIntSerializer;
+  static final int youCanHaveStaticFields = 3;
+
+  @override
+  int get anInt;
+
+  String get note;
+
+  ValueWithInt._();
+
+  factory ValueWithInt([updates(ValueWithIntBuilder b)]) = _$ValueWithInt;
+}
+
+/// Builder class for [ValueWithInt].
+abstract class ValueWithIntBuilder
+    implements Builder<ValueWithInt, ValueWithIntBuilder> {
+  int anInt;
+  String note;
+
+  ValueWithIntBuilder._();
+
+  factory ValueWithIntBuilder() = _$ValueWithIntBuilder;
+}
+
+/// Example [HasInt] that is serializable because it uses enum_class.
+class EnumWithInt extends EnumClass implements HasInt {
+  /// Serializer field makes the enum_class serializable.
+  static final Serializer<EnumWithInt> serializer = _$enumWithIntSerializer;
+
+  static const EnumWithInt one = _$one;
+  static const EnumWithInt two = _$two;
+  static const EnumWithInt three = _$three;
+
+  const EnumWithInt._(String name) : super(name);
+
+  static BuiltSet<EnumWithInt> get values => _$values;
+
+  static EnumWithInt valueOf(String name) => _$valueOf(name);
+
+  @override
+  int get anInt {
+    switch (this) {
+      case one:
+        return 1;
+      case two:
+        return 2;
+      case three:
+        return 3;
+      default:
+        throw new StateError(this.toString());
+    }
+  }
+}