Rake doc, salvation

A quién no le ha pasado que justo a la hora que necesitamos echar un vistazo a la documentación online de algún framework/lenguaje, nos encontramos con el gran problema que no tenemos conexión? Personalmente estoy tan (mal!) acostumbrado a ver la documentación online que muchas veces me he quedado sin avanzar culpa (mía primero) de la conexión.

Si estamos trabajando con rails, obtener la  documentación de la api del framework es una cosa muy sencilla. En la consola nos situamos sobre el raiz de nuestra aplicación rails y ejecutamos:

carlos@gray-shadow:~/rails_apps/ciclope$ rake rails:freeze:gems

Esta tarea copia todos los gems (inclusive rails) en el directorio /vendor de nuestra aplicación, para que la aplicación en la que estamos ejecute los gems y rails en la versión “freezada”, el siguiente paso:

carlos@gray-shadow:~/rails_apps/ciclope$ rake doc:rails

Aqui Rake nos crea toda la documentación del api del framework tal cual lo tienes online (si! en formato html!). Solo debes ir al directorio doc/api (en el raiz de tu aplicación) y alli abrir con tu browser favorito el archivo “index.html”

Recuerda que tu aplicación ha quedado freezada, por lo que si instalas nuevos gems en el rails de tu sistema, no seran accesibles desde esta aplicación, pero no te asustes para deshacer el freeze solo debes ejecutar:

carlos@gray-shadow:~/rails_apps/ciclope$ rake rails:unfreeze

Y ya tienes el api completo de rails en doc/api. Facil no? Y sobre todo muy útil