use Tree::Simple qw/use_weak_refs/;
use Tree::Simple::Visitor::FindByUID;
use Class::C3::Adopt::NEXT;
+use List::Util qw/first/;
use List::MoreUtils qw/uniq/;
use attributes;
use utf8;
#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($_)
+__PACKAGE__->mk_classdata($_) # XXX FIXME - components remove from here
for qw/container components 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::Controller'); # 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);
sub controller {
my ( $c, $name, @args ) = @_;
- my $container = $c->container->get_sub_container('controller');
- if( $name ) {
- # Direct component hash lookup to avoid costly regexps
- return $container->get_component( $name, $c, @args )
- if $container->has_service($name) && !ref $name;
+# FIXME: should this be a Catalyst::Utils method?
+ if (!$name) {
+ my $class = $c->action->class;
- return $container->get_component_regexp( $name, $c, @args );
+ my $prefix = length Catalyst::Utils::class2classprefix($class);
+
+ # MyApp::Controller::Foo becomes Foo
+ # the + 2 is because of the ::
+ $name = substr $class, $prefix + 2;
}
- 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');
- if( $name ) {
- # Direct component hash lookup to avoid costly regexps
- return $container->get_component( $name, $c, @args )
- if $container->has_service($name) && !ref $name;
-
- return $container->get_component_regexp( $name, $c, @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};
-
-# FIXME: will this still be mantained?
- my( $comp, $rest ) = $container->get_service_list;
+ if $c->stash->{current_model_instance};
- 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, $c, @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');
-
- if( $name ) {
- # Direct component hash lookup to avoid costly regexps
- return $container->get_component( $name, $c, @args )
- if !ref $name && $container->has_service($name);
-
- $c->log->warn( "Attempted to use view '$name', but does not exist" );
-
- return $container->get_component_regexp( $name, $c, @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, $c, @args );
+ return $c->container->get_component_from_sub_container( 'view', $name, $c, @args);
}
=head2 $c->controllers
sub component {
my ( $c, $component, @args ) = @_;
- if ( $component ) {
- # FIXME: I probably shouldn't be doing this
- return $c->components->{$component}
- if exists $c->components->{$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;
+ }
- my ($type, $name) = _get_component_type_name($component);
+ my ($type, $name) = _get_component_type_name($component);
- if ($type && $c->container->has_sub_container($type)) {
- my $container = $c->container->get_sub_container($type);
+ return $c->container->get_component_from_sub_container(
+ $type, $name, $c, @args
+ ) if $type;
- if( !ref $component && $container->has_service($name) ) {
- return $container->get_component( $name, $c, @args );
- }
+ my @result = $c->container->find_component( $component, $c, @args );
- return $container->get_component_regexp( $name, $c, @args );
- }
+ # list context for regexp searches
+ return @result if ref $component;
- if (ref $component) {
- 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{$component} } @components;
+ # only one component (if it's found) for string searches
+ return shift @result if @result;
- return map { $subcontainer->get_component( $_, $c, @args ) } @result;
- }
- }
+ # FIXME: I probably shouldn't be doing this
+ # I'm keeping it temporarily for things like $c->comp('MyApp')
+ return $c->components->{$component}
+ if exists $c->components->{$component} and !@args;
- $c->log->warn("Looking for '$component', but nothing was found.");
+ $c->log->warn("Looking for '$component', but nothing was found.");
- # I would expect to return an empty list here, but that breaks back-compat
- }
+ # 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.');
- # fallback
- return sort keys %{ $c->components };
+ return $c->component_list;
}
+=head2 $c->component_list
+
+Returns the sorted list of the component names of the application.
+
+=cut
+
+sub component_list { sort keys %{ shift->components } }
+
=head2 CLASS DATA AND HELPER CLASSES
=head2 $c->config
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 );
}
# Initialize our data structure
- $class->components( {} );
+ $class->components( {} ); # XXX - Remove!
$class->setup_components;
- if ( $class->debug ) {
+ if ( $class->debug ) { # XXX - Fixme to be a method on the container? (Or at least get a) data structure back from the container!!
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 } ) {
=cut
+# FIXME - We deal with ->components({'Foo' => 'Bar'})
+# however we DO NOT deal with ->components->{Foo} = 'Bar'
+# We should return a locked hash back to the user? So that if they try the latter, they
+# get breakage, rather than their addition being silently ignored?
around components => sub {
my $orig = shift;
my $class = shift;
my ($type, $name) = _get_component_type_name($component);
-# FIXME: shouldn't the service name be $name?
$containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
}
my $class = shift;
my $config = $class->config->{ setup_components };
+ my $search_extra = $config->{ search_extra };
my @comps = $class->locate_components($config);
my %comps = map { $_ => 1 } @comps;
for my $component (@comps) {
my $instance = $class->components->{ $component } = $class->setup_component($component);
- if ( my ($type, $name) = _get_component_type_name($component) ) {
+ if ( my ($type, $name) = _get_component_type_name($component, $search_extra) ) {
$containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
}
my @expanded_components = $instance->can('expand_modules')
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)) {
+ if (my ($type, $name) = _get_component_type_name($component, $search_extra)) {
$containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
}
+ # FIXME - Remove this!!
$class->components->{ $component } = $class->setup_component($component);
}
}
+
+ $containers->{model}->make_single_default;
+ $containers->{view}->make_single_default;
}
+# FIXME: should this sub exist?
+# should it be moved to Catalyst::Utils,
+# or replaced by something already existing there?
sub _get_component_type_name {
- my $component = shift;
- my @parts = split /::/, $component;
+ my ( $component, $search_extra) = @_;
+ $search_extra ||= [];
+ my @search_extra = map { s/^:://; lc $_ } @$search_extra;
+
+ my @parts = split /::/, $component;
+
+ if (scalar @parts == 1) {
+ return (undef, $component);
+ }
while (my $type = shift @parts) {
return ('controller', join '::', @parts)
return ('view', join '::', @parts)
if $type =~ /^(v|view)$/i;
+
+ return (_get_component_type($component), join '::', @parts)
+ if @search_extra and ( grep { lc $type eq $_ } @search_extra );
}
}
+sub _get_component_type {
+ my ( $instance ) = @_;
+
+ return 'controller' if $instance->isa('Catalyst::Controller');
+ return 'model' if $instance->isa('Catalyst::Model');
+ return 'view' if $instance->isa('Catalyst::View');
+}
+
=head2 $c->locate_components( $setup_component_config )
This method is meant to provide a list of component modules that should be
=cut
+## FIXME - Why the hell do we try calling the ->COMPONENT method twice, this is madness!?!
sub setup_component {
my( $class, $component ) = @_;