概要

開発者のマシンで開発環境を構築する際にDocker及びDocker composeを使って開発することが一般的になりました。いままではターミナルからdocker composeコマンドを実行してテストや動作確認をしていましたが、VS CodeのDev Containers拡張を使いよりVS Codeで便利に開発する方法を提案します。今回はRuby3.1のdebug.gemを使ったRailsプロジェクトで、VS Codeのデバッグ機能をDev Containersと一緒に使う方法を紹介します。

今回紹介する機能のセットアップ方法は下記リンクの前回の記事を参考にしてください。

VSCodeでDockerを使ってRailsを開発しよう~Dev Containers編~

開発者のマシンで開発環境を構築する際にDocker及びDocker composeを使って開発することが一般的になりました。ターミナルからdocker composeコマンドを実行してテストや動作確認するのがセオリーですが、VS CodeのDev Containers拡張を使うことによりVS Codeで便利に開発する方法を提案します。今回はRailsプロジェクトを使ったDev Containersのセットアップ方法を紹介します。

blog.uzumaki-inc.jp

VSCodeでDockerを使ってRailsを開発しよう~Dev Containers編~

目的

VS CodeとDockerを使ってRailsを開発している際により便利にします(以下コンテナと記載されている箇所はDockerコンテナ及びDocker Composeで起動したコンテナ群を指します)

VS Codeのデバッグ機能を使ってブレークポイントをGUIで設定することでRubyMineのデバッガのようなデバッグ体験する
Ruby3.1以降で動いているRailsプロジェクトでdebug.gem(rdbg)を通してデバッグ実行方法を確立する

対象読者

VSCodeを使うRailsエンジニア

PR

UZUMAKIではアジャイル開発で新規事業の開発から、大規模Webアプリケーションのアーキテクチャ更新などの開発をしています。

お問い合わせはUZUMAKIのHPのお問合せフォームから

株式会社UZUMAKI

UZUMAKI（うずまき）はエンジニア・デザイナー・ディレクターで構成されるギルド型開発チーム。成長するWebサービスやアプリのリニューアル・リファクタリングに強みがあります。

uzumaki-inc.jp

本文

準備

本記事のサンプルコードは下記URL(vscodeタグ)にあります

GitHub - konyu/base_rails at vscode

Contribute to konyu/base_rails development by creating an account on GitHub.

github.com

前提条件

M2 CPUのMac
Docker desktop for mac: 4.16.2
Ruby: 3.2.1
Rails: 7.0.4
MySQL: 8
※ 細かいバージョンはDockerfile、docker-compose.ymlに記載
rails new コマンドで適当なRailsプロジェクトを作成し、Post, Commentモデルをscaffoldで作成ずみ

環境構築については一つ前のBlogを参考にしてください。今回必要な拡張機能のVSCode rdbg Ruby Debugger のインストールもしています。

VSCodeでDockerを使ってRailsを開発しよう~Dev Containers編~

blog.uzumaki-inc.jp

debug.gemを利用したデバッグ設定

Ruby3.1から導入されたdebug.gemを使った設定を説明します。

※ ワークアラウンド的なこともしており、不明な点もあるのでご承知おきください。launch.json 内のコマンドで bundle exec railsはうまく動かないがbin/rails なら動くなどまだ不明な点があります

最初にVS Codeの右側のパネルにあるデバッグ部分で利用する .vscode/launch.json を作成します。

{
    "version": "0.2.0",
    "configurations": [
        {
            //Rails serverを起動します
            "name": "Debug Rails",
            "type": "rdbg",
            "request": "launch",
            // "command": "bundle exec rails", //bundle exec rails だとデバッガで止まらない
            "command": "bin/rails",
            "script": "s",
            "args": ["-b","0.0.0.0"],
        },
        {
            // アクティブになっているRspecファイルのテストを実行します
            "name": "Debug Rspec with current file",
            "type": "rdbg",
            "request": "launch",
            "command": "bundle exec rspec",
            "script": "${file}",
            "args": [],
            // 実行コマンドをウインドウで確認。特定行の実行などオプションを指定しやすくする
            "askParameters": true
        }
    ]
}