view release on metacpan or  search on metacpan

lib/App/genpw.pm  view on Meta::CPAN

our %arg_action = (
    action => {
        schema => ['str*', in=>[qw/gen list-patterns/]],
        default => 'gen',
        cmdline_aliases => {
            list_patterns => {summary=>'Shortcut for --action=list-patterns', is_flag=>1, code=>sub { $_[0]{action} = 'list-patterns' }},
        },
    },
);

our %arg_patterns = (
    patterns => {
        'x.name.is_plural' => 1,
        'x.name.singular' => 'pattern',
        summary => 'Pattern(s) to use',
        schema => ['array*', of=>'str*', min_len=>1],
        description => <<'MARKDOWN',

CONVERSION (`%P`). A pattern is string that is roughly similar to a printf
pattern:

    %P

where `P` is certain letter signifying a conversion. This will be replaced with
some other string according to the conversion. An example is the `%h` conversion
which will be replaced with hexdigit.

LENGTH (`%NP`). A non-negative integer (`N`) can be specified before the
conversion to signify desired length, for example, `%4w` will return a random
word of length 4.

MINIMUM AND MAXIMUM LENGTH (`%M$NP`). If two non-negative integers separated by
`$` is specified before the conversion, this specify desired minimum and maximum
length. For example, `%4$10h` will be replaced with between 4 and 10 hexdigits.

ARGUMENT AND FILTERS (`%(arg)P`, `%(arg)(filter1)(...)P`). Finally, an argument
followed by zero or more filters can be specified (before the lengths) and
before the conversion. For example, `%(wordlist:ID::KBBI)w` will be replaced by
a random word from the wordlist <pm:WordList::ID::KBBI>. Another example,
`%()(Str::uc)4$10h` will be replaced by between 4-10 uppercase hexdigits, and
`%(arraydata:Sample::DeNiro)(Str::underscore_non_latin_alphanums)(Str::lc)(Str::ucfirst)w`
will be replaced with a random movie title of Robert De Niro, where symbols are
replaced with underscore then the string will be converted into lowercase and
the first character uppercased, e.g. `Dear_america_letters_home_from_vietnam`.

Anything else will be left as-is.

Available conversions:

    %l   Random Latin letter (A-Z, a-z)
    %d   Random digit (0-9)
    %h   Random hexdigit (0-9a-f in lowercase [default] or 0-9A-F in uppercase).
         Known arguments:
         - "u" (to use the uppercase instead of the default lowercase digits)
    %a   Random letter/digit (Alphanum) (A-Z, a-z, 0-9; combination of %l and %d)
    %s   Random ASCII symbol, e.g. "-" (dash), "_" (underscore), etc.
    %x   Random letter/digit/ASCII symbol (combination of %a and %s)
    %m   Base64 character (A-Z, a-z, 0-9, +, /)
    %b   Base58 character (A-Z, a-z, 0-9 minus IOl0)
    %B   Base56 character (A-Z, a-z, 0-9 minus IOol01)
    %%   A literal percent sign
    %w   Random word. Known arguments:
         - "stdin:" (for getting the words from stdin, the default)
         - "wordlist:NAME" (for getting the words from a <pm:WordList> module)
         - "arraydata:NAME" (for getting the words from an <pm:ArrayData> module, the
           Role::TinyCommons::Collection::PickItems::RandomPos will be applied).

Filter names are modules in the `Data::Sah::Filter::perl::` namespace (without
the prefix). To list available filters, you can use <prog:pmlist> or
<prog:list-sah-filter-rule-modules>:

    % pmlist 'Data::Sah::Filter::perl::**'
    % list-sah-filter-rule-modules --perl

MARKDOWN
        cmdline_aliases => {p=>{}},
    },
);

