Anota tu código Rails con `rake notes`

Muchas veces estamos creando o revisando código y sabemos que el código que estamos viendo puede ser mejorado o quizás está pendiente realizar algo o nos hemos encontrado con algún bug. Para estos casos Rails nos provee con una utilidad dentro del código y que luego puede ser consultada con Rake con la tarea rake notes acá pueden ver la documentación de Rails al respecto http://guides.rubyonrails.org/command_line.html#notes

Básicamente, Rails nos provee tres comentarios que podemos poner en el código y luego serán interpretados por rake notes en este caso son:

1
2
3
# OPTIMIZE Esto puede ser mejorado
# TODO Esto está pendiente
# FIXME Esto está malo

Luego podemos ejecutar rake notes en la terminal y tendremos un resultado:

1
2
3
4
5
6
7
8
9
$ bin/rake notes
(in /home/foobar/commandsapp)
app/controllers/admin/users_controller.rb:
* [ 20] [TODO] any other way to do this?
* [132] [FIXME] high priority for next deploy

app/models/school.rb:
* [ 13] [OPTIMIZE] refactor this code to make it faster
* [ 17] [FIXME]

El uso de esto nos puede ayudar bastante a recordar la ubicación exacta de código a optimizar, pendiente o malo, pues muestra la lína y el archivo donde hemos puesto la nota.

Happy notes!

avatar

Blog neyDroid

Desarrollando Vagancias