X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=2c6ca19cb7543f6e62ed35a5db42ecb7938d85f5;hp=6a73021a2a6cb7132d98a8ba6b36ac06a66a6b3f;hb=e63948476024f865b8e84967ffe71681e90f2a4c;hpb=d01df17df2888c322ad8047d40da81271b25ce59 diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 6a73021..2c6ca19 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,13 +1,19 @@ package Catalyst; use strict; -use base 'Class::Data::Inheritable'; +use base qw[ Catalyst::Base Catalyst::Setup ]; use UNIVERSAL::require; +use Catalyst::Exception; use Catalyst::Log; +use Catalyst::Utils; +use NEXT; +use Text::ASCIITable; +use Path::Class; +our $CATALYST_SCRIPT_GEN = 4; -__PACKAGE__->mk_classdata($_) for qw/_config log/; +__PACKAGE__->mk_classdata($_) for qw/arguments dispatcher engine log/; -our $VERSION = '4.21'; +our $VERSION = '5.31'; our @ISA; =head1 NAME @@ -21,18 +27,15 @@ Catalyst - The Elegant MVC Web Application Framework cd MyApp # add models, views, controllers - script/create.pl model Something - script/create.pl view Stuff - script/create.pl controller Yada + script/myapp_create.pl model Something + script/myapp_create.pl view Stuff + script/myapp_create.pl controller Yada # built in testserver - script/server.pl + script/myapp_server.pl # command line interface - script/test.pl /yada - - - See also L + script/myapp_test.pl /yada use Catalyst; @@ -43,64 +46,71 @@ Catalyst - The Elegant MVC Web Application Framework use Catalyst qw/-Debug -Engine=CGI/; - __PACKAGE__->action( '!default' => sub { $_[1]->res->output('Hello') } ); + sub default : Private { $_[1]->res->output('Hello') } ); - __PACKAGE__->action( - 'index.html' => sub { - my ( $self, $c ) = @_; - $c->res->output('Hello'); - $c->forward('_foo'); - } - ); + sub index : Path('/index.html') { + my ( $self, $c ) = @_; + $c->res->output('Hello'); + $c->forward('foo'); + } - __PACKAGE__->action( - '/^product[_]*(\d*).html$/' => sub { - my ( $self, $c ) = @_; - $c->stash->{template} = 'product.tt'; - $c->stash->{product} = $c->req->snippets->[0]; - } - ); + sub product : Regex('^product[_]*(\d*).html$') { + my ( $self, $c ) = @_; + $c->stash->{template} = 'product.tt'; + $c->stash->{product} = $c->req->snippets->[0]; + } -=head1 DESCRIPTION +See also L -Catalyst is based upon L, which you should consider for smaller -projects. +=head1 DESCRIPTION The key concept of Catalyst is DRY (Don't Repeat Yourself). See L for more documentation. -Omit the Catalyst::Plugin:: prefix from plugins. -So Catalyst::Plugin::My::Module becomes My::Module. +Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement. +Omit the C prefix from the plugin name, +so C becomes C. use Catalyst 'My::Module'; -You can also set special flags like -Debug and -Engine. +Special flags like -Debug and -Engine can also be specifed as arguments when +Catalyst is loaded: use Catalyst qw/-Debug My::Module/; -The position of plugins and flags in the chain is important, -because they are loaded in the same order they appear. +The position of plugins and flags in the chain is important, because they are +loaded in exactly the order that they appear. + +The following flags are supported: -=head2 -Debug +=over 4 + +=item -Debug + +enables debug output, i.e.: use Catalyst '-Debug'; -is equivalent to +this is equivalent to: use Catalyst; sub debug { 1 } -=head2 -Engine +=item -Engine Force Catalyst to use a specific engine. -Omit the Catalyst::Engine:: prefix. +Omit the C prefix of the engine name, i.e.: use Catalyst '-Engine=CGI'; -=head2 METHODS +=back + +=head1 METHODS + +=over 4 -=head3 debug +=item debug Overload to enable debug messages. @@ -108,78 +118,129 @@ Overload to enable debug messages. sub debug { 0 } -=head3 config +=item config Returns a hashref containing your applications settings. =cut -sub config { - my $self = shift; - $self->_config( {} ) unless $self->_config; - if ( $_[0] ) { - my $config = $_[1] ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$config ) { - $self->_config->{$key} = $val; - } - } - return $self->_config; -} - sub import { - my ( $self, @options ) = @_; + my ( $class, @arguments ) = @_; + + # We have to limit $class to Catalyst to avoid pushing Catalyst upon every + # callers @ISA. + return unless $class eq 'Catalyst'; + my $caller = caller(0); - # Class - { + unless ( $caller->isa('Catalyst') ) { no strict 'refs'; - *{"$caller\::handler"} = - sub { Catalyst::Engine::handler( $caller, @_ ) }; - push @{"$caller\::ISA"}, $self; + push @{"$caller\::ISA"}, $class; } - $self->log( Catalyst::Log->new ); - - # Options - my $engine = - $ENV{MOD_PERL} ? 'Catalyst::Engine::Apache' : 'Catalyst::Engine::CGI'; - foreach (@options) { - if (/^\-Debug$/) { - no warnings; - no strict 'refs'; - *{"$self\::debug"} = sub { 1 }; - $caller->log->debug('Debug messages enabled'); - } - elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" } - elsif (/^-.*$/) { $caller->log->error(qq/Unknown flag "$_"/) } - else { - my $plugin = "Catalyst::Plugin::$_"; - - # Plugin caller should be our application class - eval "package $caller; require $plugin"; - if ($@) { - $caller->log->error(qq/Couldn't load plugin "$plugin", "$@"/); - } - else { - $caller->log->debug(qq/Loaded plugin "$plugin"/) - if $caller->debug; - unshift @ISA, $plugin; - } - } + + $caller->arguments( [ @arguments ] ); + $caller->setup_home; +} + +=item $c->engine + +Contains the engine class. + +=item $c->log + +Contains the logging object. Unless it is already set Catalyst sets this up with a +C object. To use your own log class: + + $c->log( MyLogger->new ); + $c->log->info("now logging with my own logger!"); + +Your log class should implement the methods described in the C +man page. + +=item $c->plugin( $name, $class, @args ) + +Instant plugins for Catalyst. +Classdata accessor/mutator will be created, class loaded and instantiated. + + MyApp->plugin( 'prototype', 'HTML::Prototype' ); + + $c->prototype->define_javascript_functions; + +=cut + +sub plugin { + my ( $class, $name, $plugin, @args ) = @_; + $plugin->require; + + if ( my $error = $UNIVERSAL::require::ERROR ) { + Catalyst::Exception->throw( + message => qq/Couldn't load instant plugin "$plugin", "$error"/ + ); } - # Engine - $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}" - if $ENV{CATALYST_ENGINE}; - $engine->require; - die qq/Couldn't load engine "$engine", "$@"/ if $@; - push @ISA, $engine; - $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug; + eval { $plugin->import }; + $class->mk_classdata($name); + my $obj; + eval { $obj = $plugin->new(@args) }; + + if ( $@ ) { + Catalyst::Exception->throw( + message => qq/Couldn't instantiate instant plugin "$plugin", "$@"/ + ); + } + + $class->$name($obj); + $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) + if $class->debug; } +=back + +=head1 CASE SENSITIVITY + +By default Catalyst is not case sensitive, so C becomes +C. + +But you can activate case sensitivity with a config parameter. + + MyApp->config->{case_sensitive} = 1; + +=head1 LIMITATIONS + +mod_perl2 support is considered experimental and may contain bugs. + +=head1 SUPPORT + +IRC: + + Join #catalyst on irc.perl.org. + +Mailing-Lists: + + http://lists.rawmode.org/mailman/listinfo/catalyst + http://lists.rawmode.org/mailman/listinfo/catalyst-dev + +Web: + + http://catalyst.perl.org + =head1 SEE ALSO -L, L, L, -L, L +=over 4 + +=item L - The Catalyst Manual + +=item L - Core Engine + +=item L - The Log Class. + +=item L - The Request Object + +=item L - The Response Object + +=item L - The test suite. + +=back =head1 AUTHOR @@ -187,8 +248,11 @@ Sebastian Riedel, C =head1 THANK YOU -Danijel Milicevic, David Naughton, Gary Ashton Jones, Jesse Sheidlower, -Johan Lindstrom, Marcus Ramberg and all the others who've helped. +Andy Grundman, Andrew Ford, Andrew Ruthven, Autrijus Tang, Christian Hansen, +Christopher Hicks, Dan Sully, Danijel Milicevic, David Naughton, +Gary Ashton Jones, Geoff Richards, Jesse Sheidlower, Jody Belka, +Johan Lindstrom, Juan Camacho, Leon Brocard, Marcus Ramberg, +Tatsuhiko Miyagawa and all the others who've helped. =head1 LICENSE