my %filters;
my %perconv_wl_objs; # WordList objects instantiated by per-conversion wordlist specification
my %perconv_ad_objs; # ArrayData objects instantiated by per-conversion wordlist specification
sub _fill_conversion {
    my ($matches, $words, $wl) = @_;

    my $n = $matches->{N};
    my $m = $matches->{M};
    my $len = defined($n) && defined($m) ? $n+int(rand()*($m-$n+1)) :
        defined($n) ? $n : 1;

    my $res;
    my $do_filter = sub {
        return unless $matches->{FILTERS};
        my @filters;
        while ($matches->{FILTERS} =~ /\(([^)]+)\)/g) { push @filters, $1 }
        require Data::Sah::Filter;
        for my $filter (@filters) {
            unless ($filters{$filter}) {
                $filters{$filter} = Data::Sah::Filter::gen_filter(filter_names => [$filter]);
            }
            $res = $filters{$filter}->($res);
        }
    };

    if ($matches->{CONV} eq '%') {
        $res = join("", map {'%'} 1..$len);
        $do_filter->(); return $res;
    } elsif ($matches->{CONV} eq 'd') {
        $res = join("", map {$digits->[rand(@$digits)]} 1..$len);
        $do_filter->(); return $res;
    } elsif ($matches->{CONV} eq 'h') {
        if (defined($matches->{ARG}) && $matches->{ARG} eq 'u') {
            $res = join("", map {$hexdigits_upper->[rand(@$hexdigits_upper)]} 1..$len);
        } else {
            $res = join("", map {$hexdigits->[rand(@$hexdigits)]} 1..$len);
        }
        $do_filter->(); return $res;
    } elsif ($matches->{CONV} eq 'l') {
        $res = join("", map {$letters->[rand(@$letters)]} 1..$len);
        $do_filter->(); return $res;
    } elsif ($matches->{CONV} eq 'a') {

lib/App/genpw.pm  view on Meta::CPAN

If no pattern is supplied, will generate random alphanum characters with this exact length.

=item * B<max_len> => I<posint>

If no pattern is supplied, will generate random alphanum characters with this maximum length.

=item * B<min_len> => I<posint>

If no pattern is supplied, will generate random alphanum characters with this minimum length.

=item * B<num> => I<int> (default: 1)

(No description)

=item * B<patterns> => I<array[str]>

Pattern(s) to use.

CONVERSION (C<%P>). A pattern is string that is roughly similar to a printf
pattern:

 %P

where C<P> is certain letter signifying a conversion. This will be replaced with
some other string according to the conversion. An example is the C<%h> conversion
which will be replaced with hexdigit.

LENGTH (C<%NP>). A non-negative integer (C<N>) can be specified before the
conversion to signify desired length, for example, C<%4w> will return a random
word of length 4.

MINIMUM AND MAXIMUM LENGTH (C<%M$NP>). If two non-negative integers separated by
C<$> is specified before the conversion, this specify desired minimum and maximum
length. For example, C<%4$10h> will be replaced with between 4 and 10 hexdigits.

ARGUMENT AND FILTERS (C<%(arg)P>, C<%(arg)(filter1)(...)P>). Finally, an argument
followed by zero or more filters can be specified (before the lengths) and
before the conversion. For example, C<%(wordlist:ID::KBBI)w> will be replaced by
a random word from the wordlist L<WordList::ID::KBBI>. Another example,
C<%()(Str::uc)4$10h> will be replaced by between 4-10 uppercase hexdigits, and
C<%(arraydata:Sample::DeNiro)(Str::underscore_non_latin_alphanums)(Str::lc)(Str::ucfirst)w>
will be replaced with a random movie title of Robert De Niro, where symbols are
replaced with underscore then the string will be converted into lowercase and
the first character uppercased, e.g. C<Dear_america_letters_home_from_vietnam>.

Anything else will be left as-is.

Available conversions:

 %l   Random Latin letter (A-Z, a-z)
 %d   Random digit (0-9)
 %h   Random hexdigit (0-9a-f in lowercase [default] or 0-9A-F in uppercase).
      Known arguments:
      - "u" (to use the uppercase instead of the default lowercase digits)
 %a   Random letter/digit (Alphanum) (A-Z, a-z, 0-9; combination of %l and %d)
 %s   Random ASCII symbol, e.g. "-" (dash), "_" (underscore), etc.
 %x   Random letter/digit/ASCII symbol (combination of %a and %s)
 %m   Base64 character (A-Z, a-z, 0-9, +, /)
 %b   Base58 character (A-Z, a-z, 0-9 minus IOl0)
 %B   Base56 character (A-Z, a-z, 0-9 minus IOol01)
 %%   A literal percent sign
 %w   Random word. Known arguments:
      - "stdin:" (for getting the words from stdin, the default)
      - "wordlist:NAME" (for getting the words from a L<WordList> module)
      - "arraydata:NAME" (for getting the words from an L<ArrayData> module, the
        Role::TinyCommons::Collection::PickItems::RandomPos will be applied).

Filter names are modules in the C<Data::Sah::Filter::perl::> namespace (without
the prefix). To list available filters, you can use L<pmlist> or
L<list-sah-filter-rule-modules>:

 % pmlist 'Data::Sah::Filter::perl::**'
 % list-sah-filter-rule-modules --perl


=back

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code
(200 means OK, 4xx caller error, 5xx function error). Second element
($reason) is a string containing error message, or something like "OK" if status is
200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth
element (%result_meta) is called result metadata and is optional, a hash
that contains extra information, much like how HTTP response headers provide additional metadata.

Return value:  (any)

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-genpw>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-genpw>.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 CONTRIBUTING


To contribute, you can send patches by email/via RT, or send pull requests on
GitHub.

Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your
system), you can install L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<Pod::Weaver::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond
that are considered a bug and can be reported to me.

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2024, 2020, 2018 by perlancar <perlancar@cpan.org>.