Skip to content
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

Improve camelization for words starting with acronym #18218

Open
wants to merge 14 commits into
base: master
Choose a base branch
from

Conversation

wing328
Copy link
Member

@wing328 wing328 commented Mar 24, 2024

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328 wing328 changed the title Timcbaoth improve camlization in default codegen Improve camelization for words starting with acronym Mar 24, 2024
@wing328 wing328 added this to the 7.5.0 milestone Mar 24, 2024
@wing328 wing328 marked this pull request as ready for review March 24, 2024 15:34
result = result.substring(0, 1).toLowerCase(Locale.ROOT) + result.substring(1);
if (Boolean.parseBoolean(System.getProperty("openapi.generator.fix.camelize"))) {
// new behaviour with fix
String[] splitString = name.split(nonNameElementPattern);
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you change it to this so that it does not mutate the string in unintended ways? We just want to change casing, not strip whitespace.

String[] splitString = name.split(nonNameElementPattern, -1);

}

String result = Arrays.stream(splitString)
.map(StringUtils::capitalize)
Copy link
Contributor

Choose a reason for hiding this comment

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

Why would we capitalize splitString[0] when we just used camelize with lower case first?

@@ -257,6 +258,13 @@ void configureGeneratorProperties() {
System.out.println(SerializerUtils.toJsonString(openAPI));
}

// check to see if we need to apply camelize fix
if (config.additionalProperties().containsKey("applyCamelizeFix")) {
Copy link
Contributor

Choose a reason for hiding this comment

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

If we think the new method is better, then we should make it enabled by default with an option to opt out and use the legacy method.

Copy link
Member Author

Choose a reason for hiding this comment

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

i want to let users to try it out first to see if we've other edge cases not yet handled.

plan to flip the switch in the upcoming v8.0.0 release.

@wing328 wing328 modified the milestones: 7.5.0, 7.6.0 Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants