TechBox

スタートアップで働くRails&機械学習エンジニアのブログ。時々GT-Rと旅行。

RailsのAttributesを可視化するrails-erdをインストールする

RubyOnRailsでアプリを作っていて、generateする時には必死にDBのリレーションとか、 Model間のAttributionを考えてhas_manyとかbelongs_toとか付けていきます。

が、色々案件を抱えて一時的にソース見なかったりすると、
「アレ ドンナ関連付けサレテタッケ」ってなったりします。

それとか、だいぶコーディングが終わった後にモデル同士の関連付けの確認をしたくなった時など…
DBのER図的な物が見れたらどれだけ嬉しいかって思いますよね!

f:id:daisuke-jp:20161005160938p:plain

久々に開いたプロジェクトでアレってなったので、今回導入してみます。

実行環境

CentOS7
Ruby 2.2.4
Rails 4.2.6

準備

graphvizインストール

まずはこちら
Graphviz | Graphviz - Graph Visualization Software
をインストールします。
グラフを作成する為に使ったりするソフトですね。
以下のコマンドを実行してパッケージをインストールして下さい。

yum -y install graphviz

CentOS以外の方は、適宜OSに併せてインストールをして下さい。

rails-erdインストール

次に
Rails ERD – Entity-Relationship Diagrams for Rails
をインストールします。

まずGemfileに以下を記載します。

group :development, :test do
  gem 'rails-erd'
end

本番系でER図を出す必要はないので、developmentとtestのみで有効とします。
既にgroup :developmentなどがあれば、そちらの中に追記して下さい。

保存したら、

bundle install

を実行して下さい。

ER図生成

準備が出来たので、ER図を出力します。

rake erd

を実行して下さい。

正しく実行されるとプロジェクトフォルダ直下にerd.pdfが生成されます。
こちらを見ると、attributeをER図で表してくれます。

f:id:daisuke-jp:20161005160938p:plain

以上です。簡単でしたね。
他にrailroadyという物も有り、こちらを試してみるのも良いかもしれませんね。

www.techbox.jp

www.techbox.jp

www.techbox.jp