X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=7c51d8de924b3d75a26b985a4012c0f9c1aeb328;hb=5cd3e38f295b5e88b588f4a2dbd09cb5ccb2342f;hp=1a8990a885bb792543d618d83b21ccfd7c160f77;hpb=81acce7179c17468e653f4e07e4b552dd106f5f4;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 1a8990a..7c51d8d 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -15,9 +15,7 @@ use Catalyst::Response; use Catalyst::Utils; use Catalyst::Controller; use Data::OptList; -use Devel::InnerPackage (); use File::stat; -use Module::Pluggable::Object (); use Text::SimpleTable (); use Path::Class::Dir (); use Path::Class::File (); @@ -27,7 +25,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 +65,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/; @@ -80,7 +77,7 @@ __PACKAGE__->stats_class('Catalyst::Stats'); # Remember to update this in Catalyst::Runtime as well! -our $VERSION = '5.80032'; +our $VERSION = '5.80033'; sub import { my ( $class, @arguments ) = @_; @@ -93,10 +90,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 +112,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 @@ -556,22 +564,7 @@ If you want to search for controllers, pass in a regexp as the argument. =cut -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; - } - - return $c->container->get_component_from_sub_container( 'controller', $name, $c, @args); -} +sub controller { shift->_lookup_mvc('controller', @_) } =head2 $c->model($name) @@ -594,20 +587,7 @@ If you want to search for models, pass in a regexp as the argument. =cut -sub model { - my ( $c, $name, @args ) = @_; - - if (ref $c && !$name) { - return $c->stash->{current_model_instance} - if $c->stash->{current_model_instance}; - - $name = $c->stash->{current_model} - if $c->stash->{current_model}; - } - - return $c->container->get_component_from_sub_container( 'model', $name, $c, @args); -} - +sub model { shift->_lookup_mvc('model', @_) } =head2 $c->view($name) @@ -630,18 +610,23 @@ If you want to search for views, pass in a regexp as the argument. =cut -sub view { - my ( $c, $name, @args ) = @_; +sub view { shift->_lookup_mvc('view', @_) } + +sub _lookup_mvc { + my ( $c, $type, $name, @args ) = @_; if (ref $c && !$name) { - return $c->stash->{current_view_instance} - if $c->stash->{current_view_instance}; + my $current_instance = $c->stash->{"current_${type}_instance"}; + return $current_instance + if $current_instance && $type ne 'controller'; - $name = $c->stash->{current_view} - if $c->stash->{current_view}; + $name = $type eq 'controller' + ? Catalyst::Utils::class2classshortsuffix($c->action->class) + : $c->stash->{"current_${type}"} + ; } - return $c->container->get_component_from_sub_container( 'view', $name, $c, @args); + return $c->container->get_component_from_sub_container($type, $name, $c, @args); } =head2 $c->controllers @@ -678,28 +663,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,36 +680,46 @@ component name will be returned. sub component { my ( $c, $component, @args ) = @_; - return sort keys %{ $c->components } - unless ( $component ); - - return $c->_find_component( $component, @args ) - if ref $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 @result = $c->container->find_component( $component, $c, @args ); - return $c->container->get_component_from_sub_container( - $type, $name, $c, @args - ) if $type; + # list context for regexp searches + return @result if ref $component; - my @result = $c->_find_component( $component, @args ); + # 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 @@ -911,7 +884,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 ); @@ -1040,25 +1013,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_names_types = $class->container->get_components_names_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_names_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; @@ -1458,32 +1423,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 $class->container; - for my $component ( keys %$comps ) { - $components->{ $component } = $comps->{$component}; + my $container = $class->container; - 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( $_ ) for keys %$comps; } - return $class->$orig($components); -}; + return $container->get_all_components(); +} =head2 $c->context_class @@ -2321,10 +2274,10 @@ sub setup_config { my $container_class = Class::MOP::load_first_existing_class(@container_classes); - my $container = $container_class->new( %args, name => "$class" ); + my $container = $container_class->new( %args, application_name => "$class", name => "$class" ); $class->container($container); - my $config = $container->resolve(service => 'config'); + my $config = $container->resolve( service => 'config' ); $class->config($config); $class->finalize_config; # back-compat } @@ -2340,175 +2293,37 @@ sub finalize_config { } This method is called internally to set up the application's components. It finds modules by calling the L method, expands them to -package names with the L method, and then installs -each component into the application. +package names with the $container->expand_component_module method, and then +installs each component into the application. The C config option is passed to both of the above methods. -Installation of each component is performed by the L method, -below. - =cut sub setup_components { - my $class = shift; - - my $config = $class->config->{ setup_components }; - - my @comps = $class->locate_components($config); - my %comps = map { $_ => 1 } @comps; - - my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps; - $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}. - qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n} - ) if $deprecatedcatalyst_component_names; - - for my $component ( @comps ) { - - # We pass ignore_loaded here so that overlay files for (e.g.) - # Model::DBI::Schema sub-classes are loaded - if it's in @comps - # we know M::P::O found a file on disk so this is safe - - 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) ) { - $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 ); - for my $component (@expanded_components) { - next if $comps{$component}; - - $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components; - $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}. - 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)) { - $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; + shift->container->setup_components(); } -# 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; - - return ('model', join '::', @parts) - if $type =~ /^(m|model)$/i; - - return ('view', join '::', @parts) - if $type =~ /^(v|view)$/i; - } -} - -=head2 $c->locate_components( $setup_component_config ) - -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. +=head2 locate_components =cut -sub locate_components { - my $class = shift; - my $config = shift; - - my @paths = qw( ::Controller ::C ::Model ::M ::View ::V ); - my $extra = delete $config->{ search_extra } || []; +# FIXME - removed locate_components +# don't people mess with this method directly? +# what to do with that? - push @paths, @$extra; +sub locate_components { + my $class = shift; - my $locator = Module::Pluggable::Object->new( - search_path => [ map { s/^(?=::)/$class/; $_; } @paths ], - %$config - ); + $class->log->warn('The locate_components method has been deprecated.'); + $class->log->warn('Please read Catalyst::IOC::Container documentation to'); + $class->log->warn('update your application.'); # XXX think about ditching this sort entirely - my @comps = sort { length $a <=> length $b } $locator->plugins; - - return @comps; + return sort { length $a <=> length $b } + @{ $class->container->resolve( service => 'locate_components' ) }; } -=head2 $c->expand_component_module( $component, $setup_component_config ) - -Components found by C will be passed to this method, which -is expected to return a list of component (package) names to be set up. - -=cut - -sub expand_component_module { - my ($class, $module) = @_; - return Devel::InnerPackage::list_packages( $module ); -} - -=head2 $c->setup_component - -=cut - -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 @@ -2916,12 +2731,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.