1 package CatalystX::Routes;
6 use CatalystX::Routes::Role::Class;
7 use CatalystX::Routes::Role::Controller;
8 use Moose::Util qw( apply_all_roles );
9 use Params::Util qw( _CODELIKE _REGEX _STRING );
10 use Scalar::Util qw( blessed );
14 Moose::Exporter->setup_import_methods(
15 with_meta => [qw( get get_html post put del chain_point )],
16 as_is => [qw( chained args capture_args path_part action_class_name )],
18 class => ['CatalystX::Routes::Role::Class'],
23 _add_route( 'GET', @_ );
27 _add_route( 'GET_html', @_ );
31 _add_route( 'POST', @_ );
35 _add_route( 'PUT', @_ );
39 _add_route( 'DELETE', @_ );
45 my ( $attrs, $sub ) = _process_args( $meta, @_ );
47 unless ( exists $attrs->{Chained} ) {
48 $attrs->{Chained} = q{/};
54 # We need to turn the full chain name into a path, since two end points
55 # from two different chains could have the same end point name.
56 $name = ( $attrs->{Chained} eq '/' ? q{} : $attrs->{Chained} ) . q{/}
59 my $meth_base = '__route__' . $name;
61 _maybe_add_rest_route( $meta, $meth_base, $attrs );
63 my $meth_name = $meth_base . q{_} . $rest;
65 $meta->add_method( $meth_name => sub { goto &$sub } );
73 _add_chain_point( $meta, $name, chain_point => 1, @_ );
76 sub _add_chain_point {
78 my ( $attrs, $sub ) = _process_args( $meta, @_ );
82 $meta->add_chain_point( $name => [ $attrs, $sub ] );
90 my $caller = ( caller(2) )[3];
93 "The $caller keyword expects a path string or regex as its first argument"
94 unless _STRINGLIKE0($path) || _REGEX($path);
96 die "The $caller keyword expects a sub ref as its final argument"
97 unless _CODELIKE($sub);
101 unless ( delete $p{chain_point} ) {
102 $p{ActionClass} ||= 'REST::ForBrowsers';
105 unless ( $p{PathPart} ) {
108 unless ( exists $p{Chained} ) {
109 unless ( $part =~ s{^/}{} ) {
111 $meta->name()->action_namespace('FakeConfig'), $part;
115 $p{PathPart} = [$part];
121 sub _maybe_add_rest_route {
126 return if $meta->has_method($name);
128 # This could be done by Moose::Exporter, but that would require that the
129 # module has already inherited from Cat::Controller when it calls "use
130 # CatalystX::Routes".
131 unless ( $meta->does_role('CatalystX::Routes::Role::Controller') ) {
134 'CatalystX::Routes::Role::Controller'
138 $meta->add_method( $name => sub { } );
140 $meta->add_route( $name => [ $attrs, $meta->get_method($name) ] );
146 return ( Chained => $_[0] );
150 return ( Args => [ $_[0] ] );
153 sub capture_args ($) {
154 return ( CaptureArgs => [ $_[0] ] );
158 return ( PathPart => [ $_[0] ] );
161 sub action_class_name ($) {
162 return ( ActionClass => [ $_[0] ] );
165 # XXX - this should be added to Params::Util
166 sub _STRINGLIKE0 ($) {
167 return _STRING( $_[0] )
171 && overload::Method( $_[0], q{""} )
177 # This is a nasty hack around some weird back compat code in
178 # Catalyst::Controller->action_namespace
182 return { case_sensitive => 0 };
188 # ABSTRACT: Sugar for declaring RESTful chained action in Catalyst
194 package MyApp::Controller::User;
197 use CatalystX::Routes;
199 BEGIN { extends 'Catalyst::Controller'; }
203 chain_point '_set_user'
212 $c->stash()->{user} = ...;
217 => chained('_set_user')
222 get 'foo' => sub { ... }
227 post 'foo' => \&_post;
230 put '/root' => sub { ... };
232 # /user/plain_old_catalyst
233 sub plain_old_catalyst : Local { ... }
237 This module provides a sugar layer that allows controllers to declare chained
240 Under the hood, all the sugar declarations are turned into Chained subs. All
241 chain end points are declared using one of C<get>, C<get_html>, C<post>,
242 C<put>, or C<del>. These will declare actions using the
243 L<Catalyst::Action::REST::ForBrowsers> action class from the
244 L<Catalyst::Action::REST> distribution.
246 =head1 PUTTING IT ALL TOGETHER
248 This module is merely sugar over Catalyst's built-in L<Chained
249 dispatching|Catalyst::DispatchType::Chained> and L<Catalyst::Action::REST>. It
250 helps to know how those two things work.
252 =head1 SUGAR FUNCTIONS
254 All of these functions will be exported into your controller class when you
255 use C<CatalystX::Routes>.
259 This declares a C<GET> handler.
263 This declares a C<GET> handler for browsers. Use this to generate a standard
264 HTML page for browsers while still being able to generate some sort of RESTful
265 data response for other clients.
267 If a browser makes a C<GET> request and no C<get_html> action has been
268 declared, a C<get> action is used as a fallback. See
269 C<Catalyst::TraitFor::Request::REST::ForBrowsers> for details on how
270 "browser-ness" is determined.
274 This declares a C<POST> handler.
278 This declares a C<PUT> handler.
282 This declares a C<DELETE> handler.
286 This declares an intermediate chain point that should not be exposed as a
291 This function takes a single argument, the previous chain point from which the
296 This declares the number of arguments that this action expects. This should
297 only be used for the end of a chain.
299 =head2 capture_args $number
301 The number of arguments to capture at this point in the chain. This should
302 only be used for the beginning or middle parts of a chain.
304 =head2 path_part $path
306 The path part for this part of the chain. If you are declaring a chain end
307 point with C<get>, etc., then this isn't necessary. By default, the name
308 passed to the initial sugar function will be converted to a path part. See
311 =head2 action_class_name $class
313 Use this to declare an action class. By default, this will be
314 L<Catalyst::Action::REST::ForBrowsers> for end points. For other parts of a
315 chain, it simply won't be set.
317 =head1 Path Generation
319 All of the end point function (C<get>, C<post>, etc.) take a path as the first
320 argument. By default, this will be used as the C<path_part> for the chain. You
321 can override this by explicitly calling C<path_part>, in which case the name
322 is essentially ignored (but still required).
324 Note that it is legitimate to pass the empty string as the name for a chain's
327 If the end point's name does not start with a slash, it will be prefixed with
328 the controller's namespace.
330 If you don't specify a C<chained> value for an end point, then it will use the
331 root URI, C</>, as the root of the chain.
333 By default, no arguments are specified for a chain's end point, meaning it
334 will accept any number of arguments.
338 Please report any bugs or feature requests to
339 C<bug-catalystx-routes@rt.cpan.org>, or through the web interface at
340 L<http://rt.cpan.org>. I will be notified, and then you'll automatically be
341 notified of progress on your bug as I make changes.