Merge pull request #143 from davidmorgan/serialize-datetime

Add serializer for "DateTime" fields.

Author: davidmorgan

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.6
+
+- Add serializer for "DateTime" fields.
+
 ## 0.5.5
 
 - Add serializer for "num" fields.

benchmark/pubspec.yaml

@@ -12,12 +12,16 @@ environment:
 dependencies:
   browser: any
   built_collection: ^1.0.0
-  built_value: ^0.5.5
+# built_value: ^0.5.5
+  built_value:
+    path: ../built_value
 
 dev_dependencies:
   build: ^0.7.0
   build_runner: ^0.3.0
-  built_value_generator: ^0.5.5
+# built_value_generator: ^0.5.5
+  built_value_generator:
+    path: ../built_value_generator
   source_gen: '>=0.5.0+03 <0.6.0'
   quiver: '>=0.21.0 <0.24.0'
   test: any

built_value/lib/serializer.dart

@@ -3,8 +3,10 @@
 // license that can be found in the LICENSE file.
 
 import 'package:built_collection/built_collection.dart';
+import 'package:built_value/src/date_time_serializer.dart';
 import 'package:built_value/src/num_serializer.dart';
 import 'package:quiver/core.dart';
+
 import 'src/bool_serializer.dart';
 import 'src/built_json_serializers.dart';
 import 'src/built_list_multimap_serializer.dart';
@@ -31,6 +33,7 @@ abstract class Serializers {
           ..add(new BuiltMapSerializer())
           ..add(new BuiltSetSerializer())
           ..add(new BuiltSetMultimapSerializer())
+          ..add(new DateTimeSerializer())
           ..add(new DoubleSerializer())
           ..add(new IntSerializer())
           ..add(new NumSerializer())

built_value/lib/src/date_time_serializer.dart

@@ -0,0 +1,37 @@
+// Copyright (c) 2017, 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.
+
+import 'package:built_collection/built_collection.dart';
+import 'package:built_value/serializer.dart';
+
+/// Serializer for [DateTime].
+///
+/// An exception will be thrown on attempt to serialize local DateTime
+/// instances; you must use UTC.
+class DateTimeSerializer implements PrimitiveSerializer<DateTime> {
+  final bool structured = false;
+  @override
+  final Iterable<Type> types = new BuiltList<Type>([DateTime]);
+  @override
+  final String wireName = 'DateTime';
+
+  @override
+  Object serialize(Serializers serializers, DateTime dateTime,
+      {FullType specifiedType: FullType.unspecified}) {
+    if (!dateTime.isUtc) {
+      throw new ArgumentError.value(
+          dateTime, 'dateTime', 'Must be in utc for serialization.');
+    }
+
+    return dateTime.millisecondsSinceEpoch;
+  }
+
+  @override
+  DateTime deserialize(Serializers serializers, Object serialized,
+      {FullType specifiedType: FullType.unspecified}) {
+    final millisecondsSinceEpoch = serialized as int;
+    return new DateTime.fromMillisecondsSinceEpoch(millisecondsSinceEpoch,
+        isUtc: true);
+  }
+}

built_value/test/date_time_serializer_test.dart

@@ -0,0 +1,46 @@
+// Copyright (c) 2017, 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.
+
+import 'package:built_value/serializer.dart';
+import 'package:test/test.dart';
+
+void main() {
+  final serializers = new Serializers();
+
+  group('DateTime with known specifiedType', () {
+    final data = new DateTime.utc(1980);
+    final serialized = data.millisecondsSinceEpoch;
+    final specifiedType = const FullType(DateTime);
+
+    test('can be serialized', () {
+      expect(serializers.serialize(data, specifiedType: specifiedType),
+          serialized);
+    });
+
+    test('can be deserialized', () {
+      expect(serializers.deserialize(serialized, specifiedType: specifiedType),
+          data);
+    });
+
+    test('serialize throws if not UTC', () {
+      expect(() => serializers.serialize(new DateTime.now()), throws);
+    });
+  });
+
+  group('DateTime with unknown specifiedType', () {
+    final data = new DateTime.utc(1980);
+    final serialized = ['DateTime', data.millisecondsSinceEpoch];
+    final specifiedType = FullType.unspecified;
+
+    test('can be serialized', () {
+      expect(serializers.serialize(data, specifiedType: specifiedType),
+          serialized);
+    });
+
+    test('can be deserialized', () {
+      expect(serializers.deserialize(serialized, specifiedType: specifiedType),
+          data);
+    });
+  });
+}

built_value_generator/pubspec.yaml

@@ -14,7 +14,9 @@ dependencies:
   analyzer: '>=0.29.0 <0.30.0'
   build: ^0.7.0
   built_collection: ^1.0.0
-  built_value: ^0.5.5
+# built_value: ^0.5.5
+  built_value:
+    path: ../built_value
   meta: ^1.0.4
   source_gen: '>=0.5.0+03 <0.6.0'
   quiver: ^0.23.0

chat_example/pubspec.yaml

@@ -12,7 +12,9 @@ environment:
 dependencies:
   browser: ^0.10.0
   built_collection: ^1.0.0
-  built_value: ^0.5.5
+# built_value: ^0.5.5
+  built_value:
+    path: ../built_value
   shelf: ^0.6.0
   shelf_proxy: ^0.1.0
   shelf_web_socket: ^0.2.1
@@ -21,6 +23,8 @@ dependencies:
 dev_dependencies:
   build: ^0.7.0
   build_runner: ^0.3.0
-  built_value_generator: ^0.5.5
+# built_value_generator: ^0.5.5
+  built_value_generator:
+    path: ../built_value_generator
   source_gen: '>=0.5.0+03 <0.6.0'
   test: any

end_to_end_test/lib/values.dart

@@ -153,6 +153,7 @@ abstract class PrimitivesValue
   double get dbl;
   num get number;
   String get string;
+  DateTime get dateTime;
 
   factory PrimitivesValue([updates(PrimitivesValueBuilder b)]) =
       _$PrimitivesValue;

end_to_end_test/lib/values.g.dart

@@ -12,12 +12,16 @@ environment:
 dependencies:
   meta: ^1.0.4
   built_collection: ^1.0.0
-  built_value: ^0.5.5
+# built_value: ^0.5.5
+  built_value:
+    path: ../built_value
 
 dev_dependencies:
   build: ^0.7.0
   build_runner: ^0.3.0
-  built_value_generator: ^0.5.5
+# built_value_generator: ^0.5.5
+  built_value_generator:
+    path: ../built_value_generator
   source_gen: '>=0.5.0+03 <0.6.0'
   quiver: '>=0.21.0 <0.24.0'
   test: any

end_to_end_test/pubspec.yaml

@@ -116,7 +116,8 @@ void main() {
       ..integer = 42
       ..dbl = 2.5
       ..number = 17.5
-      ..string = 'test');
+      ..string = 'test'
+      ..dateTime = new DateTime.fromMillisecondsSinceEpoch(1000, isUtc: true));
     final serialized = [
       'PrimitivesValue',
       'boolean',
@@ -129,6 +130,8 @@ void main() {
       17.5,
       'string',
       'test',
+      'dateTime',
+      1000,
     ];
 
     test('can be serialized', () {

end_to_end_test/test/values_serializer_test.dart

@@ -12,12 +12,16 @@ environment:
 dependencies:
   meta: ^1.0.4
   built_collection: ^1.0.0
-  built_value: ^0.5.5
+# built_value: ^0.5.5
+  built_value:
+    path: ../built_value
 
 dev_dependencies:
   build: ^0.7.0
   build_runner: ^0.3.0
-  built_value_generator: ^0.5.5
+# built_value_generator: ^0.5.5
+  built_value_generator:
+    path: ../built_value_generator
   source_gen: '>=0.5.0+03 <0.6.0'
   quiver: '>=0.21.0 <0.24.0'
   test: any