deprecate search_extra
[catagits/Catalyst-Runtime.git] / lib / Catalyst.pm
index 55999f7..3427d7d 100644 (file)
@@ -27,7 +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 Hash::Util qw/lock_hash/;
 use List::MoreUtils qw/uniq/;
 use attributes;
 use utf8;
@@ -67,8 +67,8 @@ our $GO        = Catalyst::Exception::Go->new;
 
 #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($_) # XXX FIXME - components remove from here
-  for qw/container components arguments dispatcher engine log dispatcher_class
+__PACKAGE__->mk_classdata($_)
+  for qw/container arguments dispatcher engine log dispatcher_class
   engine_class context_class request_class response_class stats_class
   setup_finished/;
 
@@ -95,7 +95,7 @@ sub import {
     my $meta = Moose::Meta::Class->initialize($caller);
 
     unless ( $caller->isa('Catalyst') ) { # XXX - Remove!
-        my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller'); # XXX - Remove!
+        my @superclasses = ($meta->superclasses, $class, 'Catalyst::Component'); # XXX - Remove!
         $meta->superclasses(@superclasses); # XXX - Remove!
     } # XXX - Remove!
 
@@ -115,6 +115,15 @@ sub import {
     $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
@@ -703,16 +712,22 @@ sub component {
 
     my @result = $c->container->find_component( $component, $c, @args );
 
+    # one last search for things like $c->comp(qr/::M::/)
+    @result = $c->container->find_component_regexp(
+        $c->components, $component, $c, @args
+    ) if !@result and ref $component;
+
     # list context for regexp searches
     return @result if ref $component;
 
     # only one component (if it's found) for string searches
     return shift @result if @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;
+    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;
+    }
 
     $c->log->warn("Looking for '$component', but nothing was found.");
 
@@ -1026,25 +1041,17 @@ EOF
         $class->setup unless $Catalyst::__AM_RESTARTING;
     }
 
-    # Initialize our data structure
-    $class->components( {} ); # XXX - Remove!
-
     $class->setup_components;
 
-    if ( $class->debug ) { # XXX - Fixme to be a method on the container? (Or at least get a) data structure back from the container!!
+    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;
@@ -1444,36 +1451,43 @@ Returns a hash of 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 $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);
-
-    for my $component ( keys %$comps ) {
-        $components->{ $component } = $comps->{$component};
-
-        my ($type, $name) = _get_component_type_name($component);
+    $containers->{$_} = $class->container->get_sub_container($_)
+        for qw(model view controller);
+
+    if ( $comps ) {
+        for my $component ( keys %$comps ) {
+            my ($type, $name) = _get_component_type_name($component);
+
+            $containers->{$type}->add_service(
+                Catalyst::IOC::BlockInjection->new(
+                    name  => $name,
+                    block => sub { $class->setup_component($component) },
+                )
+            );
+        }
+    }
 
-        $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
+    my %components;
+    for my $container (keys %$containers) {
+        my @service_list = $containers->{$container}->get_service_list;
+        for my $component (@service_list) {
+            my $comp = $containers->{$container}->resolve(
+                service => $component
+            );
+            my $comp_name = ref $comp || $comp;
+            $components{$comp_name} = $comp;
+        }
     }
 
-    return $class->$orig($components);
-};
+    return lock_hash %components;
+}
 
 =head2 $c->context_class
 
@@ -2344,7 +2358,12 @@ sub setup_components {
     my $class = shift;
 
     my $config  = $class->config->{ setup_components };
-    my $search_extra = $config->{ search_extra };
+
+    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;
@@ -2367,8 +2386,8 @@ sub setup_components {
     $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, $search_extra) ) {
+        my $instance = $class->setup_component($component);
+        if ( my ($type, $name) = _get_component_type_name($component) ) {
             $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
         }
         my @expanded_components = $instance->can('expand_modules')
@@ -2382,12 +2401,9 @@ sub setup_components {
                 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, $search_extra)) {
+            if (my ($type, $name) = _get_component_type_name($component)) {
                 $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);
         }
     }
 
@@ -2399,16 +2415,10 @@ sub setup_components {
 # should it be moved to Catalyst::Utils,
 # or replaced by something already existing there?
 sub _get_component_type_name {
-    my ( $component, $search_extra) = @_;
-    $search_extra ||= [];
-    my @search_extra = map { s/^:://; lc $_ } @$search_extra;
+    my ( $component ) = @_;
 
     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;
@@ -2418,10 +2428,9 @@ sub _get_component_type_name {
 
         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 );
     }
+
+    return (undef, $component);
 }
 
 sub _get_component_type {
@@ -2438,9 +2447,7 @@ 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
 
@@ -2449,9 +2456,6 @@ sub locate_components {
     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 ],
@@ -2923,12 +2927,6 @@ templates to a different directory.
 
 =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.