Add Module#private_constants block for concise private constants#34
Open
mliem2k wants to merge 1 commit into
Open
Add Module#private_constants block for concise private constants#34mliem2k wants to merge 1 commit into
mliem2k wants to merge 1 commit into
Conversation
Constants don't respect private/public regions the way methods do, so
making one private normally means repeating its name in a separate
private_constant call. private_constants { ... } marks every constant
defined within the block as private automatically.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Constants don't respect
private/publicregions the way methods do, so making one private normally means repeating its name in a separateprivate_constantcall:This implements the
private_constants do ... endAPI suggested in the issue: every constant defined directly within the block is automatically marked private viaprivate_constantonce the block finishes.It only marks constants introduced during the block (diffing
constants(false)before/after), so pre-existing constants are left untouched, and it's a no-op if the block doesn't define any new constants (avoiding Ruby's "private_constant with no argument is just ignored" warning).Added to
lib/type_toolkit/ext/module.rb, next tointerface!, since it's a similar small Module-level extension. Also added a README section under "Tools".Test plan
bundle exec rake test— 95 runs, 0 failuresbundle exec rake rubocop— no offensesbundle exec rake typecheck/typecheck_prism— no errorsspec/private_constants_spec.rbcover: constants defined via=and viaclass/modulekeywords being made private, constants outside the block staying public, unqualified access still working from the defining scope, a no-op empty block, and exceptions inside the block propagating normallyFixes #9