Eventos en jQuery, cómo usar on.

December 7th, 2012 Serabe 1 comment

En la última entrega vimos que el siguiente código no funcionaba: El anuncio desencadenó un charla con Sergi manteniendo que debería escribir directamente sobre delegación de eventos, que es precisamente lo que vamos a tratar ahora.

Delegando eventos.

jQuery cuenta con muchos métodos para delegar a eventos (bind, delegate o live). Sin embargo, estos métodos están obsoletos desde jQuery 1.7 en favor de on. A pesar de eso, empezaré explicando live, pasaré a delegate y finalmente llegaré a on.

live

El problema del código original se hubiese solucionado fácilmente llamando a live en vez de a on, como se comprueba en el fiddler correspondiente. El código es idéntico, simplemente cambia on por live.

Lo que hace este método es disparar el evento en cualquier elemento que satisfaga el selector, valiéndose de la propagación.

Dado que live está obsoleto y que actualmente live usa on internamente, lo dejaremos aquí.

delegate

delegate es bastante similar a live, sólo cambia cómo llamarlo. La equivalencia de llamadas sería:

El fiddler para delegate simplemente busca el elemento #container y le añade los handlers a él con los selectores correspondientes.

Por cierto, a la hora de escribir este artículo, delegate, ya obsoleto, también delega en on.

on

Finalmente, on es el camino a seguir con jQuery, al fin y al cabo, como habéis podido comprobar, tanto live como delegate usan on internamente.

Usar on para delegar eventos es muy similar a usar delegate, salvando que los eventos y los selectores están en orden inverso. El fiddle lo muestra en funcionamiento y el código completo es el siguiente:

¿Qué es lo que está pasando realmente?

Delegar un evento no hace que jQuery lo añada a los elementos correspondientes en cuanto se creen, sino que se añaden al elemento seleccionado ya existente y, por lo tanto, la propagación se puede parar en cualquier elemento que esté por debajo de él. De ahí que tengamos que pensar dónde delegar el evento ya que podemos cancelarlo sin darnos cuenta.

Por otro lado, tal y como podemos leer en la documentación de on en la sección Event performance, no debemos complicar mucho los selectores dentro de la delegación. Si nos vemos usando selectores jerárquicos, seguramente podamos delegar el evento en un elemento más cercano.

Delegación a mano

Para simular la delegación anterior cuyo selector era una simple clase, podemos hacerla usando el siguiente código:

En él simplemente comprobamos que el elemento que ha lanzado el evento (evt.target en el código) contiene la clase box. Puede parecer poco código extra, pero sin duda son dos líneas que nos ahorramos a cambio de un selector (el cual puede ser más complicado).

article clipper Eventos en jQuery, cómo usar on.
 

Eventos en jQuery, uso básico de on.

November 30th, 2012 Serabe No comments

En la primera entrega, vimos lo básico de los eventos de nuestro DOM. Ahora veremos cómo usar de forma básica jQuery para manejarlos.

Notas previas

Todo el código javascript mostrado en este artículo se supone dentro de la función jQuery tal que así:

El cuerpo del html es:

El método on

Antiguamente, jQuery usaba varios métodos para manejar los eventos (click, bind, live, delegate), pero actualmente se favorece el uso de un único método: on.

Lo básico

En el primer ejemplo, dibujamos tres cajas que, al hacer click sobre ellas, muestran un mensaje.

Seleccionamos los div correspondientes con $('.box') y llamamos al método on con dos parámetros. El primero, es el evento en el que estamos interesados; el segundo, la función a la que se llamará. jQuery pasará un objeto Event que no es más que una normalización de los objetos de cada navegador. Además, dentro del handler this se refiere al objeto en el se ha llamado al evento, en este caso, el div en el que se ha hecho click.

Ahora, supongamos que queremos darles un borde negro a las distintas cajas cuando pasamos el ratón por encima y quitárselo cuando el ratón sale de ellas. La forma obvia de hacerlo sería crear una clase CSS black-border con la regla correspondiente y añadírselo en el evento mouseenter y quitársela en el evento mouseout. El código en funcionamiento se puede ver en este fiddler.  Podemos acortar un poco el código pasando un objeto cuyas claves sean los eventos y los valores los handlers, como se observa en este otro fiddler.

Sin embargo, en vez de usar los métodos autodescriptivos addClass y removeClass, podemos usar el método toggleClass. Este método, pasado un nombre de clase, la añade si el elemento la tenía y la quita en caso contrario. Si además sabemos que como nombre de evento podemos pasar varios nombres separados por espacios el código (totalmente funcional) queda similar a esto:

