X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=9c5bc8cc840cac66477dc743edccb90832eeec58;hp=db307ab9bc2477df00b3c95b75a8bcaf7fa01717;hb=4ac0b9cb8e9043db8a95f44af685c782bf9426e7;hpb=edb20ed3aaf578b6784f7e0a52ed8c00f05f2718 diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index db307ab..9c5bc8c 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,11 +1,6 @@ package Catalyst; -# we don't need really need this, but if we load it before MRO::Compat gets -# loaded (via Moose and Class::MOP), we can avoid some nasty warnings -use Class::C3; - use Moose; -use Class::MOP::Object (); extends 'Catalyst::Component'; use bytes; use Scope::Upper (); @@ -22,16 +17,15 @@ use Module::Pluggable::Object (); use Text::SimpleTable (); use Path::Class::Dir (); use Path::Class::File (); -use Time::HiRes qw/gettimeofday tv_interval/; use URI (); use URI::http; use URI::https; -use Scalar::Util qw/weaken blessed/; use Tree::Simple qw/use_weak_refs/; use Tree::Simple::Visitor::FindByUID; +use Class::C3::Adopt::NEXT; use attributes; use utf8; -use Carp qw/croak carp/; +use Carp qw/croak carp shortmess/; BEGIN { require 5.008001; } @@ -82,7 +76,14 @@ __PACKAGE__->stats_class('Catalyst::Stats'); # Remember to update this in Catalyst::Runtime as well! -our $VERSION = '5.8000_04'; +our $VERSION = '5.8000_06'; + +{ + my $dev_version = $VERSION =~ /_\d{2}$/; + *_IS_DEVELOPMENT_VERSION = sub () { $dev_version }; +} + +$VERSION = eval $VERSION; sub import { my ( $class, @arguments ) = @_; @@ -93,6 +94,12 @@ sub import { my $caller = caller(); return if $caller eq 'main'; + + # Kill Adopt::NEXT warnings if we're a non-RC version + unless (_IS_DEVELOPMENT_VERSION()) { + Class::C3::Adopt::NEXT->unimport(qr/^Catalyst::/); + } + my $meta = Moose::Meta::Class->initialize($caller); #Moose->import({ into => $caller }); #do we want to do this? @@ -354,14 +361,21 @@ When called with no arguments it escapes the processing chain entirely. sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } -=head2 $c->visit( $action [, \@arguments ] ) +=head2 $c->visit( $action [, \@captures, \@arguments ] ) -=head2 $c->visit( $class, $method, [, \@arguments ] ) +=head2 $c->visit( $class, $method, [, \@captures, \@arguments ] ) Almost the same as C, but does a full dispatch, instead of just calling the new C<$action> / C<$class-E$method>. This means that C, C and the method you go to are called, just like a new request. +In addition both C<< $c->action >> and C<< $c->namespace >> are localized. +This means, for example, that $c->action methods such as C, C and +C return information for the visited action when they are invoked +within the visited action. This is different from the behavior of C +which continues to use the $c->action object from the caller action even when +invoked from the callee. + C<$c-Estash> is kept unchanged. In effect, C allows you to "wrap" another action, just as it @@ -373,9 +387,9 @@ been reached directly from a URL. sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) } -=head2 $c->go( $action [, \@arguments ] ) +=head2 $c->go( $action [, \@captures, \@arguments ] ) -=head2 $c->go( $class, $method, [, \@arguments ] ) +=head2 $c->go( $class, $method, [, \@captures, \@arguments ] ) Almost the same as C, but does a full dispatch like C, instead of just calling the new C<$action> / @@ -484,6 +498,7 @@ sub _comp_search_prefixes { my ( $c, $name, @prefixes ) = @_; my $appclass = ref $c || $c; my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::'; + $filter = qr/$filter/; # Compile regex now rather than once per loop # map the original component name to the sub part that we will search against my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; } @@ -511,9 +526,26 @@ sub _comp_search_prefixes { # don't warn if we didn't find any results, it just might not exist if( @result ) { - $c->log->warn( qq(Found results for "${name}" using regexp fallback.) ); - $c->log->warn( 'Relying on the regexp fallback behavior for component resolution is unreliable and unsafe.' ); - $c->log->warn( 'If you really want to search, pass in a regexp as the argument.' ); + # Disgusting hack to work out correct method name + my $warn_for = lc $prefixes[0]; + my $msg = "Used regexp fallback for \$c->{$warn_for}('${name}'), which found '" . + (join '", "', @result) . "'. Relying on regexp fallback behavior for " . + "component resolution is unreliable and unsafe."; + my $short = $result[0]; + $short =~ s/.*?Model:://; + my $shortmess = Carp::shortmess(''); + if ($shortmess =~ m#Catalyst/Plugin#) { + $msg .= " You probably need to set '$short' instead of '${name}' in this " . + "plugin's config"; + } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) { + $msg .= " You probably need to set '$short' instead of '${name}' in this " . + "component's config"; + } else { + $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}({'${name}'}), " . + "but if you really wanted to search, pass in a regexp as the argument " . + "like so: \$c->${warn_for}(qr/${name}/)"; + } + $c->log->warn( "${msg}$shortmess" ); } return @result; @@ -614,11 +646,11 @@ sub model { my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/); if( $rest ) { - $c->log->warn( 'Calling $c->model() will return a random model unless you specify one of:' ); + $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.80, the "random" behavior will not work at all.' ); + $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' ); } return $c->_filter_component( $comp ); @@ -671,7 +703,7 @@ sub view { $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.80, the "random" behavior will not work at all.' ); + $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' ); } return $c->_filter_component( $comp ); @@ -753,7 +785,7 @@ sub component { return map { $c->_filter_component( $_, @args ) } @result if ref $name; if( $result[ 0 ] ) { - $c->log->warn( qq(Found results for "${name}" using regexp fallback.) ); + $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 $c->_filter_component( $result[ 0 ], @args ); @@ -775,12 +807,34 @@ Returns or takes a hashref containing the application's configuration. __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } ); You can also use a C, C or C config file -like myapp.yml in your applications home directory. See +like myapp.conf in your applications home directory. See L. - --- - db: dsn:SQLite:foo.db +=head3 Cascading configuration. + +The config method is present on all Catalyst components, and configuration +will be merged when an application is started. Configuration loaded with +L takes precedence over other configuration, +followed by configuration in your top level C class. These two +configurations are merged, and then configuration data whos hash key matches a +component name is merged with configuration for that component. + +The configuration for a component is then passed to the C method when a +component is constructed. + +For example: + + MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } }); + MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' }); + +will mean that C receives the following data when +constructed: + MyApp::Model::Foo->new({ + bar => 'baz', + quux => 'frob', + overrides => 'me', + }); =cut @@ -788,8 +842,8 @@ around config => sub { my $orig = shift; my $c = shift; - $c->log->warn("Setting config after setup has been run is not a good idea.") - if ( @_ and $c->setup_finished ); + croak('Setting config after setup has been run is not allowed.') + if ( @_ and $c->setup_finished ); $c->$orig(@_); }; @@ -814,10 +868,21 @@ L. =head2 $c->debug -Overload to enable debug messages (same as -Debug option). +Returns 1 if debug mode is enabled, 0 otherwise. -Note that this is a static method, not an accessor and should be overloaded -by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1). +You can enable debug mode in several ways: + +=over + +=item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG + +=item The -Debug option in your MyApp.pm + +=item By declaring "sub debug { 1 }" in your MyApp.pm. + +=back + +Calling $c->debug(1) has no effect. =cut @@ -825,13 +890,11 @@ sub debug { 0 } =head2 $c->dispatcher -Returns the dispatcher instance. Stringifies to class name. See -L. +Returns the dispatcher instance. See L. =head2 $c->engine -Returns the engine instance. Stringifies to the class name. See -L. +Returns the engine instance. See L. =head2 UTILITY METHODS @@ -856,17 +919,25 @@ sub path_to { =head2 $c->plugin( $name, $class, @args ) -Helper method for plugins. It creates a classdata accessor/mutator and +Helper method for plugins. It creates a class data accessor/mutator and loads and instantiates the given class. MyApp->plugin( 'prototype', 'HTML::Prototype' ); $c->prototype->define_javascript_functions; + +B This method of adding plugins is deprecated. The ability +to add plugins like this B in a Catalyst 5.9. +Please do not use this functionality in new code. =cut sub plugin { my ( $class, $name, $plugin, @args ) = @_; + + # See block comment in t/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 ); eval { $plugin->import }; @@ -898,8 +969,8 @@ Catalyst> line. sub setup { my ( $class, @arguments ) = @_; - $class->log->warn("Running setup twice is not a good idea.") - if ( $class->setup_finished ); + croak('Running setup more than once') + if ( $class->setup_finished ); unless ( $class->isa('Catalyst') ) { @@ -964,7 +1035,8 @@ EOF my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins; if (@plugins) { - my $t = Text::SimpleTable->new(74); + my $column_width = Catalyst::Utils::term_width() - 6; + my $t = Text::SimpleTable->new($column_width); $t->row($_) for @plugins; $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" ); } @@ -996,7 +1068,8 @@ EOF $class->setup_components; if ( $class->debug ) { - my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] ); + 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 ); @@ -1025,10 +1098,35 @@ EOF # modifiers work correctly in MyApp (as you have to call setup _before_ # applying modifiers). Scope::Upper::reap(sub { - my $meta = $class->Moose::Object::meta(); + my $meta = Class::MOP::get_metaclass_by_name($class); $meta->make_immutable unless $meta->is_immutable; - }, 1); + }, Scope::Upper::SCOPE(1)); + + $class->setup_finalize; +} + + +=head2 $app->setup_finalize + +A hook to attach modifiers to. +Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup. +Also better than C< setup_finished(); >, as that is a getter method. + sub setup_finalize { + + my $app = shift; + + ## do stuff, i.e., determine a primary key column for sessions stored in a DB + + $app->next::method(@_); + + + } + +=cut + +sub setup_finalize { + my ($class) = @_; $class->setup_finished(1); } @@ -1062,12 +1160,17 @@ using C<< $c->req->captures >>. sub uri_for { my ( $c, $path, @args ) = @_; - if ( Scalar::Util::blessed($path) ) { # action object + if ( blessed($path) ) { # action object my $captures = ( scalar @args && ref $args[0] eq 'ARRAY' ? shift(@args) : [] ); - $path = $c->dispatcher->uri_for_action($path, $captures); - return undef unless defined($path); + my $action = $path; + $path = $c->dispatcher->uri_for_action($action, $captures); + if (not defined $path) { + $c->log->debug(qq/Can't find uri_for action '$action' @$captures/) + if $c->debug; + return undef; + } $path = '/' if $path eq ''; } @@ -1121,6 +1224,38 @@ sub uri_for { $res; } +=head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? ) + +=head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? ) + +=over + +=item $path + +A private path to the Catalyst action you want to create a URI for. + +This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path) +>> and passing the resulting C<$action> and the remaining arguments to C<< +$c->uri_for >>. + +You can also pass in a Catalyst::Action object, in which case it is passed to +C<< $c->uri_for >>. + +=back + +=cut + +sub uri_for_action { + my ( $c, $path, @args ) = @_; + my $action = blessed($path) + ? $path + : $c->dispatcher->get_action_by_path($path); + unless (defined $action) { + croak "Can't find action for path '$path'"; + } + return $c->uri_for( $action, @args ); +} + =head2 $c->welcome_message Returns the Catalyst welcome HTML page. @@ -1240,7 +1375,7 @@ sub welcome_message { they can save you a lot of work.

