X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FComponent.pm;h=aac0b64cb673ac7a1cd0028cbeeb2487bcd96392;hp=b38361e2daa9c4951070fa454a4ca0e1bde95cf2;hb=ac5c933bdd463558e8d621507a53a7b247a9093e;hpb=baf6a3dbf99be93d8e8bd9b986a95ad1d81a61ca diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index b38361e..aac0b64 100644 --- a/lib/Catalyst/Component.pm +++ b/lib/Catalyst/Component.pm @@ -1,10 +1,13 @@ package Catalyst::Component; -use strict; -use base qw/Class::Accessor::Fast Class::Data::Inheritable/; -use NEXT; +use Moose; +use MooseX::Adopt::Class::Accessor::Fast; +use Catalyst::Utils; + + +with 'MooseX::Emulate::Class::Accessor::Fast'; +with 'Catalyst::ClassData'; -__PACKAGE__->mk_classdata($_) for qw/_config _plugins/; =head1 NAME @@ -41,92 +44,84 @@ 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 { +__PACKAGE__->mk_classdata($_) for qw/_config _plugins/; + +around new => sub { + my $orig = shift; my ( $self, $c ) = @_; # 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 ) ); -} - -=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 + my $args = $self->merge_config_hashes( $self->config, $arguments ); + return $self->$orig( $args ); +}; 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; - } - } + $self->new($c, $arguments); + +# 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; +# } +# } } -# 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_sub = $self->can('_config'); + my $config = $self->$config_sub() || {}; 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. Calling the Class::Data::Inheritable setter + # will create a new _config method in the current class if it's + # currently inherited from the superclass. So, the can() call will + # return a different subref in that case and that means we know to + # copy and reset the value stored in the class data. + + $self->_config( $config ); + + if ((my $config_sub_now = $self->can('_config')) ne $config_sub) { + + $config = $self->merge_config_hashes( $config, {} ); + $self->$config_sub_now( $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,31 +129,48 @@ sub process { . " did not override Catalyst::Component::process" ); } -=head2 $c->merge_hash_config( $hashref, $hashref ) +1; -Merges two hashes together recursively, giving right-hand precedence. +__END__ -=cut +=head1 METHODS -sub merge_config_hashes { - my ( $self, $lefthash, $righthash ) = @_; +=head2 new($c, $arguments) - 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; -} +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 @@ -190,5 +202,3 @@ This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut - -1;