Refactor Parser and YamlReader#176
Merged
NathanSweet merged 5 commits intoEsotericSoftware:masterfrom Mar 16, 2024
Merged
Conversation
…tProductionTable method
Makes the name more descriptive and readable. By reading the name you can tell it's a hashmap which was not clear previously.
…nternal Extract out the deserialization of scalar values to a new method. Make readValueInternal more modular
NathanSweet
reviewed
Mar 16, 2024
Member
|
Just the one comment. The other changes look good! |
The method valueConvertedNumber has been renamed to parseNumber for improved clarity and consistency with naming conventions. Enhances the readability of the codebase and better reflects the purpose of the method, which is to parse a string value into a Number object.
This reverts commit 78d10cd.
Member
|
Cheers! |
Contributor
Author
|
Thanks @NathanSweet! |
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
2 participants
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.
After looking through the codebase, I was impressed by the code coverage and thought it was pretty amazing.
I made the decision to refactor certain small portions because I wanted to contribute to the project.
This PR refactors some methods of the Parser and YamlReader classes.
Parser
Decompose type conditional for implicit document in
initProductionTableThe
produce()method calls the helper methodisNextTokenImplicitDocument()to check if the next token indicates an implicit document. This makes the condition clearer and easier to understand.The
isNextTokenImplicitDocument()method encapsulates the condition logic, making it self-explanatory.If the condition is met, the
parseImplicitDocument()method is called, which contains the logic for adding items to the parse stack. This separates concerns and improves code readability.YamlReader
Rename method
valueConvertedNumber()toparseNumber()The method valueConvertedNumber has been renamed to parseNumber for improved clarity and consistency with naming conventions.
Enhances the readability of the codebase and better reflects the purpose of the method, which is to parse a string value into a Number object.
Extract method
readScalarValue()fromreadValueInternal()readScalarValue()method.Checklist
Checklist I followed before raising the PR.