From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

PERLANCAR / WordList-0.7.11 / lib / WordListRole / FromArray.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
—
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

              
package WordListRole::FromArray;
use Role::Tiny;
use Role::Tiny::With;
with 'WordListRole::FirstNextResetFromEach';
requires '_array';
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2021-09-26'; # DATE
our $DIST = 'WordList'; # DIST
our $VERSION = '0.7.11'; # VERSION
sub each_word {
    my ($self, $code) = @_;
    my $array = $self->_array;
    for my $i (0 .. $#{$array}) {
        my $res = $code->($array->[$i]);
        last if defined $res && $res == -2;
    }
}
# STATS
1;
# ABSTRACT: Provide first_word(), next_word(), reset_iterator(), each_word() from _array()
__END__
=pod
=encoding UTF-8
=head1 NAME
WordListRole::FromArray - Provide first_word(), next_word(), reset_iterator(), each_word() from _array()
=head1 VERSION
This document describes version 0.7.11 of WordListRole::FromArray (from Perl distribution WordList), released on 2021-09-26.
=head1 DESCRIPTION
This role can be used if you want to construct a dynamic wordlist module from an
array of words. You provide _array(), and this role will provide C<each_word()>,
C<first_word()>, C<next_word()>, C<reset_iterator()>.
=for Pod::Coverage .+
=head1 REQUIRED METHODS
=head2 _array
Must return an arrayref of words.
=head1 PROVIDED METHODS
=head2 each_word
=head2 first_word
=head2 next_word
=head2 reset_iterator
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/WordList>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-WordList>.
=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>, and sometimes one or two other
Dist::Zilla plugin and/or Pod::Weaver::Plugin. 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) 2021, 2020, 2018, 2017, 2016 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=WordList>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=cut