ヽ( ・∀・)ノくまくまー(2005-08-10)

2005-08-10 優しいRailsの育て方 [長年日記]

● 序章

これは、かつて Ruby がまだ神話だった時代、天使達の間で流行った歌(天上界オリコン13位)である。

「autoload」と言うコトバに、なんかあこがれてたー。
実際何をするのか、いまだにわかんない・・・(ヨロシク)。
動的呼出されてうれしく思い(ヨロシク)。
module 非対応で涙が出たり。忙しいな。

(福音書「21時までのシンデレラ」、2章、A節より)

● [rails] LoadingModule (active_support)

LoadingModule は動的なクラス参照を提供する機能です。通常、Rails を使っていると意識しないままその恩恵を受けていますが、モデルやビューのクラス定義ファイルなどが何の準備もなしに自動的に参照されるのはこの機能のお陰です。同様の機能である Ruby 組み込みの autoload よりも以下の点で優れています。

ネームスペースを考慮してくれる (Rubyスタイルなモジュールにも対応)
定義が不要 (メンテナンスフリー♪)

クラスを自作する場合、汎用性を意識すると他モジュールとの名前衝突の危険性からネームスペース的にモジュールを定義することになりますが、天使ならずとも autoload がネームスペースに対応していなくて悲しい想いをした人は多いでしょう。そこで人間達は考えました。モジュール全体を読み込むためのファイルを用意し、そのネームスペース的なモジュール名だけを autoload のトリガに設定してそのファイルを指定するのです。一般的には、こういう場合

(モジュール名).rb
(モジュール名)/(クラス１).rb   # (モジュール)::(クラス１)を定義したファイル
              /(クラス２).rb
              /...

というようにネームスペースとディレクトリ階層を対応させた構造で配置します。この形式を「Rubyスタイルなモジュール」と呼びます。(少なくともここでは)。LoadingModule はこういったネームスペースまで対応した動的な呼び出しを実現しつつも、それらを利用するための宣言も必要ない、という大変便利なものです。そのメカニズムを知らなくても使えるのですが、モジュール名のバッティングや動的参照に問題が発生すると原因究明に思わぬ時間を費やすことがありますし、何より Rails 以外で利用する場合のためにも、その挙動を把握しておきましょう。

● ロードパスの設定

Ruby のロードパス($:)に入っているものは自動的に読み出しの対象になりますので、active_support を require するだけで動的呼び出しの恩恵を受けることができます。また、Rubyスタイルのモジュールを動的に呼び出す場合は、LoadingModule.root メソッドでそのパスを指定する必要があります。

Controlloers = LoadingModule.root(*load_paths)

引数でパス(複数可)を渡して、戻り値(RootLoadingModuleのインスタンス)を Controllers という定数に入れます。(定数名も固定なら中で勝手にやってくれればいいのに)。具体的には、Rails では config/environment.rb に以下のような記述があります。

Controllers = Dependencies::LoadingModule.root(
  File.join(RAILS_ROOT, 'app', 'controllers'),
  File.join(RAILS_ROOT, 'components')
)

これにより、app/controllers/ と components/ 以下にあるファイルは、Rubyスタイルなモジュールとしても動的に呼び出すことが可能になります。管理上、クラス名のトップレベルに Controllers というネームスペースがつきますが気にしなくて大丈夫です。この environment.rb のデフォルトファイルから、lib には通常モジュール(ライブラリ)、components には Rubyスタイルなモジュールを置く、という利用法が Rails で期待されていることが読み取れます。

● クラス参照時のメカニズム

大雑把に言うと、以下の流れで動的なクラス(定数)が呼び出されます。

const_missing が発生
クラス名→ファイル名変換 #Inflector.underscore(name)
ロードパスから対象ファイルを検索

まず、const_missing が参照のトリガになります。次に Rails ユーザにはお馴染みのファイル名変換が入ります。これは大筋でクラス名(定数名)の先頭以外の大文字の前に'_'を追加して全部小文字にする変換です。(連続する大文字とかが違うけど省略)。LoadingModule が利用されている場合は、ネームスペースまで考慮されます。

Inflector.underscore('AccessLog')
  => "access_log"
Inflector.underscore('HelloProject::Units::BerryzKobo')
  => "hello_project/units/berryz_kobo"

● rails 以外での利用例

例えば、lib/*.rb にライブラリ、modules/* に適当なモジュールがある場合。

# lib/db_adapter.rb:
module DBAdapter
  def load

# modules/hello_project/units/berryz_kobo.rb:
module HelloProject
  module Units
    class BerryzKobo
      include HelloProject::DBAdapter
      # include DBAdapter だと lib/db_adapter.rb が参照されてしまう

# modules/hello_project/db_adapter.rb:
module HelloProject
  module DBAdapter
    def load

実行ファイルです。

# test.rb:
#!/usr/bin/ruby

require 'active_support'                                    # 動的呼び出しの設定
$: .unshift 'lib'                                           # lib/*.rb は通常の動的呼び出し
Controllers = Dependencies::LoadingModule.root('modules')   # modules/* はネームスペース付き動的呼び出し

berryz = HelloProject::Units::BerryzKobo.new
berryz.load
...

● おまけ

从 ’w’) ＜View には Helper があるけど、Controller には何でないんだろう？

ﾙ＇-＇ﾘ＜LoadingModule をマスターしたこの可愛い桃子様にかかれば簡単よ♪

# config/environment.rb:
$: .unshift('app/presenters')

# app/presenters/berryz_presenter.rb
module BerryzPresenter
  def members
    Berryz.find_all
  end

# app/controllers/berryz_controller,rb
class BerryzController < ApplicationController
  include BerryzPresenter
end

ﾉﾉl∂_∂'ﾙ＜そもそも、app/models とかはライブラリ扱いで、app/controllers/ がモジュール扱い(LoadingModule)てことは、、、

州*‘ o‘リ＜app/controllers/helpers/berryz.rb に置いて、include Helpers::Berryz が期待されてるのかしら？

（´(ｴ)｀）ｲ＜でも、Berryzがモデルと衝突してるから怖いクマー。

川´・_・｀川＜BerryzHelper も View のとかぶっちゃいますね。

从´∇｀从＜BerryzControllerHelper ... は、長いですしー。

从oﾟーﾟ从＜結局、よい名前が見つからなかったから Controller にはヘルパがない、とゆいたいです。

从 ’w’) ＜とりあえず、桃ちゃんのがいいかな？(presenter かどうかはおいといて)

ﾉﾉl∂_∂'ﾙ＜あとは、Controller を圧迫する複雑なSQLとかをリソースに追い出すのも楽しいかもね♪

# config/environment.rb:
  File.join(RAILS_ROOT, 'resources'),   # LoadingModule.root の中に追加

# resources/sql/berryz.rb
module Sql
  module Berryz
    SELECT_MEMBER  = <<EOF
      SELECT * FROM ...
    SELECT_CONCERT = ...

# app/controllers/berryz_controller,rb
class BerryzController < ApplicationController
  def information
    @members  = Berryz::find_by_sql(Sql::Berryz::SELECT_MEMBER)
    @concerts = Berryz::find_by_sql(Sql::Berryz::SELECT_CONCERT)
  end

州*‘ o‘リ＜こうして天使達は肥大化しがちな Controller をスリムにしたのでした。

从’w’) ＜デレデレ!!シンデレLOVE!!

[ツッコミを入れる]


		2005年 8月
日	月	火	水	木	金	土
	1	2	3	4	5	6
7	8	9	10	11	12	13
14	15	16	17	18	19	20
21	22	23	24	25	26	27
28	29	30	31