X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FTutorial.pod;h=4b5084841015a7aa4bb81d6c0e5b537f7240a158;hb=4f4dac1f2c66aeaea0d05e100f550af669c56dcb;hp=dea503ea95f363832b29d399400de289f0290dfb;hpb=b460ad78a952bcaaa8f468d6e578c17002d0645b;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Manual/Tutorial.pod b/lib/Catalyst/Manual/Tutorial.pod
index dea503e..4b50848 100644
--- a/lib/Catalyst/Manual/Tutorial.pod
+++ b/lib/Catalyst/Manual/Tutorial.pod
@@ -1,317 +1,583 @@
 =head1 NAME
 
-Catalyst::Manual::Tutorial - Getting started with Catalyst
+Catalyst::Manual::Tutorial - Catalyst Tutorial: Overview
 
 =head1 DESCRIPTION
 
-This document aims to get you up and running with Catalyst.
+The Catalyst framework is a flexible and comprehensive environment for
+quickly building high-functionality web applications.  This tutorial is
+designed to provide a rapid introduction to its basics and its most
+commonly used features while focusing on real-world best practices.
 
-NOTE: THIS DOCUMENT IS STILL VERY MUCH IN AN EARLY DRAFT STATE.  SEE THE NOTES
-AT THE BOTTOM OF THE DOCUMENT.
+The tutorial is divided into the following sections:
 
+B<NOTE:> CLICK THESE LINKS TO JUMP TO CHAPTERS (the index links above
+only navigate inside this page).
 
+=over 4
 
-=head2 Installation
+=item *
 
-The first step is to install Catalyst, and the simplest way to do this is to
-install the Catalyst bundle from CPAN:
+L<Introduction|Catalyst::Manual::Tutorial::Intro>
 
-    $ perl -MCPAN -e 'install Bundle::Catalyst'
+=item * 
 
-This will retrieve Catalyst and a number of useful extensions and install them
-for you.
+L<Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics>
 
+=item * 
 
-=head2 Setting up your application
+L<Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD>
 
-Catalyst includes a helper script, C<catalyst.pl>, that will set up a skeleton
-application for you:
+=item * 
 
-    $ catalyst.pl My::App
-    created "My-App"
-    created "My-App/script"
-    created "My-App/lib"
-    created "My-App/root"
-    created "My-App/t"
-    created "My-App/t/m"
-    created "My-App/t/v"
-    created "My-App/t/c"
-    created "My-App/lib/My/App"
-    created "My-App/lib/My/App/M"
-    created "My-App/lib/My/App/V"
-    created "My-App/lib/My/App/C"
-    created "My-App/lib/My/App.pm"
-    created "My-App/Makefile.PL"
-    created "My-App/README"
-    created "My-App/Changes"
-    created "My-App/t/01app.t"
-    created "My-App/t/02podcoverage.t"
-    created "My-App/script/cgi.pl"
-    created "My-App/script/nph-cgi.pl"
-    created "My-App/script/fcgi.pl"
-    created "My-App/script/server.pl"
-    created "My-App/script/test.pl"
-    created "My-App/script/create.pl"
+L<Authentication|Catalyst::Manual::Tutorial::Authentication>
 
-This creates the directory structure shown, populated with skeleton files.
+=item * 
 
+L<Authorization|Catalyst::Manual::Tutorial::Authorization>
 
+=item * 
 
-=head2 Testing out the sample application
+L<Debugging|Catalyst::Manual::Tutorial::Debugging>
 
-You can test out your new application by running the server script that
-catalyst provides:
+=item *
 
-    $ cd My-App
-    $ script/server.pl 
-    [...] [catalyst] [debug] Debug messages enabled
-    [...] [catalyst] [debug] Loaded engine "Catalyst::Engine::CGI"
-    [...] [catalyst] [debug] Initialized components ""
-    [...] [catalyst] [info] My::App powered by Catalyst 4.26
-    [...] [catalyst] [debug] "My::App" defined "!default" as "CODE(0x83fd570)"
-    You can connect to your server at http://localhost:3000
+L<Testing|Catalyst::Manual::Tutorial::Testing>
 
-(Note that each line logged by Catalyst includes a timestamp, which has been
-replaced here with "C<...>" so that the text fits onto the lines.)
+=item * 
 
