新しく加わったRuby on Railsプロジェクトを素早く把握するコツと便利なツールのご紹介

こんにちは、TECH DRIVEのTedです。

今回は新しく加わったRuby on Railsプロジェクトを素早く把握するための便利なツールをご紹介します。 本記事はこれから開発現場に入っていく方や、新しく別の現場に入られる方のお役に立てる記事になっていると思います。

本題

新しく入ったプロジェクトを手元のマシンにとってきた後に環境構築を始めると思います。
そして、例えばgithubを使っている現場であれば「さて、振られたissueを対応していきますか!」と開発を始めることになると思いますが、自分が加わったプロジェクトについての情報がないとスムーズに開発の流れに乗れないと思います。 逆に、情報が多いと効率よく開発作業を進めることができるはずです。

ここで情報が手元にない時に情報を集める方法がいくつかあるかと思いますが、 私の場合は下記の情報があると開発を始めやすいのではないかと思います。

  1. データベースの詳細、テーブル数やその相関関係
  2. ルーティングの規模感
  3. ディレクトリ構造

2~3についてはプロジェクトのコードを読むことで解決できます。例えば

2. ルーティングの規模感が調べたければroutes.rbを読んでみたり、bin/rails routesを実行してみると良いでしょう。

3. ディレクトリ構造rails newで自動生成されるディレクトリ以外についてで、よく使われているディレクトリではapp/decoratorsapp/services(このあたりはプロジェクトによって多少の違いはあります)のようなディレクトリです。見慣れないディレクトリ名を見つけた時は気をつけましょう。

今回は下記に焦点をあてたいと思います。

データベースの詳細を知りたい

先ほど、挙げた3項目の中で最も大事だと思います。

この1. データベースの詳細、テーブル数やその相関関係についてはER図があると把握しやすくなります。

ER図とは下記のようなテーブル同士の関係を示す図のこと

f:id:travy:20190327183149p:plain

schema.rbを参照することで同様にテーブル数や相関を読むこともできますが、ER図ではこのあたりを図で見ることができるので理解しやすく、schema.rbを見るよりもよりテーブル構造を把握することができるでしょう。

ER図をプロジェクトのチームが持っているならば共有してもらえば良いのですが、持っていない場合もあります。

そんな時に自動でER図をPDF形式で生成してくれるrails-erdというgemが存在します。

rails-erdの導入

Gemfileに以下のような記述をします。本番環境で使うことはないのでdevelopment環境で使えるようになっていればOKです。

*Gitを使用して開発をしている場合、既存のコードを汚さないために新しく作成したブランチで作業することをお勧めします。

group :development do
  gem 'rails-erd'
end

続いてgemをインストールします

bundle install

これで準備完了です!あとはER図を出力するだけです

bundle exec erd

下記のような図が出力されます。

f:id:travy:20190327154800p:plain

ER図をコマンド1発で手に入れることができるのは非常に強力だと思います。

ER図があると何が良いのか

ここで、ER図があると何が良いのかおさらいしておきましょう。

ER図があると親子関係や中間テーブルのようなテーブル同士の相関を一目で見ることができ、各テーブルがどのようなカラム、つまりどのような情報を持っているのかも把握することができますし、開発する時にもテーブル同士の関係性を確かめながら進めることができます。

さらに、図で見ることでサービスにおいて重要なテーブルや機能を推察するためのヒントが得られます。

ER図から得た情報は、プロジェクトの中で目を通しておくべきコードの把握や、その意味を理解するための助けになります。

終わりに

ER図が手元にある状態でコードリーディングや開発作業をすると凄く心強い気持ちになれます。

余計な脳のリソースを使うことなくテーブル構造をインプットできるER図はとても強力です。

私もよく自分で作ったサービスだったり関係するプロジェクトのER図を今回ご紹介したrails-erdで描画しようとします。開発中も常にER図の画面を開きながら開発しています。

本記事を通して少しでも新規プロジェクトへの加入が楽になるのであれば幸いです。

PR

TECH DRIVE協賛企業のサークルアラウンド株式会社では、プログラマーの成長を加速させるためのトレーニングを行なっています。フロントサイドからバックエンドまで各種バリエーションがございますので、ご興味がある方は是非以下のリンクより詳細をご覧ください。

Ruby Climbing

週1からはじめられる「Ruby」でWEB開発の基礎が習得できる塾です。現役のプログラミング講師&Rubyエンジニアがプログラミング入門からフレームワーク(Sinatra/Ruby on Rails)を使用した本格的なWEB開発の学習までをしっかりとサポートします。

ruby climbing

個別トレーニング

短期間でぐっと成長したい方は弊社主催の個別トレーニングがおすすめです。 トレーニング内容は、受講者の方の課題/要望をお伺いした上で、フルオーダメイドで作成させていただきます。 詳細は以下のリンクよりご確認ください。(応募者多数の場合には時間を別途ご用意する予定です)。

WEBプログラミング個別トレーニング

TECH DRIVEについて

TECH DRIVEは「技術者の成長を加速させる」をキーワードに都内で活動をしているコミュニティです。
TwitterやFacebookにて技術ネタやイベント情報の発信を行っていますので、ご興味があれば、いいねやフォローをお願いいたします。