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=ec30c7ab50522295de95fb17d405f32d961a8158;hp=fb5c9c6ca9662c2bb82db9e2b76e1904f47b89eb;hb=c1192f1ed63f124eb2d143e10b215703e7dc6284;hpb=760d121ecfcc1ad7c28342a6912a472fe30e5fe0 diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm index fb5c9c6..ec30c7a 100644 --- a/lib/Catalyst/Action.pm +++ b/lib/Catalyst/Action.pm @@ -21,6 +21,7 @@ L subclasses. use Moose; use Scalar::Util 'looks_like_number'; +use Moose::Util::TypeConstraints (); with 'MooseX::Emulate::Class::Accessor::Fast'; use namespace::clean -except => 'meta'; @@ -38,6 +39,211 @@ has private_path => ( default => sub { '/'.shift->reverse }, ); +has number_of_args => ( + is=>'ro', + init_arg=>undef, + isa=>'Int|Undef', + required=>1, + lazy=>1, + builder=>'_build_number_of_args'); + + sub _build_number_of_args { + my $self = shift; + if( ! exists $self->attributes->{Args} ) { + # When 'Args' does not exist, that means we want 'any number of args'. + return undef; + } elsif(!defined($self->attributes->{Args}[0])) { + # When its 'Args' that internal cue for 'unlimited' + return undef; + } elsif( + scalar(@{$self->attributes->{Args}}) == 1 && + looks_like_number($self->attributes->{Args}[0]) + ) { + # 'Old school' numbered args (is allowed to be undef as well) + return $self->attributes->{Args}[0]; + } else { + # New hotness named arg constraints + return $self->number_of_args_constraints; + } + } + +sub normalized_arg_number { + return defined($_[0]->number_of_args) ? $_[0]->number_of_args : ~0; +} + +has number_of_args_constraints => ( + is=>'ro', + isa=>'Int|Undef', + init_arg=>undef, + required=>1, + lazy=>1, + builder=>'_build_number_of_args_constraints'); + + sub _build_number_of_args_constraints { + my $self = shift; + return unless $self->has_args_constraints; + + my $total = 0; + foreach my $tc( @{$self->args_constraints}) { + if($tc->is_a_type_of('Ref')) { + if($tc->can('parameters') && $tc->has_parameters) { + my $total_params = scalar(@{ $tc->parameters||[] }); + $total = $total + $total_params; + } else { + # Its a Reftype but we don't know the number of params it + # actually validates. + return undef; + } + } else { + $total++; + } + } + + return $total; + } + +has args_constraints => ( + is=>'ro', + init_arg=>undef, + traits=>['Array'], + isa=>'ArrayRef', + required=>1, + lazy=>1, + builder=>'_build_args_constraints', + handles => { + has_args_constraints => 'count', + args_constraint_count => 'count', + }); + + sub _build_args_constraints { + my $self = shift; + my @arg_protos = @{$self->attributes->{Args}||[]}; + + return [] unless scalar(@arg_protos); + return [] unless defined($arg_protos[0]); + + # If there is only one arg and it looks like a number + # we assume its 'classic' and the number is the number of + # constraints. + my @args = (); + if( + scalar(@arg_protos) == 1 && + looks_like_number($arg_protos[0]) + ) { + return \@args; + } else { + @args = + map { my @tc = $self->resolve_type_constraint($_); scalar(@tc) ? @tc : die "$_ is not a constraint!" } + @arg_protos; + } + return \@args; + } + +has number_of_captures_constraints => ( + is=>'ro', + isa=>'Int|Undef', + init_arg=>undef, + required=>1, + lazy=>1, + builder=>'_build_number_of_capture_constraints'); + + sub _build_number_of_capture_constraints { + my $self = shift; + return unless $self->has_captures_constraints; + + my $total = 0; + foreach my $tc( @{$self->captures_constraints}) { + if($tc->is_a_type_of('Ref')) { + if($tc->can('parameters') && $tc->has_parameters) { + my $total_params = scalar(@{ $tc->parameters||[] }); + $total = $total + $total_params; + } else { + # Its a Reftype but we don't know the number of params it + # actually validates. This is not currently permitted in + # a capture... + die "You cannot use CaptureArgs($tc) in ${\$self->reverse} because we cannot determined the number of its parameters"; + } + } else { + $total++; + } + } + + return $total; + } + +has captures_constraints => ( + is=>'ro', + init_arg=>undef, + traits=>['Array'], + isa=>'ArrayRef', + required=>1, + lazy=>1, + builder=>'_build_captures_constraints', + handles => { + has_captures_constraints => 'count', + captures_constraints_count => 'count', + }); + + sub _build_captures_constraints { + my $self = shift; + my @arg_protos = @{$self->attributes->{CaptureArgs}||[]}; + + return [] unless scalar(@arg_protos); + return [] unless defined($arg_protos[0]); + # If there is only one arg and it looks like a number + # we assume its 'classic' and the number is the number of + # constraints. + my @args = (); + if( + scalar(@arg_protos) == 1 && + looks_like_number($arg_protos[0]) + ) { + return \@args; + } else { + @args = + map { my @tc = $self->resolve_type_constraint($_); scalar(@tc) ? @tc : die "$_ is not a constraint!" } + @arg_protos; + } + + return \@args; + } + +sub resolve_type_constraint { + my ($self, $name) = @_; + my @tc = eval "package ${\$self->class}; $name"; + return @tc if $tc[0]; + return Moose::Util::TypeConstraints::find_or_parse_type_constraint($name); +} + +has number_of_captures => ( + is=>'ro', + init_arg=>undef, + isa=>'Int', + required=>1, + lazy=>1, + builder=>'_build_number_of_captures'); + + sub _build_number_of_captures { + my $self = shift; + if( ! exists $self->attributes->{CaptureArgs} ) { + # If there are no defined capture args, thats considered 0. + return 0; + } elsif(!defined($self->attributes->{CaptureArgs}[0])) { + # If you fail to give a defined value, that's also 0 + return 0; + } elsif( + scalar(@{$self->attributes->{CaptureArgs}}) == 1 && + looks_like_number($self->attributes->{CaptureArgs}[0]) + ) { + # 'Old school' numbered captures + return $self->attributes->{CaptureArgs}[0]; + } else { + # New hotness named arg constraints + return $self->number_of_captures_constraints; + } + } + + use overload ( # Stringify to reverse for debug output etc. @@ -51,8 +257,6 @@ use overload ( ); - - no warnings 'recursion'; sub dispatch { # Execute ourselves against a context @@ -65,73 +269,96 @@ sub execute { $self->code->(@_); } -sub match_captures { - my ( $self, $c, $captures ) = @_; - ## It would seem that now that we can match captures, we could remove a lot - ## of the capture_args to args mapping all around. I gave it a go, but was - ## not trival, contact jnap on irc for what I tried if you want to try. - ## return $self->_match_has_expected_capture_args($captures) && - return $self->_match_has_expected_http_method($c->req->method); -} - sub match { - my ( $self, $c ) = @_; - return $self->_match_has_expected_args($c->req->args) && - $self->_match_has_expected_http_method($c->req->method); -} - -sub _match_has_expected_args { - my ($self, $req_args) = @_; - return 1 unless exists $self->attributes->{Args}; - my $args = $self->attributes->{Args}[0]; - return 1 unless defined($args) && length($args); - return scalar( @{$req_args} ) == $args; + my ( $self, $c ) = @_; + return $self->match_args($c, $c->req->args); } -sub _match_has_expected_capture_args { - my ($self, $req_args) = @_; - return 1 unless exists $self->attributes->{CaptureArgs}; - my $args = $self->attributes->{CaptureArgs}[0]; - return 1 unless defined($args) && length($args); - return scalar( @{$req_args} ) == $args; +sub match_args { + my ($self, $c, $args) = @_; + my @args = @{$args||[]}; + + # If infinite args, we always match + return 1 if $self->normalized_arg_number == ~0; + + # There there are arg constraints, we must see to it that the constraints + # check positive for each arg in the list. + if($self->has_args_constraints) { + # If there is only one type constraint, and its a Ref or subtype of Ref, + # That means we expect a reference, so use the full args arrayref. + if( + $self->args_constraint_count == 1 && + ( + $self->args_constraints->[0]->is_a_type_of('Ref') || + $self->args_constraints->[0]->is_a_type_of('ClassName') + ) + ) { + return $self->args_constraints->[0]->check($args); + # Removing coercion stuff for the first go + #if($self->args_constraints->[0]->coercion && $self->attributes->{Coerce}) { + # my $coerced = $self->args_constraints->[0]->coerce($c) || return 0; + # $c->req->args([$coerced]); + # return 1; + #} + } else { + # Because of the way chaining works, we can expect args that are totally not + # what you'd expect length wise. When they don't match length, thats a fail + return 0 unless scalar( @args ) == $self->normalized_arg_number; + + for my $i(0..$#args) { + $self->args_constraints->[$i]->check($args[$i]) || return 0; + } + return 1; + } + } else { + # Otherwise, we just need to match the number of args. + return scalar( @args ) == $self->normalized_arg_number; + } } -sub _match_has_expected_http_method { - my ($self, $method) = @_; - my @methods = @{ $self->attributes->{Method} || [] }; - if(scalar @methods) { - my $result = scalar(grep { lc($_) eq lc($method) } @methods) ? 1:0; - return $result; +sub match_captures { + my ($self, $c, $captures) = @_; + my @captures = @{$captures||[]}; + + return 1 unless scalar(@captures); # If none, just say its ok + + if($self->has_captures_constraints) { + if( + $self->captures_constraints_count == 1 && + ( + $self->captures_constraints->[0]->is_a_type_of('Ref') || + $self->captures_constraints->[0]->is_a_type_of('ClassName') + ) + ) { + return $self->captures_constraints->[0]->check($captures); + } else { + for my $i(0..$#captures) { + $self->captures_constraints->[$i]->check($captures[$i]) || return 0; + } + return 1; + } } else { - ## No HTTP Methods to check return 1; } + return 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; + return $a1->normalized_arg_number <=> $a2->normalized_arg_number; } -sub number_of_args { - my ( $self ) = @_; - return 0 unless exists $self->attributes->{Args}; - return $self->attributes->{Args}[0]; +sub scheme { + return exists $_[0]->attributes->{Scheme} ? $_[0]->attributes->{Scheme}[0] : undef; } -sub number_of_captures { - my ( $self ) = @_; - - return 0 unless exists $self->attributes->{CaptureArgs}; - return $self->attributes->{CaptureArgs}[0] || 0; -} +sub list_extra_info { + my $self = shift; + return { + Args => $self->normalized_arg_number, + CaptureArgs => $self->number_of_captures, + } +} __PACKAGE__->meta->make_immutable; @@ -149,7 +376,7 @@ and so on. This determines how the action is dispatched to. =head2 class Returns the name of the component where this action is defined. -Derived by calling the L +Derived by calling the L method on each component. =head2 code @@ -179,6 +406,14 @@ 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 match_args($c, $args) + +Underlying feature that does the 'match' work, but doesn't require a context to +work (like 'match' does.). + +=head2 resolve_type_constraint + +Trys to find a type constraint if you have on on a type constrained method. =head2 compare @@ -204,12 +439,26 @@ 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. +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 normalized_arg_number + +For the purposes of comparison we normalize 'number_of_args' so that if it is +undef we mean ~0 (as many args are we can think of). =head2 number_of_captures Returns the number of captures this action expects for L actions. +=head2 list_extra_info + +A HashRef of key-values that an action can provide to a debugging screen + +=head2 scheme + +Any defined scheme for the action + =head2 meta Provided by Moose. @@ -224,3 +473,5 @@ This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut + +