jeudi 13 mars 2008

Les Annotations dans votre application Rails

Qui n'apprécie pas de voir d'un premier coup d'œil ce qu'il a prévu de coder ou d'améliorer dans son application Ruby on Rails.
Jusque là, du temps de Rails 1.2 où je suis encore, l'on devait se contenter de mettre quelques commentaires, voir de les libellés avec quelques TODOs, FIXME ou autre OPTIMIZE ...

Avec Rails 2.0, il est possible de lancer une tâche rake permettant de lister les différentes annotations avec leur contexte (fichier de l'application, type de l'annotation et annotation) :

rake notes
ou rake notes:TODO
ou rake notes:FIXME
ou rake notes:OPTIMIZE

Le résultat obtenu serait le suivant:
(in /home/sebthemonster/RailsProjects/lpg-web)
app/controllers/commande_controller.rb:
* [142] [TODO] Insérer un appel IPN pour vérifier si la transaction a tout de même eu lieu
* [144] [OPTIMIZE] Réaliser une vue adaptée si l'échec est réel

Il est possible d'utiliser cette tâche dans Rails 1.2 en téléchargeant le script de la tâche dans le répertoire lib/tasks de votre application:

sous Linux, saisissez dans le terminal les lignes suivantes:
$ cd lib/tasks && \
wget http://dev.rubyonrails.org/export/7553/trunk/railties/lib/tasks/annotations.rake

Sources: http://ryandaigle.com/archives/2007/2

Aucun commentaire: