CLEAN CODE

Principios SOLID y Clean Code

Qué es la deuda técnica?

La falta de calidad en el código, la qual genera una deuda que repercutirá en costos futuros.

Que tipo de costos economicos conlleva la deuda técnica?

1. Tiempo en realizar mantenimientos.
2. Tiempo en refactorizar código.
3. Tiempo en comprender el código.
4. Tiempo adicional en la transferencia del código.

Quales son los 4 tipos de duda técnica según el esquema de Martin Fowler?

Deuda Imprudente, Deuda Imprudente Inadvertida, Deuda Prudente, Deuda Prudente Inadvertida.

Cómo se paga una deuda técnica?

Mediante refactorización.

Qué es la refactorización?

Es un proceso que tiene como objetivo mejorar el código sin alterar su comportamiento para que sea más entendible y tolerante a cambios.

Qué es imprescindible ante una refactorización grande?

Implementar pruebas automatizadas.

A qué nos referimos con código limpio?

Aquel código escrito con la intención de que otra persona (o tú mismo en el futuro) lo entienda.

Que es programar?

Programar es el arte de decirle a otro humano lo que quieres que la computadora haga.

Como deben ser los nombres de las variables y funciones?

Pronunciables y expresivos.

En que idioma deben estar escritos los nombres de las variables?

Imprescindiblemente en inglés.

Como podemos mejorar los nombres de las clases?

Evitando redundancias innecesarias.

Como mejorarías los nombres de esta clase ( interface UserInterface {} ) ?

interface User {}

Como mejorarías los nombres de esta clase ( class UserImplementation {} ) ?

class User {}

Como podemos crear una función anónima auto-invocada en typescript?

(() => { })();

Porque hoy día podemos usar nombre largos y descriptivos en el código sin que afecte al rendimento del programa?

Porque al compilarse el código los nombres de las variables y funciones se simplifican.

Como deben ser los nombres de las variables?

Deben describir el tipo de dato que contienen.

Como podemos mejorar el nombre de este arreglo (const fruit = ['manzana', 'platano', 'fresa'];) ?

const fruitNames = ['manzana', 'platano', 'fresa'];

Como podemos mejorar el nombre de esta variable (const open = true;) ?

const isOpen = true;

Como podemos mejorar el nombre de esta variable (const write = true;) ?

const canWrite = true;

Como podemos mejorar el nombre de esta variable (const fruit = true;) ?

const hasFruit = true;

Como podemos mejorar el nombre de esta variable (const active = false;) ?

const isActive = false;

Como podemos mejorar el nombre de esta variable (const noValues = true;) ?

const hasValues = true;

Como podemos mejorar el nombre de esta variable (const notEmpty = true;) ?

const isEmpty = true;

Como podemos mejorar el nombre de esta variable (const fruits = 3;) ?

const totalFruits = 3;

Como podemos mejorar el nombre de esta variable (const cars = 10;) ?

const totalOfCars = 10;

Como deben construirse los nombres de las funciones?

Usando el verbo que representa la acción seguido de un substantivo.

Que es el principio de responsabilidad única?

Cada acción debe realizar una tarea única.

Como deben construirse los nombres de las clases?

Nombres formados por un sustantivo.

Porque se deben evitar nombres genericos en las clases?

Para evitar que las clases realizen más tareas de las que deberían.

Que convención de nombre deben tener las clases?

UpperCamelCase

Que convención de nombre deben tener las variables?

camelCase

Que convención de nombre deben tener las variables en python?

snake_case

Que preguntas nos debemos plantear antes de definir el nombre de una clase?

1. ¿Que hace exactamente la clase?
2. ¿Cómo lleva a cabo exactamente la tarea definida esta clase?
3. ¿Hay algo específico sobre su ubicación?

Como sabemos si una función esta siguien los principios solid?

Si hace exactamente lo que su nombre indica.

Que se puede hacer para simplificar la declaración de parametros en una función?

Si tiene más de tres parámetros, utilizar una interfaz.

Como se recomiendan ordenar los parámetros de una funcion en una interfaz?

Por orden alfabético.

Que directrizes se recomiendan seguir a la hora de declarar una función?