Disparando eventos

Podemos hacer uso del método trigger para lanzar eventos. Aunque a primera vista pueda parecer poco útil, unido al hecho de podemos añadir handlers a eventos propios trigger se convierte en una importante herramienta a tener en cuenta.

Este método no tiene mucho más secreto, salvo un par de formas más de llamarlo, perfectamente documentadas en la documentación oficial. Probadlo en este fiddler.

Evitando la propagación

Ya comentamos qué era la propagación y que se podía evitar pero, dado que difería un poco jQuery respecto al comportamiento habitual en ciertos casos, no entramos en detalles. Ahora veremos qué cuatro métodos nos proporciona jQuery para lidiar con la propagación.

event.preventDefault

Al igual que en el caso general, si llamamos a este método, la acción por defecto del evento no se llevará a cabo. Además, podemos usar el método isDefaultPrevented para saber si se ha llamado o no preventDefault en el evento.

event.stopPropagation

Este método evita que el evento continúe propagándose y los handlers de los elementos padres sean llamados. Sin embargo, el resto de handlers para dicho evento en el elemento actual sí serán llamados. El método que nos permitirá saber si se ha llamado a stopPropagation es isPropagationStopped.

event.stopImmediatePropagation

En el caso de stopPropagtion, vimos que no evitaba que el resto de handlers del propio elemento sean llamados. Si queremos evitarlo, deberemos llamar a stopImmediatePropagation. Éste llama por sí solo a stopPropagation, así que también evita que el evento se propague a los nodos padre.

Por si os lo preguntáis, isImmediatePropagationStopped (menudo nombrecito) nos dirá si ya se ha llamado o no a este método. La utilidad de este método se me escapa.

return false

Y es aquí cuando vienen las diferencias. En jQuery, devolver false desde un handler equivale a llamar event.preventDefault() y event.stopPropagation(). Esto es diferente de lo que ocurre normalmente si no usamos jQuery, ya que sólo equivaldría a event.preventDefault().

Personalmente, prefiero llamar a cada uno de los métodos porque dejo claras mis intenciones (y no me veo obligado a parar la ejecución del handler).

¡Pero esto qué es!

Supongamos que en nuestro documento html sólo tenemos un div#container. Supongamos que ejecutamos el siguiente código:

Podremos comprobar que no funciona. Esto se debe a que los elementos no existen cuando llamamos al método on. Veremos cómo solucionar esto en la segunda parte.

article clipper Eventos en jQuery, uso básico de on.
 
Categories: General Tags: , ,

Un alto en el camino, eventos.

November 26th, 2012 Serabe No comments

Hacemos un alto en el camino para aprender un poco más sobre los eventos. Serán tres entregas:

  1. Eventos, cómo funcionan. Características básicas.
  2. Eventos en jQuery. Veremos cómo usar on.
  3. Eventos en jQuery. ¿Qué es eso de trigger?

¿Qué es un evento?

Un evento puede representar varias cosas, pero normalmente es una respuesta a una acción del usuario en nuestra página. Por ejemplo, al pinchar en un elemento lanzamos el evento click. Si seleccionamos un campo, se lanza el evento focus. La lista completa la podéis encontrar la página de w3schools.

 El proceso

El proceso que sigue un evento es algo más elaborado de lo que nos podríamos imaginar en un primer momento. Cuando damos una función para que maneje (handle) un evento, hacemos que maneje el evento en un elemento determinado. Por ejemplo, en este fiddle tenemos tres cajas y, cada vez que pinchamos en una de ellas, nos muestra una alerta con el número de caja, distintas cajas, responden de distinta forma. El código no es importante, pues usaremos jQuery para manejar los eventos y no las apis del DOM, como en este caso. Además, para ahorrarnos código podríamos haber escrito una función que devolviese funciones, como en este fiddle.

Manejando un evento

Para manejar un evento contamos con dos importantes conceptos: el handler y el objeto event.

El handler no es más que la función que será invocada cuando se reciba el evento. Dicha función se ha de relacionar con un nodo del documento, y sólo será invocada si ese nodo en particular recibe el evento correspondiente. Esto es importante cuando veamos qué pasa cuando se dispara un evento.

El handler recibe un argumento con un objeto Event. Aunque dicho objeto es bastante importante, esperaremos a verlo al momento en el que veamos cómo manejar eventos con jQuery.

Sin embargo, el proceso no es tan simple como disparar y recibir un evento.

Every event is bubbling

