Diferencia entre revisiones de «Gestión de integración con redes sociales - 17 18 - G2»

Revisión del 14:25 6 feb 2018

Grupo 2

ID de Opera: Grupo 4 (2017-2018)

Miembros

• Galán Blanco, Cristian
• García Rodríguez, Luis Miguel (coordinador)
• Gómez Ceballos, Alberto
• Huerta Cebolla, Juan
• Martínez Suarez, Daniel Jesús
• Ruano Enríquez, Carlos

Enlaces de interés

• Repositorio de código (GitHub)
• Gestor de tareas (kanban de GitHub)
• Diario del grupo
• WordPress API

Resumen

La web actual del congreso SPLC 2017 dispone de un plugin que permite configurar enlaces a perfiles en redes sociales. Esta utilidad es insuficiente por dos razones: no se fomenta la interacción con los usuarios, como compartir contenido o realizar comentarios; y no hay integración de los perfiles sociales, como mostrar un "timeline" con las últimas publicaciones realizadas. Tampoco mejora el posicionamiento de ésta en buscadores (SEO), ya que la integración de las redes sociales en una web es un factor clave para mejorar este aspecto.

Para solucionar este problema, se ha desarrollado un subsistema: un plugin para WordPress en el lenguaje PHP. Éste se llama SocialHub by EGC y tiene seis widgets con diferentes funcionalidades: botones para compartir contenido, botones para seguir perfiles sociales, comentarios... Para ello, se han integrado varias redes sociales. Cada widget es independiente, lo que permite ubicar cada uno en diferentes partes de la web o incluso omitir alguno si no es necesario.

Dado que cada widget del plugin es independiente, la modularización del código fuente ha sido fácil, así como la integración de estos. Además, permite cambiar la funcionalidad de uno sin que esto afecte al resto.

Introducción y contexto

El sistema heredado es la web del congreso SPLC 2017 que está montada con WordPress, un sistema de gestión de contenidos enfocado a la creación de cualquier tipo de página web. Además, WordPress es un software de código abierto que dispone de una API muy bien documentada y flexible. Ésta dispone de muchos métodos que facilitan la implementación y la integración de un plugin dentro de una web.

Para cumplir con el trabajo encomendado, el equipo de integración de redes sociales desarrolló un plugin, SocialHub by EGC, desde cero, dado que se decidió no heredar código de otros plugins, ya que ninguno satisfacía las necesidades del subsistema. El objetivo de este plugin es integrar servicios como Twitter, Facebook, Google+, LinkedIn, Instagram, Reddit, Feedly, Flipboard, Telegram o WhatsApp. Esto permite que la página esté conectada estrechamente con las redes sociales más conocidas, para atraer visitantes y fomentar la interacción mutua. Para ello, el plugin dispone de seis widgets:

1. Botones para compartir en cada red social el contenido deseado de la web.
2. Caja de comentarios de Facebook para realizar un comentario en cualquier página de la web, permitiendo incluso reflejar esos comentarios en nuestro tablón.
3. Botones para seguir los perfiles sociales de la web.
4. Línea de tiempo (timeline) de redes sociales, es decir, una secuencia de publicaciones ordenadas cronológicamente para las redes sociales Twitter y Facebook.
5. Botón RSS para generar un archivo XML para poder seguir las publicaciones de la web o conectar con una cuenta del agregador de noticias Feedly o Flipboard.
6. Botón de mensaje directo que permite crearlo y enviarlo a una cuenta concreta de Twitter o establecer una conversación por Hangouts.

Además, cada widget de SocialHub by EGC tiene un formulario de configuración que permite cambiar las cuentas y otras opciones desde el back-end de WordPress.

Para poder probarlo en la web de forma local, se ha usado la máquina virtual Debian propuesta por el grupo de integración.

Descripción del sistema

El plugin SocialHub by EGC está implementado en el mismo lenguaje que WordPress, es decir, en PHP. WordPress da cierta libertad para organizar la estructura de directorios y ficheros. Aunque la carpeta raíz del plugin debe llamarse igual que el fichero PHP principal. La estructura elegida para el plugin ha sido la siguiente.

