プロジェクト

全般

プロフィール

コントローラのスケルトンの生成

次に MVC のうちの Control を作っていきましょう。
プラグイン、モデルのスケルトン作成と同様にコントローラにもスケルトン作成機能があります。

コントローラ、アクションの名前を決める

今度もスケルトンを生成するにはまずコントローラとアクションの名前を決めておく必要があります。

コントローラはよくモデルを複数形にして名前が付けられます。モデルの名前は Foo としましたので、コントローラの名前を Foos にします。この複数形にするのは特にそう決まっているあるわけではありません。例えば、用語(Term)を管理するのは用語集(Glossary)、予約(Event)を管理するのはスケジュール張(Scheduler)といったように管理するデータをまとめる感じの分かりやすい名前であれば、何でも構いません。

次にアクションの名前を決めます。 サンプルの仕様 で考えた画面に対して、それぞれ Redmine のチケットなどの実装をまねて名前を付けました。

アクション 名前
一覧表示 index
新規作成フォーム new
作成 create
詳細表示 show
編集フォーム edit
更新 update
削除 destory
プレビュー preview

コントローラのスケルトン作成コマンドの実行

コントローラのスケルトンの実行コマンドの書式は次のような形です。

$ ruby script/rails redmine_plugin_controller プラグイン名 コントローラ名 [アクション名 ...]

Redmine のトップディレクトリに移動して、決めた名前で実際にコマンドを実行するのですが、ここでは作成(create)、更新(update)、削除(destory)とプレビュー (preview)アクションは除いています。

$ ruby script/rails generate redmine_plugin_controller redmine_standard foos index new show edit

実行結果

      create  plugins/redmine_standard/app/controllers/foos_controller.rb
      create  plugins/redmine_standard/app/helpers/foos_helper.rb
      create  plugins/redmine_standard/test/functional/foos_controller_test.rb
      create  plugins/redmine_standard/app/views/foos/index.html.erb
      create  plugins/redmine_standard/app/views/foos/new.html.erb
      create  plugins/redmine_standard/app/views/foos/show.html.erb
      create  plugins/redmine_standard/app/views/foos/edit.html.erb

実行結果を見ていただけるとコントローラだけでなく、アクションに対応するビューもできていることが分かると思います。 Rails ではデフォルトではアクションを実行するとその名前に対応するビューのファイルを探してそれを表示するようになっています。作成(create)、更新(update)、削除(destory)、プレビュー (preview)は専用の画面を必要としていなかったので、スケルトンの生成では指定しませんでした。 この四つは後でスケルトンを使わずに直接記述することにします。

コントローラの生成ファイル

コントローラの生成ファイル(app/controllers/foos_controller.rb )を見てみましょう。

class FoosController < ApplicationController
  unloadable

  def index
  end

  def new
  end

  def show
  end

  def edit
  end

end

コントローラは ApplicationController クラスを継承したクラスで実現され、一つのメソッドが一つのアクションに相当します。
2 行目の unloadable は Model で出てきたものと同じで、これを書いておかないと development モードで正常に動作しなくなります。

ビューの生成ファイル

ビューの生成ファイルとして app/views/foos/index.html.erb も見てみます。

<h2>FoosController#index</h2>

といっても大して意味のない html が書かれているだけです。 ここに今後コントローラから渡されたデータなどの中身を書いていくことになります。
html ですが Erb という埋め込み型の ruby を使って、html 中で ruby のコードを実行できます。

Erb (Embeded ruby)

Erb ではファイル内の <%%> の間が ruby スクリプトとして評価されます。
また、 <%=%> を使うとスクリプトの結果がファイルに埋め込まれます。

例えば、以下のようなコードを記述したとします。

<% for val in [1, 2, 3] %>
  <%= val %> <br />
<% end %>

生成されるファイルでは for などの繰り返しもちゃんと処理してくれます。また、 <%= %> は文字列中の #{} と同じで必ず to_s メソッドを使って文字列に変換されます。

  1 <br />
  2 <br />
  3 <br />

^ << >>