Skip to content

fix(built_value_test): respect non comparable fields #1323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(built_value_test): respect non comparable fields #1323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions built_value_test/lib/matcher.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,12 @@ import 'package:matcher/matcher.dart';
/// Returns a matcher that matches if the value is structurally equal to
/// [expected].
///
/// When [onlyCheckComparable] fields that are not comparable are ignored for
/// the equality check.
///
/// Improves on a simple equality test by offering a detailed mismatch message.
Matcher equalsBuilt(Built expected) => _BuiltValueMatcher(expected);
Matcher equalsBuilt(Built expected, {bool onlyCheckComparable = false}) =>
_BuiltValueMatcher(expected, onlyCheckComparable);

/// Matcher for [Built] instances.
///
Expand All @@ -19,8 +23,10 @@ Matcher equalsBuilt(Built expected) => _BuiltValueMatcher(expected);
class _BuiltValueMatcher implements Matcher {
final Built _expected;
final Matcher _delegate;
final bool _onlyCheckComparable;

_BuiltValueMatcher(this._expected) : _delegate = equals(_toMap(_expected));
_BuiltValueMatcher(this._expected, this._onlyCheckComparable)
: _delegate = equals(_toMap(_expected));

@override
Description describe(Description description) =>
Expand All @@ -41,6 +47,8 @@ class _BuiltValueMatcher implements Matcher {
bool matches(dynamic item, Map matchState) {
if (_expected.runtimeType != item.runtimeType) return false;

if (_onlyCheckComparable && _expected == item) return true;

return _delegate.matches(_toMap(item), matchState);
}
}
Expand Down
18 changes: 16 additions & 2 deletions built_value_test/test/matcher_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,14 @@ void main() {
..name = 'foo'
..onChanged = () => 'Change happened!');

expect(value, otherValue);
expect(value, isNot(equalsBuilt(otherValue)));
expect(
value,
equalsBuilt(
otherValue,
onlyCheckComparable: true,
),
);
});

test('compared value matcher with different onChanged outcomes', () {
Expand All @@ -114,7 +121,14 @@ void main() {
..name = 'foo'
..onChanged = () => 'Change did not happen!');

expect(value, otherValue);
expect(value, isNot(equalsBuilt(otherValue)));
expect(
value,
equalsBuilt(
otherValue,
onlyCheckComparable: true,
),
);
});

test('compared value matcher with different names', () {
Expand Down