Pryで例外をスマートに扱う方法｜バックトレース表示からカスタマイズまで

Rails開発者なら、Railsコンソールを頻繁に使う方も多いのではないでしょうか。そして今や、RailsコンソールといえばPryが定番。素のIRBと比べると、その使い勝手は段違いです。

実はPryには、例外を扱う際に非常に便利な機能が標準で組み込まれています。この記事では、その中でも特に役立つ3つの機能を紹介します。

直近の例外の完全なバックトレースを表示する

Pry(IRBでも同様)で例外が発生すると、通常は短縮されたバックトレースが表示されます。多くの場合それで十分ですが、詳細を確認したい場面もありますよね。

そんなときは wtf -v コマンドを使いましょう。直近の例外の完全なバックトレースを表示できます。-v フラグを外せば、短縮版のバックトレースが表示されます。

wtfコマンドで直近のバックトレースにアクセスする

例外オブジェクトのデータにアクセスする

例外には、エラーの原因を突き止めるうえで有用なデータが付随していることがよくあります。IRBではクラス名とエラーメッセージしか確認できませんが、Pryなら実際の例外オブジェクトそのものにアクセスできます。つまり、必要なデータを自由に取り出せるのです。

直近で発生した例外を取得するには、_ex_ 変数を使用します。Ruby組み込みの $! 変数と異なり、rescueブロックの中にいる必要がないのがポイントです。

_ex_ ローカル変数で直近の例外にアクセスする

例外の表示方法をカスタマイズする

「Pryでは常に完全なバックトレースを見たい」という場合は、デフォルトの例外ハンドラを上書きすればOKです。

~/.pryrc を開いて、以下のように記述しましょう。

# このコードはPryのデフォルト例外ハンドラをもとにしています。
# 元のコード: https://github.com/pry/pry/blob/master/lib/pry.rb

Pry.config.exception_handler = proc do |output, exception, _|
  if UserError === exception && SyntaxError === exception
      output.puts "SyntaxError: #{exception.message.sub(/.*syntax error, */m, '')}"
  else
    output.puts "#{exception.class}: #{exception.message}"
    output.puts "from #{exception.backtrace}"   
  end
end

さらに工夫すれば、「Pry内で発生したすべての例外をHoneybadgerにログとして送信する」といった応用も可能です。ぜひ自分のワークフローに合わせてカスタマイズしてみてください。:)