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

Add attr_reader options for Puma::Server #3272

Merged

Conversation

icbd
Copy link
Contributor

@icbd icbd commented Nov 1, 2023

Description

Add attr_reader :options for Puma::Server.

On the one hand, it can reduce the use of instance variables.
Using the reader method can more clearly indicate that this is a read-only attribution and will not be changed in other methods.

On the other hand, It allows Puma::Server to expose @options for external use.
I have a scenario that requires this feature: Fetch PUMA Workers count of options in Rails runtime.

When using PUMA Cli to start the service, we can indeed do this ::Puma.cli_config.options[:workers],
but if we start the server through rails server, Puma can not response cli_config method.

# This is a compatible method
Puma::Server.current.instance_variable_get('@options').fetch(:workers)

# hope to use
# Puma::Server.current.options.fetch(:workers)

Your checklist for this pull request

  • I have reviewed the guidelines for contributing to this repository.
  • I have added (or updated) appropriate tests if this PR fixes a bug or adds a feature.
  • My pull request is 100 lines added/removed or less so that it can be easily reviewed.
  • If this PR doesn't need tests (docs change), I added [ci skip] to the title of the PR.
  • If this closes any issues, I have added "Closes #issue" to the PR description or my commit messages.
  • I have updated the documentation accordingly.
  • All new and existing tests passed, including Rubocop.

@icbd icbd changed the title Add attr_reader options for Puma::Server Draft: Add attr_reader options for Puma::Server Nov 1, 2023
@dentarg dentarg marked this pull request as draft November 1, 2023 08:44
@nateberkopec
Copy link
Member

I don't see any problem with this, as options are basically a public API already anyway.

@nateberkopec nateberkopec marked this pull request as ready for review January 2, 2024 01:27
@nateberkopec nateberkopec merged commit 2ceabc8 into puma:master Jan 2, 2024
61 of 64 checks passed
@dentarg dentarg changed the title Draft: Add attr_reader options for Puma::Server Add attr_reader options for Puma::Server Mar 21, 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.

None yet

3 participants