Remove use of overload

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

diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm
index 8e5ea75..a74eb29 100644 (file)
--- a/lib/Catalyst/Action.pm
+++ b/lib/Catalyst/Action.pm
@@ -1,67 +1,120 @@
 package Catalyst::Action;
 
-use strict;
-use base qw/Class::Accessor::Fast/;
+=head1 NAME
 
-__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/);
+Catalyst::Action - Catalyst Action
 
-use overload (
+=head1 SYNOPSIS
 
-    # Stringify to reverse for debug output etc.
-    q{""} => sub { shift->{reverse} },
+    <form action="[%c.uri_for(c.action.reverse)%]">
 
-    # Codulate to encapsulated action coderef
-    '&{}' => sub { shift->{code} },
+=head1 DESCRIPTION
 
-    # Make general $stuff still work
-    fallback => 1,
+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.
 
-);
+=cut
 
-=head1 NAME
+use Class::C3;
+use Moose;
 
-Catalyst::Action - Catalyst Action
+has class => (is => 'rw');
+has namespace => (is => 'rw');
+has 'reverse' => (is => 'rw');
+has attributes => (is => 'rw');
+has name => (is => 'rw');
+has code => (is => 'rw');
 
-=head1 SYNOPSIS
+no Moose;
 
-See L<Catalyst>.
+no warnings 'recursion';
 
-=head1 DESCRIPTION
+#__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/);
+
+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;
+}
+
+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 it's 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;
+}
+
+__PACKAGE__->meta->make_immutable;
+
+1;
+
+__END__
 
 =head1 METHODS
 
 =head2 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.
+
 =head2 class
 
+Returns the class name where this action is defined.
+
 =head2 code
 
-=head2 execute
+Returns a code reference to this action.
 
-=cut
+=head2 dispatch( $c )
 
-sub execute {    # Execute ourselves against a context
-    my ( $self, $c ) = @_;
-    local $c->namespace = $self->namespace;
-    return $c->execute( $self->class, $self );
-}
+Dispatch this action against a context
 
-=head2 match
+=head2 execute( $controller, $c, @args )
 
-=cut
+Execute this action's coderef against a given controller with a given
+context and arguments
 
-sub match {
-    my ( $self, $c ) = @_;
-    return 1 unless exists $self->attributes->{Args};
-    return scalar(@{$c->req->args}) == $self->attributes->{Args}[0];
-}
+=head2 match( $c )
+
+Check Args attribute, and makes sure number of args matches the setting.
+Always returns true if Args is omitted.
 
 =head2 namespace
 
+Returns the private namespace this action lives in.
+
 =head2 reverse
 
+Returns the private path for this action.
+
 =head2 name
 
+returns the sub name of this action.
+
+=head2 meta
+
+Provided by Moose
+
 =head1 AUTHOR
 
 Matt S. Trout
@@ -72,5 +125,3 @@ This program is free software, you can redistribute it and/or modify it under
 the same terms as Perl itself.
 
 =cut
-
-1;