📁socialhub-egc (carpeta raíz)
   🗒socialhub-egc.php (PHP principal donde se hace uso de las APIs y se importan las clases de los widgets y los estilos)
   📁css (carpeta que contiene el CSS que dará formato a los widgets)
      🗒styles-socialhub.css
   📁widgets (carpeta donde van las clases PHP que implementan cada widget)
      🗒class-share-button-widget.php
      🗒class-comment-box-widget.php
      🗒class-follow-button-widget.php
      🗒class-timeline-widget.php
      🗒class-RSS-widget.php
      🗒class-message-button-widget.php
      📁img (carpeta que contiene imágenes para algunos widgets)

El fichero principal de SocialHub by EGC contiene una serie de métodos para importar el resto de archivos PHP (clases) que contienen los widgets. Para ello, hace uso de las funciones include_once y register_widget. La primera importa el código fuente y la segunda agrega el widget al conjunto de la web. Además, también se cargan los estilos alojados en el directorio css en el front-end. Para ello, se usa la función wp_register_style y wp_enqueue_style. Por último, se hace uso de las APIs necesarias embebiéndolas en el código HTML del front-end.

Al separar la implementación de los widgets del fichero principal, si se quisiera ampliar el plugin en un futuro, se podría trabajar en la implementación sin afectar al resto.

Como se ha mencionado anteriormente, cada una de las clases PHP se identifica con uno de los seis widgets, descritos en el apartado anterior. Estás clases heredan de la clase WP_Widget de WordPress. Esto es un requisito. Además, es necesario sobrescribir algunos métodos:

1. __construct: el constructor al cual le indicamos el nombre, la descripción y el ID del widget.
2. widget: en la cual debe ir todo el código HTML que se muestra en el front-end.
3. update: necesario para persistir los datos del formulario cada vez que configuramos un widget.
4. form: la cual es llamada para crear el formulario de configuración del widget.

Suponiendo que ya está instalado en WordPress y activado. El siguiente paso sería añadir el widget deseado en el lugar deseado de nuestra página web. Para ello, hay que acceder al back-end y entrar en la opción customize del menú. Una vez dentro, basta seleccionar el widget y arrastrarlo al lugar donde se quiera poner.

Cambios que se han desarrollado para el proyecto

Dado que no se heredó un plugin y, por tanto, se partió desde cero, se estipularon una serie de cambios a aplicar sobre la primera versión. Esos cambios fueron los siguientes.

1. Widget para compartir contenido: se han añadido dos botones más para compartir contenido en Telegram y WhatsApp. Además, se ha añadido una opción en el formulario de configuración para añadir un remitente al tweet que genera el botón de compartir en Twitter.
2. Widget para timelines: se ha mejorado la personalización de los mismos y se ha añadido la opción de listar los tweets por un hashtag en el formulario de configuración.
3. Widget que integra una caja de comentarios: se ha añadido un botón para ocultar los comentarios y un shortcode para integrarlo dentro de un artículo. Además, se han añadido dos opciones en el formulario de configuración: configurar el número de mensajes por defecto y el color de fondo.
4. Widget para RSS: se ha cambiado el diseño del icono RSS. Además, se han añadido dos botones para seguir un perfil: Feedly y Flipboard.
5. Widget para mensajes directos: se ha añadido un botón para iniciar una conversación a través de Hangouts y se ha mejorado la estética del botón de mensaje directo de Twitter. Además, se ha añadido una opción en el formulario de configuración para introducir un mensaje por defecto.

Planificación del proyecto

Se planificaron tres milestones, cada uno asociado a un entregable:

1. v1.0.0: es la primera versión del plugin, que contiene los seis widgets.
2. v1.1.0: es la segunda versión del plugin, que incorpora nuevos cambios (descritos en el apartado anterior) e integración continua y automatización de las pruebas.
3. v1.1.1: es la tercera versión del plugin, que incorpora mejoras en la seguridad de los formularios de configuración y corrección de errores menores.

Para realizar estas entregas y dado que el equipo de desarrollo estaba formado por seis personas, se decidió dividir el trabajo por widget.

Widget para timelines                               ->   Ruano Enríquez, Carlos
Widget para enviar un mensaje directo               ->   García Rodríguez, Luis Miguel
Widget para RSS                                     ->   Gómez Ceballos, Alberto
Widget para comentarios                             ->   Galán Blanco, Cristian
Widget para compartir contenido                     ->   Huerta Cebolla, Juan
Widget para seguir los perfiles                     ->   Martínez Suarez, Daniel Jesús

Para consultar más información sobre la planificación del proyecto (fechas significativas, actas de reuniones y tareas), consulta el diario del grupo.

