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
|
package Path::Dispatcher::Match;
# ABSTRACT: the result of a successful rule match
our $VERSION = '1.08';
use Moo;
use MooX::TypeTiny;
use Type::Utils qw(class_type);
use Types::Standard qw(Str ArrayRef HashRef Undef);
use Path::Dispatcher::Path;
use Path::Dispatcher::Rule;
has path => (
is => 'ro',
isa => class_type('Path::Dispatcher::Path'),
required => 1,
);
has leftover => (
is => 'ro',
isa => Str,
);
has rule => (
is => 'ro',
isa => class_type('Path::Dispatcher::Rule'),
required => 1,
handles => ['payload'],
);
has positional_captures => (
is => 'ro',
isa => ArrayRef[Str|Undef],
default => sub { [] },
);
has named_captures => (
is => 'ro',
isa => HashRef[Str|Undef],
default => sub { {} },
);
has parent => (
is => 'ro',
isa => class_type('Path::Dispatcher::Match'),
predicate => 'has_parent',
);
sub run {
my $self = shift;
local $_ = $self->path;
return scalar $self->rule->run($self, @_);
}
sub pos {
my $self = shift;
my $index = shift;
return undef if $index == 0;
$index-- if $index > 0;
return $self->positional_captures->[$index];
}
sub named {
my $self = shift;
my $key = shift;
return $self->named_captures->{$key};
}
__PACKAGE__->meta->make_immutable;
no Moo;
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Path::Dispatcher::Match - the result of a successful rule match
=head1 VERSION
version 1.08
=head1 SYNOPSIS
my $rule = Path::Dispatcher::Rule::Tokens->new(
tokens => [ 'attack', qr/^\w+$/ ],
block => sub {
my $match = shift;
attack($match->pos(2))
},
);
my $match = $rule->match("attack dragon");
# introspection
$match->path # "attack dragon"
$match->leftover # empty string (populated with prefix rules)
$match->rule # $rule
$match->positional_captures # ["attack", "dragon"] (decided by the rule)
$match->pos(1) # "attack"
$match->pos(2) # "dragon"
$match->run # attack("dragon")
=head1 DESCRIPTION
If a L<Path::Dispatcher::Rule> successfully matches a path, it creates one or
more C<Path::Dispatcher::Match> objects.
=head1 ATTRIBUTES
=head2 rule
The L<Path::Dispatcher::Rule> that created this match.
=head2 path
The path that the rule matched.
=head2 leftover
The rest of the path. This is populated when the rule matches a prefix of the
path.
=head2 positional_captures
Any positional captures generated by the rule. For example,
L<Path::Dispatcher::Rule::Regex> populates this with the capture variables.
=head2 named_captures
Any named captures generated by the rule. For example,
L<Path::Dispatcher::Rule::Regex> populates this with named captures.
=head2 parent
The parent match object, if applicable (which may be set if this match is the
child of, for exampl, a L<Path::Dispatcher::Rule::Under> prefix)
=head1 METHODS
=head2 run
Executes the rule's codeblock with the same arguments.
=head2 pos($i)
Returns the C<$i>th positional capture, 1-indexed.
=head1 SUPPORT
Bugs may be submitted through L<the RT bug tracker|https://rt.cpan.org/Public/Dist/Display.html?Name=Path-Dispatcher>
(or L<bug-Path-Dispatcher@rt.cpan.org|mailto:bug-Path-Dispatcher@rt.cpan.org>).
=head1 AUTHOR
Shawn M Moore, C<< <sartak at bestpractical.com> >>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2020 by Shawn M Moore.
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
|
