Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Named actions #182

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Named actions #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions lib/Catalyst.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2392,8 +2392,18 @@ sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
Gets all actions of a given name in a namespace and all parent
namespaces.

=head2 $c->action_for( $action_private_name )

Returns the action which matches the full private name or nothing if there's no
matching action

=cut

sub action_for {
my ($c, $action_private_name) = @_ ;
return $c->dispatcher->get_action_by_path($action_private_name);
}

sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }

=head2 $app->handle_request( @arguments )
Expand Down
121 changes: 121 additions & 0 deletions lib/Catalyst/Controller.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,8 @@ sub _parse_Chained_attr {
my @levels = split '/', $rel;

$value = '/'.join('/', @parts[0 .. $#parts - @levels], $rest);
} elsif ($value =~ /^\*/) {
$value = "/$value";
} elsif ($value !~ m/^\//) {
my $action_ns = $self->action_namespace($c);

Expand Down Expand Up @@ -1030,6 +1032,125 @@ like websockets.

See L<Catalyst::ActionRole::Scheme> for more.

=head2 Name

Allows you to give you action a globally addressable name, in addition to its private
name. Useful to decouple action referencing via Chaining and link creation from the
actions private name, which is tightly bound to the controller namespace as well as the
action subroutine name. Example:

package MyApp::Controller::Root;

use warnings;
use strict;
use base 'Catalyst::Controller';

sub root :Chained(/) PathPart('') CaptureArgs(0) Name(Root) {
my ($self, $c) = @_;
}

MyApp::Controller::Root->config(namespace=>'');

package MyApp::Controller::Home;

use warnings;
use strict;
use base 'Catalyst::Controller';

sub home :Chained(*Root) Args(0) {
my ($self, $c) = @_;
}

In this case the 'Home' controller's action '/home/home' is chained to the Root controllers action
'/root'. These declarations are the in practice the same:

package MyApp::Controller::Home;

use warnings;
use strict;
use base 'Catalyst::Controller';

# Reference the target prior chain link via its full private action name
sub home :Chained(/root) Args(0) {
my ($self, $c) = @_;
}

or:

# Reference the target prior chain link via a relative action path
sub home :Chained(../root) Args(0) {
my ($self, $c) = @_;
}

When using a named action's name in a :Chained attribute, when using forward/detach/go/visit or
when using $c->action_for and $controller->action_for you must prefix the name with a '*' so that
we can disambiguate a named action from an action relative path:

package MyApp::Controller::URI;

use warnings;
use strict;
use base 'Catalyst::Controller';

sub target :Path(/target) Args(0) Name (Target) {
my ($self, $c) = @_;
}

sub uri :Path(/uri) Args(0) {
my ($self, $c) = @_;
$c->response->body($c->uri_for( $c->action_for('*Target') ));
}

package MyApp::Controller::Flow;

use warnings;
use strict;
use base 'Catalyst::Controller';

sub test_forward :Path(/forward) Args(0) {
my ($self, $c) = @_;
$c->forward('*ForForward');
}

sub forward_target :Action Name(ForForward) {
my ($self, $c) = @_;
$c->response->body('forward');
}

sub test_detach :Path(/detach) Args(0) {
my ($self, $c) = @_;
$c->detach('*ForDetach');
}

sub detach_target :Action Name(ForDetach) {
my ($self, $c) = @_;
$c->response->body('detach');
}

sub test_go :Path(/go) Args(0) {
my ($self, $c) = @_;
$c->detach('*ForGo');
}

sub go_target :Action Name(ForGo) {
my ($self, $c) = @_;
$c->response->body('go');
}

sub test_visit :Path(/visit) Args(0) {
my ($self, $c) = @_;
$c->detach('*ForVisit');
}

sub visit_target :Action Name(ForVisit) {
my ($self, $c) = @_;
$c->response->body('visit');
}

B<NOTE>: Named actions are not a replacement for using an actions private name, but are offered
as an option for when additional clarity or action namespace decoupling improve code understanding
and maintainability.

=head1 OPTIONAL METHODS

=head2 _parse_[$name]_attr
Expand Down
49 changes: 30 additions & 19 deletions lib/Catalyst/DispatchType/Chained.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,25 +278,31 @@ sub recurse_match {
next TRY_ACTION unless $action->match_captures($c, \@captures);

# try the remaining parts against children of this action
my ($actions, $captures, $action_parts, $n_pathparts) = $self->recurse_match(
$c, '/'.$action->reverse, \@parts
);
# No best action currently
# OR The action has less parts
# OR The action has equal parts but less captured data (ergo more defined)
if ($actions &&
(!$best_action ||
$#$action_parts < $#{$best_action->{parts}} ||
($#$action_parts == $#{$best_action->{parts}} &&
$#$captures < $#{$best_action->{captures}} &&
$n_pathparts > $best_action->{n_pathparts}))) {
my @pathparts = split /\//, $action->attributes->{PathPart}->[0];
$best_action = {
actions => [ $action, @$actions ],
captures=> [ @captures, @$captures ],
parts => $action_parts,
n_pathparts => scalar(@pathparts) + $n_pathparts,
};
my @action_names = ($action->reverse);
# try Name first if that exists and then short circuit out
unshift @action_names, map { "*${_}"} @{$action->attributes->{Name}} if exists $action->attributes->{Name};

foreach my $action_name (@action_names) {
my ($actions, $captures, $action_parts, $n_pathparts) = $self->recurse_match(
$c, '/'.$action_name, \@parts
);
# No best action currently
# OR The action has less parts
# OR The action has equal parts but less captured data (ergo more defined)
if ($actions &&
(!$best_action ||
$#$action_parts < $#{$best_action->{parts}} ||
($#$action_parts == $#{$best_action->{parts}} &&
$#$captures < $#{$best_action->{captures}} &&
$n_pathparts > $best_action->{n_pathparts}))) {
my @pathparts = split /\//, $action->attributes->{PathPart}->[0];
$best_action = {
actions => [ $action, @$actions ],
captures=> [ @captures, @$captures ],
parts => $action_parts,
n_pathparts => scalar(@pathparts) + $n_pathparts,
};
}
}
}
else {
Expand Down Expand Up @@ -399,6 +405,11 @@ sub register {

$self->_actions->{'/'.$action->reverse} = $action;

if(my ($name) = @{$action->attributes->{Name}||[]}) {
die "Named action '$name' is already defined" if exists $self->_actions->{"/*$name"};
$self->_actions->{"/*$name"} = $action;
}

if (exists $action->attributes->{Args} and exists $action->attributes->{CaptureArgs}) {
Catalyst::Exception->throw(
"Combining Args and CaptureArgs attributes not supported registering " .
Expand Down
9 changes: 9 additions & 0 deletions lib/Catalyst/Dispatcher.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,7 @@ sub _action_rel2abs {
sub _invoke_as_path {
my ( $self, $c, $rel_path, $args ) = @_;

return $c->action_for($rel_path) if $rel_path =~ m/^\*/;
my $path = $self->_action_rel2abs( $c, $rel_path );

my ( $tail, @extra_args );
Expand Down Expand Up @@ -585,6 +586,14 @@ sub register {

$self->_action_hash->{"$namespace/$name"} = $action;
$self->_container_hash->{$namespace} = $container;

# Named Actions
if(my (@names) = @{$action->attributes->{Name}||[]}) {
foreach my $name (@names) {
die "Named action '$name' is already defined" if $self->_action_hash->{"/*$name"};
$self->_action_hash->{"/*$name"} = $action;
}
}
}

sub _find_or_create_action_container {
Expand Down
Loading