Pryでデバッグをする方法と組み込みメソッドを調べる方法を学んだので共有します。
Pryとは
そもそもPryとはGemの一種でRubyで使える外部パッケージです。
REPLと呼ばられるコードを1行ずつ実行していく対話型の仕組みを持っています。
結論
- デバッグについては標準で使えるruby/debugを使ってもどちらでもいいと思いました。
- 組み込みクラスを調べる方法は便利です。irbでのやり方を知らないだけかもしれませんが
ここから本文です。
今回Pryについて調べてわかったこと
- REPLで対話型デバッグができる
- REPLで組み込みクラスやメソッドの説明が見れる
必要なGem
Gemfileに記入してください
#本体
gem 'pry'
#デバッグ用
gem 'pry-byebug'
#Rubyのドキュメントの情報
gem 'pry-doc'
デバッグの仕方
#ファイルの先頭に記載
require 'pry-byebug'
#デバグを開始する位置で
binding.pry
プログラムを実行するとブレークポイントで一時停止し、対話しながら実行できるようになる
step 1行処理をする。メソッドの場合は中に入る
next 1行処理をする。メソッドの場合は中に入らない
ls 今見れる変数やオブジェクトの一覧を表示
<変数名> 中身の値を教えてくれる
continue 次のブレークポイントまで進める。
exit プログラムを最後まで実行する
組み込みクラスやメソッドの説明を見る
#REPLを起動
$ pry
#ドキュメントを読み込む
$ require 'pry-doc'
#メソッドの一覧を表示する
$ ls オブジェクト名
#メソッドの使いかたを見る
$ show-doc <クラス名>#<メソッド名>
#クラスの使い方を見る
$ show-doc <クラス名>
#コードを見る
$ show-source <クラス名>#<メソッド名>
#終了
$ exit
補足
pryをrailsで使う等、開発環境のみで使う場合はGemfileにグループを記入する
group :development, :test do
gem 'pry'
end
以上となります。
以下参考
【Rails】 Pryを使ってデバッグをしてみよう！
ChatGPT