adminchannel: fix, simplify, and comment hostmask utility function #2222
Conversation
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
I came for the LGTM alert about an unmatchable caret, and stayed for the completely undocumented behavior. Since the function works fine with just about any input consisting only of wildcards, I eliminated matching `*!*@*` as a special case. Fixed a typo (from 2014) in the regex for `nick!user` format (source of the LGTM alert that brought me here). Made the full-format validation stricter, disallowing the NUH field delimiters inside each field. And finally, added comments to make the string of regex checks less opaque to the first-time reader.
If it had been something sensible like `None` I might have let it go, but using the empty string '' as a sentinel value feels squicky.
Created test suite and caught (then fixed) some edge cases.
dgw
added
Bugfix
Exirel
approved these changes
Dec 8, 2021
Contributor
Exirel
left a comment
Exirel
left a comment
There was a problem hiding this comment.
I don't understand everything, but there are tests, and they look way easier to understand, so I'm all for it. 👍
Member
Author
|
Merged along with #2221 so we don't have a fixed bug in stable that's still unfixed on master. |
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.
Description
The "Big boy" version of #2221.
This is perhaps the most roundabout way to resolve a single LGTM alert in Sopel's history, but it improves a lot of stuff about the
adminchannelplugin'sconfigureHostMaskhelper function:''(empty string)Notably, adding tests also picked out a couple of edge cases that weren't handled, which I then also fixed.
The "Big boy" version of #2221.
Checklist
make qa(runsmake qualityandmake test)test/is for.