Entorno de desarrollo

Lenguajes utilizados: PHP, HTML, CSS y JavaScript (jQuery).
Editor de código fuente: Notepad++ y Sublime Text.
Sistema de control de versiones: Git.
Repositorio de código: GitHub.
Máquina virtual (con Docker y WordPress): Debian.

Gestión del cambio, incidencias y depuración

Procedimiento para registrar un issue interno

Se trabajó con el gestor de issues de GitHub. Para ello, un miembro del equipo fue el encargado de canalizar todos los issues que se registraban. Cuando se encontraba un error o surgía una petición de cambio, se siguieron los siguientes pasos:

1. Se reportaba al encargado de los issues por los canales de comunicación del equipo o en las reuniones. Éste se encargaba de registrarlo con el formato adecuado y las etiquetas que correspondían, que se explicarán a continuación. Además, asignaba a un responsable y un milestone.
2. El responsable trabajaba en la incidencia. Si un commit estaba relacionado con el issue, se incluía en el pie del commit Issue #<id de la incidencia>. También añadía comentarios al hilo del issue. Esto permitía seguir una traza de la evolución del mismo y las decisiones tomadas.
3. Una vez completado el issue, el responsable se encargaba de cerrarlo escribiendo un comentario si fuera conveniente.

Si por error o por que se detectara que el issue aún no hubiera sido terminado, se reabría.

Ejemplos

1. Incidencia relacionada con un bug en un widget. Ver ejemplo
2. Petición de cambio para añadir una nueva funcionalidad en un widget. Ver ejemplo

Procedimiento para registrar un issue externo

En el caso de tener que reportar una incidencia externa al subsistema, el coordinador del grupo se encargó de averiguar el protocolo a emplear. Sin embargo, si en un issue interno se requería la intervención de un miembro externo del equipo, se realizaba un comentario dentro del hilo mencionando a dicho miembro. En este enlace hay un ejemplo de petición de ayuda al coordinador del equipo de integración.

Formato

Se siguió el formato propuesto por el equipo de integración con algunas modificaciones:

1. Título: debía identificar el tipo de incidencia, ser descriptivo y breve.
2. Prioridad: en función de la rapidez que debía ser atendida, se establecieron cuatro grados (urgente, alta, media y baja).
3. Descripción: resumen sobre la incidencia. Éste debía ser muy explícito y podía contener referencias a otros issues o commits relacionados, e imágenes.

Plantilla para issues

Etiquetas (labels)

1. Etiquetas de tipo:
   1. task: representa una tarea concreta necesaria para completar los entregables.
   2. documentation: representa una tarea de documentación.
   3. enhancement: representa una tarea que mejora el código o una funcionalidad.
   4. new functionality: representa una tarea que implican una nueva funcionalidad en el sistema.
   5. bug: fallo encontrado en el sistema.
   6. help wanted: issue que puede ser resuelto por un miembro del equipo, pero que ha sido atendida previamente por otro.
   7. question: a usar sólo entre miembros del equipo para dudas sobre un commit. Éste debe ser referenciado en la descripción.
   8. duplicate: cuando el issue está duplicado. Se debe referenciar al issue original.
   9. invalid: cuando el issue no cumple con el formato propuesto.
   10. wontfix: cuando se ha decidido no darle una solución al issue por alguna razón que debe ser explicada en los comentarios.
2. Etiquetas de estado:
   1. pending: aún no ha sido atendida por el responsable.
   2. in progress: el responsable ya está trabajando en la misma.
   3. finished: ya ha sido resuelta.

Además, cada red social tiene su propia etiqueta y para las tareas marcadas con task no es obligatorio utilizar las etiquetas de estado. Éste se controlará a través del kanban de GitHub.

Tareas

Tanto las tareas (todos los issues marcados con la etiqueta task) como su asignación se acordaban en las reuniones. Para gestionarlas, se utilizó el kanban de GitHub. La persona encargada de una tarea tenía que ir moviéndola por los diferentes estados: To Do, In progress y Done. Además, debía añadir comentarios al hilo del issue que permitiera seguir una traza de la evolución de la misma y las decisiones tomadas.

Kanban

Gestión del código fuente

Para llevar un control del código fuente se utilizó Git, concretamente la plataforma de desarrollo GitHub. Para ello, se creó un repositorio dentro de la organización creada por el equipo de integración.

Commits

