Commit | Line | Data |
d442cc9f |
1 | =head1 NAME |
2 | |
3 | Catalyst::Manual::Tutorial::Intro - Catalyst Tutorial - Part 1: Introduction |
4 | |
5 | |
6 | =head1 OVERVIEW |
7 | |
3533daff |
8 | This is B<Part 2 of 10> for the Catalyst tutorial. |
d442cc9f |
9 | |
10 | L<Tutorial Overview|Catalyst::Manual::Tutorial> |
11 | |
12 | =over 4 |
13 | |
14 | =item 1 |
15 | |
16 | B<Introduction> |
17 | |
18 | =item 2 |
19 | |
20 | L<Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics> |
21 | |
22 | =item 3 |
23 | |
1def4a20 |
24 | L<More Catalyst Basics|Catalyst::Manual::Tutorial::MoreCatalystBasics> |
d442cc9f |
25 | |
26 | =item 4 |
27 | |
1def4a20 |
28 | L<Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD> |
d442cc9f |
29 | |
30 | =item 5 |
31 | |
1def4a20 |
32 | L<Authentication|Catalyst::Manual::Tutorial::Authentication> |
d442cc9f |
33 | |
34 | =item 6 |
35 | |
1def4a20 |
36 | L<Authorization|Catalyst::Manual::Tutorial::Authorization> |
d442cc9f |
37 | |
38 | =item 7 |
39 | |
1def4a20 |
40 | L<Debugging|Catalyst::Manual::Tutorial::Debugging> |
d442cc9f |
41 | |
42 | =item 8 |
43 | |
1def4a20 |
44 | L<Testing|Catalyst::Manual::Tutorial::Testing> |
d442cc9f |
45 | |
46 | =item 9 |
47 | |
1def4a20 |
48 | L<Advanced CRUD|Catalyst::Manual::Tutorial::AdvancedCRUD> |
49 | |
50 | =item 10 |
51 | |
d442cc9f |
52 | L<Appendices|Catalyst::Manual::Tutorial::Appendices> |
53 | |
54 | =back |
55 | |
1def4a20 |
56 | |
d442cc9f |
57 | =head1 DESCRIPTION |
58 | |
59 | This tutorial provides a multipart introduction to the Catalyst web |
60 | framework. It seeks to provide a rapid overview of many of its most |
61 | commonly used features. The focus is on the real-world best practices |
62 | required in the construction of nearly all Catalyst applications. |
63 | |
64 | Although the primary target of the tutorial is users new to the Catalyst |
65 | framework, experienced users may wish to review specific sections (for |
1def4a20 |
66 | example, how to use DBIC for their model classes, how to add |
67 | authentication and authorization to an existing application, or form |
68 | management). |
d442cc9f |
69 | |
70 | You can obtain the code for all the tutorial examples from the |
71 | catalyst subversion repository by issuing the command: |
72 | |
73 | svn co http://dev.catalyst.perl.org/repos/Catalyst/tags/examples/Tutorial/MyApp/5.7/ CatalystTutorial |
74 | |
75 | This will download the current code for each tutorial chapter in the |
76 | CatalystTutorial directory. Each example application directory has |
77 | the same name as the tutorial chapter. |
78 | |
3d9ae335 |
79 | B<These reference implementations are provided so that when you follow |
80 | the tutorial, you can use the code from the subversion repository to |
81 | ensure that your system is set up correctly, and that you have not |
82 | inadvertently made any typographic errors, or accidentally skipped |
83 | part of the tutorial.> |
84 | |
3533daff |
85 | B<NOTE: You can use any perl-supported OS and environment to run |
86 | Catalyst.> It should make little or no difference to Catalyst's |
87 | operation, but this tutorial has been written using Ubuntu 8.04 |
88 | because that represents a quick and easy for most people to try out |
89 | Catalyst with virtually zero setup time and hassles. See the Catalyst |
90 | installation section below for more information. |
91 | |
92 | If you're reading this manual online, you can download the example |
93 | program and all the necessary dependencies to your local machine by |
94 | installing the C<Task::Catalyst::Tutorial> distribution from CPAN: |
d442cc9f |
95 | |
96 | cpan Task::Catalyst::Tutorial |
97 | |
98 | This will also test to make sure the dependencies are working. If you |
99 | have trouble installing these, please ask for help on the #catalyst |
100 | IRC channel, or the Catalyst mailing list. |
101 | |
3533daff |
102 | Subjects covered by the tutorial include: |
d442cc9f |
103 | |
104 | =over 4 |
105 | |
106 | =item * |
107 | |
108 | A simple application that lists and adds books. |
109 | |
110 | =item * |
111 | |
112 | The use of L<DBIx::Class|DBIx::Class> (DBIC) for the model. |
113 | |
114 | =item * |
115 | |
116 | How to write CRUD (Create, Read, Update, and Delete) operations in |
117 | Catalyst. |
118 | |
119 | =item * |
120 | |
121 | Authentication ("auth"). |
122 | |
123 | =item * |
124 | |
125 | Role-based authorization ("authz"). |
126 | |
127 | =item * |
128 | |
129 | Attempts to provide an example showing current (5.7XXX) Catalyst |
130 | practices. For example, the use of |
131 | L<Catalyst::Action::RenderView|Catalyst::Action::RenderView>, |
132 | DBIC, L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader> |
133 | with C<myapp.yml>, the use of C<lib/MyApp/Controller/Root.pm> |
134 | vs. C<lib/MyApp.pm>, etc. |
135 | |
136 | =item * |
137 | |
138 | The use of Template Toolkit (TT) and the |
139 | L<Catalyst::Helper::View::TTSite|Catalyst::Helper::View::TTSite> |
140 | view helper. |
141 | |
142 | =item * |
143 | |
144 | Useful techniques for troubleshooting and debugging Catalyst |
145 | applications. |
146 | |
147 | =item * |
148 | |
149 | The use of SQLite as a database (with code also provided for MySQL and |
150 | PostgreSQL). |
151 | |
152 | =item * |
153 | |
1def4a20 |
154 | The use of L<HTML::FormFu|HTML::FormFu> for automated form processing |
d442cc9f |
155 | and validation. |
156 | |
157 | =back |
158 | |
159 | This tutorial makes the learning process its main priority. For |
160 | example, the level of comments in the code found here would likely be |
1def4a20 |
161 | considered excessive in a "normal project." Because of their contextual |
d442cc9f |
162 | value, this tutorial will generally favor inline comments over a |
163 | separate discussion in the text. It also deliberately tries to |
164 | demonstrate multiple approaches to various features (in general, you |
165 | should try to be as consistent as possible with your own production |
166 | code). |
167 | |
168 | Furthermore, this tutorial tries to minimize the number of controllers, |
169 | models, TT templates, and database tables. Although this does result in |
170 | things being a bit contrived at times, the concepts should be applicable |
171 | to more complex environments. More complete and complicated example |
172 | applications can be found in the C<examples> area of the Catalyst |
173 | Subversion repository at |
174 | L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/>. |
175 | |
176 | B<Note:> There are a variety of other introductory materials available |
177 | through the Catalyst web site and at |
178 | L<http://dev.catalyst.perl.org/wiki/UserIntroductions> and |
179 | L<http://dev.catalyst.perl.org/>. |
180 | |
181 | =head1 VERSIONS AND CONVENTIONS USED IN THIS TUTORIAL |
182 | |
183 | This tutorial was built using the following resources. Please note that |
184 | you may need to make adjustments for different environments and |
185 | versions: |
186 | |
187 | =over 4 |
188 | |
189 | =item * |
190 | |
1def4a20 |
191 | Ubuntu 8.04 Hardy Heron |
d442cc9f |
192 | |
193 | =item * |
194 | |
1def4a20 |
195 | Catalyst v5.7011 |
dd88c3b6 |
196 | |
22a67212 |
197 | =item * |
dd88c3b6 |
198 | |
1def4a20 |
199 | Catalyst::Devel v1.03 |
d442cc9f |
200 | |
201 | =item * |
202 | |
1def4a20 |
203 | DBIx::Class v0.08008 |
d442cc9f |
204 | |
205 | =item * |
206 | |
207 | Catalyst Plugins |
208 | |
209 | The plugins used in this tutorial all have sufficiently stable APIs that |
210 | you shouldn't need to worry about versions. However, there could be |
211 | cases where the tutorial is affected by what version of plugins you |
212 | use. This tutorial has been tested against the following set of plugins: |
213 | |
214 | =over 4 |
215 | |
216 | =item * |
217 | |
1def4a20 |
218 | Catalyst::Plugin::Authentication -- v0.10002 |
d442cc9f |
219 | |
220 | =item * |
221 | |
1def4a20 |
222 | Catalyst::Plugin::Authentication::Store::DBIC -- v0.09 |
d442cc9f |
223 | |
224 | =item * |
225 | |
1def4a20 |
226 | Catalyst::Plugin::Authorization::ACL -- v0.08 |
d442cc9f |
227 | |
228 | =item * |
229 | |
1def4a20 |
230 | Catalyst::Plugin::Authorization::Roles -- v0.05 |
d442cc9f |
231 | |
232 | =item * |
233 | |
1def4a20 |
234 | Catalyst::Plugin::ConfigLoader -- v0.17 |
d442cc9f |
235 | |
236 | =item * |
237 | |
1def4a20 |
238 | Catalyst::Plugin::Session -- v0.18 |
d442cc9f |
239 | |
240 | =item * |
241 | |
1def4a20 |
242 | Catalyst::Plugin::Session::State::Cookie -- v0.08 |
d442cc9f |
243 | |
244 | =item * |
245 | |
1def4a20 |
246 | Catalyst::Plugin::Session::Store::FastMmap -- v0.03 |
d442cc9f |
247 | |
248 | =item * |
249 | |
1def4a20 |
250 | Catalyst::Plugin::StackTrace -- v0.06 |
d442cc9f |
251 | |
252 | =item * |
253 | |
1def4a20 |
254 | Catalyst::Plugin::Static::Simple -- v0.20 |
d442cc9f |
255 | |
256 | =back |
257 | |
258 | =item * |
259 | |
260 | Since the web browser is being used on the same box where Perl and the |
261 | Catalyst development server is running, the URL of |
262 | C<http://localhost:3000> will be used (the Catalyst development server |
263 | defaults to port 3000). If you are running Perl on a different box than |
264 | where your web browser is located (or using a different port number via |
265 | the C<-p> I<port_number> option to the development server), then you |
266 | will need to update the URL you use accordingly. |
267 | |
268 | =item * |
269 | |
270 | Depending on the web browser you are using, you might need to hit |
271 | C<Shift+Reload> to pull a fresh page when testing your application at |
272 | various points. Also, the C<-k> keepalive option to the development |
273 | server can be necessary with some browsers (especially Internet |
274 | Explorer). |
275 | |
276 | =back |
277 | |
278 | =head1 CATALYST INSTALLATION |
279 | |
1def4a20 |
280 | If approach in the wrong manner, it can be a daunting tasks to get |
3533daff |
281 | Catalyst initially installed. Although a compelling strength of |
1def4a20 |
282 | Catalyst is that it makes use of many of the modules in the |
283 | vast repository that is CPAN, this can complicate the installation |
284 | process. However, there are a growing number of methods |
285 | that can dramatically ease this undertaking. Of these, the following |
286 | are likely to be applicable to the largest number of potential new |
287 | users: |
288 | |
289 | =over 4 |
290 | |
291 | =item * |
292 | |
293 | Ubuntu |
294 | |
295 | Given the popularity of Ubuntu and it's ease of use, Ubuntu can be |
296 | a great way for newcomers to experiment with Catalyst. Because it |
297 | is a "live CD," you can simply boot from the CD, run a few commands, |
298 | and you should have a fully functional environment in which to do |
299 | this tutorial in a matter of minutes. |
d442cc9f |
300 | |
301 | =over 4 |
302 | |
303 | =item * |
304 | |
3533daff |
305 | Download Ubuntu 8.04 (aka, Hardy Heron) Desktop edition and boot from |
306 | the CD and/or image file, select your language, and then "Try Ubuntu |
307 | without any changes to your computer." |
1def4a20 |
308 | |
309 | =item * |
310 | |
3533daff |
311 | Open a terminal session (click "Applications" in the upper-left |
312 | corner, then "Accessories," then "Terminal"). |
1def4a20 |
313 | |
314 | =item * |
315 | |
316 | Add the 'universe' repositories: |
317 | |
3533daff |
318 | sudo gedit /etc/apt/sources.list |
1def4a20 |
319 | |
320 | And remove the comments from the lines under the comments about the |
321 | 'universe' repositories. |
322 | |
323 | =item * |
324 | |
325 | Install Catalyst: |
326 | |
327 | sudo apt-get update |
3533daff |
328 | sudo apt-get install libdbd-sqlite3-perl libcatalyst-perl libcatalyst-modules-perl |
1def4a20 |
329 | |
330 | Accept all of the dependencies. Done. |
331 | |
3533daff |
332 | NOTE: If you are low on disk space after the above commands (use C<df /> |
333 | to tell), you can free up some space with |
334 | C<sudo rm /var/cache/apt/archives/*.deb> (the Live CD uses memory for |
335 | disk space, so having a decent amount of memory will help). And, |
336 | while the instructions above mention the Live CD because that makes it |
337 | easy for people new to Linux, you can obviously also use one of the |
338 | options to install Ubuntu on your drive. |
339 | |
1def4a20 |
340 | =back |
341 | |
342 | =item * |
343 | |
d442cc9f |
344 | Matt Trout's C<cat-install> |
345 | |
346 | Available at L<http://www.shadowcatsystems.co.uk/static/cat-install>, |
347 | C<cat-install> can be a quick and painless way to get Catalyst up and |
348 | running. Just download the script from the link above and type C<perl |
349 | cat-install>. |
350 | |
351 | =item * |
352 | |
353 | Chris Laco's CatInABox |
354 | |
355 | Download the tarball from |
356 | L<http://handelframework.com/downloads/CatInABox.tar.gz> and unpack it |
357 | on your machine. Depending on your OS platform, either run C<start.bat> |
358 | or C<start.sh>. |
359 | |
360 | =item * |
361 | |
362 | Pre-Built VMWare Images |
363 | |
364 | Under the VMWare community program, work is ongoing to develop a number |
365 | of VMWare images where an entire Catalyst development environment has |
366 | already been installed, complete with database engines and a full |
367 | complement of Catalyst plugins. |
368 | |
369 | =back |
370 | |
371 | For additional information and recommendations on Catalyst installation, |
372 | please refer to |
373 | L<Catalyst::Manual::Installation|Catalyst::Manual::Installation>. |
374 | |
375 | B<NOTE:> Step-by-step instructions to replicate the environment on |
376 | which this tutorial was developed can be found at |
377 | L<Catalyst::Manual::Installation::CentOS4|Catalyst::Manual::Installation::CentOS4>. |
378 | Using these instructions, you should be able to build a complete CentOS |
379 | 4.X server with Catalyst and all the plugins required to run this |
380 | tutorial. |
381 | |
382 | =head1 DATABASES |
383 | |
384 | This tutorial will primarily focus on SQLite because of its simplicity |
385 | of installation and use; however, modifications in the script required |
386 | to support MySQL and PostgreSQL will be presented in Appendix 2. |
387 | |
388 | B<Note:> One of the advantages of the MVC design patterns is that |
389 | applications become much more database independent. As such, you will |
390 | notice that only the C<.sql> files used to initialize the database |
391 | change between database systems: the Catalyst code generally remains the |
392 | same. |
393 | |
394 | =head1 WHERE TO GET WORKING CODE |
395 | |
396 | Each part of the tutorial has complete code available in the main |
397 | Catalyst Subversion repository (see the note at the beginning of each |
398 | part for the appropriate svn command to use). Additionally, the final |
399 | code is available as a ready-to-run tarball at |
400 | L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/Final_Tarball/MyApp.tgz>. |
401 | |
402 | B<NOTE:> You can run the test cases for the final code with the following |
403 | commands: |
404 | |
405 | wget http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/Final_Tarball/MyApp.tgz |
406 | tar zxvf MyApp.tgz |
407 | cd MyApp |
408 | CATALYST_DEBUG=0 prove --lib lib t |
409 | |
410 | |
411 | =head1 AUTHOR |
412 | |
413 | Kennedy Clark, C<hkclark@gmail.com> |
414 | |
415 | Please report any errors, issues or suggestions to the author. The |
416 | most recent version of the Catalyst Tutorial can be found at |
d712b826 |
417 | L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst-Manual/lib/Catalyst/Manual/Tutorial/>. |
d442cc9f |
418 | |
419 | Copyright 2006, Kennedy Clark, under Creative Commons License |
420 | (L<http://creativecommons.org/licenses/by-nc-sa/2.5/>). |
421 | |
422 | |