L'essentiel de Ruby on Rails

Annoter ses models

TESTEZ LINKEDIN LEARNING GRATUITEMENT ET SANS ENGAGEMENT

Tester maintenant Afficher tous les abonnements
Dans cette vidéo, vous découvrirez la gem Annotate. Elle permettra de voir ce que contiennent vos models en cours de développement.
03:20

Transcription

Lorsque nous ajoutons des propriétés à nos modèles, comme ici, title ou content pour topic, il peut être difficile de se rappeler lesquelles nous avons déjà ajoutées. Nous pourrions regarder les fichiers de migration et récupérer les colonnes que nous avons ajoutées à chacune de nos tables. Mais cela s’avèrerait vite fastidieux, surtout si nous avions énormément de migrations. Il existe du coup une gem que j’aimerai vous présenter, se nommant : annotate. Cette gem va analyser la structure de votre base de données et rajouter des commentaires au niveau de vos styles modèles contenant la structure de la table associée à ce modèle. Ajoutons-la à notre Gemfile. Je vais la mettre dans le groupe development puisqu’elle nous sera utile uniquement en développement. Comme d’habitude, après avoir ajouté une gem, n’oubliez pas d’exécuter bundle install. Un peu plus loin dans la documentation de la gem, il nous est précisé qu’elle est capable d’annoter nos modèles à chaque fois que nous exécutons la tâche rails db :migrate en exécutant cette commande. Faisons-le. Nous voyons que la commande a ajouté un fichier dans notre dossier lib/tasks. Regardons donc ce qu’il contient. Nous retrouvons ici une syntaxe de fichier de tâche rake. Notez également cette petite méthode Rails.env.development ? permettant de vérifier si nous sommes en environnement de développement ou de production. Cette méthode renverra faux si nous ne sommes pas en environnement de développement. Autrement dit, personne ne pourra utiliser cette tâche en production, ce qui est plutôt une bonne chose. Ce fichier contient un ensemble de configurations pour annotate, toutes documentées sur github. Je vais en modifier quelques-unes, notamment, remplacer ici before par after. Je vais le faire pour l’ensemble des mots-clés before. Avec before, la gem annotate ajouterait ses commentaires avant le code de nos modèles. En mettant after ici, la gem ajoutera ses commentaires après le code de nos modèles. Notez également qu’annotate ne va pas seulement ajouter des commentaires au modèle. Elle pourrait le faire aussi pour les routes, notamment, en commentaire, le résultat de la commande rake routes, ainsi qu’au niveau de différentes fonctionnalités, au niveau des tests unitaires. Je vais également changer le format des commentaires générés en remplaçant ici true par false, et ici false par true. Le format_markdown est très répandu dans les applications Ruby on rails. Il s’agit d’un format de texte avec des syntaxes spécifiques pour faire de la mise en forme sans avoir besoin d’utiliser des balises d’HTML. Ceci étant modifié, exécutons désormais la commande annotate. La commande nous indique quel fichier elle a modifié. Allons voir par exemple le fichier app/models/topic. Nous voyons qu’elle a ajouté en dessous de nos précédents commentaires un ensemble d’informations concernant notre table. Nous y retrouvons les attributs créés pour notre table, le type de ces attributs et d’éventuels paramètres ou valeurs par défaut. Je trouve ces informations vraiment utiles, surtout lorsqu’on commence à avoir des tables conséquentes. Grâce à annotate et au fichier auto_annotate_models, ces commentaires se mettront à jour chaque fois que nous exécuterons rake db:migrate. Cette vidéo vous a donc présenté comment annoter vos modèles avec des informations liées à la structure de votre base de données.

L'essentiel de Ruby on Rails

Concevez des applications web évolutives et intemporelles avec Ruby on Rails. Installez l’environnement, réalisez un projet de stack overflow, enrichissez-le, etc.

6h08 (85 vidéos)
Aucun commentaire n´est disponible actuellement

Votre formation est disponible en ligne avec option de téléchargement. Bonne nouvelle : vous ne devez pas choisir entre les deux. Dès que vous achetez une formation, vous disposez des deux options de consultation !

Le téléchargement vous permet de consulter la formation hors ligne et offre une interface plus conviviale. Si vous travaillez sur différents ordinateurs ou que vous ne voulez pas regarder la formation en une seule fois, connectez-vous sur cette page pour consulter en ligne les vidéos de la formation. Nous vous souhaitons un excellent apprentissage avec cette formation vidéo.

N'hésitez pas à nous contacter si vous avez des questions !