Closed jfelchner closed 5 years ago
Test failures seem to be Rubocop issues that existed before this PR.
Thanks a lot @jfelchner . WDYT @krzysiek1507 ?
@liufengyun just remember this needs to be version 0.4.0
.
Thank a lot @jfelchner 🎉
And thanks for reviewing @krzysiek1507 @luke-hill !
@liufengyun Could you please update the GitHub repository description as well?
@bquorning It's changed now, thanks for the catch.
Why This Change Is Necessary
The name of this gem is
hashdiff
. There is another gem namedhash_diff
. When they are both required via dependencies, errors are thrown. Additionally since the behavior is different, gems that are relying onhashdiff
's behavior, may gethash_diff
's behavior and vice versa.The reason for the conflict is because, based on ruby conventions, _'s are the separators for camel case.
So:
Unfortunately instead of making the base module of this gem
Hashdiff
, it's calledHashDiff
and it conflicts.How These Changes Address the Issue
We change all of the constants to the new constant, including in documentation and tests.
Then we add a shim to allow the old constant to be used and therefore maintain backward compatibility.
Finally we add a warning message for users of the gem that the old constant will be removed in the next major version bump.
Side Effects Caused By This Change
A new warning is added when loading the gem.
References:
45