required container name, small other fixes
[catagits/Catalyst-Runtime.git] / lib / Catalyst / IOC / Container.pm
index c972123..6a1b489 100644 (file)
@@ -38,7 +38,7 @@ has substitutions => (
     default => sub { +{} },
 );
 
-has name => (
+has application_name => (
     is      => 'ro',
     isa     => 'Str',
     default => 'MyApp',
@@ -63,7 +63,7 @@ sub BUILD {
         substitutions
         file
         driver
-        name
+        application_name
         prefix
         extensions
         path
@@ -75,6 +75,7 @@ sub BUILD {
         local_config
         config_local_suffix
         config_path
+        locate_components
     /;
 
     $self->add_sub_container(
@@ -123,10 +124,10 @@ sub build_controller_subcontainer {
     );
 }
 
-sub build_name_service {
+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 {
@@ -166,9 +167,9 @@ sub build_prefix_service {
         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') ],
     );
 }
 
@@ -181,11 +182,11 @@ sub build_path_service {
         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') ],
     );
 }
 
@@ -201,13 +202,13 @@ sub build_config_service {
             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') ],
     );
 }
 
@@ -362,11 +363,44 @@ sub build_config_local_suffix_service {
         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
+            );
+
+            # XXX think about ditching this sort entirely
+            my @comps = sort { length $a <=> length $b } $locator->plugins;
+
+            return \@comps;
+        },
+        dependencies => [ depends_on('application_name'), depends_on('config') ],
     );
 }
 
@@ -619,42 +653,12 @@ 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 = @{ $self->resolve( service => 'locate_components' ) };
     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;
+    my $deprecatedcatalyst_component_names = 0;
 
     for my $component ( @comps ) {
 
@@ -669,18 +673,21 @@ sub setup_components {
         $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;
 
+        if (
+            !$deprecatedcatalyst_component_names &&
+            ($deprecatedcatalyst_component_names = $component =~ m/::[CMV]::/) ||
+            ($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 );
+        for my $component (@expanded_components) {
+            $self->add_component( $component, $class )
+                unless $comps{$component};
         }
     }
 
@@ -720,9 +727,9 @@ Container that stores all controllers.
 
 =head1 Services
 
-=head2 build_name_service
+=head2 build_application_name_service
 
-Name of the application.
+Name of the application (such as MyApp).
 
 =head2 build_driver_service
 
@@ -837,7 +844,7 @@ 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.
 
-=head2 locate_components( $setup_component_config )
+=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>.