Un evento es una respuesta a una acción. La acción crea y pone en movimiento un objeto Event. ¿Pero qué camino sigue este evento?  Veamos el siguiente fiddler. El código sigue sin ser importante, sólo que estoy añadiendo un handler (así llamaremos a las funciones que se ejecutan cuando sucede el evento) a todos los elementos li, estando estos anidados y con fondo de distinto color para saber en cuál de ellos estamos haciendo click. El handler lo único que hace es cambiar el texto dentro del li.

Una vez el evento se pone en marcha, sigue subiendo en el árbol del documento, yendo nodo padre a nodo padre. A este proceso lo llamaremos propagación o bubbling. Dicho proceso se puede comprobar haciendo click en los distintos colores de fondo en el anterior fiddler.

Podemos refinar un poco más esta idea con el siguiente fidller. En él, añadimos un nodo hermano al nivel 3. Si pulsamos en el nivel 3 o 4, vemos que el hermano no pulsado no recibe el evento.

Parando un evento

Podemos evitar que un evento siga propagándose o cancelar la acción predefinida de un evento.

Un evento se dice cancelable si su acción predefinida puede ser evitada. Por ejemplo, hacer click en un enlace tiene como acción predefinida el seguir dicho enlace. Al hacer click en un botón para enviar la información de un formulario, la acción predefinida consiste en evitar dicho envío. Estos eventos son cancelables y podemos evitar la acción por defecto llamando al método preventDefault en el objeto Event que se pasa al handler. Hay una forma alternativa de evitar la acción por defecto: devolviendo false desde el handler. Sin embargo, prefiero llamar explícitamente a los diferentes métodos puesto que el comportamiento difiere en jQuery.

Por otra parte, también podemos usar el método stopPropagation para evitar que el evento se propague, aunque esto no evitaría la acción por defecto.

Notas finales

Sé que esta entrega se ha retrasado, y seguramente reduzca el número de publicaciones a dos por semana: una al principio y otra al final.

Lo importante de esta entrega no es saber cómo añadir handlers o cómo parar la propagación de un evento. Todos eso lo veremos cuando hablemos de eventos en jQuery.

article clipper Un alto en el camino, eventos.
 

Aprendiendo jQuery con la web del Senado, IV

November 19th, 2012 Serabe No comments

Hoy aprenderemos:

  • Qué es jQuery UI y a buscar su API.
  • A usar un objeto Date.
  • A crear elementos con jQuery.

Código inicial

Me llama la atención que, a pesar de que las variables year, txt_month y month son independientes del elemento de la colección, los está recalculando en cada iteración. Saquémoslos fuera, y hagamos unas pequeñas modificaciones.

¡Hop! ¡Hecho!

jQuery UI

jQuery User Interface es una colección de elementos orientados hacia la interfaz de usuario basados en jQuery. Entre otras cosas, la web del Senado usa jQuery UI para el selector de fechas.

senado Aprendiendo jQuery con la web del Senado, IV

También recalcar que estamos en la sección Actividad parlamentaria. Este plugin también se usa en la página principal, pero el código se refiere a éste en concreto, por lo que trabajaremos aquí.

La página del datepicker en jQuery UI contiene varios ejemplos. Sin embargo, ahora mismo es más interesante mirar su API (al fin y al cabo, está en un enlace bien grande y tentador).

Veréis, no había usado nunca el selector de fecha de jQuery UI hasta leer el código. Sin embargo, me parecía raro que no tuviese un método que devolviese la fecha seleccionada (llamadme loco). Y, en efecto, allí estaba. El método llamado getDate.

Por lo tanto, simplemente llamamos a ese método para obtener la fecha, como vemos a continuación.

Puede parecer un poco rara la forma de llamar a los métodos, pero pensad que así es más difícil pisar los nombres de otros plugins.

Para obtener el mes y el año, primero debemos indagar un poco más en el objeto Date de js.

Fechas

Una pequeña anécdota, trabajando en una gran cárnica consultora, me encontré con un código de cerca de 30 líneas de js para comparar fechas. El tipo que lo escribió me pidió ayuda para solucionar un problema, puesto que no le funcionaba la comparación para un par de fechas. El fallo ocurrió en producción.

Bien, el problema se soluciona fácilmente comparando las fechas directamente (date1 < date2, por ejemplo). Lo podéis comprobar en el siguiente fiddle.

En nuestro caso queremos conseguir el año y el mes.

Año

Los objetos Date tienen dos métodos para obtener el año, getYear y getFullYear. El primero, obsoleto, devolvía el número de años desde 1900 (WTF?); el segundo, devuelve el año completo. Por lo tanto, es lo que usaremos para obtener el año.

