private_path method for actions that returns a string suitable for use in forward...

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Action.pm

diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm
index 6758e86..e9c9363 100644 (file)
--- a/lib/Catalyst/Action.pm
+++ b/lib/Catalyst/Action.pm
@@ -6,11 +6,13 @@ Catalyst::Action - Catalyst Action
 
 =head1 SYNOPSIS
 
-    <form action="[%c.uri_for(c.action.reverse)%]">
+    <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 
+This class represents a Catalyst Action. You can access the object for the
 currently dispatched action via $c->action. See the L<Catalyst::Dispatcher>
 for more information on how actions are dispatched. Actions are defined in
 L<Catalyst::Controller> subclasses.
@@ -18,6 +20,9 @@ L<Catalyst::Controller> 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');
@@ -25,8 +30,28 @@ 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 execute to invoke the encapsulated action coderef
+    '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; },
+
+    # Make general $stuff still work
+    fallback => 1,
+
+);
+
 
-no Moose;
 
 no warnings 'recursion';
 
@@ -34,17 +59,7 @@ no warnings 'recursion';
 
 sub dispatch {    # Execute ourselves against a context
     my ( $self, $c ) = @_;
-    #Moose todo: grrrrrr. this is no good. i don't know enough about it to
-    # debug it though. why can't we just call the accessor?
-    #local $c->{namespace} = $self->namespace;
-    #return $c->execute( $self->class, $self );
-
-    #believed to be equivalent:
-    my $orig = $c->namespace;
-    $c->namespace($self->namespace);
-    my $ret = $c->execute( $self->class, $self );
-    $c->namespace($orig);
-    return $ret;
+    return $c->execute( $self->class, $self );
 }
 
 sub execute {
@@ -55,7 +70,7 @@ sub execute {
 sub match {
     my ( $self, $c ) = @_;
     #would it be unreasonable to store the number of arguments
-    #the action has as it's own attribute?
+    #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];
@@ -63,6 +78,18 @@ sub match {
     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;
@@ -98,6 +125,11 @@ context and arguments
 Check Args attribute, and makes sure number of args matches the setting.
 Always returns true if Args is omitted.
 
+=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.
@@ -106,6 +138,11 @@ 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.
@@ -114,13 +151,13 @@ returns the sub name of this action.
 
 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