X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=4d1be1494dea39694db20d14574ef968bcdc826f;hb=19c64905295c1483ceaa41d0ba498b52bf4fab5e;hp=95614c6f2d39969e5379540723e8c04185bdf604;hpb=2bbe88b7108f617383f17321e0d8a1657325a9fd;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 95614c6..4d1be14 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -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; @@ -68,7 +67,7 @@ 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($_) - 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/; @@ -93,10 +92,12 @@ sub import { 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); @@ -113,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 @@ -559,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); } @@ -678,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) @@ -717,16 +696,14 @@ component name will be returned. sub component { my ( $c, $component, @args ) = @_; - return sort keys %{ $c->components } - unless $component; - - my ($type, $name) = _get_component_type_name($component); - - return $c->container->get_component_from_sub_container( - $type, $name, $c, @args - ) if $type; + 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 @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; @@ -734,21 +711,31 @@ 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 going to be deprecated"); - $c->log->warn("in future releases."); + $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.'); - 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 @@ -913,7 +900,7 @@ Please do not use this functionality in new code. 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 ); @@ -1042,25 +1029,17 @@ EOF $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; @@ -1460,32 +1439,20 @@ Returns a hash of components. =cut -around components => sub { - my $orig = shift; - my $class = shift; - my $comps = shift; - - return $class->$orig if ( !$comps ); - -# 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 = {}; +sub components { + my ( $class, $comps ) = @_; - my $containers; - $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller); + # people create components calling this sub directly, before setup + $class->setup_config unless my $container = $class->container; - 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->setup_component($_) + ) for keys %$comps; } - return $class->$orig($components); -}; + return $container->get_all_components(); +} =head2 $c->context_class @@ -2356,7 +2323,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; @@ -2375,14 +2347,9 @@ 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); - 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 $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 ); @@ -2394,54 +2361,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) } )); - } - - $class->components->{ $component } = $class->setup_component($component); + $class->container->add_component( $component, $class->setup_component($component) ); } } - $containers->{model}->make_single_default; - $containers->{view}->make_single_default; + $class->container->get_sub_container('model')->make_single_default; + $class->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 ) @@ -2449,9 +2376,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. Specify a C config option to pass additional options directly -to L. To add additional search paths, specify a key named -C as an array reference. Items in the array beginning with C<::> -will have the application class name prepended to them. +to L. =cut @@ -2460,9 +2385,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 ], @@ -2491,6 +2413,7 @@ sub expand_component_module { =cut +## FIXME - Why the hell do we try calling the ->COMPONENT method twice, this is madness!?! sub setup_component { my( $class, $component ) = @_; @@ -2933,12 +2856,6 @@ templates to a different directory. =item * -C - 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 - If true, causes internal actions such as C<< _DISPATCH >> to be shown in hit debug tables in the test server.