[rails]has_manyなフィクスチャを書くのに疲れたらFactory Girlがオススメ！

haga — Sat, 25 Apr 2009 16:12:39 +0000

フィクスチャはメンテナンスしづらい

書籍The Rails Wayの中には「皆フィクスチャが嫌い」という項目があります（次の項目は「フィクスチャはそれほど悪くない」ですが）。

フィクスチャが嫌われる最大の原因は「メンテナンスが難しい」という事でしょう。
中間テーブルを必要とする多対多の関連をフィクスチャにしようと思ってうんざりした経験は誰にもでもあると思います。

Fixtureのhas_manyでこんな書き方したい
http://www.func09.com/wordpress/archives/369

フィクスチャの代わりにFactoryGirlを使ってみる

Factory GirlはRailsのテストにおいてfixtureの代替となるツールです。
つまりテスト時のモデルデータを用意するための仕組みです。
Factory Girlはフィクスチャと違い、Rubyのスクリプトで直接データを定義していきます。

特徴としては

Rubyコードで定義（YAMLやCSVではない）
関連のメンテナンスが楽
定義の継承もできる
同じ定義から連続的なデータを生成できる（シーケンス）

Rubyコードで実データを作る感覚でテストデータを定義するので、フィクスチャと違い中間テーブルのメンテナンスから解放されます。

インストール

インストールはgemで簡単にインストールできます。

sudo gem install thoughtbot-factory_girl --source http://gems.github.com

config/environment.rbに依存するgemとして登録しておくと、テスト実行時に自動でFactory Girlがロードされるので便利です。

config.gem "thoughtbot-factory_girl", :lib => "factory_girl", :source => "http://gems.github.com"

実際にサンプルを作ってみる

定義の継承やシーケンスといった機能も便利なのですが、とりあえず最大のメリットである複雑な関連をシンプルに定義できるという事を簡単なサンプルで証明したいと思います。

User,Page,Bookmarkという３つのモデルで簡単なブックマークアプリを作ります。

# app/models/user.rb
class User < ActiveRecord::Base
# name:string
has_many :bookmarks
has_many :pages, :through => :bookmarks
end

# app/models/page.rb
class Page < ActiveRecord::Base
# title:string
# url:string
has_many :bookmarks
has_many :users, :through => :bookmarks
end

# app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
# user_id:integer
# page_id:integer
belongs_to :user
belongs_to :page
end

UserとPageがBookmarkを中間テーブルとして多対多の関係になっています。

ファクトリーを定義する

Factory Girlは特定のクラスに対して名前を付けて雛形を定義することができます。

spec/factories.rbというファイルを作成し（rspecを使う場合）、次のように記述します

Factory.define :bob, :class => User do |f|
f.name "bob"
end

Factory.define :mike, :class => User do |f|
f.name "mike"
end

Factory.define :yahoo, :class => Page do |f|
f.title "Yahoo!"
f.url "http://www.yahoo.com/"
end

Factory.define :google, :class => Page do |f|
f.title "Google"
f.url "http://www.google.com/"
end

specもしくはtestディレクトリにfactories.rbというファイルか、factories/というディレクトリ内にrbファイルを配置すれば、自動的にFactoryGirlで定義が利用可能となります。

FactoryGirlはFactory.define(name,options)メソッドでテスト用のモデルインスタンスを作成する工場を定義していきます。

nameにはユニークな定義名を、optionsにはHashを渡します。とりあえず:classオプションがモデルクラスを指定することだけ覚えておきましょう。

ブロック引数に渡したfはfactoryインスタンスです。モデルに指定したattributeの雛形を定義しておきます。

ここではbobとmikeというユーザー、yahooとgoogleというページを定義しました。

テストから利用する

では実際にテストコードからFactoryGirlを利用してみます。先ほど定義したファクトリーを使ってインスタンス化する場合は

Factory.create(name)
Factory.build(name)

を使います。createは保存したインスタンスを、buildは保存前のインスタンスを返すようになっていて、createはデフォルトの場合、次のようなショートハンドが使えます。

Factory(name)

# spec/models/user_spec.rb
require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
describe User do
it "正常に保存できること" do
@user = Factory.build(:bob)
@user.save.should be_true
end
end

テストを実行すると、ちゃんと動いているのがわかります。 Factory.buildで取得できるオブジェクトはスタブやモックではなく、れっきとしたモデルクラスのインスタンスなので当然saveなどのメソッドが使えます。

User
- 正常に保存できること

Finished in 0.067948 seconds

1 example, 0 failures

最後に

どうでしょうか？FactoryGIrl。最近よく名前を聞くのに日本語で使い方を説明しているサイトが見つからなかったので、駆け足で使い方を説明してみました。

フィクスチャはやっぱり便利なところもあるので、使いたいのだけれど関連が絡んでくると一気にモチベーションが下がりますよね。 FactoryGirlはちょっと冗長だけれど、無理なく関連を管理できるので、これまでフィクスチャに悩まされてきた人にはおすすめです。

サンプル on Github
- http://github.com/func09/bookmark-factorygirl-sample/tree/master

参考

テストでスタブの掛け方に悩み中

haga — Thu, 23 Apr 2009 18:01:03 +0000

例えばActiveRecordで新規作成したタイミングでリモートにアクセスするような処理があったとして

class Item < ActiveRecord::Base
before_create :do_something_with_remote
def do_something_with_remote
open(self.url)
end
end

この場合、テストの時はItem#do_something_with_remoteをスタブにするよね。

item = Item.new :url => 'http://www.example.com'
item.stub! :do_something_with_remote

本当はこんな感じでかけたい

Item.stub_instance_method(:do_something_with_remote)

stubはそのオブジェクトにしか使えない？インスタンスメソッドまで影響するスタブはどう書けば良い？

–

Fixtureの代わりにFactoryGirlを使い始めた。これがなかなかシンプルで使い勝手が良いんだけど、関連を設定する時に上記のような作りの場合にちょっと困っている。 Factory.defineの中でインスタンスのメソッドにstubを設定できればいいんだよな。

Factory.define :item, :class => Item do |item|
item.stub!(:do_something_with_remote)
end

明日改造できるかソースコードを見てみる。 Factory.stubはあるんだし、できないことはないよな。

今は時間がないのでスペックヘルパーで

class Item
def do_something_remote;end
end

みたいに上書きして対処しているが・・・駄目だよな。
FactoryGirlに関してはノウハウが溜まったら書くかも。

rspec-railsでテスト結果を見やすくする

haga — Mon, 30 Mar 2009 10:14:34 +0000

はじめに

The Rails Wayを読了しました。 Railsの本は出版されたら大抵買って読むようにしているのですがその中でもかなり良著だったと思います。これから読む人はRailsアジャイルによるWebアプリケーション入門の後くらいに読むと良いですね。

さて、Rails Wayの素敵な点はテストに結構なページを割いているという点です。 Rails標準のテストとRspecによるテストにそれぞれ章だててあり、ページ数にすると60Pを超えます。本当はRspecだけで一冊書いてほしいくらいなんですが、それでも今日本語で読める本としては一番多いと思います。

Rspecの結果表示

rake specでもscript/autospecでもいいんですが、何も考えずに使っていると下の画像のようになります。

ま、これでもいいっちゃいいんですがフォーマットを買えてリスト表示（specdoc）にしたいなぁと思いました。

spec -cfs spec/hoge_spec.rb

こうオプションを渡した時みたいにね。

spec/spec.opts

specフォルダの中にspec.optsというファイルがあります。こいつの内容を見ると

--colour
--format progress
--loadby mtime
--reverse

おー、見覚えのある文字列が。。specコマンドに渡せるオプションをここに書けばフォーマットも変えることができそう。

--colour
--format specdoc
--loadby mtime
--reverse

こう書き換えたら・・

こうなりました。

こっちの方がいいっすね。

func09 » rspec