2012年1月27日金曜日

[Rails3] コントローラの namespace を取得する

実行環境:
ruby 1.9.3
Rails 3.1.3
コントローラの名前は controller.controller_name で取得できますが namespace までは取得できないので、UsersController の場合も Admin::UsersController の場合も同じ users が返ってくる。

namespace まで一緒にとりたい場合は controller.controller_path を使います。 admin/users が返ってきます。
  def namespace
    controller.controller_path.split('/')[-2]    # admin
  end

もしくは controller.class.name でも Admin::UsersController のように namespace 付きで得られます。
  def namespace
    controller.class.name.split('::')[-2]        # Admin
  end
どちらも namespace がついてない場合は nil が返ります。

2012年1月26日木曜日

[Rails3] 汎用的なScaffoldを作ってみる

実行環境:
ruby 1.9.3
Rails 3.1.3
ActiveRecord 3.1.3
複数の Scaffold を作っていて、それらの動作や見栄えを変更しようとすると View テンプレートをいちいちテーブルのカラムを1つ1つちくちく直したりというのが結構面倒です。

1つアプリの中に多数のモデル(DBのテーブル)を作っている場合、管理画面は変更が面倒という理由でデフォルトの Scaffold のままだったりします。ちょっと思いたって少しいじろうかなと思っても、修正するファイルが多すぎてすぐにへこたれてしまいます。なにせ1つの Scaffold に対して Controller が1ファイル、Viewが5ファイルあるので、20の Scaffold があると120ファイルくらいあるわけですから。 (>_<)

どの Scaffold でも Controller 名と Model 名、カラム名が違うだけでファイルの構成もやってることもたいてい同じなので、Controller 名やら Model 名やらカラム名やらを動的に取得して共通化してやれば、たくさんのファイルを管理しなくてもよいんじゃないか?

そんなことを考えて Controller と View のファイルから個別のモデルに関する記述を取り除いて、どの Scaffold でも継承するだけで使えるようなものを作ってみたいと思います。

基本方針

Controller について
ApplicationController を継承した CommonScaffoldController(名前はなんでもいいですが)を作り、index や edit などのアクションメソッドを汎用性を持たせた形で書きこみます。各 Scaffold (以下では例として Users で説明します。)のコントローラは CommonScaffoldController を継承させるだけで中身を空っぽにします。アクションは全て CommonScaffoldController で定義するという作戦です。
/app/controller/common_scaffold_controller.rb
class CommonScaffoldController < ApplicationController
  def index
    # ここできっちりと定義しておく
  end

  # アクションは全てこのファイルで定義します
 
end
/app/controller/users_controller.rb
class UsersController < CommonScaffoldController  # 個別のコントローラは継承するだけ
end

View について
デフォルトの View ファイルの構成をそのまま使います。ajax を使えばもうちょっときれいにまとめられると思いますが、今回の趣旨とは関係ないので今回はそのままです。app/views/ の直下に common_scaffold フォルダを作り、その中に index.html.erb やら _form.html.erb やらを入れます。
/app/views/common_scaffold/
[common_scaffold]
   ├ index.html.erb
   ├ show.html.erb
   ├ new.html.erb
   ├ edit.html.erb
   └ _form.html.erb

上記の CommonScafffoldController の中でこのディレクトリの中の View ファイル達を render に使います。つまりどの Scaffold でも同じ View ファイルが使われるようにします。

具体的なコード

CommonScaffoldController
各 Scaffold のコントローラがこの CommonScaffoldController を継承します。controller_name で個別のコントローラ名が取得でkるのでそれを元に対応するモデル名、モデルクラスを取得します。
/app/controller/common_scaffold_controller.rb
class CommonScaffoldController < ApplicationController

  before_filter get_model_class  # @model_class, @model_instance_name を取得

  def index
    @objects = @model_class.all
 end

  def show
    @object = @model_class.find(params[:id])
    # @object = @model_class.where("? = ?", @model_class.primary_key, params[:id]).first
  end

  def new
    @object = @model_class.new
  end

  def edit
    @object = @model_class.find(params[:id])
  end

  def create
    @object = @model_class.new(params[@model_instance_name])

    respond_to do |format|
      if @object.save
        format.html { redirect_to @object, notice: "%s was successfully created."%(@model_instance_name) }
      else
        format.html { render 'new' }
      end
    end
  end

  def update
    @object = @model_class.find(params[:id])

    respond_to do |format|
      if @object.save
        format.html { redirect_to @object, notice: "%s was successfully updated."%(@model_instance_name) }
      else
        format.html { render 'edit' }
      end
    end
  end

  def destroy
    @object = @model_class.find(params[:id])
    @object.destroy

    respond_to do |format|
      format.html { redirect_to :action => :index }
    end
  end

