Desarrollo ágil
Código y sus olores
Refinement Gestión de dependencias separada de tareas evita
conflictos
Como me pasa a mi en polypoly,
cuando he añadido una tarea a un apartado en un
package.json, y me lo he cargado al actualizarlo dle
main.
✓ TODO
□ ¿Hemos comenzado a
organizar el desarrollo en milestones?
□ ¿Se han diseñado las
excepciones?
□ ¿Se han elegido un
task runner y se ha empezado a configurar?
El mejor código es el que no se
escribe
Código declarativo
FTW
from enum import Enum
IssueState = Enum('IssueState', 'Open Closed')
class Issue:
def __init__(self, projectName: str, issueId: int ):
self._state = IssueState.Open
self._projectName = projectName
self._issueId = issueId
def close(self):
self._state = IssueState.Closed
def reopen(self):
self._state = IssueState.OpenUsamos declaración de
variables y anotaciones de código para evitar
comprobaciones. Desgraciadamente, en Python no existen las
variables privadas, aunque convencionalmente estamos
declarando todos los atributos como
privados (con el _ delante)
Refinement from enum import Enum
from dataclasses import dataclass
IssueState = Enum('IssueState', 'Open Closed')
@dataclass
class Issue:
projectName: str
issueId: str
state: IssueState = IssueState.Open
def close(self):
self.state = IssueState.Closed
def reopen(self):
self.state = IssueState.Open
DRY: No te repitas
Limpia tu código
Reflexionar sobre las
repeticiones
method new-issue( Project::Issue $issue where $issue.project-name eq
$!project-name) {…}
multi method new-milestone( $milestone where $milestone.project-name eq
$!project-name) {…}
En este caso, se
puede estar indicando que tanto los issues
como los milestones no deberían estar
fuera del proyecto sino dentro,
porque al final no tiene mucho sentido
definir un milestone fuera del contexto de
un proyecto (ni un issue)
Evitar los números mágicos
Código limpio y sin
encantamientos
Identificar los valores
import ../project
var
thisProject: Project
thisProject = Project( id: "Foo" )
assert thisProject.id == "Foo"Nim usa "const" para
sus constantes, y en este caso la usamos
para identificar tanto el valor como el
resultado de un test
Valores identificados
import ../project
const projectId= "Foo"
var
thisProject: Project
thisProject = Project( id: projectId )
assert thisProject.id == projectIdNim usa "const" para
sus constantes, y en este caso la usamos
para identificar tanto el valor como el
resultado de un test
Algo huele mal en tu código
Code smells ,
código idiomático, antipatrones y
otros pecadosUsa linters
Examinan
estáticamente el código, dan consejos para
respetar convenciones
Mi código apesta
Project/core.py:10:0: W0301: Unnecessary semicolon (unnecessary-semicolon)
Project/core.py:1:0: C0114: Missing module docstring (missing-module-docstring)
Project/core.py:1:0: C0115: Missing class docstring (missing-class-docstring)
Project/core.py:6:4: C0116: Missing function or method docstring (missing-function-docstring)
…
Project/core.py:9:4: C0103: Method name "newMilestone" doesn't conform to snake_case naming style (invalid-name)
-----------------------------------
Your code has been rated at 0.00/10
En ciertos lenguajes
son más estrictos que en otros sobre cómo se
debe escribir, pero escribir siguiendo las
buenas prácticas también es una práctica
defensiva que ayuda a que otras personas
inviertan menos tiempo en entenderlo, o en
refactorizarlo si es que se fusiona con otra
base de código que sí las siga
✓ TODO hito 10
Elegir un linter y empezar
a usarlo
agil.yaml ⇒linter: RuboCop