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=e9c936303d235f5dbff4826e4c4b3ff700fdb77c;hp=b2a094770978a434c030ba67019e68494a5fb044;hb=009b5b2324f83396439a494a56684efb60eb2cd8;hpb=261c571ec577304a8a41218a4576675c8099069a diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm index b2a0947..e9c9363 100644 --- a/lib/Catalyst/Action.pm +++ b/lib/Catalyst/Action.pm @@ -1,67 +1,163 @@ package Catalyst::Action; -use strict; -use base qw/Class::Accessor::Fast/; +=head1 NAME + +Catalyst::Action - Catalyst Action + +=head1 SYNOPSIS + +
+ + $c->forward( $action->private_path ); -__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/); +=head1 DESCRIPTION + +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. + +=cut + +use Moose; +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} }, - # Codulate to encapsulated action coderef - '&{}' => sub { shift->{code} }, + # Codulate to execute to invoke the encapsulated action coderef + '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; }, + + # Make general $stuff still work + fallback => 1, ); -=head1 NAME -Catalyst::Action - Catalyst Action -=head1 SYNOPSIS +no warnings 'recursion'; -See L. +#__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/); -=head1 DESCRIPTION +sub dispatch { # Execute ourselves against a context + my ( $self, $c ) = @_; + return $c->execute( $self->class, $self ); +} + +sub execute { + my $self = shift; + $self->code->(@_); +} + +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 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; +} + +__PACKAGE__->meta->make_immutable; + +1; + +__END__ =head1 METHODS -=over 4 +=head2 attributes -=item attributes +The sub attributes that are set for this action, like Local, Path, Private +and so on. This determines how the action is dispatched to. -=item class +=head2 class -=item code +Returns the class name where this action is defined. -=item execute +=head2 code -=cut +Returns a code reference to this action. -sub execute { # Execute ourselves against a context - my ( $self, $c ) = @_; - local $c->namespace = $self->namespace; - return $c->execute( $self->class, $self ); -} +=head2 dispatch( $c ) + +Dispatch this action against a context + +=head2 execute( $controller, $c, @args ) -=item namespace +Execute this action's coderef against a given controller with a given +context and arguments -=item reverse +=head2 match( $c ) -=item name +Check Args attribute, and makes sure number of args matches the setting. +Always returns true if Args is omitted. -=back +=head2 compare -=head1 AUTHOR +Compares 2 actions based on the value of the C attribute, with no C +having the highest precedence. -Matt S. Trout +=head2 namespace + +Returns the private namespace this action lives in. + +=head2 reverse + +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. + +=head2 meta + +Provided by Moose + +=head1 AUTHORS + +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 - -1;