-
Notifications
You must be signed in to change notification settings - Fork 213
Move the responsibility of safe loading to Node #643
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
Open
michaelherold
wants to merge
1
commit into
ruby:master
from
michaelherold:move-safety-responsibility-to-node
Open
Move the responsibility of safe loading to Node #643
michaelherold
wants to merge
1
commit into
ruby:master
from
michaelherold:move-safety-responsibility-to-node
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
This change moves the responsibility of safely loading a YAML tree from an internal detail of `Psych.safe_load` into `Psych::Nodes::Node`. The advantage of this is that you can now more easily safely load trees that you're working on without replicating the safety constraints of `Psych.safe_load`. The delegation of responsibilities also now matches for safely and unsafely loading a tree.
tenderlove
tenderlove
requested changes
Jan 17, 2024
Member
@tenderlove
tenderlove
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems fine, but could you please add tests? I don't think we need to cover the entirety of the API (since I think safe_load tests do that), but something to make sure this API doesn't break.
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.
This change moves the responsibility of safely loading a YAML tree from an internal detail of
Psych.safe_loadintoPsych::Nodes::Node.The advantage of this is that you can now more easily safely load trees that you're working on without replicating the safety constraints of
Psych.safe_load. The delegation of responsibilities also now matches for safely and unsafely loading a tree.I opted for two choices to make the diff smaller:
Psych.safe_loadinstead of moving it toPsych::Nodes::Node#to_safe_ruby. The main reason I chose to do so is thatPsych.safe_loadis the most likely entry point into using Psych for most people, so having the documentation on that method makes sense.Psych::Nodes::Noderather than duplicating them. The reason I chose to do this was to reduce the chance of two lists of arguments becoming unsynchronized. Additionally, since the behavior actually belongs toPsych::Nodes::Nodenow, it's the only place that can have the defaults set for all use cases.