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=01e38f59755977f21790ee016d38de7561fe823c;hp=0fbca47f77be75e5ac919289b0b6efce3dd8a19a;hb=f4d7cf1e0b763ba80f83a4c48edf7173ad250a46;hpb=1b79e1994c40fc525b4a84c900a5c95ffd4a2f8a diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index 0fbca47..01e38f5 100644 --- a/lib/Catalyst/Component.pm +++ b/lib/Catalyst/Component.pm @@ -5,9 +5,12 @@ use Class::MOP; use Class::MOP::Object; use Catalyst::Utils; use Class::C3::Adopt::NEXT; +use Devel::InnerPackage (); use MRO::Compat; use mro 'c3'; use Scalar::Util 'blessed'; +use Class::Load 'is_class_loaded'; +use Moose::Util 'find_meta'; use namespace::clean -except => 'meta'; with 'MooseX::Emulate::Class::Accessor::Fast'; @@ -27,14 +30,18 @@ Catalyst::Component - Catalyst Component Base Class __PACKAGE__->config( foo => 'bar' ); + has foo => ( + is => 'ro', + ); + sub test { my $self = shift; - return $self->{foo}; + return $self->foo; } sub forward_to_me { my ( $self, $c ) = @_; - $c->response->output( $self->{foo} ); + $c->response->output( $self->foo ); } 1; @@ -45,22 +52,39 @@ Catalyst::Component - Catalyst Component Base Class # Or just methods print $c->comp('MyApp::Model::Something')->test; - print $c->comp('MyApp::Model::Something')->{foo}; + print $c->comp('MyApp::Model::Something')->foo; =head1 DESCRIPTION This is the universal base class for Catalyst components (Model/View/Controller). -It provides you with a generic new() for instantiation through Catalyst's +It provides you with a generic new() for component construction through Catalyst's component loader with config() support and a process() method placeholder. +B that calling C<< $self->config >> inside a component is strongly +not recommended - the correctly merged config should have already been +passed to the constructor and stored in attributes - accessing +the config accessor directly from an instance is likely to get the +wrong values (as it only holds the class wide config, not things loaded +from the config file!) + =cut __PACKAGE__->mk_classdata('_plugins'); __PACKAGE__->mk_classdata('_config'); -has _component_name => ( is => 'ro' ); +has catalyst_component_name => ( is => 'ro' ); # Cannot be required => 1 as context + # class @ISA component - HATE +# Make accessor callable as a class method, as we need to call setup_actions +# on the application class, which we don't have an instance of, ewwwww +# Also, naughty modules like Catalyst::View::JSON try to write to _everything_, +# so spit a warning, ignore that (and try to do the right thing anyway) here.. +around catalyst_component_name => sub { + my ($orig, $self) = (shift, shift); + Carp::cluck("Tried to write to the catalyst_component_name accessor - is your component broken or just mad? (Write ignored - using default value.)") if scalar @_; + blessed($self) ? $self->$orig() || blessed($self) : $self; +}; sub BUILDARGS { my $class = shift; @@ -71,11 +95,9 @@ sub BUILDARGS { } elsif (@_ == 2) { # is it ($app, $args) or foo => 'bar' ? if (blessed($_[0])) { $args = $_[1] if ref($_[1]) eq 'HASH'; - } elsif (Class::MOP::is_class_loaded($_[0]) && + } elsif (is_class_loaded($_[0]) && $_[0]->isa('Catalyst') && ref($_[1]) eq 'HASH') { $args = $_[1]; - } elsif ($_[0] == $_[1]) { - $args = $_[1]; } else { $args = +{ @_ }; } @@ -103,6 +125,8 @@ sub COMPONENT { sub config { my $self = shift; + # Uncomment once sane to do so + #Carp::cluck("config method called on instance") if ref $self; my $config = $self->_config || {}; if (@_) { my $newconfig = { %{@_ > 1 ? {@_} : $_[0]} }; @@ -115,8 +139,8 @@ sub config { # work in a subclass. # TODO maybe this should be a ClassData option? my $class = blessed($self) || $self; - my $meta = Class::MOP::get_metaclass_by_name($class); - unless ($meta->has_package_symbol('$_config')) { + my $meta = find_meta($class); + unless (${ $meta->get_or_add_package_symbol('$_config') }) { # Call merge_hashes to ensure we deep copy the parent # config onto the subclass $self->_config( Catalyst::Utils::merge_hashes($config, {}) ); @@ -137,6 +161,11 @@ sub process { . " did not override Catalyst::Component::process" ); } +sub expand_modules { + my ($class, $component) = @_; + return Devel::InnerPackage::list_packages( $component ); +} + __PACKAGE__->meta->make_immutable; 1; @@ -145,7 +174,7 @@ __END__ =head1 METHODS -=head2 new($c, $arguments) +=head2 new($app, $arguments) Called by COMPONENT to instantiate the component; should return an object to be stored in the application's component hash. @@ -154,24 +183,38 @@ to be stored in the application's component hash. C<< my $component_instance = $component->COMPONENT($app, $arguments); >> -If this method is present (as it is on all Catalyst::Component subclasses, +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, +as $app and any config entry on the application for this component (for example, in the case of MyApp::Controller::Foo this would be C<< MyApp->config('Controller::Foo' => \%conf >>). + The arguments are expected to be a hashref and are merged with the C<< __PACKAGE__->config >> hashref before calling C<< ->new >> to instantiate the component. -You can override it in your components to do custom instantiation, using +You can override it in your components to do custom construction, using something like this: sub COMPONENT { my ($class, $app, $args) = @_; - $args = $self->merge_config_hashes($self->config, $args); + $args = $class->merge_config_hashes($class->config, $args); return $class->new($app, $args); } +B Generally when L starts, it initializes all the components +and passes the hashref present in any configutation information to the +COMPONET method. For example + + MyApp->config( + 'Model::Foo' => { + bar => 'baz', + }); + +You would expect COMPONENT to be called like this ->COMPONENT( 'MyApp', +{ bar=>'baz'}); + +This would happen ONCE during setup. + =head2 $c->config =head2 $c->config($hashref) @@ -183,6 +226,12 @@ 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 its own config hash. +The component's config hash is merged with any config entry on the +application for this component and passed to C (as mentioned +above at L). The recommended practice to access the merged +config is to use a Moose attribute for each config entry on the +receiving component. + =head2 $c->process() This is the default method called on a Catalyst component in the dispatcher. @@ -194,6 +243,13 @@ when you forward to them. The default is an abstract method. Merges two hashes together recursively, giving right-hand precedence. Alias for the method in L. +=head2 $c->expand_modules( $setup_component_config ) + +Return a list of extra components that this component has created. By default, +it just looks for a list of inner packages of this component + +=cut + =head1 OPTIONAL METHODS =head2 ACCEPT_CONTEXT($c, @args) @@ -208,6 +264,39 @@ 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. +B All classes that are Ls will have a COMPONENT +method, but classes that are intended to be factories or generators will +have ACCEPT_CONTEXT. If you have initialization arguments (such as from +configuration) that you wish to expose to the ACCEPT_CONTEXT you should +proxy them in the factory instance. For example: + + MyApp::Model::FooFactory; + + use Moose; + extends 'Catalyst::Model'; + + has type => (is=>'ro', required=>1); + + sub ACCEPT_CONTEXT { + my ($self, $c, @args) = @_; + return bless { args=>\@args }, $self->type; + } + + MyApp::Model::Foo->meta->make_immutable; + MyApp::Model::Foo->config( type => 'Type1' ); + +And in a controller: + + my $type = $c->model('FooFactory', 1,2,3,4): # $type->isa('Type1') + +B If you define a ACCEPT_CONTEXT method it MUST check to see if the +second argument is blessed (is a context) or not (is an application class name) and +it MUST return something valid for the case when the scope is application. This is +required because a component maybe be called from the application scope even if it +requires a context and you must prevent errors from being issued if this happens. +Remeber not all components that ACCEPT_CONTEXT actually need or use context information +(and there is a school of thought that suggestions doing so is a design error anyway...) + =head1 SEE ALSO L, L, L, L.