✨ SequenceSet ordered entries methods (backports to v0.4-stable) #402
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
`===` is not an alias for `cover?`. It delegates to `cover?` but handles errors differently.
`#each_range` and `#each_number` were previously tested indirectly via `#ranges` and `#numbers`, but this adds tests on them directly.
This splits off "normalized" vs "order preserving" methods in the "What's here?" sections.
Adds three new SequenceSet methods for querying about "duplicates": * `#has_duplicates?`: Returns whether the ordered entries contain any duplicates. * `#count_duplicates`: Returns the count of duplicates in the ordered entries. * `#count_with_duplicates`: Returns the count of numbers in the ordered entries, including any repeated numbers. This is useful for adding guards to `CopyUIDData` and `UIDPlusData`, and for getting the size of `SequenceSet#each_ordered_number` (another PR).
Less duplication, still fairly easy to read, IMO.
Yields each number in the ordered entries and returns +self+.
In `#count`, "*" is treated as if it is effectively UINT32_MAX. That
was also the intention for `#count_with_duplicates`.
Unlike `#count`, which can assume that `*` only appears at most once,
`#count_with_duplicates` needs to check each entry.
This means that, e.g:
SequenceSet["#{UINT32_MAX}:*"].count_with_duplicates == 1
SequenceSet["#{UINT32_MAX},*"].count_with_duplicates == 2
This is the ordered entries version of `#find_index`.
Some of the `#[negative index]` specs were using non-negative indexes. They've been updated to use negative indexes. Previously, `#at` was indirectly tested only by the `SequenceSet#[]` test and the randomized "compare to reference Set" tests. The new tests specifically explicitly focus on `#[]`.
This is the ordered entries variation of `#at`.
nevans
added
documentation
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.
Backports all of the following PRs to
v0.4-stable:SequenceSet#appendwhen its@stringis nil #376The code changes were backported already.
SequenceSet#cover?documentation #379SequenceSet#each_ordered_number#386SequenceSet#find_ordered_index#396SequenceSet#ordered_at#397With only a few simple exceptions (relating to differences in rdoc, versioned defaults in
config.rb, and the autoloads inresponse_data.rb) cherry-picking went smoothly and without conflicts.This adds the following new methods to
Net::IMAP::SequenceSet:#count_with_duplicates: The ordered entries version of#count.#count_duplicates: The difference between#countand#count_with_duplicates.#has_duplicates?: Returns whether#count_duplicatesis positive.#each_ordered_number: The ordered entries version of#each_number.#find_ordered_index: The ordered entries version of#find_index.#ordered_at: The ordered entries version of#at.