Mes

El siguiente paso es obtener el mes. El método getMonth devuelve el índice del mes. Así enero es 0, febrero es 1 y así hasta diciembre que es el 11.

El código original coge el texto del mes y recorre los options correspondientes para conseguir el valor del option seleccionado. Lo curioso es que se podrían haber ahorrado el bucle si en vez de llamar a text hubiesen llamado a val. jQuery hace que la llamada a val en el select sea el valor de la opción elegida (en el caso de que la selección sea múltiple, devuelve un array con los valores). Sin embargo, val devuelve una cadena de texto, por lo que no nos ahorraríamos el parseo.

Si nos fijamos en el select, los valores de los options se corresponden con los índices que devuelve método (salvo, por supuesto, que uno son textos y otros son números).

select month Aprendiendo jQuery con la web del Senado, IV

Finalmente, el código queda así:

Creando elementos con jQuery.

Por último, el script crea un elemento y lo pone dentro del elemento correspondiente a la iteración.

Si a la función jQuery le pasamos una cadena con html, ésta crea los elementos por nosotros. Además, podemos encadenar funciones en jQuery. La diferencia se puede ver en el siguiente gist:

Para terminar, usaremos appendTo para añadir un elemento como hijo a otro. Además, usaremos empty para eliminar cualquier texto anterior (y nodo hijo) del elemento correspondiente.

El código queda así:

Notas finales

El resto de la semana hablaré un poco de los eventos, que ya va siendo hora. Además, veremos cómo es aconsejable declararlos ahora (en el script anterior usaba la función click).

article clipper Aprendiendo jQuery con la web del Senado, IV
 
Categories: General Tags:

Aprendiendo jQuery con la web del Senado, III

November 16th, 2012 Serabe No comments

Hoy veremos el espinoso mundo de las variables globales. Además, veremos cómo

  1. Usar el atributo data.
  2. Usar la función map.
  3. Inicializar un array.

El código inicial.

El código a modificar es el siguiente:

Me encanta cuando la gente usa variables globales. Me hace preguntarme “¿por qué?”. Seré sincero, no suelo usar javascript. En su lugar uso coffeescript. Cuando estoy probando el código en desarrollo, coffeescript rodea cada uno de mis archivos con una IIFE, lo que hace que tenga que pensar qué he de exportar al ámbito global, no qué tengo que poner en el local. Lo primero que hago, es crear algo del estilo a window.Senado = {}, ahí meto toda mi mierda todo mi código.

He de reconocer que al menos meten todas las variables globales dentro de una variable nombrada, ejem, globales. Pero esto es un nombre fácilmente pisable.

Attributos data.

Por otra parte, la mayor porción del código accede a elementos para coger el texto. Todos los que he comprobado son elementos que no se muestran (tienen display: none, algunos de ellos escritos a fuego). Para ello, personalmente, prefiero meter la configuración en el elemento en sí. Para ello, me valgo de los atributos data. Si en un elemento ponéis un attributo data-x, después podéis acceder a él usando jQuery fácilmente. En este fiddle, lo uso para poner el texto del alert y el color de fondo nuevo. Más información en la documentación de la función data.

Map.

Veamos la siguiente variable.

Podríamos hacer lo mismo usando la función ya vista each. Veamos cómo en el siguiente código:

Tenemos un array con los valores del 1 al 5. Creamos un array result vacío. Después usamos la función each, y en cada iteración metemos el doble del elemento actual en el array result. Finalmente, ponemos en la consola el resultado.

Screenshot 151112 2312 5 300x89 Aprendiendo jQuery con la web del Senado, III

Esta forma de usar each parece muy útil; podríamos repetirla muchas veces en varios sitios. Podríamos hacer una función que hiciese algo parecido, pero para eso ya tenemos map. En ella pasamos una función que recibe como parámetros el índice del elemento en la colección y el elemento en cuestión. Esto mismo es para lo que sirve la función map de jQuery. Map creará un nuevo array con el mismo número de elementos, pero cada elemento será el resultado de aplicar la función al elemento original de la misma posición.

Por ejemplo, el código anterior reescrito usando jQuery.map quedaría como:

Y comprobamos que efectivamente devuelve el mismo resultado.

nuevo Aprendiendo jQuery con la web del Senado, III

