package Catalyst::Component;
-use strict;
-use base qw/Class::Data::Inheritable/;
-use NEXT;
+use Class::C3;
+use Moose;
+use MooseX::Adopt::Class::Accessor::Fast;
+use Catalyst::Utils;
-__PACKAGE__->mk_classdata($_) for qw/_config/;
+
+with 'MooseX::Emulate::Class::Accessor::Fast';
+with 'Catalyst::ClassData';
+
+no Moose;
=head1 NAME
# lib/MyApp/Model/Something.pm
package MyApp::Model::Something;
- use base 'Catalyst::Base';
+ use base 'Catalyst::Component';
__PACKAGE__->config( foo => 'bar' );
=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
-
-=over 4
-
-=item new($c)
-
=cut
+__PACKAGE__->mk_classdata($_) for qw/_config _plugins/;
+
sub new {
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} } );
+ my $args = $self->merge_config_hashes( $self->config, $arguments );
+ $self->next::method( $args );
}
-# remember to leave blank lines between the consecutive =item's
-# otherwise the pod tools don't recognize the subsequent =items
-
-=item $c->config
+sub COMPONENT {
+ my ( $self, $c ) = @_;
-=item $c->config($hashref)
+ # Temporary fix, some components does not pass context to constructor
+ my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {};
-=item $c->config($key, $value, ...)
-=cut
+ #this is not the EXACT logic we had before, since the original tested
+ #for a true value before returning meaning that a subsequent COMPONENT
+ #call could return undef and that would trigger a try to new, which could
+ #again return undef, which would lead to a straight bless of the args and
+ #config. I did not mantain that behavior because it did not seemed sane
+ # please rip me a new one if you have reason to believe i am being stupid
+ # --groditi
+ return $self->next::can ?
+ $self->next::method($c, $arguments) : $self->new($c, $arguments);
+}
sub config {
my $self = shift;
- $self->_config( {} ) unless $self->_config;
+ my $config_sub = $self->can('_config');
+ my $config = $self->$config_sub() || {};
if (@_) {
- my $config = @_ > 1 ? {@_} : $_[0];
- while ( my ( $key, $val ) = each %$config ) {
- $self->_config->{$key} = $val;
+ 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 $self->_config;
+ return $config;
}
-=item $c->process()
+sub merge_config_hashes {
+ my ( $self, $lefthash, $righthash ) = @_;
-=cut
+ return Catalyst::Utils::merge_hashes( $lefthash, $righthash );
+}
sub process {
. " did not override Catalyst::Component::process" );
}
-=back
+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<Catalyst::Utils>.
+
+=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<Catalyst>.
+L<Catalyst>, L<Catalyst::Model>, L<Catalyst::View>, L<Catalyst::Controller>.
=head1 AUTHOR
the same terms as Perl itself.
=cut
-
-1;
projects / catagits/Catalyst-Runtime.git / blobdiff