-The server is now waiting for you to make requests of it.  Try using telnet to
-manually make a simple GET request of the server (when telnet responds with
-"Escape character is '^]'.", type "GET / HTTP/1.0" and hit return twice):
+L<Advanced CRUD|Catalyst::Manual::Tutorial::AdvancedCRUD>
 
-    $ telnet localhost 3000
-    Trying 127.0.0.1...
-    Connected to localhost.
-    Escape character is '^]'.
-    GET / HTTP/1.0
-    
-    HTTP/1.0 200
-    Server: Catalyst/4.26
-    Status: 200
-    Date: Sun, 20 Mar 2005 12:31:55 GMT
-    X-catalyst: 4.26
-    Content-length: 40
-    Content-Type: text/html; charset=ISO-8859-1
+=item * 
 
-    Congratulations, My::App is on Catalyst!
-    Connection closed by foreign host.
-    $
+L<Appendices|Catalyst::Manual::Tutorial::Appendices>
 
-More trace messages will appear in the original terminal window:
+=back
 
-    [...] [catalyst] [debug] ********************************
-    [...] [catalyst] [debug] * Request 1 (0.027/s) [9818]
-    [...] [catalyst] [debug] ********************************
-    [...] [catalyst] [debug] "GET" request for ""
-    [...] [catalyst] [debug] Using default action
-    [...] [catalyst] [info] Processing "!default" took 0.000033s
-    [...] [catalyst] [info] Request took 0.051399s (19.456/s)
+A tarball of the final application is available at
+L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/Final_Tarball/MyApp.tgz>.
 
-The server will continue running until you interrupt it.
 
-The application can also be tested from the command line using the generated
-helper script, C<script/test.pl>.
+=head1 Detailed Table Of Contents
 
+=head2 L<Part 1: Introduction|Catalyst::Manual::Tutorial::Intro>
 
-=head2 Getting your application invoked
+=over 4
 
-Catalyst applications are usually run from mod_perl, but can also be run as
-CGI or FastCGI scripts.  Running under mod_perl gives better performance, but
-for development purposes you may want to run your application as a CGI script,
-especially as changes to your application code take effect under CGI without
-having to restart the web server.
+=item *
 
-To run from mod_perl you need to add something like this to your Apache
-configuration file:
+VERSIONS AND CONVENTIONS USED IN THIS TUTORIAL
 
-    <Location /my-app>
-        SetHandler  perl-script
-        PerlHandler My::App
-    </Location>
+=item *
 
-To run as a CGI script you need a wrapper script like:
+CATALYST INSTALLATION
 
-    #!/usr/bin/perl -w
+=item *
 
-    use strict;
-    use lib '/path/to/My/App/lib';
-    use My::App;
+DATABASES
 
-    My::App->run;
+=item *
 
-Catalyst outputs a complete HTTP response, which is not what is expected of a
-CGI script.  You need to configure the script as a so-called "Non-parsed
-Headers" script for it to function properly.  To do this in Apache just name
-the script starting with C<nph->.
+WHERE TO GET WORKING CODE
 
-CHECK: is this statement still valid for Cat5?
+=back
 
 
-=head2 Examining the generated code
+=head2 L<Part 2: Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics>
 
-The generated application code is quite simple and looks something like this:
+=over 4
 
-    package My::App;
+=item *
 
-    use strict;
-    use Catalyst qw/-Debug/;
+CREATE A CATALYST PROJECT
 
-    our $VERSION = '0.01';
+=item *
 
-    My::App->config(
-	name => 'My::App',
-	root => '/home/andrew/My-App/root',
-    );
+CREATE A SQLITE DATABASE
 
-    My::App->action(
-	'!default' => sub {
-	    my ( $self, $c ) = @_;
-	    $c->res->output('Congratulations, My::App is on Catalyst!');
-	},
-    );
+=item *
 
-    1;
+EDIT THE LIST OF CATALYST PLUGINS
 
+=item *
 
-When the C<Catalyst> module is imported by the application code, Catalyst
-performs the first stage of its initialization.  This includes loading the
-appropriate Engine module for the environment in which the application is
-running, loading any plugins and ensuring that the calling module (the
-application module) inherits from C<Catalyst> (which makes the Catalyst
-methods C<config> and C<action> available to the application module).
+DATABASE ACCESS WITH DBIx::Class
 