¿Os habéis dado cuenta de que podemos usar las funciones each y map en cualquier array o similar simplemente usándolos de forma diferente? En efecto, usando las formas jQuery.each y jQuery.map podemos usarlo en objetos lo suficientemente parecidos a un array. Daos cuenta, sin embargo, que la función que pasamos a jQuery.map recibirá los argumentos al revés: primero el elemento en sí y luego el índice.

Finalmente, el código corrrespondiente a la variable monthNames queda así:

Inicializando un array.

En general, si queremos crear un array, tenemos dos opciones recogidas en el siguiente gist:

En este caso, es preferible usar la segunda opción, puesto que es más rápida (se puede comprobar con este jsperf). Sin embargo, la variable está siendo inicializada con 31 elementos, todos ellos undefined.

En ese caso tenemos tres opciones. La primera es llamar a new Array con el número de elementos. El segundo, consiste simplemente en asignar 31 a la longitud del array (sí, sí, ¡funciona!). Finalmente, podemos añadir al array un método undefined 31 veces valiéndonos de un bucle para hacerlo.

Sorprendentemente, esta vez la más rápida es la que utiliza el constructor (new Array(31)). La más lenta se corresponde con la tercera opción. Los resultados del jsperf correspondiente en mi máquina son estos:

  • new Array(31): 18,590,339 operaciones por segundo.
  • [] + for: 2,497,498 operaciones por segundo.
  • [] + length: 6,512,241 operaciones por segundo.

Por lo tanto, amigos, en este caso lo han hecho bien. ¡Un aplauso para Rocío!

0 Aprendiendo jQuery con la web del Senado, III

Notas finales.

En general, esta parte no está tan mal. Se sigue notando que son incapaces de consultar una api o de leerse un tutorial, pero no está del todo mal. El código modificado quedaría así:

Hay que tener en cuenta que estamos modificando función a función. Esto no estaría así, si de mí dependiese.

¡Ánimo, Rocío!

 

article clipper Aprendiendo jQuery con la web del Senado, III
 
Categories: General Tags:

Aprendiendo jQuery con la web del Senado, II

November 14th, 2012 Serabe No comments

Hoy, refactorizando la web del senado, aprenderemos:

  1. A obtener el valor seleccionado de un select.
  2. A ocultar y a mostrar de nuevo un elemento del DOM.
  3. A separar un poco más la funcionalidad javascript del estilo de nuestra web.
  4. A añadir una función a jQuery.
  5. A retrasar la ejecución de nuestro código a que el document html esté listo.
  6. De paso, recordaremos cómo seleccionar un elemento del DOM.

El código original.

El código original es muy simple. Es el siguiente:

En primer lugar, no soy muy fan de poner nombres en español pero, si lo vas a hacer, al menos hazlo bien, mendrugo de pan. Se dice “selecciona”.

Como novedad, iré creando un jsfiddle para que podáis probar el código que vamos creando. La primera versión es ésta. Podréis ver que hay un poco de código extra, ya veremos para qué. Si jugáis un poco con él, veréis que el “Selecioname” cambia de posición. Además está mal escrito.

Empecemos.

Ortografía.

Como ya he dicho, no soy muy fan de poner nombres en castellano en lo que a programación se refiere. Sin embargo, de hacerlo, debemos intentar poner los cinco sentidos en los nombres.

Dicho esto, solucionemos este tema de una vez por todas. El nuevo fiddle recoge los cambios.

Primeros cambios.

Por primera vez, vamos a extender jQuery, vamos a añadir una función al objeto jQuery para saber si devuelve un resultado o no. Llamaremos a la función exist(), y vi esta implementación por primera vez en esta respuesta de StackOverflow.

Vemos que para añadir la función exists sólo tenemos que declararla como un miembro de $.fn.En dicha función, vemos si existe algún elemento comprobando que la longitud de la selección sea distinta a cero. Ésta es la forma más sencilla de extender las capacidades de jQuery.

Dentro de selectCharge, usamos la función $ como aprendimos en la primera parte para seleccionar el elemento div#fs_selecciona_orden. El código ahora mismo no es funcional, pero lo resolveremos en las siguientes secciones.

To display or not to display.

En el condicional, lo que se hace realmente es mostrar o esconder un elemento del dom dependiendo del valor seleccionado en el select.

En vez de modificar la propiedad CSS display del elemento deberíamos usar las funciones show y hide de jQuery. La razón más poderosa es que show y hide recuerdan la propiedad display anterior del elemento. Así, si el elemento tenía display: block; antes de usar hide, al llamar a show volverá a tener display: block;. Esto permite separar mejor el estilo de la programación. Si el diseñador cambiase el estilo del elemento y nosotros no tocásemos el código, la podíamos liar “parda”.

