X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FComponent.pm;h=9cbe331978702023ff93d51ff7bcca244deb2478;hb=615bfadf17b568b98fe61ac76a19767c90f9f58a;hp=1b601feca0d596a35097f56d5e4799f7cec98c7a;hpb=c7a54b4e7f6f28245075dd165fdbf7269ffa9d59;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index 1b601fe..9cbe331 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 MooseX::ClassAttribute; +use Catalyst::Utils; + +has _config => ( + is => 'rw', + isa => 'HashRef', + required => 1, + default => sub { {} } + ); + +class_has _plugins => ( is => 'rw' ); -__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,24 +55,20 @@ 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 METHODS - -=head2 new($c) - =cut -sub new { +#to do: are we switching to moose-style key => value constructors from +# catalyst-style {key => value} constructors ? + +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->config }, %{$arguments} } ); -} - -=head2 COMPONENT($c) - -=cut + my $merged = $self->merge_config_hashes( $self->config, $arguments ); + $orig->( $self, $merged ); +}; sub COMPONENT { my ( $self, $c ) = @_; @@ -72,6 +76,8 @@ sub COMPONENT { # Temporary fix, some components does not pass context to constructor my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {}; + #Moose TODO: I don't think I fully grok NEXT. is this here for MI or something? + # how can we have a next here? this -is- the base class.... if ( my $new = $self->NEXT::COMPONENT( $c, $arguments ) ) { return $new; } @@ -81,39 +87,50 @@ sub COMPONENT { } else { my $class = ref $self || $self; - my $new = { %{ $self->config }, %{$arguments} }; + 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 - +#Moose TODO: I have no fucking clue what's going on here (groditi) 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(); + #my $config = $self->_config; if (@_) { - $config = { %{$config}, %{@_ > 1 ? {@_} : $_[0]} }; - $self->_config($config); + 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) { + + #this is retarded. if we want a new ref we could do: { %$config } + $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 { @@ -121,6 +138,63 @@ sub process { . " did not override Catalyst::Component::process" ); } +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 + +=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 +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. @@ -137,5 +211,3 @@ This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut - -1;