Add adaptive max_depth and max_items handling in diff_objects#36
Open
top-sigrid wants to merge 8 commits intomarcoroth:mainfrom
Open
Add adaptive max_depth and max_items handling in diff_objects#36top-sigrid wants to merge 8 commits intomarcoroth:mainfrom
top-sigrid wants to merge 8 commits intomarcoroth:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #35.
When comparing deeply nested structures or large arrays,
diff_objectscould return misleading"No changes.output becausePrettyPleasetruncates content beyond the passedmax_depth&max_itemslimits. If both objects are truncated identically, no diff is shown even though the actual objects differ.See also the issue in minitest-difftastic for details.
I concluded - based on our exchange in the
minitest-difftasticissue, that this is best fixed here andminitest-difftasticactually doesn't need any adjustments.This PR makes
max_depthandmax_itemshandling adaptive indiff_objects, increasing these, up until exceeding newly defined cap values, until either:Also more of these configurations are exposed in
Difftastic::Differ.initializefor libraries and gems building upon this to customize this behaviour.