X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FComponent.pm;h=80fc8384b39d16427e07a656185387bbe19839de;hb=4ac0b9cb8e9043db8a95f44af685c782bf9426e7;hp=b38361e2daa9c4951070fa454a4ca0e1bde95cf2;hpb=baf6a3dbf99be93d8e8bd9b986a95ad1d81a61ca;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index b38361e..80fc838 100644 --- a/lib/Catalyst/Component.pm +++ b/lib/Catalyst/Component.pm @@ -1,10 +1,16 @@ 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'; + +with 'MooseX::Emulate::Class::Accessor::Fast'; +with 'Catalyst::ClassData'; -__PACKAGE__->mk_classdata($_) for qw/_config _plugins/; =head1 NAME @@ -41,92 +47,72 @@ Catalyst::Component - Catalyst Component Base Class =head1 DESCRIPTION -This is the universal base class for Catalyst components +This is the universal base class for Catalyst components (Model/View/Controller). It provides you with a generic new() for instantiation through Catalyst's component loader with config() support and a process() method placeholder. -=head1 METHODS - -=head2 new($c, $arguments) - -Called by COMPONENT to instantiate the component; should return an object -to be stored in the application's component hash. - =cut -sub new { - my ( $self, $c ) = @_; +__PACKAGE__->mk_classdata('_plugins'); +__PACKAGE__->mk_classdata('_config'); +sub BUILDARGS { + my ($self) = @_; + # Temporary fix, some components does not pass context to constructor my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {}; - return $self->NEXT::new( $self->merge_config_hashes( $self->config, $arguments ) ); + my $args = $self->merge_config_hashes( $self->config, $arguments ); + + return $args; } -=head2 COMPONENT($c, $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 -MyApp->config->{'Controller::Foo'}). The arguments are expected to be a hashref -and are merged with the __PACKAGE__->config hashref before calling ->new to -instantiate the component. - -=cut - sub COMPONENT { my ( $self, $c ) = @_; # Temporary fix, some components does not pass context to constructor my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {}; - - 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->merge_config_hashes( $self->config, $arguments ); - return bless $new, $class; - } + if( my $next = $self->next::can ){ + my $class = blessed $self || $self; + 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 linearised isa hierarchy is: " . join(', ', mro::get_linear_isa($class)) . "\n"; + warn "Please see perldoc Catalyst::Upgrading for more information about this issue.\n"; } + return $self->new($c, $arguments); } -# remember to leave blank lines between the consecutive =head2's -# otherwise the pod tools don't recognize the subsequent =head2s - -=head2 $c->config - -=head2 $c->config($hashref) - -=head2 $c->config($key, $value, ...) - -=cut - sub config { my $self = shift; - my $config = $self->_config; - unless ($config) { - $self->_config( $config = {} ); - } + 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. + my $class = blessed($self) || $self; + my $meta = Class::MOP::get_metaclass_by_name($class); + unless ($meta->has_package_symbol('$_config')) { + + $config = $self->merge_config_hashes( $config, {} ); + $self->_config( $config ); + } } return $config; } -=head2 $c->process() +sub merge_config_hashes { + my ( $self, $lefthash, $righthash ) = @_; -=cut + return Catalyst::Utils::merge_hashes( $lefthash, $righthash ); +} sub process { @@ -134,37 +120,57 @@ sub process { . " did not override Catalyst::Component::process" ); } -=head2 $c->merge_hash_config( $hashref, $hashref ) +no Moose; -Merges two hashes together recursively, giving right-hand precedence. +__PACKAGE__->meta->make_immutable; +1; -=cut +__END__ -sub merge_config_hashes { - my ( $self, $lefthash, $righthash ) = @_; +=head1 METHODS - my %merged = %$lefthash; - for my $key ( keys %$righthash ) { - my $right_ref = ( ref $righthash->{ $key } || '' ) eq 'HASH'; - my $left_ref = ( ( exists $lefthash->{ $key } && ref $lefthash->{ $key } ) || '' ) eq 'HASH'; - if( $right_ref and $left_ref ) { - $merged{ $key } = $self->merge_config_hashes( - $lefthash->{ $key }, $righthash->{ $key } - ); - } - else { - $merged{ $key } = $righthash->{ $key }; - } - } - - return \%merged; -} +=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($c, $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 +MyApp->config->{'Controller::Foo'}). The arguments are expected to be a +hashref and are merged with the __PACKAGE__->config hashref before calling +->new to instantiate the component. + +=head2 $c->config + +=head2 $c->config($hashref) + +=head2 $c->config($key, $value, ...) + +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 it's own config hash. + +=head2 $c->process() + +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. + +=head2 $c->merge_config_hashes( $hashref, $hashref ) + +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 initalized during server startup, either +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. @@ -178,11 +184,9 @@ calling code in the application rather than the component itself. 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 @@ -190,5 +194,3 @@ This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut - -1;