Singleton lifecycles

[catagits/Catalyst-Runtime.git] / lib / Catalyst / IOC / Container.pm

diff --git a/lib/Catalyst/IOC/Container.pm b/lib/Catalyst/IOC/Container.pm
index 94a2fec..c972123 100644 (file)
--- a/lib/Catalyst/IOC/Container.pm
+++ b/lib/Catalyst/IOC/Container.pm
@@ -9,6 +9,7 @@ use Hash::Util qw/lock_hash/;
 use MooseX::Types::LoadableClass qw/ LoadableClass /;
 use Moose::Util;
 use Catalyst::IOC::BlockInjection;
+use Module::Pluggable::Object ();
 use namespace::autoclean;
 
 extends 'Bread::Board::Container';
@@ -150,6 +151,7 @@ sub build_extensions_service {
     my $self = shift;
 
     return Bread::Board::BlockInjection->new(
+        lifecycle => 'Singleton',
         name => 'extensions',
         block => sub {
             return \@{Config::Any->extensions};
@@ -161,6 +163,7 @@ sub build_prefix_service {
     my $self = shift;
 
     return Bread::Board::BlockInjection->new(
+        lifecycle => 'Singleton',
         name => 'prefix',
         block => sub {
             return Catalyst::Utils::appprefix( shift->param('name') );
@@ -173,6 +176,7 @@ sub build_path_service {
     my $self = shift;
 
     return Bread::Board::BlockInjection->new(
+        lifecycle => 'Singleton',
         name => 'path',
         block => sub {
             my $s = shift;
@@ -189,6 +193,7 @@ sub build_config_service {
     my $self = shift;
 
     return Bread::Board::BlockInjection->new(
+        lifecycle => 'Singleton',
         name => 'config',
         block => sub {
             my $s = shift;
@@ -210,6 +215,7 @@ sub build_raw_config_service {
     my $self = shift;
 
     return Bread::Board::BlockInjection->new(
+        lifecycle => 'Singleton',
         name => 'raw_config',
         block => sub {
             my $s = shift;
@@ -233,6 +239,7 @@ sub build_global_files_service {
     my $self = shift;
 
     return Bread::Board::BlockInjection->new(
+        lifecycle => 'Singleton',
         name => 'global_files',
         block => sub {
             my $s = shift;
@@ -258,6 +265,7 @@ sub build_local_files_service {
     my $self = shift;
 
     return Bread::Board::BlockInjection->new(
+        lifecycle => 'Singleton',
         name => 'local_files',
         block => sub {
             my $s = shift;
@@ -285,6 +293,7 @@ sub build_global_config_service {
     my $self = shift;
 
     return Bread::Board::BlockInjection->new(
+        lifecycle => 'Singleton',
         name => 'global_config',
         block => sub {
             my $s = shift;
@@ -304,6 +313,7 @@ sub build_local_config_service {
     my $self = shift;
 
     return Bread::Board::BlockInjection->new(
+        lifecycle => 'Singleton',
         name => 'local_config',
         block => sub {
             my $s = shift;
@@ -323,6 +333,7 @@ sub build_config_path_service {
     my $self = shift;
 
     return Bread::Board::BlockInjection->new(
+        lifecycle => 'Singleton',
         name => 'config_path',
         block => sub {
             my $s = shift;
@@ -347,6 +358,7 @@ sub build_config_local_suffix_service {
     my $self = shift;
 
     return Bread::Board::BlockInjection->new(
+        lifecycle => 'Singleton',
         name => 'config_local_suffix',
         block => sub {
             my $s = shift;
@@ -532,8 +544,9 @@ sub add_component {
 
     $self->get_sub_container($type)->add_service(
         Catalyst::IOC::BlockInjection->new(
-            name  => $name,
-            block => sub { $self->setup_component( $component, $class ) },
+            lifecycle => 'Singleton', # FIXME?
+            name      => $name,
+            block     => sub { $self->setup_component( $component, $class ) },
         )
     );
 }
@@ -606,6 +619,75 @@ sub expand_component_module {
     return Devel::InnerPackage::list_packages( $module );
 }
 
+sub locate_components {
+    my ( $self, $class, $config ) = @_;
+
+    my @paths   = qw( ::Controller ::C ::Model ::M ::View ::V );
+
+    my $locator = Module::Pluggable::Object->new(
+        search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
+        %$config
+    );
+
+    # XXX think about ditching this sort entirely
+    my @comps = sort { length $a <=> length $b } $locator->plugins;
+
+    return @comps;
+}
+
+sub setup_components {
+    my ( $self, $class ) = @_;
+
+    # FIXME - should I get config as an argument, and throw the exception in
+    # Catalyst.pm?
+    my $config = $self->resolve(service => '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 @comps = $self->locate_components( $class, $config );
+    my %comps = map { $_ => 1 } @comps;
+
+    my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
+    $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}
+    ) if $deprecatedcatalyst_component_names;
+
+    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, $class );
+        # FIXME - $instance->expand_modules() is broken
+        my @expanded_components = $self->expand_component_module( $component );
+        for my $component (@expanded_components) {
+            next if $comps{$component};
+
+            # FIXME - Why is it inside the for loop? It makes no sense
+            $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
+
+            # FIXME - should I be calling warn here?
+            $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}
+            ) if $deprecatedcatalyst_component_names;
+
+            $self->add_component( $component, $class );
+        }
+    }
+
+    $self->get_sub_container('model')->make_single_default;
+    $self->get_sub_container('view')->make_single_default;
+}
+
 1;
 
 __END__
@@ -755,7 +837,13 @@ The above will respond to C<__baz(x,y)__> in config strings.
 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.
 
-=cut
+=head2 locate_components( $setup_component_config )
+
+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 AUTHORS