Catalyst::Manual::Tutorial::Intro - Catalyst Tutorial - Part 1: Introduction [対訳]

Catalyst::Manual::Tutorial::Intro – Catalyst Tutorial – Part 1: Introduction の対訳。2008/01/18 時点での最新版 Catalyst-Manual-5.701003.tar.gz を元にしています。

誤訳がありましたらコメントにてご指摘ください。

Catalyst::Manual::Tutorial::Intro – Catalyst Tutorial – Part 1: Introduction

Catalyst::Manual::Tutorial::Intro – Catalyst チュートリアル – 第一部: 導入

This is Part 1 of 9 of the Catalyst Tutorial.

9 つある Catalyst チュートリアルのうちの 1 つめです。

Tutorial Overview

チュートリアルの概要

1. Introduction
   導入
2. Catalyst Basics
   Catalyst の基礎
3. Basic CRUD
   基礎的な CRUD
4. Authentication
   認証
5. Authorization
   承認
6. Debugging
   デバッグ
7. Testing
   テスト
8. Advanced CRUD
   高度な CRUD
9. Appendices
   補遺

This tutorial provides a multipart introduction to the Catalyst web framework. It seeks to provide a rapid overview of many of its most commonly used features. The focus is on the real-world best practices required in the construction of nearly all Catalyst applications.

このチュートリアルは Catalyst web フレームワークへの複合的な導入を提供します。最もよく利用されるたくさんの機能の概要を素早く提供しようと努めます。ほぼすべての Catalyst アプリケーションの構築で必要とされる実用的な良い慣例に焦点を合わせます。

Although the primary target of the tutorial is users new to the Catalyst framework, experienced users may wish to review specific sections (for example, how to use DBIC for their model classes or how to add authentication and authorization to an existing application).

このチュートリアルの第一ターゲットは Catalyst フレームワークを初めて使うユーザですが、経験者もいくつかのセクションを再考したいと考えるかもしれません(たとえば、自分のモデルクラスで DBIC を使う方法だとか、すでに存在するアプリケーションに認証と承認を加える方法など)。

You can obtain the code for all the tutorial examples from the catalyst subversion repository by issuing the command:

以下のコマンドを実行することでこのチュートリアルの例すべてのコードを Catalyst の Subversion リポジトリから取得することができます:

svn co http://dev.catalyst.perl.org/repos/Catalyst/tags/examples/Tutorial/MyApp/5.7/ CatalystTutorial

This will download the current code for each tutorial chapter in the CatalystTutorial directory. Each example application directory has the same name as the tutorial chapter.

このコマンドを実行すると CatalystTutorial というディレクトリに各チュートリアルの章ごとの最新のコードがダウンロードされます。それぞれのサンプルアプリケーションディレクトリはチュートリアルの章と同じ名前になっています。

These reference implementations are provided so that when you follow the tutorial, you can use the code from the subversion repository to ensure that your system is set up correctly, and that you have not inadvertently made any typographic errors, or accidentally skipped part of the tutorial.

これらの参照実装はチュートリアルを追いかけていく為に提供されているので、 Subversion リポジトリから得たコードによりあなたのシステムが正しくセットアップされているかを確認でますし、うっかり文字の打ち間違いによるエラーを起こすことも、チュートリアルを一部読み飛ばしてしまうというアクシデントも起こりません。

Additionally, if you’re reading this manual online, you can download the example program and all the necessary dependencies to your local machine by installing the Task::Catalyst::Tutorial distribution from CPAN:

加えて、もしこのマニュアルをオンラインで読んでいるのであれば、 Task::Catalyst::Tutorial ディストリビューションを CPAN からインストールすることでサンプルプログラムとあなたのローカルマシンで必要となるすべての依存するものをダウンロードすることができます:

cpan Task::Catalyst::Tutorial

This will also test to make sure the dependencies are working. If you have trouble installing these, please ask for help on the #catalyst IRC channel, or the Catalyst mailing list.

このコマンドでは依存するものがちゃんと動いているかも確認してくれます。もしこれらのインストールで問題があったなら、 IRC の #catalyst チャネルか Catalyst メーリングリストに助けを求めてください。

Subjects covered include:

ここでふれる話題は以下の通りです:

