Enabled customized "separators" and updated documentation accordingly #13
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
Added a "separators" argument to the constructor to support customizable separators. Updated the documentation to demonstrate and explain how the "separators" argument is used.
zakame
requested changes
Jan 17, 2019
| @@ -33,13 +33,13 @@ has alphabet => ( | |||
|
|
|||
| has chars => ( is => 'rwp', init_arg => undef, default => sub { [] } ); | |||
|
|
|||
| has seps => ( | |||
| has separators => ( | |||
There was a problem hiding this comment.
I think you can retain seps here and just remove its init_arg option so users can set it at object construction, e.g. Hashids->new( seps => 'aeiouy' ):
has seps => (
is => 'rwp',
isa => sub {
local $_ = shift;
croak "$_ must not have spaces" if /\s/;
},
default => sub {
my @seps = qw(c f h i s t u);
join '' => @seps, map {uc} @seps;
},
);There was a problem hiding this comment.
I'm fine with using "seps" rather than the longer "separators" keyword. I also like your suggestion for this preference because, now that I think of it, it can prevent problems resulting from a somewhat common misspelling that comes out as "seperators."
| @@ -58,14 +58,15 @@ sub BUILD { | |||
| if length $self->salt > length $self->alphabet; | |||
|
|
|||
| my @alphabet = split // => $self->alphabet; | |||
| my ( @seps, @guards ); | |||
| my @seps = split // => $self->separators; | |||
There was a problem hiding this comment.
Following the above, you won't need to split here...
| for my $sep ( @{ $self->seps } ) { | ||
| # separators should contain only chars present in alphabet; | ||
| # alphabet should not contain separators | ||
| for my $sep ( @seps ) { |
There was a problem hiding this comment.
... and instead do the split here.
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.
Added a "separators" argument to the constructor to support customizable separators.
Updated the documentation to demonstrate and explain how the "separators" argument is used.