Add "built_value_test" library with matcher.

Author: davidmorgan

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.0
+
+- Add "built_value_test" library. It provides a matcher which gives good mismatch messages for built_value instances.
+
 ## 1.0.1
 
 - Allow quiver 0.25.

benchmark/pubspec.yaml

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

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: ^1.0.1
+# built_value: ^1.0.1
+  built_value:
+    path: ../built_value
   meta: ^1.0.4
   source_gen: '>=0.5.0+03 <0.6.0'
   quiver: '>=0.21.0 <0.26.0'

built_value_test/LICENSE

@@ -0,0 +1,28 @@
+Copyright 2017, Google Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+
+   * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

built_value_test/lib/matcher.dart

@@ -0,0 +1,86 @@
+// 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/built_value.dart';
+import 'package:test/test.dart';
+
+/// Returns a matcher that matches if the value is structurally equal to
+/// [expected].
+///
+/// Improves on a simple equality test by offering a detailed mismatch message.
+Matcher equalsBuilt(Built expected) => new _BuiltValueMatcher(expected);
+
+/// Matcher for [Built] instances.
+///
+/// Converts instances to maps using [_CapturingToStringHelper] then compares
+/// using [equals], which does deep comparison on maps.
+class _BuiltValueMatcher implements Matcher {
+  final Built _expected;
+  final Matcher _delegate;
+
+  _BuiltValueMatcher(this._expected) : _delegate = equals(_toMap(_expected));
+
+  @override
+  Description describe(Description description) =>
+      _delegate.describe(description);
+
+  @override
+  Description describeMismatch(dynamic item, Description mismatchDescription,
+      Map matchState, bool verbose) {
+    if (_expected.runtimeType != item.runtimeType)
+      return mismatchDescription.add('is the wrong type');
+
+    return _delegate.describeMismatch(
+        _toMap(item), mismatchDescription, matchState, verbose);
+  }
+
+  @override
+  bool matches(dynamic item, Map matchState) {
+    if (_expected.runtimeType != item.runtimeType) return false;
+
+    return _delegate.matches(_toMap(item), matchState);
+  }
+}
+
+/// Converts a Built to a map.
+Map<String, Object> _toMap(Object built) {
+  // Save the current newBuiltValueToStringHelper so we can restore it on
+  // return.
+  final previousNewBuiltValueToStringHelper = newBuiltValueToStringHelper;
+
+  // Create a ToStringHelper that will capture values instead of converting
+  // them to String.
+  final capturingToStringHelper = new _CapturingToStringHelper();
+  newBuiltValueToStringHelper = (String className) {
+    // Store the class name in the map, so we check types as well as fields
+    // and values.
+    capturingToStringHelper.map[r'$class'] = className;
+    return capturingToStringHelper;
+  };
+
+  // Call toString() on the value to do capture.
+  built.toString();
+
+  // Reset to what it was on method entry.
+  newBuiltValueToStringHelper = previousNewBuiltValueToStringHelper;
+
+  return capturingToStringHelper.map;
+}
+
+/// Captures values in a Map instead of converting to a String.
+class _CapturingToStringHelper implements BuiltValueToStringHelper {
+  final Map<String, Object> map = <String, Object>{};
+
+  @override
+  void add(String field, Object value) {
+    if (value is Built) {
+      map[field] = _toMap(value);
+    } else if (value is BuiltMap) {
+      map[field] = value.asMap();
+    } else {
+      map[field] = value;
+    }
+  }
+}

built_value_test/pubspec.yaml

@@ -0,0 +1,28 @@
+name: built_value_test
+version: 1.1.0
+description: >
+  Value types with builders, Dart classes as enums, and serialization.
+  This library provides test support.
+authors:
+- David Morgan <davidmorgan@google.com>
+homepage: https://github.com/google/built_value.dart
+
+environment:
+  sdk: '>=1.8.0 <2.0.0'
+
+dependencies:
+# built_value: ^1.0.0
+  built_value:
+    path: ../built_value
+  built_collection: ^1.0.0
+  collection: ^1.0.0
+  quiver: '>=0.21.0 <0.26.0'
+
+dev_dependencies:
+  build: ^0.7.0
+  build_runner: ^0.3.0
+# built_value_generator: ^1.0.1
+  built_value_generator:
+    path: ../built_value_generator
+  source_gen: '>=0.5.0+03 <0.6.0'
+  test: any

built_value_test/test/matcher_test.dart

@@ -0,0 +1,60 @@
+// 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/built_value.dart';
+import 'package:built_value_test/matcher.dart';
+import 'package:test/test.dart';
+import 'values.dart';
+
+void main() {
+  group('built_value matcher', () {
+    test('matches if same', () {
+      final value = new CompoundValue((b) => b
+        ..simpleValue.anInt = 3
+        ..string = 'str');
+
+      expect(value, equalsBuilt(value));
+    });
+
+    test('reports if not same', () {
+      final value = new CompoundValue((b) => b
+        ..simpleValue.anInt = 3
+        ..string = 'str');
+      final otherValue = value.rebuild((b) => b..simpleValue.anInt = 5);
+
+      _expectMismatch(value, otherValue,
+          "was <3> instead of <5> at location ['simpleValue']['anInt']");
+    });
+
+    test('reports deep match on maps if not same', () {
+      final value = new CompoundValue((b) => b
+        ..simpleValue.anInt = 3
+        ..simpleValue.map['foo'] = 3
+        ..simpleValue.map['bar'] = 4
+        ..string = 'str');
+      final otherValue = value.rebuild((b) => b..simpleValue.map['bar'] = 5);
+
+      _expectMismatch(value, otherValue,
+          "was <4> instead of <5> at location ['simpleValue']['map']['bar']");
+    });
+
+    test('reports if the wrong type', () {
+      final value = 42;
+      final otherValue = new CompoundValue((b) => b..simpleValue.anInt = 5);
+
+      _expectMismatch(value, otherValue, 'is the wrong type');
+    });
+  });
+}
+
+void _expectMismatch(
+    Object value, Built otherValue, String expectedMismatchMessage) {
+  try {
+    expect(value, equalsBuilt(otherValue));
+  } catch (exception) {
+    expect(exception.toString(), contains(expectedMismatchMessage));
+    return;
+  }
+  throw new StateError('Expected mismatch.');
+}

built_value_test/test/values.dart

@@ -0,0 +1,28 @@
+// 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.
+
+library values;
+
+import 'package:built_collection/built_collection.dart';
+import 'package:built_value/built_value.dart';
+
+part 'values.g.dart';
+
+abstract class SimpleValue implements Built<SimpleValue, SimpleValueBuilder> {
+  int get anInt;
+  BuiltMap<String, int> get map;
+
+  factory SimpleValue([updates(SimpleValueBuilder b)]) = _$SimpleValue;
+  SimpleValue._();
+}
+
+abstract class CompoundValue
+    implements Built<CompoundValue, CompoundValueBuilder> {
+  SimpleValue get simpleValue;
+  @nullable
+  String get string;
+
+  factory CompoundValue([updates(CompoundValueBuilder b)]) = _$CompoundValue;
+  CompoundValue._();
+}