X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FController.pm;h=b1c4c945da3282e02b79cf0323582e0f8d23b208;hb=f7a3f8fd0a1df1dc3f5811747cfa377a020b9dcc;hp=d31b704666be8dbab83e858a34ca9a537cd707a4;hpb=6323fda2e7ace0fc0aa06305c674957cedc6d025;p=catagits%2FCatalyst-Runtime.git
diff --git a/lib/Catalyst/Controller.pm b/lib/Catalyst/Controller.pm
index d31b704..b1c4c94 100644
--- a/lib/Catalyst/Controller.pm
+++ b/lib/Catalyst/Controller.pm
@@ -1,42 +1,50 @@
package Catalyst::Controller;
use Moose;
-use Class::MOP ();
-#use MooseX::ClassAttribute;
+use Moose::Util qw/find_meta/;
+use List::MoreUtils qw/uniq/;
+use namespace::clean -except => 'meta';
+
+BEGIN { extends qw/Catalyst::Component MooseX::MethodAttributes::Inheritable/; }
+
+use MooseX::MethodAttributes;
use Catalyst::Exception;
use Catalyst::Utils;
-use Class::Inspector;
-use NEXT;
-
-#extends qw/Catalyst::Component Catalyst::AttrContainer/;
-use base qw/Catalyst::Component Catalyst::AttrContainer/;
-
-# class_has _dispatch_steps =>
-# (
-# is => 'rw',
-# isa => 'ArrayRef',
-# required => 1,
-# default => sub{ [qw/_BEGIN _AUTO _ACTION/] },
-# );
-
-# class_has _action_class =>
-# (
-# is => 'rw',
-# isa => 'ClassName',
-# required => 1,
-# default => sub{ 'Catalyst::Action' },
-# );
-
-__PACKAGE__->mk_classdata('_dispatch_steps');
-__PACKAGE__->mk_classdata('_action_class');
-__PACKAGE__->_action_class('Catalyst::Action');
-__PACKAGE__->_dispatch_steps([qw/_BEGIN _AUTO _ACTION/]);
+with 'Catalyst::Component::ApplicationAttribute';
+
+has path_prefix =>
+ (
+ is => 'rw',
+ isa => 'Str',
+ init_arg => 'path',
+ predicate => 'has_path_prefix',
+ );
+
+has action_namespace =>
+ (
+ is => 'rw',
+ isa => 'Str',
+ init_arg => 'namespace',
+ predicate => 'has_action_namespace',
+ );
+
+has actions =>
+ (
+ accessor => '_controller_actions',
+ isa => 'HashRef',
+ init_arg => undef,
+ );
+
+sub BUILD {
+ my ($self, $args) = @_;
+ my $action = delete $args->{action} || {};
+ my $actions = delete $args->{actions} || {};
+ my $attr_value = $self->merge_config_hashes($actions, $action);
+ $self->_controller_actions($attr_value);
+}
-has _application => ( is => 'rw' );
-### _app as alias
-*_app = *_application;
=head1 NAME
@@ -61,16 +69,12 @@ for more info about how Catalyst dispatches to actions.
=cut
-# just emulating old behavior. we could probably do this
-# via BUILD later or pass $app as application => $app
-around new => sub {
- my $orig = shift;
- my $self = shift;
- my $app = $_[0];
- my $new = $self->$orig(@_);
- $new->_application( $app );
- return $new;
-};
+#I think both of these could be attributes. doesn't really seem like they need
+#to ble class data. i think that attributes +default would work just fine
+__PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/;
+
+__PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
+__PACKAGE__->_action_class('Catalyst::Action');
sub _DISPATCH : Private {
@@ -105,7 +109,7 @@ sub _ACTION : Private {
my ( $self, $c ) = @_;
if ( ref $c->action
&& $c->action->can('execute')
- && $c->req->action )
+ && defined $c->req->action )
{
$c->action->dispatch( $c );
}
@@ -126,66 +130,116 @@ sub action_for {
return $app->dispatcher->get_action($name, $self->action_namespace);
}
-sub action_namespace {
+#my opinion is that this whole sub really should be a builder method, not
+#something that happens on every call. Anyone else disagree?? -- groditi
+## -- apparently this is all just waiting for app/ctx split
+around action_namespace => sub {
+ my $orig = shift;
my ( $self, $c ) = @_;
- unless ( $c ) {
- $c = ($self->isa('Catalyst') ? $self : $self->_application);
+
+ my $class = ref($self) || $self;
+ my $appclass = ref($c) || $c;
+ if( ref($self) ){
+ return $self->$orig if $self->has_action_namespace;
+ } else {
+ return $class->config->{namespace} if exists $class->config->{namespace};
}
- my $hash = (ref $self ? $self : $self->config); # hate app-is-class
- return $hash->{namespace} if exists $hash->{namespace};
- return Catalyst::Utils::class2prefix( ref($self) || $self,
- $c->config->{case_sensitive} )
- || '';
-}
-sub path_prefix {
- my ( $self, $c ) = @_;
- unless ( $c ) {
- $c = ($self->isa('Catalyst') ? $self : $self->_application);
+ my $case_s;
+ if( $c ){
+ $case_s = $appclass->config->{case_sensitive};
+ } else {
+ if ($self->isa('Catalyst')) {
+ $case_s = $class->config->{case_sensitive};
+ } else {
+ if (ref $self) {
+ $case_s = ref($self->_application)->config->{case_sensitive};
+ } else {
+ confess("Can't figure out case_sensitive setting");
+ }
+ }
}
- my $hash = (ref $self ? $self : $self->config); # hate app-is-class
- return $hash->{path} if exists $hash->{path};
- return shift->action_namespace(@_);
+
+ my $namespace = Catalyst::Utils::class2prefix($self->catalyst_component_name, $case_s) || '';
+ $self->$orig($namespace) if ref($self);
+ return $namespace;
+};
+
+#Once again, this is probably better written as a builder method
+around path_prefix => sub {
+ my $orig = shift;
+ my $self = shift;
+ if( ref($self) ){
+ return $self->$orig if $self->has_path_prefix;
+ } else {
+ return $self->config->{path} if exists $self->config->{path};
+ }
+ my $namespace = $self->action_namespace(@_);
+ $self->$orig($namespace) if ref($self);
+ return $namespace;
+};
+
+sub get_action_methods {
+ my $self = shift;
+ my $meta = find_meta($self) || confess("No metaclass setup for $self");
+ confess("Metaclass "
+ . ref($meta) . " for "
+ . $meta->name
+ . " cannot support register_actions." )
+ unless $meta->can('get_nearest_methods_with_attributes');
+ my @methods = $meta->get_nearest_methods_with_attributes;
+
+ # actions specified via config are also action_methods
+ push(
+ @methods,
+ map {
+ $meta->find_method_by_name($_)
+ || confess( 'Action "'
+ . $_
+ . '" is not available from controller '
+ . ( ref $self ) )
+ } keys %{ $self->_controller_actions }
+ ) if ( ref $self );
+ return uniq @methods;
}
sub register_actions {
my ( $self, $c ) = @_;
- my $class = ref $self || $self;
+ $self->register_action_methods( $c, $self->get_action_methods );
+}
+
+sub register_action_methods {
+ my ( $self, $c, @methods ) = @_;
+ my $class = $self->catalyst_component_name;
+ #this is still not correct for some reason.
my $namespace = $self->action_namespace($c);
- my %methods;
- {
- my $meth_map = $class->meta->get_method_map;
- @methods{values %$meth_map} = (keys %$meth_map);
- }
- #Moose TODO: something tells me that roles could kill the directly code below
- # Advanced inheritance support for plugins and the like
- my @action_cache;
- {
- no strict 'refs';
- for my $isa ( @{"$class\::ISA"}, $class ) {
- push @action_cache, @{ $isa->_action_cache }
- if $isa->can('_action_cache');
+ # FIXME - fugly
+ if (!blessed($self) && $self eq $c && scalar(@methods)) {
+ my @really_bad_methods = grep { ! /^_(DISPATCH|BEGIN|AUTO|ACTION|END)$/ } map { $_->name } @methods;
+ if (scalar(@really_bad_methods)) {
+ $c->log->warn("Action methods (" . join(', ', @really_bad_methods) . ") found defined in your application class, $self. This is deprecated, please move them into a Root controller.");
}
}
- foreach my $cache (@action_cache) {
- my $code = $cache->[0];
- my $method = delete $methods{$code}; # avoid dupe registers
- next unless $method;
- my $attrs = $self->_parse_attrs( $c, $method, @{ $cache->[1] } );
+ foreach my $method (@methods) {
+ my $name = $method->name;
+ # Horrible hack! All method metaclasses should have an attributes
+ # method, core Moose bug - see r13354.
+ my $attributes = $method->can('attributes') ? $method->attributes : [];
+ my $attrs = $self->_parse_attrs( $c, $name, @{ $attributes } );
if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) {
$c->log->debug( 'Bad action definition "'
- . join( ' ', @{ $cache->[1] } )
- . qq/" for "$class->$method"/ )
+ . join( ' ', @{ $attributes } )
+ . qq/" for "$class->$name"/ )
if $c->debug;
next;
}
- my $reverse = $namespace ? "$namespace/$method" : $method;
+ my $reverse = $namespace ? "${namespace}/${name}" : $name;
my $action = $self->create_action(
- name => $method,
- code => $code,
+ name => $name,
+ code => $method->body,
reverse => $reverse,
namespace => $namespace,
class => $class,
@@ -196,21 +250,31 @@ sub register_actions {
}
}
-sub create_action {
+sub action_class {
my $self = shift;
my %args = @_;
my $class = (exists $args{attributes}{ActionClass}
- ? $args{attributes}{ActionClass}[0]
- : $self->_action_class);
+ ? $args{attributes}{ActionClass}[0]
+ : $self->_action_class);
- #can we replace with a single call to Class::MOP::load_class() ?
- #unless ( Class::Inspector->loaded($class) ) {
- # require Class::Inspector->filename($class);
- #}
Class::MOP::load_class($class);
+ return $class;
+}
- return $class->new( \%args );
+sub create_action {
+ my $self = shift;
+ my %args = @_;
+
+ my $class = $self->action_class(%args);
+ my $action_args = $self->config->{action_args};
+
+ my %extra_args = (
+ %{ $action_args->{'*'} || {} },
+ %{ $action_args->{ $args{name} } || {} },
+ );
+
+ return $class->new({ %extra_args, %args });
}
sub _parse_attrs {
@@ -232,15 +296,24 @@ sub _parse_attrs {
}
}
- my $hash = (ref $self ? $self : $self->config); # hate app-is-class
-
- if (exists $hash->{actions} || exists $hash->{action}) {
- my $a = $hash->{actions} || $hash->{action};
- %raw_attributes = ((exists $a->{'*'} ? %{$a->{'*'}} : ()),
- %raw_attributes,
- (exists $a->{$name} ? %{$a->{$name}} : ()));
+ #I know that the original behavior was to ignore action if actions was set
+ # but i actually think this may be a little more sane? we can always remove
+ # the merge behavior quite easily and go back to having actions have
+ # presedence over action by modifying the keys. i honestly think this is
+ # superior while mantaining really high degree of compat
+ my $actions;
+ if( ref($self) ) {
+ $actions = $self->_controller_actions;
+ } else {
+ my $cfg = $self->config;
+ $actions = $self->merge_config_hashes($cfg->{actions}, $cfg->{action});
}
+ %raw_attributes = ((exists $actions->{'*'} ? %{$actions->{'*'}} : ()),
+ %raw_attributes,
+ (exists $actions->{$name} ? %{$actions->{$name}} : ()));
+
+
my %final_attributes;
foreach my $key (keys %raw_attributes) {
@@ -250,8 +323,8 @@ sub _parse_attrs {
foreach my $value (ref($raw) eq 'ARRAY' ? @$raw : $raw) {
my $meth = "_parse_${key}_attr";
- if ( $self->can($meth) ) {
- ( $key, $value ) = $self->$meth( $c, $name, $value );
+ if ( my $code = $self->can($meth) ) {
+ ( $key, $value ) = $self->$code( $c, $name, $value );
}
push( @{ $final_attributes{$key} }, $value );
}
@@ -276,7 +349,7 @@ sub _parse_Relative_attr { shift->_parse_Local_attr(@_); }
sub _parse_Path_attr {
my ( $self, $c, $name, $value ) = @_;
- $value ||= '';
+ $value = '' if !defined $value;
if ( $value =~ m!^/! ) {
return ( 'Path', $value );
}
@@ -298,16 +371,56 @@ sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); }
sub _parse_LocalRegex_attr {
my ( $self, $c, $name, $value ) = @_;
unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; }
- return ( 'Regex', '^' . $self->path_prefix($c) . "/${value}" );
+
+ my $prefix = $self->path_prefix( $c );
+ $prefix .= '/' if length( $prefix );
+
+ return ( 'Regex', "^${prefix}${value}" );
}
sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); }
+sub _parse_Chained_attr {
+ my ($self, $c, $name, $value) = @_;
+
+ if (defined($value) && length($value)) {
+ if ($value eq '.') {
+ $value = '/'.$self->action_namespace($c);
+ } elsif (my ($rel, $rest) = $value =~ /^((?:\.{2}\/)+)(.*)$/) {
+ my @parts = split '/', $self->action_namespace($c);
+ my @levels = split '/', $rel;
+
+ $value = '/'.join('/', @parts[0 .. $#parts - @levels], $rest);
+ } elsif ($value !~ m/^\//) {
+ my $action_ns = $self->action_namespace($c);
+
+ if ($action_ns) {
+ $value = '/'.join('/', $action_ns, $value);
+ } else {
+ $value = '/'.$value; # special case namespace '' (root)
+ }
+ }
+ } else {
+ $value = '/'
+ }
+
+ return Chained => $value;
+}
+
+sub _parse_ChainedParent_attr {
+ my ($self, $c, $name, $value) = @_;
+ return $self->_parse_Chained_attr($c, $name, '../'.$name);
+}
+
+sub _parse_PathPrefix_attr {
+ my ( $self, $c ) = @_;
+ return PathPart => $self->path_prefix($c);
+}
+
sub _parse_ActionClass_attr {
my ( $self, $c, $name, $value ) = @_;
- unless ( $value =~ s/^\+// ) {
- $value = join('::', $self->_action_class, $value );
- }
+ my $appname = $self->_application;
+ $value = Catalyst::Utils::resolve_namespace($appname . '::Action', $self->_action_class, $value);
return ( 'ActionClass', $value );
}
@@ -320,6 +433,8 @@ sub _parse_MyAction_attr {
return ( 'ActionClass', $value );
}
+__PACKAGE__->meta->make_immutable;
+
1;
__END__
@@ -342,24 +457,58 @@ of setting namespace to '' (the null string).
Sets 'path_prefix', as described below.
+=head2 action
+
+Allows you to set the attributes that the dispatcher creates actions out of.
+This allows you to do 'rails style routes', or override some of the
+attribute defintions of actions composed from Roles.
+You can set arguments globally (for all actions of the controller) and
+specifically (for a single action).
+
+ __PACKAGE__->config(
+ action => {
+ '*' => { Chained => 'base', Args => 0 },
+ base => { Chained => '/', PathPart => '', CaptureArgs => 0 },
+ },
+ );
+
+In the case above every sub in the package would be made into a Chain
+endpoint with a URI the same as the sub name for each sub, chained
+to the sub named C. Ergo dispatch to C would call the
+C method, then the C method.
+
+=head2 action_args
+
+Allows you to set constructor arguments on your actions. You can set arguments
+globally and specifically (as above).
+This is particularly useful when using Cs
+(L) and custom Ces.
+
+ __PACKAGE__->config(
+ action_args => {
+ '*' => { globalarg1 => 'hello', globalarg2 => 'goodbye' },
+ 'specific_action' => { customarg => 'arg1' },
+ },
+ );
+
+In the case above the action class associated with C would get
+passed the following arguments, in addition to the normal action constructor
+arguments, when it is instantiated:
+
+ (globalarg1 => 'hello', globalarg2 => 'goodbye', customarg => 'arg1')
+
=head1 METHODS
-=head2 $class->new($app, @args)
+=head2 BUILDARGS ($app, @args)
-Proxies through to NEXT::new and stashes the application instance as
-$self->_application.
+From L, stashes the application
+instance as $self->_application.
=head2 $self->action_for('name')
Returns the Catalyst::Action object (if any) for a given method name
in this component.
-=head2 $self->register_actions($c)
-
-Finds all applicable actions for this component, creates
-Catalyst::Action objects (using $self->create_action) for them and
-registers them with $c->dispatcher.
-
=head2 $self->action_namespace($c)
Returns the private namespace for actions in this component. Defaults
@@ -370,31 +519,50 @@ overridden from the "namespace" config key.
=head2 $self->path_prefix($c)
-Returns the default path prefix for :Local, :LocalRegex and relative
-:Path actions in this component. Defaults to the action_namespace or
+Returns the default path prefix for :PathPrefix, :Local, :LocalRegex and
+relative :Path actions in this component. Defaults to the action_namespace or
can be overridden from the "path" config key.
+=head2 $self->register_actions($c)
+
+Finds all applicable actions for this component, creates
+Catalyst::Action objects (using $self->create_action) for them and
+registers them with $c->dispatcher.
+
+=head2 $self->get_action_methods()
+
+Returns a list of L objects, doing the
+L role, which are the set of
+action methods for this package.
+
+=head2 $self->register_action_methods($c, @methods)
+
+Creates action objects for a set of action methods using C< create_action >,
+and registers them with the dispatcher.
+
+=head2 $self->action_class(%args)
+
+Used when a controller is creating an action to determine the correct base
+action class to use.
+
=head2 $self->create_action(%args)
Called with a hash of data to be use for construction of a new
Catalyst::Action (or appropriate sub/alternative class) object.
-Primarily designed for the use of register_actions.
-
=head2 $self->_application
=head2 $self->_app
Returns the application instance stored by C
-=head1 AUTHOR
+=head1 AUTHORS
-Sebastian Riedel, C
-Marcus Ramberg C
+Catalyst Contributors, see Catalyst.pm
=head1 COPYRIGHT
-This program is free software, you can redistribute it and/or modify
+This library is free software. You can redistribute it and/or modify
it under the same terms as Perl itself.
=cut