● [Rails] ActiveScaffold プラグイン

AjaxScaffold までは知ってたけど、これは知らなかった。凄いねこれ。スペジェネでやりたかったことが殆ど実装されているよ。あとは ViewProperty 周りの機能が足りないけど、今からスペジェネを頑張るよりもこっちにそれを入れ込む方が早そうだ。Rails1.2 だとスペジェネの動作が微妙な部分もあるし。てことで、Rails1.2〜の現代では、スペジェネでなくて ActiveScaffold を使うのがよいと思われ。テンションあがったので、一気に調べて舞波本のスペジェネの部分(pp.288-295)を差し替えよう計画。検証や校正をする時間がないと思うので、誤字脱字、疑問点、些細な間違い、ActiveScaffold で知りたい事、本に載せて欲しい内容等、何でもどんどんツッコミお願いします。

● ActiveScaffold プラグイン (p.288)

以前は AjaxScaffold と呼ばれていた Scaffold プラグインの後継です。その名の通り Ajax ベースで高機能で見栄えもよいScaffoldです。これだけでCRUD系のアプリケーションとしては十分実用レベルになります。

■ 特徴

• scaffold 機能
• Ajax ページおよび通常(非 Ajax)ページとして動作(自動認識)
• ページとソート機能
• 検索機能
• カラムの表示設定
• ARの関連サポート
• ビューテンプレートの差替機能

■■ 配布元

http://activescaffold.googlecode.com/svn/tags/active_scaffold

■■ 準備

まず、プラグインをインストールします。css, js 等のリソースが public にコピーされますので、svn co ではなく install コマンドを利用して下さい。

./script/plugin install http://activescaffold.googlecode.com/svn/tags/active_scaffold

次に、コピーした css,js 等を読み込む設定を、レイアウトまたは利用するビューテンプレートに記述します。

<%= javascript_include_tag :defaults %>
<%= active_scaffold_includes %>

● ■■ scaffold 機能 (p.289)

まずは、オリジナルの scaffold の代用として使ってみましょう。ここではユーザ情報(Userモデル)を管理する UserController を想定します。コントローラの定義で、scaffold の代わりに active_scaffold と記述してみて下さい。

▼コード : UserController 定義

class UserController < ApplicationController active_scaffold :user end

ページへアクセスすると、以下のような画面が現れます。

右側には各レコードの操作リンクが、右上には検索と新規作成のリンクが準備されています。見栄えのよい上に、これらは全てAjaxで動作します。

● ■■ ページ機能 (p.289)

ページ機能もデフォルトで準備されています。このままではわかり辛いので、1ページあたりの表示件数を2にしてみましょう。ActiveScaffold の設定を変更するには、コントローラ内の定義部分にブロックを追加します。設定には、コントローラ内で共通な「グローバル設定」と各アクション毎の「ローカル設定」の2種類があります。

active_scaffold :user do |config| config.xxx = ... # グローバルな設定 config.list.xxx = ... # ローカル(listアクション)用の設定 config.show.xxx = ... # ローカル(lhowアクション)用の設定 end

リスト表示は "list" アクションですので config.list に対する設定になります。

▼コード : ページ化とソートの設定

active_scaffold :user do |config| config.list.per_page = 2 config.list.sorting = {:name => :asc } end

この設定では、2行目ではデフォルトのソート順序を指定しています。

2件ずつページ化され、ソートで指定したカラムが色付けされました。ページリンクや、カラムの見出し部分のソートリンクも全て Ajax です。

● ■■ 設定と日本語化 (pp.290-291)

グローバル設定(config 直下の設定)は全アクションへのデフォルト設定となり、ローカル設定は指定したアクションにのみ影響を与える設定になります。

▼表 : グローバル・ローカル共通設定

また、columns の各要素に対して、さらに以下の設定が可能です。

▼表 : カラム用の設定

これらの設定を元に日本語化してみましょう。

▼コード : 日本語化と表示カラムの設定

config.label = "ユーザ" config.columns = [:name, :birthday] config.columns[:name].label = "名前" config.columns[:name].required = true config.columns[:birthday].label = "誕生日" config.columns[:birthday].description = "西暦です"

グローバル設定ですので、「Edit」画面にも反映されています。また、name カラムの required と birthday カラムの description の設定も反映されています(補足1)。

1. 編集注：フットノートに以下を追加
2. (補足1) css に ".active-scaffold .required label {color:red;}" を追加しています

ActiveScaffold ではローカライズ機能としてラベル系は全て Object#as_(string) を通すことになっていますので、残りの部分の日本語化はそれを利用します。以下のコードを config/environment.rb の最後に追加して、その影響範囲を確認してみましょう。

