Desarrollo práctico 3: Proyecto

Escrito por | 01 Mayo 2014 | Publicado en Mayo 2014
Este es el tercer artículo, de una serie de artículos sobre el desarrollo práctico. Hoy le toca el turno, a las ventajas de hacer frente a tu proyecto a través de un en entorno de desarrollo integrado (IDE) como PHPStorm. Consulte los artículos anteriores de esta serie.

Gestionar los proyectos y archivos haciendo uso de PHPStorm

Los Entornos de Desarrollo Integrados (IDE) como Eclipse, Netbeans, PhpStorm entre otros, pueden ayudar a mejorar la productividad. Ofrecen diferentes niveles de soporte para lenguajes como PHP, JavaScript y HTML con respecto a la edición, la inspección, la refactorización, las normas de codificación de Joomla, la extensibilidad a través de plugins y mucho más.

La elección de PHPStorm

No hay elección "incorrecta" al elegir un IDE, es una cuestión de preferencia personal. Si el IDE cubre sus necesidades y se siente bien con él, ¡quédese con él!

Después de explorar varias opciones, encontré PHPStorm. Está disponible para todas las plataformas (Windows, Mac OS X y Linux), adaptable, fácil de usar y rico en características, lo cual cubre mis necesidades de desarrollo. Cada vez que se haga referencia a la palabra IDE en el contexto de esta serie de artículos, se hará referencia a PHPStorm específicamente.

Aunque PHPStorm es un producto comercial - y bien vale la pena su costo para los desarrolladores comerciales - es libre para los “desarrolladores de código abierto". Si estás contribuyendo con Joomla, consulte con el "Joomla bug squad" para una copia de la clave de licencia de Joomla. Viene con un período de prueba estándar de 30 días.

Al igual que con cualquier herramienta compleja, hay más de una manera de hacer las cosas, por lo que voy a hablar de lo que considero que es una forma genérica, la cual puede adaptarse a las necesidades específicas. 

Instalación

Descargue PHPStorm del sitio JetBrains y siga las instrucciones de la instalación

El Proyecto

Comenzamos creando un nuevo proyecto a partir de archivos existentes. Esta creación comienza en el nivel del directorio que vamos estar utilizando: 

##PROYECTOS##//local.##DOMINIO##

##PROYECTOS##//local.##DOMINIO##/#vcs/extension
                                |    /module
                                     /www
                                     /logs
                                     /.idea

El directorio .idea es creado por PHPStorm y posee la configuración del proyecto.

Todos los archivos y directorios del directorio del proyecto elegido son indexados, monitoreados y accesibles desde dentro del IDE para la inspección y la edición. 

Archivos del Proyecto

Un IDE proporcionará apoyo para un gran número de tipos de archivo, como:

.php, .css / .less / .scss, .xml, .html, .js, .ini  

Resaltado de la Sintaxis 

Resaltado Sintaxis

La ayuda más básica a la hora de inspeccionar los archivos proviene de colorear el código fuente, resaltandolo, por lo que el código es más legible. Lo anterior muestra una parte de un archivo PHP con soporte de lenguaje mixto para php, html y css.

Resaltado Imagen

Pero el resaltado de sintaxis puede ser útil para identificar, los corchetes abiertos que aún faltan por cerrar. 

Colapsar los bloques

Colapsar los bloques

Colapsar los bloques de código a una sola línea.

Colapsar los bloques 

Mostrar y Navegar

Debido a que el IDE efectivamente "lee" el código fuente, los bloques de comentarios y los interpreta, será capaz también de ofrecer información adicional. Si dejamos la tecla Ctrl presionada, por ejemplo, se muestran los parámetros utilizados en el método. Si damos Ctrl - Clic en el método o variable, navega hasta el archivo de origen correspondiente a la posición exacta.

Navegación 

El IDE también mostrará los métodos que están en desuso, los que están en riesgo de ser eliminado en una próxima versión.

Navegación 

Refactorización

Una constante en la codificación es que cuando revisamos lo que hicimos, nos damos cuenta que no estamos contento con lo que hemos hecho, y queremos refactorizar el código existente.

PHPStorm viene con algunas funciones increíbles que vale la pena explorar. Por ejemplo, en vez de usar "buscar y reemplazar (search and replace)", haga un clic derecho sobre una variable o método y seleccione refactor | rename.Refactorización 

PHPStorm hará uso de todo su conocimiento en la búsqueda y reemplazo de los nombres de archivos, y le indicará cual pueden ser cambiados, y cuales no.

Soporte Joomla

El proyecto Joomla tiene sus propias normas de codificación que ayudan a asegurar que nuestro código es de alta calidad, lo que hará que sea fácil de leer, depurar y mantener. PHPStorm puede ser extendido para contar con el apoyo específico de Joomla en el IDE

Estilo del Código

PHPStorm puede reformatear el código para que tenga la misma sangría, espaciado, etc. Con la ayuda del archivo de configuración específico para Joomla, podemos hacer que el IDE tome los estilos a la manera de Joomla (vealo en la Documentación de Joomla). Para añadir el soporte para el estilo de codificación de Joomla, descargue el archivo de configuración aquí, y copie el archivo Joomla.xml para /config/codestyles/ en el directorio de instalación de PHPStorm.

Abra la configuración de PHPStorm (vía File | Settings) y escriba en la barra de búsqueda code, para que aparezcan los diferentes estilos, en los cuales escogen el estilo Joomla.

Estilos del Código

Analizador de Código

Tener el código bien organizado es una cosa, pero asegurarnos que el código actual cumple con las normas de codificación estándar de Joomla, es otra. Por ello necesitamos un analizador de código (véalo también en la documentación de joomla) .

Primero configuramos la herramienta del analizador de código, siguiendo la documentación de PHPStorm. Ahora abra la configuración de PHPStorm (vía File | Settings) y escriba en la barra de búsqueda code, para que aparezcan los diferentes estilos, en los cuales escogen el estilo Joomla. Ahora hacemos referencia al archivo ejecutable del analizador de código para activarlo.

##INSTALACIÓN_XAMPP##/php/phpcs.bat

Analizador de código

Lo siguiente que tenemos que instalar es el soporte para la codificación estándar de Joomla. Extraemos la codificación estándar para:

##INSTALACIÓN_XAMPP##/php/pear/PHP/CodeSniffer/Standards/Joomla

O para usuarios avanzados, clonar el repositorio de Git para esa ubicación. Abra la configuración de PHPStorm (vía File | Settings) y escriba en la barra de búsqueda inspec para revelar y seleccionar el estilo de código de Joomla.

Analizador de código

Y como resultado, ahora estamos siendo advertidos al violar las normas de codificación de Joomla.

Resultado

Control de Versiones, Desarrollo y Pruebas

Estos temas son tan importantes y complejos, que sus artículos llevan un poco más de trabajo. Así que sean pacientes que todos van a salir.

Visto 6375 veces Etiquetado como Spanish, Desarrollador
Carlos Rodriguez

Carlos Rodriguez

Me apasiona el desarrollo web, y todo lo hermoso y misterioso que conlleva esto.  

Perfiles Sociales