連載
» 2011年02月28日 10時00分 公開

Railsで目指せ、情熱エンジニア(4):忘れやすい人のためのRailsリファレンスガイド (1/2)

日々の開発の中で調べ物をする環境を整えるのは、効率面でも精神面でも重要です。今回は便利なRubyやRails開発に役立つサイトやツールのご紹介です。

[井上真,@IT]

「あれどうやるんだっけ?」を素早くこなすために

 Railsのリファレンスガイドを書くに当たって、最初は「Rails英語の紹介」をと思ったのですが、それはRailsDevConで@IT編集部の西村さんがあらかたカバーされているようなので(関連記事:Rails情報源の歩き方)、ここでは私がほぼ毎日使用するものに絞って紹介したいと思います

 西村さんの情報は「どうやってエッジな情報を収集するか」ということに焦点が置かれていましたが、ここでは「そういえばああいうのがあったのだけど、どうやって使うんだっけ?」というときに役立つ情報をまとめてみました。

公式ガイドははずせない

 当たり前すぎる感じもしますが、やはりRails3関係について系統だって説明しているということについては、「Rails Guides」が一番だと思います。Googleで何かのトピックについて検索すると、だいたいここか、Stack Overflowが出てくるので、最初からあたるようにしています。「ActiveRecordについては知っているのだけれど、Rails2からRail3になってどう変わったのだろう」といった情報にアクセスするのに最適です。

公式サイトにあるRails Guidesは必見! 公式サイトにあるRails Guidesは必見!

手元でAPIを検索できる「Rails Searchable API Doc」

 上記の公式ガイドは、比較的新しいことを学ぶのに使用していますが、「あのメソッドの使い方を忘れた」といった場合は、API Docを使います。

 オフィシャルのAPI Docでも良いのですが、私が愛用しているのは、このSeachable API Docです。このサイトは、JavaScriptによるインクリメンタル検索(1文字タイプするごとに検索ヒットが絞り込まれる)ができるほか、RubyとRuby on Railsの両方のAPIを一度に検索できるページが用意されていて便利です。

オンラインでRuby、Railsの任意のバージョンを組み合わせてAPIが検索できる「Rails Searchable API Doc」 オンラインでRuby、Railsの任意のバージョンを組み合わせてAPIが検索できる「Rails Searchable API Doc

 しかも、このサイトはHTMLとJavaScriptでできていますので、いちいちこのサイトにアクセスしなくても、Ruby DocとRails Docがパックになったものをまとめてダウンロードして、ローカルで使うこともできます。こうすれば電車の中でオフラインのときにもアクセスできます。

 さらにこのサイトの親切なところは、自分が必要とするRubyとRailsのバージョンを指定すると、カスタマイズしたパッケージも作ってくれることです。原稿執筆時点では、Rubyなら1.8/1.9、Railsは2.2.2/2.3.8/3.0.3、そしてAuthlogic、Rack、RSpec、AWS-S3、Haml、Nokogiriなどメジャーなgemsのドキュメントが用意されています。これらのうち必要なものとバージョンをブラウザ画面で選択すると、その場でダウンロード用のバイナリが切り替わります。後はzipファイル(選択によって2MBから7MB程度)をダウンロードして、ローカルで解凍、適当なフォルダに入れてブックマークしておけばオーケーです。

自分が必要とするRubyとRailsのバージョンを指定して、カスタマイズしたパッケージも作ってくれる 自分が必要とするRubyとRailsのバージョンを指定して、カスタマイズしたパッケージも作ってくれる

 理想をいえば、どのプロジェクトでも常にエッヂなRubyとRailsのバージョンを使えれば良いのですが、プロジェクトによっては古いバージョンを使い続けていて、アップグレードする時間がないときがあります。そういう場合に、自分のプロジェクトで使うバージョンのものをダウンロードしておくと良いでしょう。私の場合は「Rails 2.3.8+Ruby.1.8」「Rails 3.0.0+Ruby 1.9」のドキュメントセットを利用しています。

Macの辞書としてAPI Docを入れてしまう

 「いちいちブラウザを開くのもめんどくさい」というものぐささんであれば、辞書にAPI Docを内蔵させるというのはいかがでしょうか。Ruby on Rails dictionary for Mac OS Xというサイトからファイルをダウンロードして、「~/Library/Dictionaries」に放り込むだけで、以下のようにMacの辞書内でRailsのメソッドが検索可能です。設定(プリファレンス)で辞書の優先順位を上げておくと、spotlightの検索にも出てくるようになります。

 ちなみに、RailsではなくRuby版の辞書もあります。

Macの辞書として登録する方法もある Macの辞書として登録する方法もある

Index

忘れやすい人のためのRailsリファレンスガイド

Page1
「あれどうやるんだっけ?」を素早くこなすために
公式ガイドははずせない
手元でAPIを検索できる「Rails Searchable API Doc」
Macの辞書としてAPI Docを入れてしまう

Page2
手早く「チート」する方法
ローカルにドキュメントサーバを立てる
gemのソースをコマンド一発で参照!
今回のまとめ


       1|2 次のページへ

Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。