RailRoadで楽しむ。

Ruby on Rails

RailRoadを使うと、プロジェクトのモデル、コントローラーの内容や関係を視覚的に表現した図にしてくれる。具体的には以下のような結果が得られる。（CSVサーバープロジェクトの場合）
モデルの図
コントローラーの図

インストール

RailRoad自体のインストールは簡単で、ターミナルから以下の1行を実行すればOK。

gem install railroad

使い方

  • ターミナルで、利用したいRailsプロジェクトのアプリケーションルートへ移動する。（例えば、csv_serverプロジェクトであれば以下のように操作する。）
cd ~/railsapp/csv_server
  • あとは、railroadコマンドを以下のように操作すると、そのプロジェクトのdocフォルダの中に、models.dotとcontrollers.dotが生成される。
モデルの場合
railroad -i -l -a -m -o doc/models.dot -M
コントローラーの場合
railroad -i -l -o doc/controllers.dot -C

dotビューアー

生成されたmodels.dotとcontrollers.dotは、そのままではテキストファイルとして開かれてしまい、見慣れない文字の羅列になってしまった...。実は、dotファイルを図的に表現してくれるビューアーを使う必要があった。以下の二つをインストールした。（利用環境はMacBook）

  1. Graph Visualizationのページより、Graphviz Mac OS X Builds Graphviz 2.12 Intel.dmg
  2. Mac OS X graphvizのページより、graphviz-1.13-v16.dmg


それぞれインストールしたら、2.のgraphvizアプリケーションにmodels.dotなんかをドラッグ&ドロップしてみる。すると...見えた、見えた！
図で表現するまでもなく、まだまだシンプルな構成のCSVサーバープロジェクト。でも、気付いたことが一つあって。未使用のメソッドが定義したままでした...。あとで削除しておこう。
こんな風に全体像を俯瞰することも、時には必要かも。

きっかけのページ

MOONGIFT: » Railsを見える化「RailRoad」:オープンソースを毎日紹介
素晴らしい情報に感謝です！