private
  def get_model_class
    @model_class = controller_name.classify.constantize        # モデルクラス(Userなど)を取得
    @model_instance_name = @model_class.model_name.underscore  # モデルのインスタンス名を取得
  end
end
common_scaffold/*.html.erb
Viewファイルの中身からも個別の Scaffold に関わる名前を駆逐します。

index.html.erb
app/views/common_scaffold/index.html.erb
<h1>Listing <%= @model_instance_name.plurarize %></h1>

<table>
  <tr>
    <%- @model_class.columns.each do |column| -%>
      <th><%= @model_class.human_attribute_name(column.name) %></th>
    <%- end -%>
  </tr>

  <%- @objects.each do |object| -%>
    <tr>
      <%- @model_class.columns.each do |column| -%>
        <td><%= @model_class.send(column.name) %></td>
      <%- end -%>
      <td><%= link_to 'Show', object %></td>
      <td><%= link_to 'Edit', :controller => controller.controller_name, :action => :edit, :id => object.id %></td>
      <td><%= link_to 'Destroy', object, confirm: 'Are you sure?', method: :delete %></td>
      <td></td>
    </tr>
  <%- end -%>
</table>

<%= link_to "New %s"%(@model_instance_name), :controller => controller.controller_name, :action => :new %>

show.html.erb
app/views/common_scaffold/show.html.erb
<p id="notice"><%= notice %></p>

<%- @model_class.columns.each do |column| -%>
<p>
  <b><%= column.name.humanize %></b>
  <%= @object.name %>
</p>
<%- end -%>

<%= link_to 'Edit', :controller => controller.controller_name, :action => :edit, :id => @object.id %></td>
<%= link_to 'Back', :controller => controller.controller_name, :action => :index %></td>

new.html.erb
app/views/common_scaffold/new.html.erb
<h1>New <%= @model_instance_name %></h1>

<%= render 'form' %>

<%= link_to 'Back', :controller => controller.controller_name, :action => :index %>

edit.html.erb
app/views/common_scaffold/edit.html.erb
<h1>Edit <%= @model_instance_name %></h1>

<%= render 'form' %>

<%= link_to 'Show', @object %>
<%= link_to 'Back', :controller => controller.controller_name, :action => :index %>

_form.html.erb
app/views/common_scaffold/_form.html.erb
<%= form_for(@object) do |f| %>
  <% if @object.errors.any? %>
  <div id="error_explanation">
    <h2><%= pluralize(@object.errors.count, "error") %> prohibited this <%= @model_instance_name %> from being saved:</h2>

    <ul>
    <% @object.errors.full_messages.each do |msg| %>
      <li><%= msg %></li>
    <% end %>
    </ul>
  </div>
  <% end %>

  <%- @model_class.columns.each do |column| -%>
  <div class="field">
    <%= f.label column.name %><br />
    <%= f.text_field column.name %>
  </div>
  <%- end -%>
  <div class="action">
    <%= f.submit %>
  </div>
<% end %>

個別の Scaffold の設定
Controller は CommonScaffoldController を継承するだけ、Model は標準の Scaffold で作られるもののまま、View ファイルは削除します。

Controller
Controller は CommonScaffoldController を継承するだけで、メソッドの定義は一切不要。
/app/controller/users_controller.rb
class UsersController < CommonScaffoldController
end
Views
すべて app/views/common_scaffold/ の中のファイルを見るので、個別の Scaffold 用の Views ディレクトリ(app/views/users)は削除します。View ファイルを探す際に app/views/users/*, app/views/common_scaffold/* の順に探されるので消しておかないと app/views/common_scaffold/* のファイルを使ってくれません。

Model
デフォルトの Model ファイルのまま、特に変更する必要はありません。
/app/models/user.rb
class User < ActiveRecord::Base
end

まとめ
一部妄想で書いている部分があるので動かないところがあるかもしれませんが、大まかな考え方はこんな感じです。Viewファイル1セットを変えれば全て変わるので管理画面の変更も簡単です(^_^)
※今回は rails generate scaffold したまんまの View を使いましたが、そのうち Ajax 版も作ってみたいと思います。

2012年1月9日月曜日

[Rails3] 現在のURLを取得(request オブジェクト)

実行環境:
ruby 1.9.3
Rails 3.1.3
Rails アプリケーションの中で現在処理中(アクセス中)の URL を取得するには request オブジェクトを参照します。

プロトコル名(http://)を含めたフル URL を取得する。
request.url                  # http://example.com/users/search?q=hoge&p=1

URL のホスト名以降の文字列を取得する。
request.request_uri          # /users/search?q=hoge&p=1

URL のホスト名以降のパス文字列を取得する。クエリ文字列(?以降)は含まない。
request.path_info            # /users/search


requestオブジェクトについて
URL 以外にも request オブジェクトを使うと HTTP_REQUEST に入っている様々な情報を取得できます。
request.auth_type            # AUTH_TYPE
request.content_length       # CONTENT_LENGTH
request.content_type         # CONTENT_TYPE
request.gateway_interface    # GATEWAY_INTERFACE
request.path_info            # PATH_INFO
request.path_translated      # PATH_TRANSLATED
request.query_string         # QUERY_STRING
request.remote_addr          # REMOTE_ADDR
request.remote_host          # REMOTE_HOST
request.remote_ident         # REMOTE_IDENT
request.remote_user          # REMOTE_USER
request.request_method       # REQUEST_METHOD
request.script_name          # SCRIPT_NAME
request.server_name          # SERVER_NAME
request.server_port          # SERVER_PORT
request.server_protocol      # SERVER_PROTOCOL
request.server_software      # SERVER_SOFTWARE
request.accept               # HTTP_ACCEPT
request.accept_charset       # HTTP_ACCEPT_CHARSET
request.accept_encoding      # HTTP_ACCEPT_ENCODING
request.accept_language      # HTTP_ACCEPT_LANGUAGE
request.cache_control        # HTTP_CACHE_CONTROL
request.from                 # HTTP_FROM
request.host                 # HTTP_HOST
request.negotiate            # HTTP_NEGOTIATE
request.pragma               # HTTP_PRAGMA
request.referer              # HTTP_REFERER
request.user_agent           # HTTP_USER_AGENT
request.raw_cookie           # HTTP_COOKIE
request.raw_cookie2          # HTTP_COOKIE2
request.request_uri          # REQUEST_URI

2012年1月8日日曜日

[Rails3] 国際化 I18n のまとめ(その3:辞書ファイルの使い方)

実行環境:
ruby 1.9.3
Rails 3.1.3
I18n
Railsアプリで表示を担当するのはビューなので国際化するのは当然ビューですね。ページに表示される文字すべてが対象となります。

ページに表示される文字をざっと分類してみましょう。
  1. DBに格納されている文字列
  2. HTMLに直接書く単語や文章
  3. モデルの名前や属性の名前などモデルに関連する文字列
  4. Railsのエラーメッセージ

1. DBに格納されている文字列

DBに格納されているデータを国際化(多言語化)する場合は、各ロケールごとのデータを用意する必要があります(日本語だけなら不要です)。
シンプルな方法としては、テーブルに複数のロケール用データをカラムを増やして各ロケールのデータを格納します。
TABLEの構造
+------+----------+------------+
|  id  | hello_en |  hello_ja  |
+------+----------+------------+
|   1  |  Hello   | こんにちは |
+------+----------+------------+
もしくはハッシュの形で各ロケールのデータを1つにまとめて(=シリアライズして)DBの1つのカラムに突っ込むという手もあります。
#{RAILS.ROOT}/app/models/greetings.rb
class Greeting < ActiveRecord::Base
  serialize :data, Hash
end
  @greeting.data = {:en => "Hello", :ja => "こんにちは"}
いずれの方法にせよ、表示の際にロケールにあわせて表示し分けるようにします。

2. HTMLに直接書く単語や文章

とりあえず自由に辞書を定義する
HTMLテンプレートに書くタイトルや文章などを辞書ファイルで定義していく、というのがとりあえず思いつくところでしょうか。辞書ファイルはハッシュの形で定義します。基本的にキーを自由につけることができますし、整理のために自由に階層をつけることができます。
#{RAILS.ROOT}/config/locale/ja.yml
ja:
    hello: こんにちは
    foods:
        vegetables:
            cucumber: きゅうり
参照するには I18n.t メソッドを使います。
Controllerの中では
#{RAILS.ROOT}/app/controllers/users_controller.rb
  I18n.t('hello')
  I18n.t('foods.vegetables.cucumber')
Viewの中では
#{RAILS.ROOT}/app/views/users/index.html.erb
  <%= t('hello') %>
  <%= t('foods.vegetables.cucumber') %>
という形で参照します。

「きゅうり」のように階層になっている用語については、上位の階層をscopeと見ることもでき、
#{RAILS.ROOT}/app/views/users/index.html.erb
  <%= t('cucumber', :scope => 'foods.vegetables') %>
  <%= t('vegetables.cucumber', :scope => 'foods') %>
という書き方も可能。

キーの指定は文字列だけでなく、シンボルでもいけます。
#{RAILS.ROOT}/app/views/users/index.html.erb
  <%= t(:hello) %>
  <%= t(:foods, :scope => 'vegetables.cucumber') %>
  <%= t(:foods, :scope => [:vegetables, :cucumber]) %>

ビュー別の定義
特定のビューで使用する辞書定義は、ルールに従って定義するとビューファイルの中で簡単に参照できます。
#{RAILS.ROOT}/config/locale/ja.yml
ja:
  user:        # コントローラ名
    index:     # アクション名
      title: ユーザー一覧
    show:      # アクション名
      title: ユーザーの詳細
このように定義するとビューファイルの中で <%= t('.title') %> で参照でき、index.html.erb と show.html.erb でそれぞれの定義が使われます。

ロケール別のHTMLテンプレート
単語・文章レベルで表示を差し替えればよいだけであれば上記の方法で対応できますが、ロケールによってページ内の構成が大幅に異なる場合などはロケールごとに別々にHTMLテンプレートを用意しておくこともできます。
#{RAILS.ROOT}/app/views/users/
[users]
  |-- index.en.html.erb
  |-- index.ja.html.erb
  |-- index.de.html.erb
ロケールにあわせて適切なHTMLテンプレートを選択してくれます。

3. モデルの名前や属性の名前などモデルに関連する文字列

モデルに関連する名前は次のように辞書ファイルに書きます。
#{RAILS.ROOT}/config/locale/ja.yml
ja:
  activerecord:
    models:
      user: ユーザー             # モデル名
    attributes:
      user:                      # モデル名
        name: 名前               # モデルの属性名 
        password: パスワード     # モデルの属性名 
モデル名、モデルの各属性名は
User.model_name.human            # モデル名
User.human_attribute_name(name)  # モデルの属性名 
のように簡単に参照できます。もちろん通常通り I18n.t('activerecord.models.attributes.name') でも参照できます。

form の中ではモデルの属性値を表す label が自動的に辞書ファイルの内容で置き換えられます。
#{RAILS.ROOT}/app/views/edit.html.erb
  <%= form_for(@user) do |f| %>
    <%= f.label :name %>    # 「名前」
  <%= end %>

※個人的には、毎回 User.model_name.human、User.human_attribute_name(name)とか書くのは若干面倒だなぁと思うので、こんなヘルパーメソッドを作ってモデル名やモデルの属性名が超簡単に拾えるようにしてます。
#{RAILS.ROOT}/app/helpers/application_helper.rb
def t_ar(label)
  arr = label.split(/./)
  if arr.length <= 2 then
    begin
      model = arr[0].constantize
    else
      if arr.length == 1
        return model.model_name.human
      else
        return model.human_attribute_name(arr[1])
      end
    end
  end
  label
end
  t_ar('User')        # モデル名(User.model_name.human)
  t_ar('User.name')   # 属性名(User.human_attribute_name(name))

4. Railsのエラーメッセージ

エラーメッセージも辞書ファイルで定義することで日本語化できます。
#{RAILS.ROOT}/config/locale/ja.yml
ja:
  activerecord:
    errors:
      messages: ユーザー一覧
        blank: "が記入されていません。"   # ①
        invalid: "が不正な値です。"
        confirmation: "が一致しません。"
        ...
エラーの種類に対応したエラーメッセージをこのように定義します。この定義はすべてのモデルのエラーをカバーします。

一方、特定のモデルや特定の属性について別のエラーメッセージを指定するには次のようにします。
特定のモデル用のエラーメッセージ
#{RAILS.ROOT}/config/locale/ja.yml
ja:
  activerecord:
    errors:
      models:
        user:
          blank: "が記入されていません。"   # ②
          ...
特定のモデルの特定の属性用のエラーメッセージ
#{RAILS.ROOT}/config/locale/ja.yml
ja:
  activerecord:
    errors:
      models:
        user:
          attributes:
            name:
              blank: "が記入されていません。"   # ③
              ...
より細かいところでの定義が優先されます。
Userモデルのname属性についてのvalidationが以下のように定義されていてnameに値にblankエラーが発生した場合、③ → ② → ① の順に探して最初に見つかった定義が使われます。
#{RAILS.ROOT}/app/models/user.rb
class User < ActiveRecord::Base
  validates_presence_of :name
end