✨ Cache server capabilities and add #capable?(name)#156
Merged
nevans merged 4 commits intoruby:masterfrom Jul 22, 2023
Merged
Conversation
nevans
changed the title
#capable?(name)
nevans
force-pushed
the
cached-capabilities
branch
2 times, most recently
from
4d26793 to
75043c8
Compare
nevans
force-pushed
the
cached-capabilities
branch
2 times, most recently
from
474fdbe to
1497b24
Compare
nevans
force-pushed
the
cached-capabilities
branch
7 times, most recently
from
27554f6 to
d611853
Compare
nevans
force-pushed
the
cached-capabilities
branch
from
b7c61c6 to
452f10f
Compare
This simplifies using Net::IMAP::FakeServer in multiple test suites.
nevans
force-pushed
the
cached-capabilities
branch
2 times, most recently
from
ecc6bd1 to
7ed848d
Compare
This update started as a cleanup of the capabilities documentation, but along the way it became something bigger. Because yard doesn't honor the `#--` and `#++` delimiters, most of the TODO comments have been either removed or converted into readable documentation of the missing features.
nevans
force-pushed
the
cached-capabilities
branch
from
7ed848d to
d4ea5d8
Compare
Updated methods: * `#initialize` - save capabilities in `OK` or `PREAUTH` greeting * `#capability` - always update saved capabilities * `#starttls` - always clear capabilities after tagged OK response * `#authenticate` - clear capabilities or update from tagged OK response * `#login` - clear capabilities or update from tagged OK response New methods: * `#capable?(name)` - the primary API for discovering capabilities * `#auth_capable?(name)` - returns whether a SASL mechanism is supported * `#auth_mechanisms` - returns the server's supported SASL mechanisms * `#capabilities` - cached version of `capability` * `#capabilities_cached?` - whether capabilities are cached * `#clear_cached_capabilities` - clears the cache Also, the docs related to capabilities were reorganized and rewritten. Fixes ruby#31.
nevans
force-pushed
the
cached-capabilities
branch
from
d4ea5d8 to
b0f8b9e
Compare
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
1 participant
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.
Updated methods:
#initialize- save capabilities inOKorPREAUTHgreeting#capability- always update saved capabilities#starttls- always clear capabilities after tagged OK response#authenticate- clear capabilities or update from tagged OK response#login- clear capabilities or update from tagged OK responseNew methods:
#capable?(name)- the primary API for discovering capabilities#auth_capable?(name)- returns whether a SASL mechanism is supported#auth_mechanisms- returns the server's supported SASL mechanisms#capabilities- callscapabilitywhen needed#capabilities_cached?- whether capabilities are cached#clear_cached_capabilities- clears the cacheFixes #31
Related issues:
#capability?(name)#31