X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=5d96074ef64a85e5bf7c3f7e8a01095d1b34f072;hb=cf0b6c0cb55b65a14f7ed39c0c4dab9db53bf1e5;hp=fe7a6d283d904e48df2e0ca4684f323c9e51ef8f;hpb=aa61c19093ccde10f79f746daee1387748590f43;p=catagits%2FCatalyst-Runtime.git
diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm
index fe7a6d2..5d96074 100644
--- a/lib/Catalyst.pm
+++ b/lib/Catalyst.pm
@@ -26,7 +26,7 @@ use Tree::Simple qw/use_weak_refs/;
use Tree::Simple::Visitor::FindByUID;
use attributes;
use utf8;
-use Carp qw/croak carp/;
+use Carp qw/croak carp shortmess/;
BEGIN { require 5.008001; }
@@ -64,7 +64,7 @@ __PACKAGE__->stats_class('Catalyst::Stats');
# Remember to update this in Catalyst::Runtime as well!
-our $VERSION = '5.7099_02';
+our $VERSION = '5.71001';
sub import {
my ( $class, @arguments ) = @_;
@@ -98,7 +98,7 @@ documentation and tutorials.
catalyst.pl MyApp
# add models, views, controllers
- script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
+ script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
script/myapp_create.pl view MyTemplate TT
script/myapp_create.pl controller Search
@@ -328,13 +328,40 @@ When called with no arguments it escapes the processing chain entirely.
sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
-=head2 $c->go( $action [, \@arguments ] )
+=head2 $c->visit( $action [, \@captures, \@arguments ] )
-=head2 $c->go( $class, $method, [, \@arguments ] )
+=head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
-Almost the same as C, but does a full dispatch, instead of just
+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 is called, just like a new request.
+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
+would have been called by dispatching from a URL, while the analogous
+C allows you to transfer control to another action as if it had
+been reached directly from a URL.
+
+=cut
+
+sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
+
+=head2 $c->go( $action [, \@captures, \@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> /
+C<$class-E$method>. This means that C, C and the
+method you visit are called, just like a new request.
C<$c-Estash> is kept unchanged.
@@ -434,6 +461,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; }
@@ -461,9 +489,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;
@@ -564,7 +609,7 @@ 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' );
@@ -703,7 +748,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 );
@@ -914,7 +959,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" );
}
@@ -946,7 +992,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 );
@@ -969,23 +1016,88 @@ EOF
$class->setup_finished(1);
}
+=head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
+
=head2 $c->uri_for( $path, @args?, \%query_values? )
-Merges path with C<< $c->request->base >> for absolute URIs and with
-C<< $c->namespace >> for relative URIs, then returns a normalized L
-object. If any args are passed, they are added at the end of the path.
-If the last argument to C is a hash reference, it is assumed to
-contain GET parameter key/value pairs, which will be appended to the URI
-in standard fashion.
+=over
+
+=item $action
+
+A Catalyst::Action object representing the Catalyst action you want to
+create a URI for.
+
+To get an action object:
+
+ From another controller, anywhere:
+ C<< $c->controller('ControllerName')->action_for('someactionname') >>
+ Shorter styles useful in particular places:
+ In the current controller's action method:
+ C<< $self->action_for('someactionname') >>
+ From the view for currently dispatched action:
+ C<< $c->controller->action_for('someactionname') >>
+
+
+This method must be used to create URIs for
+L actions.
-Note that uri_for is destructive to the passed hashref. Subsequent calls
-with the same hashref may have unintended results.
+=item $path
-Instead of C<$path>, you can also optionally pass a C<$action> object
-which will be resolved to a path using
-C<< $c->dispatcher->uri_for_action >>; if the first element of
-C<@args> is an arrayref it is treated as a list of captures to be passed
-to C.
+The actual path you wish to create a URI for, this is a public path,
+not a private action path.
+
+=item \@captures
+
+If provided, this argument is used to insert values into a I
+action in the parts where the definitions contain I. If
+not needed, leave out this argument.
+
+=item @args
+
+If provided, this is used as a list of further path sections to append
+to the URI. In a I action these are the equivalent to the
+endpoint L.
+
+=item \%query_values
+
+If provided, the query_values hashref is used to add query parameters
+to the URI, with the keys as the names, and the values as the values.
+
+=back
+
+Returns a L object.
+
+ ## Ex 1: a path with args and a query parameter
+ $c->uri_for($c->controller('User')->action_for('list'), 'short', { page => 2});
+ ## -> ($c->req->base is 'http://localhost:3000/'
+ URI->new('http://localhost:3000/user/list/short?page=2)
+
+ ## Ex 2: a chained view action that captures the user id
+ ## In controller:
+ sub user : Chained('/'): PathPart('myuser'): CaptureArgs(1) {}
+ sub viewuser : Chained('user'): PathPart('view') {}
+
+ ## In uri creating code:
+ my $uaction = $c->controller('Users')->action_for('viewuser');
+ $c->uri_for($uaction, [ 42 ]);
+ ## outputs:
+ URI->new('http://localhost:3000/myuser/42/view')
+
+ ## Ex 3: this style is deprecated and should be omitted
+ $c->uri_for('user/list', 'short', { page => 2});
+ ## -> ($c->req->base is 'http://localhost:3000/'
+ URI->new('http://localhost:3000/user/list/short?page=2)
+
+Creates a URI object using C<< $c->request->base >> and a path. If an
+Action object is given instead of a path, the path is constructed
+using C<< $c->dispatcher->uri_for_action >> and passing it the
+@captures array, if supplied.
+
+If any query parameters are passed they are added to the end of the
+URI in the usual way.
+
+Note that uri_for is destructive to the passed query values hashref.
+Subsequent calls with the same hashref may have unintended results.
=cut
@@ -1170,7 +1282,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.
@@ -2467,6 +2579,8 @@ Geoff Richards
jcamacho: Juan Camacho
+jhannah: Jay Hannah
+
Jody Belka
Johan Lindstrom
@@ -2493,6 +2607,8 @@ obra: Jesse Vincent
omega: Andreas Marienborg
+Oleg Kostyuk
+
phaylon: Robert Sedlacek
sky: Arthur Bergman
@@ -2503,6 +2619,8 @@ Ulf Edvinsson
willert: Sebastian Willert
+batman: Jan Henning Thorsen
+
=head1 LICENSE
This library is free software, you can redistribute it and/or modify it under