X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=9cc2a0699e353b31ccf90432f94ed091fa1a9f25;hb=542a67cf086b9e90d16d87e6f7ef0c1d02bacf03;hp=21c04d8e18ae6e03604873557f0773fe44691bfc;hpb=29817f46bdaaa28fb0c1471fc74084482ce6f3ee;p=catagits%2FCatalyst-Runtime.git
diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm
index 21c04d8..9cc2a06 100644
--- a/lib/Catalyst.pm
+++ b/lib/Catalyst.pm
@@ -17,13 +17,12 @@ 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/;
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 shortmess/;
@@ -77,7 +76,14 @@ __PACKAGE__->stats_class('Catalyst::Stats');
# Remember to update this in Catalyst::Runtime as well!
-our $VERSION = '5.8000_05';
+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 ) = @_;
@@ -88,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?
@@ -349,9 +361,9 @@ 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,
@@ -375,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> /
@@ -486,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; }
@@ -513,7 +526,9 @@ sub _comp_search_prefixes {
# don't warn if we didn't find any results, it just might not exist
if( @result ) {
- my $msg = "Used regexp fallback for \$c->model('${name}'), which found '" .
+ # 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];
@@ -526,9 +541,9 @@ sub _comp_search_prefixes {
$msg .= " You probably need to set '$short' instead of '${name}' in this " .
"component's config";
} else {
- $msg .= " You probably meant \$c->model('$short') instead of \$c->model{'${name}'}, " .
+ $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->model(qr/${name}/)";
+ "like so: \$c->${warn_for}(qr/${name}/)";
}
$c->log->warn( "${msg}$shortmess" );
}
@@ -792,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
@@ -805,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(@_);
};
@@ -831,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
@@ -842,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
@@ -873,7 +919,7 @@ 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' );
@@ -890,7 +936,7 @@ sub plugin {
my ( $class, $name, $plugin, @args ) = @_;
# See block comment in t/unit_core_plugin.t
- $class->log->debug(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.9/);
+ $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 );
@@ -923,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') ) {
@@ -1114,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 '';
}
@@ -1292,7 +1343,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.
@@ -1806,10 +1857,15 @@ sub prepare_body {
$c->prepare_parameters;
$c->prepare_uploads;
- if ( $c->debug ) {
- $c->log_parameters(
- 'Body Parameters are', $c->request->body_parameters
- );
+ if ( $c->debug && keys %{ $c->req->body_parameters } ) {
+ my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
+ for my $key ( sort keys %{ $c->req->body_parameters } ) {
+ my $param = $c->req->body_parameters->{$key};
+ my $value = defined($param) ? $param : '';
+ $t->row( $key,
+ ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
+ }
+ $c->log->debug( "Body Parameters are:\n" . $t->draw );
}
}
@@ -1895,65 +1951,15 @@ sub prepare_query_parameters {
$c->engine->prepare_query_parameters( $c, @_ );
- if ( $c->debug ) {
- $c->log_parameters(
- 'Query Parameters are', $c->request->query_parameters
- );
- }
-}
-
-=head2 $c->log_parameters($name, $parameters)
-
-Logs a hash reference of key value pairs, with a caption above the table.
-
-Looks like:
-
- [debug] Query Parameters are:
- .-------------------------------------+--------------------------------------.
- | Parameter | Value |
- +-------------------------------------+--------------------------------------+
- | search | Moose |
- | searchtype | modules |
- '-------------------------------------+--------------------------------------'
-
-If there are query parameters you don't want to display in this output, such
-as passwords or other sensitive input, you can configure your application to
-redact those parameters:
-
- C<< MyApp->config->{Debug}->{redact_parameters} = [ 'password' ] >>
-
-In that case, the output will look like:
-
- [debug] Query Parameters are:
- .-------------------------------------+--------------------------------------.
- | Parameter | Value |
- +-------------------------------------+--------------------------------------+
- | password | (redacted by config) |
- | username | some_user |
- '-------------------------------------+--------------------------------------'
-
-=cut
-
-sub log_parameters {
- my ( $c, $name, $parameters ) = @_;
-
- my $skip = $c->config->{Debug}->{redact_parameters};
- if (
- ( not defined $skip or ref $skip eq 'ARRAY' )
- && keys %{ $parameters }
- ) {
- my $t = Text::SimpleTable->new(
- [ 35, 'Parameter' ], [ 36, 'Value' ] );
- my %skip_params = map { $_ => $_ } @{ $skip || [] };
- for my $key ( sort keys %$parameters ) {
- my $param = $parameters->{$key};
+ if ( $c->debug && keys %{ $c->request->query_parameters } ) {
+ my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
+ for my $key ( sort keys %{ $c->req->query_parameters } ) {
+ my $param = $c->req->query_parameters->{$key};
my $value = defined($param) ? $param : '';
- $value = '(redacted by config)' if exists $skip_params{$key};
-
$t->row( $key,
ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
}
- $c->log->debug( "$name:\n" . $t->draw );
+ $c->log->debug( "Query Parameters are:\n" . $t->draw );
}
}
@@ -2089,7 +2095,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.)
@@ -2610,8 +2621,6 @@ audreyt: Audrey Tang
bricas: Brian Cassidy
-Byron Young
-
Caelum: Rafael Kitover
chansen: Christian Hansen