-
Notifications
You must be signed in to change notification settings - Fork 24
refactor(guard): extract validateIntegrityField to eliminate triplicated switch blocks #4944
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| package guard | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
| ) | ||
|
|
||
| // allowedIntegrityLevels is the single source of truth for valid integrity-level values. | ||
| var allowedIntegrityLevels = []string{"none", "unapproved", "approved", "merged"} | ||
|
|
||
| var allowedIntegrityLevelSet = map[string]struct{}{ | ||
| "none": {}, | ||
| "unapproved": {}, | ||
| "approved": {}, | ||
| "merged": {}, | ||
| } | ||
|
|
||
| func invalidIntegrityFieldError(fieldName string) error { | ||
| return fmt.Errorf( | ||
| "invalid %s value: expected one of %s", | ||
| fieldName, | ||
| strings.Join(allowedIntegrityLevels, "|"), | ||
| ) | ||
| } | ||
|
|
||
| // validateIntegrityField returns an error if raw is not a valid integrity-level | ||
| // string. fieldName is used in the error message (e.g. "disapproval-integrity"). | ||
| func validateIntegrityField(fieldName string, raw interface{}) error { | ||
| s, ok := raw.(string) | ||
| if !ok { | ||
| return invalidIntegrityFieldError(fieldName) | ||
| } | ||
| normalized := strings.ToLower(strings.TrimSpace(s)) | ||
| if _, ok := allowedIntegrityLevelSet[normalized]; ok { | ||
| return nil | ||
| } | ||
| return invalidIntegrityFieldError(fieldName) | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
validateIntegrityField still duplicates the allowed-values string in multiple places (the error message is repeated in both the type-assertion failure and default case, and the allowed values are also duplicated in the switch). To fully achieve the goal of “single source of truth” for integrity levels, consider centralizing the allowed values (e.g., a const/slice + helper to format the error) so adding a new integrity level requires changing it in only one place.