Il codice che funziona ma che nessuno vuole toccare è un debito che si paga a ogni modifica. Semplificarlo significa renderlo più chiaro senza cambiarne il comportamento: stesso risultato, minor fatica per chi lo legge dopo.
Prima regola: il comportamento resta identico
Una semplificazione che cambia il comportamento è una modifica, e va trattata come tale (con test, revisione, descrizione). Perciò si lavora con i test verdi, a passi piccoli, e ogni passo si prova. Se non ci sono test, si scrivono prima quelli che fissano il comportamento attuale.
Capire prima di toccare
Davanti a un pezzo di codice che sembra inutile o strano, vale il recinto di Chesterton: prima di rimuovere un recinto, si scopre perché qualcuno l'ha messo. Si legge la storia della modifica, si cerca chi lo usa, si prova a capire il caso che protegge. Se dopo l'esame non si trova una ragione, si rimuove; se si trova, si documenta con un commento.
Che cosa cercare
- Annidamenti profondi. Una cascata di condizioni si appiattisce con uscite anticipate.
- Funzioni lunghe con più responsabilità. Si dividono in funzioni con nomi che descrivono ciò che fanno.
- Nomi poco chiari. Un nome che richiede un commento per essere capito è un nome sbagliato.
- Duplicazioni. Ma si estrae un elemento comune solo dopo il terzo caso (regola del tre): due somiglianze possono essere una coincidenza, e un'astrazione prematura costa più della duplicazione.
- Codice morto e flag mai usati. Si eliminano.
- Complessità accidentale. Strutture generiche costruite per un futuro che non è arrivato.
- Commenti che ripetono il codice. Si tolgono; restano quelli che spiegano il perché.
Come procedere
Una semplificazione per volta; test dopo ognuna; un commit per ciascuna con un messaggio che dica "nessun cambiamento di comportamento". Chi rivede deve poter verificare in pochi minuti che nulla è cambiato.
Quando non toccare
- Codice che non si capisce e non ha test: prima si scrivono i test.
- Codice che sta per essere sostituito o rimosso.
- Codice con prestazioni critiche, dove la versione "brutta" è così per una ragione misurata.
- Quando la semplificazione è un pretesto per riscrivere tutto: il rischio supera il vantaggio.
Segnali d'allarme
- Cambiare il comportamento insieme alla struttura nello stesso passaggio.
- Rimuovere qualcosa senza capire perché c'era.
- Estrarre un'astrazione dopo due soli usi.
- Una "pulizia" che tocca decine di file senza test.
- Una semplificazione che rende il codice più corto ma più oscuro.
Un esempio
Una funzione con quattro if annidati controlla un ordine. Con i test verdi, si porta ogni condizione a uscita anticipata ("se l'ordine è annullato, esci"), si dà un nome alla condizione composta ("ordine_modificabile") e si elimina un ramo irraggiungibile dopo averne verificato l'assenza di usi. Il comportamento è identico e la funzione si legge dall'alto in basso.
Quando usarlo
Quando si rifattorizza per chiarezza senza cambiare il comportamento, quando il codice funziona ma è più difficile da leggere, mantenere o estendere di quanto dovrebbe, o quando in una revisione si nota complessità accumulata senza motivo.
Questo metodo deriva dalla famiglia di skill open source agent-skills di Addy Osmani (licenza MIT), riscritta e adattata.
Questo articolo è una skill di OIAR
Quello che hai letto è il contenuto di una skill del catalogo OIAR, scritto per le persone. Una conoscenza come questa ma più ricca e profonda, scritta per gli agenti, guida le interviste, l'analisi e il report dentro la piattaforma. Le skill si usano in OIAR: per provarla su un tuo progetto serve un account.
code-simplificationMetodo per semplificare codice funzionante senza cambiarne il comportamento: test come rete di sicurezza, recinto di Chesterton, regola del tre, passi piccoli, quando non toccare. Usarla quando il codice funziona ma è difficile da leggere, mantenere o estendere.