Existe en linea una buena cantidad de recursos de ayuda para trabajar en Rails, uno de los primeros sitios a consultar es RailsGuide, otro sitio en linea importante es el que contiene la documentación del API de Rails o el sitio Rails API; finalmente la fuente de ayuda mas importante es el mismo código fuente de Rails.
Todas estas opciones son muy buenas para resolver dudas sobre el API, el detalle viene cuando por algún motivo no estamos en linea. Si al momento de instalar nuestra gemas instalamos también la ayuda en formato rdoc, entonces podemos consultar el API desde la linea de comando con ri.
Por ejemplo si buscamos ayuda sobre content_for, en la linea de comando podemos ejecutar:
$ ri content_for
Después de un momento ri nos indica que hay mas de un resultado, entonces elijo el que están dentro del namespace de Ruby que nos interesa y volvemos a ejecutar ri:
$ri ActionView::Helpers::CaptureHelper#content_for
En este caso el resultado que nos muestra ri es la ayuda sobre ese especifico método de Rails. Esta opción funciona en todas las plataformas donde podamos instalar Rails, pero si estamos en OSX, pues tenemos una opción gráfica para la ayuda en linea.
Esta opción consiste en usar la aplicación de diccionario de OSX, donde instalamos el diccionario con la ayuda de Rails, este lo podemos descargar de el vinculo publicado en este post, y para instalarlo solamente copiamos el diccionario a la carpeta ~/Library/Dictionaries.
Abrimos la aplicación de diccionario y ya podemos consultar el API de Rails fuera de linea.
Inclusive mejor aun, desde nuestro editor - en mi caso MacVIM, me posiciono sobre la instrucción de la que quiero consultar el API y presiono las teclas Command + Ctrl + D y me aparece una "burbuja" con la ayuda proveniente del API.
Ya sea en linea o fuera de linea, hay opciones muy convenientes para siempre poder consultar el API de Rails.
No hay comentarios.:
Publicar un comentario