BLOG
Voici un petit gem qui va vous permettre de visualiser votre schéma de base donnée en quelques lignes de commande!!
Introduction
Cet article à été originalement écrit par CoachUp. Voici une traduction en français.
Avez-vous déjà voulu visualiser votre schéma Rails, de façon clair et resortant les relation en les différents Models ? Vous a-t-on déjà demandé des représentations visuel de votre schéma, et ce par différentes personnes, voir différents services ?
Après avoir créé le diagramme, cela aide beaucoup les membres des équipes (surtout de dev, et en particulier les nouveaux développeur sur le projets) afin de savoir où en est le schéma. Cela évite de toujours affichier les champs dans PHPMyAdmin par exemple…
J’ai pensé qu’il fallait partager cette petite information qui pourraient vous aider !!! Voici les étapes pour installer le Gem Railroady qui va vous permettre de visualiser vos diagrammes !
Installation
Pour commencer il vous faut graphviz.
sudo apt-get install graphviz
En suite on installe le gem
vim Gemfile group :development, :test do gem 'railroady' end bundle install
Et voilà, c’est installé !!
Utilisation
Une commande va vous générer 4 fichiers svg de représentation de vos modeles. Ils sont donc ouvrable directement dans votre navigateur.
rake diagram:all
Quelques exemples bien utiles:
railroady -o models.dot -M Produces a models diagram to the file 'models.dot' railroady -a -i -o full_models.dot -M Models diagram with all classes showing inheritance relations railroady -M | dot -Tsvg > models.svg Model diagram in SVG format railroady -C | neato -Tpng > controllers.png Controller diagram in PNG format railroady -h Shows usage help
Sources
- Le site officiel: http://railroady.prestonlee.com
- L’article original: http://engineering.coachup.com/visualizing-rails-schemas-railroady-gem
- Les sources du gem: https://github.com/preston/railroady