X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FIOC%2FContainer.pm;h=31dd7d6224cde6447a1ad93a82825a11d0247218;hb=efb195a58de076418b16547f3c2e35ee90812e8d;hp=ebffb92cb2832de2e27d9d99d4a8860ad9b26ff4;hpb=4156b7272fd4b82422e6b647eb810bd142e32e30;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/IOC/Container.pm b/lib/Catalyst/IOC/Container.pm index ebffb92..31dd7d6 100644 --- a/lib/Catalyst/IOC/Container.pm +++ b/lib/Catalyst/IOC/Container.pm @@ -1,13 +1,16 @@ package Catalyst::IOC::Container; -use Bread::Board; +use Bread::Board qw/depends_on/; use Moose; use Config::Any; use Data::Visitor::Callback; use Catalyst::Utils (); +use List::Util qw(first); use Devel::InnerPackage (); use Hash::Util qw/lock_hash/; use MooseX::Types::LoadableClass qw/ LoadableClass /; use Moose::Util; +use Scalar::Util qw/refaddr/; +use Catalyst::IOC::BlockInjection; use Catalyst::IOC::ConstructorInjection; use Module::Pluggable::Object (); use namespace::autoclean; @@ -38,12 +41,6 @@ has substitutions => ( default => sub { +{} }, ); -has application_name => ( - is => 'ro', - isa => 'Str', - default => 'MyApp', -); - has sub_container_class => ( isa => LoadableClass, is => 'ro', @@ -73,31 +70,47 @@ sub BUILD { local_files global_config local_config + class_config config_local_suffix config_path locate_components /; + my $config = $self->resolve( service => 'config' ); + + # don't force default_component to be undef if the config wasn't set + my @default_view = $config->{default_view} + ? ( default_component => $config->{default_view} ) + : ( ) + ; + my @default_model = $config->{default_model} + ? ( default_component => $config->{default_model} ) + : ( ) + ; + $self->add_sub_container( - $self->build_controller_subcontainer + $self->build_component_subcontainer ); - # FIXME - the config should be merged at this point - my $config = $self->resolve( service => 'config' ); - my $default_view = $params->{default_view} || $config->{default_view}; - my $default_model = $params->{default_model} || $config->{default_model}; + $self->add_sub_container( + $self->build_controller_subcontainer + ); $self->add_sub_container( - $self->build_view_subcontainer( - default_component => $default_view, - ) + $self->build_view_subcontainer( @default_view ) ); $self->add_sub_container( - $self->build_model_subcontainer( - default_component => $default_model, - ) + $self->build_model_subcontainer( @default_model ) ); + + { + no strict 'refs'; + no warnings 'once'; + my $class = ref $self; + ${ $class . '::customise_container' }->($self) + if ${ $class . '::customise_container' }; + } } sub build_model_subcontainer { @@ -124,10 +137,56 @@ sub build_controller_subcontainer { ); } +sub build_component_subcontainer { + my $self = shift; + + return Bread::Board::Container->new( + name => 'component', + ); +} + +sub build_home_service { + my $self = shift; + + return Bread::Board::BlockInjection->new( + lifecycle => 'Singleton', + name => 'home', + block => sub { + my $self = shift; + my $class = $self->param('application_name'); + my $home; + + if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) { + $home = $env; + } + + $home ||= Catalyst::Utils::home($class); + return $home; + }, + dependencies => [ depends_on('application_name') ], + ); +} + +# FIXME: very ambiguous - maybe root_dir? +sub build_root_service { + my $self = shift; + + return Bread::Board::BlockInjection->new( + lifecycle => 'Singleton', + name => 'root', + block => sub { + my $self = shift; + + return Path::Class::Dir->new( $self->param('home') )->subdir('root'); + }, + dependencies => [ depends_on('home') ], + ); +} + sub build_application_name_service { my $self = shift; - return Bread::Board::Literal->new( name => 'application_name', value => $self->application_name ); + return Bread::Board::Literal->new( name => 'application_name', value => $self->name ); } sub build_driver_service { @@ -224,15 +283,17 @@ sub build_raw_config_service { my @global = @{$s->param('global_config')}; my @locals = @{$s->param('local_config')}; - my $config = {}; + my $config = $s->param('class_config'); + for my $cfg (@global, @locals) { for (keys %$cfg) { $config = Catalyst::Utils::merge_hashes( $config, $cfg->{$_} ); } } + return $config; }, - dependencies => [ depends_on('global_config'), depends_on('local_config') ], + dependencies => [ depends_on('global_config'), depends_on('local_config'), depends_on('class_config') ], ); } @@ -290,6 +351,26 @@ sub build_local_files_service { ); } +sub build_class_config_service { + my $self = shift; + + return Bread::Board::BlockInjection->new( + lifecycle => 'Singleton', + name => 'class_config', + block => sub { + my $s = shift; + my $app = $s->param('application_name'); + + # Container might be called outside Catalyst context + return {} unless Class::MOP::is_class_loaded($app); + + # config might not have been defined + return $app->config || {}; + }, + dependencies => [ depends_on('application_name') ], + ); +} + sub build_global_config_service { my $self = shift; @@ -408,6 +489,21 @@ sub setup_components { my %comps = map { $_ => 1 } @comps; my $deprecatedcatalyst_component_names = 0; + my $app_locate_components_addr = refaddr( + $class->can('locate_components') + ); + my $cat_locate_components_addr = refaddr( + Catalyst->can('locate_components') + ); + + if ($app_locate_components_addr != $cat_locate_components_addr) { + # FIXME - why not just say: @comps = $class->locate_components() ? + $class->log->warn(qq{You have overridden locate_components. That } . + qq{no longer works. Please refer to the documentation to achieve } . + qq{similar results.\n} + ); + } + for my $component ( @comps ) { # We pass ignore_loaded here so that overlay files for (e.g.) @@ -418,7 +514,7 @@ sub setup_components { } for my $component (@comps) { - $self->add_component( $component, $class ); + $self->add_component( $component ); # FIXME - $instance->expand_modules() is broken my @expanded_components = $self->expand_component_module( $component ); @@ -428,19 +524,17 @@ sub setup_components { ($deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components) ) { # FIXME - should I be calling warn here? + # Maybe it's time to remove it, or become fatal $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}. qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n} ); } for my $component (@expanded_components) { - $self->add_component( $component, $class ) + $self->add_component( $component ) unless $comps{$component}; } } - - $self->get_sub_container('model')->make_single_default; - $self->get_sub_container('view')->make_single_default; } sub _fix_syntax { @@ -521,12 +615,12 @@ sub get_component_from_sub_container { } sub find_component { - my ( $self, $component, $c, @args ) = @_; + my ( $self, $component, @args ) = @_; my ( $type, $name ) = _get_component_type_name($component); my @result; return $self->get_component_from_sub_container( - $type, $name, $c, @args + $type, $name, @args ) if $type; my $query = ref $component @@ -539,70 +633,53 @@ sub find_component { my @components = $subcontainer->get_service_list; @result = grep { m{$component} } @components; - return map { $subcontainer->get_component( $_, $c, @args ) } @result + return map { $subcontainer->get_component( $_, @args ) } @result if @result; } - # FIXME - I guess I shouldn't be calling $c->components here # one last search for things like $c->comp(qr/::M::/) - @result = $self->find_component_regexp( - $c->components, $component, $c, @args + @result = $self->_find_component_regexp( + $component, @args ) if !@result and ref $component; # it expects an empty list on failed searches return @result; } -sub find_component_regexp { - my ( $self, $components, $component, @args ) = @_; +sub _find_component_regexp { + my ( $self, $component, $ctx, @args ) = @_; my @result; - my @components = grep { m{$component} } keys %{ $components }; + my @components = grep { m{$component} } keys %{ $self->get_all_components($ctx) }; for (@components) { my ($type, $name) = _get_component_type_name($_); push @result, $self->get_component_from_sub_container( - $type, $name, @args + $type, $name, $ctx, @args ) if $type; } return @result; } -# FIXME sorry for the name again :) -sub get_components_types { - my ( $self ) = @_; - my @comps_types; - - for my $sub_container_name (qw/model view controller/) { - my $sub_container = $self->get_sub_container($sub_container_name); - for my $service ( $sub_container->get_service_list ) { - my $comp = $self->resolve(service => $service); - my $compname = ref $comp || $comp; - my $type = ref $comp ? 'instance' : 'class'; - push @comps_types, [ $compname, $type ]; - } - } - - return @comps_types; -} - sub get_all_components { - my $self = shift; + my ($self, $class) = @_; my %components; - my $containers = { - map { $_ => $self->get_sub_container($_) } qw(model view controller) - }; + # FIXME - if we're getting from these containers, we need to either: + # - pass 'ctx' and 'accept_context_args' OR + # - make these params optional + # big problem when setting up the dispatcher - this method is called + # as $container->get_all_components('MyApp'). What to do with Request + # life cycles? + foreach my $type (qw/model view controller /) { + my $container = $self->get_sub_container($type); - for my $container (keys %$containers) { - for my $component ($containers->{$container}->get_service_list) { - my $comp = $containers->{$container}->resolve( - service => $component - ); - my $comp_name = ref $comp || $comp; - $components{$comp_name} = $comp; + for my $component ($container->get_service_list) { + my $comp_service = $container->get_service($component); + + $components{$comp_service->catalyst_component_name} = $comp_service->get(ctx => $class); } } @@ -610,30 +687,52 @@ sub get_all_components { } sub add_component { - my ( $self, $component, $class ) = @_; + my ( $self, $component ) = @_; my ( $type, $name ) = _get_component_type_name($component); return unless $type; - $self->get_sub_container($type)->add_service( + # The 'component' sub-container will create the object, and store it's + # instance, which, by default, will live throughout the application. + # The model/view/controller sub-containers only reference the instance + # held in the aforementioned sub-container, and execute the ACCEPT_CONTEXT + # sub every time they are called, when it exists. + my $instance_container = $self->get_sub_container('component'); + my $accept_context_container = $self->get_sub_container($type); + + # Custom containers might have added the service already + # We don't want to override that + return if $accept_context_container->has_service( $name ); + + my $component_service_name = "${type}_${name}"; + + $instance_container->add_service( Catalyst::IOC::ConstructorInjection->new( - name => $name, + name => $component_service_name, + catalyst_component_name => $component, class => $component, + lifecycle => 'Singleton', dependencies => [ depends_on( '/application_name' ), - depends_on( '/config' ), ], - parameters => { - suffix => { - isa => 'Str', - default => Catalyst::Utils::class2classsuffix( $component ), - }, - accept_context_args => { - isa => 'ArrayRef|Undef', - required => 0, - default => undef, - }, - }, + ), + ); + # XXX - FIXME - We have to explicitly build the service here, + # causing the COMPONENT method to be called early here, as otherwise + # if the component method defines other classes (e.g. the + # ACCEPT_CONTEXT injection Model::DBIC::Schema does) + # then they won't be found by Devel::InnerPackage + # see also t/aggregate/unit_core_component_loading.t + $instance_container->get_service($component_service_name)->get; + + $accept_context_container->add_service( + Catalyst::IOC::BlockInjection->new( + name => $name, + catalyst_component_name => $component, + dependencies => [ + depends_on( "/component/$component_service_name" ), + ], + block => sub { shift->param($component_service_name) }, ) ); } @@ -643,21 +742,16 @@ sub add_component { # or replaced by something already existing there? sub _get_component_type_name { my ( $component ) = @_; + my $result; - my @parts = split /::/, $component; - - while (my $type = shift @parts) { - return ('controller', join '::', @parts) - if $type =~ /^(c|controller)$/i; - - return ('model', join '::', @parts) - if $type =~ /^(m|model)$/i; - - return ('view', join '::', @parts) - if $type =~ /^(v|view)$/i; + while ( !$result and (my $index = index $component, '::') > 0 ) { + my $type = lc substr $component, 0, $index; + $component = substr $component, $index + 2; + $result = first { $type eq $_ or $type eq substr($_, 0, 1) } + qw{ model view controller }; } - return (undef, $component); + return ($result, $component); } sub expand_component_module { @@ -665,6 +759,8 @@ sub expand_component_module { return Devel::InnerPackage::list_packages( $module ); } +__PACKAGE__->meta->make_immutable; + 1; __END__ @@ -681,21 +777,30 @@ Catalyst::Container - IOC for Catalyst components =head1 METHODS -=head1 Containers +=head1 Methods for Building Containers + +=head2 build_component_subcontainer + +Container that stores all components, i.e. all models, views and controllers +together. Each service is an instance of the actual component, and by default +it lives while the application is running. Retrieving components from this +sub-container will instantiate the component, if it hasn't been instantiated +already, but will not execute ACCEPT_CONTEXT. =head2 build_model_subcontainer -Container that stores all models. +Container that stores references for all models that are inside the components +sub-container. Retrieving a model triggers ACCEPT_CONTEXT, if it exists. =head2 build_view_subcontainer -Container that stores all views. +Same as L, but for views. =head2 build_controller_subcontainer -Container that stores all controllers. +Same as L, but for controllers. -=head1 Services +=head1 Methods for Building Services =head2 build_application_name_service @@ -711,28 +816,85 @@ Config options passed directly to the driver being used. =head2 build_substitutions_service -Executes all the substitutions in config. See L method. +This method substitutes macros found with calls to a function. There are a +number of default macros: + +=over + +=item * C<__HOME__> - replaced with C<$c-Epath_to('')> + +=item * C<__ENV(foo)__> - replaced with the value of C<$ENV{foo}> + +=item * C<__path_to(foo/bar)__> - replaced with C<$c-Epath_to('foo/bar')> + +=item * C<__literal(__FOO__)__> - leaves __FOO__ alone (allows you to use +C<__DATA__> as a config value, for example) + +=back + +The parameter list is split on comma (C<,>). You can override this method to +do your own string munging, or you can define your own macros in +C<< config( 'Plugin::ConfigLoader' => { substitutions => { ... } } ) >>. +Example: + + MyApp->config( 'Plugin::ConfigLoader' => { + substitutions => { + baz => sub { my $c = shift; qux( @_ ); }, + }, + }); + +The above will respond to C<__baz(x,y)__> in config strings. =head2 build_extensions_service +Config::Any's available config file extensions (e.g. xml, json, pl, etc). + =head2 build_prefix_service +The prefix, based on the application name, that will be used to look-up the +config files (which will be in the format $prefix.$extension). If the app is +MyApp::Foo, the prefix will be myapp_foo. + =head2 build_path_service +The path to the config file (or environment variable, if defined). + =head2 build_config_service +The resulting configuration for the application, after it has successfully +been loaded, and all substitutions have been made. + =head2 build_raw_config_service +The merge of local_config and global_config hashes, before substitutions. + =head2 build_global_files_service +Gets all files for config that don't have the local_suffix, such as myapp.conf. + =head2 build_local_files_service +Gets all files for config that have the local_suffix, such as myapp_local.conf. + =head2 build_global_config_service +Reads config from global_files. + =head2 build_local_config_service +Reads config from local_files. + +=head2 build_class_config_service + +Reads config set from the application's class attribute config, +i.e. MyApp->config( name => 'MyApp', ... ) + =head2 build_config_path_service +Splits the path to the config file, and returns on array ref containing +the path to the config file minus the extension in the first position, +and the extension in the second. + =head2 build_config_local_suffix_service Determines the suffix of files used to override the main config. By default @@ -754,74 +916,53 @@ For example, if C< $ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }> is set to C, ConfigLoader will try and load C instead of C. -=head2 get_component_from_sub_container($sub_container, $name, $c, @args) - -Looks for components in a given subcontainer (such as controller, model or view), and returns the searched component. If $name is undef, it returns the default component (such as default_view, if $sub_container is 'view'). If $name is a regexp, it returns an array of matching components. Otherwise, it looks for the component with name $name. - -=head2 get_components_types - -=head2 get_all_components - -Fetches all the components, in each of the sub_containers model, view and controller, and returns a readonly hash. The keys are the class names, and the values are the blessed objects. This is what is returned by $c->components. - -=head2 add_component - -Adds a component to the appropriate subcontainer. The subcontainer is guessed by the component name given. - -=head2 find_component - -Searches for components in all containers. If $component is the full class name, the subcontainer is guessed, and it gets the searched component in there. Otherwise, it looks for a component with that name in all subcontainers. If $component is a regexp, it calls the method below, find_component_regexp, and matches all components against that regexp. - -=head2 find_component_regexp - -Finds components that match a given regexp. Used internally, by find_component. - -=head2 _fix_syntax +=head2 build_locate_components_service -=head2 _config_substitutions +This method is meant to provide a list of component modules that should be +setup for the application. By default, it will use L. -This method substitutes macros found with calls to a function. There are a -number of default macros: +Specify a C config option to pass additional options directly +to L. -=over +=head1 Other methods -=item * C<__HOME__> - replaced with C<$c-Epath_to('')> +=head2 get_component_from_sub_container($sub_container, $name, $c, @args) -=item * C<__ENV(foo)__> - replaced with the value of C<$ENV{foo}> +Looks for components in a given sub-container (such as controller, model or +view), and returns the searched component. If $name is undef, it returns the +default component (such as default_view, if $sub_container is 'view'). If +$name is a regexp, it returns an array of matching components. Otherwise, it +looks for the component with name $name. -=item * C<__path_to(foo/bar)__> - replaced with C<$c-Epath_to('foo/bar')> +=head2 get_all_components -=item * C<__literal(__FOO__)__> - leaves __FOO__ alone (allows you to use -C<__DATA__> as a config value, for example) +Fetches all the components, in each of the sub_containers model, view and +controller, and returns a read-only hash. The keys are the class names, and +the values are the blessed objects. This is what is returned by $c->components. -=back +=head2 add_component -The parameter list is split on comma (C<,>). You can override this method to -do your own string munging, or you can define your own macros in -Cconfig-E{ 'Plugin::ConfigLoader' }-E{ substitutions }>. -Example: +Adds a component to the appropriate sub-container. The sub-container is guessed +by the component name given. - MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = { - baz => sub { my $c = shift; qux( @_ ); } - } +=head2 find_component -The above will respond to C<__baz(x,y)__> in config strings. +Searches for components in all containers. If $component is the full class +name, the sub-container is guessed, and it gets the searched component in there. +Otherwise, it looks for a component with that name in all sub-containers. If +$component is a regexp it calls _find_component_regexp and matches all +components against that regexp. -=head2 $c->expand_component_module( $component, $setup_component_config ) +=head2 expand_component_module Components found by C will be passed to this method, which is expected to return a list of component (package) names to be set up. -=head2 build_locate_components_service - -This method is meant to provide a list of component modules that should be -setup for the application. By default, it will use L. - -Specify a C config option to pass additional options directly -to L. - =head2 setup_components +Uses locate_components service to list the components, and adds them to the +appropriate sub-containers, using add_component(). + =head1 AUTHORS Catalyst Contributors, see Catalyst.pm