Visual Studio CodeにおけるPadrinoのデバッグ方法

Microsoft社から無償で提供されている、Visual Studio Codeを用いて、
Padrinoフレームワークで作られたRubyプログラムのデバック方法について説明します。

今回は、Windows(64bit版)での操作方法を紹介いたします。

1. Visual Studio Codeのインストール

下記URLよりダウンロードします。
https://www.visualstudio.com/ja-jp/products/code-vs.aspx1

今回は、Windows版を選択します。
2

画面に従って、インストールを進めていきます。
3

途中、エクスプローラのコンテキストメニューに『Codeで開く』という項目を追加するかどうか聞かれます。
これはチェックを付けても付けなくでも動作に影響は無いですが、特に理由が無ければチェックを付けておいた方が良いです。
(チェックを付けておくと、フォルダやファイルを右クリックし、Codeで開くを押すと、直接Visual Studio Codeが起動します)
4

画面に従い、インストールを完了させます。
インストールが完了すれば、スタートメニュー内のすべてのアプリに、Visual Studio Codeが追加されます。

2. Visual Studio Codeの拡張機能『Ruby』のインストール

Visual Studio Codeを起動し、左のメニューの一番下の項目(拡張機能)を選択します。
5

出てきたメニューの検索ボックスの中にrubyと入力。
下記画像の丸でくくってあるRuby拡張機能をインストールします。
6

なお、インストール後、拡張機能を有効にするためには、Visual Studio Codeの再起動が必要になります。

3. Rubyのデバッグに必要なGemのインストール

コマンドプロンプトで操作してもインストール出来ますが、Visual Studio Codeには統合ターミナルという、コマンドプロンプトとほぼ同じ機能を備えているものが統合されているので、今回は、統合ターミナルを使った方法で解説します。

Visual Studio Codeを起動し、Ctrlと@を同時押しします。
そうすると、下記画像のように、画面下に統合ターミナルが表示されます。
7

統合ターミナル内に、以下のコマンドを入力します。

gem install ruby-debug-ide
gem install debase

8
Padrinoのインストール時と同様、自動的に必要なgemを探してインストールしてくれます。

4. Gemfileへの追記

genetateしたPadrinoプロジェクト直下にある『Gemfile』ファイルに以下の文を追記します。

gem 'ruby-debug-ide'
gem 'debase'

9

追記したGemfileを保存後、bundle installを実施します。
10

5. デバッグを実施する

Visual Studio Codeの上から4つ目のメニュー(デバッグ)を選択し、出てきたサイドメニューの中にある歯車をクリックします。
11

上部にメニューが出てくるので、その中のRubyを選択します。
12

選択後、歯車の左のプルダウンメニューが選択可能となるので、その中のListen for rdebug-ideを選択します。
13

統合ターミナルを起動し、以下のコマンドを入力し実行してください。

bundle exec rdebug-ide --host 127.0.0.1 --port 1234 --dispatcher-port 26162 -- bin/(プロジェクト名) s

14

デバッグ再生ボタンを押すと、画面下にデバッグコンソールが立ち上がり、デバックがスタートします。
この際、デバッグコンソールには何も表示されませんが、プログラムにバグが無ければ、デバッグは正常にスタートしています。
15

正常に起動してるか確認のため、Ctrl + @ を押して統合ターミナルを表示します。
すると、padrino startした時と同じように、WEBrickがポート3000で起動していることが確認できます。
16

http://localhost:3000/など、適切なURLを入力するとプログラムが起動し、結果がブラウザに表示されます。
17

6. ブレークポイント・ステップインの活用

本家Visual Studioと同様、Visual Studio Codeにも簡易的ではありますが、ブレークポイント・ステップインを使用することができます。

プログラムを一時停止させたい行番号の左側をクリックし、赤丸を付けてあげます。
上記デバック手順実施時に、赤丸を付けた行で処理が一旦停止し、停止した時点での変数の情報などが左側に表示されます。
18
この状態から、F10を押すとステップイン動作となり、一処理毎の状態を確認することができます。
19

以上が、Visual Studio Codeにおける、Padrinoフレームワークを用いたRubyプログラムのデバッグ方法の簡単な説明になります。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA