Document and test that Mojo::ByteStream split method uses core split function semantics #1617
Conversation
This file contains 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
kraih
previously approved these changes
Nov 28, 2020
…function semantics
Grinnz
force-pushed
the
Grinnz/bytestream_split_pattern
branch
from
39fa7a2
to
6efd5eb
Compare
|
The split function only consistently interprets a string containing a single space when it's not a literal since 5.18: https://perldoc.perl.org/perl5180delta#split's-first-argument-is-more-consistently-interpreted So added a workaround to make this work consistently on 5.16, the other option is not documenting or testing the single space string case at all. This seems potentially surprising to users using the split semantics. |
kraih
reviewed
Nov 29, 2020
| @@ -49,6 +49,9 @@ sub size { length ${$_[0]} } | |||
|
|
|||
| sub split { | |||
| my ($self, $pat, $lim) = (shift, shift, shift // 0); | |||
|
|
|||
| # awk compatible special case on 5.16 | |||
kraih
requested changes
Nov 29, 2020
|
A week should have been enough time for anyone who disagrees to speak up, so i'll close this PR as rejected. |
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
The first argument to Mojo::ByteStream's split method has some special treatment as it's passed directly to the split function. Add some documentation and examples to clarify this treatment - it's the pattern argument and is treated as a regex, except in the awk compatibility special case of a single space character, and the special case of an empty pattern which splits on each character.
It also may be worthwhile to suggest and document passing split patterns to this function as
qr//regex refs rather than strings, thoughts? (this is already tested)Motivation
Clarify how this argument is interpreted.
References
https://perldoc.perl.org/functions/split