• A simple application that lists and adds books.

  本を表示したり加えたりする単純なアプリケーション。

• The use of DBIx::Class (DBIC) for the model.

  モデルのためにDBIx::Class(DBIC) を使う。

• How to write CRUD (Create, Read, Update, and Delete) operations in Catalyst.

  Catalyst で CRUD(Create, Read, Update,と Delete) を書くための方法。

• Authentication (“auth”).

  認証(“auth”)。

• Role-based authorization (“authz”).

  ロールによる承認(“authz”)。

• Attempts to provide an example showing current (5.7XXX) Catalyst practices. For example, the use of Catalyst::Action::RenderView, DBIC, Catalyst::Plugin::ConfigLoader with myapp.yml, the use of lib/MyApp/Controller/Root.pm vs. lib/MyApp.pm, etc.

  Catalyst の最新(5.7XXX) の機能を見せるためのサンプルを提供することを試みる。例えば、 Catalyst::Action::RenderView の使い方、 DBIC、 Catalyst::Plugin::ConfigLoader と myapp.yml、 lib/MyApp/Controller/Root.pm 対 lib/MyApp.pm の使い方、など。

• The use of Template Toolkit (TT) and the Catalyst::Helper::View::TTSite view helper.

  Template Toolkit(TT) と Catalyst::Helper::View::TTSite ビューヘルパーの使い方。

• Useful techniques for troubleshooting and debugging Catalyst applications.

  Catalyst アプリケーションでのトラブルシューティングとデバッグに役立つテクニック。

• The use of SQLite as a database (with code also provided for MySQL and PostgreSQL).

  SQLite をデータベースとして使う方法(MySQL と PostgreSQL も同じように提供)。

• The use of HTML::Widget for automated form processing and validation.

  自動 FORM 処理と値検査のための HTML::Widget の使い方。

This tutorial makes the learning process its main priority. For example, the level of comments in the code found here would likely be considered excessive in a “normal project”. Because of their contextual value, this tutorial will generally favor inline comments over a separate discussion in the text. It also deliberately tries to demonstrate multiple approaches to various features (in general, you should try to be as consistent as possible with your own production code).

このチュートリアルでは学ぶプロセスを確立することを第一優先としています。例えば、コードの中には “普通のプロジェクト” からみたら過度なレベルのコメントが見られます。文脈上の価値のために、このチュートリアルでは一般にテキストで議論を分断するよりもインラインコメントの方を好むからです。またさまざまな機能に対して意図的に複数のアプローチのしかたを試みることもあります(一般には、あなたのプロジェクトのコードではできるだけ一貫性をもたせるようにすべきです)。

Furthermore, this tutorial tries to minimize the number of controllers, models, TT templates, and database tables. Although this does result in things being a bit contrived at times, the concepts should be applicable to more complex environments. More complete and complicated example applications can be found in the examples area of the Catalyst Subversion repository at http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/.

さらに、このチュートリアルではコントローラ、モデル、 TT テンプレート、そしてデータベースを最小限とするよう努めています。より複雑な環境へ適用できるようにというコンセプトによる意図的な結果です。より完全で複雑なサンプルアプリケーションは http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/ にある Catalyst Subversion リポジトリの examples エリアにあります。

Note: There are a variety of other introductory materials available through the Catalyst web site and at http://dev.catalyst.perl.org/wiki/UserIntroductions and http://dev.catalyst.perl.org/.

ノート: ほかにもさまざまな紹介的なものが Catalyst の Web サイトと http://dev.catalyst.perl.org/wiki/UserIntroductions と http://dev.catalyst.perl.org/ を通じて手に入れることができます。

This tutorial was built using the following resources. Please note that you may need to make adjustments for different environments and versions:

このチュートリアルは以下のリソースを用いて構築されています。違う環境やバージョンではどこか調整しなければならなくなるかもしれないことに注意してください:

• OS = CentOS 4 Linux (RHEL 4)

  OS = CentOS 4 Linux (RHEL 4)

• Catalyst v5.7

  Catalyst v5.7

• Catalyst::Devel v1.02

  Catalyst::Devel v1.02

• DBIx::Class v0.06003

  DBIx::Class v0.06003

