Skip to content

Conversation

Fryguy
Copy link
Contributor

@Fryguy Fryguy commented Sep 30, 2025

The Ruby code that is generated copies numerous methods into every model. This creates bloat both in file size and run-time memory usage. This commit introduces a base class for all models to store common methods. This commit's focus is only on static methods that do not change between models.

Part of #22051

@cliffano @zlx @autopp

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@Fryguy Fryguy force-pushed the ruby_api_model_base branch 2 times, most recently from 6304e3b to 50be973 Compare September 30, 2025 13:29
@Fryguy
Copy link
Contributor Author

Fryguy commented Sep 30, 2025

@Fryguy
Copy link
Contributor Author

Fryguy commented Sep 30, 2025

I did want to point out I deleted those inline_object files in the ruby petstore sample because they aren't generated and look like something old and unused. If they aren't, let me know and I will restore them with manual changes matching the new pattern.

@wing328
Copy link
Member

wing328 commented Oct 10, 2025

Is this PR ready for review?

The Ruby code that is generated copies numerous methods into every
model. This creates bloat both in file size and run-time memory usage.
This commit introduces a base class for all models to store common
methods. This commit's focus is only on static methods that do not
change between models.
@Fryguy Fryguy force-pushed the ruby_api_model_base branch from 50be973 to f55ba7c Compare October 10, 2025 18:38
@Fryguy Fryguy marked this pull request as ready for review October 10, 2025 18:38
@Fryguy
Copy link
Contributor Author

Fryguy commented Oct 10, 2025

Thanks for the poke @wing328 - I've un-drafted this PR.

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