X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FComponent.pm;h=2950f4458af9b3a0b1ec7c9ebd7c0cf9501c5c9a;hb=46d0346ddafe8e167c679cddef9834946598e689;hp=feab1cf8a59684c2c71168c6e01620716cb5f6b6;hpb=22247e54ccd3fbdaf286e77304b96e61ecc43a0f;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index feab1cf..2950f44 100644 --- a/lib/Catalyst/Component.pm +++ b/lib/Catalyst/Component.pm @@ -1,10 +1,15 @@ package Catalyst::Component; -use strict; -use base qw/Class::Accessor::Fast Class::Data::Inheritable/; -use NEXT; +use Moose; +use Class::MOP; +use MooseX::Adopt::Class::Accessor::Fast; +use Catalyst::Utils; +use MRO::Compat; +use mro 'c3'; + +with 'MooseX::Emulate::Class::Accessor::Fast'; +with 'Catalyst::ClassData'; -__PACKAGE__->mk_classdata($_) for qw/_config/; =head1 NAME @@ -41,54 +46,112 @@ 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) - =cut -sub new { - my ( $self, $c ) = @_; +__PACKAGE__->mk_classdata('_plugins'); + +around new => sub { + my ( $orig, $self) = @_; # Temporary fix, some components does not pass context to constructor my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {}; - return $self->NEXT::new( { %{ $self->config }, %{$arguments} } ); -} + my $args = $self->merge_config_hashes( $self->config, $arguments ); + $self->$orig( $args ); +}; -=head2 COMPONENT($c) - -=cut +no Moose; 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; + 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}. This behavior is deprecated and will stop working in future releases."; + return $next->($self, $arguments); } - 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; + return $self->new($c, $arguments); +} + +sub config { + my $self = shift; + my $class = blessed $self || $self; + + my $config; + my $meta = $class->meta; + if( $meta->has_package_symbol('$config') ){ + $config = ${ $meta->get_package_symbol('$config') }; + } else { + foreach my $super ( $meta->linearized_isa ) { + my $super_meta = Moose::Meta::Class->initialize($super); + if( $super_meta->has_package_symbol('$config') ){ + $config = ${ $super_meta->get_package_symbol('$config') }; + unless( @_ ){ #don't copy and write it twice + $config = $class->merge_config_hashes( $config, {} ); + $meta->add_package_symbol('$config', \ $config); } + last; + } } + } + + unless( defined $config ){ + $config = {}; + $meta->add_package_symbol('$config', \ $config) unless @_; + } + + if (@_) { + my $from_args = { %{@_ > 1 ? {@_} : $_[0]} }; + my $new_config = $class->merge_config_hashes( $config, $from_args); + $meta->add_package_symbol('$config', \ $new_config); + } + + return $config; +} + +sub merge_config_hashes { + my ( $self, $lefthash, $righthash ) = @_; + + return Catalyst::Utils::merge_hashes( $lefthash, $righthash ); +} + +sub process { + + Catalyst::Exception->throw( message => ( ref $_[0] || $_[0] ) + . " did not override Catalyst::Component::process" ); } -# remember to leave blank lines between the consecutive =head2's -# otherwise the pod tools don't recognize the subsequent =head2s + +__PACKAGE__->meta->make_immutable; +1; + +__END__ + +=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. + +=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 @@ -96,29 +159,35 @@ sub COMPONENT { =head2 $c->config($key, $value, ...) -=cut - -sub config { - my $self = shift; - $self->_config( {} ) unless $self->_config; - if (@_) { - my $config = @_ > 1 ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$config ) { - $self->_config->{$key} = $val; - } - } - return $self->_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 it's 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 initalized 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 @@ -136,5 +205,3 @@ This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut - -1;