• Catalyst Plugins – The plugins used in this tutorial all have sufficiently stable APIs that you shouldn’t need to worry about versions. However, there could be cases where the tutorial is affected by what version of plugins you use. This tutorial has been tested against the following set of plugins:

  Catalyst プラグイン – このチュートリアルで用いるプラグインはすべて十分に安定している API なのでバージョンに関する心配は必要ありません。しかしながら、あなたが使っているプラグインのバージョンの影響を受けるケースもあるかもしれません。このチュートリアルは以下のプラグインでテストしています。

  • Catalyst::Plugin::Authentication — 0.09

    Catalyst::Plugin::Authentication — 0.09

  • Catalyst::Plugin::Authentication::Store::DBIC — 0.07

    Catalyst::Plugin::Authentication::Store::DBIC — 0.07

  • Catalyst::Plugin::Authorization::ACL — 0.08

    Catalyst::Plugin::Authorization::ACL — 0.08

  • Catalyst::Plugin::Authorization::Roles — 0.04

    Catalyst::Plugin::Authorization::Roles — 0.04

  • Catalyst::Plugin::ConfigLoader — 0.13

    Catalyst::Plugin::ConfigLoader — 0.13

  • Catalyst::Plugin::HTML::Widget — 1.1

    Catalyst::Plugin::HTML::Widget — 1.1

  • Catalyst::Plugin::Session — 0.12

    Catalyst::Plugin::Session — 0.12

  • Catalyst::Plugin::Session::State::Cookie — 0.05

    Catalyst::Plugin::Session::State::Cookie — 0.05

  • Catalyst::Plugin::Session::Store::FastMmap — 0.02

    Catalyst::Plugin::Session::Store::FastMmap — 0.02

  • Catalyst::Plugin::StackTrace — 0.06

    Catalyst::Plugin::StackTrace — 0.06

  • Catalyst::Plugin::Static::Simple — 0.14

    Catalyst::Plugin::Static::Simple — 0.14

• Since the web browser is being used on the same box where Perl and the Catalyst development server is running, the URL of http://localhost:3000 will be used (the Catalyst development server defaults to port 3000). If you are running Perl on a different box than where your web browser is located (or using a different port number via the -p port_number option to the development server), then you will need to update the URL you use accordingly.

  Perl と Catalyst 開発サーバが動作するのと同じマシンで Web ブラウザを利用するのであれば、 http://localhost:3000 という URL を使います(Catalyst 開発サーバのデフォルトのポートは 3000 です)。もし Web ブラウザを実行しているのと異なるマシンで Perl を実行しているのであれば(もしくは開発サーバで -p port_number オプションにより異なるポート番号を用いているのであれば)、それに応じて URL をアップデートする必要があります。

• Depending on the web browser you are using, you might need to hit Shift+Reload to pull a fresh page when testing your application at various points. Also, the -k keepalive option to the development server can be necessary with some browsers (especially Internet Explorer).

  使っている Web ブラウザによっては、いくつかの点であなたのアプリケーションをテストする際に最新ページを引っ張ってくるためには Shift+Reload を押す必要があるかもしれません。また、いくつかのブラウザ(特に Internet Explorer)では開発サーバで -k keepalive オプションが必要となるかもしれません。

Unfortunately, one of the most daunting tasks faced by newcomers to Catalyst is getting it installed. Although a compelling strength of Catalyst is that it can easily make use of many of the modules in the vast repository that is CPAN, this can result in initial installations that are both time consuming and frustrating. However, there are a growing number of methods that can dramatically ease this undertaking. Of these, the following are likely to be applicable to the largest number of potential new users:

不幸にも、 Catalyst 初心者がもっともよく直面するやる気をなくしてしまう作業の一つがそのインストールです。Although a compelling strength of Catalyst is that it can easily make use of many of the modules in the vast repository that is CPAN, this can result in initial installations that are both time consuming and frustrating. しかしながら、これらを劇的に簡単にしてくれる方法がたくさん存在しています。もちろん、これらの方法は多くの潜在的な新規利用者にも適用できます。

• Matt Trout’s cat-install – Available at http://www.shadowcatsystems.co.uk/static/cat-install, cat-install can be a quick and painless way to get Catalyst up and running. Just download the script from the link above and type perl cat-install.

  Matt Trout の cat-install – http://www.shadowcatsystems.co.uk/static/cat-install から入手できる cat-install は Catalyst の入手と実行を素早く苦痛なしに実現する方法です。ただスクリプトを上記リンクからダウンロードし perl cat-install を打ち込むだけでけです。