Además, podemos pasar parámetros extra si queremos que se convierta en una animación.

El código en esta fase se parece a lo siguiente:

Retoques finales.

El código requiere de dos toques finales:

  1. La función exists no es realmente necesaria.
  2. Usar jQuery con el parámetro select.

Como ahora estamos usando las funciones show y hide, no necesitamos comprobar que haya un elemento en la colección. Por lo tanto, podemos eliminar ese código.

Por último, vamos a user jQuery para obtener el valor seleccionado del select. En jQuery podemos hacerlo directamente con $(select).val(), suponiendo que select contiene el elemento DOM correspondiente. Personalmente, prefiero encontrar primero el option que está seleccionado. Para ello, usaremos una pseudoclase CSS :selected. Además, ya que estamos, compararemos con un más correcto ===.

Finalmente el código termina así:

Y el fiddle correspondiente nos permite jugar con el código y observar cómo el elemento conserva el display: block.

No tan deprisa.

Al principio os prometí ver qué pasaba con ese código extra que le había metido al fiddle.

La primera parte son dos simples líneas de código que se parecen a esto.

Otra forma de escribirlo, que nos da más pistas de qué sucede, es:

En nuestro código referenciamos elementos de html que pueden no existir cuando el código se ejecuta. Si esto pasa, nuestro código puede, en el mejor de los casos, no funcionar. Para evitar esto, usamos la función $ (otra vez nos encontramos, vieja amiga) pasándole una función que jQuery ejecutará cuando el documento este listo (document y ready, fácil).

¿Qué pasa con la otra parte? Es un poco más complicada de explicar y no voy a explicar exactamente qué sucede con los eventos en jQuery, eso será para otro momento. Veamos el código:

Básicamente, le estamos diciendo a jQuery que, cada vez que un elemento de $('select') cambie (change en inglés), debe llamar a la siguiente función. Para terminar de entenderlo, debemos saber que jQuery hará que la variable this se refiera al select correspondiente. ¿Por qué decir ‘el correspondiente’ cuando sólo hay uno? Pues porque $('select') podría devolver una colección de más de un elemento, en cuyo caso añadiría el callback (así es como llamamos a la función que le pasamos) al evento change de cada uno de los elementos.

Notas finales.

No hemos reducido mucho el código (LoC nunca ha sido un buen indicador de la calidad del código), pero a cambio hemos separado nuestro código del diseño. Si tuviera que hacer ese código, probablemente lo haría de forma diferente (¡Qué coño porras! ¡Lo he escrito hace menos de un mes! ¡Diferente!), pero no está del todo mal.

article clipper Aprendiendo jQuery con la web del Senado, II
 
Categories: General, Javascript, jQuery, Programming Tags:

Aprendiendo jQuery con la web del Senado, I

November 12th, 2012 Serabe No comments

Notas previas.

En primer lugar, agradecer a los desarrolladores que han trabajado duramente en funciones.js y en aquellos que no se han molestado en pasarlo por un minimizador de código.

Se recomienda leer antes el artículo de Javier Ramírez Los problemas del desarrollo web en España resumidos en senado.es.

El código está disponible en este gist.

Durante esta serie de artículos nos olvidaremos de que todas las funciones son declaradas en el ambiente global.

El problema del peso.

 

Antes de ponernos con jQuery, veamos un poco cómo está hecho el archivo. El archivo pesa unos 45KB (según me chiva ls -lh) y tiene unas 1313 líneas (esto, chivado por wc -l). Lo primero que intento es ver cómo está el código. Para ello, usamos alguna herramienta como jslint o jshint. En este último caso, si pegamos el código y pulsamos en Lint, nos devolverá una lista con 50 errores, añadiendo un último error indicando que ha escaneado el 23% del código y ha parado porque ha encontrado demasiados errores.

Una vez pasado por jsHint, decidi pasarlo por el compilador de Google closure, para minimizarlo un poco. Al fin y al cabo, un vistazo rápido permite ver la ingente cantidad de comentarios que hay en el archivo. Está bien que haya muchos comentarios, lo único que me preocupa es:

  1. Que los han puesto en producción (gracias, Rocío, por sustituir los días escritos a fuego).
  2. Que haya código comentado, también en producción.