▼コード : ActiveScaffoldのローカライズ機能の確認

class Object def as_(string, *args) "[#{string}]" end end

日本語化したい部分が全て被覆されてますね。後は自分で好きなように置換するだけで日本語化が完了です。もし、GetText 等のローカライザを使っていれば、"as_" をそのまま委譲するのもよいでしょう。

1. 編集注： 以下をフットノートに入れる
2. GetText の使用例 http://dev.rakusui.jp/diary/?date=20071109
3. 日本語化の例 http://d.hatena.ne.jp/urekat/20071110/

● ■■ 表示設定 (p.292)

表示内容を変更する場合は、ヘルパにメソッドを追加します。

▼表 : 表示内容とメソッド

▼コード : 誕生日(birthday)をYYYYMMDD形式に

module UserHelper def birthday_column(record) record[:birthday].strftime("%Y-%m-%d") end def birthday_form_column(record, name) input(:record, :birthday, :name=>name, :order=>[:year,:month,:day], :use_month_numbers=>true, :start_year=>1970) end

● ■■ 関連設定 (p.293)

has_one や has_many といった関連にも対応しています。デフォルトでlistアクションに追加されていますが、カラム名にARの関連名を指定することで、他の実カラム同様に表示項目として扱うことができます。

▼コード : user の所属情報を追加(:companyは関連名)

config.columns = [:name, :birthday, :company] config.columns[:company].label = "所属"

第一章で解説したように、関連名(:company)で参照されるものは AR オブジェクトです。ActiveScaffold はその表示名として、同オブジェクトに対して以下の順序でメソッドサーチを行います。

▼コード : Company クラスに表示用メソッドを追加

class Company < ActiveRecord::Base has_many :users def to_label "(#{kind})#{name}" end

編集時には自動的に、関連先がプルダウンで選択できるようになっています。デフォルトでは新規登録も可能になっていまので、望まない場合は ui_type を :select にして下さい。

▼コード : 所属の新規登録を禁止する

config.columns[:company].ui_type = :select

● ■■ 検索設定 (p.294)

検索は現在のところ、テキスト検索のみです。カラムを指定した絞込み検索もできませんが、検索対象にカラムを追加することは可能です。(デフォルトでは文字列カラムだけが検索対象になっています)

▼コード : 誕生日を文字列検索に加える

config.search.columns << :birthday config.columns[:birthday].search_sql = 'birthday'

この場合、以下のような条件節が作成されます。

LOWER(users."name") LIKE '%1994%' OR LOWER(birthday) LIKE '%1994%'

関連先を検索に含めたい場合は、search_sql にテーブル名まで考慮した部分クエリを記述します。

▼コード : 関連先の所属名称を検索に含める

config.search.columns << :company config.columns[:company].search_sql = 'companies.name'

空白で区切ると&検索になります。デフォルトでは "LIKE" を用いた部分一致検索になります。"=" による一致検索を行う場合は "config.search.full_text_search" の値を false にして下さい。

● ■■ セキュリティ設定 (p.295)

Edit や Delete 等のリンクを望まない場合は、グローバル設定の actions から削除します。

config.actions.exclude :update, :delete

(※ Edit リンク用のアクション名は :edit でなくて :update が正解です(修正:20071213))

アクション設定とリンク (追加:20071214)

■ ビューテンプレートの差し替え

また、テンプレートの継承機能を利用することで、テンプレート自体を置き換える方法もあります。

▼表 : テンプレートの参照順位

システム全体に反映させたい場合は2に、コントローラ毎に変更したい場合は1に配置します。

■ アクション単位のセキュリティ設定

コントローラの #{action_name}_authorized? メソッドを定義することで、各アクションレベルでの利用設定が可能です。

class UserController < ApplicationController def delete_authorized? request.remote_ip == '127.0.0.1' end

■ リソース単位のセキュリティ設定

モデルの authorized_for? メソッドを定義することで、特定のデータだけ保護することが可能です。

class Service def authorized_for?(options = {}) not (options[:action] == :delete and port < 1024) end

"authorized_for_#{crud_action}?" で定義することも可能です。

■ 利用者単位のセキュリティ設定

モデルの current_user メソッドによって、コントローラ実行中の(ログインしている)ユーザ情報を取得可能です。前提として、コントローラの current_user メソッドでそのログイン情報を返す設定が必要ですが、acts_as_authenticated などと親和性が高いです。

class Company def authorized_for_delete?(options = {}) current_user.login == 'admin' end

SEO: active_scaffold