script/${prefix}_create.pl -help

Also, be sure to check out the vast and growing - collection of plugins for Catalyst on CPAN; + collection of plugins for Catalyst on CPAN; you are likely to find what you need there.

@@ -1992,7 +2127,12 @@ sub setup_components { my @comps = sort { length $a <=> length $b } $locator->plugins; my %comps = map { $_ => 1 } @comps; - + + my $deprecated_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 $deprecated_component_names; + for my $component ( @comps ) { # We pass ignore_loaded here so that overlay files for (e.g.) @@ -2094,7 +2234,7 @@ sub setup_engine { } if ( $ENV{MOD_PERL} ) { - my $meta = $class->Class::MOP::Object::meta(); + my $meta = Class::MOP::get_metaclass_by_name($class); # create the apache method $meta->add_method('apache' => sub { shift->engine->apache }); @@ -2226,25 +2366,25 @@ or if the C<$CATALYST_DEBUG> environment variable is set to a true value. Note that if the log has already been setup, by either a previous call to C or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>, -that this method won't actually set up the log. +that this method won't actually set up the log object. =cut sub setup_log { my ( $class, $levels ) = @_; - my %levels; + $levels ||= ''; + $levels =~ s/^\s+//; + $levels =~ s/\s+$//; + my %levels = map { $_ => 1 } split /\s*,\s*/, $levels || ''; + unless ( $class->log ) { - $levels ||= ''; - $levels =~ s/^\s+//; - $levels =~ s/\s+$//; - %levels = map { $_ => 1 } split /\s*,\s*/, $levels || ''; $class->log( Catalyst::Log->new(keys %levels) ); } my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' ); if ( defined($env_debug) or $levels{debug} ) { - $class->Class::MOP::Object::meta()->add_method('debug' => sub { 1 }); + Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 }); $class->log->debug('Debug messages enabled'); } } @@ -2268,7 +2408,7 @@ sub setup_stats { my $env = Catalyst::Utils::env_value( $class, 'STATS' ); if ( defined($env) ? $env : ($stats || $class->debug ) ) { - $class->Class::MOP::Object::meta()->add_method('use_stats' => sub { 1 }); + Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 }); $class->log->debug('Statistics enabled'); } } @@ -2311,7 +2451,7 @@ the plugin name does not begin with C. $proto->_plugins->{$plugin} = 1; unless ($instant) { no strict 'refs'; - if ( my $meta = $class->Class::MOP::Object::meta() ) { + if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) { my @superclasses = ($plugin, $meta->superclasses ); $meta->superclasses(@superclasses); } else { @@ -2539,6 +2679,8 @@ ilmari: Dagfinn Ilmari Mannsåker jcamacho: Juan Camacho +jhannah: Jay Hannah + Jody Belka Johan Lindstrom @@ -2565,6 +2707,8 @@ obra: Jesse Vincent omega: Andreas Marienborg +Oleg Kostyuk + phaylon: Robert Sedlacek rafl: Florian Ragwitz @@ -2573,6 +2717,8 @@ sky: Arthur Bergman the_jester: Jesse Sheidlower +t0m: Tomas Doran + Ulf Edvinsson willert: Sebastian Willert