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

[R][Client] allow to initialize enum classes without parameters #18183

Merged

Conversation

joXemMx
Copy link
Contributor

@joXemMx joXemMx commented Mar 20, 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.

modelEnum.mustache currently produces classes that do not allow initialization as

MyEnumClass$new()

The above produces an error due to stopifnot(length(val) == 1L). The problem is that if this enum class is a parameter in another class, within the fromJSON function of this class it will say

if (!is.null(this_object$`enumExample`)) {
  `enumExample_object` <- MyEnumClass$new()
  `enumExample_object`$fromJSON(jsonlite::toJSON(this_object$`enumExample`, auto_unbox = TRUE, digits = NA))
  self$`enumExample` <- `enumExample_object`
}

and in turn try to initialize the enum class as given above. I re-wrote the initialization in modelEnum.mustache to behave as before if a wrong enum value is given, but allow initializing as MyEnumClass$new() by using a dummy enum DUMMY_ENUM and warning the user about it. This way the user is warned when using the class itself incorreclty, but can (in most cases) ignore the warning if the enum is instantly corrected like in the latter code example.

TL;DR having an enum class as a class parameter currently does not work in any case, and this PR allows it to work (while expressing warnings to the user)
Technical committee @Ramanth @saigiridhar21

@wing328
Copy link
Member

wing328 commented Mar 21, 2024

lgtm. let's give it a try

@wing328 wing328 merged commit 2600eb9 into OpenAPITools:master Mar 21, 2024
14 checks passed
@wing328 wing328 added this to the 7.5.0 milestone Mar 21, 2024
zapodot pushed a commit to zapodot/openapi-generator that referenced this pull request Mar 21, 2024
…APITools#18183)

* allow empty initialization of enum classes

* regenerate samples
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.

2 participants