Default stringify to true

[zepfietje]

Status

READY

Breaking Changes

NO

Description

Defaulting stringify to true takes away some boilerplate.
Related issue: #60.
Not sure if this should be seen as a breaking change.

Todos

• Tests
• Documentation
• Examples

[codecov-io]

Codecov Report

Merging #65 into master will decrease coverage by 2.22%.
The diff coverage is 50.00%.

@@             Coverage Diff             @@
##            master      #65      +/-   ##
===========================================
- Coverage   100.00%   97.77%   -2.23%     
===========================================
  Files            3        3              
  Lines           45       45              
===========================================
- Hits            45       44       -1     
- Misses           0        1       +1     

Impacted Files	Coverage Δ
lib/src/equatable_mixin.dart	88.88% <0.00%> (-11.12%)	⬇️
lib/src/equatable.dart	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 29325c1...f96d301. Read the comment docs.

[felangel]

@jorgecoca thoughts on this change? I vaguely remember you were against this at one point.

[jorgecoca]

@zepfietje First of all, thank you for your contribution!

When I discussed this feature with @felangel a while ago, my recommendation was to not to set stringify as true by default: many classes marked as Equatable might contain user's personal data (usernames, passwords, SSNs, birthdates...), and a very common use case of these is to combine them with flutter_bloc relying on BlocDelegate for automated logs/analytics.

If we introduce a change like this, we potentially risk leaking a lot of information with a "ghost change": yes, there's a new major API version, but people might apply that change blindly and cause a big security hole.

Instead, if we want to control the value of stringify globally, we could have an EquatableDelegate class, or an equatable.yaml (or any other solution..) to control global behavior. This way, the responsibility is on the developer to make this decision, and not on the library.

I hope this makes sense 🤞 Thank you folks!

[zepfietje]

@jorgecoca good point. I think the main thing is that during development one wants to be able to view all values of a class marked as Equatable, whereas in production certain private values like you mentioned should be hidden.

We should be able to come up with a smart solution along the lines of your suggestions.

Thanks again for your comments! 👌

[felangel]

@jorgecoca @zepfietje thoughts on having it default to true in debug mode?

[jorgecoca]

Wouldn't that assume that you are running Flutter though? How would that work with pure Dart apps/packages? IMO, I'd still prefer to have access to a delegate/config that lets you set it up with your own settings, and leave it up to the developer to make that decision.

[felangel]

Wouldn't that assume that you are running Flutter though? How would that work with pure Dart apps/packages? IMO, I'd still prefer to have access to a delegate/config that lets you set it up with your own settings, and leave it up to the developer to make that decision.

Fair enough 👍

[zepfietje]

A delegate would probably be the best solution. Then developers can check for debug mode themselves.

[felangel]

@zepfietje closing this PR in favor of having an alternative solution (using a delegate or global explicit configuration). I will try to work on this this week 👍