#I imagine that very few of these really need to be class variables. if any.
#maybe we should just make them attributes with a default?
__PACKAGE__->mk_classdata($_)
- for qw/container components arguments dispatcher engine log dispatcher_class
+ for qw/container arguments dispatcher engine log dispatcher_class
engine_class context_class request_class response_class stats_class
setup_finished/;
return if $caller eq 'main';
my $meta = Moose::Meta::Class->initialize($caller);
- unless ( $caller->isa('Catalyst') ) {
- my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
- $meta->superclasses(@superclasses);
- }
+
+ unless ( $caller->isa('Catalyst') ) { # XXX - Remove!
+ my @superclasses = ($meta->superclasses, $class, 'Catalyst::Component'); # XXX - Remove!
+ $meta->superclasses(@superclasses); # XXX - Remove!
+ } # XXX - Remove!
+
# Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
$meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
$caller->setup_home;
}
+sub MODIFY_CODE_ATTRIBUTES {
+ Catalyst::Exception->throw(
+ "Catalyst applications (aka MyApp) cannot be controllers anymore. " .
+ "That has been deprecated and removed. You should create a " .
+ "controller class called Root.pm, and move relevant code to that class."
+ );
+}
+
+
sub _application { $_[0] }
=head1 NAME
sub controller {
my ( $c, $name, @args ) = @_;
- my $container = $c->container->get_sub_container('controller');
- unshift @args, $c;
- if( $name ) {
- # Direct component hash lookup to avoid costly regexps
- return $container->get_component($name, \@args)
- if $container->has_service($name) && !ref $name;
-
- return $container->get_component_regexp( $c, $name, \@args );
- }
+ $name ||= Catalyst::Utils::class2classshortsuffix( $c->action->class );
- return $c->component( $c->action->class );
+ return $c->container->get_component_from_sub_container( 'controller', $name, $c, @args);
}
=head2 $c->model($name)
sub model {
my ( $c, $name, @args ) = @_;
- my $appclass = ref($c) || $c;
- my $container = $c->container->get_sub_container('model');
- unshift @args, $c;
-
- if( $name ) {
- # Direct component hash lookup to avoid costly regexps
- return $container->get_component($name, \@args)
- if $container->has_service($name) && !ref $name;
- return $container->get_component_regexp( $c, $name, \@args );
- }
-
- if (ref $c) {
+ if (ref $c && !$name) {
return $c->stash->{current_model_instance}
- if $c->stash->{current_model_instance};
- return $c->model( $c->stash->{current_model} )
- if $c->stash->{current_model};
- }
- return $c->model( $appclass->config->{default_model} )
- if $appclass->config->{default_model};
+ if $c->stash->{current_model_instance};
-# FIXME: will this still be mantained?
- my( $comp, $rest ) = $container->get_service_list;
-
- if( $rest ) {
- $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
- $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
- $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
- $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
- $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
+ $name = $c->stash->{current_model}
+ if $c->stash->{current_model};
}
- return $container->get_component( $comp, \@args );
+ return $c->container->get_component_from_sub_container( 'model', $name, $c, @args);
}
sub view {
my ( $c, $name, @args ) = @_;
- my $appclass = ref($c) || $c;
- my $container = $c->container->get_sub_container('view');
- unshift @args, $c;
- if( $name ) {
- if ( !ref $name ) { # Direct component hash lookup to avoid costly regexps
- if ( $container->has_service($name) ) {
- return $container->get_component($name, \@args);
- }
- else {
- $c->log->warn( "Attempted to use view '$name', but does not exist" );
- }
- }
-
- return $container->get_component_regexp( $c, $name, \@args );
- }
-
- if (ref $c) {
+ if (ref $c && !$name) {
return $c->stash->{current_view_instance}
- if $c->stash->{current_view_instance};
- return $c->view( $c->stash->{current_view} )
- if $c->stash->{current_view};
- }
- return $c->view( $appclass->config->{default_view} )
- if $appclass->config->{default_view};
-
- my( $comp, $rest ) = $container->get_service_list;
+ if $c->stash->{current_view_instance};
- if( $rest ) {
- $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
- $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
- $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
- $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
- $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
+ $name = $c->stash->{current_view}
+ if $c->stash->{current_view};
}
- return $container->get_component( $comp, \@args );
+ return $c->container->get_component_from_sub_container( 'view', $name, $c, @args);
}
=head2 $c->controllers
If C<$name> is a regexp, a list of components matched against the full
component name will be returned.
-If Catalyst can't find a component by name, it will fallback to regex
-matching by default. To disable this behaviour set
-disable_component_resolution_regex_fallback to a true value.
-
- __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
-
=cut
sub component {
my ( $c, $component, @args ) = @_;
- unshift @args, $c;
- if ( $component ) {
- my ($type, $name) = _get_component_type_name($component);
+ unless ($component) {
+ $c->log->warn('Calling $c->component with no args is deprecated and ');
+ $c->log->warn('will be removed in a future release.');
+ $c->log->warn('Use $c->component_list instead.');
+ return $c->component_list;
+ }
- if ($type && $c->container->has_sub_container($type)) {
- my $container = $c->container->get_sub_container($type);
+ my @result = $c->container->find_component( $component, $c, @args );
- if( !ref $component && $container->has_service($name) ) {
- return $container->get_component( $name, \@args );
- }
+ # list context for regexp searches
+ return @result if ref $component;
- return $container->get_component_regexp( $c, $name, \@args );
- }
+ # only one component (if it's found) for string searches
+ return shift @result if @result;
- return
- if $c->config->{disable_component_resolution_regex_fallback} && !ref $component;
+ if (ref $c eq $component) {
+ $c->log->warn('You are calling $c->comp("MyApp"). This behaviour is');
+ $c->log->warn('deprecated, and will be removed in a future release.');
+ return $c;
+ }
- # This is here so $c->comp( '::M::' ) works
- my $query = ref $component ? $component : qr{$component}i;
+ $c->log->warn("Looking for '$component', but nothing was found.");
- for my $subcontainer_name (qw/model view controller/) {
- my $subcontainer = $c->container->get_sub_container($subcontainer_name);
- my @components = $subcontainer->get_service_list;
- my @result = grep { m{$query} } @components;
+ # I would expect to return an empty list here, but that breaks back-compat
+ $c->log->warn('Component not found, returning the list of existing');
+ $c->log->warn('components. This behavior is deprecated and will be');
+ $c->log->warn('removed in a future release. Use $c->component_list');
+ $c->log->warn('instead.');
- if (@result) {
- return map { $subcontainer->get_component( $_, \@args ) } @result
- if ref $component;
+ return $c->component_list;
+}
- $c->log->warn( Carp::shortmess(qq(Found results for "${component}" using regexp fallback)) );
- $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
- $c->log->warn( 'is unreliable and unsafe. You have been warned' );
+=head2 $c->component_list
- return $subcontainer->get_component( $result[0], \@args );
- }
- }
+Returns the sorted list of the component names of the application.
- # I would expect to return an empty list here, but that breaks back-compat
- }
+=cut
- # fallback
- return sort keys %{ $c->components };
-}
+sub component_list { sort keys %{ shift->components } }
=head2 CLASS DATA AND HELPER CLASSES
sub plugin {
my ( $class, $name, $plugin, @args ) = @_;
- # See block comment in t/unit_core_plugin.t
+ # See block comment in t/aggregate/unit_core_plugin.t
$class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
$class->_register_plugin( $plugin, 1 );
$class->setup unless $Catalyst::__AM_RESTARTING;
}
- # Initialize our data structure
- $class->components( {} );
-
$class->setup_components;
- if ( $class->debug ) {
+ if (
+ $class->debug and
+ my @comps_types = $class->container->get_components_types
+ ) {
my $column_width = Catalyst::Utils::term_width() - 8 - 9;
my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
- for my $comp ( sort keys %{ $class->components } ) {
- my $type = ref $class->components->{$comp} ? 'instance' : 'class';
- $t->row( $comp, $type );
- }
- $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
- if ( keys %{ $class->components } );
- }
+ $t->row( @$_ ) for @comps_types;
- # Add our self to components, since we are also a component
- if( $class->isa('Catalyst::Controller') ){
- $class->components->{$class} = $class;
+ $class->log->debug( "Loaded components:\n" . $t->draw . "\n" );
}
$class->setup_actions;
=cut
-around components => sub {
- my $orig = shift;
- my $class = shift;
- my $comps = shift;
-
- return $class->$orig if ( !$comps );
+sub components {
+ my ( $class, $comps ) = @_;
-# FIXME: should this ugly kludge exist?
+ # FIXME: should this ugly kludge exist?
$class->setup_config unless defined $class->container;
-# FIXME: should there be a warning here, not to use this accessor to create the components?
- my $components = {};
-
my $containers;
- $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
+ $containers->{$_} = $class->container->get_sub_container($_)
+ for qw(model view controller);
- for my $component ( keys %$comps ) {
- $components->{ $component } = $comps->{$component};
-
- my ($type, $name) = _get_component_type_name($component);
-
-# FIXME: shouldn't the service name be $name?
- $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
+ if ( $comps ) {
+ for my $component ( keys %$comps ) {
+ $class->container->add_component(
+ $component, $class->setup_component($component)
+ );
+ }
}
- return $class->$orig($components);
-};
+ return $class->container->get_all_components();
+}
=head2 $c->context_class
my %args = %{ $class->config || {} };
- my @container_classes = ( "${class}::Container", 'Catalyst::Container');
+ my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
unshift @container_classes, delete $args{container_class} if exists $args{container_class};
my $container_class = Class::MOP::load_first_existing_class(@container_classes);
$class->finalize_config; # back-compat
}
-=head $c->finalize_config
+=head2 $c->finalize_config
=cut
my $config = $class->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 = $class->locate_components($config);
my %comps = map { $_ => 1 } @comps;
Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
}
- my $containers;
- $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
-
for my $component (@comps) {
- my $instance = $class->components->{ $component } = $class->setup_component($component);
- if ( my ($type, $name) = _get_component_type_name($component) ) {
- $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $name, block => sub { return $instance } ));
- }
+ my $instance = $class->setup_component($component);
+ $class->container->add_component( $component, $instance );
my @expanded_components = $instance->can('expand_modules')
? $instance->expand_modules( $component, $config )
: $class->expand_component_module( $component, $config );
qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
) if $deprecatedcatalyst_component_names;
- if (my ($type, $name) = _get_component_type_name($component)) {
- $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
- }
-
- $class->components->{ $component } = $class->setup_component($component);
+ $class->container->add_component( $component, $class->setup_component($component) );
}
}
-}
-
-sub _get_component_type_name {
- my $component = shift;
- 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;
- }
+ $class->container->get_sub_container('model')->make_single_default;
+ $class->container->get_sub_container('view')->make_single_default;
}
+
=head2 $c->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>. To add additional search paths, specify a key named
-C<search_extra> as an array reference. Items in the array beginning with C<::>
-will have the application class name prepended to them.
+to L<Module::Pluggable>.
=cut
my $config = shift;
my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
- my $extra = delete $config->{ search_extra } || [];
-
- push @paths, @$extra;
my $locator = Module::Pluggable::Object->new(
search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
=cut
+## FIXME - Why the hell do we try calling the ->COMPONENT method twice, this is madness!?!
sub setup_component {
my( $class, $component ) = @_;
=item *
-C<disable_component_resolution_regex_fallback> - Turns
-off the deprecated component resolution functionality so
-that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
-are called then regex search will not be attempted on string values and
-instead C<undef> will be returned.
-
-=item *
-
C<home> - The application home directory. In an uninstalled application,
this is the top level application directory. In an installed application,
this will be the directory containing C<< MyApp.pm >>.
=item *
-C<search_extra> - Array reference passed to Module::Pluggable to for additional
-namespaces from which components will be loaded (and constructed and stored in
-C<< $c->components >>).
-
-=item *
-
C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
to be shown in hit debug tables in the test server.
Andrew Ruthven
+André Walker
+
andyg: Andy Grundman <andy@hybridized.org>
audreyt: Audrey Tang
projects / catagits/Catalyst-Runtime.git / blobdiff