A documentação de projetos é algo importante, coisa que normalmente os desenvolvedores acabam deixando de lado, mas quando se está trabalhando com um projeto Rails, a documentação do banco de dados e dos controllers fica bastante facilitada, utilizando um utilitário chamado RailRoad.
o RailRoad pode gerar os seguintes diagramas:
- Diagramas de modelos (MER), mostrando tanto a hierarquia de classes(herança) como as associações existentes no smodelos. é possível também escolher se quer ou não exibir informações sobre colunas e sobre os tipos de dados utilizados.
- Diagramas dos controllers, mostrando a hierarquia de classes (herança). É possível incluir os métosos, inclusive agrupados pela visibilidade (publicos, privados, protegidos)
- E para quem usa o plugin “acts_as_state_machine” gera também os diagramas de estado.
o RailRoad utiliza o Graphviz para gerar imagens dos modelos
Para instalar o RailRoad no linux (Ubuntu) siga os seguintes passos:
$sudo apt-get install graphviz
$sudo gem install railroad
– Ignore o primeiro comando se voce já tiver o graphviz instalado.
– para outras distribuições, verifique se o graphviz está no gerenciador de pacotes e instale-o
– Para windows obtenha o graphviz aqui.
Exemplos diretamente do site do RailRoad:
Diagrama de modelo:
Diagrama de controllers:
você pode ver mais exemplos diretamente no site: http://railroad.rubyforge.org/