-The call to C<config> sets up configuration data for the application.  The
-C<name> and C<root> items are the minimum required, and specify the name of
-the application and the path to the root directory where documents, images and
-templates can be found.
 
-Catalyst associates I<actions> with URLs and on receiving a request dispatches
-to the action that matches to request URL.  The call to C<action> in the code
-above registers a default action.  With just this action registered the
-application will respond to all requests with the same message
-"Congratulations, My::App is on Catalyst!".
+=over 4
 
-TODO: mention private actions and attributes
+=item *
 
+Create a DBIC Schema File
 
-The first call to the C<action> method triggers the second stage of Catalyst's
-initialization process.  In this phase Catalyst searches for any component
-modules, locating and registering any actions it finds in those modules.
-Component modules have names prefixed with the application module name,
-followed by C<Model>, C<View> or C<Controller> (or the alternative short
-forms: C<M>, C<V> or C<C>) followed by the component name, for example:
+=item *
 
-    My::App::Controller::ShoppingCart
+Create the DBIC ``Result Source'' Files
 
+=item *
 
+Use Catalyst::Model::DBIC::Schema to Load the Model Class
 
+=back
 
-=head2 Extending the generated code
 
-NOTE: this section is outdated by Cat5.
+=item *
 
-You can start extending the application by adding new actions:
+CREATE A CATALYST CONTROLLER
 
-    My::App->action(
-        'test1' => sub {
-	    my ( $self, $c ) = @_;
-	    $c->res->output('In a new test action #1');
-	},
-        'test1' => sub {
-	    my ( $self, $c ) = @_;
-	    $c->res->output('In a new test action #1');
-	},
-	'!default' => sub {
-	    my ( $self, $c ) = @_;
-	    $c->res->output('Congratulations, My::App is on Catalyst!');
-	},
-    );
+=item *
 
+CATALYST VIEWS
 
-TODO: explain briefly about plugins, actions and components
 
-regex actions passed subexpression matches in $c->req->snippets (array ref).
+=over 4
 
+=item *
 
-=head2 Hooking in to Template Toolkit
+Create a Catalyst View Using TTSite
 
-One of the first things you will probably want to add to your application is a
-templating system for generating your output.  Catalyst works well with
-Template Toolkit.  If you are unfamiliar with Template Toolkit then I suggest
-you look at L<http://tt2.org>, install C<Template>, read the documentation and
-play around with it, and have a look at the I<Badger Book> (I<Template
-Toolkit> by Darren Chamberlain, Dave Cross and Andy Wardly, O'Reilly &
-Associates, 2004).
+=item *
 
-You can create a stub Template Toolkit view component using the create script
-that Catalyst set up as part of the skeleton application:
+Using RenderView for the Default View
 
-    $ script/create.pl view TT TT
+=item *
 
-this generates a view component named C<My::App::View::TT>, which you might
-use by forwarding from your C<end> action:
+Globally Customize Every View
 
-    # In My::App or My::App::Controller::SomeController
+=item *
 
-    sub end : Private {
-        my($self, $c) = @_;
-        $c->forward('My::App::View::TT');
-    }
+Create a TT Template Page
 
-The generated TT view component simply subclasses the C<Catalyst::View::TT>
-class.  It looks like this (with the POD stripped out):
+=back
 
-    package My::App::V::TT;
 
-    use strict;
-    use base 'Catalyst::View::TT';
+=item *
 
-    1;
+RUN THE APPLICATION
 
-C<Catalyst::View::TT> initializes a Template Toolkit object with an options
-hash initialized with built-in default settings followed by the contents of
-the hash C<<%{__PACKAGE__->config()}>>.  You can configure TT more to your
-needs by adding a C<new> method to the generated TT component:
+=back
 
-    sub new {
-	my $self = shift;
-	$self->config->{PRE_PROCESS} = 'config/main';
-	$self->config->{WRAPPER}     = 'site/wrapper';
-	return $self->SUPER::new(@_);
-    }
+=head2 L<Part 3: Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD>
 
+=over 4
 
+=item *
 