1. Mantener la simplicidad.
2. Mantener un tamaño reducido.
3. Crear funciones de una sola línea de código sin causar complejiad.
4. Mantener las funciones de menos de 20 líneas de código.
5. Priorizar el uso de la condicional ternaria.

Comno podemos reducir la cantidad de líneas de código en una función?

Delegando responsabilidades a otras funciones.

Como se podría simplificar la siguiente línea de código?
if(isSeparated) {
return 2500;
}

if (isSeparated) return 2500;

Como podemos simplificar el código de la imagen?

const getPayAmount = ({ isDead = false, isSeparated = true, isRetired = false }): number => {
if (isDead) return 1500;
if (isSeparated) return 2500;
return (isRetired) ? 3000 : 4000;
}

Como podemos simplificar el código de la imagen?

let redFruits: string[] = ['manzana', 'cereza', 'ciruela'];
function isRedFruit(fruit: string): boolean {
return (redFruits.includes(fruit));
}

Como podemos simplificar la función de la imagen?

function workingSteps() {

if (!isFirstStepWorking) return ‘First step broken.’;

if (!isSecondStepWorking) return ‘Second step broken.’;

if (!isThirdStepWorking) return ‘Third step broken.’;

if (!isFourthStepWorking) return ‘Fourth step broken.’;

return ‘Working properly!’;

}

Que representan las siglas del principio DRY?

Don't Repeat Yourself.

En que consiste el principio DRY?

En evitar código redundante.

Que ventajas tiene la utilización del principio DRY?

1. Simplifica las pruebas.
2. Ayuda a centralizar procesos.

Instancia un nuevo tipo de dato en TypeScript para permitir solo género femenino o masculino.

type Gender: 'M'|'F';

Qual es la estructura recomendada de una clase?

1\. Lista de propiedades estáticas.
2\. Lista de propiedades privadas.
3\. Lista de propiedades públicas.
4\. Constructores estáticos.
5\. Constructores.
6\. Métodos estáticos.
7\. Métodos privados.
8\. Resto de métodos de instancia ordenados de mayor a menor importancia.
9\. Getters y setters al final.

Porque los comentarios en el código no deberían ser la regla general?

Porque el código debería ser auto-explicativo.

Qual es la frase de Brian W. Kernighan sobre el código mal escrito?

No comentes el código mal escrito, reescríbelo.

En que caso se suelen utilizar los comentarios en el código?

Cuando se requiere el uso de apis de terceros o librerías.

Cuando hacemos comentarios en el código, que se recomienda y que no se recomienda explicar?

Ni el qué ni el cómo, si no el porqué.

Que característica deben tener las diferentes clases de un proyecto?

Uniformidad.

Como debe ser la indentación en un proyecto?

Uniforme.

Cuantos espacios tiene una tabulación?

4

Que significan las siglas STUPID?

Son 6 code smells que se deben evitar.

1\. Singleton
2\. Tight Coupling
3\. Untestability
4\. Premature Optimization
5\. Indescriptive Naming
6\. Duplication

Que es un antipatrón?

Un patrón de código cuya utilización se debe evitar.

Que consecuencias puede tener un code smell?

Que nuestro código pierda calidad.

Qual es la única ventaja que proporciona el uso del patrón singleton?

Garantiza una única instancia de la clase a lo largo de toda la aplicación.

Porque se considera el patrón singleton un code smell?

Porque puede ser modificado por cualquiera y hace el código más difícil de testear, además no es rastreable.

Qué desventajas trae el alto acoplamiento (Tight Coupling)?

1\. Un cambio en un módulo provoca un efecto dominó de cambios en otros modulos.

2\. El ensamblaje de módulos puede requerir más esfuerzo debido a la mayor dependencia entre módulos.

3\. Un modulo en particular puede ser más difícil de reutilizar debido a que se deben incluir otros módulos dependientes.

Que representa esta imagen?

Alto acoplamiento y baja cohesión.

Bajo acoplamiento y alta cohesión.

Como deben ser los módulos de una aplicación?

Auto-contenidos, auto-suficientes e independientes, con un objetivo y un propósito bien definido.

A que nos referimos con baja cohesión?

A clases o funciones que realizan una gran variedad de acciones más allá de su propósito principal.

