Skip to content

fix!: avoid custom toString override #213

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
stan-at-work wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix!: avoid custom toString override #213

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
2f3db22
Change default toString() implementation. (equatable.dart, equatable_…
stan-at-work May 7, 2026
ac94de6
Changed tests to reflect the breaking toString() implementation change.
stan-at-work May 7, 2026
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
2 changes: 1 addition & 1 deletion lib/src/equatable.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ abstract class Equatable {
if (stringify ?? EquatableConfig.stringify) {
return mapPropsToString(runtimeType, props);
}
return '$runtimeType';
return super.toString();
}
}
2 changes: 1 addition & 1 deletion lib/src/equatable_mixin.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ mixin EquatableMixin {
if (stringify ?? EquatableConfig.stringify) {
return mapPropsToString(runtimeType, props);
}
return '$runtimeType';
return super.toString();
}
}
8 changes: 4 additions & 4 deletions test/equatable_config_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ void main() {
EquatableConfig.stringify = false;
expect(
Credentials(username: 'joe', password: 'pass').toString(),
'Credentials',
"Instance of 'Credentials'",
);
expect(
CredentialsMixin(username: 'joe', password: 'pass').toString(),
'CredentialsMixin',
"Instance of 'CredentialsMixin'",
);
});

Expand Down Expand Up @@ -113,15 +113,15 @@ void main() {
password: 'pass',
shouldStringify: false,
).toString(),
'Credentials',
"Instance of 'Credentials'",
);
expect(
CredentialsMixin(
username: 'joe',
password: 'pass',
shouldStringify: false,
).toString(),
'CredentialsMixin',
"Instance of 'CredentialsMixin'",
);
});
});
Expand Down
11 changes: 7 additions & 4 deletions test/equatable_mixin_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ void main() {
test('should correct toString when EquatableConfig.stringify is false', () {
EquatableConfig.stringify = false;
final instance = SimpleEquatable('simple');
expect(instance.toString(), 'SimpleEquatable<String>');
expect(instance.toString(), "Instance of 'SimpleEquatable<String>'");
});

test('should return true when instance is the same', () {
Expand Down Expand Up @@ -660,9 +660,12 @@ void main() {
ExplicitStringifyFalse(name: 'Bob', hairColor: Color.black);
final instanceC =
ExplicitStringifyFalse(name: 'Joe', age: 50, hairColor: Color.blonde);
expect(instanceA.toString(), 'ExplicitStringifyFalse');
expect(instanceB.toString(), 'ExplicitStringifyFalse');
expect(instanceC.toString(), 'ExplicitStringifyFalse');

const expected = "Instance of 'ExplicitStringifyFalse'";

expect(instanceA.toString(), expected);
expect(instanceB.toString(), expected);
expect(instanceC.toString(), expected);
});
});

Expand Down
11 changes: 7 additions & 4 deletions test/equatable_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ void main() {
test('should correct toString when EquatableConfig.stringify is false', () {
EquatableConfig.stringify = false;
final instance = SimpleEquatable('simple');
expect(instance.toString(), 'SimpleEquatable<String>');
expect(instance.toString(), "Instance of 'SimpleEquatable<String>'");
});

test('should return true when instance is the same', () {
Expand Down Expand Up @@ -1057,9 +1057,12 @@ void main() {
age: 50,
hairColor: Color.blonde,
);
expect(instanceA.toString(), 'ExplicitStringifyFalse');
expect(instanceB.toString(), 'ExplicitStringifyFalse');
expect(instanceC.toString(), 'ExplicitStringifyFalse');

const expected = "Instance of 'ExplicitStringifyFalse'";

expect(instanceA.toString(), expected);
expect(instanceB.toString(), expected);
expect(instanceC.toString(), expected);
});
});
}
Expand Down