-=head1 AUTHOR
+FORMLESS SUBMISSION
+
+=over 4
+
+=item *
+
+Include a Create Action in the Books Controller
+
+=item *
+
+Include a Template for the url_create Action:
+
+=item *
+
+Try the url_create Feature
+
+=back
+
+=item *
+
+MANUALLY BUILDING A CREATE FORM
+
+=over 4
+
+=item *
+
+Add a Method to Display the Form
+
+=item *
+
+Add a Template for the Form
+
+=item *
+
+Add Method to Process Form Values and Update Database
+
+=item *
+
+Test Out the Form
+
+=back
+
+=item *
+
+A SIMPLE DELETE FEATURE
+
+=over 4
+
+=item *
+
+Include a Delete Link in the List
+
+=item *
+
+Add a Delete Action to the Controller
+
+=item *
+
+Try the Delete Feature
+
+=back
+
+=back
+
+=head2 L<Part 4: Authentication|Catalyst::Manual::Tutorial::Authentication>
+
+=over 4
+
+=item *
+
+BASIC AUTHENTICATION
+
+=over 4
+
+=item *
+
+Add Users and Roles to the Database
 
-Andrew Ford, C<A.Ford@ford-mason.co.uk>
+=item *
 
-As noted above, this document is at an alpha stage.  My plan for this document
-is as follows:
+Add User and Role Information to DBIC Schema
+
+=item *
+
+Create New ``Result Source Objects''
+
+=item *
+
+Sanity-Check Reload of Development Server
+
+=item *
+
+Include Authentication and Session Plugins
+
+=item *
+
+Configure Authentication
+
+=item *
+
+Add Login and Logout Controllers
+
+=item *
+
+Add a Login Form TT Template Page
+
+=item *
+
+Add Valid User Check
+
+=item *
+
+Displaying Content Only to Authenticated Users
+
+=item *
+
+Try Out Authentication
+
+=back
+
+=item *
+
+USING PASSWORD HASHES
 
 =over 4
 
-=item 1
+=item *
+
+Get a SHA-1 Hash for the Password
 
-expand this document fairly rapidly to cover topics relevant to
-a newcomer to Catalyst in an order that can be read sequentially
+=item *
 
-=item 2
+Switch to SHA-1 Password Hashes in the Database
 
-incorporate feedback 
+=item *
+
+Enable SHA-1 Hash Passwords in Catalyst::Plugin::Authentication::Store::DBIC
+
+=item *
+
+Try Out the Hashed Passwords
+
+=back
+
+=back
 
-=item 3
+=head2 L<Part 5: Authorization|Catalyst::Manual::Tutorial::Authorization>
 
-revise the text 
+=over 4
+
+=item *
+
+BASIC AUTHORIZATION
+
+=over 4
+
+=item *
+
+Update Plugins to Include Support for Authorization
+
+=item *
+
+Add Config Information for Authorization
+
+=item *
+
+Add Role-Specific Logic to the ``Book List'' Template
+
+=item *
+
+Limit Books::add to admin Users
+
+=item *
+
+Try Out Authentication And Authorization
+
+=back
+
+=item *
+
+ENABLE ACL-BASED AUTHORIZATION
+
+=over 4
+
+=item *
+
+Add the Catalyst::Plugin::Authorization::ACL Plugin
+
+=item *
+
+Add ACL Rules to the Application Class
+
+=item *
+
+Add a Method to Handle Access Violations
+
+=back
 
 =back
 
-Placeholders are indicated by the words: TODO or CHECK 
+=head2 L<Part 6: Debugging|Catalyst::Manual::Tutorial::Debugging>
 
-Please send comments, corrections and suggestions for improvements to
-A.Ford@ford-mason.co.uk
+=over 4
+
+=item *
+
+LOG STATEMENTS
+
+=item *
+
+RUNNING CATALYST UNDER THE PERL DEBUGGER
+
+=item *
+
+DEBUGGING MODULES FROM CPAN
+
+=back
+
+=head2 L<Part 7: Testing|Catalyst::Manual::Tutorial::Testing>
+
+=over 4
+
+=item *
+
+RUNNING THE "CANNED" CATALYST TESTS
+
+=item *
+
+RUNNING A SINGLE TEST
+
+=item *
+
+ADDING YOUR OWN TEST SCRIPT
+
+=item *
+
+SUPPORTING BOTH PRODUCTION AND TEST DATABASES
+
+=back
+
+=head2 L<Part 8: Advanced CRUD|Catalyst::Manual::Tutorial::AdvancedCRUD>
+
+=over 4
+
+=item *
+
+HTML::WIDGET FORM CREATION
+
+=over 4
+
+=item *
+
+Add the HTML::Widget Plugin
+
+=item *
+
+Add a Form Creation Helper Method
+
+=item *
+
+Add Actions to Display and Save the Form
+
+=item *
+
+Update the CSS
+
+=item *
+
+Create a Template Page To Display The Form
+
+=item *
+
+Add Links for Create and Update via HTML::Widget
+
+=item *
+
+Test The <HTML::Widget> Create Form
+
+=back
+
+=item *
+
+HTML::WIDGET VALIDATION AND FILTERING
+
+=over 4
+
+=item *
+
+Add Constraints and Filters to the Widget Creation Method
+
+=item *
+
+Rebuild the Form Submission Method to Include Validation
+
+=item *
+
+Try Out the Form
+
+=back
+
+=item *
+
+Enable DBIx::Class::HTMLWidget Support
+
+=over 4
+
+=item *
+
+Add DBIx::Class::HTMLWidget to DBIC Model
+
+=item *
+
+Use populate_from_widget in hw_create_do
+
+=back
+
+=back
+
+=head2 L<Part 9: Appendices|Catalyst::Manual::Tutorial::Appendices>
+
+=over 4
+
+=item *
+
+APPENDIX 1: CUT AND PASTE FOR POD-BASED EXAMPLES
+
+=over 4
+
+=item *
+
+"Un-indenting" with Vi/Vim
+
+=item *
+
+"Un-indenting" with Emacs
+
+=back
+
+=item *
+
+APPENDIX 2: USING MYSQL AND POSTGRESQL
+
+=over 4
+
+=item *
+
+MySQL
+
+=item *
+
+PostgreSQL
+
+=back
+
+=item *
+
+APPENDIX 3: IMPROVED HASHING SCRIPT
+
+=back
+
+
+=head1 THANKS
+
+This tutorial would not have been possible without the input of many 
+different people in the Catalyst community.  In particular, the 
+primary author would like to thank:
+
+=over 4
+
+=item *
+
+Sebastian Riedel for founding the Catalyst project.
+
+=item *
+
+The members of the Catalyst Core Team for their tireless efforts to
+advance the Catalyst project.  Although all of the Core Team members
+have played a key role in this tutorial, it would have never been
+possible without the critical contributions of: Matt Trout, for his
+unfathomable knowledge of all things Perl and Catalyst (and his
+willingness to answer lots of my questions); Jesse Sheidlower, for his
+incredible skill with the written word and dedication to improving the
+Catalyst documentation; and Yuval Kogman, for his work on the Catalyst
+"Auth & Authz" plugins (the original focus of the tutorial) and other
+key Catalyst modules.
+
+=item *
+
+Other Catalyst documentation folks like Kieren Diment, Gavin Henry,
+and Jess Robinson (including their work on the original Catalyst
+tutorial).
+
+=item *
+
+Everyone on #catalyst and #catalyst-dev.
+
+=item *
+
+People who have emailed me with corrections and suggestions on the 
+tutorial.  As of the most recent release, this include: Florian Ragwitz, 
+Mauro Andreolini, Jim Howard, Giovanni Gigante, William Moreno,  
+Bryan Roach, Ashley Berlin, David Kamholz, Kevin Old, Henning Sprang,
+and Jeremy Jones.  
+
+=back
+
+
+
+=head1 AUTHOR
 
+Kennedy Clark, C<hkclark@gmail.com>
 
-=head1 COPYRIGHT
+Please report any errors, issues or suggestions to the author.  The
+most recent version of the Catalyst Tutorial can be found at
+L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst-Runtime/lib/Catalyst/Manual/Tutorial/>.
 
-This program is free software, you can redistribute it and/or modify it under
-the same terms as Perl itself.
+Copyright 2006, Kennedy Clark, under Creative Commons License
+(L<http://creativecommons.org/licenses/by-nc-sa/2.5/>).