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 Catalyst::IOC::BlockInjection;
use Catalyst::IOC::ConstructorInjection;
use Module::Pluggable::Object ();
use namespace::autoclean;
);
has application_name => (
- is => 'ro',
- isa => 'Str',
- default => 'MyApp',
+ is => 'ro',
+ isa => 'Str',
+ required => 1,
);
has sub_container_class => (
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 )
);
}
);
}
+sub build_component_subcontainer {
+ my $self = shift;
+
+ return Bread::Board::Container->new(
+ name => 'component',
+ );
+}
+
sub build_application_name_service {
my $self = 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') ],
);
}
);
}
+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;
sub setup_components {
my $self = shift;
+ warn("Setting up default components");
my $class = $self->resolve( service => 'application_name' );
my @comps = @{ $self->resolve( service => 'locate_components' ) };
my %comps = map { $_ => 1 } @comps;
unless $comps{$component};
}
}
-
- $self->get_sub_container('model')->make_single_default;
- $self->get_sub_container('view')->make_single_default;
}
sub _fix_syntax {
}
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
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, @args ) = @_;
my @result;
- my @components = grep { m{$component} } keys %{ $components };
+ my @components = grep { m{$component} } keys %{ $self->get_all_components };
for (@components) {
my ($type, $name) = _get_component_type_name($_);
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 %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
+ 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(
+ for my $component ($container->get_service_list) {
+ my $comp = $container->resolve(
service => $component
);
- my $comp_name = ref $comp || $comp;
+ my $comp_name = ref $comp || $comp; # THIS IS WRONG! :)
+ # Just as it is called Model::Foo
+ # does not mean it has to be
+ # an instance of model::foo
+ # (André's answer)
+ # t0m, you're absolutely right, I really hadn't thought about it.
+ # But then, we have a problem: suppose there is a component called
+ # MyApp::M::Foo, for instance. The service name would be 'Foo',
+ # and it would be stored in the 'model' sub container. So we have
+ # $app_name . '::' . uc_first($type) . '::' . $service_name
+ # that would return MyApp::Model::Foo. It would get really, really
+ # ugly to check MyApp::M::Foo. So, either we change the hash key,
+ # or we drop support for ::[CMV]::, or I don't know, maybe you
+ # have a better solution? :)
+
$components{$comp_name} = $comp;
}
}
return unless $type;
- $self->get_sub_container($type)->add_service(
+ 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 => $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,
- },
- },
)
- );
+ ) 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?
# 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 {
=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 all models.
+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
-Container that stores all views.
+Same as L<build_model_subcontainer>, but for views.
=head2 build_controller_subcontainer
-Container that stores all controllers.
+Same as L<build_model_subcontainer>, but for controllers.
=head1 Building Services
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-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ substitutions }>.
+C<< <MyApp->config( 'Plugin::ConfigLoader' => { substitutions => { ... } } ) >>.
Example:
- MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = {
- baz => sub { my $c = shift; qux( @_ ); }
- }
+ MyApp->config( 'Plugin::ConfigLoader' => {
+ substitutions => {
+ baz => sub { my $c = shift; qux( @_ ); },
+ },
+ });
The above will respond to C<__baz(x,y)__> in config strings.
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
=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
+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_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.
+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.
+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.
+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 _find_component_regexp and matches all
+components against that regexp.
=head2 expand_component_module