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 - Graph Visualization Software
をインストールします。
グラフを作成する為に使ったりするソフトですね。
以下のコマンドを実行してパッケージをインストールして下さい。

yum -y install graphviz

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

rails-erdインストール

次に
https://rails-erd.rubyforge.org/
をインストールします。

まず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

RubyOnRailsでモデル同士のattributesを可視化したい時ってりますよね。 DBのER図の様に出力されたら便利だなって事を実現できるgemのrails-erdの導入です。

このブログの人気の投稿

AnacondaとPythonのインストール（python2とpython3の共存）とDjango

イメージ
個人的にdjangoとnumpyなどPythonを使う機会があり、 折角なのでローカル開発環境としてのAnacondaのインストール方法をまとめました。 僕の環境がGCPのSDKが入っている関係で、Python2とPython3の共存が必要ので、その辺りもあります。 前提 Windows（Macと手順のベースは変わらないですが、コマンドに若干再有り） pythonコマンドだとPython2が動作し、python3だとPython3が動作します 手順 Anacondaのインストーラーをダウンロードしインストール ※ Python2と3を共存させる場合、インストーラーでPathは通さない。 Pathを通す インストールディレクトリ\Anaconda3 インストールディレクトリ\Anaconda3\Scripts インストールディレクトリ\Anaconda3\Library\bin Anaconda3内のシンボリックリンクを作成する それぞれAnaconda3内にあるexeです。 元のexeがある場所にそれぞれに3を付けたシンボリックリンクを作成します。 ショートカットだと上手く動作しなかったので、シンボリックリンクとしました。 python.exe -> python3.exe anaconda.exe -> anaconda3.exe anaconda-script.py -> anaconda3-script.py conda.exe -> conda3.exe conda-script.py -> conda3-script.py easy_install.exe -> easy_install3.exe easy_install-script.py -> easy_install3-script.py pip.exe -> pip3.exe pip-script.py ->pip3-script.py spyder.exe -> spyder3.exe spyder-script.py -> spyder3-script.py 動作確認 コマンドプロンプトでpythonとpython3で
続きを読む

PyCharmでAnaconda(Python)とDjangoの開発環境を構築する 　その２

イメージ
PyCharmのGUIのみでAnacondaの仮想環境と、Djangoの開発環境を作っていきます。 前提として、 Anacondaはインストール済み 例題のプロジェクト名は skyline 例題のアプリ名は gtr 例題の仮想環境名は nissan と想定します。 Anacondaのインストールはこちらをご覧下さい。  www.techbox.jp PyCharmを起動して、[Create New Project]を選択します。 左のツリーから[Django]を選択し、[Location]にプロジェクトの保存先を指定します。 末尾が ～\untitled になっているので、作成するプロジェクトの名前に変更します。 [interpreter]の右の歯車をクリックし[Create conda env]を選択します。 ここから新規でAnacondaの仮想環境の作成が行えます。 [Name]に仮想環境名を入力します。ここでは nissan そうすると、[Location]にはAnacondaの仮想環境保存先が指定され、末尾が[Name]で指定したディレクトリになるハズです。 最後に使用するPythonのバージョンを指定します。 OKを押すとAnacondaの仮想環境の作成が始まるので、しばらく待ちます。 終わったらロケーションに設定したディレクトリに nissan フォルダが作成されています。 New Project画面に戻るので、[More Settings]をクリックし、設定画面を表示します。 [Template language]に Django [Application name]に gtr を設定し、[Enable Django admin]はお好みでチェックを入れます。   ここで注意点ですが、プロジェクト名とアプリケーション名は同一の物は設定できません。 これらの名称の関係性としては、作成後のフォルダ構成を見れば分かりますが、 以下の様な形で作成されます。 skyline/ ├ gtr/ │ ├ migrations/ │ ├ _init_.py │ ├ admin.py │ ├ apps.py │ ├ models.py │ ├ tests.py
続きを読む

PyCharmでAnaconda(Python)とDjangoの開発環境を構築する 　その１

イメージ
今回はPyCharmでPythonとDJangoの開発環境を作っていきたいと思います。 Pycharmはデフォルト設定とプロジェクト設定、２パターンの設定方法があります。 今回は、 既に作成した仮想環境を、Pycharmデフォルトの設定にする 方法を行っていきます。 プロジェクト単位での設定と、完全にGUIで構築する手順はその２で記載します。 Anaconda、Djangoインストールと仮想環境構築 以下のリンクに沿って実行して下さい。 www.techbox.jp Pycharmを起動し、スタート画面で右下の [configure]>[settings] をクリック 左のツリーから[Project Interpreter]を選択し、 右側上部のコンボボックスに、手順1で作成した仮想環境のpython.exeがリストアップされる事を確認し、選択します。 選択すると仮想環境にインストールされているパッケージの一覧が表示されます。 ここでDjangoがインストールされている事がわかります。 [Apply]を押し、設定を保存します。 以上でデフォルトの設定が完了しました。 後はCreate new projectやGitからリポジトリを取ってきて、 今回の設定をベースに立ち上げる事が可能です。 今回はAnacondaの仮想環境を手動で作成し、Pycharmのデフォルト設定のみを設定する方法でした。 その２では、仮想環境の構築、Djangoのインストール、新しいプロジェクトの立ち上げまでをPycharmのGUIのみで行う手順を書こうと思います。 実際の所、次の手順で立ち上げる事の方が多いような気がします。
続きを読む