RailRaod는 Rails Application의 Model과 Controller의 현재 모습을 그래프를 통해서 시각화된 모습으로 확인할 수 있도록 도와준다.

RailRoad는 rails 의 model과 controller로부터 얻을 수 있는 has_many같은 관계들과 상속 정보를 가지고 dot파일을 만든다. dot 파일에는 model과 controller의 그래프 정보가 포함되어 있는데, 이 dot파일은 graphivz를 통해서 png 같은 이미지 혹은 svg 형식으로 변경할 수 있다.

설치

Graphviz 를 설치한다.

railroad gem을 설치한다.

1. gem install railroad

사용하기

model diagram

model의 구조를 png 이미지 파일로..

1. railroad -i -l -a -m -M | dot -Tpng> doc/models.png

controoler diagram

controller의 구조를 svg 형식으로..

1. railroad -i -l -C | neato -Tsvg > doc/controllers.svg

Firefox를 통해서 SVG파일을 확인할 수 있다.

Explore를 통해서 보고 싶다면 SVG Viewer 를 설치한다.

task로 정의해 놓으면 편리하게 이용할 수 있다.

1. namespace :doc do
     namespace :diagram do
       task :models do
         sh "railroad -i -l -a -m -M | dot -Tpng > doc/models.png"
       end
   
       task :controllers do
         sh "railroad -i -l -C | neato -Tpng > doc/controllers.png"
       end
     end
   
     task :diagrams => %w(diagram:models diagram:controllers)
   end

참조

http://railroad.rubyforge.org

이 글은 스프링노트에서 작성되었습니다.