Added test for optional :Args when using :ChildOf
[catagits/Catalyst-Runtime.git] / lib / Catalyst / DispatchType / ChildOf.pm
CommitLineData
141459fa 1package Catalyst::DispatchType::ChildOf;
2
3use strict;
4use base qw/Catalyst::DispatchType/;
5use Text::SimpleTable;
6use Catalyst::ActionChain;
7use URI;
8
792b40ac 9# please don't perltidy this. hairy code within.
10
141459fa 11=head1 NAME
12
792b40ac 13Catalyst::DispatchType::ChildOf - Path Part DispatchType
141459fa 14
15=head1 SYNOPSIS
16
17See L<Catalyst>.
18
19=head1 DESCRIPTION
20
21=head1 METHODS
22
23=head2 $self->list($c)
24
25Debug output for Path Part dispatch points
26
141459fa 27=cut
28
792b40ac 29sub list {
30 my ( $self, $c ) = @_;
31
32 return unless $self->{endpoints};
33
34 my $paths = Text::SimpleTable->new(
35 [ 35, 'Path Spec' ], [ 36, 'Private' ]
36 );
37
38 ENDPOINT: foreach my $endpoint (
39 sort { $a->reverse cmp $b->reverse }
40 @{ $self->{endpoints} }
41 ) {
42 my $args = $endpoint->attributes->{Args}->[0];
43 my @parts = (defined($args) ? (("*") x $args) : '...');
d34667c3 44 my @parents = ();
792b40ac 45 my $parent = "DUMMY";
46 my $curr = $endpoint;
47 while ($curr) {
48 if (my $cap = $curr->attributes->{Captures}) {
49 unshift(@parts, (("*") x $cap->[0]));
50 }
51 if (my $pp = $curr->attributes->{PartPath}) {
52 unshift(@parts, $pp->[0])
53 if (defined $pp->[0] && length $pp->[0]);
54 }
55 $parent = $curr->attributes->{ChildOf}->[0];
56 $curr = $self->{actions}{$parent};
d34667c3 57 unshift(@parents, $curr) if $curr;
792b40ac 58 }
59 next ENDPOINT unless $parent eq '/'; # skip dangling action
d34667c3 60 my @rows;
61 foreach my $p (@parents) {
62 my $name = "/${p}";
63 if (my $cap = $p->attributes->{Captures}) {
64 $name .= ' ('.$cap->[0].')';
65 }
66 unless ($p eq $parents[0]) {
67 $name = "-> ${name}";
68 }
69 push(@rows, [ '', $name ]);
70 }
71 push(@rows, [ '', (@rows ? "=> " : '')."/${endpoint}" ]);
72 $rows[0][0] = join('/', '', @parts);
73 $paths->row(@$_) for @rows;
792b40ac 74 }
75
76 $c->log->debug( "Loaded Path Part actions:\n" . $paths->draw );
77}
141459fa 78
79=head2 $self->match( $c, $path )
80
81Matt is an idiot and hasn't documented this yet.
82
83=cut
84
85sub match {
86 my ( $self, $c, $path ) = @_;
87
88 return 0 if @{$c->req->args};
89
90 my @parts = split('/', $path);
91
92 my ($chain, $captures) = $self->recurse_match($c, '/', \@parts);
93
94 return 0 unless $chain;
95
96 my $action = Catalyst::ActionChain->from_chain($chain);
97
98 $c->req->action("/${action}");
99 $c->req->match("/${action}");
100 $c->req->captures($captures);
101 $c->action($action);
102 $c->namespace( $action->namespace );
103
104 return 1;
105}
106
107=head2 $self->recurse_match( $c, $parent, \@path_parts )
108
109Matt is an idiot and hasn't documented this yet.
110
111=cut
112
113sub recurse_match {
114 my ( $self, $c, $parent, $path_parts ) = @_;
115 my $children = $self->{children_of}{$parent};
116 return () unless $children;
117 my @captures;
cdc97b63 118 TRY: foreach my $try_part (sort { length($a) <=> length($b) }
119 keys %$children) {
141459fa 120 my @parts = @$path_parts;
121 if (length $try_part) { # test and strip PathPart
122 next TRY unless
123 ($try_part eq join('/', # assemble equal number of parts
124 splice( # and strip them off @parts as well
792b40ac 125 @parts, 0, scalar(@{[split('/', $try_part)]})
126 ))); # @{[]} to avoid split to @_
141459fa 127 }
128 my @try_actions = @{$children->{$try_part}};
129 TRY_ACTION: foreach my $action (@try_actions) {
130 if (my $args_attr = $action->attributes->{Args}) {
131 # XXX alternative non-Args way to identify an endpoint?
132 {
133 local $c->req->{arguments} = [ @{$c->req->args}, @parts ];
134 next TRY_ACTION unless $action->match($c);
135 }
136 push(@{$c->req->args}, @parts);
137 return [ $action ], [ ];
138 } else {
139 my @captures;
140 my @parts = @parts; # localise
141 if (my $capture_attr = $action->attributes->{Captures}) {
142 # strip Captures into list
143 push(@captures, splice(@parts, 0, $capture_attr->[0]));
144 }
145 # try the remaining parts against children of this action
146 my ($actions, $captures) = $self->recurse_match(
147 $c, '/'.$action->reverse, \@parts
148 );
149 if ($actions) {
150 return [ $action, @$actions ], [ @captures, @$captures ];
151 }
152 }
153 }
154 }
155 return ();
156}
157
158=head2 $self->register( $c, $action )
159
160Matt is an idiot and hasn't documented this yet.
161
162=cut
163
164sub register {
165 my ( $self, $c, $action ) = @_;
166
167 my @child_of_attr = @{ $action->attributes->{ChildOf} || [] };
168
169 return 0 unless @child_of_attr;
170
171 if (@child_of_attr > 2) {
172 Catalyst::Exception->throw(
173 "Multiple ChildOf attributes not supported registering ${action}"
174 );
175 }
176
177 my $parent = $child_of_attr[0];
178
179 if (defined($parent) && length($parent)) {
180 unless ($parent =~ m/^\//) {
181 $parent = '/'.join('/', $action->namespace, $parent);
182 }
183 } else {
184 $parent = '/'.$action->namespace;
185 }
186
792b40ac 187 $action->attributes->{ChildOf} = [ $parent ];
188
141459fa 189 my $children = ($self->{children_of}{$parent} ||= {});
190
191 my @path_part = @{ $action->attributes->{PathPart} || [] };
192
193 my $part = '';
194
195 if (@path_part == 1) {
196 $part = (defined $path_part[0] ? $path_part[0] : $action->name);
197 } elsif (@path_part > 1) {
198 Catalyst::Exception->throw(
199 "Multiple PathPart attributes not supported registering ${action}"
200 );
201 }
202
792b40ac 203 $action->attributes->{PartPath} = [ $part ];
204
141459fa 205 unshift(@{ $children->{$part} ||= [] }, $action);
206
792b40ac 207 ($self->{actions} ||= {})->{'/'.$action->reverse} = $action;
208
209 if ($action->attributes->{Args}) {
210 unshift(@{ $self->{endpoints} ||= [] }, $action);
211 }
212
213 return 1;
141459fa 214}
215
216=head2 $self->uri_for_action($action, $captures)
217
218Matt is an idiot and hasn't documented this yet.
219
220=cut
221
222sub uri_for_action {
223 my ( $self, $action, $captures ) = @_;
224
792b40ac 225 return undef unless ($action->attributes->{ChildOf}
226 && $action->attributes->{Args});
227
228 my @parts = ();
229 my @captures = @$captures;
230 my $parent = "DUMMY";
231 my $curr = $action;
232 while ($curr) {
233 if (my $cap = $curr->attributes->{Captures}) {
234 return undef unless @captures >= $cap->[0]; # not enough captures
235 unshift(@parts, splice(@captures, -$cap->[0]));
236 }
237 if (my $pp = $curr->attributes->{PartPath}) {
238 unshift(@parts, $pp->[0])
239 if (defined $pp->[0] && length $pp->[0]);
240 }
241 $parent = $curr->attributes->{ChildOf}->[0];
242 $curr = $self->{actions}{$parent};
141459fa 243 }
792b40ac 244
245 return undef unless $parent eq '/'; # fail for dangling action
246
247 return undef if @captures; # fail for too many captures
248
249 return join('/', '', @parts);
250
141459fa 251}
252
253=head1 AUTHOR
254
792b40ac 255Matt S Trout <mst@shadowcatsystems.co.uk>
141459fa 256
257=head1 COPYRIGHT
258
259This program is free software, you can redistribute it and/or modify it under
260the same terms as Perl itself.
261
262=cut
263
2641;