Design And Implementation Smells Fix#964
Closed
alwinsanil wants to merge 10 commits intostleary:masterfrom
Closed
Conversation
added 10 commits
March 22, 2025 17:52
Owner
|
What version of Java does this project require? "At the present time Java 8 is required to run the unit tests and the Maven Repository release. However, the library can be compiled and executed with Java 6." How do you decide which pull requests to accept "Otherwise, a good heuristic to follow is: "If it's not broken, don't fix it". This includes performance improvements, refactoring, formatting, and design updates. Before submitting such PRs, consider opening an issue to discuss your idea." |
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.
Refactoring of code done to address some design smells and implementation smells.
Implementation smells fixed:
Complex Conditional: getBoolean method in JSONArray.
Techniques: Extract Method, Decompose Conditional, Introduce Explaining Variable
• Extract Method - Created isFalse() and isTrue() methods to handle the complex conditionals
• Decompose Conditional - Broke down the complex if-conditions into simpler methods
• Introduce Explaining Variable - Used isBooleanString to clarify the string check logic
Complex Conditional: nextTo method in JSONTokener
Techniques: Extract Method, Decompose Conditional, Introduce Explaining Variable
• Extract Method - Created isDelimiter() helper methods to encapsulate delimiter checks
• Decompose Conditional - Broke down complex OR conditions into simpler checks
• Introduce Explaining Variable - Used isEndOfInput to clarify the zero-character check
Magic Number: toString method in JSONArray
Techniques: Introduce explaining variable
• Introduce explaining variable (for magic number 2) - Explain the multiplier purpose
• Introduce explaining variable (for magic number 16) - Explain minimum buffer size
Design smells fixed:
Deficient Encapsulation in JSONMLParserConfiguration
Technique: Move Field/Method
Cyclical Dependency between XML and XMLTokener
Technique: Extract Class
Missing Hierarchy of method similar in JSONArray, JSONObject and JSONString
Technique: Replace conditional with Polymorphism
Broken Hierarchy between JSONStringer and JSONWriter