XMLEye

Bueno bueno, acabo de volver de la fase final del Concurso, donde he tenido el gustazo de recibir el Primer Premio en la categoría Educativa. Quitando que el dinero es bienvenido, cómo no :-D, me alegra mucho que se reconozcan los esfuerzos de todos nosotros, que es lo realmente importante.

Me gustaría agradecer a todos los demás finalistas, a los organizadores y a todos los involucrados por dejarme pasar unos dos días fantásticos con mucho frikeo ubuntero, debianero y demás. La visita a los jardines del Real Alcázar se aguó un poco, pero fue muy bonita de todas formas.

Felicidades a todos los demás, que todos somos premiados. Empezando por Psychosynth, que dan ganas de tontear con él sólo de verlo :-D, y que no me extraña que sea el premiado en absoluto. Y siguiendo con el robotito R4P (espero que resolváis el problema con los horns de los servos, y poned fotos de la versión negra), Minirok (Dato, eres de GNOME en el fondo, lo sé ;-)), Pigmeo (sigo pensando que aunque no es prioritario, se debería poner la creación de un simulador en un documento por si alguien se siente dispuesto a echar el rato), y Zenphp (se nota de dónde viene el nombre al hablar con el autor).

Un recuerdo también a las menciones, en particular Pleim, de mi misma universidad, que por desgracia no se pudo pasar, y a los de Pro Evolution Chapping, con un juego peligrosamente adictivo. Pero por favor, entrenad un poco más y no os metáis tantos goles en propia puerta :-D.

¡Suerte a todos en vuestros proyectos a partir de ahora!

¡Listo! Ya he traducido por lo pronto todos los textos de las interfaces, manuales y hojas XSLT de ACL2::Procesador, YAXML::Reverse y XMLEye al inglés. La selección se realiza de forma automática al ejecutar los programas. Si estamos en un ordenador con local española por defecto, con esto veremos XMLEye en español:

xmleye

Y con esto en inglés (bajo GNU/Linux):

LC_ALL=en_US xmleye

Lo que va a tardar más en traducirse es el código, sin duda. Por lo pronto todas las clases Java están traducidas, pero no aún ni sus métodos ni los comentarios de la mayoría de los ficheros fuente. Habrá que ir haciéndolo poco a poco, supongo.

Todos los paquetes Debian han sido actualizados debidamente, con lo que con esto basta para pasar a la nueva versión:

sudo aptitude update
sudo aptitude safe-upgrade

Bueno, lo siguiente es revisar un poco los javadocs para ver si se han visto afectados por esta traducción y arreglarlos un poco, e ir un poco a la caza de más posibles bugs.

Ah, e imitando un poco a algunos de mis compañeros, creo que cuando termine el concurso moveré este blog a mi propio dominio, que en este caso tiene un nombre algo más genérico, ya que seguramente lo usaré para otras cosas mías y demás pruebas que haga con otras tecnologías: www.shoyusauce.org. Sí, salsa de soja, en japonés. No me sentía muy inspirado ese día :-D.

Por lo pronto ya lo uso para alojar los paquetes Debian y los manuales, pero ya lo iré mejorando.

Bueno, como de costumbre el toro me ha pillado con otras cosas y no he podido ponerme tanto como quisiera. He aprovechado este rato libre que me deja la Semana Santa para escribir una primera versión del Manual del Desarrollador.

Es algo escueta, pero que creo cuenta todo lo importante. En principio pensaba escribir un tutorial de cómo desarrollarlo, pero después me di cuenta que realmente no sería instructivo, ya que me pasaría más tiempo hablando acerca del procesado concreto que se fuera a hacer que de las particularidades de desarrollar para XMLEye.

Dicho y hecho: ya está subido a la web y los enlaces puestos en la forja. Cualquiera que lo desee es libre de mejorarlo y comprobarlo.

Por lo pronto, lo primero que me gustaría hacer antes de seguir es trabajar en una traducción inglesa de XMLEye, y posiblemente también después del post-procesador de ACL2. Casi todo está internacionalizado, salvo quizás por los POD de los módulos Perl: aún no me he puesto en ello. Lo siguiente sería traducir el propio código, que sí lo veo más difícil en el lado Perl, donde no tengo las herramientas de factorización de las que disfruta Java. En fin, supongo que para algo están las pruebas de regresión :-D. De todas formas no creo que me dé tiempo.

Empecé el visor con vistas a ACL2, pero estoy viendo que realmente se puede usar para cualquier cosa. Ahora mismo voy apuntando muchas posibles ideas y mejoras como Feature Requests en la forja, desde mejoras en usabilidad hasta nuevos formatos, pasando por cambiar a XSLT 2.0/XPath 2.0 e incluso crear una versión “headless” del programa, al que pudiera accederse con un navegador. Esto da para largo :-D.

Esta semana he estado escribiendo el Manual de Usuario (está entre los documentos del proyecto de la forja), y empecé el Manual del Desarrollador. Por lo pronto ya tengo las instrucciones de compilación, pero aún queda mucho por escribir. Más que nada lo hago porque la gracia de XMLEye está precisamente en que se escriban muchos tipos de documento para él.

Se me ocurrió que sería bueno tener un ejemplo sencillo en dicho manual, ya que definitivamente ACL2::Procesador no serviría como “ejemplo sencillo”: 6000 líneas aproximadamente de código Perl orientado a objetos, fábricas y demás, y sin contar la infraestructura necesaria para que todo funcione como un módulo Perl estándar.

Dicho y hecho: se me ocurrió que YAML podría ser un buen candidato, siempre que pueda escapar la ira de sus usuarios por ensuciarlo convirtiéndolo a XML :-D. Así se pueden usar más tecnologías XML sobre él, como XML Schema o XSLT.

Así que he creado un módulo Perl basado sobre YAML::Syck (un binding Perl de la biblioteca Syck de serialización) que convierte YAML a XML, e incluye una hoja XSLT que devuelve el XML así creado a YAML. Integra pruebas de unidad para asegurarse de que no se producen pérdidas de información en el proceso YAML->XML->YAML. Todo se ha hecho siguiendo las directrices de un binding experimental de YAML para XML, YAXML, disponible en http://www.yaml.org/xml.html.

Además, tiene sus propias hojas de usuario y descriptor de tipo para preprocesamiento y visualización para XMLEye, con lo que nos saltamos algunas de las limitaciones de XML a la hora de visualizar, como no poder tener elementos como “Pepito el de mi pueblo”, que sí son claves de tabla hash válidos en YAML, o nombrar como “Elemento 0″ a los elementos de una lista. La hoja de visualización es una especialización de la hoja XML que añade elementos de los elementos con atributo alias a sus anchor correspondientes.

Se encuentra también en mi repositorio Debian, junto con una versión más reciente de XMLEye que corrige algunos fallos de los que me he dado cuenta desarrollando este ejemplo, dentro del paquete libyaxml-reverse-perl. Puede usarse como un módulo más, o a través del guión yaml2xml que incluye el paquete.

Ah, y de paso: este módulo (y XMLEye por lo tanto) también acepta documentos JSON, ya que dicho estándar no es más que un subconjunto de YAML. Si alguien conoce un vocabulario estándar basado en YAML o JSON, que me lo comente y veré si me puedo montar una especialización de las hojas de usuario para YAXML.

Al final creo que no he conseguido un ejemplo sencillo de preprocesador, pero por lo menos las hojas de visualización y preprocesado sí que son bastante sencillas :-D.

Mucho Debian veo ahí en el título.

Tras una semana de prueba y error y de limpiar bugs a mansalva, he conseguido una versión mucho más estable de pprocACL2 y XMLEye, y lo que es más importante, he creado un repositorio Debian con todos los paquetes necesarios. Además, tengo la grata sorpresa de que mi programa compila y funciona sin más problemas en IcedTea: el único “pero” es que la salida HTML no se muestra del todo bien, pero son detalles sin importancia realmente. Por fin he podido quitar sun-java6-jdk de Build-Depends. He tenido que poner en Depends del paquete IcedTea (con preferencia) y el JRE de Sun (por si el usuario ya lo tiene, ya que java2-runtime por defecto en Gutsy es GCJ, en el que no funciona bien Swing, y sólo SWT.

De paso, he aprovechado lo que he ido aprendiendo todo este tiempo para hacer una pequeña guía (bueno, el PDF tiene ~60 páginas) de cómo crear un paquete Debian, siguiendo una serie de buenas prácticas. No intento competir con otras guías fantásticas que hay por ahí (hay algunas referencias en mi propia guía a ellas), pero vi que no había gran cosa en español, y que no se hablaba bien de ciertas opciones como crear nuestro propio repositorio con reprepro, sincronizarlo con lftp, o usar cowdancer para agilizar el proceso de construcción pbuilder, entre otras cosas. El manual está bajo la GNU FDL y su código fuente está en el repositorio.

Tuve que hacerme mis propias hojas XSLT para convertir DocBook a LaTeX, ya que las que había dejaban mucho que desear (creo que el autor no comprendía bien que LaTeX  es quien debe ocuparse de la presentación, y no él). Están en el subdirectorio manualDebian/hojasXSL, y hay dos: una para generar ficheros LaTeX, y otra para los BibTeX (la salida se ha de volcar a un fichero llamado bibliografia.bib).

Ahora empezaré a trabajar en la documentación del programa. También podría trabajar un poco en las traducciones y en hacer que se integre bien en Windows.

Para instalar los paquetes, hay que añadir estas líneas a /etc/apt/sources.list (también se puede usar Orígenes de software bajo el menú Sistema, y entrar en la pestaña Software de terceros):

deb http://www.shoyusauce.org/packages/ubuntu gutsy main
deb-src http://www.shoyusauce.org/packages/ubuntu gutsy main

Hay que descargarse la clave GPG con la que he firmado mis paquetes, y añadirla al anillo de claves de confianza de apt:

wget http://www.shoyusauce.org/packages/claveDebian.asc
sudo apt-key add claveDebian.asc

Ahora ya podemos actualizar e instalar XMLEye y pprocACL2:

sudo aptitude install xmleye pprocACL2

De por sí no tienen tantas dependencias, pero a la hora de desarrollar he tenido que empaquetar algunos módulos con muchas subdependencias como PAR::Packer. Por supuesto, no hay que instalar ambos: son completamente independientes. XMLEye puede usarse simplemente como un visor XML.

He subido también un tar.bz2 con el código fuente de pprocACL2 y XMLEye. En el código fuente de pprocACL2 hay una serie de ficheros .lisp de ejemplo bajo t/testInputs, que están muy probados. Provienen de los tutoriales disponibles de ACL2. El ejemplo hanoi-use.lisp es el más interesante, ya que incluye enlaces entre una demostración y el libro cuyos teoremas y funciones usa.