• Chris Laco’s CatInABox – Download the tarball from http://handelframework.com/downloads/CatInABox.tar.gz and unpack it on your machine. Depending on your OS platform, either run start.bat or start.sh.

  Chris Laco の CatInABox – http://handelframework.com/downloads/CatInABox.tar.gz から Tar アーカイブをダウンロードしあなたのマシンに解凍してください。あなたの OS プラットフォームに依存しますが、 start.bat か start.sh を実行します。

• Pre-Built VMWare Images – Under the VMWare community program, work is ongoing to develop a number of VMWare images where an entire Catalyst development environment has already been installed, complete with database engines and a full complement of Catalyst plugins.

  Pre-Built VMWare Images – VMWare コミュニティプログラムの元、いくつかのデータベースエンジンとすべての Catalyst プラグインを含む Catalyst 開発環境があらかじめインストールされた VMWare イメージが継続して開発されています。

For additional information and recommendations on Catalyst installation, please refer to Catalyst::Manual::Installation.

Catalyst のインストールに関する追加の情報とおすすめは Catalyst::Manual::Installation を参照してください。

NOTE: Step-by-step instructions to replicate the environment on which this tutorial was developed can be found at Catalyst::Manual::Installation::CentOS4. Using these instructions, you should be able to build a complete CentOS 4.X server with Catalyst and all the plugins required to run this tutorial.

ノート: このチュートリアルを開発した環境を複製するためのステップバイステップ手順は Catalyst::Manual::Installation::CentOS4 にあります。これらの手順を使えば、このチュートリアルを実行するために必要となる Catalyst とすべてのプラグインがそろった完全な CentOS 4.x サーバを構築することができます。

This tutorial will primarily focus on SQLite because of its simplicity of installation and use; however, modifications in the script required to support MySQL and PostgreSQL will be presented in Appendix 2.

このチュートリアルではインストールと利用が簡単な SQLite に焦点を当てます。が、 MySQL と PostgreSQL をサポートするために必要となるスクリプトの変更について補遺 2 で紹介します。

Note: One of the advantages of the MVC design patterns is that applications become much more database independent. As such, you will notice that only the .sql files used to initialize the database change between database systems: the Catalyst code generally remains the same.

ノート: MVC デザインパターンのひとつの利点はアプリケーションがデータベースに依存しなくなることです。そのため、 .sql ファイルはデータベース間をまたがるデータベース変更のときのみ用いられることに注意してください: Catalyst コードは同じままです。

Each part of the tutorial has complete code available in the main Catalyst Subversion repository (see the note at the beginning of each part for the appropriate svn command to use). Additionally, the final code is available as a ready-to-run tarball at http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/Final_Tarball/MyApp.tgz.

チュートリアルのそれぞれの部分はメインの Catalyst Subversion リポジトリ(実行すべき svn コマンドはそれぞれの部の冒頭にあるノートをみてください)から得られる完全なコードを持っています。加えて、実行可能な最終コードの Tar アーカイブが http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/Final_Tarball/MyApp.tgz にあります。

NOTE: You can run the test cases for the final code with the following commands:

ノート: 次のコマンドにより最終コードのテストケースを実行することができます:

wget http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/Final_Tarball/MyApp.tgz
tar zxvf MyApp.tgz
cd MyApp
CATALYST_DEBUG=0 prove --lib lib  t

Kennedy Clark, hkclark [a] gmail.com

Kennedy Clark, hkclark [a] gmail.com

Please report any errors, issues or suggestions to the author. The most recent version of the Catalyst Tutorial can be found at http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst-Manual/lib/Catalyst/Manual/Tutorial/.

Please report any errors, issues or suggestions to the author. The most recent version of the Catalyst Tutorial can be found at http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst-Manual/lib/Catalyst/Manual/Tutorial/.

Copyright 2006, Kennedy Clark, under Creative Commons License (http://creativecommons.org/licenses/by-nc-sa/2.5/).

Copyright 2006, Kennedy Clark, under Creative Commons License (http://creativecommons.org/licenses/by-nc-sa/2.5/).