lib/Catalyst/IOC/Container.pm

   1 package Catalyst::IOC::Container;
   2 use Bread::Board;
   3 use Moose;
   4 use Config::Any;
   5 use Data::Visitor::Callback;
   6 use Catalyst::Utils ();
   7 use Devel::InnerPackage ();
   8 use Hash::Util qw/lock_hash/;
   9 use MooseX::Types::LoadableClass qw/ LoadableClass /;
  10 use Moose::Util;
  11 use Catalyst::IOC::BlockInjection;
  12 use Catalyst::IOC::ConstructorInjection;
  13 use Module::Pluggable::Object ();
  14 use namespace::autoclean;
  15
  16 extends 'Bread::Board::Container';
  17
  18 has config_local_suffix => (
  19     is      => 'ro',
  20     isa     => 'Str',
  21     default => 'local',
  22 );
  23
  24 has driver => (
  25     is      => 'ro',
  26     isa     => 'HashRef',
  27     default => sub { +{} },
  28 );
  29
  30 has file => (
  31     is      => 'ro',
  32     isa     => 'Str',
  33     default => '',
  34 );
  35
  36 has substitutions => (
  37     is      => 'ro',
  38     isa     => 'HashRef',
  39     default => sub { +{} },
  40 );
  41
  42 has application_name => (
  43     is       => 'ro',
  44     isa      => 'Str',
  45     required => 1,
  46 );
  47
  48 has sub_container_class => (
  49     isa     => LoadableClass,
  50     is      => 'ro',
  51     coerce  => 1,
  52     default => 'Catalyst::IOC::SubContainer',
  53     handles => {
  54         new_sub_container => 'new',
  55     }
  56 );
  57
  58 sub BUILD {
  59     my ( $self, $params ) = @_;
  60
  61     $self->add_service(
  62         $self->${\"build_${_}_service"}
  63     ) for qw/
  64         substitutions
  65         file
  66         driver
  67         application_name
  68         prefix
  69         extensions
  70         path
  71         config
  72         raw_config
  73         global_files
  74         local_files
  75         global_config
  76         local_config
  77         class_config
  78         config_local_suffix
  79         config_path
  80         locate_components
  81     /;
  82
  83     my $config = $self->resolve( service => 'config' );
  84
  85     $self->add_sub_container(
  86         $self->build_component_subcontainer
  87     );
  88
  89     $self->add_sub_container(
  90         $self->build_controller_subcontainer
  91     );
  92
  93     $self->add_sub_container(
  94         $self->build_view_subcontainer(
  95             default_component => $config->{default_view},
  96         )
  97     );
  98
  99     $self->add_sub_container(
 100         $self->build_model_subcontainer(
 101             default_component => $config->{default_model},
 102         )
 103     );
 104 }
 105
 106 sub build_model_subcontainer {
 107     my $self = shift;
 108
 109     return $self->new_sub_container( @_,
 110         name => 'model',
 111     );
 112 }
 113
 114 sub build_view_subcontainer {
 115     my $self = shift;
 116
 117     return $self->new_sub_container( @_,
 118         name => 'view',
 119     );
 120 }
 121
 122 sub build_controller_subcontainer {
 123     my $self = shift;
 124
 125     return $self->new_sub_container(
 126         name => 'controller',
 127     );
 128 }
 129
 130 sub build_component_subcontainer {
 131     my $self = shift;
 132
 133     return Bread::Board::Container->new(
 134         name => 'component',
 135     );
 136 }
 137
 138 sub build_application_name_service {
 139     my $self = shift;
 140
 141     return Bread::Board::Literal->new( name => 'application_name', value => $self->application_name );
 142 }
 143
 144 sub build_driver_service {
 145     my $self = shift;
 146
 147     return Bread::Board::Literal->new( name => 'driver', value => $self->driver );
 148 }
 149
 150 sub build_file_service {
 151     my $self = shift;
 152
 153     return Bread::Board::Literal->new( name => 'file', value => $self->file );
 154 }
 155
 156 sub build_substitutions_service {
 157     my $self = shift;
 158
 159     return Bread::Board::Literal->new( name => 'substitutions', value => $self->substitutions );
 160 }
 161
 162 sub build_extensions_service {
 163     my $self = shift;
 164
 165     return Bread::Board::BlockInjection->new(
 166         lifecycle => 'Singleton',
 167         name => 'extensions',
 168         block => sub {
 169             return \@{Config::Any->extensions};
 170         },
 171     );
 172 }
 173
 174 sub build_prefix_service {
 175     my $self = shift;
 176
 177     return Bread::Board::BlockInjection->new(
 178         lifecycle => 'Singleton',
 179         name => 'prefix',
 180         block => sub {
 181             return Catalyst::Utils::appprefix( shift->param('application_name') );
 182         },
 183         dependencies => [ depends_on('application_name') ],
 184     );
 185 }
 186
 187 sub build_path_service {
 188     my $self = shift;
 189
 190     return Bread::Board::BlockInjection->new(
 191         lifecycle => 'Singleton',
 192         name => 'path',
 193         block => sub {
 194             my $s = shift;
 195
 196             return Catalyst::Utils::env_value( $s->param('application_name'), 'CONFIG' )
 197             || $s->param('file')
 198             || $s->param('application_name')->path_to( $s->param('prefix') );
 199         },
 200         dependencies => [ depends_on('file'), depends_on('application_name'), depends_on('prefix') ],
 201     );
 202 }
 203
 204 sub build_config_service {
 205     my $self = shift;
 206
 207     return Bread::Board::BlockInjection->new(
 208         lifecycle => 'Singleton',
 209         name => 'config',
 210         block => sub {
 211             my $s = shift;
 212
 213             my $v = Data::Visitor::Callback->new(
 214                 plain_value => sub {
 215                     return unless defined $_;
 216                     return $self->_config_substitutions( $s->param('application_name'), $s->param('substitutions'), $_ );
 217                 }
 218
 219             );
 220             $v->visit( $s->param('raw_config') );
 221         },
 222         dependencies => [ depends_on('application_name'), depends_on('raw_config'), depends_on('substitutions') ],
 223     );
 224 }
 225
 226 sub build_raw_config_service {
 227     my $self = shift;
 228
 229     return Bread::Board::BlockInjection->new(
 230         lifecycle => 'Singleton',
 231         name => 'raw_config',
 232         block => sub {
 233             my $s = shift;
 234
 235             my @global = @{$s->param('global_config')};
 236             my @locals = @{$s->param('local_config')};
 237
 238             my $config = $s->param('class_config');
 239
 240             for my $cfg (@global, @locals) {
 241                 for (keys %$cfg) {
 242                     $config = Catalyst::Utils::merge_hashes( $config, $cfg->{$_} );
 243                 }
 244             }
 245
 246             return $config;
 247         },
 248         dependencies => [ depends_on('global_config'), depends_on('local_config'), depends_on('class_config') ],
 249     );
 250 }
 251
 252 sub build_global_files_service {
 253     my $self = shift;
 254
 255     return Bread::Board::BlockInjection->new(
 256         lifecycle => 'Singleton',
 257         name => 'global_files',
 258         block => sub {
 259             my $s = shift;
 260
 261             my ( $path, $extension ) = @{$s->param('config_path')};
 262
 263             my @extensions = @{$s->param('extensions')};
 264
 265             my @files;
 266             if ( $extension ) {
 267                 die "Unable to handle files with the extension '${extension}'" unless grep { $_ eq $extension } @extensions;
 268                 push @files, $path;
 269             } else {
 270                 @files = map { "$path.$_" } @extensions;
 271             }
 272             return \@files;
 273         },
 274         dependencies => [ depends_on('extensions'), depends_on('config_path') ],
 275     );
 276 }
 277
 278 sub build_local_files_service {
 279     my $self = shift;
 280
 281     return Bread::Board::BlockInjection->new(
 282         lifecycle => 'Singleton',
 283         name => 'local_files',
 284         block => sub {
 285             my $s = shift;
 286
 287             my ( $path, $extension ) = @{$s->param('config_path')};
 288             my $suffix = $s->param('config_local_suffix');
 289
 290             my @extensions = @{$s->param('extensions')};
 291
 292             my @files;
 293             if ( $extension ) {
 294                 die "Unable to handle files with the extension '${extension}'" unless grep { $_ eq $extension } @extensions;
 295                 $path =~ s{\.$extension}{_$suffix.$extension};
 296                 push @files, $path;
 297             } else {
 298                 @files = map { "${path}_${suffix}.$_" } @extensions;
 299             }
 300             return \@files;
 301         },
 302         dependencies => [ depends_on('extensions'), depends_on('config_path'), depends_on('config_local_suffix') ],
 303     );
 304 }
 305
 306 sub build_class_config_service {
 307     my $self = shift;
 308
 309     return Bread::Board::BlockInjection->new(
 310         lifecycle => 'Singleton',
 311         name => 'class_config',
 312         block => sub {
 313             my $s   = shift;
 314             my $app = $s->param('application_name');
 315
 316             # Container might be called outside Catalyst context
 317             return {} unless Class::MOP::is_class_loaded($app);
 318
 319             # config might not have been defined
 320             return $app->config || {};
 321         },
 322         dependencies => [ depends_on('application_name') ],
 323     );
 324 }
 325
 326 sub build_global_config_service {
 327     my $self = shift;
 328
 329     return Bread::Board::BlockInjection->new(
 330         lifecycle => 'Singleton',
 331         name => 'global_config',
 332         block => sub {
 333             my $s = shift;
 334
 335             return Config::Any->load_files({
 336                 files       => $s->param('global_files'),
 337                 filter      => \&_fix_syntax,
 338                 use_ext     => 1,
 339                 driver_args => $s->param('driver'),
 340             });
 341         },
 342         dependencies => [ depends_on('global_files') ],
 343     );
 344 }
 345
 346 sub build_local_config_service {
 347     my $self = shift;
 348
 349     return Bread::Board::BlockInjection->new(
 350         lifecycle => 'Singleton',
 351         name => 'local_config',
 352         block => sub {
 353             my $s = shift;
 354
 355             return Config::Any->load_files({
 356                 files       => $s->param('local_files'),
 357                 filter      => \&_fix_syntax,
 358                 use_ext     => 1,
 359                 driver_args => $s->param('driver'),
 360             });
 361         },
 362         dependencies => [ depends_on('local_files') ],
 363     );
 364 }
 365
 366 sub build_config_path_service {
 367     my $self = shift;
 368
 369     return Bread::Board::BlockInjection->new(
 370         lifecycle => 'Singleton',
 371         name => 'config_path',
 372         block => sub {
 373             my $s = shift;
 374
 375             my $path = $s->param('path');
 376             my $prefix = $s->param('prefix');
 377
 378             my ( $extension ) = ( $path =~ m{\.(.{1,4})$} );
 379
 380             if ( -d $path ) {
 381                 $path =~ s{[\/\\]$}{};
 382                 $path .= "/$prefix";
 383             }
 384
 385             return [ $path, $extension ];
 386         },
 387         dependencies => [ depends_on('prefix'), depends_on('path') ],
 388     );
 389 }
 390
 391 sub build_config_local_suffix_service {
 392     my $self = shift;
 393
 394     return Bread::Board::BlockInjection->new(
 395         lifecycle => 'Singleton',
 396         name => 'config_local_suffix',
 397         block => sub {
 398             my $s = shift;
 399             my $suffix = Catalyst::Utils::env_value( $s->param('application_name'), 'CONFIG_LOCAL_SUFFIX' ) || $self->config_local_suffix;
 400
 401             return $suffix;
 402         },
 403         dependencies => [ depends_on('application_name') ],
 404     );
 405 }
 406
 407 sub build_locate_components_service {
 408     my $self = shift;
 409
 410     return Bread::Board::BlockInjection->new(
 411         lifecycle => 'Singleton',
 412         name      => 'locate_components',
 413         block     => sub {
 414             my $s      = shift;
 415             my $class  = $s->param('application_name');
 416             my $config = $s->param('config')->{ setup_components };
 417
 418             Catalyst::Exception->throw(
 419                 qq{You are using search_extra config option. That option is\n} .
 420                 qq{deprecated, please refer to the documentation for\n} .
 421                 qq{other ways of achieving the same results.\n}
 422             ) if delete $config->{ search_extra };
 423
 424             my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
 425
 426             my $locator = Module::Pluggable::Object->new(
 427                 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
 428                 %$config
 429             );
 430
 431             return [ $locator->plugins ];
 432         },
 433         dependencies => [ depends_on('application_name'), depends_on('config') ],
 434     );
 435 }
 436
 437 sub setup_components {
 438     my $self = shift;
 439     my $class = $self->resolve( service => 'application_name' );
 440     my @comps = @{ $self->resolve( service => 'locate_components' ) };
 441     my %comps = map { $_ => 1 } @comps;
 442     my $deprecatedcatalyst_component_names = 0;
 443
 444     for my $component ( @comps ) {
 445
 446         # We pass ignore_loaded here so that overlay files for (e.g.)
 447         # Model::DBI::Schema sub-classes are loaded - if it's in @comps
 448         # we know M::P::O found a file on disk so this is safe
 449
 450         Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
 451     }
 452
 453     for my $component (@comps) {
 454         $self->add_component( $component );
 455         # FIXME - $instance->expand_modules() is broken
 456         my @expanded_components = $self->expand_component_module( $component );
 457
 458         if (
 459             !$deprecatedcatalyst_component_names &&
 460             ($deprecatedcatalyst_component_names = $component =~ m/::[CMV]::/) ||
 461             ($deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components)
 462         ) {
 463             # FIXME - should I be calling warn here?
 464             # Maybe it's time to remove it, or become fatal
 465             $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
 466                 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
 467             );
 468         }
 469
 470         for my $component (@expanded_components) {
 471             $self->add_component( $component )
 472                 unless $comps{$component};
 473         }
 474     }
 475
 476     $self->get_sub_container('model')->make_single_default;
 477     $self->get_sub_container('view')->make_single_default;
 478 }
 479
 480 sub _fix_syntax {
 481     my $config     = shift;
 482     my @components = (
 483         map +{
 484             prefix => $_ eq 'Component' ? '' : $_ . '::',
 485             values => delete $config->{ lc $_ } || delete $config->{ $_ }
 486         },
 487         grep { ref $config->{ lc $_ } || ref $config->{ $_ } }
 488             qw( Component Model M View V Controller C Plugin )
 489     );
 490
 491     foreach my $comp ( @components ) {
 492         my $prefix = $comp->{ prefix };
 493         foreach my $element ( keys %{ $comp->{ values } } ) {
 494             $config->{ "$prefix$element" } = $comp->{ values }->{ $element };
 495         }
 496     }
 497 }
 498
 499 sub _config_substitutions {
 500     my ( $self, $name, $subs, $arg ) = @_;
 501
 502     $subs->{ HOME } ||= sub { shift->path_to( '' ); };
 503     $subs->{ ENV } ||=
 504         sub {
 505             my ( $c, $v ) = @_;
 506             if (! defined($ENV{$v})) {
 507                 Catalyst::Exception->throw( message =>
 508                     "Missing environment variable: $v" );
 509                 return "";
 510             } else {
 511                 return $ENV{ $v };
 512             }
 513         };
 514     $subs->{ path_to } ||= sub { shift->path_to( @_ ); };
 515     $subs->{ literal } ||= sub { return $_[ 1 ]; };
 516     my $subsre = join( '|', keys %$subs );
 517
 518     $arg =~ s{__($subsre)(?:\((.+?)\))?__}{ $subs->{ $1 }->( $name, $2 ? split( /,/, $2 ) : () ) }eg;
 519     return $arg;
 520 }
 521
 522 sub get_component_from_sub_container {
 523     my ( $self, $sub_container_name, $name, $c, @args ) = @_;
 524
 525     my $sub_container = $self->get_sub_container( $sub_container_name );
 526
 527     if (!$name) {
 528         my $default = $sub_container->default_component;
 529
 530         return $sub_container->get_component( $default, $c, @args )
 531             if $default && $sub_container->has_service( $default );
 532
 533         # FIXME - should I be calling $c->log->warn here?
 534         # this is never a controller, so this is safe
 535         $c->log->warn( "Calling \$c->$sub_container_name() is not supported unless you specify one of:" );
 536         $c->log->warn( "* \$c->config(default_$sub_container_name => 'the name of the default $sub_container_name to use')" );
 537         $c->log->warn( "* \$c->stash->{current_$sub_container_name} # the name of the view to use for this request" );
 538         $c->log->warn( "* \$c->stash->{current_${sub_container_name}_instance} # the instance of the $sub_container_name to use for this request" );
 539
 540         return;
 541     }
 542
 543     return $sub_container->get_component_regexp( $name, $c, @args )
 544         if ref $name;
 545
 546     return $sub_container->get_component( $name, $c, @args )
 547         if $sub_container->has_service( $name );
 548
 549     $c->log->warn(
 550         "Attempted to use $sub_container_name '$name', " .
 551         "but it does not exist"
 552     );
 553
 554     return;
 555 }
 556
 557 sub find_component {
 558     my ( $self, $component, @args ) = @_;
 559     my ( $type, $name ) = _get_component_type_name($component);
 560     my @result;
 561
 562     return $self->get_component_from_sub_container(
 563         $type, $name, @args
 564     ) if $type;
 565
 566     my $query = ref $component
 567               ? $component
 568               : qr{^$component$}
 569               ;
 570
 571     for my $subcontainer_name (qw/model view controller/) {
 572         my $subcontainer = $self->get_sub_container( $subcontainer_name );
 573         my @components   = $subcontainer->get_service_list;
 574         @result          = grep { m{$component} } @components;
 575
 576         return map { $subcontainer->get_component( $_, @args ) } @result
 577             if @result;
 578     }
 579
 580     # one last search for things like $c->comp(qr/::M::/)
 581     @result = $self->find_component_regexp(
 582         $component, @args
 583     ) if !@result and ref $component;
 584
 585     # it expects an empty list on failed searches
 586     return @result;
 587 }
 588
 589 sub find_component_regexp {
 590     my ( $self, $component, @args ) = @_;
 591     my @result;
 592
 593     my @components = grep { m{$component} } keys %{ $self->get_all_components };
 594
 595     for (@components) {
 596         my ($type, $name) = _get_component_type_name($_);
 597
 598         push @result, $self->get_component_from_sub_container(
 599             $type, $name, @args
 600         ) if $type;
 601     }
 602
 603     return @result;
 604 }
 605
 606 # FIXME - t0m, how do you feel about this name?
 607 # also, do you think I should draw it here, or just return the data structure?
 608 sub get_components_names_types {
 609     my ( $self ) = @_;
 610     my @comps_names_types;
 611
 612     for my $sub_container_name (qw/model view controller/) {
 613         my $sub_container = $self->get_sub_container($sub_container_name);
 614         for my $service ( $sub_container->get_service_list ) {
 615             my $comp     = $sub_container->resolve(service => $service);
 616             my $compname = ref $comp || $comp;
 617             my $type     = ref $comp ? 'instance' : 'class';
 618             push @comps_names_types, [ $compname, $type ];
 619         }
 620     }
 621
 622     return @comps_names_types;
 623 }
 624
 625 sub get_all_components {
 626     my $self = shift;
 627     my %components;
 628
 629     my $container = $self->get_sub_container('component');
 630
 631     for my $component ($container->get_service_list) {
 632         my $comp = $container->resolve(
 633             service => $component
 634         );
 635         my $comp_name = ref $comp || $comp;
 636         $components{$comp_name} = $comp;
 637     }
 638
 639     return lock_hash %components;
 640 }
 641
 642 sub add_component {
 643     my ( $self, $component ) = @_;
 644     my ( $type, $name ) = _get_component_type_name($component);
 645
 646     return unless $type;
 647
 648     my $component_service_name = "${type}_${name}";
 649
 650     $self->get_sub_container('component')->add_service(
 651         Catalyst::IOC::ConstructorInjection->new(
 652             name      => $component_service_name,
 653             class     => $component,
 654             lifecycle => 'Singleton',
 655             dependencies => [
 656                 depends_on( '/application_name' ),
 657                 depends_on( '/config' ),
 658             ],
 659         )
 660     );
 661
 662     $self->get_sub_container($type)->add_service(
 663         Catalyst::IOC::BlockInjection->new(
 664             name         => $name,
 665             dependencies => [
 666                 depends_on( "/component/$component_service_name" ),
 667             ],
 668             block => sub { return shift->param($component_service_name) },
 669         )
 670     );
 671 }
 672
 673 # FIXME: should this sub exist?
 674 # should it be moved to Catalyst::Utils,
 675 # or replaced by something already existing there?
 676 sub _get_component_type_name {
 677     my ( $component ) = @_;
 678
 679     my @parts = split /::/, $component;
 680
 681     while (my $type = shift @parts) {
 682         return ('controller', join '::', @parts)
 683             if $type =~ /^(c|controller)$/i;
 684
 685         return ('model', join '::', @parts)
 686             if $type =~ /^(m|model)$/i;
 687
 688         return ('view', join '::', @parts)
 689             if $type =~ /^(v|view)$/i;
 690     }
 691
 692     return (undef, $component);
 693 }
 694
 695 sub expand_component_module {
 696     my ( $class, $module ) = @_;
 697     return Devel::InnerPackage::list_packages( $module );
 698 }
 699
 700 1;
 701
 702 __END__
 703
 704 =pod
 705
 706 =head1 NAME
 707
 708 Catalyst::Container - IOC for Catalyst components
 709
 710 =head1 SYNOPSIS
 711
 712 =head1 DESCRIPTION
 713
 714 =head1 METHODS
 715
 716 =head1 Building Containers
 717
 718 =head2 build_model_subcontainer
 719
 720 Container that stores all models.
 721
 722 =head2 build_view_subcontainer
 723
 724 Container that stores all views.
 725
 726 =head2 build_controller_subcontainer
 727
 728 Container that stores all controllers.
 729
 730 =head1 Building Services
 731
 732 =head2 build_application_name_service
 733
 734 Name of the application (such as MyApp).
 735
 736 =head2 build_driver_service
 737
 738 Config options passed directly to the driver being used.
 739
 740 =head2 build_file_service
 741
 742 ?
 743
 744 =head2 build_substitutions_service
 745
 746 This method substitutes macros found with calls to a function. There are a
 747 number of default macros:
 748
 749 =over
 750
 751 =item * C<__HOME__> - replaced with C<$c-E<gt>path_to('')>
 752
 753 =item * C<__ENV(foo)__> - replaced with the value of C<$ENV{foo}>
 754
 755 =item * C<__path_to(foo/bar)__> - replaced with C<$c-E<gt>path_to('foo/bar')>
 756
 757 =item * C<__literal(__FOO__)__> - leaves __FOO__ alone (allows you to use
 758 C<__DATA__> as a config value, for example)
 759
 760 =back
 761
 762 The parameter list is split on comma (C<,>). You can override this method to
 763 do your own string munging, or you can define your own macros in
 764 C<MyApp-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ substitutions }>.
 765 Example:
 766
 767     MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = {
 768         baz => sub { my $c = shift; qux( @_ ); }
 769     }
 770
 771 The above will respond to C<__baz(x,y)__> in config strings.
 772
 773 =head2 build_extensions_service
 774
 775 Config::Any's available config file extensions (e.g. xml, json, pl, etc).
 776
 777 =head2 build_prefix_service
 778
 779 The prefix, based on the application name, that will be used to lookup the
 780 config files (which will be in the format $prefix.$extension). If the app is
 781 MyApp::Foo, the prefix will be myapp_foo.
 782
 783 =head2 build_path_service
 784
 785 The path to the config file (or environment variable, if defined).
 786
 787 =head2 build_config_service
 788
 789 The resulting configuration for the application, after it has successfully
 790 been loaded, and all substitutions have been made.
 791
 792 =head2 build_raw_config_service
 793
 794 The merge of local_config and global_config hashes, before substitutions.
 795
 796 =head2 build_global_files_service
 797
 798 Gets all files for config that don't have the local_suffix, such as myapp.conf.
 799
 800 =head2 build_local_files_service
 801
 802 Gets all files for config that have the local_suffix, such as myapp_local.conf.
 803
 804 =head2 build_global_config_service
 805
 806 Reads config from global_files.
 807
 808 =head2 build_local_config_service
 809
 810 Reads config from local_files.
 811
 812 =head2 build_class_config_service
 813
 814 Reads config set from the application's class attribute config,
 815 i.e. MyApp->config( name => 'MyApp', ... )
 816
 817 =head2 build_config_path_service
 818
 819 Splits the path to the config file, and returns on array ref containing
 820 the path to the config file minus the extension in the first position,
 821 and the extension in the second.
 822
 823 =head2 build_config_local_suffix_service
 824
 825 Determines the suffix of files used to override the main config. By default
 826 this value is C<local>, which will load C<myapp_local.conf>.  The suffix can
 827 be specified in the following order of preference:
 828
 829 =over
 830
 831 =item * C<$ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }>
 832
 833 =item * C<$ENV{ CATALYST_CONFIG_LOCAL_SUFFIX }>
 834
 835 =back
 836
 837 The first one of these values found replaces the default of C<local> in the
 838 name of the local config file to be loaded.
 839
 840 For example, if C< $ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }> is set to C<testing>,
 841 ConfigLoader will try and load C<myapp_testing.conf> instead of
 842 C<myapp_local.conf>.
 843
 844 =head2 build_locate_components_service
 845
 846 This method is meant to provide a list of component modules that should be
 847 setup for the application.  By default, it will use L<Module::Pluggable>.
 848
 849 Specify a C<setup_components> config option to pass additional options directly
 850 to L<Module::Pluggable>.
 851
 852 =head1 Other methods
 853
 854 =head2 get_component_from_sub_container($sub_container, $name, $c, @args)
 855
 856 Looks for components in a given subcontainer (such as controller, model or
 857 view), and returns the searched component. If $name is undef, it returns the
 858 default component (such as default_view, if $sub_container is 'view'). If
 859 $name is a regexp, it returns an array of matching components. Otherwise, it
 860 looks for the component with name $name.
 861
 862 =head2 get_components_names_types
 863
 864 Gets all components from all containers and returns them as an array of
 865 arrayrefs containing the component name and the component type (i.e., whether
 866 it's an instance or a class).
 867
 868 =head2 get_all_components
 869
 870 Fetches all the components, in each of the sub_containers model, view and
 871 controller, and returns a readonly hash. The keys are the class names, and
 872 the values are the blessed objects. This is what is returned by $c->components.
 873
 874 =head2 add_component
 875
 876 Adds a component to the appropriate subcontainer. The subcontainer is guessed
 877 by the component name given.
 878
 879 =head2 find_component
 880
 881 Searches for components in all containers. If $component is the full class
 882 name, the subcontainer is guessed, and it gets the searched component in there.
 883 Otherwise, it looks for a component with that name in all subcontainers. If
 884 $component is a regexp, it calls the method below, find_component_regexp,
 885 and matches all components against that regexp.
 886
 887 =head2 find_component_regexp
 888
 889 Finds components that match a given regexp. Used internally, by find_component.
 890
 891 =head2 expand_component_module
 892
 893 Components found by C<locate_components> will be passed to this method, which
 894 is expected to return a list of component (package) names to be set up.
 895
 896 =head2 setup_components
 897
 898 =head1 AUTHORS
 899
 900 Catalyst Contributors, see Catalyst.pm
 901
 902 =head1 COPYRIGHT
 903
 904 This library is free software. You can redistribute it and/or modify it under
 905 the same terms as Perl itself.
 906
 907 =cut