X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FComponent.pm;h=b0bb7b5a58021c9fd82ecaf7d7851306d5f1e527;hb=fa7a60aac97d8a9501a2cdca54f519752c12731a;hp=07202d3210230780204c1607750f35a89b4bb7d0;hpb=f8ad6ea56eeb4d3a3d5d77cf502651712dfb5e62;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index 07202d3..b0bb7b5 100644 --- a/lib/Catalyst/Component.pm +++ b/lib/Catalyst/Component.pm @@ -1,10 +1,18 @@ package Catalyst::Component; -use strict; -use base qw/Class::Accessor::Fast Class::Data::Inheritable/; -use NEXT; +use Moose; +use Class::MOP; +use Class::MOP::Object; +use Catalyst::Utils; +use Class::C3::Adopt::NEXT; +use MRO::Compat; +use mro 'c3'; +use Scalar::Util 'blessed'; +use namespace::clean -except => 'meta'; + +with 'MooseX::Emulate::Class::Accessor::Fast'; +with 'Catalyst::ClassData'; -__PACKAGE__->mk_classdata($_) for qw/_config _plugins/; =head1 NAME @@ -28,7 +36,7 @@ Catalyst::Component - Catalyst Component Base Class my ( $self, $c ) = @_; $c->response->output( $self->{foo} ); } - + 1; # Methods can be a request step @@ -47,62 +55,134 @@ This is the universal base class for Catalyst components It provides you with a generic new() for instantiation through Catalyst's component loader with config() support and a process() method placeholder. -=head1 ACCEPT_CONTEXT - -Catalyst components are normally initalized during server startup, either -as a Class or a Instance. However, some compoents require information about -the current request. To do so, they can implement an ACCEPT_CONTEXT method. +=cut -The ACCEPT_CONTEXT method is called on the component as initalized at startup, -with the current $c object, and should return itself. It can do whatever it -likes with $c, such as extracting a path to use in the component or something -similar. +__PACKAGE__->mk_classdata('_plugins'); +__PACKAGE__->mk_classdata('_config'); + +has catalyst_component_name => ( is => 'ro' ); # Cannot be required => 1 as context + # class @ISA component - HATE +# Make accessor callable as a class method, as we need to call setup_actions +# on the application class, which we don't have an instance of, ewwwww +# Also, naughty modules like Catalyst::View::JSON try to write to _everything_, +# so spit a warning, ignore that (and try to do the right thing anyway) here.. +around catalyst_component_name => sub { + my ($orig, $self) = (shift, shift); + Carp::cluck("Tried to write to the catalyst_component_name accessor - is your component broken or just mad? (Write ignored - using default value.)") if scalar @_; + blessed($self) ? $self->$orig() || blessed($self) : $self; +}; + +sub BUILDARGS { + my $class = shift; + my $args = {}; + + if (@_ == 1) { + $args = $_[0] if ref($_[0]) eq 'HASH'; + } elsif (@_ == 2) { # is it ($app, $args) or foo => 'bar' ? + if (blessed($_[0])) { + $args = $_[1] if ref($_[1]) eq 'HASH'; + } elsif (Class::MOP::is_class_loaded($_[0]) && + $_[0]->isa('Catalyst') && ref($_[1]) eq 'HASH') { + $args = $_[1]; + } elsif ($_[0] eq $_[1]) { + $args = $_[1]; + } else { + $args = +{ @_ }; + } + } elsif (@_ % 2 == 0) { + $args = +{ @_ }; + } -This call happens for every $c->comp/controller/model/view call. + return $class->merge_config_hashes( $class->config, $args ); +} +sub COMPONENT { + my ( $class, $c ) = @_; -=head1 METHODS + # Temporary fix, some components does not pass context to constructor + my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {}; + if ( my $next = $class->next::can ) { + my ($next_package) = Class::MOP::get_code_info($next); + warn "There is a COMPONENT method resolving after Catalyst::Component in ${next_package}.\n"; + warn "This behavior can no longer be supported, and so your application is probably broken.\n"; + warn "Your linearized isa hierarchy is: " . join(', ', @{ mro::get_linear_isa($class) }) . "\n"; + warn "Please see perldoc Catalyst::Upgrading for more information about this issue.\n"; + } + return $class->new($c, $arguments); +} -=head2 new($c) +sub config { + my $self = shift; + # Uncomment once sane to do so + #Carp::cluck("config method called on instance") if ref $self; + my $config = $self->_config || {}; + if (@_) { + my $newconfig = { %{@_ > 1 ? {@_} : $_[0]} }; + $self->_config( + $self->merge_config_hashes( $config, $newconfig ) + ); + } else { + # this is a bit of a kludge, required to make + # __PACKAGE__->config->{foo} = 'bar'; + # work in a subclass. + # TODO maybe this should be a ClassData option? + my $class = blessed($self) || $self; + my $meta = Class::MOP::get_metaclass_by_name($class); + unless ($meta->has_package_symbol('$_config')) { + # Call merge_hashes to ensure we deep copy the parent + # config onto the subclass + $self->_config( Catalyst::Utils::merge_hashes($config, {}) ); + } + } + return $self->_config; +} -=cut +sub merge_config_hashes { + my ( $self, $lefthash, $righthash ) = @_; -sub new { - my ( $self, $c ) = @_; + return Catalyst::Utils::merge_hashes( $lefthash, $righthash ); +} - # Temporary fix, some components does not pass context to constructor - my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {}; +sub process { - return $self->NEXT::new( { %{ $self->config }, %{$arguments} } ); + Catalyst::Exception->throw( message => ( ref $_[0] || $_[0] ) + . " did not override Catalyst::Component::process" ); } -=head2 COMPONENT($c) +__PACKAGE__->meta->make_immutable; -=cut +1; -sub COMPONENT { - my ( $self, $c ) = @_; +__END__ - # Temporary fix, some components does not pass context to constructor - my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {}; +=head1 METHODS - if ( my $new = $self->NEXT::COMPONENT( $c, $arguments ) ) { - return $new; - } - else { - if ( my $new = $self->new( $c, $arguments ) ) { - return $new; - } - else { - my $class = ref $self || $self; - my $new = { %{ $self->config }, %{$arguments} }; - return bless $new, $class; - } - } -} +=head2 new($c, $arguments) + +Called by COMPONENT to instantiate the component; should return an object +to be stored in the application's component hash. + +=head2 COMPONENT -# remember to leave blank lines between the consecutive =head2's -# otherwise the pod tools don't recognize the subsequent =head2s +C<< my $component_instance = $component->COMPONENT($app, $arguments); >> + +If this method is present (as it is on all Catalyst::Component subclasses, +it is called by Catalyst during setup_components with the application class +as $c and any config entry on the application for this component (for example, +in the case of MyApp::Controller::Foo this would be +C<< MyApp->config('Controller::Foo' => \%conf >>). +The arguments are expected to be a hashref and are merged with the +C<< __PACKAGE__->config >> hashref before calling C<< ->new >> +to instantiate the component. + +You can override it in your components to do custom instantiation, using +something like this: + + sub COMPONENT { + my ($class, $app, $args) = @_; + $args = $self->merge_config_hashes($self->config, $args); + return $class->new($app, $args); + } =head2 $c->config @@ -110,46 +190,47 @@ sub COMPONENT { =head2 $c->config($key, $value, ...) -=cut - -sub config { - my $self = shift; - my $config = $self->_config; - unless ($config) { - $self->_config( $config = {} ); - } - if (@_) { - $config = { %{$config}, %{@_ > 1 ? {@_} : $_[0]} }; - $self->_config($config); - } - return $config; -} +Accessor for this component's config hash. Config values can be set as +key value pair, or you can specify a hashref. In either case the keys +will be merged with any existing config settings. Each component in +a Catalyst application has its own config hash. =head2 $c->process() -=cut +This is the default method called on a Catalyst component in the dispatcher. +For instance, Views implement this action to render the response body +when you forward to them. The default is an abstract method. -sub process { +=head2 $c->merge_config_hashes( $hashref, $hashref ) - Catalyst::Exception->throw( message => ( ref $_[0] || $_[0] ) - . " did not override Catalyst::Component::process" ); -} +Merges two hashes together recursively, giving right-hand precedence. +Alias for the method in L. + +=head1 OPTIONAL METHODS + +=head2 ACCEPT_CONTEXT($c, @args) + +Catalyst components are normally initialized during server startup, either +as a Class or a Instance. However, some components require information about +the current request. To do so, they can implement an ACCEPT_CONTEXT method. + +If this method is present, it is called during $c->comp/controller/model/view +with the current $c and any additional args (e.g. $c->model('Foo', qw/bar baz/) +would cause your MyApp::Model::Foo instance's ACCEPT_CONTEXT to be called with +($c, 'bar', 'baz')) and the return value of this method is returned to the +calling code in the application rather than the component itself. =head1 SEE ALSO L, L, L, L. -=head1 AUTHOR +=head1 AUTHORS -Sebastian Riedel, C -Marcus Ramberg, C -Matt S Trout, C +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 - -1;