Improve the docs for MyAction attributes
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Action.pm
index 0eb9942..b5b2f48 100644 (file)
@@ -8,6 +8,8 @@ Catalyst::Action - Catalyst Action
 
     <form action="[%c.uri_for(c.action)%]">
 
+    $c->forward( $action->private_path );
+
 =head1 DESCRIPTION
 
 This class represents a Catalyst Action. You can access the object for the
@@ -28,6 +30,13 @@ 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 (
 
@@ -37,10 +46,6 @@ use overload (
     # Codulate to execute to invoke the encapsulated action coderef
     '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; },
 
-    # Which action takes precedence
-    'cmp' => 'compare',
-    '<=>' => 'compare',
-
     # Make general $stuff still work
     fallback => 1,
 
@@ -50,8 +55,6 @@ use overload (
 
 no warnings 'recursion';
 
-#__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/);
-
 sub dispatch {    # Execute ourselves against a context
     my ( $self, $c ) = @_;
     return $c->execute( $self->class, $self );
@@ -62,31 +65,72 @@ sub execute {
   $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 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 sort_order {
-    my $self = shift;
-
-    my ($args) = @{ $self->attributes->{Args} || [] };
+sub match {
+  my ( $self, $c ) = @_;
+  return $self->_match_has_expected_args($c->req->args) &&
+    $self->_match_has_expected_http_method($c->req->method);
+}
 
-    return $args if looks_like_number($args);
+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;
+}
 
-    return ~0;
+#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_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;
+  } else {
+    ## No HTTP Methods to check
+    return 1;
+  }
 }
 
 sub compare {
     my ($a1, $a2) = @_;
 
-    return $a1->sort_order <=> $a2->sort_order;
+    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;
 }
 
 __PACKAGE__->meta->make_immutable;
@@ -104,7 +148,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<Catalyst::Component/catalyst_component_name|catalyst_component_name>
+method on each component.
 
 =head2 code
 
@@ -112,7 +158,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 )
 
@@ -124,6 +170,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<Args> attribute, with no C<Args>
+having the highest precedence.
+
 =head2 namespace
 
 Returns the private namespace this action lives in.
@@ -132,13 +193,26 @@ 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<reverse>, the
+C<private_path> of an action is always suitable for passing to C<forward>.
+
 =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<Chained|Catalyst::DispatchType::Chained> actions.
 
 =head2 meta
 
-Provided by Moose
+Provided by Moose.
 
 =head1 AUTHORS