vi b(l)og rock!!!

1. p/pp

こちらはRailsに限らず良く使われている方法ですが、RailsではWebサーバをフォアグラウンドプロセスとして立ち上げた状態で使う感じになります。

   1  $ ./script/server

p/ppに慣れている人にはわかりやすくて良いと思います。

2. logger.debug

さて、続いてlogger.debugを使う方法です。

   1  logger.debug "something interesting information"

p/ppの代わりにlogger.debugを呼ぶ事で、結果がlog/development.logなどのlog/$RAILS_ENV.logファイルに書き出されます。 書き出されたファイルを、

   1  $ tail -f log/development.log

しておくと、p/ppでデバッグする時と同じような感じでデバッグ出力を見る事が出来ます。また、出力結果はlogファイルとして残っているので、後で参照する事もできます。

3. script/console

script/consoleは、実行時にデータベースの中身がどうなっているかを知りたい時に非常に便利です。script/consoleコマンドを実行すると、Railsの環境を読み込んだ状態でirbが立ち上がるので、ActiveRecordを使ってfindしたりcreateしたりdestroy_allしたり、好きなようにDBをいじる事ができます。本当に素晴らしい機能ですね。

4. script/breakpointer

script/consoleはとても素晴らしいのですが、アクション実行中のsessionの状態を調べたりするのには使えません。そんな時は、script/breakpointerを使う事ができます。

   1  $ ./script/breakpointer

まず、あらかじめbreakpointerを立ち上げておきます。続いて、状態を確認したい場所にbreakpointを仕込みます。

   1  class FooController < ApplicationController
   2    def bar
   3      # something
   4      breakpoint
   5      # something
   6    end

あとは、ブラウザからアクセスしてbarアクションを実行すると、待ち受けていたbreakpointerでirbが立ち上がるので、必要な情報を自由に閲覧・操作する事ができます。

5. better rails debugger

script/breakpointerはとても便利ですが、ステップ実行が出来ないという問題があります。 実際にステップ実行がどうしても必要という場面はあまり無いのですが、あればあったほうが便利ですね。そんな時は、ruby-debugというGemを使います。 これは前回のRails勉強会のときにyuguiさんから教えていただいた方法なのですが、まずはruby-debugをインストールします。

   1  # gem install ruby-debug

次に、ブレークポイントを仕込みます。

   1  class FooController < ApplicationController
   2    def bar
   3      # something
   4      debugger
   5      # something
   6    end

あとは、p/ppデバッグをするときのようにWebrickやMongrel等のWebサーバをフォアグラウンドで立ち上げ、目的のコードが実行されるようにブラウザからアクセスします。 すると、Webサーバのプロセス上でdebug.rb（と似たような感じのもの）が立ち上がるので、通常のrubyスクリプトを デバッグする時と同じ要領でデバッグを行う事ができます。

6. test/autotest

Ruby on Railsでは、テスト用のフレームワークがはじめから使える状態になっています。 テスト駆動開発では、テストを書いてから実装を書きますが、適当な動作検証用のコードをテストとして書くことで、デバッグに使う事もできます。この際、毎 回テストをrakeコマンドから実行するのは時間が掛かるので、ZenTestのautotestを使うのがお勧めです。 autotestを使うと、編集されたファイルに関連するテストだけを実行してくれるので、rakeコマンドを実行するよりも軽快なレスポンスが得られま す。さらにredgreenを併用すると気分良くデバッグを行う事ができるのでお勧め。

7. tail -f log/development.log&; autotest

最後に、僕が今使っている方法を紹介します。 開発用とは別に一つターミナルを立ち上げて、RAILS_ROOTで以下のコマンドを実行。

   1  $ tail -f log/development.log&; autotest

こうしておくと、プログラムやテストコードを編集した時はautotestの出力が表示され、ブラウザからアクセスした時にはロガーの出力が表示されます。 基本的に両者が同時に行われる事は無いので、一つのターミナルを有効利用する事ができておすすめ。

というわけで、Railsでデバッグを行う方法の紹介でした。