De ahí que me preguntase cuánto se ahorraría minimizando de la forma más básica el código. Para ello, he usado el compilador de Google closure en dos versiones. En la primera, he usado los parámetros por defecto; y en la segunda, he pasado la opción --compilation_level ADVANCED_OPTIMIZATIONS. Echando mano otra vez de ls -lh, vemos que con los parámetros por defecto, el archivo resultante pesa 22KB, mientras que usando las optimizaciones avanzadas, el tamaño baja hasta 15KB. El archivo se queda, respectivamente, en un 50% y un 25% del tamaño original. Todo esto, realizado en cinco minutos, sin mayores ajustes de la herramienta. Cabe destacar que closure genera 1 y 6 warnings, todos ellos referidos al uso de la variable this, excepto uno, que se trata de un código que no se ejecutará nunca (ya veremos qué).

cargar_atr_destacados

La primera función que estudiaremos es, justamente la primera del archivo, la función cargar_atr_destacados. Dicha función se encuentra en este gist. Empecemos a tocar las pelotas aprender un poco.

En primer lugar, suelo preferir declarar las funciones de la forma var cargar_atr_destacados = function() {};, pero, mientras se entiendan las diferencias, me da un poco igual.

Dentro de la función, vemos que estamos ejecutando realmente el mismo código para $('#img_destacados1 img'), $('#img_destacados2 img'), $('#img_destacados3 img'), $('#img_destacados4 img') y $('#img_destacados5 img'). ¿Pesado de leer, ¿eh? ¡Pues imagínate lo pesado que debe ser de mantener! Por eso, antes de estudiar lo que hace, vamos a convertirlo, sin modificarlo mucho, en un bucle. El resultado es el siguiente

No está mucho mejor, pero al menos hemos reducido el número de líneas a casi un 25%.

Empecemos a ver qué hace el código. Todos esos signos de dólar ($) es como se llama comúnmente a la función de jQuery. Dicha función sirve para muchas (pero muchas de verdad, ¿eh?) cosas, entre ellas seleccionar elementos dado un selector de CSS. En este caso estamos seleccionando las etiquetas img dentro de los elementos cuyo id es img_destacados seguidos de un número del 1 al 5. Puesto que hay varias imágenes que cumplen dicha propiedad, el resultado es un array o vector de elementos.

Por otra parte, vemos muchas llamadas al método eq. Dicho método, como podemos observar en la documentación oficial, sirve para seleccionar un elemento específico dentro del array. Por ejemplo, eq(0) selecciona el primer elemento, eq(1) el segundo, etc. Ahora veamos porqué el uso del método anterior es innecesario.

¿Que lo geque y lo seque?

El método attr de jQuery se puede invocar de distintas formas. Si lo invocamos con un sólo argumento, como en la tercera línea del código anterior, tomará dicho parámetro como el nombre del atributo a devolver. Puesto que lo estamos llamando en una colección, podríamos pensar que nos devolverá un array de valores, pero en realidad nos devolverá sólo el valor del primer elemento. A esta forma de llamarlo lo llamaremos getter, porque nos devuelve un valor.

Por otra parte, podemos llamarlo como un setter. Para ello, le daremos dos valores, el nombre del atributo y el valor a tomar. Podríamos pensar que entonces sólo dará el valor pasado al primer objeto; al fin y al cabo, es el valor que nos devolvía. Sin embargo, dará el valor a todos los elementos de la colección. Hay una segunda y tercera forma de usarlo como setter, pero os podéis mirar la documentación para esos casos.

En general, todas las funciones de jQuery que puedan ser usadas como getter y como setter tienen el mismo comportamiento: si están siendo usadas como getter devuelven el valor del primer elemento de la colección; si están siendo usadas como setter, actualizarán el valor de todos los elementos de la colección. Teniendo en cuenta lo que hemos aprendido en el párrafo anterior, podemos refactorizar nuestro código para que quede así:

Si además sabemos que podemos pasar un objeto con todos los pares claves-valor que queremos modificar en una sola llamada, el código es:

Grabado a fuego.

Pero aún tenemos ese for ahí que no me gusta mucho, pues realmente estamos harcodeando o, como diría nuestra amiga Rocío, grabando a fuego, la cantidad de elementos a modificar. Para ello, nos fijamos en que cada grupo de imágenes está metido dentro de un div con clase mod_destacados diferentes entre sí. Además, un rápido vistazo nos permite ver que no hay más div.mod_destacados que grupos de imágenes, si participásemos en el grupo de desarrollo estaría bien que nos aseguráramos de esto o, mejor, añadir una clase estilo js-mod_destacado. Por lo tanto, lo que haremos será buscar todos los div con clase mod_destacados y dentro de cada uno de ellos modificar los attributos alt y title de las imágenes. El selector para los div es tan fácil como $('.mod_destacados'). Veamos el código completo y después lo explicamos:

