X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=2bba938353dba0defcec99c0cbc627685ab4f58a;hp=e49736fa3f4862b1fb23c93e8634a07a2895c317;hb=1927c219b552ac80dff59c235a51d422ac5b9d25;hpb=d7c505f31a1c555f2cc3bee7ddfb550a808cd091 diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index e49736f..2bba938 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,13 +1,15 @@ package Catalyst; use strict; -use base 'Class::Data::Inheritable'; +use base 'Catalyst::Base'; use UNIVERSAL::require; use Catalyst::Log; +use Text::ASCIITable; +use Text::ASCIITable::Wrap 'wrap'; -__PACKAGE__->mk_classdata($_) for qw/_config log/; +__PACKAGE__->mk_classdata($_) for qw/engine log/; -our $VERSION = '4.01'; +our $VERSION = '5.00'; our @ISA; =head1 NAME @@ -17,22 +19,19 @@ Catalyst - The Elegant MVC Web Application Framework =head1 SYNOPSIS # use the helper to start a new application - catalyst MyApp + catalyst.pl MyApp cd MyApp # add models, views, controllers - bin/create model Something - bin/create view Stuff - bin/create controller Yada + script/create.pl model Something + script/create.pl view Stuff + script/create.pl controller Yada # built in testserver - bin/server + script/server.pl # command line interface - bin/test /yada - - - See also L + script/test.pl /yada use Catalyst; @@ -43,23 +42,21 @@ 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]; + } + +See also L =head1 DESCRIPTION @@ -70,37 +67,49 @@ 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. -=head2 -Debug +The following flags are supported: + +=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 -=head3 debug +=head1 METHODS + +=over 4 + +=item debug Overload to enable debug messages. @@ -108,45 +117,55 @@ 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 $caller = caller(0); - # Class - { + unless ( $caller->isa($self) ) { no strict 'refs'; - *{"$caller\::handler"} = - sub { Catalyst::Engine::handler( $caller, @_ ) }; push @{"$caller\::ISA"}, $self; } - $self->log( Catalyst::Log->new ); - # Options - my $engine = - $ENV{MOD_PERL} ? 'Catalyst::Engine::Apache' : 'Catalyst::Engine::CGI'; + if ( $caller->engine ) { + return; # Catalyst is allready initialized + } + + unless ( $caller->log ) { + $caller->log( Catalyst::Log->new ); + } + + if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($caller) . '_DEBUG' } ) { + no strict 'refs'; + *{"$caller\::debug"} = sub { 1 }; + $caller->log->debug('Debug messages enabled'); + } + + my $engine = 'Catalyst::Engine::CGI'; + + if ( $ENV{MOD_PERL} ) { + + require mod_perl; + + if ( $mod_perl::VERSION >= 1.99 ) { + $engine = 'Catalyst::Engine::Apache::MP2'; + } + else { + $engine = 'Catalyst::Engine::Apache::MP1'; + } + } + + my @plugins; foreach (@options) { if (/^\-Debug$/) { - no warnings; + next if $caller->debug; no strict 'refs'; - *{"$self\::debug"} = sub { 1 }; + *{"$caller\::debug"} = sub { 1 }; $caller->log->debug('Debug messages enabled'); } elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" } @@ -154,28 +173,68 @@ sub import { else { my $plugin = "Catalyst::Plugin::$_"; - # Plugin caller should be our application class - eval "package $caller; require $plugin"; + $plugin->require; + if ($@) { $caller->log->error(qq/Couldn't load plugin "$plugin", "$@"/); } else { - $caller->log->debug(qq/Loaded plugin "$plugin"/) - if $caller->debug; - unshift @ISA, $plugin; + push @plugins, $plugin; + no strict 'refs'; + push @{"$caller\::ISA"}, $plugin; } } } + my $t = Text::ASCIITable->new( { hide_HeadRow => 1, hide_HeadLine => 1 } ); + $t->setCols('Class'); + $t->setColWidth( 'Class', 75, 1 ); + $t->addRow( wrap( $_, 75 ) ) for @plugins; + $caller->log->debug( 'Loaded plugins', $t->draw ) + if ( @plugins && $caller->debug ); # Engine $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}" if $ENV{CATALYST_ENGINE}; + $engine->require; die qq/Couldn't load engine "$engine", "$@"/ if $@; - push @ISA, $engine; + { + no strict 'refs'; + push @{"$caller\::ISA"}, $engine; + } + $caller->engine($engine); $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug; } +=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. + + +=back + +=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 + =head1 SEE ALSO L, L, L, @@ -187,8 +246,10 @@ 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. +Andrew Ford, Andrew Ruthven, Christian Hansen, Christopher Hicks, +Dan Sully, Danijel Milicevic, David Naughton, Gary Ashton Jones, +Jesse Sheidlower, Johan Lindstrom, Marcus Ramberg, Tatsuhiko Miyagawa +and all the others who've helped. =head1 LICENSE