Skip to content
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

Jump to bottom

fix: iterable equality comparisons #103

Merged
merged 2 commits into from Feb 8, 2021
Merged

fix: iterable equality comparisons #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfc3656
fix: iterable equality comparisons
felangel Feb 8, 2021
6be363c
fix: analysis
felangel Feb 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 8 additions & 1 deletion lib/src/equatable_utils.dart
View file
Open in desktop
@@ -1,4 +1,5 @@
import 'package:collection/collection.dart';
import 'package:equatable/equatable.dart';

/// Returns a `hashCode` for [props].
int mapPropsToHashCode(Iterable props) =>
Expand All @@ -17,7 +18,9 @@ bool equals(List list1, List list2) {
final dynamic unit1 = list1[i];
final dynamic unit2 = list2[i];

if (unit1 is Iterable || unit1 is Map) {
if (_isEquatable(unit1) && _isEquatable(unit2)) {
if (unit1 != unit2) return false;
} else if (unit1 is Iterable || unit1 is Map) {
if (!_equality.equals(unit1, unit2)) return false;
} else if (unit1?.runtimeType != unit2?.runtimeType) {
return false;
Expand All @@ -28,6 +31,10 @@ bool equals(List list1, List list2) {
return true;
}

bool _isEquatable(dynamic object) {
return object is Equatable || object is EquatableMixin;
}

/// Jenkins Hash Functions
/// https://en.wikipedia.org/wiki/Jenkins_hash_function
int _combine(int hash, dynamic object) {
Expand Down
55 changes: 55 additions & 0 deletions test/equatable_mixin_test.dart
View file
Open in desktop
Expand Up @@ -119,6 +119,19 @@ class NullProps extends Equatable {
bool get stringify => true;
}

class IterableWithFlag<T> extends Iterable<T> with EquatableMixin {
IterableWithFlag({this.list, this.flag});

final bool flag;
final List<T> list;

@override
List<Object> get props => [flag, list];

@override
Iterator<T> get iterator => list.iterator;
}

void main() {
setUp(() {
EquatableConfig.stringify = false;
Expand Down Expand Up @@ -638,4 +651,46 @@ void main() {
expect(instance.toString(), 'NullProps()');
});
});

group('Iterable Equatable', () {
test('should be equal when different instances have same values', () {
final instanceA = IterableWithFlag(flag: true, list: [1, 2]);
final instanceB = IterableWithFlag(flag: true, list: [1, 2]);

expect(instanceA == instanceB, isTrue);
});

test('should not be equal when different instances have different values',
() {
final instanceA = IterableWithFlag(flag: false, list: [1, 2]);
final instanceB = IterableWithFlag(flag: true, list: [1, 2]);

expect(instanceA == instanceB, isFalse);
});

test('wrapper should be equal when different instances have same values',
() {
final instanceA = SimpleEquatable(
IterableWithFlag(flag: true, list: [1, 2]),
);
final instanceB = SimpleEquatable(
IterableWithFlag(flag: true, list: [1, 2]),
);

expect(instanceA == instanceB, isTrue);
});

test(
'wrapper should not be equal '
'when different instances have different values', () {
final instanceA = SimpleEquatable(
IterableWithFlag(flag: true, list: [1, 2]),
);
final instanceB = SimpleEquatable(
IterableWithFlag(flag: false, list: [1, 2]),
);

expect(instanceA == instanceB, isFalse);
});
});
}
8 changes: 0 additions & 8 deletions test/equatable_test.dart
View file
Open in desktop
Expand Up @@ -752,11 +752,9 @@ void main() {

group('Set Equatable', () {
test('should return when values are same', () {
// ignore: prefer_collection_literals
final instanceA = SimpleEquatable<Set<String>>(
Set.from(<String>['A', 'B']),
);
// ignore: prefer_collection_literals
final instanceB = SimpleEquatable<Set<String>>(
Set.from(<String>['A', 'B']),
);
Expand All @@ -765,11 +763,9 @@ void main() {
});

test('should return when values are same', () {
// ignore: prefer_collection_literals
final instanceA = SimpleEquatable<Set<String>>(
Set.from(<String>['A', 'B', 'A']),
);
// ignore: prefer_collection_literals
final instanceB = SimpleEquatable<Set<String>>(
Set.from(<String>['A', 'B']),
);
Expand All @@ -778,11 +774,9 @@ void main() {
});

test('should return when values are different', () {
// ignore: prefer_collection_literals
final instanceA = SimpleEquatable<Set<String>>(
Set.from(<String>['A', 'B']),
);
// ignore: prefer_collection_literals
final instanceB = SimpleEquatable<Set<String>>(
Set.from(<String>['a', 'b']),
);
Expand All @@ -791,11 +785,9 @@ void main() {
});

test('should return when values are different', () {
// ignore: prefer_collection_literals
final instanceA = SimpleEquatable<Set<String>>(
Set.from(<String>['A', 'B']),
);
// ignore: prefer_collection_literals
final instanceB = SimpleEquatable<Set<String>>(
Set.from(<String>['C', 'D']),
);
Expand Down