Para entender este último código, sólo necesitamos aprender lo que hace la función each y la función find.

Llamaremos a la función each siempre sobre una colección jQuery y le pasaremos como parámetro una función. jQuery llamará dicha función, una vez por cada elemento de la colección, con el índice de dicho elemento dentro de la colección actual, y el elemento en sí. Además, dentro de la función parámetro, this se referirá al elemento correspondiente de la colección.

¿Os acordáis de que os comenté que la función $ valía para todo? Pues bien, en la línea 3 podéis ver que la llamamos con un único parámetro, this. Éste no es un selector por lo que no sabemos aún qué hace. Antes llamábamos a $ con un selector CSS y nos devolvía un objeto jQuery que envolvía a la colección; ahora que le pasamos un elemento del DOM, ¿qué devuelve? La respuesta es muy simple: nos devuelvo un objeto jQuery que envuelve a dicho elemento. De esta forma, podemos usar todos las funciones de jQuery en él. Por ejemplo, en este caso, usamos la función find.

La función find(selector) es muy similar a $ sólo que restringe la búsqueda a los nodos de la colección padre. Así $(this).find('img') busca todas las etiquetas imágenes dentro de $(this), es decir, entre sus nodos hijos.

De esta forma, sabiendo muy poquito de jQuery, hemos reducido un script de 37 líneas a sólo 7. Además, si aumentamos el número de imágenes, o lo reducimos, nuestro script seguirá funcionando.

Notas finales.

Como último comentario, decir que actualmente se favorece el uso de prop frente a attr en jQuery. El problema con la web del senado es que están usando jQuery 1.3.2

Screenshot 121112 2026 3 300x212 Aprendiendo jQuery con la web del Senado, I

La versión de jQuery usada en senado.es es 1.3.2

 

Un vistazo rápido a github nos permite comprobar que esa versión es de hace 4 años.

article clipper Aprendiendo jQuery con la web del Senado, I
 

Adding organization repos to Travis-CI: Part I

October 9th, 2011 Serabe No comments

It was a nice FridayPorras and I were at the BeBanjOffice and  we were working on adding organization support to Travis-CI.

First, we needed to find where the user repos were being fetch. Said and done, we found that travis is using the ServiceHookController to ask the server for repos (and to update them too, but don’t hurry, we’ll get there in part II). The controller was using the github_repositories method in the User model. Finally, we arrived to Travis::GithubApi, where all our questions found answers.

repositories_for_user just relied on Octokit#repositories for getting the repos, so we added all the code after the plus sign. You might think that this code lacks the proper security, is wrong and that it shouldn’t be there (and damn it, you’re right!) but there is no easy way to retrieve only the repos where the user has admin privileges (we wasted hours on this and a quick message to Github confirmed it).  Basically, it asks for all organizations for the given user (beware! You need to make your membership public, otherwise it won’t work) and then flat_map them to the repos in the given organization (whether the user can administrate them or not).

Later, the each block was added so we could know whether the repo belongs to the user or to an organization.

Stop! Hammertime!

We needed a way to let the user know that a repo actually belongs to an organization, so we added that info to the template (that {{#if content.organization_name}} is ours :D) and added some style so it could look this awesome:

20110928 q5hyhyuddmqnsr7awgmxtj6ph5.medium Adding organization repos to Travis CI: Part I

We had some tough time trying to get it vertically centered, but after realizing that Github has its tags the same way as we do, we stop trying to fix it. And they still look awesome.

More coming in part II.

article clipper Adding organization repos to Travis CI: Part I
 

Transforming CSS selector to an XPath query

September 9th, 2011 Serabe No comments

So. Easy.

[ruby]require ‘nokogiri'; Nokogiri::CSS.xpath_for(css_selector)[/ruby]

article clipper Transforming CSS selector to an XPath query
 
Categories: Programming, Ruby Tags: , ,

Tries: la pronunciación se deja como ejercicio para el lector.

April 28th, 2011 Serabe No comments

El repositorio de github de trie. Tomad y usad todos de él.

Para ver el artículo de succint trie, añadid en Google Reader el feed http://stevehanov.ca/blog/index.php?atom El artículo se llama “Succint Data Structures: Cramming 80,000 words into a Javascript file“.

Próximamente la presentación en slideshare.

Próximamente el vídeo.

Cuando vea en qué formato sale lo de OvationApp, lo subo también (y también próximamente)

 

article clipper Tries: la pronunciación se deja como ejercicio para el lector.
 
Categories: General Tags: