broke expand_modules, setup_component became a method
[catagits/Catalyst-Runtime.git] / lib / Catalyst.pm
index b59a1b0..a19de10 100644 (file)
@@ -27,7 +27,6 @@ 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;
@@ -67,8 +66,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 +94,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 +114,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
@@ -561,16 +569,7 @@ If you want to search for controllers, pass in a regexp as the argument.
 sub controller {
     my ( $c, $name, @args ) = @_;
 
-# FIXME: should this be a Catalyst::Utils method?
-    if (!$name) {
-        my $class  = $c->action->class;
-
-        my $prefix = length Catalyst::Utils::class2classprefix($class);
-
-        # MyApp::Controller::Foo becomes Foo
-        # the + 2 is because of the ::
-        $name = substr $class, $prefix + 2;
-    }
+    $name ||= Catalyst::Utils::class2classshortsuffix( $c->action->class );
 
     return $c->container->get_component_from_sub_container( 'controller', $name, $c, @args);
 }
@@ -680,28 +679,6 @@ 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)
@@ -721,18 +698,12 @@ sub component {
 
     unless ($component) {
         $c->log->warn('Calling $c->component with no args is deprecated and ');
-        $c->log->warn('will be removed in future releases.');
+        $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);
-
-    return $c->container->get_component_from_sub_container(
-        $type, $name, $c, @args
-    ) if $type;
-
-    my @result = $c->_find_component( $component, @args );
+    my @result = $c->container->find_component( $component, $c, @args );
 
     # list context for regexp searches
     return @result if ref $component;
@@ -740,17 +711,19 @@ sub 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.");
 
     # 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 future releases. Use $c->component_list instead.');
+    $c->log->warn('removed in a future release. Use $c->component_list');
+    $c->log->warn('instead.');
 
     return $c->component_list;
 }
@@ -1056,25 +1029,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;
@@ -1474,36 +1439,22 @@ 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?
-    $class->setup_config unless defined $class->container;
+    # people create components calling this sub directly, before setup
+    $class->setup_config unless $class->container;
 
-# FIXME: should there be a warning here, not to use this accessor to create the components?
-    my $components = {};
+    my $container = $class->container;
 
-    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->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
+    if ( $comps ) {
+        $container->add_component(
+            $_, $class
+        ) for keys %$comps;
     }
 
-    return $class->$orig($components);
-};
+    return $container->get_all_components();
+}
 
 =head2 $c->context_class
 
@@ -2365,16 +2316,18 @@ each component into the application.
 
 The C<setup_components> config option is passed to both of the above methods.
 
-Installation of each component is performed by the L<setup_component> method,
-below.
-
 =cut
 
 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;
@@ -2393,17 +2346,12 @@ sub setup_components {
         Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
     }
 
-    my $containers;
-    $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
+    my $container = $class->container;
 
     for my $component (@comps) {
-        my $instance = $class->components->{ $component } = $class->setup_component($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')
-            ? $instance->expand_modules( $component, $config )
-            : $class->expand_component_module( $component, $config );
+        $container->add_component( $component, $class );
+# FIXME - $instance->expand_modules() is broken
+        my @expanded_components = $class->expand_component_module( $component, $config );
         for my $component (@expanded_components) {
             next if $comps{$component};
 
@@ -2412,55 +2360,14 @@ 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)) {
-                $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);
+            $container->add_component( $component, $class );
         }
     }
 
-    $containers->{model}->make_single_default;
-    $containers->{view}->make_single_default;
+    $container->get_sub_container('model')->make_single_default;
+    $container->get_sub_container('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, $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)
-            if $type =~ /^(c|controller)$/i;
-
-        return ('model', join '::', @parts)
-            if $type =~ /^(m|model)$/i;
-
-        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 )
 
@@ -2468,9 +2375,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
 
@@ -2479,9 +2384,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 ],
@@ -2506,47 +2408,6 @@ sub expand_component_module {
     return Devel::InnerPackage::list_packages( $module );
 }
 
-=head2 $c->setup_component
-
-=cut
-
-## FIXME - Why the hell do we try calling the ->COMPONENT method twice, this is madness!?!
-sub setup_component {
-    my( $class, $component ) = @_;
-
-    unless ( $component->can( 'COMPONENT' ) ) {
-        return $component;
-    }
-
-    my $suffix = Catalyst::Utils::class2classsuffix( $component );
-    my $config = $class->config->{ $suffix } || {};
-    # Stash catalyst_component_name in the config here, so that custom COMPONENT
-    # methods also pass it. local to avoid pointlessly shitting in config
-    # for the debug screen, as $component is already the key name.
-    local $config->{catalyst_component_name} = $component;
-
-    my $instance = eval { $component->COMPONENT( $class, $config ); };
-
-    if ( my $error = $@ ) {
-        chomp $error;
-        Catalyst::Exception->throw(
-            message => qq/Couldn't instantiate component "$component", "$error"/
-        );
-    }
-    elsif (!blessed $instance) {
-        my $metaclass = Moose::Util::find_meta($component);
-        my $method_meta = $metaclass->find_method_by_name('COMPONENT');
-        my $component_method_from = $method_meta->associated_metaclass->name;
-        my $value = defined($instance) ? $instance : 'undef';
-        Catalyst::Exception->throw(
-            message =>
-            qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
-        );
-    }
-
-    return $instance;
-}
-
 =head2 $c->setup_dispatcher
 
 Sets up dispatcher.
@@ -2953,12 +2814,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.