Refactorización de complementos de WordPress: un pequeño ejemplo
Una de las formas en que surgen los complementos de WordPress es que, al menos en mi caso, comienzan como una colección de funciones utilizadas para ayudar con un propósito particular para un proyecto determinado. A partir de ahí, piensas "Oye, tal vez a alguien más le resulte útil".
Al menos esa ha sido mi experiencia la mayoría de las veces.
Pero la cuestión es que antes de publicarlo para que otras personas lo prueben, desea pasar por el proceso de limpieza del código. Tampoco estoy hablando de refactorizar los complementos de WordPress, al menos no todavía.
Estoy hablando de tomar el código, convertirlo en algo que funcione como un complemento de WordPress y luego posiblemente refactorizar el código.
Refactorización de complementos de WordPress
Pasar por todo el proceso de refactorización de los complementos de WordPress, por no hablar de un solo complemento de WordPress, puede ser arduo, pero compartir cómo refactorizar una parte de un complemento es algo factible.
Así que usaré un ejemplo de cómo estaba usando algo recientemente (con el código resumido un poco para no molestarme en ser específico sobre un proyecto determinado).
Trazar la salida ideal de opciones.
Sin embargo, antes de hacerlo, creo que es importante compartir que mi proceso puede diferir, o probablemente, diferir del suyo (ya que muchos de nosotros tenemos procesos diferentes).
- Diseñe el componente (sí, ni siquiera el complemento completo) en un cuaderno,
- Cree una lista de verificación de los casos de uso en los que debería pasar y cuándo debería fallar,
- Escriba qué datos se necesitan, cómo se necesitan y cuándo se deben ignorar
- Convierta todo lo anterior en código.
Por supuesto, no lo convierto todo literalmente en código, pero entiendes la idea. Quizás la forma más sucinta de decirlo sea así:
- Comience con un método largo que sirva para el caso de uso ideal. Luego refactorice ese código para que las funciones sean más pequeñas y tengan en cuenta los casos en los que el resultado fallaría.
Dicho esto, así es como se vería el código.
1 Escritura para el caso de uso ideal
En este ejemplo, el caso de uso ideal es cuando el usuario carga las opciones, las opciones están presentes y luego necesita realizar una acción si las opciones tienen ciertos valores.
Esta parte debería ser fácil de leer, pero no tiene en cuenta nada excepto la ruta ideal a través del código.
2 Ponte un poco a la defensiva
A continuación, me gusta asegurarme de que las opciones estén configuradas antes de intentar leerlas. En algunos casos, es posible que desee mostrar un aviso, generar una excepción o registrar información.
En este ejemplo, solo voy a regresar ya que es fácil de leer y se puede ajustar más fácilmente para su uso.
Entonces eso maneja las opciones, pero ¿qué pasa con el caso cuando las opciones están configuradas pero no tienen los valores que esperamos? Esto significa que también debemos verificar que lo hagan. Y, si no, ignóralos, regresa, registra un error, lanza una excepción, etc.
Ya sabes: Lo mismo que arriba. Excepto que, en este caso, no tomaré ninguna acción a menos que el código tenga la información ideal.
3 Poniéndose un poco largo
En este punto, el método se está volviendo un poco largo y cada vez más difícil de leer. Claro, si es un programador experimentado, puede argumentar que "Esto es código, no es inglés", pero ¿por qué no intentar que sea un poco más fácil de seguir?
Además, hace que sea un poco más fácil de probar. Pero eso está más allá del alcance de esta publicación. Tome la evaluación de opciones como el primer ejemplo del código.
- Esto es algo que puede incluirse en su función que no solo aísla esta verificación, sino que también facilita un poco la llamada resultante.
- Luego, tome el segundo bloque de código que verifica los valores de opción ideales. Esto también se puede abstraer por las mismas razones anteriores.
- Y finalmente, configure una función para asegurarse de que los valores esperados estén establecidos para cada uno de los valores que se especifican :
Así que ahora tiene dos métodos más pequeños que encapsulan la misma verificación que estaba haciendo.
4 La función final
En este punto, la función final es mucho más fácil de leer, ya que tiene dos funciones auxiliares que encapsulan sus responsabilidades, mientras que esta vuelve a evaluar la ruta ideal a través del código:
Baste decir que cuando se trata de refactorizar complementos de WordPress, este es solo un ejemplo de cómo hacer solo un segmento. Pero es un comienzo, ¿verdad?
Complementos completos?
¿Yo se, verdad? Refactorizar complementos de WordPress no es una broma. Pero si comienza con funciones pequeñas como esta y trabaja gradualmente en el código base, se vuelve más fácil.
Y si dedica tiempo a planificar el proyecto desde el principio, puede ahorrar mucho tiempo al volver atrás y refactorizar este tipo de cosas.