Cada vez que se completó una funcionalidad o se solucionó un error, se realizó un commit con un mensaje que siguió el formato propuesto por el equipo de integración con algunas modificaciones. Para ello, se procedió del siguiente modo.

git add <nombreFichero> (para agregar el fichero al índice)
git commit

<tipo>: <título del commit>
(espacio)
<cuerpo del commit>
(espacio)
Issue #<número de la incidencia/tarea en GitHub> (opcional) 

git push origin <nombreRama> (para subir los cambios al repositorio de GitHub)

Ejemplos

1. Commit de tipo "add". Ver ejemplo
2. Commit de tipo "fix". Ver ejemplo

Ramas (branches)

Disponemos de varias ramas:

1. Una rama por cada desarrollador, donde se implementó la funcionalidad asignada a cada uno.
2. Una rama develop que integró todas las funcionalidades implementadas.
3. Una rama principal o master para los entregables.
4. Una rama hotfix para errores detectados en producción por si hiciera falta.
5. Una rama manual para documentación de ayuda.

Ramas principales

Para crear una rama basta con ir a la rama padre con git checkout <ramaPadre> y, a continuación, escribir git branch <ramaHija> para crearla.

Gestión de la construcción e integración continua

Tanto la construcción como la integración continua se ha realizado con Travis CI, junto con la herramienta de PHP para la integración de pruebas unitarias PHPUnit.

Primero de todo, ha sido necesario disponer de varios recursos entre directorios y archivos, dentro de nuestro repositorio:

📁socialhub-egc
📁tests
   🗒bootstrap.php
🗒deploy.enc
🗒phpunit.xml
🗒.travis.yml

socialhub-egc: carpeta donde se encuentra el directorio raíz del plugin de WordPress, esencial para la construcción e integración.

tests: directorio que contiene todos los tests que se llevan a cabo a través de la herramienta PHPUnit. Estos se ejecutarán automáticamente a través de Travis CI. Sin embargo, PHPUnit no se ejecuta solo, necesita ser llamado a través de una instrucción contenida en el fichero de configuración .travis.yml, que será descrito con detalle más adelante.

bootstrap.php: nuestra automatización de pruebas no se reduce únicamente a usar PHPUnit, necesitamos la integración de pruebas que nos proporciona la API de WordPress. Esto se hace mediante este archivo bootstrap.php. En él, además de hacer referencia al fichero bootstrap fuente de la propia instalación de WordPress, también se activa nuestro plugin para que pueda ser probado.

deploy.enc: este fichero es el que contiene las claves encriptadas que se usarán posteriormente para el despliegue, al final de todo el proceso, como se detallará al explicar el fichero de configuración .travis.yml.

phpunit.xml: este fichero es el encargado de organizar la ejecución entre tests, el orden y el fichero en sí, si queremos ejecutar archivos de uno en uno en determinado orden o si queremos programar la ejecución de pruebas de un directorio concreto. Este archivo es al que se llama desde el fichero de configuración .travis.yml mediante una instrucción especifica dentro del script.

.travis.yml: la clave de toda la construcción e integración, es el script de configuración que ejecuta Travis CI (servicio distribuido de integración continua de software). Se adjunta a continuación el contenido de dicho archivo y las lineas de código claves para que, construcción y automatización de pruebas, se lleven a cabo con éxito:

 1  # Tell Travis CI we're using PHP
 2  language: php
 3 
 4  # PHP version used in first build configuration.
 5  matrix:
 6   include:
 7   - php: "5.5"
 8   - php: "5.4"
 9 
10  before_install:
11     - openssl aes-256-cbc -K $encrypted_cb20ac550795_key -iv $encrypted_cb20ac550795_iv -in deploy.enc -out deploy -d
12 
13  before_script:
14     - export PLUGIN_SLUG=$(basename $(pwd))
15     - git clone https://github.com/tierra/wordpress.git /tmp/wordpress
16     - cd ..
17     - mv $PLUGIN_SLUG "/tmp/wordpress/src/wp-content/plugins/$PLUGIN_SLUG"
18     - cd /tmp/wordpress
19     - mysql -e "CREATE DATABASE wordpress_tests;" -uroot
20     - cp wp-tests-config-sample.php wp-tests-config.php
21     - sed -i "s/youremptytestdbnamehere/wordpress_tests/" wp-tests-config.php
22     - sed -i "s/yourusernamehere/travis/" wp-tests-config.php
23     - sed -i "s/yourpasswordhere//" wp-tests-config.php
24     - cd "/tmp/wordpress/src/wp-content/plugins/$PLUGIN_SLUG"
25     - cp -r ./socialhub-egc ..
26     - cd ..
27     - cd "$PLUGIN_SLUG"
28 
29  script: phpunit --colors="always"
30 
31  before_deploy:
32     - chmod 600 deploy && mv deploy ~/.ssh/id_rsa
33     - curl -O https://raw.githubusercontent.com/EGC-G2-Trabajo-1718/integracion/master/tools/deploy-wordpress-subsistemas.sh
34 
35  deploy:
36     skip_cleanup: true
37     provider: 
38         - script
39         - releases
40     api_key:
41      secure: "secure_key"
42     script: ssh -o StrictHostKeyChecking=no deploy@egc.duckdns.org 'bash -s' < deploy-wordpress-subsistemas.sh RedesSociales
43     on:
44      repo: EGC-G2-Trabajo-1718/RedesSociales
45      branch: master
46      php: '5.5'
47      tags: true
48  name: Versión v1.1.1 del plugin SocialHub by EGC

línea 2: en esta línea de código se especifica que el proyecto se desarrolló en el lenguaje PHP.

líneas 5-8: aquí se especifica qué versiones de PHP se van a probar concretamente, con lo que Travis CI, lo primero que haría, sería descargarse dichas versiones del lenguaje antes de comenzar la construcción e integración.

línea 10: esta instrucción, before_install, hace referencia al momento en el que Travis CI aún no ha comenzado la construcción del proyecto. Hasta este instante, Travis CI únicamente ha instalado las versiones que le hemos especificado en la instrucción anterior.

línea 11: esta línea de código es una llamada al paquete de herramientas de criptografía openssl instalado por defecto en UNIX. Dicha herramienta, entre otras funciones, tiene la finalidad de desencriptar el archivo de claves que se citaba anteriormente en este apartado, deploy.enc, para poder llevar a cabo el despliegue cuando se requiera durante la ejecución del script.

línea 13: esta instrucción, before_script, hace referencia al instante en el que Travis CI ha terminado de importar todas las librerías y paquetes de herramientas que hicieran falta para la correcta ejecución y despliegue del proyecto, pero sigue sin comenzar la construcción del mismo. A partir de dicha instrucción, el servicio de Travis CI comienza a descargar el repositorio de GitHub a su imagen virtual de UNIX.

líneas 14-27: estas instrucciones son propias de la shell de UNIX para navegar dentro de los directorios de la máquina de Travis CI.

• Priméramente se clona, en una carpeta temporal dentro de la máquina de Travis CI, el repositorio oficial de GitHub de WordPress (mirror).
• A continuación, se crea la base de datos de MySQL que servirá para llevar a cabo las pruebas con WordPress, editándose también el fichero de configuración de la base de datos (wp-tests-config.php).
• Después, tomamos la carpeta de nuestro plugin, socialhub-egc, y la movemos a la ruta de instalación de los plugins de WordPress, por defecto: .../wordpress/src/wp-content/plugins/.
• Para terminar, se volverá a la ruta raíz del repositorio, donde se encuentra el archivo esencial para la ejecución y configuración de las pruebas unitarias: phpunit.xml.

línea 29: script es la instrucción que verdaderamente da pie a Travis CI a comenzar la construcción del proyecto. En esta instrucción se llama a la herramienta de integración de pruebas unitarias PHPUnit, que se encuentra orquestada por el fichero al que se hacía referencia anteriormente, phpunit.xml, en el que se gestionan todas las rutas a los ficheros de prueba (tests) y el orden en el que se quiere que se ejecuten.

líneas 31-final: esta parte controla el despliegue del proyecto, en la que se hace referencia, con la instrucción before_deploy, a qué se quiere hacer justo antes de llevar a cabo dicho despliegue, seguida de la instrucción deploy, que precede la instrucciones del despliegue final dentro de Travis CI.

La parte del despliegue se explicará más detalladamente en el siguiente bloque.

Gestión de liberaciones, despliegue y entregas

Gestión de liberaciones

Se realizaron al terminar todas las tareas relacionadas con un milestone. Éste estaba asociado a un release.

Tras unir todas las ramas de cada miembro con la rama develop y resolver los conflictos, si los hubiera, se procedía a subir el código fuente de la rama develop a la rama principal (master). Para ello, fue necesario realizar un pull request (ver ejemplo), que debía ser aprobado por el coordinador. En éste se mencionaba los cambios de la nueva versión y el milestone al cual estaba asociado.

Todas las versiones del proyecto se encuentran en el release de GitHub.

Gestión de despliegue

Como se comentaba en el bloque anterior, el despliegue se automatizó a través de Travis CI. En la parte final del fichero de configuración travis.yml se encuentran las intrucciones para realizar el despliegue:

1. Con el skip_cleanup: true evitamos que Travis CI restablezca su directorio de trabajo y elimine todos los cambios realizados durante la compilación del script.
2. La instrucción provider y los valores script y release, hacen referencia a que el código de despliegue va a ejecutar un script propio (proporcionado) y además va a construir una release del proyecto.
3. api_key, secure, hace referencia a la clave de api que requiere Github para automatizar el despliegue de la release requerida, donde "secure_key" no es la cadena que habría que poner, sino una clave de api válida para la automatización. Por cuestiones de integridad no se muestra en el ejemplo.
4. A continuación de la instrucción script se llama al paquete SSH, cuya herramienta ofrece un medio de conexión segura hacia otro servidor SSH de una máquina remota, un servidor construido por el equipo de integración con su configuración por cada submódulo del proyecto organizado de la asignatura, en nuestro caso el subsistema Redes Sociales.
5. Posteriormente a la instrucción on, el script se encarga de establecer varios parametros:

• Nombre del repositorio del que se va a llevar a cabo la release.
• Rama del repositorio que sirve como disparador de la release a la hora de hacer un commit en ella.
• Con que versión del lenguaje va a ser compatible (versión de php en nuestro caso).
• Si la release va a generar tag o no.
• Y el nombre de la propia release.

Ejecutando este fragmento de código, Travis esta configurado para llevar a cabo tanto el despliegue como la release simultáneamente.

El equipo de integración de la organización se encargó de crear un script para que el plugin se desplegara y se integrara con el resto del sistema. Para ello, fue necesario hacer referencia a dicho script dentro del fichero de configuración de Travis CI. Además, para poder realizar el despliegue eran necesarias las claves del fichero deploy.enc. El despliegue se producía siempre que se confirmaba un cambio en la rama master. El plugin y el resto de subsistemas se encuentra integrado en este servidor.

Gestión de entregas

La entrega se realizó a través de un ZIP que contiene el código fuente. Se realizaron tres versiones del producto software: v1.0.0, v1.1.0. y v1.1.1. La documentación se entregó en formato wiki.

Política de nombrado e identificación de los entregables

Los entregables tendrán la siguiente nomenclatura: X.Y.Z

• X => Se utiliza para cambios importantes como cambios en la arquitectura.
• Y => Se utiliza para cambios menos importantes como nuevas funcionalidades.
• Z => Se utiliza para corrección de errores o mejoraras en el código que no impliquen un cambio de funcionalidad.

Mapa de herramientas

Por un lado, se encuentran las herramientas que forman parte del entorno de desarrollo. Para ello, se dispone de Oracle VM VirtualBox, un software de virtualización, en los equipos de los desarrolladores. Éste tiene una máquina virtual de Debian con el contenedor de software Docker instalado, que tiene a su vez varias imágenes instaladas:

1. WordPress: el sistema de gestión de contenido web que contiene el sistema SPLC. Aquí se integran con el resto del sistema y se prueban los widgets del proyecto.
2. MySQL: el sistema de gestión de la base de datos del sistema.
3. HTTP Apache: el servidor necesario para ejecutar WordPress.

Estas herramientas permiten desplegar de manera local el sistema. Además, se ha trabajado con el lenguaje de programación PHP, empleando como herramientas de desarrollo los editores de código fuente Notepad++ y Sublime Text. Por último, para gestionar el código fuente se ha utilizado un repositorio alojado en GitHub, el cual integra un sistema de control de versiones de Git.

Por otro lado, para la gestión de la integración continua, automatizar las pruebas y el despliegue, se ha empleado la herramienta Travis CI, la cual está sincronizada con el repositorio de GitHub. Para estas pruebas se ha usado la versión 5.4 y 5.5 de PHP.

Mapa de herramientas

Ejercicio de propuesta de cambio

