Code Smells and Refactoring

[DiegoA00]

Hola, con motivos académicos he encontrado algunos code smells y sugerencias para hacer uso de algunas técnicas de refactorización.

Code Smells

Comments:

Signs and Symptoms
En la clase EspetacullosController se hace uso de comentarios en varios fragmentos para explicar algo. Esto indica que el autor cree que su código no es fácil de entender.

Payoff
Mayor legibilidad y entendimiento del código.

Técnicas de Refactorización
Reemplazar Type Code con Subclases

Síntomas
Se encontró un método en la clase CalculadoraDePrecos en la que calcula el precio de los espectáculos dependiendo del tipo del espectáculo. Por ello se hacen varias condiciones para un simple cálculo. Esto es solo uno de los posibles métodos que podrían hacer uso de la clase enum TipoDeEspetaculo.

Solución
Con esta técnica cambiamos el enum TipoDeEspetaculo a subclases de Espetaculo donde se podrá manejar de mejor forma el cálculo del precio de cada tipo de espectáculo.

Beneficios
Evitar el uso de condicionales muy grandes y que no se entiendan fácilmente.
El código se vuelve más extensible. Si tenemos un nuevo tipo solo creamos una nueva subclase.

 
Consolidar Expresiones Condicionales

Síntomas
En el método calcula de la clase CalculadoraDePrecos se tienen varias condicionales que dan un mismo resultado. Para los espectáculos de tipo ballet y orquestra se tiene el mismo resultado. Además, la variable preco siempre va a terminar siendo el precio de la sesión si no se cumplen tres condiciones.

Solución
Crear un método que tenga dentro una verificación de que si la sesión es de tipo ballet u orquestra. Este método se llamará dentro del if para que realice el mismo cálculo del precio para dichas sesiones. También inicializar la variable preco con el precio de la sesión.

Beneficios
Evitamos la repetición de código y tenemos una mayor legibilidad del código.
 
Encapsular Colección

Síntomas
La clase Espetaculo tiene una lista de sesiones como atributo privado, pero esta misma clase ofrece una manera de que cualquier clase pueda obtener esta lista que se puede modificar. Esto realmente no encapsula la lista se sesiones.

Solución
Reemplazar el retorno del método getSessoes a una lista que no se pueda modificar haciendo uso de un método de la clase Collections.

Beneficios
Evita que se hagan cambios accidentales o se sobrescriba la lista de sesiones de alguna instancia de Espetaculo.
 
Introduce Parameter Object

Síntomas
En el método cadastraSessoes de la clase EspetaculosController se tiene varios parámetros donde sus tipos de datos están relacionados con el tiempo y la fecha.

Solución
Crear una clase CronogramaSesion que tenga como atributo una fecha de inicio, una fecha de fin, un horario y su periodicidad con sus respectivos getters. Así el método cadastraSessoes se reduce a 2 parámetros.

Beneficios
Mayor legibilidad al código porque ya no se tienen varios parámetros, sino que tenemos un objeto con un nombre comprensible.
Esto sirve por si en algún futuro se decidan crear más métodos que hagan uso de los mismos parámetros. Con esto el grupo de parámetros se reduce al objeto creado.