X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FAction.pm;h=8c51d1390c63eb2654c4d766f88353774593b15b;hp=174fb4b95e8d22ce520431ca2c2e220ec51c059f;hb=3c0da3ece98e535f1c168bb985980583498894ad;hpb=059c085bfcead450e70ace9ef193aa99ac2ab37d diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm index 174fb4b..8c51d13 100644 --- a/lib/Catalyst/Action.pm +++ b/lib/Catalyst/Action.pm @@ -6,11 +6,13 @@ Catalyst::Action - Catalyst Action =head1 SYNOPSIS -
+ + + $c->forward( $action->private_path ); =head1 DESCRIPTION -This class represents a Catalyst Action. You can access the object for the +This class represents a Catalyst Action. You can access the object for the currently dispatched action via $c->action. See the L for more information on how actions are dispatched. Actions are defined in L subclasses. @@ -18,24 +20,28 @@ L subclasses. =cut use Moose; - -has class => (is => 'rw'); -has namespace => (is => 'rw'); -has 'reverse' => (is => 'rw'); -has attributes => (is => 'rw'); -has name => (is => 'rw'); -has code => (is => 'rw'); - -no Moose; - -no warnings 'recursion'; - -#__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/); +use Scalar::Util 'looks_like_number'; +with 'MooseX::Emulate::Class::Accessor::Fast'; +use namespace::clean -except => 'meta'; + +has class => (is => 'rw'); +has namespace => (is => 'rw'); +has 'reverse' => (is => 'rw'); +has attributes => (is => 'rw'); +has name => (is => 'rw'); +has code => (is => 'rw'); +has private_path => ( + reader => 'private_path', + isa => 'Str', + lazy => 1, + required => 1, + default => sub { '/'.shift->reverse }, +); use overload ( # Stringify to reverse for debug output etc. - q{""} => sub { shift->reverse() }, + q{""} => sub { shift->{reverse} }, # Codulate to execute to invoke the encapsulated action coderef '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; }, @@ -45,9 +51,12 @@ use overload ( ); + + +no warnings 'recursion'; + sub dispatch { # Execute ourselves against a context my ( $self, $c ) = @_; - local $c->{namespace} = $self->namespace; return $c->execute( $self->class, $self ); } @@ -58,12 +67,46 @@ sub execute { sub match { my ( $self, $c ) = @_; + #would it be unreasonable to store the number of arguments + #the action has as its own attribute? + #it would basically eliminate the code below. ehhh. small fish return 1 unless exists $self->attributes->{Args}; my $args = $self->attributes->{Args}[0]; return 1 unless defined($args) && length($args); return scalar( @{ $c->req->args } ) == $args; } +sub match_captures { 1 } + +sub compare { + my ($a1, $a2) = @_; + + my ($a1_args) = @{ $a1->attributes->{Args} || [] }; + my ($a2_args) = @{ $a2->attributes->{Args} || [] }; + + $_ = looks_like_number($_) ? $_ : ~0 + for $a1_args, $a2_args; + + return $a1_args <=> $a2_args; +} + +sub number_of_args { + my ( $self ) = @_; + return 0 unless exists $self->attributes->{Args}; + return $self->attributes->{Args}[0]; +} + +sub number_of_captures { + my ( $self ) = @_; + + return 0 unless exists $self->attributes->{CaptureArgs}; + return $self->attributes->{CaptureArgs}[0] || 0; +} + +sub list_extra_info { } + +__PACKAGE__->meta->make_immutable; + 1; __END__ @@ -77,7 +120,9 @@ and so on. This determines how the action is dispatched to. =head2 class -Returns the class name where this action is defined. +Returns the name of the component where this action is defined. +Derived by calling the L +method on each component. =head2 code @@ -85,7 +130,7 @@ Returns a code reference to this action. =head2 dispatch( $c ) -Dispatch this action against a context +Dispatch this action against a context. =head2 execute( $controller, $c, @args ) @@ -97,6 +142,21 @@ context and arguments Check Args attribute, and makes sure number of args matches the setting. Always returns true if Args is omitted. +=head2 match_captures ($c, $captures) + +Can be implemented by action class and action role authors. If the method +exists, then it will be called with the request context and an array reference +of the captures for this action. + +Returning true from this method causes the chain match to continue, returning +makes the chain not match (and alternate, less preferred chains will be attempted). + + +=head2 compare + +Compares 2 actions based on the value of the C attribute, with no C +having the highest precedence. + =head2 namespace Returns the private namespace this action lives in. @@ -105,21 +165,38 @@ Returns the private namespace this action lives in. Returns the private path for this action. +=head2 private_path + +Returns absolute private path for this action. Unlike C, the +C of an action is always suitable for passing to C. + =head2 name -returns the sub name of this action. +Returns the sub name of this action. + +=head2 number_of_args + +Returns the number of args this action expects. This is 0 if the action doesn't take any arguments and undef if it will take any number of arguments. + +=head2 number_of_captures + +Returns the number of captures this action expects for L actions. + +=head2 list_extra_info + +An array of values useful to improve debugging =head2 meta -Provided by Moose +Provided by Moose. -=head1 AUTHOR +=head1 AUTHORS -Matt S. Trout +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify it under +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut