incorporated static discussion from andyg into Cookbook.pod
[catagits/Catalyst-Runtime.git] / lib / Catalyst.pm
index f0638c1..2c6ca19 100644 (file)
@@ -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.33';
+our $VERSION = '5.31';
 our @ISA;
 
 =head1 NAME
@@ -21,15 +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
+    script/myapp_test.pl /yada
 
 
     use Catalyst;
@@ -40,37 +46,30 @@ 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<Catalyst::Manual::Intro>
 
 =head1 DESCRIPTION
 
-Catalyst is based upon L<Maypole>, which you should consider for smaller
-projects.
-
 The key concept of Catalyst is DRY (Don't Repeat Yourself).
 
 See L<Catalyst::Manual> for more documentation.
 
 Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement.
-Omit the C<Catalyst::Plugin::> prefix from the plugin name, 
+Omit the C<Catalyst::Plugin::> prefix from the plugin name,
 so C<Catalyst::Plugin::My::Module> becomes C<My::Module>.
 
     use Catalyst 'My::Module';
@@ -125,77 +124,27 @@ 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, @_ ) };
-
-        unless ( $caller->isa($self) ) {
-            push @{"$caller\::ISA"}, $self;
-        }
+        push @{"$caller\::ISA"}, $class;
     }
 
-    unless ( $caller->log ) {
-        $caller->log( Catalyst::Log->new );
-    }
+    $caller->arguments( [ @arguments ] );
+    $caller->setup_home;
+}
 
-    # Options
-    my $engine =
-      $ENV{MOD_PERL} ? 'Catalyst::Engine::Apache' : 'Catalyst::Engine::CGI';
-    foreach (@options) {
-        if (/^\-Debug$/) {
-            no warnings;
-            no strict 'refs';
-            *{"$caller\::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;
-                no strict 'refs';
-                push @{"$caller\::ISA"}, $plugin;
-            }
-        }
-    }
+=item $c->engine
 
-    # Engine
-    $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}"
-      if $ENV{CATALYST_ENGINE};
-    $engine->require;
-    die qq/Couldn't load engine "$engine", "$@"/ if $@;
-    {
-        no strict 'refs';
-        push @{"$caller\::ISA"}, $engine;
-    }
-    $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug;
-}
+Contains the engine class.
 
 =item $c->log
 
@@ -208,9 +157,58 @@ C<Catalyst::Log> object.  To use your own log class:
 Your log class should implement the methods described in the C<Catalyst::Log>
 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"/
+        );
+    }
+
+    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<MyApp::C::FOO::Bar> becomes
+C</foo/bar>.
+
+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:
@@ -221,11 +219,28 @@ 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<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
-L<Catalyst::Response>, L<Catalyst::Engine>
+=over 4
+
+=item L<Catalyst::Manual> - The Catalyst Manual
+
+=item L<Catalyst::Engine> - Core Engine
+
+=item L<Catalyst::Log> - The Log Class.
+
+=item L<Catalyst::Request> - The Request Object
+
+=item L<Catalyst::Response> - The Response Object
+
+=item L<Catalyst::Test> - The test suite.
+
+=back
 
 =head1 AUTHOR
 
@@ -233,10 +248,11 @@ Sebastian Riedel, C<sri@oook.de>
 
 =head1 THANK YOU
 
-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.
+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