Refactorizar: Extraer un método

Ejemplo de refactorización para la técnica Extraer un método

Código sin refactorizar:

Python
def generar_reporte(clientes):
  """
  Genera un reporte en formato HTML con la información de los clientes.

  Args:
    clientes: Una lista de diccionarios que representan los clientes.

  Returns:
    Una cadena de texto con el HTML del reporte.
  """

  html = "<html><head><title>Reporte de clientes</title></head><body>"

  for cliente in clientes:
    html += "<h1>" + cliente["nombre"] + "</h1>"
    html += "<ul>"
    html += "<li>ID: " + str(cliente["id"]) + "</li>"
    html += "<li>Email: " + cliente["email"] + "</li>"
    html += "<li>Teléfono: " + cliente["telefono"] + "</li>"
    html += "</ul>"

  html += "</body></html>"
  return html

Problema del código sin refactorizar:

  • El método generar_reporte es demasiado largo y contiene código repetitivo para generar la información de cada cliente.

Refactorización utilizando la técnica Extraer un método:

Python
def generar_reporte(clientes):
  """
  Genera un reporte en formato HTML con la información de los clientes.

  Args:
    clientes: Una lista de diccionarios que representan los clientes.

  Returns:
    Una cadena de texto con el HTML del reporte.
  """

  html = "<html><head><title>Reporte de clientes</title></head><body>"

  for cliente in clientes:
    html += generar_informacion_cliente(cliente)

  html += "</body></html>"
  return html

def generar_informacion_cliente(cliente):
  """
  Genera el HTML con la información de un cliente.

  Args:
    cliente: Un diccionario que representa un cliente.

  Returns:
    Una cadena de texto con el HTML del cliente.
  """

  html = "<h1>" + cliente["nombre"] + "</h1>"
  html += "<ul>"
  html += "<li>ID: " + str(cliente["id"]) + "</li>"
  html += "<li>Email: " + cliente["email"] + "</li>"
  html += "<li>Teléfono: " + cliente["telefono"] + "</li>"
  html += "</ul>"
  return html

Beneficios de la refactorización:

  • El código está mejor organizado y es más fácil de leer.
  • Se ha eliminado la duplicación de código.
  • El método generar_reporte es ahora más corto y fácil de entender.
  • El método generar_informacion_cliente se puede reutilizar para generar HTML con la información de un cliente en cualquier parte del programa.

En este ejemplo, la técnica Extraer un método ha permitido crear un código más modular y reutilizable. Es importante tener en cuenta que el nombre de los métodos extraídos debe ser descriptivo y reflejar claramente su propósito. 

Comentarios

Publicar un comentario

Entradas más populares de este blog

Malos olores

Malos olores En el desarrollo de software, los malos olores se refieren a indicadores que sugieren que el código puede tener problemas subyacentes de calidad o diseño. Estos problemas pueden afectar la legibilidad, mantenibilidad, extensibilidad y confiabilidad del código. Ejemplos de malos olores: Clases grandes: Clases con un gran número de métodos o atributos pueden ser difíciles de entender y mantener. Métodos largos: Métodos con un gran número de líneas de código pueden ser difíciles de seguir y depurar. Duplicación de código: Código que se repite en diferentes partes del programa puede indicar que el código no está bien organizado o que falta refactorización. Nombres confusos: Nombres de variables, métodos o clases que no son claros o descriptivos pueden dificultar la comprensión del código. Acoplamiento excesivo: Las dependencias estrechas entre diferentes partes del código pueden dificultar la modificación o extensión del programa. ¿Cómo detectar malos olores en softw...
Leer más

Refactorización

Refactorización. La refactorización es una técnica fundamental en la ingeniería de software que consiste en modificar el código fuente de un programa sin alterar su comportamiento externo. En otras palabras, se trata de mejorar la estructura interna del código para hacerlo más limpio, legible, mantenible y extensible. Importancia. Existen diversas razones por las que la refactorización es una práctica valiosa en el desarrollo de software: Mejora la legibilidad del código: Un código bien refactorizado es más fácil de entender para cualquier desarrollador, lo que facilita su comprensión, modificación y mantenimiento en el futuro. Reduce la probabilidad de errores: Un código limpio y organizado es menos propenso a contener errores, ya que su estructura lógica es más clara y sencilla de seguir. Facilita la adición de nuevas funcionalidades: Un código bien diseñado y modular permite incorporar nuevas características de manera más eficiente y segura, sin comprometer la estabilidad del progra...
Leer más

Refactorización: Eliminar código muerto

  Ejemplo de refactorización: Eliminar código muerto Problema: Consideremos el siguiente código JavaScript: JavaScript function calcularPromedio ( notas ) { let suma = 0 ; for ( let nota of notas) { suma += nota; } let promedio = suma / notas.length; // Código muerto console .log( "Las notas sin ponderar son:" , notas); return promedio; } En este código, la línea console.log("Las notas sin ponderar son:", notas); se considera código muerto, ya que no se utiliza el valor de la variable notas después de imprimirlo en la consola. Solución: Eliminar la línea de código muerto: JavaScript function calcularPromedio ( notas ) { let suma = 0 ; for ( let nota of notas) { suma += nota; } let promedio = suma / notas.length; // Se elimina la línea de código muerto return promedio; } Explicación: La técnica de refactorización Eliminar código muerto consiste en eliminar código que no tiene ningún efecto en el comportamient...
Leer más