removed a little bit of repetition, and commented
[catagits/Catalyst-Runtime.git] / lib / Catalyst.pm
index 31f193f..37371ab 100644 (file)
@@ -27,6 +27,7 @@ use URI::https;
 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;
@@ -536,34 +537,6 @@ sub clear_errors {
     $c->error(0);
 }
 
-sub _find_component_regexp {
-    my ( $c, $container, $name, $args ) = @_;
-
-    return
-        if $c->config->{disable_component_resolution_regex_fallback} && !ref $name;
-
-    my $appclass = ref $c || $c;
-    my $prefix   = ucfirst $container->name;
-    my $p        = substr $prefix, 0, 1;
-
-    my $query = ref $name ? $name : qr{$name}i;
-    $query =~ s/^${appclass}::($p|$prefix):://i;
-
-    my @comps  = $container->get_service_list;
-    my @result = map {
-        $container->resolve( service => $_, parameters => { context => $args } )
-    } grep { m/$query/ } @comps;
-
-    if (!ref $name && $result[0]) {
-        $c->log->warn( Carp::shortmess(qq(Found results for "${name}" 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' );
-        return $result[0];
-    }
-
-    return @result;
-}
-
 =head2 COMPONENT ACCESSORS
 
 =head2 $c->controller($name)
@@ -585,17 +558,19 @@ If you want to search for controllers, pass in a regexp as the argument.
 
 sub controller {
     my ( $c, $name, @args ) = @_;
-    my $container = $c->container->get_sub_container('controller');
-    unshift @args, $c;
 
-    if( $name ) {
-        return $c->container->get_component('controller', $name, \@args)
-            if $container->has_service($name) && !ref $name;
+# FIXME: should this be a Catalyst::Utils method?
+    if (!$name) {
+        my $class  = $c->action->class;
+
+        my $prefix = length Catalyst::Utils::class2classprefix($class);
 
-        return $c->_find_component_regexp( $container, $name, \@args );
+        # 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)
@@ -621,39 +596,16 @@ If you want to search for models, pass in a regexp as the argument.
 
 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 $c->container->get_component('model', $name, \@args)
-            if ( !ref $name && $container->has_service($name));
-
-        return $c->_find_component_regexp( $container, $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->resolve( service => $comp, parameters => { context => \@args } );
+    return $c->container->get_component_from_sub_container( 'model', $name, $c, @args);
 }
 
 
@@ -680,43 +632,16 @@ If you want to search for views, pass in a regexp as the argument.
 
 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 $c->container->get_component('view', $name, \@args);
-            }
-            else {
-                $c->log->warn( "Attempted to use view '$name', but does not exist" );
-            }
-        }
-
-        return $c->_find_component_regexp( $container, $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->resolve( service => $comp, parameters => { context => \@args } );
+    return $c->container->get_component_from_sub_container( 'view', $name, $c, @args);
 }
 
 =head2 $c->controllers
@@ -753,6 +678,28 @@ sub views {
     return $c->container->get_sub_container('view')->get_service_list;
 }
 
+sub _find_component {
+    my ($c, $component, @args) = @_;
+    my @result;
+
+    my $query = ref $component
+              ? $component
+              : qr{^$component$}
+              ;
+
+    for my $subcontainer_name (qw/model view controller/) {
+        my $subcontainer = $c->container->get_sub_container($subcontainer_name);
+        my @components   = $subcontainer->get_service_list;
+        @result          = grep { m{$component} } @components;
+
+        return map { $subcontainer->get_component( $_, $c, @args ) } @result
+            if @result;
+    }
+
+    # it expects an empty list on failed searches
+    return @result;
+}
+
 =head2 $c->comp($name)
 
 =head2 $c->component($name)
@@ -765,70 +712,40 @@ should be used instead.
 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 ) = @_;
 
-    if ( $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);
-
-            if( !ref $component && $container->has_service($name) ) {
-                return $container->resolve( service => $name, parameters => { context => [ $c, @args ] } );
-            }
-
-            return
-                if $c->config->{disable_component_resolution_regex_fallback};
+    return sort keys %{ $c->components }
+        unless $component;
 
-            my $query      = qr{$name}i;
-            my @components = $container->get_service_list;
-            my @result     = grep { m{$query} } @components;
+    my ($type, $name) = _get_component_type_name($component);
 
-            if (@result) {
-                $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' );
+    return $c->container->get_component_from_sub_container(
+        $type, $name, $c, @args
+    ) if $type;
 
-                return $container->resolve( service => $result[0], parameters => { context => [$c, @args] } );
-            }
-        }
+    my @result = $c->_find_component( $component, @args );
 
-        return
-            if $c->config->{disable_component_resolution_regex_fallback} && !ref $component;
+    # list context for regexp searches
+    return @result if ref $component;
 
-        # This is here so $c->comp( '::M::' ) works
-        my $query = ref $component ? $component : qr{$component}i;
+    # only one component (if it's found) for string searches
+    return shift @result if @result;
 
-        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;
+    # 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;
 
-            if (@result) {
-                return map { $subcontainer->resolve( service => $_, parameters => { context => [$c, @args] } ) } @result
-                    if ref $component;
+    $c->log->warn("Looking for '$component', but nothing was found.");
 
-                $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' );
-
-                return $subcontainer->resolve( service => $result[0], parameters => { context => [$c, @args] } );
-            }
-        }
-
-        # 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 going to be deprecated");
+    $c->log->warn("in future releases.");
 
-    # fallback
     return sort keys %{ $c->components };
 }
 
@@ -1564,8 +1481,7 @@ around components => sub {
 
         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) } ));
+        $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
     }
 
     return $class->$orig($components);
@@ -2402,7 +2318,7 @@ sub setup_config {
 
     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);
@@ -2415,7 +2331,7 @@ sub setup_config {
     $class->finalize_config; # back-compat
 }
 
-=head $c->finalize_config
+=head2 $c->finalize_config
 
 =cut
 
@@ -2464,7 +2380,7 @@ sub setup_components {
     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 } ));
+            $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
         }
         my @expanded_components = $instance->can('expand_modules')
             ? $instance->expand_modules( $component, $config )
@@ -2478,18 +2394,28 @@ sub setup_components {
             ) 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) } ));
+                $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
             }
 
             $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;
 
+    if (scalar @parts == 1) {
+        return (undef, $component);
+    }
+
     while (my $type = shift @parts) {
         return ('controller', join '::', @parts)
             if $type =~ /^(c|controller)$/i;
@@ -2965,14 +2891,6 @@ C<default_view> - The default view to be rendered or returned when C<< $c->view
 
 =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 >>.
@@ -3146,6 +3064,8 @@ Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
 
 Andrew Ruthven
 
+AndrĂ© Walker
+
 andyg: Andy Grundman <andy@hybridized.org>
 
 audreyt: Audrey Tang