Skip to content

Conversation

@devpatel43543
Copy link

@devpatel43543 devpatel43543 commented Nov 23, 2024

hii @stleary

i have refactored changes in following 3 files to enhance readability and maintainability:

  1. [Decompose Conditional] in valueToString() (JSONWriter.java):

    • Extracted a complex condition into a method (isDirectlyConvertibleToJSON()) to improve readability.
      Commit
  2. [Extract Method] in toString() (HTTP.java):

    • Divided the method into smaller, focused methods to follow the Single Responsibility Principle.
      Commit
  3. [Rename Variable] in JSONObject:

    • Renamed variables (xjsonTokener, ccurrentChar) for better clarity and readability.

}
if (value instanceof Boolean || value instanceof JSONObject
|| value instanceof JSONArray) {
if (isDirectlyConvertibleToJSON(value)) {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this change. A separate method is not needed for this conditional. You can add a clarification comment if you want.

return JSONObject.quote(value.toString());
}

private static boolean isDirectlyConvertibleToJSON(Object value) {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General rule: All methods must include JavaDoc comment

sb.append(jo.getString("Status-Code"));
sb.append(' ');
sb.append(jo.getString("Reason-Phrase"));
appendResponseHeader(sb, jo);
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert all changes to toString(). Refactoring this code is a judgement call. In this case, I trust Douglas Crockford's decision to include all HTTP string conversions in a single method.

@stleary
Copy link
Owner

stleary commented Nov 26, 2024

@devpatel43543 review comments added. The changes to JSONObject look good. All else should be reverted.

@stleary
Copy link
Owner

stleary commented Nov 30, 2024

Closing, please see How do you decide which pull requests to accept

@stleary stleary closed this Nov 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants