use Config::Any;
use Data::Visitor::Callback;
use Catalyst::Utils ();
+use Devel::InnerPackage ();
+use Hash::Util qw/lock_hash/;
use MooseX::Types::LoadableClass qw/ LoadableClass /;
+use Moose::Util;
use Catalyst::IOC::BlockInjection;
+use Catalyst::IOC::ConstructorInjection;
+use Module::Pluggable::Object ();
use namespace::autoclean;
extends 'Bread::Board::Container';
default => sub { +{} },
);
-has name => (
- is => 'ro',
- isa => 'Str',
- default => 'TestApp',
+has application_name => (
+ is => 'ro',
+ isa => 'Str',
+ required => 1,
);
has sub_container_class => (
substitutions
file
driver
- name
+ application_name
prefix
extensions
path
local_files
global_config
local_config
+ class_config
config_local_suffix
config_path
+ locate_components
/;
+ my $config = $self->resolve( service => 'config' );
+
$self->add_sub_container(
- $self->build_controller_subcontainer
+ $self->build_component_subcontainer
);
- 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,
+ default_component => $config->{default_view},
)
);
$self->add_sub_container(
$self->build_model_subcontainer(
- default_component => $default_model,
+ default_component => $config->{default_model},
)
);
}
);
}
-sub build_name_service {
+sub build_component_subcontainer {
+ my $self = shift;
+
+ return Bread::Board::Container->new(
+ name => 'component',
+ );
+}
+
+sub build_application_name_service {
my $self = shift;
- return Bread::Board::Literal->new( name => 'name', value => $self->name );
+ return Bread::Board::Literal->new( name => 'application_name', value => $self->application_name );
}
sub build_driver_service {
my $self = shift;
return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
name => 'extensions',
block => sub {
return \@{Config::Any->extensions};
my $self = shift;
return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
name => 'prefix',
block => sub {
- return Catalyst::Utils::appprefix( shift->param('name') );
+ return Catalyst::Utils::appprefix( shift->param('application_name') );
},
- dependencies => [ depends_on('name') ],
+ dependencies => [ depends_on('application_name') ],
);
}
my $self = shift;
return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
name => 'path',
block => sub {
my $s = shift;
- return Catalyst::Utils::env_value( $s->param('name'), 'CONFIG' )
+ return Catalyst::Utils::env_value( $s->param('application_name'), 'CONFIG' )
|| $s->param('file')
- || $s->param('name')->path_to( $s->param('prefix') );
+ || $s->param('application_name')->path_to( $s->param('prefix') );
},
- dependencies => [ depends_on('file'), depends_on('name'), depends_on('prefix') ],
+ dependencies => [ depends_on('file'), depends_on('application_name'), depends_on('prefix') ],
);
}
my $self = shift;
return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
name => 'config',
block => sub {
my $s = shift;
my $v = Data::Visitor::Callback->new(
plain_value => sub {
return unless defined $_;
- return $self->_config_substitutions( $s->param('name'), $s->param('substitutions'), $_ );
+ return $self->_config_substitutions( $s->param('application_name'), $s->param('substitutions'), $_ );
}
);
$v->visit( $s->param('raw_config') );
},
- dependencies => [ depends_on('name'), depends_on('raw_config'), depends_on('substitutions') ],
+ dependencies => [ depends_on('application_name'), depends_on('raw_config'), depends_on('substitutions') ],
);
}
my $self = shift;
return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
name => 'raw_config',
block => sub {
my $s = shift;
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') ],
);
}
my $self = shift;
return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
name => 'global_files',
block => sub {
my $s = shift;
my $self = shift;
return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
name => 'local_files',
block => sub {
my $s = shift;
);
}
+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;
return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
name => 'global_config',
block => sub {
my $s = shift;
my $self = shift;
return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
name => 'local_config',
block => sub {
my $s = shift;
my $self = shift;
return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
name => 'config_path',
block => sub {
my $s = shift;
my $self = shift;
return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
name => 'config_local_suffix',
block => sub {
my $s = shift;
- my $suffix = Catalyst::Utils::env_value( $s->param('name'), 'CONFIG_LOCAL_SUFFIX' ) || $self->config_local_suffix;
+ my $suffix = Catalyst::Utils::env_value( $s->param('application_name'), 'CONFIG_LOCAL_SUFFIX' ) || $self->config_local_suffix;
return $suffix;
},
- dependencies => [ depends_on('name') ],
+ dependencies => [ depends_on('application_name') ],
+ );
+}
+
+sub build_locate_components_service {
+ my $self = shift;
+
+ return Bread::Board::BlockInjection->new(
+ lifecycle => 'Singleton',
+ name => 'locate_components',
+ block => sub {
+ my $s = shift;
+ my $class = $s->param('application_name');
+ my $config = $s->param('config')->{ setup_components };
+
+ Catalyst::Exception->throw(
+ qq{You are using search_extra config option. That option is\n} .
+ qq{deprecated, please refer to the documentation for\n} .
+ qq{other ways of achieving the same results.\n}
+ ) if delete $config->{ search_extra };
+
+ my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
+
+ my $locator = Module::Pluggable::Object->new(
+ search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
+ %$config
+ );
+
+ return [ $locator->plugins ];
+ },
+ dependencies => [ depends_on('application_name'), depends_on('config') ],
);
}
+sub setup_components {
+ my $self = shift;
+ my $class = $self->resolve( service => 'application_name' );
+ my @comps = @{ $self->resolve( service => 'locate_components' ) };
+ my %comps = map { $_ => 1 } @comps;
+ my $deprecatedcatalyst_component_names = 0;
+
+ for my $component ( @comps ) {
+
+ # We pass ignore_loaded here so that overlay files for (e.g.)
+ # Model::DBI::Schema sub-classes are loaded - if it's in @comps
+ # we know M::P::O found a file on disk so this is safe
+
+ Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
+ }
+
+ for my $component (@comps) {
+ $self->add_component( $component );
+ # FIXME - $instance->expand_modules() is broken
+ my @expanded_components = $self->expand_component_module( $component );
+
+ if (
+ !$deprecatedcatalyst_component_names &&
+ ($deprecatedcatalyst_component_names = $component =~ m/::[CMV]::/) ||
+ ($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 )
+ unless $comps{$component};
+ }
+ }
+
+ $self->get_sub_container('model')->make_single_default;
+ $self->get_sub_container('view')->make_single_default;
+}
+
sub _fix_syntax {
my $config = shift;
my @components = (
return $sub_container->get_component( $default, $c, @args )
if $default && $sub_container->has_service( $default );
+ # FIXME - should I be calling $c->log->warn here?
# this is never a controller, so this is safe
$c->log->warn( "Calling \$c->$sub_container_name() is not supported unless you specify one of:" );
$c->log->warn( "* \$c->config(default_$sub_container_name => 'the name of the default $sub_container_name to use')" );
sub find_component {
my ( $self, $component, @args ) = @_;
+ my ( $type, $name ) = _get_component_type_name($component);
my @result;
+ return $self->get_component_from_sub_container(
+ $type, $name, @args
+ ) if $type;
+
my $query = ref $component
? $component
: qr{^$component$}
;
for my $subcontainer_name (qw/model view controller/) {
- my $subcontainer = $self->get_sub_container($subcontainer_name);
+ my $subcontainer = $self->get_sub_container( $subcontainer_name );
my @components = $subcontainer->get_service_list;
@result = grep { m{$component} } @components;
if @result;
}
+ # one last search for things like $c->comp(qr/::M::/)
+ @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 ) = @_;
+ my ( $self, $component, @args ) = @_;
my @result;
- my @components = grep { m{$component} } keys %{ $components };
+ my @components = grep { m{$component} } keys %{ $self->get_all_components };
for (@components) {
- # FIXME this is naughty enough being called inside Catalyst.pm
- # find some alternative for this sub and remember to delete here
- my ($type, $name) = Catalyst::_get_component_type_name($_);
+ my ($type, $name) = _get_component_type_name($_);
push @result, $self->get_component_from_sub_container(
$type, $name, @args
return @result;
}
-sub get_components_types {
+# FIXME - t0m, how do you feel about this name?
+# also, do you think I should draw it here, or just return the data structure?
+sub get_components_names_types {
my ( $self ) = @_;
- my @comps_types;
+ my @comps_names_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 $comp = $sub_container->resolve(service => $service);
my $compname = ref $comp || $comp;
my $type = ref $comp ? 'instance' : 'class';
- push @comps_types, [ $compname, $type ];
+ push @comps_names_types, [ $compname, $type ];
}
}
- return @comps_types;
+ return @comps_names_types;
+}
+
+sub get_all_components {
+ my $self = shift;
+ my %components;
+
+ my $container = $self->get_sub_container('component');
+
+ for my $component ($container->get_service_list) {
+ my $comp = $container->resolve(
+ service => $component
+ );
+ my $comp_name = ref $comp || $comp;
+ $components{$comp_name} = $comp;
+ }
+
+ return lock_hash %components;
+}
+
+sub add_component {
+ my ( $self, $component ) = @_;
+ my ( $type, $name ) = _get_component_type_name($component);
+
+ return unless $type;
+
+ my $component_service_name = "${type}_${name}";
+
+ # 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);
+
+ $instance_container->add_service(
+ Catalyst::IOC::ConstructorInjection->new(
+ name => $component_service_name,
+ class => $component,
+ lifecycle => 'Singleton',
+ dependencies => [
+ depends_on( '/application_name' ),
+ depends_on( '/config' ),
+ ],
+ )
+ ) unless $instance_container->has_service( $component_service_name );
+ # ^ custom containers might have added the service already.
+ # we don't want to override that.
+
+ $accept_context_container->add_service(
+ Catalyst::IOC::BlockInjection->new(
+ name => $name,
+ dependencies => [
+ depends_on( "/component/$component_service_name" ),
+ ],
+ block => sub { shift->param($component_service_name) },
+ )
+ ) unless $accept_context_container->has_service( $name );
+ # ^ same as above
+}
+
+# FIXME: should this sub exist?
+# should it be moved to Catalyst::Utils,
+# or replaced by something already existing there?
+sub _get_component_type_name {
+ my ( $component ) = @_;
+
+ 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;
+ }
+
+ return (undef, $component);
+}
+
+sub expand_component_module {
+ my ( $class, $module ) = @_;
+ return Devel::InnerPackage::list_packages( $module );
}
1;
Catalyst::Container - IOC for Catalyst components
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
=head1 METHODS
+=head1 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
+subcontainer will instantiate the component, if it hasn't been instantiated
+already, but will not execute ACCEPT_CONTEXT.
+
=head2 build_model_subcontainer
+Container that stores references for all models that are inside the components
+subcontainer. Retrieving a model triggers ACCEPT_CONTEXT, if it exists.
+
=head2 build_view_subcontainer
+Same as L<build_model_subcontainer>, but for views.
+
=head2 build_controller_subcontainer
-=head2 build_name_service
+Same as L<build_model_subcontainer>, but for controllers. The difference is
+that there is no ACCEPT_CONTEXT for controllers.
+
+=head1 Building Services
+
+=head2 build_application_name_service
+
+Name of the application (such as MyApp).
=head2 build_driver_service
+Config options passed directly to the driver being used.
+
=head2 build_file_service
+?
+
=head2 build_substitutions_service
+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-E<gt>path_to('')>
+
+=item * C<__ENV(foo)__> - replaced with the value of C<$ENV{foo}>
+
+=item * C<__path_to(foo/bar)__> - replaced with C<$c-E<gt>path_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<< <MyApp->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 lookup 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
-=head2 get_component_from_sub_container
+Determines the suffix of files used to override the main config. By default
+this value is C<local>, which will load C<myapp_local.conf>. The suffix can
+be specified in the following order of preference:
+
+=over
+
+=item * C<$ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }>
+
+=item * C<$ENV{ CATALYST_CONFIG_LOCAL_SUFFIX }>
+
+=back
+
+The first one of these values found replaces the default of C<local> in the
+name of the local config file to be loaded.
+
+For example, if C< $ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }> is set to C<testing>,
+ConfigLoader will try and load C<myapp_testing.conf> instead of
+C<myapp_local.conf>.
+
+=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<Module::Pluggable>.
+
+Specify a C<setup_components> config option to pass additional options directly
+to L<Module::Pluggable>.
+
+=head1 Other methods
+
+=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_names_types
+
+Gets all components from all containers and returns them as an array of
+arrayrefs containing the component name and the component type (i.e., whether
+it's an instance or a class).
+
+=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
-=head2 _fix_syntax
+Finds components that match a given regexp. Used internally, by find_component.
+
+=head2 expand_component_module
+
+Components found by C<locate_components> will be passed to this method, which
+is expected to return a list of component (package) names to be set up.
-=head2 _config_substitutions
+=head2 setup_components
=head1 AUTHORS
projects / catagits/Catalyst-Runtime.git / blobdiff