A que nos referimos con alta cohesión?

A clases o funciones que se encfocan únicamente en su propósito principal.

A que nos referimos con acoplamiento?

A la relación y dependencia entre clases o módulos.

A que puede llevar el alto acoplamiento en el peor de los casos?

A una renovación completa del sistema.

Hablando en términos de acoplamiento y cohesión, como debe ser una aplicación idealmente?

Una aplicación óptima debería tener una alta cohesión y un bajo acoplamiento.

A que nos referimos con Untestability?

A código no testeable.

Qual puede ser la causa de Untestability?

Un código con alto acoplamiento.

Que es la complejidad esencial?

Es la complejidad inherente a un problema.

Que es la complejiad accidental?

Complejidad añadida por encima de la complejiad esencial.

Que tipos de duplicidad de código existen?

La duplicidad real y la duplicidad accidental.

Que es la duplicidad real?

Un código que es idéntico y cumple la misma función.

Que consecuencias puede traer la duplicidad de código real?

1\. Implementar un cambio implicaría actualizar todo el código idéntico en diversos lugares.
2\. Incrementa posibilidades de error humano si se olvida una parte por actualizar.
3\. Puede llevar a una cantidad mayor de pruebas necesarias para probar el código.

A que conclusion nos debe llevar el hecho de que copiamos y pegamos varias veces el mismo código en una aplicación?

A que no se está aplicando correctamente el principio DRY.

Que es la duplicidad accidental?

Un código que parece similar pero cumple funciones distintas.

Como podemos identificar la duplicidad accidental?

Si hay un cambio, se aplica únicamente en un lugar de la aplicación.

Como se puede optimizar la duplicidad accidental?

Mediante parametros y optimizaciones.

Si hablamos de code smell, a que nos referimos con inflación?

A un método o clase con demasiadas líneas de código.

Como podemos resolver la inflación en un método?

Delegando las responsabilidades del método en submétodos más específicos.

Como podemos resolver la inflación en una clase?

Dividiendo la clase en subclases más específicas.

A que nos referimos con feature envy?

A un método que accede a los datos de otro objeto más que a sus propios datos.

A que nos referimos con intimidad inapropiada?

A una clase que utiliza métodos internos de otra clase.

Que nos indica que una clase está desarrollada de manera correcta?

Que sabe lo mínimo posible de otras clases.

A que nos referimos con middle man?

A una clase cuya única función es delegar una tarea a otra clase.

Que nos puede llevar a un code smell de tipo middle man?

Una refactorización de una cadena de mensajes.

A que nos ayudan los principios SOLID?

A escribir un código de mayor calidad y a evitar code smells.

A que consecuencia nos lleva no seguir los principios SOLID?

A acumular deuda técnica.

Quales són los 5 principios SOLID?

1\. S – Single Responsibility Principle (SRP)
2\. O – Open/Closed Principle (OCP)
3\. L – Liskov Substitution Principle (LSP)
4\. I – Interface Segregation Principle (ISP)
5\. D – Dependency Inversion Principle (DIP)

En que consiste el Principio de responsabilidad única o Single Responsibility Principle (SRP)?

Nunca debería haber más de un motivo por el cual cambiar una clase o un módulo.

Como podemos detectar violaciones del Single Responsibility Principle (SRP)?

1\. La clase o módulo tiene un nombre demasiado genérico.
2\. La clase o módulo tiene una gran cantidad de importaciones.
3\. La clase o módulo tiene una gran cantidad de métodos públicos.
4\. La clase o módulo tiene una gran cantidad de líneas de código.
5\. Un cambio en el código afecta a toda la clase o módulo.

SRP?

Single Responsibility Principle.

Single Responsibility Principle?

SRP.

OAC?

Open and Closed.

Open and Closed?

OAC.

Que establece el principio Open and CLosed?

Establece que las entidades de software deben estar abiertas para la extensión pero cerradas para la modificación

LSP?

Liskov Substitution Principle

Liskov Substitution Principle?

LSP.

En que consiste el principio de Liskov Substitution?

Cada clase que hereda de otra puede usarse como su padre sin necesidad de conocer las diferencias entre ellas.