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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
package Regexp::Pattern::Example;
our $DATE = '2020-04-01'; # DATE
our $VERSION = '0.2.14'; # VERSION
use 5.010001;
# BEGIN_BLOCK: def
our %RE = (
# the minimum spec
re1 => { pat => qr/\d{3}-\d{3}/ },
# more complete spec
re2 => {
summary => 'This is regexp for blah', # plaintext
description => <<'_',
A longer description in *Markdown* format.
_
pat => qr/\d{3}-\d{3}(?:-\d{5})?/,
tags => ['A','B'],
examples => [
# examples can be tested using 'test-regexp-pattern' script
# (distributed in Test-Regexp-Pattern distribution). examples can
# also be rendered in your POD using
# Pod::Weaver::Plugin::Regexp::Pattern.
{
str => '123-456',
matches => 1,
},
{
summary => 'Another example that matches',
str => '123-456-78901',
matches => 1,
},
{
summary => 'An example that does not match',
str => '123456',
matches => 0,
},
{
summary => 'An example that does not get tested',
str => '123456',
},
{
summary => 'Another example that does not get tested nor rendered to POD',
str => '234567',
matches => 0,
test => 0,
doc => 0,
},
],
},
# dynamic (regexp generator)
re3 => {
summary => 'This is a regexp for blah blah',
description => <<'_',
...
_
gen => sub {
my %args = @_;
my $variant = $args{variant} || 'A';
if ($variant eq 'A') {
return qr/\d{3}-\d{3}/;
} else { # B
return qr/\d{3}-\d{2}-\d{5}/;
}
},
gen_args => {
variant => {
summary => 'Choose variant',
schema => ['str*', in=>['A','B']],
default => 'A',
req => 1,
},
},
tags => ['B','C'],
examples => [
{
summary => 'An example that matches',
gen_args => {variant=>'A'},
str => '123-456',
matches => 1,
},
{
summary => "An example that doesn't match",
gen_args => {variant=>'B'},
str => '123-456',
matches => 0,
},
],
},
re4 => {
summary => 'This is a regexp that does capturing',
# it is recommended that your pattern does not capture, unless
# necessary. capturing pattern should tag with 'capturing' to let
# users/tools know.
tags => ['capturing'],
pat => qr/(\d{3})-(\d{3})/,
examples => [
{str=>'123-456', matches=>[123, 456]},
{str=>'foo-bar', matches=>[]},
],
},
re5 => {
summary => 'This is another regexp that is anchored and does (named) capturing',
# it is recommended that your pattern is not anchored for more
# reusability, unless necessary. anchored pattern should tag with
# 'anchored' to let users/tools know.
tags => ['capturing', 'anchored'],
pat => qr/^(?<cap1>\d{3})-(?<cap2>\d{3})/,
examples => [
{str=>'123-456', matches=>{cap1=>123, cap2=>456}},
{str=>'something 123-456', matches=>{}},
],
},
);
# END_BLOCK: def
1;
# ABSTRACT: An example Regexp::Pattern::* module
__END__
=pod
=encoding UTF-8
=head1 NAME
Regexp::Pattern::Example - An example Regexp::Pattern::* module
=head1 VERSION
This document describes version 0.2.14 of Regexp::Pattern::Example (from Perl distribution Regexp-Pattern), released on 2020-04-01.
=head1 SYNOPSIS
use Regexp::Pattern; # exports re()
my $re = re("Example::re1");
=head1 DESCRIPTION
L<Regexp::Pattern> is a convention for organizing reusable regex patterns.
=head1 PATTERNS
=over
=item * re1
=item * re2
This is regexp for blah.
A longer description in I<Markdown> format.
Examples:
"123-456" =~ re("Example::re2"); # matches
Another example that matches.
"123-456-78901" =~ re("Example::re2"); # matches
An example that does not match.
123456 =~ re("Example::re2"); # doesn't match
An example that does not get tested.
123456 =~ re("Example::re2"); # doesn't match
=item * re3
This is a regexp for blah blah.
...
This is a dynamic pattern which will be generated on-demand.
The following arguments are available to customize the generated pattern:
=over
=item * variant
Choose variant.
=back
Examples:
An example that matches.
"123-456" =~ re("Example::re3", {variant=>"A"}); # matches
An example that doesn't match.
"123-456" =~ re("Example::re3", {variant=>"B"}); # doesn't match
=item * re4
This is a regexp that does capturing.
Examples:
"123-456" =~ re("Example::re4"); # matches, $1=123, $2=456
"foo-bar" =~ re("Example::re4"); # doesn't match
=item * re5
This is another regexp that is anchored and does (named) capturing.
Examples:
"123-456" =~ re("Example::re5"); # matches, $+{"cap1"}=123, $+{"cap2"}=456
"something 123-456" =~ re("Example::re5"); # doesn't match
=back
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Regexp-Pattern>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-Regexp-Pattern>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Regexp-Pattern>
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.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2020, 2019, 2018, 2016 by 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.
=cut
|
