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.

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

revert: equals in equatable_utils #190

Merged
merged 1 commit into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions lib/src/equatable_utils.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ int mapPropsToHashCode(Iterable<Object?>? props) {
return _finish(props == null ? 0 : props.fold(0, _combine));
}

/// Determines whether two lists ([a] and [b]) are equal.
// See https://github.com/felangel/equatable/issues/187.
@pragma('vm:prefer-inline')
bool equals(List<Object?>? a, List<Object?>? b) {
if (identical(a, b)) return true;
if (a == null || b == null) return false;
return iterableEquals(a, b);
}

/// Determines whether two iterables are equal.
@pragma('vm:prefer-inline')
bool iterableEquals(Iterable<Object?> a, Iterable<Object?> b) {
Expand Down
26 changes: 25 additions & 1 deletion test/equatable_utils_test.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import 'package:equatable/equatable.dart';
import 'package:equatable/src/equatable_utils.dart';
import 'package:test/test.dart';
import 'package:test/test.dart' hide equals;

class Person with EquatableMixin {
Person({required this.name});
Expand All @@ -16,19 +16,33 @@ void main() {
final alice = Person(name: 'Alice');
final aliceCopy = Person(name: 'Alice');

group('equals', () {
test('returns true when both are null', () {
expect(equals(null, null), isTrue);
});

test('returns false when one is null', () {
expect(equals(null, []), isFalse);
expect(equals([], null), isFalse);
});
});

group('iterableEquals', () {
test('returns true for identical props', () {
final value = [Object()];
expect(iterableEquals(value, value), isTrue);
expect(equals(value, value), isTrue);
});

test('returns true for empty iterables', () {
expect(iterableEquals([], []), isTrue);
expect(equals([], []), isTrue);
});

test('returns false when props differ in length', () {
final object = Object();
expect(iterableEquals([object], [object, object]), isFalse);
expect(equals([object], [object, object]), isFalse);
});

test('uses == when props are equatable', () {
Expand All @@ -37,12 +51,19 @@ void main() {
expect(iterableEquals([alice], [bob]), isFalse);
expect(iterableEquals([bob], [alice]), isFalse);
expect(iterableEquals([alice, null], [alice, -1]), isFalse);

expect(equals([alice], [aliceCopy]), isTrue);
expect(equals([bob], [bob]), isTrue);
expect(equals([alice], [bob]), isFalse);
expect(equals([bob], [alice]), isFalse);
expect(equals([alice, null], [alice, -1]), isFalse);
});

test('returns false for iterables with different elements', () {
final iterable1 = [1, 2, 3];
final iterable2 = [1, 2, 4];
expect(iterableEquals(iterable1, iterable2), isFalse);
expect(equals(iterable1, iterable2), isFalse);
});

test(
Expand All @@ -51,6 +72,7 @@ void main() {
final iterable1 = [1, 2, 3];
final iterable2 = [1, 3, 2];
expect(iterableEquals(iterable1, iterable2), isFalse);
expect(equals(iterable1, iterable2), isFalse);
});

test('returns true for nested identical iterables', () {
Expand All @@ -63,6 +85,7 @@ void main() {
[alice, bob],
];
expect(iterableEquals(iterable1, iterable2), isTrue);
expect(equals(iterable1, iterable2), isTrue);
});

test('returns false for nested iterables with different elements', () {
Expand All @@ -75,6 +98,7 @@ void main() {
[3, 5],
];
expect(iterableEquals(iterable1, iterable2), isFalse);
expect(equals(iterable1, iterable2), isFalse);
});
});

Expand Down