A continuación, se mostrará un ejemplo real de un cambio realizado. Éste consistía en añadir dos botones más al widget para compartir contenido: Telegram y WhatsApp.

1. El encargado de la gestión de los issues creó un nuevo issue en GitHub con el formato adecuado; asignando a un responsable, un milestone y añadiéndolo al proyecto. Además, añadió tres etiquetas: Telegram, WhatsApp, task y new functionality (dado que se trataba de un cambio que añadía una funcionalidad). Ver issue.
2. Para poder controlar la evolución de la nueva tarea, entró en el kanban de GitHub e hizo clic en +Add cards para colocar la tarea en la columna To Do.
3. El responsable de la nueva tarea, entró en el kanban de GitHub y colocó la tarea en la columna In progress cuando empezó con ella.
4. En su repositorio local, creó una rama con su nombre a partir de la rama develop donde desarrollar la nueva funcionalidad. Primero accedió a la rama de desarrollo git checkout develop. Y después creó la rama y accedió a ella git branch -b <nombreRama>.
5. Implementó los cambios en la nueva rama. Para ello, añadió código en la función widget de la clase class-share-button-widget.php para crear los botones. Además, creó un formulario en la función form para poder cambiar el texto por defecto asociado al enlace a compartir. También añadió nuevas clases CSS para los estilos de los botones y una línea de código en la función update para persistir el texto introducido en el formulario: $instance['telegramText'] = trim(strip_tags($new_instance['telegramText']));.
   

   Código fuente de los botones para Telegram y WhatsApp
   
   
   

   Código fuente del formulario para Telegram
6. Por cada funcionalidad completada, realizó un commit. Además, escribió varios comentarios en el hilo del issue para explicar los cambios realizados. Ver comentario del botón de Telegram o ver comentario del botón de WhatsApp.
   

   Botones de Telegram y WhatsApp
7. Para confirmar los cambios, primero preparó el fichero modificado para ser confirmado git add <nombreFichero>. Luego realizó el commit git commit. Éste debía tener el formato correcto. A continuación, subió la rama al repositorio de GitHub git push origin <nombreRama>.Ver commit del botón de Telegram o ver commit del botón de WhatsApp.
8. Una vez completada la tarea, realizó un merge entre la nueva rama donde implementó la funcionalidad y la rama develop. Para ello, accedió a la rama de desarrollo git checkout develop e hizo el merge git merge <nombreRama>. A continuación, subió el cambio al repositorio git push origin develop.
9. Colocó la tarea en la columna Done en el kanban y cerró el issue.
10. El encargado de la gestión de los issues realizó un pull request para hacer un merge entre la rama develop y master, que debía tener el visto bueno del coordinador. En esta petición se escribió un comentario con los cambios de la nueva versión (changelog). Ver pull request.
11. Así, el cambio pasó a la rama principal y, por tanto, al estar sincronizado ésta con Travis CI, se procedió con la integración continua. Para ello, hay que tener configurado el fichero .travis.yml, donde se indica el lenguaje de programación del proyecto (PHP), las versiones a utilizar y el software necesario a instalar: WordPress, MySQL, Apache y PHP Unit (para las pruebas).

Conclusiones y trabajo futuro

La implementación del plugin no ha sido una tarea muy compleja, dado que tanto la API de WordPress como las de las redes sociales integradas es muy flexible. Además, la documentación es completa y tiene ejemplos.

Por otro lado, consideramos que es muy importante estudiar en profundidad un buen modelo para gestionar las ramas: crear sólo las ramas necesarias y, sobre todo, que éstas se adapten tanto al proyecto como al modo de trabajar del equipo. En nuestro caso esto no fue así. Esto originó que tuviéramos que cambiar el modelo con el proyecto ya empezado, lo que originó que se acumularan muchas tareas para los últimos días.

Por último, consideramos que el plugin SocialHub by EGC cumple con los aspectos más relevantes de cualquier integración con redes sociales. Sin embargo, consideramos que aún podría ser mejorado. Por ello, sugerimos una serie de mejoras para una próxima versión.

1. Mejorar los estilos de los diferentes widgets: que todos utilicen el mismo color de fondo, que todos los botones tengan el mismo tamaño o que se pueda personalizar los estilos desde el formulario de configuración.
2. Integrar más redes sociales como Pinterest o Flickr.
3. Crear un manual de usuario que pueda ser consultado desde el back-end de WordPress.
4. Publicar el plugin en el repositorio de WordPress.